Do not permit multi-component wildcards on certificate names (OpenSSL, EXPERIMENTAL_C...
[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.83"
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"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCP%&
3815 .oindex "&%-MCP%&"
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 server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
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 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMm%&&~<&'message&~reference'&>
4225 .oindex "&%-oMm%&"
4226 .cindex "message reference" "message reference, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4228 option sets the message reference, e.g. message-id, and is logged during
4229 delivery. This is useful when some kind of audit trail is required to tie
4230 messages together. The format of the message reference is checked and will
4231 abort if the format is invalid. The option will only be accepted if exim is
4232 running in trusted mode, not as any regular user.
4233
4234 The best example of a message reference is when Exim sends a bounce message.
4235 The message reference is the message-id of the original message for which Exim
4236 is sending the bounce.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .vitem &%-X%&&~<&'logfile'&>
4640 .oindex "&%-X%&"
4641 This option is interpreted by Sendmail to cause debug information to be sent
4642 to the named file.  It is ignored by Exim.
4643 .endlist
4644
4645 .ecindex IIDclo1
4646 .ecindex IIDclo2
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . Insert a stylized DocBook comment here, to identify the end of the command
4651 . line options. This is for the benefit of the Perl script that automatically
4652 . creates a man page for the options.
4653 . ////////////////////////////////////////////////////////////////////////////
4654
4655 .literal xml
4656 <!-- === End of command line options === -->
4657 .literal off
4658
4659
4660
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . ////////////////////////////////////////////////////////////////////////////
4665
4666
4667 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4668          "The runtime configuration file"
4669
4670 .cindex "run time configuration"
4671 .cindex "configuration file" "general description"
4672 .cindex "CONFIGURE_FILE"
4673 .cindex "configuration file" "errors in"
4674 .cindex "error" "in configuration file"
4675 .cindex "return code" "for bad configuration"
4676 Exim uses a single run time configuration file that is read whenever an Exim
4677 binary is executed. Note that in normal operation, this happens frequently,
4678 because Exim is designed to operate in a distributed manner, without central
4679 control.
4680
4681 If a syntax error is detected while reading the configuration file, Exim
4682 writes a message on the standard error, and exits with a non-zero return code.
4683 The message is also written to the panic log. &*Note*&: Only simple syntax
4684 errors can be detected at this time. The values of any expanded options are
4685 not checked until the expansion happens, even when the expansion does not
4686 actually alter the string.
4687
4688 The name of the configuration file is compiled into the binary for security
4689 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4690 most configurations, this specifies a single file. However, it is permitted to
4691 give a colon-separated list of file names, in which case Exim uses the first
4692 existing file in the list.
4693
4694 .cindex "EXIM_USER"
4695 .cindex "EXIM_GROUP"
4696 .cindex "CONFIGURE_OWNER"
4697 .cindex "CONFIGURE_GROUP"
4698 .cindex "configuration file" "ownership"
4699 .cindex "ownership" "configuration file"
4700 The run time configuration file must be owned by root or by the user that is
4701 specified at compile time by the CONFIGURE_OWNER option (if set). The
4702 configuration file must not be world-writeable, or group-writeable unless its
4703 group is the root group or the one specified at compile time by the
4704 CONFIGURE_GROUP option.
4705
4706 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4707 to root, anybody who is able to edit the run time configuration file has an
4708 easy way to run commands as root. If you specify a user or group in the
4709 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4710 who are members of that group will trivially be able to obtain root privileges.
4711
4712 Up to Exim version 4.72, the run time configuration file was also permitted to
4713 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4714 since it offered a simple privilege escalation for any attacker who managed to
4715 compromise the Exim user account.
4716
4717 A default configuration file, which will work correctly in simple situations,
4718 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4719 defines just one file name, the installation process copies the default
4720 configuration to a new file of that name if it did not previously exist. If
4721 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4722 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4723 configuration.
4724
4725
4726
4727 .section "Using a different configuration file" "SECID40"
4728 .cindex "configuration file" "alternate"
4729 A one-off alternate configuration can be specified by the &%-C%& command line
4730 option, which may specify a single file or a list of files. However, when
4731 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4732 unless the argument for &%-C%& is identical to the built-in value from
4733 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4734 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4735 is useful mainly for checking the syntax of configuration files before
4736 installing them. No owner or group checks are done on a configuration file
4737 specified by &%-C%&, if root privilege has been dropped.
4738
4739 Even the Exim user is not trusted to specify an arbitrary configuration file
4740 with the &%-C%& option to be used with root privileges, unless that file is
4741 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4742 testing a configuration using &%-C%& right through message reception and
4743 delivery, even if the caller is root. The reception works, but by that time,
4744 Exim is running as the Exim user, so when it re-execs to regain privilege for
4745 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4746 can test reception and delivery using two separate commands (one to put a
4747 message on the queue, using &%-odq%&, and another to do the delivery, using
4748 &%-M%&).
4749
4750 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4751 prefix string with which any file named in a &%-C%& command line option must
4752 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4753 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4754 name can be used with &%-C%&.
4755
4756 One-off changes to a configuration can be specified by the &%-D%& command line
4757 option, which defines and overrides values for macros used inside the
4758 configuration file. However, like &%-C%&, the use of this option by a
4759 non-privileged user causes Exim to discard its root privilege.
4760 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4761 completely disabled, and its use causes an immediate error exit.
4762
4763 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4764 to declare certain macro names trusted, such that root privilege will not
4765 necessarily be discarded.
4766 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4767 considered safe and, if &%-D%& only supplies macros from this list, and the
4768 values are acceptable, then Exim will not give up root privilege if the caller
4769 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4770 transition mechanism and is expected to be removed in the future.  Acceptable
4771 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4772
4773 Some sites may wish to use the same Exim binary on different machines that
4774 share a file system, but to use different configuration files on each machine.
4775 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4776 looks for a file whose name is the configuration file name followed by a dot
4777 and the machine's node name, as obtained from the &[uname()]& function. If this
4778 file does not exist, the standard name is tried. This processing occurs for
4779 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4780
4781 In some esoteric situations different versions of Exim may be run under
4782 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4783 help with this. See the comments in &_src/EDITME_& for details.
4784
4785
4786
4787 .section "Configuration file format" "SECTconffilfor"
4788 .cindex "configuration file" "format of"
4789 .cindex "format" "configuration file"
4790 Exim's configuration file is divided into a number of different parts. General
4791 option settings must always appear at the start of the file. The other parts
4792 are all optional, and may appear in any order. Each part other than the first
4793 is introduced by the word &"begin"& followed by the name of the part. The
4794 optional parts are:
4795
4796 .ilist
4797 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4798 &<<CHAPACL>>&).
4799 .next
4800 .cindex "AUTH" "configuration"
4801 &'authenticators'&: Configuration settings for the authenticator drivers. These
4802 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4803 .next
4804 &'routers'&: Configuration settings for the router drivers. Routers process
4805 addresses and determine how the message is to be delivered (see chapters
4806 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4807 .next
4808 &'transports'&: Configuration settings for the transport drivers. Transports
4809 define mechanisms for copying messages to destinations (see chapters
4810 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4811 .next
4812 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4813 If there is no retry section, or if it is empty (that is, no retry rules are
4814 defined), Exim will not retry deliveries. In this situation, temporary errors
4815 are treated the same as permanent errors. Retry rules are discussed in chapter
4816 &<<CHAPretry>>&.
4817 .next
4818 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4819 when new addresses are generated during delivery. Rewriting is discussed in
4820 chapter &<<CHAPrewrite>>&.
4821 .next
4822 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4823 want to use this feature, you must set
4824 .code
4825 LOCAL_SCAN_HAS_OPTIONS=yes
4826 .endd
4827 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4828 facility are given in chapter &<<CHAPlocalscan>>&.
4829 .endlist
4830
4831 .cindex "configuration file" "leading white space in"
4832 .cindex "configuration file" "trailing white space in"
4833 .cindex "white space" "in configuration file"
4834 Leading and trailing white space in configuration lines is always ignored.
4835
4836 Blank lines in the file, and lines starting with a # character (ignoring
4837 leading white space) are treated as comments and are ignored. &*Note*&: A
4838 # character other than at the beginning of a line is not treated specially,
4839 and does not introduce a comment.
4840
4841 Any non-comment line can be continued by ending it with a backslash. Note that
4842 the general rule for white space means that trailing white space after the
4843 backslash and leading white space at the start of continuation
4844 lines is ignored. Comment lines beginning with # (but not empty lines) may
4845 appear in the middle of a sequence of continuation lines.
4846
4847 A convenient way to create a configuration file is to start from the
4848 default, which is supplied in &_src/configure.default_&, and add, delete, or
4849 change settings as required.
4850
4851 The ACLs, retry rules, and rewriting rules have their own syntax which is
4852 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4853 respectively. The other parts of the configuration file have some syntactic
4854 items in common, and these are described below, from section &<<SECTcos>>&
4855 onwards. Before that, the inclusion, macro, and conditional facilities are
4856 described.
4857
4858
4859
4860 .section "File inclusions in the configuration file" "SECID41"
4861 .cindex "inclusions in configuration file"
4862 .cindex "configuration file" "including other files"
4863 .cindex "&`.include`& in configuration file"
4864 .cindex "&`.include_if_exists`& in configuration file"
4865 You can include other files inside Exim's run time configuration file by
4866 using this syntax:
4867 .display
4868 &`.include`& <&'file name'&>
4869 &`.include_if_exists`& <&'file name'&>
4870 .endd
4871 on a line by itself. Double quotes round the file name are optional. If you use
4872 the first form, a configuration error occurs if the file does not exist; the
4873 second form does nothing for non-existent files. In all cases, an absolute file
4874 name is required.
4875
4876 Includes may be nested to any depth, but remember that Exim reads its
4877 configuration file often, so it is a good idea to keep them to a minimum.
4878 If you change the contents of an included file, you must HUP the daemon,
4879 because an included file is read only when the configuration itself is read.
4880
4881 The processing of inclusions happens early, at a physical line level, so, like
4882 comment lines, an inclusion can be used in the middle of an option setting,
4883 for example:
4884 .code
4885 hosts_lookup = a.b.c \
4886                .include /some/file
4887 .endd
4888 Include processing happens after macro processing (see below). Its effect is to
4889 process the lines of the included file as if they occurred inline where the
4890 inclusion appears.
4891
4892
4893
4894 .section "Macros in the configuration file" "SECTmacrodefs"
4895 .cindex "macro" "description of"
4896 .cindex "configuration file" "macros"
4897 If a line in the main part of the configuration (that is, before the first
4898 &"begin"& line) begins with an upper case letter, it is taken as a macro
4899 definition, and must be of the form
4900 .display
4901 <&'name'&> = <&'rest of line'&>
4902 .endd
4903 The name must consist of letters, digits, and underscores, and need not all be
4904 in upper case, though that is recommended. The rest of the line, including any
4905 continuations, is the replacement text, and has leading and trailing white
4906 space removed. Quotes are not removed. The replacement text can never end with
4907 a backslash character, but this doesn't seem to be a serious limitation.
4908
4909 Macros may also be defined between router, transport, authenticator, or ACL
4910 definitions. They may not, however, be defined within an individual driver or
4911 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4912
4913 .section "Macro substitution" "SECID42"
4914 Once a macro is defined, all subsequent lines in the file (and any included
4915 files) are scanned for the macro name; if there are several macros, the line is
4916 scanned for each in turn, in the order in which the macros are defined. The
4917 replacement text is not re-scanned for the current macro, though it is scanned
4918 for subsequently defined macros. For this reason, a macro name may not contain
4919 the name of a previously defined macro as a substring. You could, for example,
4920 define
4921 .display
4922 &`ABCD_XYZ = `&<&'something'&>
4923 &`ABCD = `&<&'something else'&>
4924 .endd
4925 but putting the definitions in the opposite order would provoke a configuration
4926 error. Macro expansion is applied to individual physical lines from the file,
4927 before checking for line continuation or file inclusion (see above). If a line
4928 consists solely of a macro name, and the expansion of the macro is empty, the
4929 line is ignored. A macro at the start of a line may turn the line into a
4930 comment line or a &`.include`& line.
4931
4932
4933 .section "Redefining macros" "SECID43"
4934 Once defined, the value of a macro can be redefined later in the configuration
4935 (or in an included file). Redefinition is specified by using &'=='& instead of
4936 &'='&. For example:
4937 .code
4938 MAC =  initial value
4939 ...
4940 MAC == updated value
4941 .endd
4942 Redefinition does not alter the order in which the macros are applied to the
4943 subsequent lines of the configuration file. It is still the same order in which
4944 the macros were originally defined. All that changes is the macro's value.
4945 Redefinition makes it possible to accumulate values. For example:
4946 .code
4947 MAC =  initial value
4948 ...
4949 MAC == MAC and something added
4950 .endd
4951 This can be helpful in situations where the configuration file is built
4952 from a number of other files.
4953
4954 .section "Overriding macro values" "SECID44"
4955 The values set for macros in the configuration file can be overridden by the
4956 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4957 used, unless called by root or the Exim user. A definition on the command line
4958 using the &%-D%& option causes all definitions and redefinitions within the
4959 file to be ignored.
4960
4961
4962
4963 .section "Example of macro usage" "SECID45"
4964 As an example of macro usage, consider a configuration where aliases are looked
4965 up in a MySQL database. It helps to keep the file less cluttered if long
4966 strings such as SQL statements are defined separately as macros, for example:
4967 .code
4968 ALIAS_QUERY = select mailbox from user where \
4969               login='${quote_mysql:$local_part}';
4970 .endd
4971 This can then be used in a &(redirect)& router setting like this:
4972 .code
4973 data = ${lookup mysql{ALIAS_QUERY}}
4974 .endd
4975 In earlier versions of Exim macros were sometimes used for domain, host, or
4976 address lists. In Exim 4 these are handled better by named lists &-- see
4977 section &<<SECTnamedlists>>&.
4978
4979
4980 .section "Conditional skips in the configuration file" "SECID46"
4981 .cindex "configuration file" "conditional skips"
4982 .cindex "&`.ifdef`&"
4983 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4984 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4985 portions of the configuration file. The processing happens whenever the file is
4986 read (that is, when an Exim binary starts to run).
4987
4988 The implementation is very simple. Instances of the first four directives must
4989 be followed by text that includes the names of one or macros. The condition
4990 that is tested is whether or not any macro substitution has taken place in the
4991 line. Thus:
4992 .code
4993 .ifdef AAA
4994 message_size_limit = 50M
4995 .else
4996 message_size_limit = 100M
4997 .endif
4998 .endd
4999 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5000 otherwise. If there is more than one macro named on the line, the condition
5001 is true if any of them are defined. That is, it is an &"or"& condition. To
5002 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5003
5004 Although you can use a macro expansion to generate one of these directives,
5005 it is not very useful, because the condition &"there was a macro substitution
5006 in this line"& will always be true.
5007
5008 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5009 to clarify complicated nestings.
5010
5011
5012
5013 .section "Common option syntax" "SECTcos"
5014 .cindex "common option syntax"
5015 .cindex "syntax of common options"
5016 .cindex "configuration file" "common option syntax"
5017 For the main set of options, driver options, and &[local_scan()]& options,
5018 each setting is on a line by itself, and starts with a name consisting of
5019 lower-case letters and underscores. Many options require a data value, and in
5020 these cases the name must be followed by an equals sign (with optional white
5021 space) and then the value. For example:
5022 .code
5023 qualify_domain = mydomain.example.com
5024 .endd
5025 .cindex "hiding configuration option values"
5026 .cindex "configuration options" "hiding value of"
5027 .cindex "options" "hiding value of"
5028 Some option settings may contain sensitive data, for example, passwords for
5029 accessing databases. To stop non-admin users from using the &%-bP%& command
5030 line option to read these values, you can precede the option settings with the
5031 word &"hide"&. For example:
5032 .code
5033 hide mysql_servers = localhost/users/admin/secret-password
5034 .endd
5035 For non-admin users, such options are displayed like this:
5036 .code
5037 mysql_servers = <value not displayable>
5038 .endd
5039 If &"hide"& is used on a driver option, it hides the value of that option on
5040 all instances of the same driver.
5041
5042 The following sections describe the syntax used for the different data types
5043 that are found in option settings.
5044
5045
5046 .section "Boolean options" "SECID47"
5047 .cindex "format" "boolean"
5048 .cindex "boolean configuration values"
5049 .oindex "&%no_%&&'xxx'&"
5050 .oindex "&%not_%&&'xxx'&"
5051 Options whose type is given as boolean are on/off switches. There are two
5052 different ways of specifying such options: with and without a data value. If
5053 the option name is specified on its own without data, the switch is turned on;
5054 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5055 boolean options may be followed by an equals sign and one of the words
5056 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5057 the following two settings have exactly the same effect:
5058 .code
5059 queue_only
5060 queue_only = true
5061 .endd
5062 The following two lines also have the same (opposite) effect:
5063 .code
5064 no_queue_only
5065 queue_only = false
5066 .endd
5067 You can use whichever syntax you prefer.
5068
5069
5070
5071
5072 .section "Integer values" "SECID48"
5073 .cindex "integer configuration values"
5074 .cindex "format" "integer"
5075 If an option's type is given as &"integer"&, the value can be given in decimal,
5076 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5077 number is assumed. Otherwise, it is treated as an octal number unless it starts
5078 with the characters &"0x"&, in which case the remainder is interpreted as a
5079 hexadecimal number.
5080
5081 If an integer value is followed by the letter K, it is multiplied by 1024; if
5082 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5083 of integer option settings are output, values which are an exact multiple of
5084 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5085 and M. The printing style is independent of the actual input format that was
5086 used.
5087
5088
5089 .section "Octal integer values" "SECID49"
5090 .cindex "integer format"
5091 .cindex "format" "octal integer"
5092 If an option's type is given as &"octal integer"&, its value is always
5093 interpreted as an octal number, whether or not it starts with the digit zero.
5094 Such options are always output in octal.
5095
5096
5097 .section "Fixed point numbers" "SECID50"
5098 .cindex "fixed point configuration values"
5099 .cindex "format" "fixed point"
5100 If an option's type is given as &"fixed-point"&, its value must be a decimal
5101 integer, optionally followed by a decimal point and up to three further digits.
5102
5103
5104
5105 .section "Time intervals" "SECTtimeformat"
5106 .cindex "time interval" "specifying in configuration"
5107 .cindex "format" "time interval"
5108 A time interval is specified as a sequence of numbers, each followed by one of
5109 the following letters, with no intervening white space:
5110
5111 .table2 30pt
5112 .irow &%s%& seconds
5113 .irow &%m%& minutes
5114 .irow &%h%& hours
5115 .irow &%d%& days
5116 .irow &%w%& weeks
5117 .endtable
5118
5119 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5120 intervals are output in the same format. Exim does not restrict the values; it
5121 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5122
5123
5124
5125 .section "String values" "SECTstrings"
5126 .cindex "string" "format of configuration values"
5127 .cindex "format" "string"
5128 If an option's type is specified as &"string"&, the value can be specified with
5129 or without double-quotes. If it does not start with a double-quote, the value
5130 consists of the remainder of the line plus any continuation lines, starting at
5131 the first character after any leading white space, with trailing white space
5132 removed, and with no interpretation of the characters in the string. Because
5133 Exim removes comment lines (those beginning with #) at an early stage, they can
5134 appear in the middle of a multi-line string. The following two settings are
5135 therefore equivalent:
5136 .code
5137 trusted_users = uucp:mail
5138 trusted_users = uucp:\
5139                 # This comment line is ignored
5140                 mail
5141 .endd
5142 .cindex "string" "quoted"
5143 .cindex "escape characters in quoted strings"
5144 If a string does start with a double-quote, it must end with a closing
5145 double-quote, and any backslash characters other than those used for line
5146 continuation are interpreted as escape characters, as follows:
5147
5148 .table2 100pt
5149 .irow &`\\`&                     "single backslash"
5150 .irow &`\n`&                     "newline"
5151 .irow &`\r`&                     "carriage return"
5152 .irow &`\t`&                     "tab"
5153 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5154 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5155                                    character"
5156 .endtable
5157
5158 If a backslash is followed by some other character, including a double-quote
5159 character, that character replaces the pair.
5160
5161 Quoting is necessary only if you want to make use of the backslash escapes to
5162 insert special characters, or if you need to specify a value with leading or
5163 trailing spaces. These cases are rare, so quoting is almost never needed in
5164 current versions of Exim. In versions of Exim before 3.14, quoting was required
5165 in order to continue lines, so you may come across older configuration files
5166 and examples that apparently quote unnecessarily.
5167
5168
5169 .section "Expanded strings" "SECID51"
5170 .cindex "expansion" "definition of"
5171 Some strings in the configuration file are subjected to &'string expansion'&,
5172 by which means various parts of the string may be changed according to the
5173 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5174 is as just described; in particular, the handling of backslashes in quoted
5175 strings is done as part of the input process, before expansion takes place.
5176 However, backslash is also an escape character for the expander, so any
5177 backslashes that are required for that reason must be doubled if they are
5178 within a quoted configuration string.
5179
5180
5181 .section "User and group names" "SECID52"
5182 .cindex "user name" "format of"
5183 .cindex "format" "user name"
5184 .cindex "groups" "name format"
5185 .cindex "format" "group name"
5186 User and group names are specified as strings, using the syntax described
5187 above, but the strings are interpreted specially. A user or group name must
5188 either consist entirely of digits, or be a name that can be looked up using the
5189 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5190
5191
5192 .section "List construction" "SECTlistconstruct"
5193 .cindex "list" "syntax of in configuration"
5194 .cindex "format" "list item in configuration"
5195 .cindex "string" "list, definition of"
5196 The data for some configuration options is a list of items, with colon as the
5197 default separator. Many of these options are shown with type &"string list"& in
5198 the descriptions later in this document. Others are listed as &"domain list"&,
5199 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5200 are all the same; however, those other than &"string list"& are subject to
5201 particular kinds of interpretation, as described in chapter
5202 &<<CHAPdomhosaddlists>>&.
5203
5204 In all these cases, the entire list is treated as a single string as far as the
5205 input syntax is concerned. The &%trusted_users%& setting in section
5206 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5207 in a list, it must be entered as two colons. Leading and trailing white space
5208 on each item in a list is ignored. This makes it possible to include items that
5209 start with a colon, and in particular, certain forms of IPv6 address. For
5210 example, the list
5211 .code
5212 local_interfaces = 127.0.0.1 : ::::1
5213 .endd
5214 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5215
5216 &*Note*&: Although leading and trailing white space is ignored in individual
5217 list items, it is not ignored when parsing the list. The space after the first
5218 colon in the example above is necessary. If it were not there, the list would
5219 be interpreted as the two items 127.0.0.1:: and 1.
5220
5221 .section "Changing list separators" "SECID53"
5222 .cindex "list separator" "changing"
5223 .cindex "IPv6" "addresses in lists"
5224 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5225 introduced to allow the separator character to be changed. If a list begins
5226 with a left angle bracket, followed by any punctuation character, that
5227 character is used instead of colon as the list separator. For example, the list
5228 above can be rewritten to use a semicolon separator like this:
5229 .code
5230 local_interfaces = <; 127.0.0.1 ; ::1
5231 .endd
5232 This facility applies to all lists, with the exception of the list in
5233 &%log_file_path%&. It is recommended that the use of non-colon separators be
5234 confined to circumstances where they really are needed.
5235
5236 .cindex "list separator" "newline as"
5237 .cindex "newline" "as list separator"
5238 It is also possible to use newline and other control characters (those with
5239 code values less than 32, plus DEL) as separators in lists. Such separators
5240 must be provided literally at the time the list is processed. For options that
5241 are string-expanded, you can write the separator using a normal escape
5242 sequence. This will be processed by the expander before the string is
5243 interpreted as a list. For example, if a newline-separated list of domains is
5244 generated by a lookup, you can process it directly by a line such as this:
5245 .code
5246 domains = <\n ${lookup mysql{.....}}
5247 .endd
5248 This avoids having to change the list separator in such data. You are unlikely
5249 to want to use a control character as a separator in an option that is not
5250 expanded, because the value is literal text. However, it can be done by giving
5251 the value in quotes. For example:
5252 .code
5253 local_interfaces = "<\n 127.0.0.1 \n ::1"
5254 .endd
5255 Unlike printing character separators, which can be included in list items by
5256 doubling, it is not possible to include a control character as data when it is
5257 set as the separator. Two such characters in succession are interpreted as
5258 enclosing an empty list item.
5259
5260
5261
5262 .section "Empty items in lists" "SECTempitelis"
5263 .cindex "list" "empty item in"
5264 An empty item at the end of a list is always ignored. In other words, trailing
5265 separator characters are ignored. Thus, the list in
5266 .code
5267 senders = user@domain :
5268 .endd
5269 contains only a single item. If you want to include an empty string as one item
5270 in a list, it must not be the last item. For example, this list contains three
5271 items, the second of which is empty:
5272 .code
5273 senders = user1@domain : : user2@domain
5274 .endd
5275 &*Note*&: There must be white space between the two colons, as otherwise they
5276 are interpreted as representing a single colon data character (and the list
5277 would then contain just one item). If you want to specify a list that contains
5278 just one, empty item, you can do it as in this example:
5279 .code
5280 senders = :
5281 .endd
5282 In this case, the first item is empty, and the second is discarded because it
5283 is at the end of the list.
5284
5285
5286
5287
5288 .section "Format of driver configurations" "SECTfordricon"
5289 .cindex "drivers" "configuration format"
5290 There are separate parts in the configuration for defining routers, transports,
5291 and authenticators. In each part, you are defining a number of driver
5292 instances, each with its own set of options. Each driver instance is defined by
5293 a sequence of lines like this:
5294 .display
5295 <&'instance name'&>:
5296   <&'option'&>
5297   ...
5298   <&'option'&>
5299 .endd
5300 In the following example, the instance name is &(localuser)&, and it is
5301 followed by three options settings:
5302 .code
5303 localuser:
5304   driver = accept
5305   check_local_user
5306   transport = local_delivery
5307 .endd
5308 For each driver instance, you specify which Exim code module it uses &-- by the
5309 setting of the &%driver%& option &-- and (optionally) some configuration
5310 settings. For example, in the case of transports, if you want a transport to
5311 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5312 a local file you would use the &(appendfile)& driver. Each of the drivers is
5313 described in detail in its own separate chapter later in this manual.
5314
5315 You can have several routers, transports, or authenticators that are based on
5316 the same underlying driver (each must have a different instance name).
5317
5318 The order in which routers are defined is important, because addresses are
5319 passed to individual routers one by one, in order. The order in which
5320 transports are defined does not matter at all. The order in which
5321 authenticators are defined is used only when Exim, as a client, is searching
5322 them to find one that matches an authentication mechanism offered by the
5323 server.
5324
5325 .cindex "generic options"
5326 .cindex "options" "generic &-- definition of"
5327 Within a driver instance definition, there are two kinds of option: &'generic'&
5328 and &'private'&. The generic options are those that apply to all drivers of the
5329 same type (that is, all routers, all transports or all authenticators). The
5330 &%driver%& option is a generic option that must appear in every definition.
5331 .cindex "private options"
5332 The private options are special for each driver, and none need appear, because
5333 they all have default values.
5334
5335 The options may appear in any order, except that the &%driver%& option must
5336 precede any private options, since these depend on the particular driver. For
5337 this reason, it is recommended that &%driver%& always be the first option.
5338
5339 Driver instance names, which are used for reference in log entries and
5340 elsewhere, can be any sequence of letters, digits, and underscores (starting
5341 with a letter) and must be unique among drivers of the same type. A router and
5342 a transport (for example) can each have the same name, but no two router
5343 instances can have the same name. The name of a driver instance should not be
5344 confused with the name of the underlying driver module. For example, the
5345 configuration lines:
5346 .code
5347 remote_smtp:
5348   driver = smtp
5349 .endd
5350 create an instance of the &(smtp)& transport driver whose name is
5351 &(remote_smtp)&. The same driver code can be used more than once, with
5352 different instance names and different option settings each time. A second
5353 instance of the &(smtp)& transport, with different options, might be defined
5354 thus:
5355 .code
5356 special_smtp:
5357   driver = smtp
5358   port = 1234
5359   command_timeout = 10s
5360 .endd
5361 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5362 these transport instances from routers, and these names would appear in log
5363 lines.
5364
5365 Comment lines may be present in the middle of driver specifications. The full
5366 list of option settings for any particular driver instance, including all the
5367 defaulted values, can be extracted by making use of the &%-bP%& command line
5368 option.
5369
5370
5371
5372
5373
5374
5375 . ////////////////////////////////////////////////////////////////////////////
5376 . ////////////////////////////////////////////////////////////////////////////
5377
5378 .chapter "The default configuration file" "CHAPdefconfil"
5379 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5380 .cindex "default" "configuration file &""walk through""&"
5381 The default configuration file supplied with Exim as &_src/configure.default_&
5382 is sufficient for a host with simple mail requirements. As an introduction to
5383 the way Exim is configured, this chapter &"walks through"& the default
5384 configuration, giving brief explanations of the settings. Detailed descriptions
5385 of the options are given in subsequent chapters. The default configuration file
5386 itself contains extensive comments about ways you might want to modify the
5387 initial settings. However, note that there are many options that are not
5388 mentioned at all in the default configuration.
5389
5390
5391
5392 .section "Main configuration settings" "SECTdefconfmain"
5393 The main (global) configuration option settings must always come first in the
5394 file. The first thing you'll see in the file, after some initial comments, is
5395 the line
5396 .code
5397 # primary_hostname =
5398 .endd
5399 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5400 to know the official, fully qualified name of your host, and this is where you
5401 can specify it. However, in most cases you do not need to set this option. When
5402 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5403
5404 The first three non-comment configuration lines are as follows:
5405 .code
5406 domainlist local_domains    = @
5407 domainlist relay_to_domains =
5408 hostlist   relay_from_hosts = 127.0.0.1
5409 .endd
5410 These are not, in fact, option settings. They are definitions of two named
5411 domain lists and one named host list. Exim allows you to give names to lists of
5412 domains, hosts, and email addresses, in order to make it easier to manage the
5413 configuration file (see section &<<SECTnamedlists>>&).
5414
5415 The first line defines a domain list called &'local_domains'&; this is used
5416 later in the configuration to identify domains that are to be delivered
5417 on the local host.
5418
5419 .cindex "@ in a domain list"
5420 There is just one item in this list, the string &"@"&. This is a special form
5421 of entry which means &"the name of the local host"&. Thus, if the local host is
5422 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5423 be delivered locally. Because the local host's name is referenced indirectly,
5424 the same configuration file can be used on different hosts.
5425
5426 The second line defines a domain list called &'relay_to_domains'&, but the
5427 list itself is empty. Later in the configuration we will come to the part that
5428 controls mail relaying through the local host; it allows relaying to any
5429 domains in this list. By default, therefore, no relaying on the basis of a mail
5430 domain is permitted.
5431
5432 The third line defines a host list called &'relay_from_hosts'&. This list is
5433 used later in the configuration to permit relaying from any host or IP address
5434 that matches the list. The default contains just the IP address of the IPv4
5435 loopback interface, which means that processes on the local host are able to
5436 submit mail for relaying by sending it over TCP/IP to that interface. No other
5437 hosts are permitted to submit messages for relaying.
5438
5439 Just to be sure there's no misunderstanding: at this point in the configuration
5440 we aren't actually setting up any controls. We are just defining some domains
5441 and hosts that will be used in the controls that are specified later.
5442
5443 The next two configuration lines are genuine option settings:
5444 .code
5445 acl_smtp_rcpt = acl_check_rcpt
5446 acl_smtp_data = acl_check_data
5447 .endd
5448 These options specify &'Access Control Lists'& (ACLs) that are to be used
5449 during an incoming SMTP session for every recipient of a message (every RCPT
5450 command), and after the contents of the message have been received,
5451 respectively. The names of the lists are &'acl_check_rcpt'& and
5452 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5453 section of the configuration. The RCPT ACL controls which recipients are
5454 accepted for an incoming message &-- if a configuration does not provide an ACL
5455 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5456 contents of a message to be checked.
5457
5458 Two commented-out option settings are next:
5459 .code
5460 # av_scanner = clamd:/tmp/clamd
5461 # spamd_address = 127.0.0.1 783
5462 .endd
5463 These are example settings that can be used when Exim is compiled with the
5464 content-scanning extension. The first specifies the interface to the virus
5465 scanner, and the second specifies the interface to SpamAssassin. Further
5466 details are given in chapter &<<CHAPexiscan>>&.
5467
5468 Three more commented-out option settings follow:
5469 .code
5470 # tls_advertise_hosts = *
5471 # tls_certificate = /etc/ssl/exim.crt
5472 # tls_privatekey = /etc/ssl/exim.pem
5473 .endd
5474 These are example settings that can be used when Exim is compiled with
5475 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5476 first one specifies the list of clients that are allowed to use TLS when
5477 connecting to this server; in this case the wildcard means all clients. The
5478 other options specify where Exim should find its TLS certificate and private
5479 key, which together prove the server's identity to any clients that connect.
5480 More details are given in chapter &<<CHAPTLS>>&.
5481
5482 Another two commented-out option settings follow:
5483 .code
5484 # daemon_smtp_ports = 25 : 465 : 587
5485 # tls_on_connect_ports = 465
5486 .endd
5487 .cindex "port" "465 and 587"
5488 .cindex "port" "for message submission"
5489 .cindex "message" "submission, ports for"
5490 .cindex "ssmtp protocol"
5491 .cindex "smtps protocol"
5492 .cindex "SMTP" "ssmtp protocol"
5493 .cindex "SMTP" "smtps protocol"
5494 These options provide better support for roaming users who wish to use this
5495 server for message submission. They are not much use unless you have turned on
5496 TLS (as described in the previous paragraph) and authentication (about which
5497 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5498 on end-user networks, so RFC 4409 specifies that message submission should use
5499 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5500 configured to use port 587 correctly, so these settings also enable the
5501 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5502 &<<SECTsupobssmt>>&).
5503
5504 Two more commented-out options settings follow:
5505 .code
5506 # qualify_domain =
5507 # qualify_recipient =
5508 .endd
5509 The first of these specifies a domain that Exim uses when it constructs a
5510 complete email address from a local login name. This is often needed when Exim
5511 receives a message from a local process. If you do not set &%qualify_domain%&,
5512 the value of &%primary_hostname%& is used. If you set both of these options,
5513 you can have different qualification domains for sender and recipient
5514 addresses. If you set only the first one, its value is used in both cases.
5515
5516 .cindex "domain literal" "recognizing format"
5517 The following line must be uncommented if you want Exim to recognize
5518 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5519 (an IP address within square brackets) instead of a named domain.
5520 .code
5521 # allow_domain_literals
5522 .endd
5523 The RFCs still require this form, but many people think that in the modern
5524 Internet it makes little sense to permit mail to be sent to specific hosts by
5525 quoting their IP addresses. This ancient format has been used by people who
5526 try to abuse hosts by using them for unwanted relaying. However, some
5527 people believe there are circumstances (for example, messages addressed to
5528 &'postmaster'&) where domain literals are still useful.
5529
5530 The next configuration line is a kind of trigger guard:
5531 .code
5532 never_users = root
5533 .endd
5534 It specifies that no delivery must ever be run as the root user. The normal
5535 convention is to set up &'root'& as an alias for the system administrator. This
5536 setting is a guard against slips in the configuration.
5537 The list of users specified by &%never_users%& is not, however, the complete
5538 list; the build-time configuration in &_Local/Makefile_& has an option called
5539 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5540 contents of &%never_users%& are added to this list. By default
5541 FIXED_NEVER_USERS also specifies root.
5542
5543 When a remote host connects to Exim in order to send mail, the only information
5544 Exim has about the host's identity is its IP address. The next configuration
5545 line,
5546 .code
5547 host_lookup = *
5548 .endd
5549 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5550 in order to get a host name. This improves the quality of the logging
5551 information, but if you feel it is too expensive, you can remove it entirely,
5552 or restrict the lookup to hosts on &"nearby"& networks.
5553 Note that it is not always possible to find a host name from an IP address,
5554 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5555 unreachable.
5556
5557 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5558 1413 (hence their names):
5559 .code
5560 rfc1413_hosts = *
5561 rfc1413_query_timeout = 0s
5562 .endd
5563 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5564 Few hosts offer RFC1413 service these days; calls have to be
5565 terminated by a timeout and this needlessly delays the startup
5566 of an incoming SMTP connection.
5567 If you have hosts for which you trust RFC1413 and need this
5568 information, you can change this.
5569
5570 This line enables an efficiency SMTP option.  It is negociated by clients
5571 and not expected to cause problems but can be disabled if needed.
5572 .code
5573 prdr_enable = true
5574 .endd
5575
5576 When Exim receives messages over SMTP connections, it expects all addresses to
5577 be fully qualified with a domain, as required by the SMTP definition. However,
5578 if you are running a server to which simple clients submit messages, you may
5579 find that they send unqualified addresses. The two commented-out options:
5580 .code
5581 # sender_unqualified_hosts =
5582 # recipient_unqualified_hosts =
5583 .endd
5584 show how you can specify hosts that are permitted to send unqualified sender
5585 and recipient addresses, respectively.
5586
5587 The &%percent_hack_domains%& option is also commented out:
5588 .code
5589 # percent_hack_domains =
5590 .endd
5591 It provides a list of domains for which the &"percent hack"& is to operate.
5592 This is an almost obsolete form of explicit email routing. If you do not know
5593 anything about it, you can safely ignore this topic.
5594
5595 The last two settings in the main part of the default configuration are
5596 concerned with messages that have been &"frozen"& on Exim's queue. When a
5597 message is frozen, Exim no longer continues to try to deliver it. Freezing
5598 occurs when a bounce message encounters a permanent failure because the sender
5599 address of the original message that caused the bounce is invalid, so the
5600 bounce cannot be delivered. This is probably the most common case, but there
5601 are also other conditions that cause freezing, and frozen messages are not
5602 always bounce messages.
5603 .code
5604 ignore_bounce_errors_after = 2d
5605 timeout_frozen_after = 7d
5606 .endd
5607 The first of these options specifies that failing bounce messages are to be
5608 discarded after 2 days on the queue. The second specifies that any frozen
5609 message (whether a bounce message or not) is to be timed out (and discarded)
5610 after a week. In this configuration, the first setting ensures that no failing
5611 bounce message ever lasts a week.
5612
5613
5614
5615 .section "ACL configuration" "SECID54"
5616 .cindex "default" "ACLs"
5617 .cindex "&ACL;" "default configuration"
5618 In the default configuration, the ACL section follows the main configuration.
5619 It starts with the line
5620 .code
5621 begin acl
5622 .endd
5623 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5624 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5625 and &%acl_smtp_data%& above.
5626
5627 .cindex "RCPT" "ACL for"
5628 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5629 RCPT command specifies one of the message's recipients. The ACL statements
5630 are considered in order, until the recipient address is either accepted or
5631 rejected. The RCPT command is then accepted or rejected, according to the
5632 result of the ACL processing.
5633 .code
5634 acl_check_rcpt:
5635 .endd
5636 This line, consisting of a name terminated by a colon, marks the start of the
5637 ACL, and names it.
5638 .code
5639 accept  hosts = :
5640 .endd
5641 This ACL statement accepts the recipient if the sending host matches the list.
5642 But what does that strange list mean? It doesn't actually contain any host
5643 names or IP addresses. The presence of the colon puts an empty item in the
5644 list; Exim matches this only if the incoming message did not come from a remote
5645 host, because in that case, the remote hostname is empty. The colon is
5646 important. Without it, the list itself is empty, and can never match anything.
5647
5648 What this statement is doing is to accept unconditionally all recipients in
5649 messages that are submitted by SMTP from local processes using the standard
5650 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5651 manner.
5652 .code
5653 deny    message       = Restricted characters in address
5654         domains       = +local_domains
5655         local_parts   = ^[.] : ^.*[@%!/|]
5656
5657 deny    message       = Restricted characters in address
5658         domains       = !+local_domains
5659         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5660 .endd
5661 These statements are concerned with local parts that contain any of the
5662 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5663 Although these characters are entirely legal in local parts (in the case of
5664 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5665 in Internet mail addresses.
5666
5667 The first three have in the past been associated with explicitly routed
5668 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5669 option). Addresses containing these characters are regularly tried by spammers
5670 in an attempt to bypass relaying restrictions, and also by open relay testing
5671 programs. Unless you really need them it is safest to reject these characters
5672 at this early stage. This configuration is heavy-handed in rejecting these
5673 characters for all messages it accepts from remote hosts. This is a deliberate
5674 policy of being as safe as possible.
5675
5676 The first rule above is stricter, and is applied to messages that are addressed
5677 to one of the local domains handled by this host. This is implemented by the
5678 first condition, which restricts it to domains that are listed in the
5679 &'local_domains'& domain list. The &"+"& character is used to indicate a
5680 reference to a named list. In this configuration, there is just one domain in
5681 &'local_domains'&, but in general there may be many.
5682
5683 The second condition on the first statement uses two regular expressions to
5684 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5685 or &"|"&. If you have local accounts that include these characters, you will
5686 have to modify this rule.
5687
5688 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5689 allows them because they have been encountered in practice. (Consider the
5690 common convention of local parts constructed as
5691 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5692 the author of Exim, who has no second initial.) However, a local part starting
5693 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5694 file name (for example, for a mailing list). This is also true for local parts
5695 that contain slashes. A pipe symbol can also be troublesome if the local part
5696 is incorporated unthinkingly into a shell command line.
5697
5698 The second rule above applies to all other domains, and is less strict. This
5699 allows your own users to send outgoing messages to sites that use slashes
5700 and vertical bars in their local parts. It blocks local parts that begin
5701 with a dot, slash, or vertical bar, but allows these characters within the
5702 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5703 and &"!"& is blocked, as before. The motivation here is to prevent your users
5704 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5705 .code
5706 accept  local_parts   = postmaster
5707         domains       = +local_domains
5708 .endd
5709 This statement, which has two conditions, accepts an incoming address if the
5710 local part is &'postmaster'& and the domain is one of those listed in the
5711 &'local_domains'& domain list. The &"+"& character is used to indicate a
5712 reference to a named list. In this configuration, there is just one domain in
5713 &'local_domains'&, but in general there may be many.
5714
5715 The presence of this statement means that mail to postmaster is never blocked
5716 by any of the subsequent tests. This can be helpful while sorting out problems
5717 in cases where the subsequent tests are incorrectly denying access.
5718 .code
5719 require verify        = sender
5720 .endd
5721 This statement requires the sender address to be verified before any subsequent
5722 ACL statement can be used. If verification fails, the incoming recipient
5723 address is refused. Verification consists of trying to route the address, to
5724 see if a bounce message could be delivered to it. In the case of remote
5725 addresses, basic verification checks only the domain, but &'callouts'& can be
5726 used for more verification if required. Section &<<SECTaddressverification>>&
5727 discusses the details of address verification.
5728 .code
5729 accept  hosts         = +relay_from_hosts
5730         control       = submission
5731 .endd
5732 This statement accepts the address if the message is coming from one of the
5733 hosts that are defined as being allowed to relay through this host. Recipient
5734 verification is omitted here, because in many cases the clients are dumb MUAs
5735 that do not cope well with SMTP error responses. For the same reason, the
5736 second line specifies &"submission mode"& for messages that are accepted. This
5737 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5738 messages that are deficient in some way, for example, because they lack a
5739 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5740 probably add recipient verification here, and disable submission mode.
5741 .code
5742 accept  authenticated = *
5743         control       = submission
5744 .endd
5745 This statement accepts the address if the client host has authenticated itself.
5746 Submission mode is again specified, on the grounds that such messages are most
5747 likely to come from MUAs. The default configuration does not define any
5748 authenticators, though it does include some nearly complete commented-out
5749 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5750 fact authenticate until you complete the authenticator definitions.
5751 .code
5752 require message = relay not permitted
5753         domains = +local_domains : +relay_to_domains
5754 .endd
5755 This statement rejects the address if its domain is neither a local domain nor
5756 one of the domains for which this host is a relay.
5757 .code
5758 require verify = recipient
5759 .endd
5760 This statement requires the recipient address to be verified; if verification
5761 fails, the address is rejected.
5762 .code
5763 # deny    message     = rejected because $sender_host_address \
5764 #                       is in a black list at $dnslist_domain\n\
5765 #                       $dnslist_text
5766 #         dnslists    = black.list.example
5767 #
5768 # warn    dnslists    = black.list.example
5769 #         add_header  = X-Warning: $sender_host_address is in \
5770 #                       a black list at $dnslist_domain
5771 #         log_message = found in $dnslist_domain
5772 .endd
5773 These commented-out lines are examples of how you could configure Exim to check
5774 sending hosts against a DNS black list. The first statement rejects messages
5775 from blacklisted hosts, whereas the second just inserts a warning header
5776 line.
5777 .code
5778 # require verify = csa
5779 .endd
5780 This commented-out line is an example of how you could turn on client SMTP
5781 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5782 records.
5783 .code
5784 accept
5785 .endd
5786 The final statement in the first ACL unconditionally accepts any recipient
5787 address that has successfully passed all the previous tests.
5788 .code
5789 acl_check_data:
5790 .endd
5791 This line marks the start of the second ACL, and names it. Most of the contents
5792 of this ACL are commented out:
5793 .code
5794 # deny    malware   = *
5795 #         message   = This message contains a virus \
5796 #                     ($malware_name).
5797 .endd
5798 These lines are examples of how to arrange for messages to be scanned for
5799 viruses when Exim has been compiled with the content-scanning extension, and a
5800 suitable virus scanner is installed. If the message is found to contain a
5801 virus, it is rejected with the given custom error message.
5802 .code
5803 # warn    spam      = nobody
5804 #         message   = X-Spam_score: $spam_score\n\
5805 #                     X-Spam_score_int: $spam_score_int\n\
5806 #                     X-Spam_bar: $spam_bar\n\
5807 #                     X-Spam_report: $spam_report
5808 .endd
5809 These lines are an example of how to arrange for messages to be scanned by
5810 SpamAssassin when Exim has been compiled with the content-scanning extension,
5811 and SpamAssassin has been installed. The SpamAssassin check is run with
5812 &`nobody`& as its user parameter, and the results are added to the message as a
5813 series of extra header line. In this case, the message is not rejected,
5814 whatever the spam score.
5815 .code
5816 accept
5817 .endd
5818 This final line in the DATA ACL accepts the message unconditionally.
5819
5820
5821 .section "Router configuration" "SECID55"
5822 .cindex "default" "routers"
5823 .cindex "routers" "default"
5824 The router configuration comes next in the default configuration, introduced
5825 by the line
5826 .code
5827 begin routers
5828 .endd
5829 Routers are the modules in Exim that make decisions about where to send
5830 messages. An address is passed to each router in turn, until it is either
5831 accepted, or failed. This means that the order in which you define the routers
5832 matters. Each router is fully described in its own chapter later in this
5833 manual. Here we give only brief overviews.
5834 .code
5835 # domain_literal:
5836 #   driver = ipliteral
5837 #   domains = !+local_domains
5838 #   transport = remote_smtp
5839 .endd
5840 .cindex "domain literal" "default router"
5841 This router is commented out because the majority of sites do not want to
5842 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5843 you uncomment this router, you also need to uncomment the setting of
5844 &%allow_domain_literals%& in the main part of the configuration.
5845 .code
5846 dnslookup:
5847   driver = dnslookup
5848   domains = ! +local_domains
5849   transport = remote_smtp
5850   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5851   no_more
5852 .endd
5853 The first uncommented router handles addresses that do not involve any local
5854 domains. This is specified by the line
5855 .code
5856 domains = ! +local_domains
5857 .endd
5858 The &%domains%& option lists the domains to which this router applies, but the
5859 exclamation mark is a negation sign, so the router is used only for domains
5860 that are not in the domain list called &'local_domains'& (which was defined at
5861 the start of the configuration). The plus sign before &'local_domains'&
5862 indicates that it is referring to a named list. Addresses in other domains are
5863 passed on to the following routers.
5864
5865 The name of the router driver is &(dnslookup)&,
5866 and is specified by the &%driver%& option. Do not be confused by the fact that
5867 the name of this router instance is the same as the name of the driver. The
5868 instance name is arbitrary, but the name set in the &%driver%& option must be
5869 one of the driver modules that is in the Exim binary.
5870
5871 The &(dnslookup)& router routes addresses by looking up their domains in the
5872 DNS in order to obtain a list of hosts to which the address is routed. If the
5873 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5874 specified by the &%transport%& option. If the router does not find the domain
5875 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5876 the address fails and is bounced.
5877
5878 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5879 be entirely ignored. This option is present because a number of cases have been
5880 encountered where MX records in the DNS point to host names
5881 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5882 Completely ignoring these IP addresses causes Exim to fail to route the
5883 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5884 continue to try to deliver the message periodically until the address timed
5885 out.
5886 .code
5887 system_aliases:
5888   driver = redirect
5889   allow_fail
5890   allow_defer
5891   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5892 # user = exim
5893   file_transport = address_file
5894   pipe_transport = address_pipe
5895 .endd
5896 Control reaches this and subsequent routers only for addresses in the local
5897 domains. This router checks to see whether the local part is defined as an
5898 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5899 data that it looks up from that file. If no data is found for the local part,
5900 the value of the &%data%& option is empty, causing the address to be passed to
5901 the next router.
5902
5903 &_/etc/aliases_& is a conventional name for the system aliases file that is
5904 often used. That is why it is referenced by from the default configuration
5905 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5906 &_Local/Makefile_& before building Exim.
5907 .code
5908 userforward:
5909   driver = redirect
5910   check_local_user
5911 # local_part_suffix = +* : -*
5912 # local_part_suffix_optional
5913   file = $home/.forward
5914 # allow_filter
5915   no_verify
5916   no_expn
5917   check_ancestor
5918   file_transport = address_file
5919   pipe_transport = address_pipe
5920   reply_transport = address_reply
5921 .endd
5922 This is the most complicated router in the default configuration. It is another
5923 redirection router, but this time it is looking for forwarding data set up by
5924 individual users. The &%check_local_user%& setting specifies a check that the
5925 local part of the address is the login name of a local user. If it is not, the
5926 router is skipped. The two commented options that follow &%check_local_user%&,
5927 namely:
5928 .code
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931 .endd
5932 .vindex "&$local_part_suffix$&"
5933 show how you can specify the recognition of local part suffixes. If the first
5934 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5935 by any sequence of characters, is removed from the local part and placed in the
5936 variable &$local_part_suffix$&. The second suffix option specifies that the
5937 presence of a suffix in the local part is optional. When a suffix is present,
5938 the check for a local login uses the local part with the suffix removed.
5939
5940 When a local user account is found, the file called &_.forward_& in the user's
5941 home directory is consulted. If it does not exist, or is empty, the router
5942 declines. Otherwise, the contents of &_.forward_& are interpreted as
5943 redirection data (see chapter &<<CHAPredirect>>& for more details).
5944
5945 .cindex "Sieve filter" "enabling in default router"
5946 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5947 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5948 is commented out by default), the contents of the file are interpreted as a set
5949 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5950 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5951 separate document entitled &'Exim's interfaces to mail filtering'&.
5952
5953 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5954 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5955 There are two reasons for doing this:
5956
5957 .olist
5958 Whether or not a local user has a &_.forward_& file is not really relevant when
5959 checking an address for validity; it makes sense not to waste resources doing
5960 unnecessary work.
5961 .next
5962 More importantly, when Exim is verifying addresses or handling an EXPN
5963 command during an SMTP session, it is running as the Exim user, not as root.
5964 The group is the Exim group, and no additional groups are set up.
5965 It may therefore not be possible for Exim to read users' &_.forward_& files at
5966 this time.
5967 .endlist
5968
5969 The setting of &%check_ancestor%& prevents the router from generating a new
5970 address that is the same as any previous address that was redirected. (This
5971 works round a problem concerning a bad interaction between aliasing and
5972 forwarding &-- see section &<<SECTredlocmai>>&).
5973
5974 The final three option settings specify the transports that are to be used when
5975 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5976 auto-reply, respectively. For example, if a &_.forward_& file contains
5977 .code
5978 a.nother@elsewhere.example, /home/spqr/archive
5979 .endd
5980 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5981 transport.
5982 .code
5983 localuser:
5984   driver = accept
5985   check_local_user
5986 # local_part_suffix = +* : -*
5987 # local_part_suffix_optional
5988   transport = local_delivery
5989 .endd
5990 The final router sets up delivery into local mailboxes, provided that the local
5991 part is the name of a local login, by accepting the address and assigning it to
5992 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5993 routers, so the address is bounced. The commented suffix settings fulfil the
5994 same purpose as they do for the &(userforward)& router.
5995
5996
5997 .section "Transport configuration" "SECID56"
5998 .cindex "default" "transports"
5999 .cindex "transports" "default"
6000 Transports define mechanisms for actually delivering messages. They operate
6001 only when referenced from routers, so the order in which they are defined does
6002 not matter. The transports section of the configuration starts with
6003 .code
6004 begin transports
6005 .endd
6006 One remote transport and four local transports are defined.
6007 .code
6008 remote_smtp:
6009   driver = smtp
6010   hosts_try_prdr = *
6011 .endd
6012 This transport is used for delivering messages over SMTP connections.
6013 The list of remote hosts comes from the router.
6014 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6015 It is negotiated between client and server
6016 and not expected to cause problems but can be disabled if needed.
6017 All other options are defaulted.
6018 .code
6019 local_delivery:
6020   driver = appendfile
6021   file = /var/mail/$local_part
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 # group = mail
6026 # mode = 0660
6027 .endd
6028 This &(appendfile)& transport is used for local delivery to user mailboxes in
6029 traditional BSD mailbox format. By default it runs under the uid and gid of the
6030 local user, which requires the sticky bit to be set on the &_/var/mail_&
6031 directory. Some systems use the alternative approach of running mail deliveries
6032 under a particular group instead of using the sticky bit. The commented options
6033 show how this can be done.
6034
6035 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6036 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6037 similarly-named options above.
6038 .code
6039 address_pipe:
6040   driver = pipe
6041   return_output
6042 .endd
6043 This transport is used for handling deliveries to pipes that are generated by
6044 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6045 option specifies that any output generated by the pipe is to be returned to the
6046 sender.
6047 .code
6048 address_file:
6049   driver = appendfile
6050   delivery_date_add
6051   envelope_to_add
6052   return_path_add
6053 .endd
6054 This transport is used for handling deliveries to files that are generated by
6055 redirection. The name of the file is not specified in this instance of
6056 &(appendfile)&, because it comes from the &(redirect)& router.
6057 .code
6058 address_reply:
6059   driver = autoreply
6060 .endd
6061 This transport is used for handling automatic replies generated by users'
6062 filter files.
6063
6064
6065
6066 .section "Default retry rule" "SECID57"
6067 .cindex "retry" "default rule"
6068 .cindex "default" "retry rule"
6069 The retry section of the configuration file contains rules which affect the way
6070 Exim retries deliveries that cannot be completed at the first attempt. It is
6071 introduced by the line
6072 .code
6073 begin retry
6074 .endd
6075 In the default configuration, there is just one rule, which applies to all
6076 errors:
6077 .code
6078 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6079 .endd
6080 This causes any temporarily failing address to be retried every 15 minutes for
6081 2 hours, then at intervals starting at one hour and increasing by a factor of
6082 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6083 is not delivered after 4 days of temporary failure, it is bounced.
6084
6085 If the retry section is removed from the configuration, or is empty (that is,
6086 if no retry rules are defined), Exim will not retry deliveries. This turns
6087 temporary errors into permanent errors.
6088
6089
6090 .section "Rewriting configuration" "SECID58"
6091 The rewriting section of the configuration, introduced by
6092 .code
6093 begin rewrite
6094 .endd
6095 contains rules for rewriting addresses in messages as they arrive. There are no
6096 rewriting rules in the default configuration file.
6097
6098
6099
6100 .section "Authenticators configuration" "SECTdefconfauth"
6101 .cindex "AUTH" "configuration"
6102 The authenticators section of the configuration, introduced by
6103 .code
6104 begin authenticators
6105 .endd
6106 defines mechanisms for the use of the SMTP AUTH command. The default
6107 configuration file contains two commented-out example authenticators
6108 which support plaintext username/password authentication using the
6109 standard PLAIN mechanism and the traditional but non-standard LOGIN
6110 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6111 to support most MUA software.
6112
6113 The example PLAIN authenticator looks like this:
6114 .code
6115 #PLAIN:
6116 #  driver                  = plaintext
6117 #  server_set_id           = $auth2
6118 #  server_prompts          = :
6119 #  server_condition        = Authentication is not yet configured
6120 #  server_advertise_condition = ${if def:tls_in_cipher }
6121 .endd
6122 And the example LOGIN authenticator looks like this:
6123 .code
6124 #LOGIN:
6125 #  driver                  = plaintext
6126 #  server_set_id           = $auth1
6127 #  server_prompts          = <| Username: | Password:
6128 #  server_condition        = Authentication is not yet configured
6129 #  server_advertise_condition = ${if def:tls_in_cipher }
6130 .endd
6131
6132 The &%server_set_id%& option makes Exim remember the authenticated username
6133 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6134 &%server_prompts%& option configures the &(plaintext)& authenticator so
6135 that it implements the details of the specific authentication mechanism,
6136 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6137 when Exim offers authentication to clients; in the examples, this is only
6138 when TLS or SSL has been started, so to enable the authenticators you also
6139 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6140
6141 The &%server_condition%& setting defines how to verify that the username and
6142 password are correct. In the examples it just produces an error message.
6143 To make the authenticators work, you can use a string expansion
6144 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6145
6146 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6147 usercode and password are in different positions.
6148 Chapter &<<CHAPplaintext>>& covers both.
6149
6150 .ecindex IIDconfiwal
6151
6152
6153
6154 . ////////////////////////////////////////////////////////////////////////////
6155 . ////////////////////////////////////////////////////////////////////////////
6156
6157 .chapter "Regular expressions" "CHAPregexp"
6158
6159 .cindex "regular expressions" "library"
6160 .cindex "PCRE"
6161 Exim supports the use of regular expressions in many of its options. It
6162 uses the PCRE regular expression library; this provides regular expression
6163 matching that is compatible with Perl 5. The syntax and semantics of
6164 regular expressions is discussed in many Perl reference books, and also in
6165 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6166 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6167
6168 The documentation for the syntax and semantics of the regular expressions that
6169 are supported by PCRE is included in the PCRE distribution, and no further
6170 description is included here. The PCRE functions are called from Exim using
6171 the default option settings (that is, with no PCRE options set), except that
6172 the PCRE_CASELESS option is set when the matching is required to be
6173 case-insensitive.
6174
6175 In most cases, when a regular expression is required in an Exim configuration,
6176 it has to start with a circumflex, in order to distinguish it from plain text
6177 or an &"ends with"& wildcard. In this example of a configuration setting, the
6178 second item in the colon-separated list is a regular expression.
6179 .code
6180 domains = a.b.c : ^\\d{3} : *.y.z : ...
6181 .endd
6182 The doubling of the backslash is required because of string expansion that
6183 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6184 of this issue, and a way of avoiding the need for doubling backslashes. The
6185 regular expression that is eventually used in this example contains just one
6186 backslash. The circumflex is included in the regular expression, and has the
6187 normal effect of &"anchoring"& it to the start of the string that is being
6188 matched.
6189
6190 There are, however, two cases where a circumflex is not required for the
6191 recognition of a regular expression: these are the &%match%& condition in a
6192 string expansion, and the &%matches%& condition in an Exim filter file. In
6193 these cases, the relevant string is always treated as a regular expression; if
6194 it does not start with a circumflex, the expression is not anchored, and can
6195 match anywhere in the subject string.
6196
6197 In all cases, if you want a regular expression to match at the end of a string,
6198 you must code the $ metacharacter to indicate this. For example:
6199 .code
6200 domains = ^\\d{3}\\.example
6201 .endd
6202 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6203 You need to use:
6204 .code
6205 domains = ^\\d{3}\\.example\$
6206 .endd
6207 if you want &'example'& to be the top-level domain. The backslash before the
6208 $ is needed because string expansion also interprets dollar characters.
6209
6210
6211
6212 . ////////////////////////////////////////////////////////////////////////////
6213 . ////////////////////////////////////////////////////////////////////////////
6214
6215 .chapter "File and database lookups" "CHAPfdlookup"
6216 .scindex IIDfidalo1 "file" "lookups"
6217 .scindex IIDfidalo2 "database" "lookups"
6218 .cindex "lookup" "description of"
6219 Exim can be configured to look up data in files or databases as it processes
6220 messages. Two different kinds of syntax are used:
6221
6222 .olist
6223 A string that is to be expanded may contain explicit lookup requests. These
6224 cause parts of the string to be replaced by data that is obtained from the
6225 lookup. Lookups of this type are conditional expansion items. Different results
6226 can be defined for the cases of lookup success and failure. See chapter
6227 &<<CHAPexpand>>&, where string expansions are described in detail.
6228 .next
6229 Lists of domains, hosts, and email addresses can contain lookup requests as a
6230 way of avoiding excessively long linear lists. In this case, the data that is
6231 returned by the lookup is often (but not always) discarded; whether the lookup
6232 succeeds or fails is what really counts. These kinds of list are described in
6233 chapter &<<CHAPdomhosaddlists>>&.
6234 .endlist
6235
6236 String expansions, lists, and lookups interact with each other in such a way
6237 that there is no order in which to describe any one of them that does not
6238 involve references to the others. Each of these three chapters makes more sense
6239 if you have read the other two first. If you are reading this for the first
6240 time, be aware that some of it will make a lot more sense after you have read
6241 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6242
6243 .section "Examples of different lookup syntax" "SECID60"
6244 It is easy to confuse the two different kinds of lookup, especially as the
6245 lists that may contain the second kind are always expanded before being
6246 processed as lists. Therefore, they may also contain lookups of the first kind.
6247 Be careful to distinguish between the following two examples:
6248 .code
6249 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6250 domains = lsearch;/some/file
6251 .endd
6252 The first uses a string expansion, the result of which must be a domain list.
6253 No strings have been specified for a successful or a failing lookup; the
6254 defaults in this case are the looked-up data and an empty string, respectively.
6255 The expansion takes place before the string is processed as a list, and the
6256 file that is searched could contain lines like this:
6257 .code
6258 192.168.3.4: domain1:domain2:...
6259 192.168.1.9: domain3:domain4:...
6260 .endd
6261 When the lookup succeeds, the result of the expansion is a list of domains (and
6262 possibly other types of item that are allowed in domain lists).
6263
6264 In the second example, the lookup is a single item in a domain list. It causes
6265 Exim to use a lookup to see if the domain that is being processed can be found
6266 in the file. The file could contains lines like this:
6267 .code
6268 domain1:
6269 domain2:
6270 .endd
6271 Any data that follows the keys is not relevant when checking that the domain
6272 matches the list item.
6273
6274 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6275 Consider a file containing lines like this:
6276 .code
6277 192.168.5.6: lsearch;/another/file
6278 .endd
6279 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6280 first &%domains%& setting above generates the second setting, which therefore
6281 causes a second lookup to occur.
6282
6283 The rest of this chapter describes the different lookup types that are
6284 available. Any of them can be used in any part of the configuration where a
6285 lookup is permitted.
6286
6287
6288 .section "Lookup types" "SECID61"
6289 .cindex "lookup" "types of"
6290 .cindex "single-key lookup" "definition of"
6291 Two different types of data lookup are implemented:
6292
6293 .ilist
6294 The &'single-key'& type requires the specification of a file in which to look,
6295 and a single key to search for. The key must be a non-empty string for the
6296 lookup to succeed. The lookup type determines how the file is searched.
6297 .next
6298 .cindex "query-style lookup" "definition of"
6299 The &'query-style'& type accepts a generalized database query. No particular
6300 key value is assumed by Exim for query-style lookups. You can use whichever
6301 Exim variables you need to construct the database query.
6302 .endlist
6303
6304 The code for each lookup type is in a separate source file that is included in
6305 the binary of Exim only if the corresponding compile-time option is set. The
6306 default settings in &_src/EDITME_& are:
6307 .code
6308 LOOKUP_DBM=yes
6309 LOOKUP_LSEARCH=yes
6310 .endd
6311 which means that only linear searching and DBM lookups are included by default.
6312 For some types of lookup (e.g. SQL databases), you need to install appropriate
6313 libraries and header files before building Exim.
6314
6315
6316
6317
6318 .section "Single-key lookup types" "SECTsinglekeylookups"
6319 .cindex "lookup" "single-key types"
6320 .cindex "single-key lookup" "list of types"
6321 The following single-key lookup types are implemented:
6322
6323 .ilist
6324 .cindex "cdb" "description of"
6325 .cindex "lookup" "cdb"
6326 .cindex "binary zero" "in lookup key"
6327 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6328 string without a terminating binary zero. The cdb format is designed for
6329 indexed files that are read frequently and never updated, except by total
6330 re-creation. As such, it is particularly suitable for large files containing
6331 aliases or other indexed data referenced by an MTA. Information about cdb can
6332 be found in several places:
6333 .display
6334 &url(http://www.pobox.com/~djb/cdb.html)
6335 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6336 &url(http://packages.debian.org/stable/utils/freecdb.html)
6337 .endd
6338 A cdb distribution is not needed in order to build Exim with cdb support,
6339 because the code for reading cdb files is included directly in Exim itself.
6340 However, no means of building or testing cdb files is provided with Exim, so
6341 you need to obtain a cdb distribution in order to do this.
6342 .next
6343 .cindex "DBM" "lookup type"
6344 .cindex "lookup" "dbm"
6345 .cindex "binary zero" "in lookup key"
6346 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6347 DBM file by looking up the record with the given key. A terminating binary
6348 zero is included in the key that is passed to the DBM library. See section
6349 &<<SECTdb>>& for a discussion of DBM libraries.
6350
6351 .cindex "Berkeley DB library" "file format"
6352 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6353 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6354 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6355 the DB_UNKNOWN option. This enables it to handle any of the types of database
6356 that the library supports, and can be useful for accessing DBM files created by
6357 other applications. (For earlier DB versions, DB_HASH is always used.)
6358 .next
6359 .cindex "lookup" "dbmjz"
6360 .cindex "lookup" "dbm &-- embedded NULs"
6361 .cindex "sasldb2"
6362 .cindex "dbmjz lookup type"
6363 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6364 interpreted as an Exim list; the elements of the list are joined together with
6365 ASCII NUL characters to form the lookup key.  An example usage would be to
6366 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6367 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6368 &(cram_md5)& authenticator.
6369 .next
6370 .cindex "lookup" "dbmnz"
6371 .cindex "lookup" "dbm &-- terminating zero"
6372 .cindex "binary zero" "in lookup key"
6373 .cindex "Courier"
6374 .cindex "&_/etc/userdbshadow.dat_&"
6375 .cindex "dbmnz lookup type"
6376 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6377 is not included in the key that is passed to the DBM library. You may need this
6378 if you want to look up data in files that are created by or shared with some
6379 other application that does not use terminating zeros. For example, you need to
6380 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6381 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6382 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6383 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6384 .next
6385 .cindex "lookup" "dsearch"
6386 .cindex "dsearch lookup type"
6387 &(dsearch)&: The given file must be a directory; this is searched for an entry
6388 whose name is the key by calling the &[lstat()]& function. The key may not
6389 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6390 the lookup is the name of the entry, which may be a file, directory,
6391 symbolic link, or any other kind of directory entry. An example of how this
6392 lookup can be used to support virtual domains is given in section
6393 &<<SECTvirtualdomains>>&.
6394 .next
6395 .cindex "lookup" "iplsearch"
6396 .cindex "iplsearch lookup type"
6397 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6398 terminated by a colon or white space or the end of the line. The keys in the
6399 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6400 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6401 being interpreted as a key terminator. For example:
6402 .code
6403 1.2.3.4:           data for 1.2.3.4
6404 192.168.0.0/16:    data for 192.168.0.0/16
6405 "abcd::cdab":      data for abcd::cdab
6406 "abcd:abcd::/32"   data for abcd:abcd::/32
6407 .endd
6408 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6409 file is searched linearly, using the CIDR masks where present, until a matching
6410 key is found. The first key that matches is used; there is no attempt to find a
6411 &"best"& match. Apart from the way the keys are matched, the processing for
6412 &(iplsearch)& is the same as for &(lsearch)&.
6413
6414 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6415 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6416 lookup types support only literal keys.
6417
6418 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6419 the implicit key is the host's IP address rather than its name (see section
6420 &<<SECThoslispatsikey>>&).
6421 .next
6422 .cindex "linear search"
6423 .cindex "lookup" "lsearch"
6424 .cindex "lsearch lookup type"
6425 .cindex "case sensitivity" "in lsearch lookup"
6426 &(lsearch)&: The given file is a text file that is searched linearly for a
6427 line beginning with the search key, terminated by a colon or white space or the
6428 end of the line. The search is case-insensitive; that is, upper and lower case
6429 letters are treated as the same. The first occurrence of the key that is found
6430 in the file is used.
6431
6432 White space between the key and the colon is permitted. The remainder of the
6433 line, with leading and trailing white space removed, is the data. This can be
6434 continued onto subsequent lines by starting them with any amount of white
6435 space, but only a single space character is included in the data at such a
6436 junction. If the data begins with a colon, the key must be terminated by a
6437 colon, for example:
6438 .code
6439 baduser:  :fail:
6440 .endd
6441 Empty lines and lines beginning with # are ignored, even if they occur in the
6442 middle of an item. This is the traditional textual format of alias files. Note
6443 that the keys in an &(lsearch)& file are literal strings. There is no
6444 wildcarding of any kind.
6445
6446 .cindex "lookup" "lsearch &-- colons in keys"
6447 .cindex "white space" "in lsearch key"
6448 In most &(lsearch)& files, keys are not required to contain colons or #
6449 characters, or white space. However, if you need this feature, it is available.
6450 If a key begins with a doublequote character, it is terminated only by a
6451 matching quote (or end of line), and the normal escaping rules apply to its
6452 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6453 quoted keys (exactly as for unquoted keys). There is no special handling of
6454 quotes for the data part of an &(lsearch)& line.
6455
6456 .next
6457 .cindex "NIS lookup type"
6458 .cindex "lookup" "NIS"
6459 .cindex "binary zero" "in lookup key"
6460 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6461 the given key, without a terminating binary zero. There is a variant called
6462 &(nis0)& which does include the terminating binary zero in the key. This is
6463 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6464 aliases; the full map names must be used.
6465
6466 .next
6467 .cindex "wildlsearch lookup type"
6468 .cindex "lookup" "wildlsearch"
6469 .cindex "nwildlsearch lookup type"
6470 .cindex "lookup" "nwildlsearch"
6471 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6472 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6473 the file may be wildcarded. The difference between these two lookup types is
6474 that for &(wildlsearch)&, each key in the file is string-expanded before being
6475 used, whereas for &(nwildlsearch)&, no expansion takes place.
6476
6477 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6478 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6479 file that are regular expressions can be made case-sensitive by the use of
6480 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6481
6482 . ==== As this is a nested list, any displays it contains must be indented
6483 . ==== as otherwise they are too far to the left.
6484
6485 .olist
6486 The string may begin with an asterisk to mean &"ends with"&. For example:
6487 .code
6488     *.a.b.c       data for anything.a.b.c
6489     *fish         data for anythingfish
6490 .endd
6491 .next
6492 The string may begin with a circumflex to indicate a regular expression. For
6493 example, for &(wildlsearch)&:
6494 .code
6495     ^\N\d+\.a\.b\N    data for <digits>.a.b
6496 .endd
6497 Note the use of &`\N`& to disable expansion of the contents of the regular
6498 expression. If you are using &(nwildlsearch)&, where the keys are not
6499 string-expanded, the equivalent entry is:
6500 .code
6501     ^\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503 The case-insensitive flag is set at the start of compiling the regular
6504 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6505 For example, to make the entire pattern case-sensitive:
6506 .code
6507     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6508 .endd
6509
6510 If the regular expression contains white space or colon characters, you must
6511 either quote it (see &(lsearch)& above), or represent these characters in other
6512 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6513 colon. This may be easier than quoting, because if you quote, you have to
6514 escape all the backslashes inside the quotes.
6515
6516 &*Note*&: It is not possible to capture substrings in a regular expression
6517 match for later use, because the results of all lookups are cached. If a lookup
6518 is repeated, the result is taken from the cache, and no actual pattern matching
6519 takes place. The values of all the numeric variables are unset after a
6520 &((n)wildlsearch)& match.
6521
6522 .next
6523 Although I cannot see it being of much use, the general matching function that
6524 is used to implement &((n)wildlsearch)& means that the string may begin with a
6525 lookup name terminated by a semicolon, and followed by lookup data. For
6526 example:
6527 .code
6528     cdb;/some/file  data for keys that match the file
6529 .endd
6530 The data that is obtained from the nested lookup is discarded.
6531 .endlist olist
6532
6533 Keys that do not match any of these patterns are interpreted literally. The
6534 continuation rules for the data are the same as for &(lsearch)&, and keys may
6535 be followed by optional colons.
6536
6537 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6538 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6539 lookup types support only literal keys.
6540 .endlist ilist
6541
6542
6543 .section "Query-style lookup types" "SECID62"
6544 .cindex "lookup" "query-style types"
6545 .cindex "query-style lookup" "list of types"
6546 The supported query-style lookup types are listed below. Further details about
6547 many of them are given in later sections.
6548
6549 .ilist
6550 .cindex "DNS" "as a lookup type"
6551 .cindex "lookup" "DNS"
6552 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6553 are given in the supplied query. The resulting data is the contents of the
6554 records. See section &<<SECTdnsdb>>&.
6555 .next
6556 .cindex "InterBase lookup type"
6557 .cindex "lookup" "InterBase"
6558 &(ibase)&: This does a lookup in an InterBase database.
6559 .next
6560 .cindex "LDAP" "lookup type"
6561 .cindex "lookup" "LDAP"
6562 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6563 returns attributes from a single entry. There is a variant called &(ldapm)&
6564 that permits values from multiple entries to be returned. A third variant
6565 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6566 any attribute values. See section &<<SECTldap>>&.
6567 .next
6568 .cindex "MySQL" "lookup type"
6569 .cindex "lookup" "MySQL"
6570 &(mysql)&: The format of the query is an SQL statement that is passed to a
6571 MySQL database. See section &<<SECTsql>>&.
6572 .next
6573 .cindex "NIS+ lookup type"
6574 .cindex "lookup" "NIS+"
6575 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6576 the field to be returned. See section &<<SECTnisplus>>&.
6577 .next
6578 .cindex "Oracle" "lookup type"
6579 .cindex "lookup" "Oracle"
6580 &(oracle)&: The format of the query is an SQL statement that is passed to an
6581 Oracle database. See section &<<SECTsql>>&.
6582 .next
6583 .cindex "lookup" "passwd"
6584 .cindex "passwd lookup type"
6585 .cindex "&_/etc/passwd_&"
6586 &(passwd)& is a query-style lookup with queries that are just user names. The
6587 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6588 success, the result string is the same as you would get from an &(lsearch)&
6589 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6590 password value. For example:
6591 .code
6592 *:42:42:King Rat:/home/kr:/bin/bash
6593 .endd
6594 .next
6595 .cindex "PostgreSQL lookup type"
6596 .cindex "lookup" "PostgreSQL"
6597 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6598 PostgreSQL database. See section &<<SECTsql>>&.
6599
6600 .next
6601 .cindex "sqlite lookup type"
6602 .cindex "lookup" "sqlite"
6603 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6604 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6605
6606 .next
6607 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6608 not likely to be useful in normal operation.
6609 .next
6610 .cindex "whoson lookup type"
6611 .cindex "lookup" "whoson"
6612 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6613 allows a server to check whether a particular (dynamically allocated) IP
6614 address is currently allocated to a known (trusted) user and, optionally, to
6615 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6616 at one time for &"POP before SMTP"& authentication, but that approach has been
6617 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6618 &"POP before SMTP"& checking using ACL statements such as
6619 .code
6620 require condition = \
6621   ${lookup whoson {$sender_host_address}{yes}{no}}
6622 .endd
6623 The query consists of a single IP address. The value returned is the name of
6624 the authenticated user, which is stored in the variable &$value$&. However, in
6625 this example, the data in &$value$& is not used; the result of the lookup is
6626 one of the fixed strings &"yes"& or &"no"&.
6627 .endlist
6628
6629
6630
6631 .section "Temporary errors in lookups" "SECID63"
6632 .cindex "lookup" "temporary error in"
6633 Lookup functions can return temporary error codes if the lookup cannot be
6634 completed. For example, an SQL or LDAP database might be unavailable. For this
6635 reason, it is not advisable to use a lookup that might do this for critical
6636 options such as a list of local domains.
6637
6638 When a lookup cannot be completed in a router or transport, delivery
6639 of the message (to the relevant address) is deferred, as for any other
6640 temporary error. In other circumstances Exim may assume the lookup has failed,
6641 or may give up altogether.
6642
6643
6644
6645 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6646 .cindex "wildcard lookups"
6647 .cindex "lookup" "default values"
6648 .cindex "lookup" "wildcard"
6649 .cindex "lookup" "* added to type"
6650 .cindex "default" "in single-key lookups"
6651 In this context, a &"default value"& is a value specified by the administrator
6652 that is to be used if a lookup fails.
6653
6654 &*Note:*& This section applies only to single-key lookups. For query-style
6655 lookups, the facilities of the query language must be used. An attempt to
6656 specify a default for a query-style lookup provokes an error.
6657
6658 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6659 and the initial lookup fails, the key &"*"& is looked up in the file to
6660 provide a default value. See also the section on partial matching below.
6661
6662 .cindex "*@ with single-key lookup"
6663 .cindex "lookup" "*@ added to type"
6664 .cindex "alias file" "per-domain default"
6665 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6666 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6667 character, a second lookup is done with everything before the last @ replaced
6668 by *. This makes it possible to provide per-domain defaults in alias files
6669 that include the domains in the keys. If the second lookup fails (or doesn't
6670 take place because there is no @ in the key), &"*"& is looked up.
6671 For example, a &(redirect)& router might contain:
6672 .code
6673 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6674 .endd
6675 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6676 looks up these keys, in this order:
6677 .code
6678 jane@eyre.example
6679 *@eyre.example
6680 *
6681 .endd
6682 The data is taken from whichever key it finds first. &*Note*&: In an
6683 &(lsearch)& file, this does not mean the first of these keys in the file. A
6684 complete scan is done for each key, and only if it is not found at all does
6685 Exim move on to try the next key.
6686
6687
6688
6689 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6690 .cindex "partial matching"
6691 .cindex "wildcard lookups"
6692 .cindex "lookup" "partial matching"
6693 .cindex "lookup" "wildcard"
6694 .cindex "asterisk" "in search type"
6695 The normal operation of a single-key lookup is to search the file for an exact
6696 match with the given key. However, in a number of situations where domains are
6697 being looked up, it is useful to be able to do partial matching. In this case,
6698 information in the file that has a key starting with &"*."& is matched by any
6699 domain that ends with the components that follow the full stop. For example, if
6700 a key in a DBM file is
6701 .code
6702 *.dates.fict.example
6703 .endd
6704 then when partial matching is enabled this is matched by (amongst others)
6705 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6706 by &'dates.fict.example'&, if that does not appear as a separate key in the
6707 file.
6708
6709 &*Note*&: Partial matching is not available for query-style lookups. It is
6710 also not available for any lookup items in address lists (see section
6711 &<<SECTaddresslist>>&).
6712
6713 Partial matching is implemented by doing a series of separate lookups using
6714 keys constructed by modifying the original subject key. This means that it can
6715 be used with any of the single-key lookup types, provided that
6716 partial matching keys
6717 beginning with a special prefix (default &"*."&) are included in the data file.
6718 Keys in the file that do not begin with the prefix are matched only by
6719 unmodified subject keys when partial matching is in use.
6720
6721 Partial matching is requested by adding the string &"partial-"& to the front of
6722 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6723 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6724 is added at the start of the subject key, and it is looked up again. If that
6725 fails, further lookups are tried with dot-separated components removed from the
6726 start of the subject key, one-by-one, and &"*."& added on the front of what
6727 remains.
6728
6729 A minimum number of two non-* components are required. This can be adjusted
6730 by including a number before the hyphen in the search type. For example,
6731 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6732 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6733 subject key is &'2250.dates.fict.example'& then the following keys are looked
6734 up when the minimum number of non-* components is two:
6735 .code
6736 2250.dates.fict.example
6737 *.2250.dates.fict.example
6738 *.dates.fict.example
6739 *.fict.example
6740 .endd
6741 As soon as one key in the sequence is successfully looked up, the lookup
6742 finishes.
6743
6744 .cindex "lookup" "partial matching &-- changing prefix"
6745 .cindex "prefix" "for partial matching"
6746 The use of &"*."& as the partial matching prefix is a default that can be
6747 changed. The motivation for this feature is to allow Exim to operate with file
6748 formats that are used by other MTAs. A different prefix can be supplied in
6749 parentheses instead of the hyphen after &"partial"&. For example:
6750 .code
6751 domains = partial(.)lsearch;/some/file
6752 .endd
6753 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6754 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6755 components is unchanged). The prefix may consist of any punctuation characters
6756 other than a closing parenthesis. It may be empty, for example:
6757 .code
6758 domains = partial1()cdb;/some/file
6759 .endd
6760 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6761 &`a.b.c`&, &`b.c`&, and &`c`&.
6762
6763 If &"partial0"& is specified, what happens at the end (when the lookup with
6764 just one non-wild component has failed, and the original key is shortened right
6765 down to the null string) depends on the prefix:
6766
6767 .ilist
6768 If the prefix has zero length, the whole lookup fails.
6769 .next
6770 If the prefix has length 1, a lookup for just the prefix is done. For
6771 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6772 .next
6773 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6774 remainder is looked up. With the default prefix, therefore, the final lookup is
6775 for &"*"& on its own.
6776 .next
6777 Otherwise, the whole prefix is looked up.
6778 .endlist
6779
6780
6781 If the search type ends in &"*"& or &"*@"& (see section
6782 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6783 this implies happens after all partial lookups have failed. If &"partial0"& is
6784 specified, adding &"*"& to the search type has no effect with the default
6785 prefix, because the &"*"& key is already included in the sequence of partial
6786 lookups. However, there might be a use for lookup types such as
6787 &"partial0(.)lsearch*"&.
6788
6789 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6790 in domain lists and the like. Partial matching works only in terms of
6791 dot-separated components; a key such as &`*fict.example`&
6792 in a database file is useless, because the asterisk in a partial matching
6793 subject key is always followed by a dot.
6794
6795
6796
6797
6798 .section "Lookup caching" "SECID64"
6799 .cindex "lookup" "caching"
6800 .cindex "caching" "lookup data"
6801 Exim caches all lookup results in order to avoid needless repetition of
6802 lookups. However, because (apart from the daemon) Exim operates as a collection
6803 of independent, short-lived processes, this caching applies only within a
6804 single Exim process. There is no inter-process lookup caching facility.
6805
6806 For single-key lookups, Exim keeps the relevant files open in case there is
6807 another lookup that needs them. In some types of configuration this can lead to
6808 many files being kept open for messages with many recipients. To avoid hitting
6809 the operating system limit on the number of simultaneously open files, Exim
6810 closes the least recently used file when it needs to open more files than its
6811 own internal limit, which can be changed via the &%lookup_open_max%& option.
6812
6813 The single-key lookup files are closed and the lookup caches are flushed at
6814 strategic points during delivery &-- for example, after all routing is
6815 complete.
6816
6817
6818
6819
6820 .section "Quoting lookup data" "SECID65"
6821 .cindex "lookup" "quoting"
6822 .cindex "quoting" "in lookups"
6823 When data from an incoming message is included in a query-style lookup, there
6824 is the possibility of special characters in the data messing up the syntax of
6825 the query. For example, a NIS+ query that contains
6826 .code
6827 [name=$local_part]
6828 .endd
6829 will be broken if the local part happens to contain a closing square bracket.
6830 For NIS+, data can be enclosed in double quotes like this:
6831 .code
6832 [name="$local_part"]
6833 .endd
6834 but this still leaves the problem of a double quote in the data. The rule for
6835 NIS+ is that double quotes must be doubled. Other lookup types have different
6836 rules, and to cope with the differing requirements, an expansion operator
6837 of the following form is provided:
6838 .code
6839 ${quote_<lookup-type>:<string>}
6840 .endd
6841 For example, the safest way to write the NIS+ query is
6842 .code
6843 [name="${quote_nisplus:$local_part}"]
6844 .endd
6845 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6846 operator can be used for all lookup types, but has no effect for single-key
6847 lookups, since no quoting is ever needed in their key strings.
6848
6849
6850
6851
6852 .section "More about dnsdb" "SECTdnsdb"
6853 .cindex "dnsdb lookup"
6854 .cindex "lookup" "dnsdb"
6855 .cindex "DNS" "as a lookup type"
6856 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6857 of a record type and a domain name, separated by an equals sign. For example,
6858 an expansion string could contain:
6859 .code
6860 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6861 .endd
6862 If the lookup succeeds, the result is placed in &$value$&, which in this case
6863 is used on its own as the result. If the lookup does not succeed, the
6864 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6865 &<<SECTforexpfai>>& for an explanation of what this means.
6866
6867 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6868 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6869 configured). If no type is given, TXT is assumed. When the type is PTR,
6870 the data can be an IP address, written as normal; inversion and the addition of
6871 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6872 .code
6873 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6874 .endd
6875 If the data for a PTR record is not a syntactically valid IP address, it is not
6876 altered and nothing is added.
6877
6878 For any record type, if multiple records are found (or, for A6 lookups, if a
6879 single record leads to multiple addresses), the data is returned as a
6880 concatenation, with newline as the default separator. The order, of course,
6881 depends on the DNS resolver. You can specify a different separator character
6882 between multiple records by putting a right angle-bracket followed immediately
6883 by the new separator at the start of the query. For example:
6884 .code
6885 ${lookup dnsdb{>: a=host1.example}}
6886 .endd
6887 It is permitted to specify a space as the separator character. Further
6888 white space is ignored.
6889
6890 .cindex "MX record" "in &(dnsdb)& lookup"
6891 .cindex "SRV record" "in &(dnsdb)& lookup"
6892 For an MX lookup, both the preference value and the host name are returned for
6893 each record, separated by a space. For an SRV lookup, the priority, weight,
6894 port, and host name are returned for each record, separated by spaces.
6895 .new
6896 An alternate field separator can be specified using a comma after the main
6897 separator character, followed immediately by the field separator.
6898 .wen
6899
6900 .cindex "TXT record" "in &(dnsdb)& lookup"
6901 .cindex "SPF record" "in &(dnsdb)& lookup"
6902 For TXT records with multiple items of data, only the first item is returned,
6903 unless a separator for them is specified using a comma after the separator
6904 character followed immediately by the TXT record item separator. To concatenate
6905 items without a separator, use a semicolon instead. For SPF records the
6906 default behaviour is to concatenate multiple items without using a separator.
6907 .code
6908 ${lookup dnsdb{>\n,: txt=a.b.example}}
6909 ${lookup dnsdb{>\n; txt=a.b.example}}
6910 ${lookup dnsdb{spf=example.org}}
6911 .endd
6912 It is permitted to specify a space as the separator character. Further
6913 white space is ignored.
6914
6915 .section "Pseudo dnsdb record types" "SECID66"
6916 .cindex "MX record" "in &(dnsdb)& lookup"
6917 By default, both the preference value and the host name are returned for
6918 each MX record, separated by a space. If you want only host names, you can use
6919 the pseudo-type MXH:
6920 .code
6921 ${lookup dnsdb{mxh=a.b.example}}
6922 .endd
6923 In this case, the preference values are omitted, and just the host names are
6924 returned.
6925
6926 .cindex "name server for enclosing domain"
6927 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6928 records on the given domain, but if none are found, it removes the first
6929 component of the domain name, and tries again. This process continues until NS
6930 records are found or there are no more components left (or there is a DNS
6931 error). In other words, it may return the name servers for a top-level domain,
6932 but it never returns the root name servers. If there are no NS records for the
6933 top-level domain, the lookup fails. Consider these examples:
6934 .code
6935 ${lookup dnsdb{zns=xxx.quercite.com}}
6936 ${lookup dnsdb{zns=xxx.edu}}
6937 .endd
6938 Assuming that in each case there are no NS records for the full domain name,
6939 the first returns the name servers for &%quercite.com%&, and the second returns
6940 the name servers for &%edu%&.
6941
6942 You should be careful about how you use this lookup because, unless the
6943 top-level domain does not exist, the lookup always returns some host names. The
6944 sort of use to which this might be put is for seeing if the name servers for a
6945 given domain are on a blacklist. You can probably assume that the name servers
6946 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6947 such a list.
6948
6949 .cindex "CSA" "in &(dnsdb)& lookup"
6950 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6951 records according to the CSA rules, which are described in section
6952 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6953 not sufficient because of the extra parent domain search behaviour of CSA. The
6954 result of a successful lookup such as:
6955 .code
6956 ${lookup dnsdb {csa=$sender_helo_name}}
6957 .endd
6958 has two space-separated fields: an authorization code and a target host name.
6959 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6960 authorization required but absent, or &"?"& for unknown.
6961
6962 .cindex "A+" "in &(dnsdb)& lookup"
6963 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6964 and then an A lookup.  All results are returned; defer processing
6965 (see below) is handled separately for each lookup.  Example:
6966 .code
6967 ${lookup dnsdb {>; a+=$sender_helo_name}}
6968 .endd
6969
6970
6971 .section "Multiple dnsdb lookups" "SECID67"
6972 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6973 However, you can specify a list of domains or IP addresses in a single
6974 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6975 the default separator, but with the ability to change this. For example:
6976 .code
6977 ${lookup dnsdb{one.domain.com:two.domain.com}}
6978 ${lookup dnsdb{a=one.host.com:two.host.com}}
6979 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6980 .endd
6981 In order to retain backwards compatibility, there is one special case: if
6982 the lookup type is PTR and no change of separator is specified, Exim looks
6983 to see if the rest of the string is precisely one IPv6 address. In this
6984 case, it does not treat it as a list.
6985
6986 The data from each lookup is concatenated, with newline separators by default,
6987 in the same way that multiple DNS records for a single item are handled. A
6988 different separator can be specified, as described above.
6989
6990 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6991 each followed by a comma,
6992 that may appear before the record type.
6993
6994 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6995 temporary DNS error for any of them, the behaviour is controlled by
6996 a defer-option modifier.
6997 The possible keywords are
6998 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6999 With &"strict"& behaviour, any temporary DNS error causes the
7000 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7001 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7002 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7003 error causes the whole lookup to defer only if none of the other lookups
7004 succeed. The default is &"lax"&, so the following lookups are equivalent:
7005 .code
7006 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7007 ${lookup dnsdb{a=one.host.com:two.host.com}}
7008 .endd
7009 Thus, in the default case, as long as at least one of the DNS lookups
7010 yields some data, the lookup succeeds.
7011
7012 .cindex "DNSSEC" "dns lookup"
7013 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7014 The possible keywords are
7015 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7016 With &"strict"& or &"lax"& DNSSEC information is requested
7017 with the lookup.
7018 With &"strict"& a response from the DNS resolver that
7019 is not labelled as authenticated data
7020 is treated as equivalent to a temporary DNS error.
7021 The default is &"never"&.
7022
7023 See also the &$lookup_dnssec_authenticated$& variable.
7024
7025
7026
7027
7028 .section "More about LDAP" "SECTldap"
7029 .cindex "LDAP" "lookup, more about"
7030 .cindex "lookup" "LDAP"
7031 .cindex "Solaris" "LDAP"
7032 The original LDAP implementation came from the University of Michigan; this has
7033 become &"Open LDAP"&, and there are now two different releases. Another
7034 implementation comes from Netscape, and Solaris 7 and subsequent releases
7035 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7036 the lookup function level, their error handling is different. For this reason
7037 it is necessary to set a compile-time variable when building Exim with LDAP, to
7038 indicate which LDAP library is in use. One of the following should appear in
7039 your &_Local/Makefile_&:
7040 .code
7041 LDAP_LIB_TYPE=UMICHIGAN
7042 LDAP_LIB_TYPE=OPENLDAP1
7043 LDAP_LIB_TYPE=OPENLDAP2
7044 LDAP_LIB_TYPE=NETSCAPE
7045 LDAP_LIB_TYPE=SOLARIS
7046 .endd
7047 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7048 same interface as the University of Michigan version.
7049
7050 There are three LDAP lookup types in Exim. These behave slightly differently in
7051 the way they handle the results of a query:
7052
7053 .ilist
7054 &(ldap)& requires the result to contain just one entry; if there are more, it
7055 gives an error.
7056 .next
7057 &(ldapdn)& also requires the result to contain just one entry, but it is the
7058 Distinguished Name that is returned rather than any attribute values.
7059 .next
7060 &(ldapm)& permits the result to contain more than one entry; the attributes
7061 from all of them are returned.
7062 .endlist
7063
7064
7065 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7066 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7067 the data returned by a successful lookup is described in the next section.
7068 First we explain how LDAP queries are coded.
7069
7070
7071 .section "Format of LDAP queries" "SECTforldaque"
7072 .cindex "LDAP" "query format"
7073 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7074 the configuration of a &(redirect)& router one might have this setting:
7075 .code
7076 data = ${lookup ldap \
7077   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7078   c=UK?mailbox?base?}}
7079 .endd
7080 .cindex "LDAP" "with TLS"
7081 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7082 secure (encrypted) LDAP connections. The second of these ensures that an
7083 encrypted TLS connection is used.
7084
7085 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7086 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7087 See the &%ldap_start_tls%& option.
7088
7089 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7090 controlled. Every part of the TLS configuration can be configured by settings in
7091 &_exim.conf_&. Depending on the version of the client libraries installed on
7092 your system, some of the initialization may have required setting options in
7093 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7094 certificates. This revealed a nuance where the current UID that exim was
7095 running as could affect which config files it read. With Exim 4.83, these
7096 methods become optional, only taking effect if not specifically set in
7097 &_exim.conf_&.
7098
7099
7100 .section "LDAP quoting" "SECID68"
7101 .cindex "LDAP" "quoting"
7102 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7103 and the second because the LDAP query is represented as a URL. Furthermore,
7104 within an LDAP query, two different kinds of quoting are required. For this
7105 reason, there are two different LDAP-specific quoting operators.
7106
7107 The &%quote_ldap%& operator is designed for use on strings that are part of
7108 filter specifications. Conceptually, it first does the following conversions on
7109 the string:
7110 .code
7111 *   =>   \2A
7112 (   =>   \28
7113 )   =>   \29
7114 \   =>   \5C
7115 .endd
7116 in accordance with RFC 2254. The resulting string is then quoted according
7117 to the rules for URLs, that is, all non-alphanumeric characters except
7118 .code
7119 ! $ ' - . _ ( ) * +
7120 .endd
7121 are converted to their hex values, preceded by a percent sign. For example:
7122 .code
7123 ${quote_ldap: a(bc)*, a<yz>; }
7124 .endd
7125 yields
7126 .code
7127 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7128 .endd
7129 Removing the URL quoting, this is (with a leading and a trailing space):
7130 .code
7131 a\28bc\29\2A, a<yz>;
7132 .endd
7133 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7134 base DN specifications in queries. Conceptually, it first converts the string
7135 by inserting a backslash in front of any of the following characters:
7136 .code
7137 , + " \ < > ;
7138 .endd
7139 It also inserts a backslash before any leading spaces or # characters, and
7140 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7141 is then quoted according to the rules for URLs. For example:
7142 .code
7143 ${quote_ldap_dn: a(bc)*, a<yz>; }
7144 .endd
7145 yields
7146 .code
7147 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7148 .endd
7149 Removing the URL quoting, this is (with a trailing space):
7150 .code
7151 \ a(bc)*\, a\<yz\>\;\
7152 .endd
7153 There are some further comments about quoting in the section on LDAP
7154 authentication below.
7155
7156
7157 .section "LDAP connections" "SECID69"
7158 .cindex "LDAP" "connections"
7159 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7160 is in use, via a Unix domain socket. The example given above does not specify
7161 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7162 by starting it with
7163 .code
7164 ldap://<hostname>:<port>/...
7165 .endd
7166 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7167 used. When no server is specified in a query, a list of default servers is
7168 taken from the &%ldap_default_servers%& configuration option. This supplies a
7169 colon-separated list of servers which are tried in turn until one successfully
7170 handles a query, or there is a serious error. Successful handling either
7171 returns the requested data, or indicates that it does not exist. Serious errors
7172 are syntactical, or multiple values when only a single value is expected.
7173 Errors which cause the next server to be tried are connection failures, bind
7174 failures, and timeouts.
7175
7176 For each server name in the list, a port number can be given. The standard way
7177 of specifying a host and port is to use a colon separator (RFC 1738). Because
7178 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7179 doubled. For example
7180 .code
7181 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7182 .endd
7183 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7184 to the LDAP library with no server name, and the library's default (normally
7185 the local host) is used.
7186
7187 If you are using the OpenLDAP library, you can connect to an LDAP server using
7188 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7189 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7190 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7191 not available.
7192
7193 For this type of connection, instead of a host name for the server, a pathname
7194 for the socket is required, and the port number is not relevant. The pathname
7195 can be specified either as an item in &%ldap_default_servers%&, or inline in
7196 the query. In the former case, you can have settings such as
7197 .code
7198 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7199 .endd
7200 When the pathname is given in the query, you have to escape the slashes as
7201 &`%2F`& to fit in with the LDAP URL syntax. For example:
7202 .code
7203 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7204 .endd
7205 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7206 a pathname, it uses the Unix domain socket code, even if the query actually
7207 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7208 socket connection. This behaviour means that you can use a setting of
7209 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7210 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7211 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7212 backup host.
7213
7214 If an explicit &`ldapi`& type is given in a query when a host name is
7215 specified, an error is diagnosed. However, if there are more items in
7216 &%ldap_default_servers%&, they are tried. In other words:
7217
7218 .ilist
7219 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7220 interface.
7221 .next
7222 Using &`ldapi`& with a host name causes an error.
7223 .endlist
7224
7225
7226 Using &`ldapi`& with no host or path in the query, and no setting of
7227 &%ldap_default_servers%&, does whatever the library does by default.
7228
7229
7230
7231 .section "LDAP authentication and control information" "SECID70"
7232 .cindex "LDAP" "authentication"
7233 The LDAP URL syntax provides no way of passing authentication and other control
7234 information to the server. To make this possible, the URL in an LDAP query may
7235 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7236 spaces. If a value contains spaces it must be enclosed in double quotes, and
7237 when double quotes are used, backslash is interpreted in the usual way inside
7238 them. The following names are recognized:
7239 .display
7240 &`DEREFERENCE`&  set the dereferencing parameter
7241 &`NETTIME    `&  set a timeout for a network operation
7242 &`USER       `&  set the DN, for authenticating the LDAP bind
7243 &`PASS       `&  set the password, likewise
7244 &`REFERRALS  `&  set the referrals parameter
7245 &`SERVERS    `&  set alternate server list for this query only
7246 &`SIZE       `&  set the limit for the number of entries returned
7247 &`TIME       `&  set the maximum waiting time for a query
7248 .endd
7249 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7250 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7251 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7252 library from trying to follow referrals issued by the LDAP server.
7253
7254 The name CONNECT is an obsolete name for NETTIME, retained for
7255 backwards compatibility. This timeout (specified as a number of seconds) is
7256 enforced from the client end for operations that can be carried out over a
7257 network. Specifically, it applies to network connections and calls to the
7258 &'ldap_result()'& function. If the value is greater than zero, it is used if
7259 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7260 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7261 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7262 Netscape SDK; for OpenLDAP no action is taken.
7263
7264 The TIME parameter (also a number of seconds) is passed to the server to
7265 set a server-side limit on the time taken to complete a search.
7266
7267 The SERVERS parameter allows you to specify an alternate list of ldap servers
7268 to use for an individual lookup.  The global ldap_servers option provides a
7269 default list of ldap servers, and a single lookup can specify a single ldap
7270 server to use.  But when you need to do a lookup with a list of servers that is
7271 different than the default list (maybe different order, maybe a completely
7272 different set of servers), the SERVERS parameter allows you to specify this
7273 alternate list (colon-separated).
7274
7275 Here is an example of an LDAP query in an Exim lookup that uses some of these
7276 values. This is a single line, folded to fit on the page:
7277 .code
7278 ${lookup ldap
7279   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7280   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7281   {$value}fail}
7282 .endd
7283 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7284 any of the auxiliary data. Exim configuration settings that include lookups
7285 which contain password information should be preceded by &"hide"& to prevent
7286 non-admin users from using the &%-bP%& option to see their values.
7287
7288 The auxiliary data items may be given in any order. The default is no
7289 connection timeout (the system timeout is used), no user or password, no limit
7290 on the number of entries returned, and no time limit on queries.
7291
7292 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7293 removes any URL quoting that it may contain before passing it LDAP. Apparently
7294 some libraries do this for themselves, but some do not. Removing the URL
7295 quoting has two advantages:
7296
7297 .ilist
7298 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7299 DNs as with DNs inside actual queries.
7300 .next
7301 It permits spaces inside USER= DNs.
7302 .endlist
7303
7304 For example, a setting such as
7305 .code
7306 USER=cn=${quote_ldap_dn:$1}
7307 .endd
7308 should work even if &$1$& contains spaces.
7309
7310 Expanded data for the PASS= value should be quoted using the &%quote%&
7311 expansion operator, rather than the LDAP quote operators. The only reason this
7312 field needs quoting is to ensure that it conforms to the Exim syntax, which
7313 does not allow unquoted spaces. For example:
7314 .code
7315 PASS=${quote:$3}
7316 .endd
7317 The LDAP authentication mechanism can be used to check passwords as part of
7318 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7319 &<<CHAPexpand>>&.
7320
7321
7322
7323 .section "Format of data returned by LDAP" "SECID71"
7324 .cindex "LDAP" "returned data formats"
7325 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7326 as a sequence of values, for example
7327 .code
7328 cn=manager, o=University of Cambridge, c=UK
7329 .endd
7330 The &(ldap)& lookup type generates an error if more than one entry matches the
7331 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7332 the result between the data from different entries. It is possible for multiple
7333 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7334 you know that whatever values are returned all came from a single entry in the
7335 directory.
7336
7337 In the common case where you specify a single attribute in your LDAP query, the
7338 result is not quoted, and does not contain the attribute name. If the attribute
7339 has multiple values, they are separated by commas.
7340
7341 If you specify multiple attributes, the result contains space-separated, quoted
7342 strings, each preceded by the attribute name and an equals sign. Within the
7343 quotes, the quote character, backslash, and newline are escaped with
7344 backslashes, and commas are used to separate multiple values for the attribute.
7345 .new
7346 Any commas in attribute values are doubled
7347 (permitting treatment of the values as a comma-separated list).
7348 .wen
7349 Apart from the escaping, the string within quotes takes the same form as the
7350 output when a single attribute is requested. Specifying no attributes is the
7351 same as specifying all of an entry's attributes.
7352
7353 .new
7354 Here are some examples of the output format. The first line of each pair is an
7355 LDAP query, and the second is the data that is returned. The attribute called
7356 &%attr1%& has two values, one of them with an embedded comma, whereas
7357 &%attr2%& has only one value:
7358 .code
7359 ldap:///o=base?attr1?sub?(uid=fred)
7360 value1.1,value1,,2
7361
7362 ldap:///o=base?attr2?sub?(uid=fred)
7363 value two
7364
7365 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7366 attr1="value1.1,value1,,2" attr2="value two"
7367
7368 ldap:///o=base??sub?(uid=fred)
7369 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7370 .endd
7371 .wen
7372 You can
7373 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7374 results of LDAP lookups.
7375 The &%extract%& operator in string expansions can be used to pick out
7376 individual fields from data that consists of &'key'&=&'value'& pairs.
7377 .new
7378 The &%listextract%& operator should be used to pick out individual values
7379 of attributes, even when only a single value is expected.
7380 The doubling of embedded commas allows you to use the returned data as a
7381 comma separated list (using the "<," syntax for changing the input list separator).
7382 .wen
7383
7384
7385
7386
7387 .section "More about NIS+" "SECTnisplus"
7388 .cindex "NIS+ lookup type"
7389 .cindex "lookup" "NIS+"
7390 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7391 and field name. If this is given, the result of a successful query is the
7392 contents of the named field; otherwise the result consists of a concatenation
7393 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7394 values containing spaces are quoted. For example, the query
7395 .code
7396 [name=mg1456],passwd.org_dir
7397 .endd
7398 might return the string
7399 .code
7400 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7401 home=/home/mg1456 shell=/bin/bash shadow=""
7402 .endd
7403 (split over two lines here to fit on the page), whereas
7404 .code
7405 [name=mg1456],passwd.org_dir:gcos
7406 .endd
7407 would just return
7408 .code
7409 Martin Guerre
7410 .endd
7411 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7412 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7413 operator is to double any quote characters within the text.
7414
7415
7416
7417 .section "SQL lookups" "SECTsql"
7418 .cindex "SQL lookup types"
7419 .cindex "MySQL" "lookup type"
7420 .cindex "PostgreSQL lookup type"
7421 .cindex "lookup" "MySQL"
7422 .cindex "lookup" "PostgreSQL"
7423 .cindex "Oracle" "lookup type"
7424 .cindex "lookup" "Oracle"
7425 .cindex "InterBase lookup type"
7426 .cindex "lookup" "InterBase"
7427 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7428 databases. Queries for these databases contain SQL statements, so an example
7429 might be
7430 .code
7431 ${lookup mysql{select mailbox from users where id='userx'}\
7432   {$value}fail}
7433 .endd
7434 If the result of the query contains more than one field, the data for each
7435 field in the row is returned, preceded by its name, so the result of
7436 .code
7437 ${lookup pgsql{select home,name from users where id='userx'}\
7438   {$value}}
7439 .endd
7440 might be
7441 .code
7442 home=/home/userx name="Mister X"
7443 .endd
7444 Empty values and values containing spaces are double quoted, with embedded
7445 quotes escaped by a backslash. If the result of the query contains just one
7446 field, the value is passed back verbatim, without a field name, for example:
7447 .code
7448 Mister X
7449 .endd
7450 If the result of the query yields more than one row, it is all concatenated,
7451 with a newline between the data for each row.
7452
7453
7454 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7455 .cindex "MySQL" "lookup type"
7456 .cindex "PostgreSQL lookup type"
7457 .cindex "lookup" "MySQL"
7458 .cindex "lookup" "PostgreSQL"
7459 .cindex "Oracle" "lookup type"
7460 .cindex "lookup" "Oracle"
7461 .cindex "InterBase lookup type"
7462 .cindex "lookup" "InterBase"
7463 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7464 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7465 option (as appropriate) must be set to a colon-separated list of server
7466 information.
7467 (For MySQL and PostgreSQL only, the global option need not be set if all
7468 queries contain their own server information &-- see section
7469 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7470 items: host name, database name, user name, and password. In the case of
7471 Oracle, the host name field is used for the &"service name"&, and the database
7472 name field is not used and should be empty. For example:
7473 .code
7474 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7475 .endd
7476 Because password data is sensitive, you should always precede the setting with
7477 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7478 option. Here is an example where two MySQL servers are listed:
7479 .code
7480 hide mysql_servers = localhost/users/root/secret:\
7481                      otherhost/users/root/othersecret
7482 .endd
7483 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7484 because this is a colon-separated list, the colon has to be doubled. For each
7485 query, these parameter groups are tried in order until a connection is made and
7486 a query is successfully processed. The result of a query may be that no data is
7487 found, but that is still a successful query. In other words, the list of
7488 servers provides a backup facility, not a list of different places to look.
7489
7490 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7491 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7492 respectively, and the characters single-quote, double-quote, and backslash
7493 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7494 addition, escapes the percent and underscore characters. This cannot be done
7495 for MySQL because these escapes are not recognized in contexts where these
7496 characters are not special.
7497
7498 .section "Specifying the server in the query" "SECTspeserque"
7499 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7500 it is possible to specify a list of servers with an individual query. This is
7501 done by starting the query with
7502 .display
7503 &`servers=`&&'server1:server2:server3:...'&&`;`&
7504 .endd
7505 Each item in the list may take one of two forms:
7506 .olist
7507 If it contains no slashes it is assumed to be just a host name. The appropriate
7508 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7509 of the same name, and the remaining parameters (database, user, password) are
7510 taken from there.
7511 .next
7512 If it contains any slashes, it is taken as a complete parameter set.
7513 .endlist
7514 The list of servers is used in exactly the same way as the global list.
7515 Once a connection to a server has happened and a query has been
7516 successfully executed, processing of the lookup ceases.
7517
7518 This feature is intended for use in master/slave situations where updates
7519 are occurring and you want to update the master rather than a slave. If the
7520 master is in the list as a backup for reading, you might have a global setting
7521 like this:
7522 .code
7523 mysql_servers = slave1/db/name/pw:\
7524                 slave2/db/name/pw:\
7525                 master/db/name/pw
7526 .endd
7527 In an updating lookup, you could then write:
7528 .code
7529 ${lookup mysql{servers=master; UPDATE ...} }
7530 .endd
7531 That query would then be sent only to the master server. If, on the other hand,
7532 the master is not to be used for reading, and so is not present in the global
7533 option, you can still update it by a query of this form:
7534 .code
7535 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7536 .endd
7537
7538
7539 .section "Special MySQL features" "SECID73"
7540 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7541 causes a connection to the server on the local host by means of a Unix domain
7542 socket. An alternate socket can be specified in parentheses. The full syntax of
7543 each item in &%mysql_servers%& is:
7544 .display
7545 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7546   <&'user'&>/<&'password'&>
7547 .endd
7548 Any of the three sub-parts of the first field can be omitted. For normal use on
7549 the local host it can be left blank or set to just &"localhost"&.
7550
7551 No database need be supplied &-- but if it is absent here, it must be given in
7552 the queries.
7553
7554 If a MySQL query is issued that does not request any data (an insert, update,
7555 or delete command), the result of the lookup is the number of rows affected.
7556
7557 &*Warning*&: This can be misleading. If an update does not actually change
7558 anything (for example, setting a field to the value it already has), the result
7559 is zero because no rows are affected.
7560
7561
7562 .section "Special PostgreSQL features" "SECID74"
7563 PostgreSQL lookups can also use Unix domain socket connections to the database.
7564 This is usually faster and costs less CPU time than a TCP/IP connection.
7565 However it can be used only if the mail server runs on the same machine as the
7566 database server. A configuration line for PostgreSQL via Unix domain sockets
7567 looks like this:
7568 .code
7569 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7570 .endd
7571 In other words, instead of supplying a host name, a path to the socket is
7572 given. The path name is enclosed in parentheses so that its slashes aren't
7573 visually confused with the delimiters for the other server parameters.
7574
7575 If a PostgreSQL query is issued that does not request any data (an insert,
7576 update, or delete command), the result of the lookup is the number of rows
7577 affected.
7578
7579 .section "More about SQLite" "SECTsqlite"
7580 .cindex "lookup" "SQLite"
7581 .cindex "sqlite lookup type"
7582 SQLite is different to the other SQL lookups because a file name is required in
7583 addition to the SQL query. An SQLite database is a single file, and there is no
7584 daemon as in the other SQL databases. The interface to Exim requires the name
7585 of the file, as an absolute path, to be given at the start of the query. It is
7586 separated from the query by white space. This means that the path name cannot
7587 contain white space. Here is a lookup expansion example:
7588 .code
7589 ${lookup sqlite {/some/thing/sqlitedb \
7590   select name from aliases where id='userx';}}
7591 .endd
7592 In a list, the syntax is similar. For example:
7593 .code
7594 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7595    select * from relays where ip='$sender_host_address';
7596 .endd
7597 The only character affected by the &%quote_sqlite%& operator is a single
7598 quote, which it doubles.
7599
7600 The SQLite library handles multiple simultaneous accesses to the database
7601 internally. Multiple readers are permitted, but only one process can
7602 update at once. Attempts to access the database while it is being updated
7603 are rejected after a timeout period, during which the SQLite library
7604 waits for the lock to be released. In Exim, the default timeout is set
7605 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7606 option.
7607 .ecindex IIDfidalo1
7608 .ecindex IIDfidalo2
7609
7610
7611 . ////////////////////////////////////////////////////////////////////////////
7612 . ////////////////////////////////////////////////////////////////////////////
7613
7614 .chapter "Domain, host, address, and local part lists" &&&
7615          "CHAPdomhosaddlists" &&&
7616          "Domain, host, and address lists"
7617 .scindex IIDdohoadli "lists of domains; hosts; etc."
7618 A number of Exim configuration options contain lists of domains, hosts,
7619 email addresses, or local parts. For example, the &%hold_domains%& option
7620 contains a list of domains whose delivery is currently suspended. These lists
7621 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7622 arguments to expansion conditions such as &%match_domain%&.
7623
7624 Each item in one of these lists is a pattern to be matched against a domain,
7625 host, email address, or local part, respectively. In the sections below, the
7626 different types of pattern for each case are described, but first we cover some
7627 general facilities that apply to all four kinds of list.
7628
7629
7630
7631 .section "Expansion of lists" "SECID75"
7632 .cindex "expansion" "of lists"
7633 Each list is expanded as a single string before it is used. The result of
7634 expansion must be a list, possibly containing empty items, which is split up
7635 into separate items for matching. By default, colon is the separator character,
7636 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7637 &<<SECTempitelis>>& for details of the list syntax; the second of these
7638 discusses the way to specify empty list items.
7639
7640
7641 If the string expansion is forced to fail, Exim behaves as if the item it is
7642 testing (domain, host, address, or local part) is not in the list. Other
7643 expansion failures cause temporary errors.
7644
7645 If an item in a list is a regular expression, backslashes, dollars and possibly
7646 other special characters in the expression must be protected against
7647 misinterpretation by the string expander. The easiest way to do this is to use
7648 the &`\N`& expansion feature to indicate that the contents of the regular
7649 expression should not be expanded. For example, in an ACL you might have:
7650 .code
7651 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7652                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7653 .endd
7654 The first item is a regular expression that is protected from expansion by
7655 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7656 senders based on the receiving domain.
7657
7658
7659
7660
7661 .section "Negated items in lists" "SECID76"
7662 .cindex "list" "negation"
7663 .cindex "negation" "in lists"
7664 Items in a list may be positive or negative. Negative items are indicated by a
7665 leading exclamation mark, which may be followed by optional white space. A list
7666 defines a set of items (domains, etc). When Exim processes one of these lists,
7667 it is trying to find out whether a domain, host, address, or local part
7668 (respectively) is in the set that is defined by the list. It works like this:
7669
7670 The list is scanned from left to right. If a positive item is matched, the
7671 subject that is being checked is in the set; if a negative item is matched, the
7672 subject is not in the set. If the end of the list is reached without the
7673 subject having matched any of the patterns, it is in the set if the last item
7674 was a negative one, but not if it was a positive one. For example, the list in
7675 .code
7676 domainlist relay_to_domains = !a.b.c : *.b.c
7677 .endd
7678 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7679 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7680 list is positive. However, if the setting were
7681 .code
7682 domainlist relay_to_domains = !a.b.c
7683 .endd
7684 then all domains other than &'a.b.c'& would match because the last item in the
7685 list is negative. In other words, a list that ends with a negative item behaves
7686 as if it had an extra item &`:*`& on the end.
7687
7688 Another way of thinking about positive and negative items in lists is to read
7689 the connector as &"or"& after a positive item and as &"and"& after a negative
7690 item.
7691
7692
7693
7694 .section "File names in lists" "SECTfilnamlis"
7695 .cindex "list" "file name in"
7696 If an item in a domain, host, address, or local part list is an absolute file
7697 name (beginning with a slash character), each line of the file is read and
7698 processed as if it were an independent item in the list, except that further
7699 file names are not allowed,
7700 and no expansion of the data from the file takes place.
7701 Empty lines in the file are ignored, and the file may also contain comment
7702 lines:
7703
7704 .ilist
7705 For domain and host lists, if a # character appears anywhere in a line of the
7706 file, it and all following characters are ignored.
7707 .next
7708 Because local parts may legitimately contain # characters, a comment in an
7709 address list or local part list file is recognized only if # is preceded by
7710 white space or the start of the line. For example:
7711 .code
7712 not#comment@x.y.z   # but this is a comment
7713 .endd
7714 .endlist
7715
7716 Putting a file name in a list has the same effect as inserting each line of the
7717 file as an item in the list (blank lines and comments excepted). However, there
7718 is one important difference: the file is read each time the list is processed,
7719 so if its contents vary over time, Exim's behaviour changes.
7720
7721 If a file name is preceded by an exclamation mark, the sense of any match
7722 within the file is inverted. For example, if
7723 .code
7724 hold_domains = !/etc/nohold-domains
7725 .endd
7726 and the file contains the lines
7727 .code
7728 !a.b.c
7729 *.b.c
7730 .endd
7731 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7732 any domain matching &`*.b.c`& is not.
7733
7734
7735
7736 .section "An lsearch file is not an out-of-line list" "SECID77"
7737 As will be described in the sections that follow, lookups can be used in lists
7738 to provide indexed methods of checking list membership. There has been some
7739 confusion about the way &(lsearch)& lookups work in lists. Because
7740 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7741 sometimes thought that it is allowed to contain wild cards and other kinds of
7742 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7743 always fixed strings, just as for any other single-key lookup type.
7744
7745 If you want to use a file to contain wild-card patterns that form part of a
7746 list, just give the file name on its own, without a search type, as described
7747 in the previous section. You could also use the &(wildlsearch)& or
7748 &(nwildlsearch)&, but there is no advantage in doing this.
7749
7750
7751
7752
7753 .section "Named lists" "SECTnamedlists"
7754 .cindex "named lists"
7755 .cindex "list" "named"
7756 A list of domains, hosts, email addresses, or local parts can be given a name
7757 which is then used to refer to the list elsewhere in the configuration. This is
7758 particularly convenient if the same list is required in several different
7759 places. It also allows lists to be given meaningful names, which can improve
7760 the readability of the configuration. For example, it is conventional to define
7761 a domain list called &'local_domains'& for all the domains that are handled
7762 locally on a host, using a configuration line such as
7763 .code
7764 domainlist local_domains = localhost:my.dom.example
7765 .endd
7766 Named lists are referenced by giving their name preceded by a plus sign, so,
7767 for example, a router that is intended to handle local domains would be
7768 configured with the line
7769 .code
7770 domains = +local_domains
7771 .endd
7772 The first router in a configuration is often one that handles all domains
7773 except the local ones, using a configuration with a negated item like this:
7774 .code
7775 dnslookup:
7776   driver = dnslookup
7777   domains = ! +local_domains
7778   transport = remote_smtp
7779   no_more
7780 .endd
7781 The four kinds of named list are created by configuration lines starting with
7782 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7783 respectively. Then there follows the name that you are defining, followed by an
7784 equals sign and the list itself. For example:
7785 .code
7786 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7787 addresslist bad_senders = cdb;/etc/badsenders
7788 .endd
7789 A named list may refer to other named lists:
7790 .code
7791 domainlist  dom1 = first.example : second.example
7792 domainlist  dom2 = +dom1 : third.example
7793 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7794 .endd
7795 &*Warning*&: If the last item in a referenced list is a negative one, the
7796 effect may not be what you intended, because the negation does not propagate
7797 out to the higher level. For example, consider:
7798 .code
7799 domainlist  dom1 = !a.b
7800 domainlist  dom2 = +dom1 : *.b
7801 .endd
7802 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7803 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7804 means it matches the second list as well. The effect is not the same as
7805 .code
7806 domainlist  dom2 = !a.b : *.b
7807 .endd
7808 where &'x.y'& does not match. It's best to avoid negation altogether in
7809 referenced lists if you can.
7810
7811 Named lists may have a performance advantage. When Exim is routing an
7812 address or checking an incoming message, it caches the result of tests on named
7813 lists. So, if you have a setting such as
7814 .code
7815 domains = +local_domains
7816 .endd
7817 on several of your routers
7818 or in several ACL statements,
7819 the actual test is done only for the first one. However, the caching works only
7820 if there are no expansions within the list itself or any sublists that it
7821 references. In other words, caching happens only for lists that are known to be
7822 the same each time they are referenced.
7823
7824 By default, there may be up to 16 named lists of each type. This limit can be
7825 extended by changing a compile-time variable. The use of domain and host lists
7826 is recommended for concepts such as local domains, relay domains, and relay
7827 hosts. The default configuration is set up like this.
7828
7829
7830
7831 .section "Named lists compared with macros" "SECID78"
7832 .cindex "list" "named compared with macro"
7833 .cindex "macro" "compared with named list"
7834 At first sight, named lists might seem to be no different from macros in the
7835 configuration file. However, macros are just textual substitutions. If you
7836 write
7837 .code
7838 ALIST = host1 : host2
7839 auth_advertise_hosts = !ALIST
7840 .endd
7841 it probably won't do what you want, because that is exactly the same as
7842 .code
7843 auth_advertise_hosts = !host1 : host2
7844 .endd
7845 Notice that the second host name is not negated. However, if you use a host
7846 list, and write
7847 .code
7848 hostlist alist = host1 : host2
7849 auth_advertise_hosts = ! +alist
7850 .endd
7851 the negation applies to the whole list, and so that is equivalent to
7852 .code
7853 auth_advertise_hosts = !host1 : !host2
7854 .endd
7855
7856
7857 .section "Named list caching" "SECID79"
7858 .cindex "list" "caching of named"
7859 .cindex "caching" "named lists"
7860 While processing a message, Exim caches the result of checking a named list if
7861 it is sure that the list is the same each time. In practice, this means that
7862 the cache operates only if the list contains no $ characters, which guarantees
7863 that it will not change when it is expanded. Sometimes, however, you may have
7864 an expanded list that you know will be the same each time within a given
7865 message. For example:
7866 .code
7867 domainlist special_domains = \
7868            ${lookup{$sender_host_address}cdb{/some/file}}
7869 .endd
7870 This provides a list of domains that depends only on the sending host's IP
7871 address. If this domain list is referenced a number of times (for example,
7872 in several ACL lines, or in several routers) the result of the check is not
7873 cached by default, because Exim does not know that it is going to be the
7874 same list each time.
7875
7876 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7877 cache the result anyway. For example:
7878 .code
7879 domainlist_cache special_domains = ${lookup{...
7880 .endd
7881 If you do this, you should be absolutely sure that caching is going to do
7882 the right thing in all cases. When in doubt, leave it out.
7883
7884
7885
7886 .section "Domain lists" "SECTdomainlist"
7887 .cindex "domain list" "patterns for"
7888 .cindex "list" "domain list"
7889 Domain lists contain patterns that are to be matched against a mail domain.
7890 The following types of item may appear in domain lists:
7891
7892 .ilist
7893 .cindex "primary host name"
7894 .cindex "host name" "matched in domain list"
7895 .oindex "&%primary_hostname%&"
7896 .cindex "domain list" "matching primary host name"
7897 .cindex "@ in a domain list"
7898 If a pattern consists of a single @ character, it matches the local host name,
7899 as set by the &%primary_hostname%& option (or defaulted). This makes it
7900 possible to use the same configuration file on several different hosts that
7901 differ only in their names.
7902 .next
7903 .cindex "@[] in a domain list"
7904 .cindex "domain list" "matching local IP interfaces"
7905 .cindex "domain literal"
7906 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7907 in square brackets (as in an email address that contains a domain literal), but
7908 only if that IP address is recognized as local for email routing purposes. The
7909 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7910 control which of a host's several IP addresses are treated as local.
7911 In today's Internet, the use of domain literals is controversial.
7912 .next
7913 .cindex "@mx_any"
7914 .cindex "@mx_primary"
7915 .cindex "@mx_secondary"
7916 .cindex "domain list" "matching MX pointers to local host"
7917 If a pattern consists of the string &`@mx_any`& it matches any domain that
7918 has an MX record pointing to the local host or to any host that is listed in
7919 .oindex "&%hosts_treat_as_local%&"
7920 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7921 are similar, except that the first matches only when a primary MX target is the
7922 local host, and the second only when no primary MX target is the local host,
7923 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7924 preference value &-- there may of course be more than one of them.
7925
7926 The MX lookup that takes place when matching a pattern of this type is
7927 performed with the resolver options for widening names turned off. Thus, for
7928 example, a single-component domain will &'not'& be expanded by adding the
7929 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7930 options of the &(dnslookup)& router for a discussion of domain widening.
7931
7932 Sometimes you may want to ignore certain IP addresses when using one of these
7933 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7934 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7935 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7936 on a router). For example:
7937 .code
7938 domains = @mx_any/ignore=127.0.0.1
7939 .endd
7940 This example matches any domain that has an MX record pointing to one of
7941 the local host's IP addresses other than 127.0.0.1.
7942
7943 The list of IP addresses is in fact processed by the same code that processes
7944 host lists, so it may contain CIDR-coded network specifications and it may also
7945 contain negative items.
7946
7947 Because the list of IP addresses is a sublist within a domain list, you have to
7948 be careful about delimiters if there is more than one address. Like any other
7949 list, the default delimiter can be changed. Thus, you might have:
7950 .code
7951 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7952           an.other.domain : ...
7953 .endd
7954 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7955 involved, it is easiest to change the delimiter for the main list as well:
7956 .code
7957 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7958           an.other.domain ? ...
7959 .endd
7960 .next
7961 .cindex "asterisk" "in domain list"
7962 .cindex "domain list" "asterisk in"
7963 .cindex "domain list" "matching &""ends with""&"
7964 If a pattern starts with an asterisk, the remaining characters of the pattern
7965 are compared with the terminating characters of the domain. The use of &"*"& in
7966 domain lists differs from its use in partial matching lookups. In a domain
7967 list, the character following the asterisk need not be a dot, whereas partial
7968 matching works only in terms of dot-separated components. For example, a domain
7969 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7970 &'cipher.key.ex'&.
7971
7972 .next
7973 .cindex "regular expressions" "in domain list"
7974 .cindex "domain list" "matching regular expression"
7975 If a pattern starts with a circumflex character, it is treated as a regular
7976 expression, and matched against the domain using a regular expression matching
7977 function. The circumflex is treated as part of the regular expression.
7978 Email domains are case-independent, so this regular expression match is by
7979 default case-independent, but you can make it case-dependent by starting it
7980 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7981 are given in chapter &<<CHAPregexp>>&.
7982
7983 &*Warning*&: Because domain lists are expanded before being processed, you
7984 must escape any backslash and dollar characters in the regular expression, or
7985 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7986 it is not to be expanded (unless you really do want to build a regular
7987 expression by expansion, of course).
7988 .next
7989 .cindex "lookup" "in domain list"
7990 .cindex "domain list" "matching by lookup"
7991 If a pattern starts with the name of a single-key lookup type followed by a
7992 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7993 must be a file name in a suitable format for the lookup type. For example, for
7994 &"cdb;"& it must be an absolute path:
7995 .code
7996 domains = cdb;/etc/mail/local_domains.cdb
7997 .endd
7998 The appropriate type of lookup is done on the file using the domain name as the
7999 key. In most cases, the data that is looked up is not used; Exim is interested
8000 only in whether or not the key is present in the file. However, when a lookup
8001 is used for the &%domains%& option on a router
8002 or a &%domains%& condition in an ACL statement, the data is preserved in the
8003 &$domain_data$& variable and can be referred to in other router options or
8004 other statements in the same ACL.
8005
8006 .next
8007 Any of the single-key lookup type names may be preceded by
8008 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8009 .code
8010 domains = partial-dbm;/partial/domains
8011 .endd
8012 This causes partial matching logic to be invoked; a description of how this
8013 works is given in section &<<SECTpartiallookup>>&.
8014
8015 .next
8016 .cindex "asterisk" "in lookup type"
8017 Any of the single-key lookup types may be followed by an asterisk. This causes
8018 a default lookup for a key consisting of a single asterisk to be done if the
8019 original lookup fails. This is not a useful feature when using a domain list to
8020 select particular domains (because any domain would match), but it might have
8021 value if the result of the lookup is being used via the &$domain_data$&
8022 expansion variable.
8023 .next
8024 If the pattern starts with the name of a query-style lookup type followed by a
8025 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8026 pattern must be an appropriate query for the lookup type, as described in
8027 chapter &<<CHAPfdlookup>>&. For example:
8028 .code
8029 hold_domains = mysql;select domain from holdlist \
8030   where domain = '${quote_mysql:$domain}';
8031 .endd
8032 In most cases, the data that is looked up is not used (so for an SQL query, for
8033 example, it doesn't matter what field you select). Exim is interested only in
8034 whether or not the query succeeds. However, when a lookup is used for the
8035 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8036 variable and can be referred to in other options.
8037 .next
8038 .cindex "domain list" "matching literal domain name"
8039 If none of the above cases apply, a caseless textual comparison is made
8040 between the pattern and the domain.
8041 .endlist
8042
8043 Here is an example that uses several different kinds of pattern:
8044 .code
8045 domainlist funny_domains = \
8046   @ : \
8047   lib.unseen.edu : \
8048   *.foundation.fict.example : \
8049   \N^[1-2]\d{3}\.fict\.example$\N : \
8050   partial-dbm;/opt/data/penguin/book : \
8051   nis;domains.byname : \
8052   nisplus;[name=$domain,status=local],domains.org_dir
8053 .endd
8054 There are obvious processing trade-offs among the various matching modes. Using
8055 an asterisk is faster than a regular expression, and listing a few names
8056 explicitly probably is too. The use of a file or database lookup is expensive,
8057 but may be the only option if hundreds of names are required. Because the
8058 patterns are tested in order, it makes sense to put the most commonly matched
8059 patterns earlier.
8060
8061
8062
8063 .section "Host lists" "SECThostlist"
8064 .cindex "host list" "patterns in"
8065 .cindex "list" "host list"
8066 Host lists are used to control what remote hosts are allowed to do. For
8067 example, some hosts may be allowed to use the local host as a relay, and some
8068 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8069 two different ways, by name or by IP address. In a host list, some types of
8070 pattern are matched to a host name, and some are matched to an IP address.
8071 You need to be particularly careful with this when single-key lookups are
8072 involved, to ensure that the right value is being used as the key.
8073
8074
8075 .section "Special host list patterns" "SECID80"
8076 .cindex "empty item in hosts list"
8077 .cindex "host list" "empty string in"
8078 If a host list item is the empty string, it matches only when no remote host is
8079 involved. This is the case when a message is being received from a local
8080 process using SMTP on the standard input, that is, when a TCP/IP connection is
8081 not used.
8082
8083 .cindex "asterisk" "in host list"
8084 The special pattern &"*"& in a host list matches any host or no host. Neither
8085 the IP address nor the name is actually inspected.
8086
8087
8088
8089 .section "Host list patterns that match by IP address" "SECThoslispatip"
8090 .cindex "host list" "matching IP addresses"
8091 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8092 the incoming address actually appears in the IPv6 host as
8093 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8094 list, it is converted into a traditional IPv4 address first. (Not all operating
8095 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8096 concerns.)
8097
8098 The following types of pattern in a host list check the remote host by
8099 inspecting its IP address:
8100
8101 .ilist
8102 If the pattern is a plain domain name (not a regular expression, not starting
8103 with *, not a lookup of any kind), Exim calls the operating system function
8104 to find the associated IP address(es). Exim uses the newer
8105 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8106 This typically causes a forward DNS lookup of the name. The result is compared
8107 with the IP address of the subject host.
8108
8109 If there is a temporary problem (such as a DNS timeout) with the host name
8110 lookup, a temporary error occurs. For example, if the list is being used in an
8111 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8112 temporary SMTP error code. If no IP address can be found for the host name,
8113 what happens is described in section &<<SECTbehipnot>>& below.
8114
8115 .next
8116 .cindex "@ in a host list"
8117 If the pattern is &"@"&, the primary host name is substituted and used as a
8118 domain name, as just described.
8119
8120 .next
8121 If the pattern is an IP address, it is matched against the IP address of the
8122 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8123 IPv6 addresses can be given in colon-separated format, but the colons have to
8124 be doubled so as not to be taken as item separators when the default list
8125 separator is used. IPv6 addresses are recognized even when Exim is compiled
8126 without IPv6 support. This means that if they appear in a host list on an
8127 IPv4-only host, Exim will not treat them as host names. They are just addresses
8128 that can never match a client host.
8129
8130 .next
8131 .cindex "@[] in a host list"
8132 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8133 the local host. For example, if the local host is an IPv4 host with one
8134 interface address 10.45.23.56, these two ACL statements have the same effect:
8135 .code
8136 accept hosts = 127.0.0.1 : 10.45.23.56
8137 accept hosts = @[]
8138 .endd
8139 .next
8140 .cindex "CIDR notation"
8141 If the pattern is an IP address followed by a slash and a mask length (for
8142 example 10.11.42.0/24), it is matched against the IP address of the subject
8143 host under the given mask. This allows, an entire network of hosts to be
8144 included (or excluded) by a single item. The mask uses CIDR notation; it
8145 specifies the number of address bits that must match, starting from the most
8146 significant end of the address.
8147
8148 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8149 of a range of addresses. It is the number of bits in the network portion of the
8150 address. The above example specifies a 24-bit netmask, so it matches all 256
8151 addresses in the 10.11.42.0 network. An item such as
8152 .code
8153 192.168.23.236/31
8154 .endd
8155 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8156 32 for an IPv4 address is the same as no mask at all; just a single address
8157 matches.
8158
8159 Here is another example which shows an IPv4 and an IPv6 network:
8160 .code
8161 recipient_unqualified_hosts = 192.168.0.0/16: \
8162                               3ffe::ffff::836f::::/48
8163 .endd
8164 The doubling of list separator characters applies only when these items
8165 appear inline in a host list. It is not required when indirecting via a file.
8166 For example:
8167 .code
8168 recipient_unqualified_hosts = /opt/exim/unqualnets
8169 .endd
8170 could make use of a file containing
8171 .code
8172 172.16.0.0/12
8173 3ffe:ffff:836f::/48
8174 .endd
8175 to have exactly the same effect as the previous example. When listing IPv6
8176 addresses inline, it is usually more convenient to use the facility for
8177 changing separator characters. This list contains the same two networks:
8178 .code
8179 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8180                                  3ffe:ffff:836f::/48
8181 .endd
8182 The separator is changed to semicolon by the leading &"<;"& at the start of the
8183 list.
8184 .endlist
8185
8186
8187
8188 .section "Host list patterns for single-key lookups by host address" &&&
8189          "SECThoslispatsikey"
8190 .cindex "host list" "lookup of IP address"
8191 When a host is to be identified by a single-key lookup of its complete IP
8192 address, the pattern takes this form:
8193 .display
8194 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8195 .endd
8196 For example:
8197 .code
8198 hosts_lookup = net-cdb;/hosts-by-ip.db
8199 .endd
8200 The text form of the IP address of the subject host is used as the lookup key.
8201 IPv6 addresses are converted to an unabbreviated form, using lower case
8202 letters, with dots as separators because colon is the key terminator in
8203 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8204 quoting the keys, but this is a facility that was added later.] The data
8205 returned by the lookup is not used.
8206
8207 .cindex "IP address" "masking"
8208 .cindex "host list" "masked IP address"
8209 Single-key lookups can also be performed using masked IP addresses, using
8210 patterns of this form:
8211 .display
8212 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8213 .endd
8214 For example:
8215 .code
8216 net24-dbm;/networks.db
8217 .endd
8218 The IP address of the subject host is masked using <&'number'&> as the mask
8219 length. A textual string is constructed from the masked value, followed by the
8220 mask, and this is used as the lookup key. For example, if the host's IP address
8221 is 192.168.34.6, the key that is looked up for the above example is
8222 &"192.168.34.0/24"&.
8223
8224 When an IPv6 address is converted to a string, dots are normally used instead
8225 of colons, so that keys in &(lsearch)& files need not contain colons (which
8226 terminate &(lsearch)& keys). This was implemented some time before the ability
8227 to quote keys was made available in &(lsearch)& files. However, the more
8228 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8229 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8230 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8231 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8232 addresses are always used.
8233
8234 Ideally, it would be nice to tidy up this anomalous situation by changing to
8235 colons in all cases, given that quoting is now available for &(lsearch)&.
8236 However, this would be an incompatible change that might break some existing
8237 configurations.
8238
8239 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8240 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8241 the former case the key strings include the mask value, whereas in the latter
8242 case the IP address is used on its own.
8243
8244
8245
8246 .section "Host list patterns that match by host name" "SECThoslispatnam"
8247 .cindex "host" "lookup failures"
8248 .cindex "unknown host name"
8249 .cindex "host list" "matching host name"
8250 There are several types of pattern that require Exim to know the name of the
8251 remote host. These are either wildcard patterns or lookups by name. (If a
8252 complete hostname is given without any wildcarding, it is used to find an IP
8253 address to match against, as described in section &<<SECThoslispatip>>&
8254 above.)
8255
8256 If the remote host name is not already known when Exim encounters one of these
8257 patterns, it has to be found from the IP address.
8258 Although many sites on the Internet are conscientious about maintaining reverse
8259 DNS data for their hosts, there are also many that do not do this.
8260 Consequently, a name cannot always be found, and this may lead to unwanted
8261 effects. Take care when configuring host lists with wildcarded name patterns.
8262 Consider what will happen if a name cannot be found.
8263
8264 Because of the problems of determining host names from IP addresses, matching
8265 against host names is not as common as matching against IP addresses.
8266
8267 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8268 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8269 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8270 are done can be changed by setting the &%host_lookup_order%& option. For
8271 security, once Exim has found one or more names, it looks up the IP addresses
8272 for these names and compares them with the IP address that it started with.
8273 Only those names whose IP addresses match are accepted. Any other names are
8274 discarded. If no names are left, Exim behaves as if the host name cannot be
8275 found. In the most common case there is only one name and one IP address.
8276
8277 There are some options that control what happens if a host name cannot be
8278 found. These are described in section &<<SECTbehipnot>>& below.
8279
8280 .cindex "host" "alias for"
8281 .cindex "alias for host"
8282 As a result of aliasing, hosts may have more than one name. When processing any
8283 of the following types of pattern, all the host's names are checked:
8284
8285 .ilist
8286 .cindex "asterisk" "in host list"
8287 If a pattern starts with &"*"& the remainder of the item must match the end of
8288 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8289 &'.b.c'&. This special simple form is provided because this is a very common
8290 requirement. Other kinds of wildcarding require the use of a regular
8291 expression.
8292 .next
8293 .cindex "regular expressions" "in host list"
8294 .cindex "host list" "regular expression in"
8295 If the item starts with &"^"& it is taken to be a regular expression which is
8296 matched against the host name. Host names are case-independent, so this regular
8297 expression match is by default case-independent, but you can make it
8298 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8299 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8300 example,
8301 .code
8302 ^(a|b)\.c\.d$
8303 .endd
8304 is a regular expression that matches either of the two hosts &'a.c.d'& or
8305 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8306 that backslash and dollar characters are not misinterpreted as part of the
8307 string expansion. The simplest way to do this is to use &`\N`& to mark that
8308 part of the string as non-expandable. For example:
8309 .code
8310 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8311 .endd
8312 &*Warning*&: If you want to match a complete host name, you must include the
8313 &`$`& terminating metacharacter in the regular expression, as in the above
8314 example. Without it, a match at the start of the host name is all that is
8315 required.
8316 .endlist
8317
8318
8319
8320
8321 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8322 .cindex "host" "lookup failures, permanent"
8323 While processing a host list, Exim may need to look up an IP address from a
8324 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8325 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8326 behaviour when it fails to find the information it is seeking is the same.
8327
8328 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8329 apply to temporary DNS errors, whose handling is described in the next section.
8330
8331 .cindex "&`+include_unknown`&"
8332 .cindex "&`+ignore_unknown`&"
8333 Exim parses a host list from left to right. If it encounters a permanent
8334 lookup failure in any item in the host list before it has found a match,
8335 Exim treats it as a failure and the default behavior is as if the host
8336 does not match the list. This may not always be what you want to happen.
8337 To change Exim's behaviour, the special items &`+include_unknown`& or
8338 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8339 not recognized in an indirected file).
8340
8341 .ilist
8342 If any item that follows &`+include_unknown`& requires information that
8343 cannot found, Exim behaves as if the host does match the list. For example,
8344 .code
8345 host_reject_connection = +include_unknown:*.enemy.ex
8346 .endd
8347 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8348 any hosts whose name it cannot find.
8349
8350 .next
8351 If any item that follows &`+ignore_unknown`& requires information that cannot
8352 be found, Exim ignores that item and proceeds to the rest of the list. For
8353 example:
8354 .code
8355 accept hosts = +ignore_unknown : friend.example : \
8356                192.168.4.5
8357 .endd
8358 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8359 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8360 name can be found for 192.168.4.5, it is rejected.
8361 .endlist
8362
8363 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8364 list. The effect of each one lasts until the next, or until the end of the
8365 list.
8366
8367 .section "Mixing wildcarded host names and addresses in host lists" &&&
8368          "SECTmixwilhos"
8369 .cindex "host list" "mixing names and addresses in"
8370
8371 This section explains the host/ip processing logic with the same concepts
8372 as the previous section, but specifically addresses what happens when a
8373 wildcarded hostname is one of the items in the hostlist.
8374
8375 .ilist
8376 If you have name lookups or wildcarded host names and
8377 IP addresses in the same host list, you should normally put the IP
8378 addresses first. For example, in an ACL you could have:
8379 .code
8380 accept hosts = 10.9.8.7 : *.friend.example
8381 .endd
8382 The reason you normally would order it this way lies in the
8383 left-to-right way that Exim processes lists.  It can test IP addresses
8384 without doing any DNS lookups, but when it reaches an item that requires
8385 a host name, it fails if it cannot find a host name to compare with the
8386 pattern. If the above list is given in the opposite order, the
8387 &%accept%& statement fails for a host whose name cannot be found, even
8388 if its IP address is 10.9.8.7.
8389
8390 .next
8391 If you really do want to do the name check first, and still recognize the IP
8392 address, you can rewrite the ACL like this:
8393 .code
8394 accept hosts = *.friend.example
8395 accept hosts = 10.9.8.7
8396 .endd
8397 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8398 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8399 &`+ignore_unknown`&, which was discussed in depth in the first example in
8400 this section.
8401 .endlist
8402
8403
8404 .section "Temporary DNS errors when looking up host information" &&&
8405          "SECTtemdnserr"
8406 .cindex "host" "lookup failures, temporary"
8407 .cindex "&`+include_defer`&"
8408 .cindex "&`+ignore_defer`&"
8409 A temporary DNS lookup failure normally causes a defer action (except when
8410 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8411 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8412 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8413 section. These options should be used with care, probably only in non-critical
8414 host lists such as whitelists.
8415
8416
8417
8418 .section "Host list patterns for single-key lookups by host name" &&&
8419          "SECThoslispatnamsk"
8420 .cindex "unknown host name"
8421 .cindex "host list" "matching host name"
8422 If a pattern is of the form
8423 .display
8424 <&'single-key-search-type'&>;<&'search-data'&>
8425 .endd
8426 for example
8427 .code
8428 dbm;/host/accept/list
8429 .endd
8430 a single-key lookup is performed, using the host name as its key. If the
8431 lookup succeeds, the host matches the item. The actual data that is looked up
8432 is not used.
8433
8434 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8435 keys in the file, not IP addresses. If you want to do lookups based on IP
8436 addresses, you must precede the search type with &"net-"& (see section
8437 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8438 two items in the same list, one doing an address lookup and one doing a name
8439 lookup, both using the same file.
8440
8441
8442
8443 .section "Host list patterns for query-style lookups" "SECID81"
8444 If a pattern is of the form
8445 .display
8446 <&'query-style-search-type'&>;<&'query'&>
8447 .endd
8448 the query is obeyed, and if it succeeds, the host matches the item. The actual
8449 data that is looked up is not used. The variables &$sender_host_address$& and
8450 &$sender_host_name$& can be used in the query. For example:
8451 .code
8452 hosts_lookup = pgsql;\
8453   select ip from hostlist where ip='$sender_host_address'
8454 .endd
8455 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8456 can use the &%sg%& expansion item to change this if you need to. If you want to
8457 use masked IP addresses in database queries, you can use the &%mask%& expansion
8458 operator.
8459
8460 If the query contains a reference to &$sender_host_name$&, Exim automatically
8461 looks up the host name if it has not already done so. (See section
8462 &<<SECThoslispatnam>>& for comments on finding host names.)
8463
8464 Historical note: prior to release 4.30, Exim would always attempt to find a
8465 host name before running the query, unless the search type was preceded by
8466 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8467 still recognized for query-style lookups, but its presence or absence has no
8468 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8469 See section &<<SECThoslispatsikey>>&.)
8470
8471
8472
8473
8474
8475 .section "Address lists" "SECTaddresslist"
8476 .cindex "list" "address list"
8477 .cindex "address list" "empty item"
8478 .cindex "address list" "patterns"
8479 Address lists contain patterns that are matched against mail addresses. There
8480 is one special case to be considered: the sender address of a bounce message is
8481 always empty. You can test for this by providing an empty item in an address
8482 list. For example, you can set up a router to process bounce messages by
8483 using this option setting:
8484 .code
8485 senders = :
8486 .endd
8487 The presence of the colon creates an empty item. If you do not provide any
8488 data, the list is empty and matches nothing. The empty sender can also be
8489 detected by a regular expression that matches an empty string,
8490 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8491
8492 Non-empty items in an address list can be straightforward email addresses. For
8493 example:
8494 .code
8495 senders = jbc@askone.example : hs@anacreon.example
8496 .endd
8497 A certain amount of wildcarding is permitted. If a pattern contains an @
8498 character, but is not a regular expression and does not begin with a
8499 semicolon-terminated lookup type (described below), the local part of the
8500 subject address is compared with the local part of the pattern, which may start
8501 with an asterisk. If the local parts match, the domain is checked in exactly
8502 the same way as for a pattern in a domain list. For example, the domain can be
8503 wildcarded, refer to a named list, or be a lookup:
8504 .code
8505 deny senders = *@*.spamming.site:\
8506                *@+hostile_domains:\
8507                bozo@partial-lsearch;/list/of/dodgy/sites:\
8508                *@dbm;/bad/domains.db
8509 .endd
8510 .cindex "local part" "starting with !"
8511 .cindex "address list" "local part starting with !"
8512 If a local part that begins with an exclamation mark is required, it has to be
8513 specified using a regular expression, because otherwise the exclamation mark is
8514 treated as a sign of negation, as is standard in lists.
8515
8516 If a non-empty pattern that is not a regular expression or a lookup does not
8517 contain an @ character, it is matched against the domain part of the subject
8518 address. The only two formats that are recognized this way are a literal
8519 domain, or a domain pattern that starts with *. In both these cases, the effect
8520 is the same as if &`*@`& preceded the pattern. For example:
8521 .code
8522 deny senders = enemy.domain : *.enemy.domain
8523 .endd
8524
8525 The following kinds of more complicated address list pattern can match any
8526 address, including the empty address that is characteristic of bounce message
8527 senders:
8528
8529 .ilist
8530 .cindex "regular expressions" "in address list"
8531 .cindex "address list" "regular expression in"
8532 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8533 done against the complete address, with the pattern as the regular expression.
8534 You must take care that backslash and dollar characters are not misinterpreted
8535 as part of the string expansion. The simplest way to do this is to use &`\N`&
8536 to mark that part of the string as non-expandable. For example:
8537 .code
8538 deny senders = \N^.*this.*@example\.com$\N : \
8539                \N^\d{8}.+@spamhaus.example$\N : ...
8540 .endd
8541 The &`\N`& sequences are removed by the expansion, so these items do indeed
8542 start with &"^"& by the time they are being interpreted as address patterns.
8543
8544 .next
8545 .cindex "address list" "lookup for complete address"
8546 Complete addresses can be looked up by using a pattern that starts with a
8547 lookup type terminated by a semicolon, followed by the data for the lookup. For
8548 example:
8549 .code
8550 deny senders = cdb;/etc/blocked.senders : \
8551   mysql;select address from blocked where \
8552   address='${quote_mysql:$sender_address}'
8553 .endd
8554 Both query-style and single-key lookup types can be used. For a single-key
8555 lookup type, Exim uses the complete address as the key. However, empty keys are
8556 not supported for single-key lookups, so a match against the empty address
8557 always fails. This restriction does not apply to query-style lookups.
8558
8559 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8560 cannot be used, and is ignored if specified, with an entry being written to the
8561 panic log.
8562 .cindex "*@ with single-key lookup"
8563 However, you can configure lookup defaults, as described in section
8564 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8565 default. For example, with this lookup:
8566 .code
8567 accept senders = lsearch*@;/some/file
8568 .endd
8569 the file could contains lines like this:
8570 .code
8571 user1@domain1.example
8572 *@domain2.example
8573 .endd
8574 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8575 that are tried is:
8576 .code
8577 nimrod@jaeger.example
8578 *@jaeger.example
8579 *
8580 .endd
8581 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8582 would mean that every address matches, thus rendering the test useless.
8583
8584 &*Warning 2*&: Do not confuse these two kinds of item:
8585 .code
8586 deny recipients = dbm*@;/some/file
8587 deny recipients = *@dbm;/some/file
8588 .endd
8589 The first does a whole address lookup, with defaulting, as just described,
8590 because it starts with a lookup type. The second matches the local part and
8591 domain independently, as described in a bullet point below.
8592 .endlist
8593
8594
8595 The following kinds of address list pattern can match only non-empty addresses.
8596 If the subject address is empty, a match against any of these pattern types
8597 always fails.
8598
8599
8600 .ilist
8601 .cindex "@@ with single-key lookup"
8602 .cindex "address list" "@@ lookup type"
8603 .cindex "address list" "split local part and domain"
8604 If a pattern starts with &"@@"& followed by a single-key lookup item
8605 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8606 split into a local part and a domain. The domain is looked up in the file. If
8607 it is not found, there is no match. If it is found, the data that is looked up
8608 from the file is treated as a colon-separated list of local part patterns, each
8609 of which is matched against the subject local part in turn.
8610
8611 .cindex "asterisk" "in address list"
8612 The lookup may be a partial one, and/or one involving a search for a default
8613 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8614 patterns that are looked up can be regular expressions or begin with &"*"&, or
8615 even be further lookups. They may also be independently negated. For example,
8616 with
8617 .code
8618 deny senders = @@dbm;/etc/reject-by-domain
8619 .endd
8620 the data from which the DBM file is built could contain lines like
8621 .code
8622 baddomain.com:  !postmaster : *
8623 .endd
8624 to reject all senders except &%postmaster%& from that domain.
8625
8626 .cindex "local part" "starting with !"
8627 If a local part that actually begins with an exclamation mark is required, it
8628 has to be specified using a regular expression. In &(lsearch)& files, an entry
8629 may be split over several lines by indenting the second and subsequent lines,
8630 but the separating colon must still be included at line breaks. White space
8631 surrounding the colons is ignored. For example:
8632 .code
8633 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8634   spammer3 : spammer4
8635 .endd
8636 As in all colon-separated lists in Exim, a colon can be included in an item by
8637 doubling.
8638
8639 If the last item in the list starts with a right angle-bracket, the remainder
8640 of the item is taken as a new key to look up in order to obtain a continuation
8641 list of local parts. The new key can be any sequence of characters. Thus one
8642 might have entries like
8643 .code
8644 aol.com: spammer1 : spammer 2 : >*
8645 xyz.com: spammer3 : >*
8646 *:       ^\d{8}$
8647 .endd
8648 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8649 local parts for all domains, in addition to the specific local parts listed for
8650 each domain. Of course, using this feature costs another lookup each time a
8651 chain is followed, but the effort needed to maintain the data is reduced.
8652
8653 .cindex "loop" "in lookups"
8654 It is possible to construct loops using this facility, and in order to catch
8655 them, the chains may be no more than fifty items long.
8656
8657 .next
8658 The @@<&'lookup'&> style of item can also be used with a query-style
8659 lookup, but in this case, the chaining facility is not available. The lookup
8660 can only return a single list of local parts.
8661 .endlist
8662
8663 &*Warning*&: There is an important difference between the address list items
8664 in these two examples:
8665 .code
8666 senders = +my_list
8667 senders = *@+my_list
8668 .endd
8669 In the first one, &`my_list`& is a named address list, whereas in the second
8670 example it is a named domain list.
8671
8672
8673
8674
8675 .section "Case of letters in address lists" "SECTcasletadd"
8676 .cindex "case of local parts"
8677 .cindex "address list" "case forcing"
8678 .cindex "case forcing in address lists"
8679 Domains in email addresses are always handled caselessly, but for local parts
8680 case may be significant on some systems (see &%caseful_local_part%& for how
8681 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8682 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8683 blocking lists should be done in a case-independent manner. Since most address
8684 lists in Exim are used for this kind of control, Exim attempts to do this by
8685 default.
8686
8687 The domain portion of an address is always lowercased before matching it to an
8688 address list. The local part is lowercased by default, and any string
8689 comparisons that take place are done caselessly. This means that the data in
8690 the address list itself, in files included as plain file names, and in any file
8691 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8692 keys in files that are looked up by a search type other than &(lsearch)& (which
8693 works caselessly) must be in lower case, because these lookups are not
8694 case-independent.
8695
8696 .cindex "&`+caseful`&"
8697 To allow for the possibility of caseful address list matching, if an item in
8698 an address list is the string &"+caseful"&, the original case of the local
8699 part is restored for any comparisons that follow, and string comparisons are no
8700 longer case-independent. This does not affect the domain, which remains in
8701 lower case. However, although independent matches on the domain alone are still
8702 performed caselessly, regular expressions that match against an entire address
8703 become case-sensitive after &"+caseful"& has been seen.
8704
8705
8706
8707 .section "Local part lists" "SECTlocparlis"
8708 .cindex "list" "local part list"
8709 .cindex "local part" "list"
8710 Case-sensitivity in local part lists is handled in the same way as for address
8711 lists, as just described. The &"+caseful"& item can be used if required. In a
8712 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8713 set false, the subject is lowercased and the matching is initially
8714 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8715 matching in the local part list, but not elsewhere in the router. If
8716 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8717 option is case-sensitive from the start.
8718
8719 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8720 comments are handled in the same way as address lists &-- they are recognized
8721 only if the # is preceded by white space or the start of the line.
8722 Otherwise, local part lists are matched in the same way as domain lists, except
8723 that the special items that refer to the local host (&`@`&, &`@[]`&,
8724 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8725 Refer to section &<<SECTdomainlist>>& for details of the other available item
8726 types.
8727 .ecindex IIDdohoadli
8728
8729
8730
8731
8732 . ////////////////////////////////////////////////////////////////////////////
8733 . ////////////////////////////////////////////////////////////////////////////
8734
8735 .chapter "String expansions" "CHAPexpand"
8736 .scindex IIDstrexp "expansion" "of strings"
8737 Many strings in Exim's run time configuration are expanded before use. Some of
8738 them are expanded every time they are used; others are expanded only once.
8739
8740 When a string is being expanded it is copied verbatim from left to right except
8741 when a dollar or backslash character is encountered. A dollar specifies the
8742 start of a portion of the string that is interpreted and replaced as described
8743 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8744 escape character, as described in the following section.
8745
8746 Whether a string is expanded depends upon the context.  Usually this is solely
8747 dependent upon the option for which a value is sought; in this documentation,
8748 options for which string expansion is performed are marked with &dagger; after
8749 the data type.  ACL rules always expand strings.  A couple of expansion
8750 conditions do not expand some of the brace-delimited branches, for security
8751 reasons.
8752
8753
8754
8755 .section "Literal text in expanded strings" "SECTlittext"
8756 .cindex "expansion" "including literal text"
8757 An uninterpreted dollar can be included in an expanded string by putting a
8758 backslash in front of it. A backslash can be used to prevent any special
8759 character being treated specially in an expansion, including backslash itself.
8760 If the string appears in quotes in the configuration file, two backslashes are
8761 required because the quotes themselves cause interpretation of backslashes when
8762 the string is read in (see section &<<SECTstrings>>&).
8763
8764 .cindex "expansion" "non-expandable substrings"
8765 A portion of the string can specified as non-expandable by placing it between
8766 two occurrences of &`\N`&. This is particularly useful for protecting regular
8767 expressions, which often contain backslashes and dollar signs. For example:
8768 .code
8769 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8770 .endd
8771 On encountering the first &`\N`&, the expander copies subsequent characters
8772 without interpretation until it reaches the next &`\N`& or the end of the
8773 string.
8774
8775
8776
8777 .section "Character escape sequences in expanded strings" "SECID82"
8778 .cindex "expansion" "escape sequences"
8779 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8780 expanded string is recognized as an escape sequence for the character newline,
8781 carriage return, or tab, respectively. A backslash followed by up to three
8782 octal digits is recognized as an octal encoding for a single character, and a
8783 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8784 encoding.
8785
8786 These escape sequences are also recognized in quoted strings when they are read
8787 in. Their interpretation in expansions as well is useful for unquoted strings,
8788 and for other cases such as looked-up strings that are then expanded.
8789
8790
8791 .section "Testing string expansions" "SECID83"
8792 .cindex "expansion" "testing"
8793 .cindex "testing" "string expansion"
8794 .oindex "&%-be%&"
8795 Many expansions can be tested by calling Exim with the &%-be%& option. This
8796 takes the command arguments, or lines from the standard input if there are no
8797 arguments, runs them through the string expansion code, and writes the results
8798 to the standard output. Variables based on configuration values are set up, but
8799 since no message is being processed, variables such as &$local_part$& have no
8800 value. Nevertheless the &%-be%& option can be useful for checking out file and
8801 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8802 and &%nhash%&.
8803
8804 Exim gives up its root privilege when it is called with the &%-be%& option, and
8805 instead runs under the uid and gid it was called with, to prevent users from
8806 using &%-be%& for reading files to which they do not have access.
8807
8808 .oindex "&%-bem%&"
8809 If you want to test expansions that include variables whose values are taken
8810 from a message, there are two other options that can be used. The &%-bem%&
8811 option is like &%-be%& except that it is followed by a file name. The file is
8812 read as a message before doing the test expansions. For example:
8813 .code
8814 exim -bem /tmp/test.message '$h_subject:'
8815 .endd
8816 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8817 Exim message identifier. For example:
8818 .code
8819 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8820 .endd
8821 This loads the message from Exim's spool before doing the test expansions, and
8822 is therefore restricted to admin users.
8823
8824
8825 .section "Forced expansion failure" "SECTforexpfai"
8826 .cindex "expansion" "forced failure"
8827 A number of expansions that are described in the following section have
8828 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8829 (which are sometimes called &"curly brackets"&). Which of the two strings is
8830 used depends on some condition that is evaluated as part of the expansion. If,
8831 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8832 the entire string expansion fails in a way that can be detected by the code
8833 that requested the expansion. This is called &"forced expansion failure"&, and
8834 its consequences depend on the circumstances. In some cases it is no different
8835 from any other expansion failure, but in others a different action may be
8836 taken. Such variations are mentioned in the documentation of the option that is
8837 being expanded.
8838
8839
8840
8841
8842 .section "Expansion items" "SECTexpansionitems"
8843 The following items are recognized in expanded strings. White space may be used
8844 between sub-items that are keywords or substrings enclosed in braces inside an
8845 outer set of braces, to improve readability. &*Warning*&: Within braces,
8846 white space is significant.
8847
8848 .vlist
8849 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8850 .cindex "expansion" "variables"
8851 Substitute the contents of the named variable, for example:
8852 .code
8853 $local_part
8854 ${domain}
8855 .endd
8856 The second form can be used to separate the name from subsequent alphanumeric
8857 characters. This form (using braces) is available only for variables; it does
8858 &'not'& apply to message headers. The names of the variables are given in
8859 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8860 given, the expansion fails.
8861
8862 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8863 .cindex "expansion" "operators"
8864 The string is first itself expanded, and then the operation specified by
8865 <&'op'&> is applied to it. For example:
8866 .code
8867 ${lc:$local_part}
8868 .endd
8869 The string starts with the first character after the colon, which may be
8870 leading white space. A list of operators is given in section &<<SECTexpop>>&
8871 below. The operator notation is used for simple expansion items that have just
8872 one argument, because it reduces the number of braces and therefore makes the
8873 string easier to understand.
8874
8875 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8876 This item inserts &"basic"& header lines. It is described with the &%header%&
8877 expansion item below.
8878
8879
8880 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8881 .cindex "expansion" "calling an acl"
8882 .cindex "&%acl%&" "call from expansion"
8883 The name and zero to nine argument strings are first expanded separately.  The expanded
8884 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8885 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8886 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8887 and may use the variables; if another acl expansion is used the values
8888 are restored after it returns.  If the ACL sets
8889 a value using a "message =" modifier and returns accept or deny, the value becomes
8890 the result of the expansion.
8891 If no message is set and the ACL returns accept or deny
8892 the expansion result is an empty string.
8893 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8894
8895
8896 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8897        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8898 .cindex "expansion" "extracting cerificate fields"
8899 .cindex "&%certextract%&" "certificate fields"
8900 .cindex "certificate" "extracting fields"
8901 The <&'certificate'&> must be a variable of type certificate.
8902 The field name is expanded and used to retrive the relevant field from
8903 the certificate.  Supported fields are:
8904 .display
8905 &`version        `&
8906 &`serial_number  `&
8907 &`subject        `& RFC4514 DN
8908 &`issuer         `& RFC4514 DN
8909 &`notbefore      `& time
8910 &`notafter       `& time
8911 &`sig_algorithm  `&
8912 &`signature      `&
8913 &`subj_altname   `& tagged list
8914 &`ocsp_uri       `& list
8915 &`crl_uri        `& list
8916 .endd
8917 If the field is found,
8918 <&'string2'&> is expanded, and replaces the whole item;
8919 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8920 variable &$value$& contains the value that has been extracted. Afterwards, it
8921 is restored to any previous value it might have had.
8922
8923 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8924 key is not found. If {<&'string2'&>} is also omitted, the value that was
8925 extracted is used.
8926
8927 Some field names take optional modifiers, appended and separated by commas.
8928
8929 The field selectors marked as "RFC4514" above
8930 output a Distinguished Name string which is
8931 not quite
8932 parseable by Exim as a comma-separated tagged list
8933 (the exceptions being elements containin commas).
8934 RDN elements of a single type may be selected by
8935 a modifier of the type label; if so the expansion
8936 result is a list (newline-separated by default).
8937 The separator may be changed by another modifer of
8938 a right angle-bracket followed immediately by the new separator.
8939 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8940
8941 The field selectors marked as "time" above
8942 may output a number of seconds since epoch
8943 if the modifier "int" is used.
8944
8945 The field selectors marked as "list" above return a list,
8946 newline-separated by default,
8947 (embedded separator characters in elements are doubled).
8948 The separator may be changed by a modifier of
8949 a right angle-bracket followed immediately by the new separator.
8950
8951 The field selectors marked as "tagged" above
8952 prefix each list element with a type string and an equals sign.
8953 Elements of only one type may be selected by a modifier
8954 which is one of "dns", "uri" or "mail";
8955 if so the elenment tags are omitted.
8956
8957 If not otherwise noted field values are presented in human-readable form.
8958
8959 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8960        {*&<&'arg'&>&*}...}*&"
8961 .cindex &%dlfunc%&
8962 This expansion dynamically loads and then calls a locally-written C function.
8963 This functionality is available only if Exim is compiled with
8964 .code
8965 EXPAND_DLFUNC=yes
8966 .endd
8967 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8968 object so that it doesn't reload the same object file in the same Exim process
8969 (but of course Exim does start new processes frequently).
8970
8971 There may be from zero to eight arguments to the function. When compiling
8972 a local function that is to be called in this way, &_local_scan.h_& should be
8973 included. The Exim variables and functions that are defined by that API
8974 are also available for dynamically loaded functions. The function itself
8975 must have the following type:
8976 .code
8977 int dlfunction(uschar **yield, int argc, uschar *argv[])
8978 .endd
8979 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8980 function should return one of the following values:
8981
8982 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8983 into the expanded string that is being built.
8984
8985 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8986 from &'yield'&, if it is set.
8987
8988 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8989 taken from &'yield'& if it is set.
8990
8991 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8992
8993 When compiling a function that is to be used in this way with gcc,
8994 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8995 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8996
8997 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8998        {*&<&'string3'&>&*}}*&"
8999 .cindex "expansion" "extracting substrings by key"
9000 .cindex "&%extract%&" "substrings by key"
9001 The key and <&'string1'&> are first expanded separately. Leading and trailing
9002 white space is removed from the key (but not from any of the strings). The key
9003 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9004 form:
9005 .display
9006 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9007 .endd
9008 .vindex "&$value$&"
9009 where the equals signs and spaces (but not both) are optional. If any of the
9010 values contain white space, they must be enclosed in double quotes, and any
9011 values that are enclosed in double quotes are subject to escape processing as
9012 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9013 for the value that corresponds to the key. The search is case-insensitive. If
9014 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9015 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9016 variable &$value$& contains the value that has been extracted. Afterwards, it
9017 is restored to any previous value it might have had.
9018
9019 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9020 key is not found. If {<&'string2'&>} is also omitted, the value that was
9021 extracted is used. Thus, for example, these two expansions are identical, and
9022 yield &"2001"&:
9023 .code
9024 ${extract{gid}{uid=1984 gid=2001}}
9025 ${extract{gid}{uid=1984 gid=2001}{$value}}
9026 .endd
9027 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9028 appear, for example:
9029 .code
9030 ${extract{Z}{A=... B=...}{$value} fail }
9031 .endd
9032 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9033 {<&'string2'&>} must be present for &"fail"& to be recognized.
9034
9035
9036 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9037         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9038 .cindex "expansion" "extracting substrings by number"
9039 .cindex "&%extract%&" "substrings by number"
9040 The <&'number'&> argument must consist entirely of decimal digits,
9041 apart from leading and trailing white space, which is ignored.
9042 This is what distinguishes this form of &%extract%& from the previous kind. It
9043 behaves in the same way, except that, instead of extracting a named field, it
9044 extracts from <&'string1'&> the field whose number is given as the first
9045 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9046 <&'string3'&> as before.
9047
9048 The fields in the string are separated by any one of the characters in the
9049 separator string. These may include space or tab characters.
9050 The first field is numbered one. If the number is negative, the fields are
9051 counted from the end of the string, with the rightmost one numbered -1. If the
9052 number given is zero, the entire string is returned. If the modulus of the
9053 number is greater than the number of fields in the string, the result is the
9054 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9055 provided. For example:
9056 .code
9057 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9058 .endd
9059 yields &"42"&, and
9060 .code
9061 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9062 .endd
9063 yields &"99"&. Two successive separators mean that the field between them is
9064 empty (for example, the fifth field above).
9065
9066
9067 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9068 .cindex "list" "selecting by condition"
9069 .cindex "expansion" "selecting from list by condition"
9070 .vindex "&$item$&"
9071 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9072 default, but the separator can be changed in the usual way. For each item
9073 in this list, its value is place in &$item$&, and then the condition is
9074 evaluated. If the condition is true, &$item$& is added to the output as an
9075 item in a new list; if the condition is false, the item is discarded. The
9076 separator used for the output list is the same as the one used for the
9077 input, but a separator setting is not included in the output. For example:
9078 .code
9079 ${filter{a:b:c}{!eq{$item}{b}}
9080 .endd
9081 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9082 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9083
9084
9085 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9086 .cindex "hash function" "textual"
9087 .cindex "expansion" "textual hash"
9088 This is a textual hashing function, and was the first to be implemented in
9089 early versions of Exim. In current releases, there are other hashing functions
9090 (numeric, MD5, and SHA-1), which are described below.
9091
9092 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9093 <&'n'&>. If you are using fixed values for these numbers, that is, if
9094 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9095 use the simpler operator notation that avoids some of the braces:
9096 .code
9097 ${hash_<n>_<m>:<string>}
9098 .endd
9099 The second number is optional (in both notations). If <&'n'&> is greater than
9100 or equal to the length of the string, the expansion item returns the string.
9101 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9102 function to the string. The new string consists of characters taken from the
9103 first <&'m'&> characters of the string
9104 .code
9105 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9106 .endd
9107 If <&'m'&> is not present the value 26 is used, so that only lower case
9108 letters appear. For example:
9109 .display
9110 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9111 &`$hash{5}{monty}}           `&   yields  &`monty`&
9112 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9113 .endd
9114
9115 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9116         &*$h_*&<&'header&~name'&>&*:*&" &&&
9117        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9118         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9119        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9120         &*$rh_*&<&'header&~name'&>&*:*&"
9121 .cindex "expansion" "header insertion"
9122 .vindex "&$header_$&"
9123 .vindex "&$bheader_$&"
9124 .vindex "&$rheader_$&"
9125 .cindex "header lines" "in expansion strings"
9126 .cindex "header lines" "character sets"
9127 .cindex "header lines" "decoding"
9128 Substitute the contents of the named message header line, for example
9129 .code
9130 $header_reply-to:
9131 .endd
9132 The newline that terminates a header line is not included in the expansion, but
9133 internal newlines (caused by splitting the header line over several physical
9134 lines) may be present.
9135
9136 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9137 the data in the header line is interpreted.
9138
9139 .ilist
9140 .cindex "white space" "in header lines"
9141 &%rheader%& gives the original &"raw"& content of the header line, with no
9142 processing at all, and without the removal of leading and trailing white space.
9143
9144 .next
9145 .cindex "base64 encoding" "in header lines"
9146 &%bheader%& removes leading and trailing white space, and then decodes base64
9147 or quoted-printable MIME &"words"& within the header text, but does no
9148 character set translation. If decoding of what looks superficially like a MIME
9149 &"word"& fails, the raw string is returned. If decoding
9150 .cindex "binary zero" "in header line"
9151 produces a binary zero character, it is replaced by a question mark &-- this is
9152 what Exim does for binary zeros that are actually received in header lines.
9153
9154 .next
9155 &%header%& tries to translate the string as decoded by &%bheader%& to a
9156 standard character set. This is an attempt to produce the same string as would
9157 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9158 returned. Translation is attempted only on operating systems that support the
9159 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9160 a system Makefile or in &_Local/Makefile_&.
9161 .endlist ilist
9162
9163 In a filter file, the target character set for &%header%& can be specified by a
9164 command of the following form:
9165 .code
9166 headers charset "UTF-8"
9167 .endd
9168 This command affects all references to &$h_$& (or &$header_$&) expansions in
9169 subsequently obeyed filter commands. In the absence of this command, the target
9170 character set in a filter is taken from the setting of the &%headers_charset%&
9171 option in the runtime configuration. The value of this option defaults to the
9172 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9173 ISO-8859-1.
9174
9175 Header names follow the syntax of RFC 2822, which states that they may contain
9176 any printing characters except space and colon. Consequently, curly brackets
9177 &'do not'& terminate header names, and should not be used to enclose them as
9178 if they were variables. Attempting to do so causes a syntax error.
9179
9180 Only header lines that are common to all copies of a message are visible to
9181 this mechanism. These are the original header lines that are received with the
9182 message, and any that are added by an ACL statement or by a system
9183 filter. Header lines that are added to a particular copy of a message by a
9184 router or transport are not accessible.
9185
9186 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9187 before the DATA ACL, because the header structure is not set up until the
9188 message is received. Header lines that are added in a RCPT ACL (for example)
9189 are saved until the message's incoming header lines are available, at which
9190 point they are added. When a DATA ACL is running, however, header lines added
9191 by earlier ACLs are visible.
9192
9193 Upper case and lower case letters are synonymous in header names. If the
9194 following character is white space, the terminating colon may be omitted, but
9195 this is not recommended, because you may then forget it when it is needed. When
9196 white space terminates the header name, it is included in the expanded string.
9197 If the message does not contain the given header, the expansion item is
9198 replaced by an empty string. (See the &%def%& condition in section
9199 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9200
9201 If there is more than one header with the same name, they are all concatenated
9202 to form the substitution string, up to a maximum length of 64K. Unless
9203 &%rheader%& is being used, leading and trailing white space is removed from
9204 each header before concatenation, and a completely empty header is ignored. A
9205 newline character is then inserted between non-empty headers, but there is no
9206 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9207 those headers that contain lists of addresses, a comma is also inserted at the
9208 junctions between headers. This does not happen for the &%rheader%& expansion.
9209
9210
9211 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9212 .cindex "expansion" "hmac hashing"
9213 .cindex &%hmac%&
9214 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9215 shared secret and some text into a message authentication code, as specified in
9216 RFC 2104. This differs from &`${md5:secret_text...}`& or
9217 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9218 cryptographic hash, allowing for authentication that is not possible with MD5
9219 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9220 present. For example:
9221 .code
9222 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9223 .endd
9224 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9225 produces:
9226 .code
9227 dd97e3ba5d1a61b5006108f8c8252953
9228 .endd
9229 As an example of how this might be used, you might put in the main part of
9230 an Exim configuration:
9231 .code
9232 SPAMSCAN_SECRET=cohgheeLei2thahw
9233 .endd
9234 In a router or a transport you could then have:
9235 .code
9236 headers_add = \
9237   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9238   ${hmac{md5}{SPAMSCAN_SECRET}\
9239   {${primary_hostname},${message_exim_id},$h_message-id:}}
9240 .endd
9241 Then given a message, you can check where it was scanned by looking at the
9242 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9243 this header line is authentic by recomputing the authentication code from the
9244 host name, message ID and the &'Message-id:'& header line. This can be done
9245 using Exim's &%-be%& option, or by other means, for example by using the
9246 &'hmac_md5_hex()'& function in Perl.
9247
9248
9249 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9250 .cindex "expansion" "conditional"
9251 .cindex "&%if%&, expansion item"
9252 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9253 item; otherwise <&'string2'&> is used. The available conditions are described
9254 in section &<<SECTexpcond>>& below. For example:
9255 .code
9256 ${if eq {$local_part}{postmaster} {yes}{no} }
9257 .endd
9258 The second string need not be present; if it is not and the condition is not
9259 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9260 be present instead of the second string (without any curly brackets). In this
9261 case, the expansion is forced to fail if the condition is not true (see section
9262 &<<SECTforexpfai>>&).
9263
9264 If both strings are omitted, the result is the string &`true`& if the condition
9265 is true, and the empty string if the condition is false. This makes it less
9266 cumbersome to write custom ACL and router conditions. For example, instead of
9267 .code
9268 condition = ${if >{$acl_m4}{3}{true}{false}}
9269 .endd
9270 you can use
9271 .code
9272 condition = ${if >{$acl_m4}{3}}
9273 .endd
9274
9275 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9276 .cindex "expansion" "string truncation"
9277 .cindex "&%length%& expansion item"
9278 The &%length%& item is used to extract the initial portion of a string. Both
9279 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9280 you are using a fixed value for the number, that is, if <&'string1'&> does not
9281 change when expanded, you can use the simpler operator notation that avoids
9282 some of the braces:
9283 .code
9284 ${length_<n>:<string>}
9285 .endd
9286 The result of this item is either the first <&'n'&> characters or the whole
9287 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9288 &%strlen%&, which gives the length of a string.
9289
9290
9291 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9292         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9293 .cindex "expansion" "extracting list elements by number"
9294 .cindex "&%listextract%&" "extract list elements by number"
9295 .cindex "list" "extracting elements by number"
9296 The <&'number'&> argument must consist entirely of decimal digits,
9297 apart from an optional leading minus,
9298 and leading and trailing white space (which is ignored).
9299
9300 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9301 default, but the separator can be changed in the usual way.
9302
9303 The first field of the list is numbered one.
9304 If the number is negative, the fields are
9305 counted from the end of the list, with the rightmost one numbered -1.
9306 The numbered element of the list is extracted and placed in &$value$&,
9307 then <&'string2'&> is expanded as the result.
9308
9309 If the modulus of the
9310 number is zero or greater than the number of fields in the string,
9311 the result is the expansion of <&'string3'&>.
9312
9313 For example:
9314 .code
9315 ${listextract{2}{x:42:99}}
9316 .endd
9317 yields &"42"&, and
9318 .code
9319 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9320 .endd
9321 yields &"result: 99"&.
9322
9323 If {<&'string3'&>} is omitted, an empty string is used for string3.
9324 If {<&'string2'&>} is also omitted, the value that was
9325 extracted is used.
9326 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9327
9328
9329 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9330         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9331 This is the first of one of two different types of lookup item, which are both
9332 described in the next item.
9333
9334 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9335         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9336 .cindex "expansion" "lookup in"
9337 .cindex "file" "lookups"
9338 .cindex "lookup" "in expanded string"
9339 The two forms of lookup item specify data lookups in files and databases, as
9340 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9341 lookups, and the second is used for query-style lookups. The <&'key'&>,
9342 <&'file'&>, and <&'query'&> strings are expanded before use.
9343
9344 If there is any white space in a lookup item which is part of a filter command,
9345 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9346 other place where white space is significant, the lookup item must be enclosed
9347 in double quotes. The use of data lookups in users' filter files may be locked
9348 out by the system administrator.
9349
9350 .vindex "&$value$&"
9351 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9352 During its expansion, the variable &$value$& contains the data returned by the
9353 lookup. Afterwards it reverts to the value it had previously (at the outer
9354 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9355 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9356 string on failure. If <&'string2'&> is provided, it can itself be a nested
9357 lookup, thus providing a mechanism for looking up a default value when the
9358 original lookup fails.
9359
9360 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9361 data for the outer lookup while the parameters of the second lookup are
9362 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9363 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9364 appear, and in this case, if the lookup fails, the entire expansion is forced
9365 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9366 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9367 successful lookup, and nothing in the case of failure.
9368
9369 For single-key lookups, the string &"partial"& is permitted to precede the
9370 search type in order to do partial matching, and * or *@ may follow a search
9371 type to request default lookups if the key does not match (see sections
9372 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9373
9374 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9375 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9376 and non-wild parts of the key during the expansion of the replacement text.
9377 They return to their previous values at the end of the lookup item.
9378
9379 This example looks up the postmaster alias in the conventional alias file:
9380 .code
9381 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9382 .endd
9383 This example uses NIS+ to look up the full name of the user corresponding to
9384 the local part of an address, forcing the expansion to fail if it is not found:
9385 .code
9386 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9387   {$value}fail}
9388 .endd
9389
9390
9391 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9392 .cindex "expansion" "list creation"
9393 .vindex "&$item$&"
9394 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9395 default, but the separator can be changed in the usual way. For each item
9396 in this list, its value is place in &$item$&, and then <&'string2'&> is
9397 expanded and added to the output as an item in a new list. The separator used
9398 for the output list is the same as the one used for the input, but a separator
9399 setting is not included in the output. For example:
9400 .code
9401 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9402 .endd
9403 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9404 value of &$item$& is restored to what it was before. See also the &*filter*&
9405 and &*reduce*& expansion items.
9406
9407 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9408 .cindex "expansion" "numeric hash"
9409 .cindex "hash function" "numeric"
9410 The three strings are expanded; the first two must yield numbers. Call them
9411 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9412 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9413 can use the simpler operator notation that avoids some of the braces:
9414 .code
9415 ${nhash_<n>_<m>:<string>}
9416 .endd
9417 The second number is optional (in both notations). If there is only one number,
9418 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9419 processed by a div/mod hash function that returns two numbers, separated by a
9420 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9421 example,
9422 .code
9423 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9424 .endd
9425 returns the string &"6/33"&.
9426
9427
9428
9429 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9430 .cindex "Perl" "use in expanded string"
9431 .cindex "expansion" "calling Perl from"
9432 This item is available only if Exim has been built to include an embedded Perl
9433 interpreter. The subroutine name and the arguments are first separately
9434 expanded, and then the Perl subroutine is called with those arguments. No
9435 additional arguments need be given; the maximum number permitted, including the
9436 name of the subroutine, is nine.
9437
9438 The return value of the subroutine is inserted into the expanded string, unless
9439 the return value is &%undef%&. In that case, the expansion fails in the same
9440 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9441 Whatever you return is evaluated in a scalar context. For example, if you
9442 return the name of a Perl vector, the return value is the size of the vector,
9443 not its contents.
9444
9445 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9446 with the error message that was passed to &%die%&. More details of the embedded
9447 Perl facility are given in chapter &<<CHAPperl>>&.
9448
9449 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9450 out the use of this expansion item in filter files.
9451
9452
9453 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9454 .cindex "&%prvs%& expansion item"
9455 The first argument is a complete email address and the second is secret
9456 keystring. The third argument, specifying a key number, is optional. If absent,
9457 it defaults to 0. The result of the expansion is a prvs-signed email address,
9458 to be typically used with the &%return_path%& option on an &(smtp)& transport
9459 as part of a bounce address tag validation (BATV) scheme. For more discussion
9460 and an example, see section &<<SECTverifyPRVS>>&.
9461
9462 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9463         {*&<&'string'&>&*}}*&"
9464 .cindex "&%prvscheck%& expansion item"
9465 This expansion item is the complement of the &%prvs%& item. It is used for
9466 checking prvs-signed addresses. If the expansion of the first argument does not
9467 yield a syntactically valid prvs-signed address, the whole item expands to the
9468 empty string. When the first argument does expand to a syntactically valid
9469 prvs-signed address, the second argument is expanded, with the prvs-decoded
9470 version of the address and the key number extracted from the address in the
9471 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9472
9473 These two variables can be used in the expansion of the second argument to
9474 retrieve the secret. The validity of the prvs-signed address is then checked
9475 against the secret. The result is stored in the variable &$prvscheck_result$&,
9476 which is empty for failure or &"1"& for success.
9477
9478 The third argument is optional; if it is missing, it defaults to an empty
9479 string. This argument is now expanded. If the result is an empty string, the
9480 result of the expansion is the decoded version of the address. This is the case
9481 whether or not the signature was valid. Otherwise, the result of the expansion
9482 is the expansion of the third argument.
9483
9484 All three variables can be used in the expansion of the third argument.
9485 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9486 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9487
9488 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9489 .cindex "expansion" "inserting an entire file"
9490 .cindex "file" "inserting into expansion"
9491 .cindex "&%readfile%& expansion item"
9492 The file name and end-of-line string are first expanded separately. The file is
9493 then read, and its contents replace the entire item. All newline characters in
9494 the file are replaced by the end-of-line string if it is present. Otherwise,
9495 newlines are left in the string.
9496 String expansion is not applied to the contents of the file. If you want this,
9497 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9498 the string expansion fails.
9499
9500 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9501 locks out the use of this expansion item in filter files.
9502
9503
9504
9505 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9506         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9507 .cindex "expansion" "inserting from a socket"
9508 .cindex "socket, use of in expansion"
9509 .cindex "&%readsocket%& expansion item"
9510 This item inserts data from a Unix domain or Internet socket into the expanded
9511 string. The minimal way of using it uses just two arguments, as in these
9512 examples:
9513 .code
9514 ${readsocket{/socket/name}{request string}}
9515 ${readsocket{inet:some.host:1234}{request string}}
9516 .endd
9517 For a Unix domain socket, the first substring must be the path to the socket.
9518 For an Internet socket, the first substring must contain &`inet:`& followed by
9519 a host name or IP address, followed by a colon and a port, which can be a
9520 number or the name of a TCP port in &_/etc/services_&. An IP address may
9521 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9522 example:
9523 .code
9524 ${readsocket{inet:[::1]:1234}{request string}}
9525 .endd
9526 Only a single host name may be given, but if looking it up yields more than
9527 one IP address, they are each tried in turn until a connection is made. For
9528 both kinds of socket, Exim makes a connection, writes the request string
9529 (unless it is an empty string) and reads from the socket until an end-of-file
9530 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9531 extend what can be done. Firstly, you can vary the timeout. For example:
9532 .code
9533 ${readsocket{/socket/name}{request string}{3s}}
9534 .endd
9535 A fourth argument allows you to change any newlines that are in the data
9536 that is read, in the same way as for &%readfile%& (see above). This example
9537 turns them into spaces:
9538 .code
9539 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9540 .endd
9541 As with all expansions, the substrings are expanded before the processing
9542 happens. Errors in these sub-expansions cause the expansion to fail. In
9543 addition, the following errors can occur:
9544
9545 .ilist
9546 Failure to create a socket file descriptor;
9547 .next
9548 Failure to connect the socket;
9549 .next
9550 Failure to write the request string;
9551 .next
9552 Timeout on reading from the socket.
9553 .endlist
9554
9555 By default, any of these errors causes the expansion to fail. However, if
9556 you supply a fifth substring, it is expanded and used when any of the above
9557 errors occurs. For example:
9558 .code
9559 ${readsocket{/socket/name}{request string}{3s}{\n}\
9560   {socket failure}}
9561 .endd
9562 You can test for the existence of a Unix domain socket by wrapping this
9563 expansion in &`${if exists`&, but there is a race condition between that test
9564 and the actual opening of the socket, so it is safer to use the fifth argument
9565 if you want to be absolutely sure of avoiding an expansion error for a
9566 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9567
9568 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9569 locks out the use of this expansion item in filter files.
9570
9571
9572 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9573 .cindex "expansion" "reducing a list to a scalar"
9574 .cindex "list" "reducing to a scalar"
9575 .vindex "&$value$&"
9576 .vindex "&$item$&"
9577 This operation reduces a list to a single, scalar string. After expansion,
9578 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9579 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9580 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9581 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9582 them. The result of that expansion is assigned to &$value$& before the next
9583 iteration. When the end of the list is reached, the final value of &$value$& is
9584 added to the expansion output. The &*reduce*& expansion item can be used in a
9585 number of ways. For example, to add up a list of numbers:
9586 .code
9587 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9588 .endd
9589 The result of that expansion would be &`6`&. The maximum of a list of numbers
9590 can be found:
9591 .code
9592 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9593 .endd
9594 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9595 restored to what they were before. See also the &*filter*& and &*map*&
9596 expansion items.
9597
9598 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9599 This item inserts &"raw"& header lines. It is described with the &%header%&
9600 expansion item above.
9601
9602 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9603         {*&<&'string2'&>&*}}*&"
9604 .cindex "expansion" "running a command"
9605 .cindex "&%run%& expansion item"
9606 The command and its arguments are first expanded as one string. The string is
9607 split apart into individual arguments by spaces, and then the command is run
9608 in a separate process, but under the same uid and gid.  As in other command
9609 executions from Exim, a shell is not used by default. If the command requires
9610 a shell, you must explicitly code it.
9611
9612 Since the arguments are split by spaces, when there is a variable expansion
9613 which has an empty result, it will cause the situation that the argument will
9614 simply be omitted when the program is actually executed by Exim. If the
9615 script/program requires a specific number of arguments and the expanded
9616 variable could possibly result in this empty expansion, the variable must be
9617 quoted. This is more difficult if the expanded variable itself could result
9618 in a string containing quotes, because it would interfere with the quotes
9619 around the command arguments. A possible guard against this is to wrap the
9620 variable in the &%sg%& operator to change any quote marks to some other
9621 character.
9622
9623 The standard input for the command exists, but is empty. The standard output
9624 and standard error are set to the same file descriptor.
9625 .cindex "return code" "from &%run%& expansion"
9626 .vindex "&$value$&"
9627 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9628 and replaces the entire item; during this expansion, the standard output/error
9629 from the command is in the variable &$value$&. If the command fails,
9630 <&'string2'&>, if present, is expanded and used. Once again, during the
9631 expansion, the standard output/error from the command is in the variable
9632 &$value$&.
9633
9634 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9635 can be the word &"fail"& (not in braces) to force expansion failure if the
9636 command does not succeed. If both strings are omitted, the result is contents
9637 of the standard output/error on success, and nothing on failure.
9638
9639 .vindex "&$run_in_acl$&"
9640 The standard output/error of the command is put in the variable &$value$&.
9641 In this ACL example, the output of a command is logged for the admin to
9642 troubleshoot:
9643 .code
9644 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9645       log_message  = Output of id: $value
9646 .endd
9647 If the command requires shell idioms, such as the > redirect operator, the
9648 shell must be invoked directly, such as with:
9649 .code
9650 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9651 .endd
9652
9653 .vindex "&$runrc$&"
9654 The return code from the command is put in the variable &$runrc$&, and this
9655 remains set afterwards, so in a filter file you can do things like this:
9656 .code
9657 if "${run{x y z}{}}$runrc" is 1 then ...
9658   elif $runrc is 2 then ...
9659   ...
9660 endif
9661 .endd
9662 If execution of the command fails (for example, the command does not exist),
9663 the return code is 127 &-- the same code that shells use for non-existent
9664 commands.
9665
9666 &*Warning*&: In a router or transport, you cannot assume the order in which
9667 option values are expanded, except for those preconditions whose order of
9668 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9669 by the expansion of one option, and use it in another.
9670
9671 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9672 out the use of this expansion item in filter files.
9673
9674
9675 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9676 .cindex "expansion" "string substitution"
9677 .cindex "&%sg%& expansion item"
9678 This item works like Perl's substitution operator (s) with the global (/g)
9679 option; hence its name. However, unlike the Perl equivalent, Exim does not
9680 modify the subject string; instead it returns the modified string for insertion
9681 into the overall expansion. The item takes three arguments: the subject string,
9682 a regular expression, and a substitution string. For example:
9683 .code
9684 ${sg{abcdefabcdef}{abc}{xyz}}
9685 .endd
9686 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9687 if any $ or \ characters are required in the regular expression or in the
9688 substitution string, they have to be escaped. For example:
9689 .code
9690 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9691 .endd
9692 yields &"defabc"&, and
9693 .code
9694 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9695 .endd
9696 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9697 the regular expression from string expansion.
9698
9699
9700
9701 .new
9702 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9703 .cindex sorting a list
9704 .cindex list sorting
9705 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9706 default, but the separator can be changed in the usual way.
9707 The <&'comparator'&> argument is interpreted as the operator
9708 of a two-argument expansion condition.
9709 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9710 The comparison should return true when applied to two values
9711 if the first value should sort before the second value.
9712 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9713 the element being placed in &$item$&,
9714 to give values for comparison.
9715
9716 The item result is a sorted list,
9717 with the original list separator,
9718 of the list elements (in full) of the original.
9719
9720 Examples:
9721 .code
9722 ${sort{3:2:1:4}{<}{$item}}
9723 .endd
9724 sorts a list of numbers, and
9725 .code
9726 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9727 .endd
9728 will sort an MX lookup into priority order.
9729 .wen
9730
9731
9732 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9733 .cindex "&%substr%& expansion item"
9734 .cindex "substring extraction"
9735 .cindex "expansion" "substring extraction"
9736 The three strings are expanded; the first two must yield numbers. Call them
9737 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9738 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9739 can use the simpler operator notation that avoids some of the braces:
9740 .code
9741 ${substr_<n>_<m>:<string>}
9742 .endd
9743 The second number is optional (in both notations).
9744 If it is absent in the simpler format, the preceding underscore must also be
9745 omitted.
9746
9747 The &%substr%& item can be used to extract more general substrings than
9748 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9749 length required. For example
9750 .code
9751 ${substr{3}{2}{$local_part}}
9752 .endd
9753 If the starting offset is greater than the string length the result is the
9754 null string; if the length plus starting offset is greater than the string
9755 length, the result is the right-hand part of the string, starting from the
9756 given offset. The first character in the string has offset zero.
9757
9758 The &%substr%& expansion item can take negative offset values to count
9759 from the right-hand end of its operand. The last character is offset -1, the
9760 second-last is offset -2, and so on. Thus, for example,
9761 .code
9762 ${substr{-5}{2}{1234567}}
9763 .endd
9764 yields &"34"&. If the absolute value of a negative offset is greater than the
9765 length of the string, the substring starts at the beginning of the string, and
9766 the length is reduced by the amount of overshoot. Thus, for example,
9767 .code
9768 ${substr{-5}{2}{12}}
9769 .endd
9770 yields an empty string, but
9771 .code
9772 ${substr{-3}{2}{12}}
9773 .endd
9774 yields &"1"&.
9775
9776 When the second number is omitted from &%substr%&, the remainder of the string
9777 is taken if the offset is positive. If it is negative, all characters in the
9778 string preceding the offset point are taken. For example, an offset of -1 and
9779 no length, as in these semantically identical examples:
9780 .code
9781 ${substr_-1:abcde}
9782 ${substr{-1}{abcde}}
9783 .endd
9784 yields all but the last character of the string, that is, &"abcd"&.
9785
9786
9787
9788 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9789         {*&<&'replacements'&>&*}}*&"
9790 .cindex "expansion" "character translation"
9791 .cindex "&%tr%& expansion item"
9792 This item does single-character translation on its subject string. The second
9793 argument is a list of characters to be translated in the subject string. Each
9794 matching character is replaced by the corresponding character from the
9795 replacement list. For example
9796 .code
9797 ${tr{abcdea}{ac}{13}}
9798 .endd
9799 yields &`1b3de1`&. If there are duplicates in the second character string, the
9800 last occurrence is used. If the third string is shorter than the second, its
9801 last character is replicated. However, if it is empty, no translation takes
9802 place.
9803 .endlist
9804
9805
9806
9807 .section "Expansion operators" "SECTexpop"
9808 .cindex "expansion" "operators"
9809 For expansion items that perform transformations on a single argument string,
9810 the &"operator"& notation is used because it is simpler and uses fewer braces.
9811 The substring is first expanded before the operation is applied to it. The
9812 following operations can be performed:
9813
9814 .vlist
9815 .vitem &*${address:*&<&'string'&>&*}*&
9816 .cindex "expansion" "RFC 2822 address handling"
9817 .cindex "&%address%& expansion item"
9818 The string is interpreted as an RFC 2822 address, as it might appear in a
9819 header line, and the effective address is extracted from it. If the string does
9820 not parse successfully, the result is empty.
9821
9822
9823 .vitem &*${addresses:*&<&'string'&>&*}*&
9824 .cindex "expansion" "RFC 2822 address handling"
9825 .cindex "&%addresses%& expansion item"
9826 The string (after expansion) is interpreted as a list of addresses in RFC
9827 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9828 operative address (&'local-part@domain'&) is extracted from each item, and the
9829 result of the expansion is a colon-separated list, with appropriate
9830 doubling of colons should any happen to be present in the email addresses.
9831 Syntactically invalid RFC2822 address items are omitted from the output.
9832
9833 It is possible to specify a character other than colon for the output
9834 separator by starting the string with > followed by the new separator
9835 character. For example:
9836 .code
9837 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9838 .endd
9839 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9840 expansion item, which extracts the working address from a single RFC2822
9841 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9842 processing lists.
9843
9844 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9845 a strict interpretation of header line formatting.  Exim parses the bare,
9846 unquoted portion of an email address and if it finds a comma, treats it as an
9847 email address seperator. For the example header line:
9848 .code
9849 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9850 .endd
9851 The first example below demonstrates that Q-encoded email addresses are parsed
9852 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9853 It does not see the comma because it's still encoded as "=2C".  The second
9854 example below is passed the contents of &`$header_from:`&, meaning it gets
9855 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9856 The third example shows that the presence of a comma is skipped when it is
9857 quoted.
9858 .code
9859 # exim -be '${addresses:From: \
9860 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9861 user@example.com
9862 # exim -be '${addresses:From: Last, First <user@example.com>}'
9863 Last:user@example.com
9864 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9865 user@example.com
9866 .endd
9867
9868 .vitem &*${base62:*&<&'digits'&>&*}*&
9869 .cindex "&%base62%& expansion item"
9870 .cindex "expansion" "conversion to base 62"
9871 The string must consist entirely of decimal digits. The number is converted to
9872 base 62 and output as a string of six characters, including leading zeros. In
9873 the few operating environments where Exim uses base 36 instead of base 62 for
9874 its message identifiers (because those systems do not have case-sensitive file
9875 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9876 be absolutely clear: this is &'not'& base64 encoding.
9877
9878 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9879 .cindex "&%base62d%& expansion item"
9880 .cindex "expansion" "conversion to base 62"
9881 The string must consist entirely of base-62 digits, or, in operating
9882 environments where Exim uses base 36 instead of base 62 for its message
9883 identifiers, base-36 digits. The number is converted to decimal and output as a
9884 string.
9885
9886
9887 .vitem &*${domain:*&<&'string'&>&*}*&
9888 .cindex "domain" "extraction"
9889 .cindex "expansion" "domain extraction"
9890 The string is interpreted as an RFC 2822 address and the domain is extracted
9891 from it. If the string does not parse successfully, the result is empty.
9892
9893
9894 .vitem &*${escape:*&<&'string'&>&*}*&
9895 .cindex "expansion" "escaping non-printing characters"
9896 .cindex "&%escape%& expansion item"
9897 If the string contains any non-printing characters, they are converted to
9898 escape sequences starting with a backslash. Whether characters with the most
9899 significant bit set (so-called &"8-bit characters"&) count as printing or not
9900 is controlled by the &%print_topbitchars%& option.
9901
9902
9903 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9904 .cindex "expansion" "expression evaluation"
9905 .cindex "expansion" "arithmetic expression"
9906 .cindex "&%eval%& expansion item"
9907 These items supports simple arithmetic and bitwise logical operations in
9908 expansion strings. The string (after expansion) must be a conventional
9909 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9910 logical operators, and parentheses. All operations are carried out using
9911 integer arithmetic. The operator priorities are as follows (the same as in the
9912 C programming language):
9913 .table2 70pt 300pt
9914 .irow &'highest:'& "not (~), negate (-)"
9915 .irow ""   "multiply (*), divide (/), remainder (%)"
9916 .irow ""   "plus (+), minus (-)"
9917 .irow ""   "shift-left (<<), shift-right (>>)"
9918 .irow ""   "and (&&)"
9919 .irow ""   "xor (^)"
9920 .irow &'lowest:'&  "or (|)"
9921 .endtable
9922 Binary operators with the same priority are evaluated from left to right. White
9923 space is permitted before or after operators.
9924
9925 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9926 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9927 decimal, even if they start with a leading zero; hexadecimal numbers are not
9928 permitted. This can be useful when processing numbers extracted from dates or
9929 times, which often do have leading zeros.
9930
9931 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9932 or 1024*1024*1024,
9933 respectively. Negative numbers are supported. The result of the computation is
9934 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9935
9936 .display
9937 &`${eval:1+1}            `&  yields 2
9938 &`${eval:1+2*3}          `&  yields 7
9939 &`${eval:(1+2)*3}        `&  yields 9
9940 &`${eval:2+42%5}         `&  yields 4
9941 &`${eval:0xc&amp;5}          `&  yields 4
9942 &`${eval:0xc|5}          `&  yields 13
9943 &`${eval:0xc^5}          `&  yields 9
9944 &`${eval:0xc>>1}         `&  yields 6
9945 &`${eval:0xc<<1}         `&  yields 24
9946 &`${eval:~255&amp;0x1234}    `&  yields 4608
9947 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9948 .endd
9949
9950 As a more realistic example, in an ACL you might have
9951 .code
9952 deny   message = Too many bad recipients
9953        condition =                    \
9954          ${if and {                   \
9955            {>{$rcpt_count}{10}}       \
9956            {                          \
9957            <                          \
9958              {$recipients_count}      \
9959              {${eval:$rcpt_count/2}}  \
9960            }                          \
9961          }{yes}{no}}
9962 .endd
9963 The condition is true if there have been more than 10 RCPT commands and
9964 fewer than half of them have resulted in a valid recipient.
9965
9966
9967 .vitem &*${expand:*&<&'string'&>&*}*&
9968 .cindex "expansion" "re-expansion of substring"
9969 The &%expand%& operator causes a string to be expanded for a second time. For
9970 example,
9971 .code
9972 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9973 .endd
9974 first looks up a string in a file while expanding the operand for &%expand%&,
9975 and then re-expands what it has found.
9976
9977
9978 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9979 .cindex "Unicode"
9980 .cindex "UTF-8" "conversion from"
9981 .cindex "expansion" "UTF-8 conversion"
9982 .cindex "&%from_utf8%& expansion item"
9983 The world is slowly moving towards Unicode, although there are no standards for
9984 email yet. However, other applications (including some databases) are starting
9985 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9986 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9987 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9988 the result is an undefined sequence of bytes.
9989
9990 Unicode code points with values less than 256 are compatible with ASCII and
9991 ISO-8859-1 (also known as Latin-1).
9992 For example, character 169 is the copyright symbol in both cases, though the
9993 way it is encoded is different. In UTF-8, more than one byte is needed for
9994 characters with code values greater than 127, whereas ISO-8859-1 is a
9995 single-byte encoding (but thereby limited to 256 characters). This makes
9996 translation from UTF-8 to ISO-8859-1 straightforward.
9997
9998
9999 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10000 .cindex "hash function" "textual"
10001 .cindex "expansion" "textual hash"
10002 The &%hash%& operator is a simpler interface to the hashing function that can
10003 be used when the two parameters are fixed numbers (as opposed to strings that
10004 change when expanded). The effect is the same as
10005 .code
10006 ${hash{<n>}{<m>}{<string>}}
10007 .endd
10008 See the description of the general &%hash%& item above for details. The
10009 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10010
10011
10012
10013 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10014 .cindex "base64 encoding" "conversion from hex"
10015 .cindex "expansion" "hex to base64"
10016 .cindex "&%hex2b64%& expansion item"
10017 This operator converts a hex string into one that is base64 encoded. This can
10018 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10019
10020
10021
10022 .vitem &*${hexquote:*&<&'string'&>&*}*&
10023 .cindex "quoting" "hex-encoded unprintable characters"
10024 .cindex "&%hexquote%& expansion item"
10025 This operator converts non-printable characters in a string into a hex
10026 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10027 as is, and other byte values are converted to &`\xNN`&, for example a
10028 byte value 127 is converted to &`\x7f`&.
10029
10030
10031 .vitem &*${lc:*&<&'string'&>&*}*&
10032 .cindex "case forcing in strings"
10033 .cindex "string" "case forcing"
10034 .cindex "lower casing"
10035 .cindex "expansion" "case forcing"
10036 .cindex "&%lc%& expansion item"
10037 This forces the letters in the string into lower-case, for example:
10038 .code
10039 ${lc:$local_part}
10040 .endd
10041
10042 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10043 .cindex "expansion" "string truncation"
10044 .cindex "&%length%& expansion item"
10045 The &%length%& operator is a simpler interface to the &%length%& function that
10046 can be used when the parameter is a fixed number (as opposed to a string that
10047 changes when expanded). The effect is the same as
10048 .code
10049 ${length{<number>}{<string>}}
10050 .endd
10051 See the description of the general &%length%& item above for details. Note that
10052 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10053 when &%length%& is used as an operator.
10054
10055
10056 .vitem &*${listcount:*&<&'string'&>&*}*&
10057 .cindex "expansion" "list item count"
10058 .cindex "list" "item count"
10059 .cindex "list" "count of items"
10060 .cindex "&%listcount%& expansion item"
10061 The string is interpreted as a list and the number of items is returned.
10062
10063
10064 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10065 .cindex "expansion" "named list"
10066 .cindex "&%listnamed%& expansion item"
10067 The name is interpreted as a named list and the content of the list is returned,
10068 expanding any referenced lists, re-quoting as needed for colon-separation.
10069 If the optional type is given it must be one of "a", "d", "h" or "l"
10070 and selects address-, domain-, host- or localpart- lists to search among respectively.
10071 Otherwise all types are searched in an undefined order and the first
10072 matching list is returned.
10073
10074
10075 .vitem &*${local_part:*&<&'string'&>&*}*&
10076 .cindex "expansion" "local part extraction"
10077 .cindex "&%local_part%& expansion item"
10078 The string is interpreted as an RFC 2822 address and the local part is
10079 extracted from it. If the string does not parse successfully, the result is
10080 empty.
10081
10082
10083 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10084 .cindex "masked IP address"
10085 .cindex "IP address" "masking"
10086 .cindex "CIDR notation"
10087 .cindex "expansion" "IP address masking"
10088 .cindex "&%mask%& expansion item"
10089 If the form of the string to be operated on is not an IP address followed by a
10090 slash and an integer (that is, a network address in CIDR notation), the
10091 expansion fails. Otherwise, this operator converts the IP address to binary,
10092 masks off the least significant bits according to the bit count, and converts
10093 the result back to text, with mask appended. For example,
10094 .code
10095 ${mask:10.111.131.206/28}
10096 .endd
10097 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10098 be mostly used for looking up masked addresses in files, the result for an IPv6
10099 address uses dots to separate components instead of colons, because colon
10100 terminates a key string in lsearch files. So, for example,
10101 .code
10102 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10103 .endd
10104 returns the string
10105 .code
10106 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10107 .endd
10108 Letters in IPv6 addresses are always output in lower case.
10109
10110
10111 .vitem &*${md5:*&<&'string'&>&*}*&
10112 .cindex "MD5 hash"
10113 .cindex "expansion" "MD5 hash"
10114 .cindex "certificate fingerprint"
10115 .cindex "&%md5%& expansion item"
10116 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10117 as a 32-digit hexadecimal number, in which any letters are in lower case.
10118
10119
10120 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10121 .cindex "expansion" "numeric hash"
10122 .cindex "hash function" "numeric"
10123 The &%nhash%& operator is a simpler interface to the numeric hashing function
10124 that can be used when the two parameters are fixed numbers (as opposed to
10125 strings that change when expanded). The effect is the same as
10126 .code
10127 ${nhash{<n>}{<m>}{<string>}}
10128 .endd
10129 See the description of the general &%nhash%& item above for details.
10130
10131
10132 .vitem &*${quote:*&<&'string'&>&*}*&
10133 .cindex "quoting" "in string expansions"
10134 .cindex "expansion" "quoting"
10135 .cindex "&%quote%& expansion item"
10136 The &%quote%& operator puts its argument into double quotes if it
10137 is an empty string or
10138 contains anything other than letters, digits, underscores, dots, and hyphens.
10139 Any occurrences of double quotes and backslashes are escaped with a backslash.
10140 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10141 respectively For example,
10142 .code
10143 ${quote:ab"*"cd}
10144 .endd
10145 becomes
10146 .code
10147 "ab\"*\"cd"
10148 .endd
10149 The place where this is useful is when the argument is a substitution from a
10150 variable or a message header.
10151
10152 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10153 .cindex "&%quote_local_part%& expansion item"
10154 This operator is like &%quote%&, except that it quotes the string only if
10155 required to do so by the rules of RFC 2822 for quoting local parts. For
10156 example, a plus sign would not cause quoting (but it would for &%quote%&).
10157 If you are creating a new email address from the contents of &$local_part$&
10158 (or any other unknown data), you should always use this operator.
10159
10160
10161 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10162 .cindex "quoting" "lookup-specific"
10163 This operator applies lookup-specific quoting rules to the string. Each
10164 query-style lookup type has its own quoting rules which are described with
10165 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10166 .code
10167 ${quote_ldap:two * two}
10168 .endd
10169 returns
10170 .code
10171 two%20%5C2A%20two
10172 .endd
10173 For single-key lookup types, no quoting is ever necessary and this operator
10174 yields an unchanged string.
10175
10176
10177 .vitem &*${randint:*&<&'n'&>&*}*&
10178 .cindex "random number"
10179 This operator returns a somewhat random number which is less than the
10180 supplied number and is at least 0.  The quality of this randomness depends
10181 on how Exim was built; the values are not suitable for keying material.
10182 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10183 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10184 for versions of GnuTLS with that function.
10185 Otherwise, the implementation may be arc4random(), random() seeded by
10186 srandomdev() or srandom(), or a custom implementation even weaker than
10187 random().
10188
10189
10190 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10191 .cindex "expansion" "IP address"
10192 This operator reverses an IP address; for IPv4 addresses, the result is in
10193 dotted-quad decimal form, while for IPv6 addreses the result is in
10194 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10195 for DNS.  For example,
10196 .code
10197 ${reverse_ip:192.0.2.4}
10198 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10199 .endd
10200 returns
10201 .code
10202 4.2.0.192
10203 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
10204 .endd
10205
10206
10207 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10208 .cindex "expansion" "RFC 2047"
10209 .cindex "RFC 2047" "expansion operator"
10210 .cindex "&%rfc2047%& expansion item"
10211 This operator encodes text according to the rules of RFC 2047. This is an
10212 encoding that is used in header lines to encode non-ASCII characters. It is
10213 assumed that the input string is in the encoding specified by the
10214 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10215 contains only characters in the range 33&--126, and no instances of the
10216 characters
10217 .code
10218 ? = ( ) < > @ , ; : \ " . [ ] _
10219 .endd
10220 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10221 string, using as many &"encoded words"& as necessary to encode all the
10222 characters.
10223
10224
10225 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10226 .cindex "expansion" "RFC 2047"
10227 .cindex "RFC 2047" "decoding"
10228 .cindex "&%rfc2047d%& expansion item"
10229 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10230 bytes are replaced by question marks. Characters are converted into the
10231 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10232 not recognized unless &%check_rfc2047_length%& is set false.
10233
10234 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10235 access a header line, RFC 2047 decoding is done automatically. You do not need
10236 to use this operator as well.
10237
10238
10239
10240 .vitem &*${rxquote:*&<&'string'&>&*}*&
10241 .cindex "quoting" "in regular expressions"
10242 .cindex "regular expressions" "quoting"
10243 .cindex "&%rxquote%& expansion item"
10244 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10245 characters in its argument. This is useful when substituting the values of
10246 variables or headers inside regular expressions.
10247
10248
10249 .vitem &*${sha1:*&<&'string'&>&*}*&
10250 .cindex "SHA-1 hash"
10251 .cindex "expansion" "SHA-1 hashing"
10252 .cindex "certificate fingerprint"
10253 .cindex "&%sha2%& expansion item"
10254 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10255 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10256
10257
10258 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10259 .cindex "SHA-256 hash"
10260 .cindex "certificate fingerprint"
10261 .cindex "expansion" "SHA-256 hashing"
10262 .cindex "&%sha256%& expansion item"
10263 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10264 certificate,
10265 and returns
10266 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10267 Only arguments which are a single variable of certificate type are supported.
10268
10269
10270 .vitem &*${stat:*&<&'string'&>&*}*&
10271 .cindex "expansion" "statting a file"
10272 .cindex "file" "extracting characteristics"
10273 .cindex "&%stat%& expansion item"
10274 The string, after expansion, must be a file path. A call to the &[stat()]&
10275 function is made for this path. If &[stat()]& fails, an error occurs and the
10276 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10277 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10278 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10279 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10280 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10281 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10282 can extract individual fields using the &%extract%& expansion item.
10283
10284 The use of the &%stat%& expansion in users' filter files can be locked out by
10285 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10286 systems for files larger than 2GB.
10287
10288 .vitem &*${str2b64:*&<&'string'&>&*}*&
10289 .cindex "expansion" "base64 encoding"
10290 .cindex "base64 encoding" "in string expansion"
10291 .cindex "&%str2b64%& expansion item"
10292 This operator converts a string into one that is base64 encoded.
10293
10294
10295
10296 .vitem &*${strlen:*&<&'string'&>&*}*&
10297 .cindex "expansion" "string length"
10298 .cindex "string" "length in expansion"
10299 .cindex "&%strlen%& expansion item"
10300 The item is replace by the length of the expanded string, expressed as a
10301 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10302
10303
10304 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10305 .cindex "&%substr%& expansion item"
10306 .cindex "substring extraction"
10307 .cindex "expansion" "substring expansion"
10308 The &%substr%& operator is a simpler interface to the &%substr%& function that
10309 can be used when the two parameters are fixed numbers (as opposed to strings
10310 that change when expanded). The effect is the same as
10311 .code
10312 ${substr{<start>}{<length>}{<string>}}
10313 .endd
10314 See the description of the general &%substr%& item above for details. The
10315 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10316
10317 .vitem &*${time_eval:*&<&'string'&>&*}*&
10318 .cindex "&%time_eval%& expansion item"
10319 .cindex "time interval" "decoding"
10320 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10321 seconds.
10322
10323 .vitem &*${time_interval:*&<&'string'&>&*}*&
10324 .cindex "&%time_interval%& expansion item"
10325 .cindex "time interval" "formatting"
10326 The argument (after sub-expansion) must be a sequence of decimal digits that
10327 represents an interval of time as a number of seconds. It is converted into a
10328 number of larger units and output in Exim's normal time format, for example,
10329 &`1w3d4h2m6s`&.
10330
10331 .vitem &*${uc:*&<&'string'&>&*}*&
10332 .cindex "case forcing in strings"
10333 .cindex "string" "case forcing"
10334 .cindex "upper casing"
10335 .cindex "expansion" "case forcing"
10336 .cindex "&%uc%& expansion item"
10337 This forces the letters in the string into upper-case.
10338
10339 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10340 .cindex "correction of invalid utf-8 sequences in strings"
10341 .cindex "utf-8" "utf-8 sequences"
10342 .cindex "incorrect utf-8"
10343 .cindex "expansion" "utf-8 forcing"
10344 .cindex "&%utf8clean%& expansion item"
10345 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10346 .endlist
10347
10348
10349
10350
10351
10352
10353 .section "Expansion conditions" "SECTexpcond"
10354 .scindex IIDexpcond "expansion" "conditions"
10355 The following conditions are available for testing by the &%${if%& construct
10356 while expanding strings:
10357
10358 .vlist
10359 .vitem &*!*&<&'condition'&>
10360 .cindex "expansion" "negating a condition"
10361 .cindex "negation" "in expansion condition"
10362 Preceding any condition with an exclamation mark negates the result of the
10363 condition.
10364
10365 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10366 .cindex "numeric comparison"
10367 .cindex "expansion" "numeric comparison"
10368 There are a number of symbolic operators for doing numeric comparisons. They
10369 are:
10370 .display
10371 &`=   `&   equal
10372 &`==  `&   equal
10373 &`>   `&   greater
10374 &`>=  `&   greater or equal
10375 &`<   `&   less
10376 &`<=  `&   less or equal
10377 .endd
10378 For example:
10379 .code
10380 ${if >{$message_size}{10M} ...
10381 .endd
10382 Note that the general negation operator provides for inequality testing. The
10383 two strings must take the form of optionally signed decimal integers,
10384 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10385 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10386 As a special case, the numerical value of an empty string is taken as
10387 zero.
10388
10389 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10390 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10391 10M, not if 10M is larger than &$message_size$&.
10392
10393
10394 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10395         {*&<&'arg2'&>&*}...}*&
10396 .cindex "expansion" "calling an acl"
10397 .cindex "&%acl%&" "expansion condition"
10398 The name and zero to nine argument strings are first expanded separately.  The expanded
10399 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10400 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10401 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10402 and may use the variables; if another acl expansion is used the values
10403 are restored after it returns.  If the ACL sets
10404 a value using a "message =" modifier the variable $value becomes
10405 the result of the expansion, otherwise it is empty.
10406 If the ACL returns accept the condition is true; if deny, false.
10407 If the ACL returns defer the result is a forced-fail.
10408
10409 .vitem &*bool&~{*&<&'string'&>&*}*&
10410 .cindex "expansion" "boolean parsing"
10411 .cindex "&%bool%& expansion condition"
10412 This condition turns a string holding a true or false representation into
10413 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10414 (case-insensitively); also integer numbers map to true if non-zero,
10415 false if zero.
10416 An empty string is treated as false.
10417 Leading and trailing whitespace is ignored;
10418 thus a string consisting only of whitespace is false.
10419 All other string values will result in expansion failure.
10420
10421 When combined with ACL variables, this expansion condition will let you
10422 make decisions in one place and act on those decisions in another place.
10423 For example:
10424 .code
10425 ${if bool{$acl_m_privileged_sender} ...
10426 .endd
10427
10428
10429 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10430 .cindex "expansion" "boolean parsing"
10431 .cindex "&%bool_lax%& expansion condition"
10432 Like &%bool%&, this condition turns a string into a boolean state.  But
10433 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10434 loose definition that the Router &%condition%& option uses.  The empty string
10435 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10436 true.  Leading and trailing whitespace is ignored.
10437
10438 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10439
10440 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10441 .cindex "expansion" "encrypted comparison"
10442 .cindex "encrypted strings, comparing"
10443 .cindex "&%crypteq%& expansion condition"
10444 This condition is included in the Exim binary if it is built to support any
10445 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10446 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10447 included in the binary.
10448
10449 The &%crypteq%& condition has two arguments. The first is encrypted and
10450 compared against the second, which is already encrypted. The second string may
10451 be in the LDAP form for storing encrypted strings, which starts with the
10452 encryption type in curly brackets, followed by the data. If the second string
10453 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10454 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10455 Typically this will be a field from a password file. An example of an encrypted
10456 string in LDAP form is:
10457 .code
10458 {md5}CY9rzUYh03PK3k6DJie09g==
10459 .endd
10460 If such a string appears directly in an expansion, the curly brackets have to
10461 be quoted, because they are part of the expansion syntax. For example:
10462 .code
10463 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10464 .endd
10465 The following encryption types (whose names are matched case-independently) are
10466 supported:
10467
10468 .ilist
10469 .cindex "MD5 hash"
10470 .cindex "base64 encoding" "in encrypted password"
10471 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10472 printable characters to compare with the remainder of the second string. If the
10473 length of the comparison string is 24, Exim assumes that it is base64 encoded
10474 (as in the above example). If the length is 32, Exim assumes that it is a
10475 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10476 comparison fails.
10477
10478 .next
10479 .cindex "SHA-1 hash"
10480 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10481 printable characters to compare with the remainder of the second string. If the
10482 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10483 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10484 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10485
10486 .next
10487 .cindex "&[crypt()]&"
10488 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10489 only the first eight characters of the password. However, in modern operating
10490 systems this is no longer true, and in many cases the entire password is used,
10491 whatever its length.
10492
10493 .next
10494 .cindex "&[crypt16()]&"
10495 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10496 use up to 16 characters of the password in some operating systems. Again, in
10497 modern operating systems, more characters may be used.
10498 .endlist
10499 Exim has its own version of &[crypt16()]&, which is just a double call to
10500 &[crypt()]&. For operating systems that have their own version, setting
10501 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10502 operating system version instead of its own. This option is set by default in
10503 the OS-dependent &_Makefile_& for those operating systems that are known to
10504 support &[crypt16()]&.
10505
10506 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10507 it was not using the same algorithm as some operating systems' versions. It
10508 turns out that as well as &[crypt16()]& there is a function called
10509 &[bigcrypt()]& in some operating systems. This may or may not use the same
10510 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10511
10512 However, since there is now a move away from the traditional &[crypt()]&
10513 functions towards using SHA1 and other algorithms, tidying up this area of
10514 Exim is seen as very low priority.
10515
10516 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10517 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10518 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10519 default is &`{crypt}`&. Whatever the default, you can always use either
10520 function by specifying it explicitly in curly brackets.
10521
10522 .vitem &*def:*&<&'variable&~name'&>
10523 .cindex "expansion" "checking for empty variable"
10524 .cindex "&%def%& expansion condition"
10525 The &%def%& condition must be followed by the name of one of the expansion
10526 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10527 variable does not contain the empty string. For example:
10528 .code
10529 ${if def:sender_ident {from $sender_ident}}
10530 .endd
10531 Note that the variable name is given without a leading &%$%& character. If the
10532 variable does not exist, the expansion fails.
10533
10534 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10535         &~&*def:h_*&<&'header&~name'&>&*:*&"
10536 .cindex "expansion" "checking header line existence"
10537 This condition is true if a message is being processed and the named header
10538 exists in the message. For example,
10539 .code
10540 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10541 .endd
10542 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10543 the header name must be terminated by a colon if white space does not follow.
10544
10545 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10546        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10547 .cindex "string" "comparison"
10548 .cindex "expansion" "string comparison"
10549 .cindex "&%eq%& expansion condition"
10550 .cindex "&%eqi%& expansion condition"
10551 The two substrings are first expanded. The condition is true if the two
10552 resulting strings are identical. For &%eq%& the comparison includes the case of
10553 letters, whereas for &%eqi%& the comparison is case-independent.
10554
10555 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10556 .cindex "expansion" "file existence test"
10557 .cindex "file" "existence test"
10558 .cindex "&%exists%&, expansion condition"
10559 The substring is first expanded and then interpreted as an absolute path. The
10560 condition is true if the named file (or directory) exists. The existence test
10561 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10562 users' filter files may be locked out by the system administrator.
10563
10564 .vitem &*first_delivery*&
10565 .cindex "delivery" "first"
10566 .cindex "first delivery"
10567 .cindex "expansion" "first delivery test"
10568 .cindex "&%first_delivery%& expansion condition"
10569 This condition, which has no data, is true during a message's first delivery
10570 attempt. It is false during any subsequent delivery attempts.
10571
10572
10573 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10574        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10575 .cindex "list" "iterative conditions"
10576 .cindex "expansion" "&*forall*& condition"
10577 .cindex "expansion" "&*forany*& condition"
10578 .vindex "&$item$&"
10579 These conditions iterate over a list. The first argument is expanded to form
10580 the list. By default, the list separator is a colon, but it can be changed by
10581 the normal method. The second argument is interpreted as a condition that is to
10582 be applied to each item in the list in turn. During the interpretation of the
10583 condition, the current list item is placed in a variable called &$item$&.
10584 .ilist
10585 For &*forany*&, interpretation stops if the condition is true for any item, and
10586 the result of the whole condition is true. If the condition is false for all
10587 items in the list, the overall condition is false.
10588 .next
10589 For &*forall*&, interpretation stops if the condition is false for any item,
10590 and the result of the whole condition is false. If the condition is true for
10591 all items in the list, the overall condition is true.
10592 .endlist
10593 Note that negation of &*forany*& means that the condition must be false for all
10594 items for the overall condition to succeed, and negation of &*forall*& means
10595 that the condition must be false for at least one item. In this example, the
10596 list separator is changed to a comma:
10597 .code
10598 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10599 .endd
10600 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10601 being processed, to enable these expansion items to be nested.
10602
10603 To scan a named list, expand it with the &*listnamed*& operator.
10604
10605
10606 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10607        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10608 .cindex "string" "comparison"
10609 .cindex "expansion" "string comparison"
10610 .cindex "&%ge%& expansion condition"
10611 .cindex "&%gei%& expansion condition"
10612 The two substrings are first expanded. The condition is true if the first
10613 string is lexically greater than or equal to the second string. For &%ge%& the
10614 comparison includes the case of letters, whereas for &%gei%& the comparison is
10615 case-independent.
10616
10617 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10618        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10619 .cindex "string" "comparison"
10620 .cindex "expansion" "string comparison"
10621 .cindex "&%gt%& expansion condition"
10622 .cindex "&%gti%& expansion condition"
10623 The two substrings are first expanded. The condition is true if the first
10624 string is lexically greater than the second string. For &%gt%& the comparison
10625 includes the case of letters, whereas for &%gti%& the comparison is
10626 case-independent.
10627
10628 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10629        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10630 .cindex "string" "comparison"
10631 .cindex "list" "iterative conditions"
10632 Both strings are expanded; the second string is treated as a list of simple
10633 strings; if the first string is a member of the second, then the condition
10634 is true.
10635
10636 These are simpler to use versions of the more powerful &*forany*& condition.
10637 Examples, and the &*forany*& equivalents:
10638 .code
10639 ${if inlist{needle}{foo:needle:bar}}
10640   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10641 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10642   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10643 .endd
10644
10645 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10646        &*isip4&~{*&<&'string'&>&*}*& &&&
10647        &*isip6&~{*&<&'string'&>&*}*&
10648 .cindex "IP address" "testing string format"
10649 .cindex "string" "testing for IP address"
10650 .cindex "&%isip%& expansion condition"
10651 .cindex "&%isip4%& expansion condition"
10652 .cindex "&%isip6%& expansion condition"
10653 The substring is first expanded, and then tested to see if it has the form of
10654 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10655 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10656
10657 For an IPv4 address, the test is for four dot-separated components, each of
10658 which consists of from one to three digits. For an IPv6 address, up to eight
10659 colon-separated components are permitted, each containing from one to four
10660 hexadecimal digits. There may be fewer than eight components if an empty
10661 component (adjacent colons) is present. Only one empty component is permitted.
10662
10663 &*Note*&: The checks are just on the form of the address; actual numerical
10664 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10665 check. The main use of these tests is to distinguish between IP addresses and
10666 host names, or between IPv4 and IPv6 addresses. For example, you could use
10667 .code
10668 ${if isip4{$sender_host_address}...
10669 .endd
10670 to test which IP version an incoming SMTP connection is using.
10671
10672 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10673 .cindex "LDAP" "use for authentication"
10674 .cindex "expansion" "LDAP authentication test"
10675 .cindex "&%ldapauth%& expansion condition"
10676 This condition supports user authentication using LDAP. See section
10677 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10678 queries. For this use, the query must contain a user name and password. The
10679 query itself is not used, and can be empty. The condition is true if the
10680 password is not empty, and the user name and password are accepted by the LDAP
10681 server. An empty password is rejected without calling LDAP because LDAP binds
10682 with an empty password are considered anonymous regardless of the username, and
10683 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10684 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10685 this can be used.
10686
10687
10688 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10689        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10690 .cindex "string" "comparison"
10691 .cindex "expansion" "string comparison"
10692 .cindex "&%le%& expansion condition"
10693 .cindex "&%lei%& expansion condition"
10694 The two substrings are first expanded. The condition is true if the first
10695 string is lexically less than or equal to the second string. For &%le%& the
10696 comparison includes the case of letters, whereas for &%lei%& the comparison is
10697 case-independent.
10698
10699 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10700        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10701 .cindex "string" "comparison"
10702 .cindex "expansion" "string comparison"
10703 .cindex "&%lt%& expansion condition"
10704 .cindex "&%lti%& expansion condition"
10705 The two substrings are first expanded. The condition is true if the first
10706 string is lexically less than the second string. For &%lt%& the comparison
10707 includes the case of letters, whereas for &%lti%& the comparison is
10708 case-independent.
10709
10710
10711 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10712 .cindex "expansion" "regular expression comparison"
10713 .cindex "regular expressions" "match in expanded string"
10714 .cindex "&%match%& expansion condition"
10715 The two substrings are first expanded. The second is then treated as a regular
10716 expression and applied to the first. Because of the pre-expansion, if the
10717 regular expression contains dollar, or backslash characters, they must be
10718 escaped. Care must also be taken if the regular expression contains braces
10719 (curly brackets). A closing brace must be escaped so that it is not taken as a
10720 premature termination of <&'string2'&>. The easiest approach is to use the
10721 &`\N`& feature to disable expansion of the regular expression.
10722 For example,
10723 .code
10724 ${if match {$local_part}{\N^\d{3}\N} ...
10725 .endd
10726 If the whole expansion string is in double quotes, further escaping of
10727 backslashes is also required.
10728
10729 The condition is true if the regular expression match succeeds.
10730 The regular expression is not required to begin with a circumflex
10731 metacharacter, but if there is no circumflex, the expression is not anchored,
10732 and it may match anywhere in the subject, not just at the start. If you want
10733 the pattern to match at the end of the subject, you must include the &`$`&
10734 metacharacter at an appropriate point.
10735
10736 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10737 At the start of an &%if%& expansion the values of the numeric variable
10738 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10739 succeeds causes them to be reset to the substrings of that condition and they
10740 will have these values during the expansion of the success string. At the end
10741 of the &%if%& expansion, the previous values are restored. After testing a
10742 combination of conditions using &%or%&, the subsequent values of the numeric
10743 variables are those of the condition that succeeded.
10744
10745 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10746 .cindex "&%match_address%& expansion condition"
10747 See &*match_local_part*&.
10748
10749 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10750 .cindex "&%match_domain%& expansion condition"
10751 See &*match_local_part*&.
10752
10753 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10754 .cindex "&%match_ip%& expansion condition"
10755 This condition matches an IP address to a list of IP address patterns. It must
10756 be followed by two argument strings. The first (after expansion) must be an IP
10757 address or an empty string. The second (not expanded) is a restricted host
10758 list that can match only an IP address, not a host name. For example:
10759 .code
10760 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10761 .endd
10762 The specific types of host list item that are permitted in the list are:
10763
10764 .ilist
10765 An IP address, optionally with a CIDR mask.
10766 .next
10767 A single asterisk, which matches any IP address.
10768 .next
10769 An empty item, which matches only if the IP address is empty. This could be
10770 useful for testing for a locally submitted message or one from specific hosts
10771 in a single test such as
10772 . ==== As this is a nested list, any displays it contains must be indented
10773 . ==== as otherwise they are too far to the left. This comment applies to
10774 . ==== the use of xmlto plus fop. There's no problem when formatting with
10775 . ==== sdop, with or without the extra indent.
10776 .code
10777   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10778 .endd
10779 where the first item in the list is the empty string.
10780 .next
10781 The item @[] matches any of the local host's interface addresses.
10782 .next
10783 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10784 even if &`net-`& is not specified. There is never any attempt to turn the IP
10785 address into a host name. The most common type of linear search for
10786 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10787 masks. For example:
10788 .code
10789   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10790 .endd
10791 It is of course possible to use other kinds of lookup, and in such a case, you
10792 do need to specify the &`net-`& prefix if you want to specify a specific
10793 address mask, for example:
10794 .code
10795   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10796 .endd
10797 However, unless you are combining a &%match_ip%& condition with others, it is
10798 just as easy to use the fact that a lookup is itself a condition, and write:
10799 .code
10800   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10801 .endd
10802 .endlist ilist
10803
10804 Note that <&'string2'&> is not itself subject to string expansion, unless
10805 Exim was built with the EXPAND_LISTMATCH_RHS option.
10806
10807 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10808
10809 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10810 .cindex "domain list" "in expansion condition"
10811 .cindex "address list" "in expansion condition"
10812 .cindex "local part" "list, in expansion condition"
10813 .cindex "&%match_local_part%& expansion condition"
10814 This condition, together with &%match_address%& and &%match_domain%&, make it
10815 possible to test domain, address, and local part lists within expansions. Each
10816 condition requires two arguments: an item and a list to match. A trivial
10817 example is:
10818 .code
10819 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10820 .endd
10821 In each case, the second argument may contain any of the allowable items for a
10822 list of the appropriate type. Also, because the second argument (after
10823 expansion) is a standard form of list, it is possible to refer to a named list.
10824 Thus, you can use conditions like this:
10825 .code
10826 ${if match_domain{$domain}{+local_domains}{...
10827 .endd
10828 .cindex "&`+caseful`&"
10829 For address lists, the matching starts off caselessly, but the &`+caseful`&
10830 item can be used, as in all address lists, to cause subsequent items to
10831 have their local parts matched casefully. Domains are always matched
10832 caselessly.
10833
10834 Note that <&'string2'&> is not itself subject to string expansion, unless
10835 Exim was built with the EXPAND_LISTMATCH_RHS option.
10836
10837 &*Note*&: Host lists are &'not'& supported in this way. This is because
10838 hosts have two identities: a name and an IP address, and it is not clear
10839 how to specify cleanly how such a test would work. However, IP addresses can be
10840 matched using &%match_ip%&.
10841
10842 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10843 .cindex "PAM authentication"
10844 .cindex "AUTH" "with PAM"
10845 .cindex "Solaris" "PAM support"
10846 .cindex "expansion" "PAM authentication test"
10847 .cindex "&%pam%& expansion condition"
10848 &'Pluggable Authentication Modules'&
10849 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10850 available in the latest releases of Solaris and in some GNU/Linux
10851 distributions. The Exim support, which is intended for use in conjunction with
10852 the SMTP AUTH command, is available only if Exim is compiled with
10853 .code
10854 SUPPORT_PAM=yes
10855 .endd
10856 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10857 in some releases of GNU/Linux &%-ldl%& is also needed.
10858
10859 The argument string is first expanded, and the result must be a
10860 colon-separated list of strings. Leading and trailing white space is ignored.
10861 The PAM module is initialized with the service name &"exim"& and the user name
10862 taken from the first item in the colon-separated data string (<&'string1'&>).
10863 The remaining items in the data string are passed over in response to requests
10864 from the authentication function. In the simple case there will only be one
10865 request, for a password, so the data consists of just two strings.
10866
10867 There can be problems if any of the strings are permitted to contain colon
10868 characters. In the usual way, these have to be doubled to avoid being taken as
10869 separators. If the data is being inserted from a variable, the &%sg%& expansion
10870 item can be used to double any existing colons. For example, the configuration
10871 of a LOGIN authenticator might contain this setting:
10872 .code
10873 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10874 .endd
10875 For a PLAIN authenticator you could use:
10876 .code
10877 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10878 .endd
10879 In some operating systems, PAM authentication can be done only from a process
10880 running as root. Since Exim is running as the Exim user when receiving
10881 messages, this means that PAM cannot be used directly in those systems.
10882 A patched version of the &'pam_unix'& module that comes with the
10883 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10884 The patched module allows one special uid/gid combination, in addition to root,
10885 to authenticate. If you build the patched module to allow the Exim user and
10886 group, PAM can then be used from an Exim authenticator.
10887
10888
10889 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10890 .cindex "&'pwcheck'& daemon"
10891 .cindex "Cyrus"
10892 .cindex "expansion" "&'pwcheck'& authentication test"
10893 .cindex "&%pwcheck%& expansion condition"
10894 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10895 This is one way of making it possible for passwords to be checked by a process
10896 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10897 deprecated. Its replacement is &'saslauthd'& (see below).
10898
10899 The pwcheck support is not included in Exim by default. You need to specify
10900 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10901 building Exim. For example:
10902 .code
10903 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10904 .endd
10905 You do not need to install the full Cyrus software suite in order to use
10906 the pwcheck daemon. You can compile and install just the daemon alone
10907 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10908 access to the &_/var/pwcheck_& directory.
10909
10910 The &%pwcheck%& condition takes one argument, which must be the user name and
10911 password, separated by a colon. For example, in a LOGIN authenticator
10912 configuration, you might have this:
10913 .code
10914 server_condition = ${if pwcheck{$auth1:$auth2}}
10915 .endd
10916 Again, for a PLAIN authenticator configuration, this would be:
10917 .code
10918 server_condition = ${if pwcheck{$auth2:$auth3}}
10919 .endd
10920 .vitem &*queue_running*&
10921 .cindex "queue runner" "detecting when delivering from"
10922 .cindex "expansion" "queue runner test"
10923 .cindex "&%queue_running%& expansion condition"
10924 This condition, which has no data, is true during delivery attempts that are
10925 initiated by queue runner processes, and false otherwise.
10926
10927
10928 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10929 .cindex "Radius"
10930 .cindex "expansion" "Radius authentication"
10931 .cindex "&%radius%& expansion condition"
10932 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10933 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10934 the Radius client configuration file in order to build Exim with Radius
10935 support.
10936
10937 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10938 library, using the original API. If you are using release 0.4.0 or later of
10939 this library, you need to set
10940 .code
10941 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10942 .endd
10943 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10944 &%libradius%& library that comes with FreeBSD. To do this, set
10945 .code
10946 RADIUS_LIB_TYPE=RADLIB
10947 .endd
10948 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10949 You may also have to supply a suitable setting in EXTRALIBS so that the
10950 Radius library can be found when Exim is linked.
10951
10952 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10953 Radius client library, which calls the Radius server. The condition is true if
10954 the authentication is successful. For example:
10955 .code
10956 server_condition = ${if radius{<arguments>}}
10957 .endd
10958
10959
10960 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10961         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10962 .cindex "&'saslauthd'& daemon"
10963 .cindex "Cyrus"
10964 .cindex "expansion" "&'saslauthd'& authentication test"
10965 .cindex "&%saslauthd%& expansion condition"
10966 This condition supports user authentication using the Cyrus &'saslauthd'&
10967 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10968 Using this daemon is one way of making it possible for passwords to be checked
10969 by a process that is not running as root.
10970
10971 The saslauthd support is not included in Exim by default. You need to specify
10972 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10973 building Exim. For example:
10974 .code
10975 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10976 .endd
10977 You do not need to install the full Cyrus software suite in order to use
10978 the saslauthd daemon. You can compile and install just the daemon alone
10979 from the Cyrus SASL library.
10980
10981 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10982 two are mandatory. For example:
10983 .code
10984 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10985 .endd
10986 The service and the realm are optional (which is why the arguments are enclosed
10987 in their own set of braces). For details of the meaning of the service and
10988 realm, and how to run the daemon, consult the Cyrus documentation.
10989 .endlist vlist
10990
10991
10992
10993 .section "Combining expansion conditions" "SECID84"
10994 .cindex "expansion" "combining conditions"
10995 Several conditions can be tested at once by combining them using the &%and%&
10996 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10997 conditions on their own, and precede their lists of sub-conditions. Each
10998 sub-condition must be enclosed in braces within the overall braces that contain
10999 the list. No repetition of &%if%& is used.
11000
11001
11002 .vlist
11003 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11004 .cindex "&""or""& expansion condition"
11005 .cindex "expansion" "&""or""& of conditions"
11006 The sub-conditions are evaluated from left to right. The condition is true if
11007 any one of the sub-conditions is true.
11008 For example,
11009 .code
11010 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11011 .endd
11012 When a true sub-condition is found, the following ones are parsed but not
11013 evaluated. If there are several &"match"& sub-conditions the values of the
11014 numeric variables afterwards are taken from the first one that succeeds.
11015
11016 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11017 .cindex "&""and""& expansion condition"
11018 .cindex "expansion" "&""and""& of conditions"
11019 The sub-conditions are evaluated from left to right. The condition is true if
11020 all of the sub-conditions are true. If there are several &"match"&
11021 sub-conditions, the values of the numeric variables afterwards are taken from
11022 the last one. When a false sub-condition is found, the following ones are
11023 parsed but not evaluated.
11024 .endlist
11025 .ecindex IIDexpcond
11026
11027
11028
11029
11030 .section "Expansion variables" "SECTexpvar"
11031 .cindex "expansion" "variables, list of"
11032 This section contains an alphabetical list of all the expansion variables. Some
11033 of them are available only when Exim is compiled with specific options such as
11034 support for TLS or the content scanning extension.
11035
11036 .vlist
11037 .vitem "&$0$&, &$1$&, etc"
11038 .cindex "numerical variables (&$1$& &$2$& etc)"
11039 When a &%match%& expansion condition succeeds, these variables contain the
11040 captured substrings identified by the regular expression during subsequent
11041 processing of the success string of the containing &%if%& expansion item.
11042 However, they do not retain their values afterwards; in fact, their previous
11043 values are restored at the end of processing an &%if%& item. The numerical
11044 variables may also be set externally by some other matching process which
11045 precedes the expansion of the string. For example, the commands available in
11046 Exim filter files include an &%if%& command with its own regular expression
11047 matching condition.
11048
11049 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11050 Within an acl condition, expansion condition or expansion item
11051 any arguments are copied to these variables,
11052 any unused variables being made empty.
11053
11054 .vitem "&$acl_c...$&"
11055 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11056 can be given any name that starts with &$acl_c$& and is at least six characters
11057 long, but the sixth character must be either a digit or an underscore. For
11058 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11059 variables persist throughout the lifetime of an SMTP connection. They can be
11060 used to pass information between ACLs and between different invocations of the
11061 same ACL. When a message is received, the values of these variables are saved
11062 with the message, and can be accessed by filters, routers, and transports
11063 during subsequent delivery.
11064
11065 .vitem "&$acl_m...$&"
11066 These variables are like the &$acl_c...$& variables, except that their values
11067 are reset after a message has been received. Thus, if several messages are
11068 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11069 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11070 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11071 message is received, the values of these variables are saved with the message,
11072 and can be accessed by filters, routers, and transports during subsequent
11073 delivery.
11074
11075 .vitem &$acl_narg$&
11076 Within an acl condition, expansion condition or expansion item
11077 this variable has the number of arguments.
11078
11079 .vitem &$acl_verify_message$&
11080 .vindex "&$acl_verify_message$&"
11081 After an address verification has failed, this variable contains the failure
11082 message. It retains its value for use in subsequent modifiers. The message can
11083 be preserved by coding like this:
11084 .code
11085 warn !verify = sender
11086      set acl_m0 = $acl_verify_message
11087 .endd
11088 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11089 &%log_message%& modifiers, to include information about the verification
11090 failure.
11091
11092 .vitem &$address_data$&
11093 .vindex "&$address_data$&"
11094 This variable is set by means of the &%address_data%& option in routers. The
11095 value then remains with the address while it is processed by subsequent routers
11096 and eventually a transport. If the transport is handling multiple addresses,
11097 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11098 for more details. &*Note*&: The contents of &$address_data$& are visible in
11099 user filter files.
11100
11101 If &$address_data$& is set when the routers are called from an ACL to verify
11102 a recipient address, the final value is still in the variable for subsequent
11103 conditions and modifiers of the ACL statement. If routing the address caused it
11104 to be redirected to just one address, the child address is also routed as part
11105 of the verification, and in this case the final value of &$address_data$& is
11106 from the child's routing.
11107
11108 If &$address_data$& is set when the routers are called from an ACL to verify a
11109 sender address, the final value is also preserved, but this time in
11110 &$sender_address_data$&, to distinguish it from data from a recipient
11111 address.
11112
11113 In both cases (recipient and sender verification), the value does not persist
11114 after the end of the current ACL statement. If you want to preserve
11115 these values for longer, you can save them in ACL variables.
11116
11117 .vitem &$address_file$&
11118 .vindex "&$address_file$&"
11119 When, as a result of aliasing, forwarding, or filtering, a message is directed
11120 to a specific file, this variable holds the name of the file when the transport
11121 is running. At other times, the variable is empty. For example, using the
11122 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11123 .code
11124 /home/r2d2/savemail
11125 .endd
11126 then when the &(address_file)& transport is running, &$address_file$&
11127 contains the text string &`/home/r2d2/savemail`&.
11128 .cindex "Sieve filter" "value of &$address_file$&"
11129 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11130 then up to the transport configuration to generate an appropriate absolute path
11131 to the relevant file.
11132
11133 .vitem &$address_pipe$&
11134 .vindex "&$address_pipe$&"
11135 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11136 this variable holds the pipe command when the transport is running.
11137
11138 .vitem "&$auth1$& &-- &$auth3$&"
11139 .vindex "&$auth1$&, &$auth2$&, etc"
11140 These variables are used in SMTP authenticators (see chapters
11141 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11142
11143 .vitem &$authenticated_id$&
11144 .cindex "authentication" "id"
11145 .vindex "&$authenticated_id$&"
11146 When a server successfully authenticates a client it may be configured to
11147 preserve some of the authentication information in the variable
11148 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11149 user/password authenticator configuration might preserve the user name for use
11150 in the routers. Note that this is not the same information that is saved in
11151 &$sender_host_authenticated$&.
11152 When a message is submitted locally (that is, not over a TCP connection)
11153 the value of &$authenticated_id$& is normally the login name of the calling
11154 process. However, a trusted user can override this by means of the &%-oMai%&
11155 command line option.
11156
11157 .vitem &$authenticated_fail_id$&
11158 .cindex "authentication" "fail" "id"
11159 .vindex "&$authenticated_fail_id$&"
11160 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11161 will contain the failed authentication id. If more than one authentication
11162 id is attempted, it will contain only the last one. The variable is
11163 available for processing in the ACL's, generally the quit or notquit ACL.
11164 A message to a local recipient could still be accepted without requiring
11165 authentication, which means this variable could also be visible in all of
11166 the ACL's as well.
11167
11168
11169 .vitem &$authenticated_sender$&
11170 .cindex "sender" "authenticated"
11171 .cindex "authentication" "sender"
11172 .cindex "AUTH" "on MAIL command"
11173 .vindex "&$authenticated_sender$&"
11174 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11175 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11176 described in section &<<SECTauthparamail>>&. Unless the data is the string
11177 &"<>"&, it is set as the authenticated sender of the message, and the value is
11178 available during delivery in the &$authenticated_sender$& variable. If the
11179 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11180
11181 .vindex "&$qualify_domain$&"
11182 When a message is submitted locally (that is, not over a TCP connection), the
11183 value of &$authenticated_sender$& is an address constructed from the login
11184 name of the calling process and &$qualify_domain$&, except that a trusted user
11185 can override this by means of the &%-oMas%& command line option.
11186
11187
11188 .vitem &$authentication_failed$&
11189 .cindex "authentication" "failure"
11190 .vindex "&$authentication_failed$&"
11191 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11192 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11193 possible to distinguish between &"did not try to authenticate"&
11194 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11195 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11196 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11197 negative response to an AUTH command, including (for example) an attempt to use
11198 an undefined mechanism.
11199
11200 .vitem &$av_failed$&
11201 .cindex "content scanning" "AV scanner failure"
11202 This variable is available when Exim is compiled with the content-scanning
11203 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11204 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11205 the ACL malware condition.
11206
11207 .vitem &$body_linecount$&
11208 .cindex "message body" "line count"
11209 .cindex "body of message" "line count"
11210 .vindex "&$body_linecount$&"
11211 When a message is being received or delivered, this variable contains the
11212 number of lines in the message's body. See also &$message_linecount$&.
11213
11214 .vitem &$body_zerocount$&
11215 .cindex "message body" "binary zero count"
11216 .cindex "body of message" "binary zero count"
11217 .cindex "binary zero" "in message body"
11218 .vindex "&$body_zerocount$&"
11219 When a message is being received or delivered, this variable contains the
11220 number of binary zero bytes (ASCII NULs) in the message's body.
11221
11222 .vitem &$bounce_recipient$&
11223 .vindex "&$bounce_recipient$&"
11224 This is set to the recipient address of a bounce message while Exim is creating
11225 it. It is useful if a customized bounce message text file is in use (see
11226 chapter &<<CHAPemsgcust>>&).
11227
11228 .vitem &$bounce_return_size_limit$&
11229 .vindex "&$bounce_return_size_limit$&"
11230 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11231 up to a multiple of 1000. It is useful when a customized error message text
11232 file is in use (see chapter &<<CHAPemsgcust>>&).
11233
11234 .vitem &$caller_gid$&
11235 .cindex "gid (group id)" "caller"
11236 .vindex "&$caller_gid$&"
11237 The real group id under which the process that called Exim was running. This is
11238 not the same as the group id of the originator of a message (see
11239 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11240 incarnation normally contains the Exim gid.
11241
11242 .vitem &$caller_uid$&
11243 .cindex "uid (user id)" "caller"
11244 .vindex "&$caller_uid$&"
11245 The real user id under which the process that called Exim was running. This is
11246 not the same as the user id of the originator of a message (see
11247 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11248 incarnation normally contains the Exim uid.
11249
11250 .vitem &$compile_date$&
11251 .vindex "&$compile_date$&"
11252 The date on which the Exim binary was compiled.
11253
11254 .vitem &$compile_number$&
11255 .vindex "&$compile_number$&"
11256 The building process for Exim keeps a count of the number
11257 of times it has been compiled. This serves to distinguish different
11258 compilations of the same version of the program.
11259
11260 .vitem &$demime_errorlevel$&
11261 .vindex "&$demime_errorlevel$&"
11262 This variable is available when Exim is compiled with
11263 the content-scanning extension and the obsolete &%demime%& condition. For
11264 details, see section &<<SECTdemimecond>>&.
11265
11266 .vitem &$demime_reason$&
11267 .vindex "&$demime_reason$&"
11268 This variable is available when Exim is compiled with the
11269 content-scanning extension and the obsolete &%demime%& condition. For details,
11270 see section &<<SECTdemimecond>>&.
11271
11272 .vitem &$dnslist_domain$& &&&
11273        &$dnslist_matched$& &&&
11274        &$dnslist_text$& &&&
11275        &$dnslist_value$&
11276 .vindex "&$dnslist_domain$&"
11277 .vindex "&$dnslist_matched$&"
11278 .vindex "&$dnslist_text$&"
11279 .vindex "&$dnslist_value$&"
11280 .cindex "black list (DNS)"
11281 When a DNS (black) list lookup succeeds, these variables are set to contain
11282 the following data from the lookup: the list's domain name, the key that was
11283 looked up, the contents of any associated TXT record, and the value from the
11284 main A record. See section &<<SECID204>>& for more details.
11285
11286 .vitem &$domain$&
11287 .vindex "&$domain$&"
11288 When an address is being routed, or delivered on its own, this variable
11289 contains the domain. Uppercase letters in the domain are converted into lower
11290 case for &$domain$&.
11291
11292 Global address rewriting happens when a message is received, so the value of
11293 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11294 is set during user filtering, but not during system filtering, because a
11295 message may have many recipients and the system filter is called just once.
11296
11297 When more than one address is being delivered at once (for example, several
11298 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11299 have the same domain. Transports can be restricted to handling only one domain
11300 at a time if the value of &$domain$& is required at transport time &-- this is
11301 the default for local transports. For further details of the environment in
11302 which local transports are run, see chapter &<<CHAPenvironment>>&.
11303
11304 .oindex "&%delay_warning_condition%&"
11305 At the end of a delivery, if all deferred addresses have the same domain, it is
11306 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11307
11308 The &$domain$& variable is also used in some other circumstances:
11309
11310 .ilist
11311 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11312 the recipient address. The domain of the &'sender'& address is in
11313 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11314 normally set during the running of the MAIL ACL. However, if the sender address
11315 is verified with a callout during the MAIL ACL, the sender domain is placed in
11316 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11317 the &(smtp)& transport.
11318
11319 .next
11320 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11321 &$domain$& contains the domain portion of the address that is being rewritten;
11322 it can be used in the expansion of the replacement address, for example, to
11323 rewrite domains by file lookup.
11324
11325 .next
11326 With one important exception, whenever a domain list is being scanned,
11327 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11328 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11329 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11330 that, in a RCPT ACL, the sender domain list can be dependent on the
11331 recipient domain (which is what is in &$domain$& at this time).
11332
11333 .next
11334 .cindex "ETRN" "value of &$domain$&"
11335 .oindex "&%smtp_etrn_command%&"
11336 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11337 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11338 .endlist
11339
11340
11341 .vitem &$domain_data$&
11342 .vindex "&$domain_data$&"
11343 When the &%domains%& option on a router matches a domain by
11344 means of a lookup, the data read by the lookup is available during the running
11345 of the router as &$domain_data$&. In addition, if the driver routes the
11346 address to a transport, the value is available in that transport. If the
11347 transport is handling multiple addresses, the value from the first address is
11348 used.
11349
11350 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11351 domain by means of a lookup. The data read by the lookup is available during
11352 the rest of the ACL statement. In all other situations, this variable expands
11353 to nothing.
11354
11355 .vitem &$exim_gid$&
11356 .vindex "&$exim_gid$&"
11357 This variable contains the numerical value of the Exim group id.
11358
11359 .vitem &$exim_path$&
11360 .vindex "&$exim_path$&"
11361 This variable contains the path to the Exim binary.
11362
11363 .vitem &$exim_uid$&
11364 .vindex "&$exim_uid$&"
11365 This variable contains the numerical value of the Exim user id.
11366
11367 .vitem &$found_extension$&
11368 .vindex "&$found_extension$&"
11369 This variable is available when Exim is compiled with the
11370 content-scanning extension and the obsolete &%demime%& condition. For details,
11371 see section &<<SECTdemimecond>>&.
11372
11373 .vitem &$header_$&<&'name'&>
11374 This is not strictly an expansion variable. It is expansion syntax for
11375 inserting the message header line with the given name. Note that the name must
11376 be terminated by colon or white space, because it may contain a wide variety of
11377 characters. Note also that braces must &'not'& be used.
11378
11379 .vitem &$headers_added$&
11380 .vindex "&$headers_added$&"
11381 Within an ACL this variable contains the headers added so far by
11382 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11383 The headers are a newline-separated list.
11384
11385 .vitem &$home$&
11386 .vindex "&$home$&"
11387 When the &%check_local_user%& option is set for a router, the user's home
11388 directory is placed in &$home$& when the check succeeds. In particular, this
11389 means it is set during the running of users' filter files. A router may also
11390 explicitly set a home directory for use by a transport; this can be overridden
11391 by a setting on the transport itself.
11392
11393 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11394 of the environment variable HOME.
11395
11396 .vitem &$host$&
11397 .vindex "&$host$&"
11398 If a router assigns an address to a transport (any transport), and passes a
11399 list of hosts with the address, the value of &$host$& when the transport starts
11400 to run is the name of the first host on the list. Note that this applies both
11401 to local and remote transports.
11402
11403 .cindex "transport" "filter"
11404 .cindex "filter" "transport filter"
11405 For the &(smtp)& transport, if there is more than one host, the value of
11406 &$host$& changes as the transport works its way through the list. In
11407 particular, when the &(smtp)& transport is expanding its options for encryption
11408 using TLS, or for specifying a transport filter (see chapter
11409 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11410 is connected.
11411
11412 When used in the client part of an authenticator configuration (see chapter
11413 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11414 client is connected.
11415
11416
11417 .vitem &$host_address$&
11418 .vindex "&$host_address$&"
11419 This variable is set to the remote host's IP address whenever &$host$& is set
11420 for a remote connection. It is also set to the IP address that is being checked
11421 when the &%ignore_target_hosts%& option is being processed.
11422
11423 .vitem &$host_data$&
11424 .vindex "&$host_data$&"
11425 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11426 result of the lookup is made available in the &$host_data$& variable. This
11427 allows you, for example, to do things like this:
11428 .code
11429 deny  hosts = net-lsearch;/some/file
11430 message = $host_data
11431 .endd
11432 .vitem &$host_lookup_deferred$&
11433 .cindex "host name" "lookup, failure of"
11434 .vindex "&$host_lookup_deferred$&"
11435 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11436 message comes from a remote host and there is an attempt to look up the host's
11437 name from its IP address, and the attempt is not successful, one of these
11438 variables is set to &"1"&.
11439
11440 .ilist
11441 If the lookup receives a definite negative response (for example, a DNS lookup
11442 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11443
11444 .next
11445 If there is any kind of problem during the lookup, such that Exim cannot
11446 tell whether or not the host name is defined (for example, a timeout for a DNS
11447 lookup), &$host_lookup_deferred$& is set to &"1"&.
11448 .endlist ilist
11449
11450 Looking up a host's name from its IP address consists of more than just a
11451 single reverse lookup. Exim checks that a forward lookup of at least one of the
11452 names it receives from a reverse lookup yields the original IP address. If this
11453 is not the case, Exim does not accept the looked up name(s), and
11454 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11455 IP address (for example, the existence of a PTR record in the DNS) is not
11456 sufficient on its own for the success of a host name lookup. If the reverse
11457 lookup succeeds, but there is a lookup problem such as a timeout when checking
11458 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11459 &"1"&. See also &$sender_host_name$&.
11460
11461 .vitem &$host_lookup_failed$&
11462 .vindex "&$host_lookup_failed$&"
11463 See &$host_lookup_deferred$&.
11464
11465 .vitem &$host_port$&
11466 .vindex "&$host_port$&"
11467 This variable is set to the remote host's TCP port whenever &$host$& is set
11468 for an outbound connection.
11469
11470
11471 .vitem &$inode$&
11472 .vindex "&$inode$&"
11473 The only time this variable is set is while expanding the &%directory_file%&
11474 option in the &(appendfile)& transport. The variable contains the inode number
11475 of the temporary file which is about to be renamed. It can be used to construct
11476 a unique name for the file.
11477
11478 .vitem &$interface_address$&
11479 .vindex "&$interface_address$&"
11480 This is an obsolete name for &$received_ip_address$&.
11481
11482 .vitem &$interface_port$&
11483 .vindex "&$interface_port$&"
11484 This is an obsolete name for &$received_port$&.
11485
11486 .vitem &$item$&
11487 .vindex "&$item$&"
11488 This variable is used during the expansion of &*forall*& and &*forany*&
11489 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11490 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11491 empty.
11492
11493 .vitem &$ldap_dn$&
11494 .vindex "&$ldap_dn$&"
11495 This variable, which is available only when Exim is compiled with LDAP support,
11496 contains the DN from the last entry in the most recently successful LDAP
11497 lookup.
11498
11499 .vitem &$load_average$&
11500 .vindex "&$load_average$&"
11501 This variable contains the system load average, multiplied by 1000 so that it
11502 is an integer. For example, if the load average is 0.21, the value of the
11503 variable is 210. The value is recomputed every time the variable is referenced.
11504
11505 .vitem &$local_part$&
11506 .vindex "&$local_part$&"
11507 When an address is being routed, or delivered on its own, this
11508 variable contains the local part. When a number of addresses are being
11509 delivered together (for example, multiple RCPT commands in an SMTP
11510 session), &$local_part$& is not set.
11511
11512 Global address rewriting happens when a message is received, so the value of
11513 &$local_part$& during routing and delivery is the value after rewriting.
11514 &$local_part$& is set during user filtering, but not during system filtering,
11515 because a message may have many recipients and the system filter is called just
11516 once.
11517
11518 .vindex "&$local_part_prefix$&"
11519 .vindex "&$local_part_suffix$&"
11520 If a local part prefix or suffix has been recognized, it is not included in the
11521 value of &$local_part$& during routing and subsequent delivery. The values of
11522 any prefix or suffix are in &$local_part_prefix$& and
11523 &$local_part_suffix$&, respectively.
11524
11525 When a message is being delivered to a file, pipe, or autoreply transport as a
11526 result of aliasing or forwarding, &$local_part$& is set to the local part of
11527 the parent address, not to the file name or command (see &$address_file$& and
11528 &$address_pipe$&).
11529
11530 When an ACL is running for a RCPT command, &$local_part$& contains the
11531 local part of the recipient address.
11532
11533 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11534 &$local_part$& contains the local part of the address that is being rewritten;
11535 it can be used in the expansion of the replacement address, for example.
11536
11537 In all cases, all quoting is removed from the local part. For example, for both
11538 the addresses
11539 .code
11540 "abc:xyz"@test.example
11541 abc\:xyz@test.example
11542 .endd
11543 the value of &$local_part$& is
11544 .code
11545 abc:xyz
11546 .endd
11547 If you use &$local_part$& to create another address, you should always wrap it
11548 inside a quoting operator. For example, in a &(redirect)& router you could
11549 have:
11550 .code
11551 data = ${quote_local_part:$local_part}@new.domain.example
11552 .endd
11553 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11554 to process local parts in a case-dependent manner in a router, you can set the
11555 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11556
11557 .vitem &$local_part_data$&
11558 .vindex "&$local_part_data$&"
11559 When the &%local_parts%& option on a router matches a local part by means of a
11560 lookup, the data read by the lookup is available during the running of the
11561 router as &$local_part_data$&. In addition, if the driver routes the address
11562 to a transport, the value is available in that transport. If the transport is
11563 handling multiple addresses, the value from the first address is used.
11564
11565 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11566 matches a local part by means of a lookup. The data read by the lookup is
11567 available during the rest of the ACL statement. In all other situations, this
11568 variable expands to nothing.
11569
11570 .vitem &$local_part_prefix$&
11571 .vindex "&$local_part_prefix$&"
11572 When an address is being routed or delivered, and a
11573 specific prefix for the local part was recognized, it is available in this
11574 variable, having been removed from &$local_part$&.
11575
11576 .vitem &$local_part_suffix$&
11577 .vindex "&$local_part_suffix$&"
11578 When an address is being routed or delivered, and a
11579 specific suffix for the local part was recognized, it is available in this
11580 variable, having been removed from &$local_part$&.
11581
11582 .vitem &$local_scan_data$&
11583 .vindex "&$local_scan_data$&"
11584 This variable contains the text returned by the &[local_scan()]& function when
11585 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11586
11587 .vitem &$local_user_gid$&
11588 .vindex "&$local_user_gid$&"
11589 See &$local_user_uid$&.
11590
11591 .vitem &$local_user_uid$&
11592 .vindex "&$local_user_uid$&"
11593 This variable and &$local_user_gid$& are set to the uid and gid after the
11594 &%check_local_user%& router precondition succeeds. This means that their values
11595 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11596 and &%condition%&), for the &%address_data%& expansion, and for any
11597 router-specific expansions. At all other times, the values in these variables
11598 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11599
11600 .vitem &$localhost_number$&
11601 .vindex "&$localhost_number$&"
11602 This contains the expanded value of the
11603 &%localhost_number%& option. The expansion happens after the main options have
11604 been read.
11605
11606 .vitem &$log_inodes$&
11607 .vindex "&$log_inodes$&"
11608 The number of free inodes in the disk partition where Exim's
11609 log files are being written. The value is recalculated whenever the variable is
11610 referenced. If the relevant file system does not have the concept of inodes,
11611 the value of is -1. See also the &%check_log_inodes%& option.
11612
11613 .vitem &$log_space$&
11614 .vindex "&$log_space$&"
11615 The amount of free space (as a number of kilobytes) in the disk
11616 partition where Exim's log files are being written. The value is recalculated
11617 whenever the variable is referenced. If the operating system does not have the
11618 ability to find the amount of free space (only true for experimental systems),
11619 the space value is -1. See also the &%check_log_space%& option.
11620
11621
11622 .vitem &$lookup_dnssec_authenticated$&
11623 .vindex "&$lookup_dnssec_authenticated$&"
11624 This variable is set after a DNS lookup done by
11625 a dnsdb lookup expansion, dnslookup router or smtp transport.
11626 It will be empty if &(DNSSEC)& was not requested,
11627 &"no"& if the result was not labelled as authenticated data
11628 and &"yes"& if it was.
11629
11630 .vitem &$mailstore_basename$&
11631 .vindex "&$mailstore_basename$&"
11632 This variable is set only when doing deliveries in &"mailstore"& format in the
11633 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11634 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11635 contains the basename of the files that are being written, that is, the name
11636 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11637 variable is empty.
11638
11639 .vitem &$malware_name$&
11640 .vindex "&$malware_name$&"
11641 This variable is available when Exim is compiled with the
11642 content-scanning extension. It is set to the name of the virus that was found
11643 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11644
11645 .vitem &$max_received_linelength$&
11646 .vindex "&$max_received_linelength$&"
11647 .cindex "maximum" "line length"
11648 .cindex "line length" "maximum"
11649 This variable contains the number of bytes in the longest line that was
11650 received as part of the message, not counting the line termination
11651 character(s).
11652
11653 .vitem &$message_age$&
11654 .cindex "message" "age of"
11655 .vindex "&$message_age$&"
11656 This variable is set at the start of a delivery attempt to contain the number
11657 of seconds since the message was received. It does not change during a single
11658 delivery attempt.
11659
11660 .vitem &$message_body$&
11661 .cindex "body of message" "expansion variable"
11662 .cindex "message body" "in expansion"
11663 .cindex "binary zero" "in message body"
11664 .vindex "&$message_body$&"
11665 .oindex "&%message_body_visible%&"
11666 This variable contains the initial portion of a message's body while it is
11667 being delivered, and is intended mainly for use in filter files. The maximum
11668 number of characters of the body that are put into the variable is set by the
11669 &%message_body_visible%& configuration option; the default is 500.
11670
11671 .oindex "&%message_body_newlines%&"
11672 By default, newlines are converted into spaces in &$message_body$&, to make it
11673 easier to search for phrases that might be split over a line break. However,
11674 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11675 zeros are always converted into spaces.
11676
11677 .vitem &$message_body_end$&
11678 .cindex "body of message" "expansion variable"
11679 .cindex "message body" "in expansion"
11680 .vindex "&$message_body_end$&"
11681 This variable contains the final portion of a message's
11682 body while it is being delivered. The format and maximum size are as for
11683 &$message_body$&.
11684
11685 .vitem &$message_body_size$&
11686 .cindex "body of message" "size"
11687 .cindex "message body" "size"
11688 .vindex "&$message_body_size$&"
11689 When a message is being delivered, this variable contains the size of the body
11690 in bytes. The count starts from the character after the blank line that
11691 separates the body from the header. Newlines are included in the count. See
11692 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11693
11694 .vitem &$message_exim_id$&
11695 .vindex "&$message_exim_id$&"
11696 When a message is being received or delivered, this variable contains the
11697 unique message id that is generated and used by Exim to identify the message.
11698 An id is not created for a message until after its header has been successfully
11699 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11700 line; it is the local id that Exim assigns to the message, for example:
11701 &`1BXTIK-0001yO-VA`&.
11702
11703 .vitem &$message_headers$&
11704 .vindex &$message_headers$&
11705 This variable contains a concatenation of all the header lines when a message
11706 is being processed, except for lines added by routers or transports. The header
11707 lines are separated by newline characters. Their contents are decoded in the
11708 same way as a header line that is inserted by &%bheader%&.
11709
11710 .vitem &$message_headers_raw$&
11711 .vindex &$message_headers_raw$&
11712 This variable is like &$message_headers$& except that no processing of the
11713 contents of header lines is done.
11714
11715 .vitem &$message_id$&
11716 This is an old name for &$message_exim_id$&. It is now deprecated.
11717
11718 .vitem &$message_linecount$&
11719 .vindex "&$message_linecount$&"
11720 This variable contains the total number of lines in the header and body of the
11721 message. Compare &$body_linecount$&, which is the count for the body only.
11722 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11723 number of lines received. Before delivery happens (that is, before filters,
11724 routers, and transports run) the count is increased to include the
11725 &'Received:'& header line that Exim standardly adds, and also any other header
11726 lines that are added by ACLs. The blank line that separates the message header
11727 from the body is not counted.
11728
11729 As with the special case of &$message_size$&, during the expansion of the
11730 appendfile transport's maildir_tag option in maildir format, the value of
11731 &$message_linecount$& is the precise size of the number of newlines in the
11732 file that has been written (minus one for the blank line between the
11733 header and the body).
11734
11735 Here is an example of the use of this variable in a DATA ACL:
11736 .code
11737 deny message   = Too many lines in message header
11738      condition = \
11739       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11740 .endd
11741 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11742 message has not yet been received.
11743
11744 .vitem &$message_size$&
11745 .cindex "size" "of message"
11746 .cindex "message" "size"
11747 .vindex "&$message_size$&"
11748 When a message is being processed, this variable contains its size in bytes. In
11749 most cases, the size includes those headers that were received with the
11750 message, but not those (such as &'Envelope-to:'&) that are added to individual
11751 deliveries as they are written. However, there is one special case: during the
11752 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11753 doing a delivery in maildir format, the value of &$message_size$& is the
11754 precise size of the file that has been written. See also
11755 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11756
11757 .cindex "RCPT" "value of &$message_size$&"
11758 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11759 contains the size supplied on the MAIL command, or -1 if no size was given. The
11760 value may not, of course, be truthful.
11761
11762 .vitem &$mime_$&&'xxx'&
11763 A number of variables whose names start with &$mime$& are
11764 available when Exim is compiled with the content-scanning extension. For
11765 details, see section &<<SECTscanmimepart>>&.
11766
11767 .vitem "&$n0$& &-- &$n9$&"
11768 These variables are counters that can be incremented by means
11769 of the &%add%& command in filter files.
11770
11771 .vitem &$original_domain$&
11772 .vindex "&$domain$&"
11773 .vindex "&$original_domain$&"
11774 When a top-level address is being processed for delivery, this contains the
11775 same value as &$domain$&. However, if a &"child"& address (for example,
11776 generated by an alias, forward, or filter file) is being processed, this
11777 variable contains the domain of the original address (lower cased). This
11778 differs from &$parent_domain$& only when there is more than one level of
11779 aliasing or forwarding. When more than one address is being delivered in a
11780 single transport run, &$original_domain$& is not set.
11781
11782 If a new address is created by means of a &%deliver%& command in a system
11783 filter, it is set up with an artificial &"parent"& address. This has the local
11784 part &'system-filter'& and the default qualify domain.
11785
11786 .vitem &$original_local_part$&
11787 .vindex "&$local_part$&"
11788 .vindex "&$original_local_part$&"
11789 When a top-level address is being processed for delivery, this contains the
11790 same value as &$local_part$&, unless a prefix or suffix was removed from the
11791 local part, because &$original_local_part$& always contains the full local
11792 part. When a &"child"& address (for example, generated by an alias, forward, or
11793 filter file) is being processed, this variable contains the full local part of
11794 the original address.
11795
11796 If the router that did the redirection processed the local part
11797 case-insensitively, the value in &$original_local_part$& is in lower case.
11798 This variable differs from &$parent_local_part$& only when there is more than
11799 one level of aliasing or forwarding. When more than one address is being
11800 delivered in a single transport run, &$original_local_part$& is not set.
11801
11802 If a new address is created by means of a &%deliver%& command in a system
11803 filter, it is set up with an artificial &"parent"& address. This has the local
11804 part &'system-filter'& and the default qualify domain.
11805
11806 .vitem &$originator_gid$&
11807 .cindex "gid (group id)" "of originating user"
11808 .cindex "sender" "gid"
11809 .vindex "&$caller_gid$&"
11810 .vindex "&$originator_gid$&"
11811 This variable contains the value of &$caller_gid$& that was set when the
11812 message was received. For messages received via the command line, this is the
11813 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11814 normally the gid of the Exim user.
11815
11816 .vitem &$originator_uid$&
11817 .cindex "uid (user id)" "of originating user"
11818 .cindex "sender" "uid"
11819 .vindex "&$caller_uid$&"
11820 .vindex "&$originaltor_uid$&"
11821 The value of &$caller_uid$& that was set when the message was received. For
11822 messages received via the command line, this is the uid of the sending user.
11823 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11824 user.
11825
11826 .vitem &$parent_domain$&
11827 .vindex "&$parent_domain$&"
11828 This variable is similar to &$original_domain$& (see
11829 above), except that it refers to the immediately preceding parent address.
11830
11831 .vitem &$parent_local_part$&
11832 .vindex "&$parent_local_part$&"
11833 This variable is similar to &$original_local_part$&
11834 (see above), except that it refers to the immediately preceding parent address.
11835
11836 .vitem &$pid$&
11837 .cindex "pid (process id)" "of current process"
11838 .vindex "&$pid$&"
11839 This variable contains the current process id.
11840
11841 .vitem &$pipe_addresses$&
11842 .cindex "filter" "transport filter"
11843 .cindex "transport" "filter"
11844 .vindex "&$pipe_addresses$&"
11845 This is not an expansion variable, but is mentioned here because the string
11846 &`$pipe_addresses`& is handled specially in the command specification for the
11847 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11848 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11849 It cannot be used in general expansion strings, and provokes an &"unknown
11850 variable"& error if encountered.
11851
11852 .vitem &$primary_hostname$&
11853 .vindex "&$primary_hostname$&"
11854 This variable contains the value set by &%primary_hostname%& in the
11855 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11856 a single-component name, Exim calls &[gethostbyname()]& (or
11857 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11858 qualified host name. See also &$smtp_active_hostname$&.
11859
11860
11861 .vitem &$prvscheck_address$&
11862 This variable is used in conjunction with the &%prvscheck%& expansion item,
11863 which is described in sections &<<SECTexpansionitems>>& and
11864 &<<SECTverifyPRVS>>&.
11865
11866 .vitem &$prvscheck_keynum$&
11867 This variable is used in conjunction with the &%prvscheck%& expansion item,
11868 which is described in sections &<<SECTexpansionitems>>& and
11869 &<<SECTverifyPRVS>>&.
11870
11871 .vitem &$prvscheck_result$&
11872 This variable is used in conjunction with the &%prvscheck%& expansion item,
11873 which is described in sections &<<SECTexpansionitems>>& and
11874 &<<SECTverifyPRVS>>&.
11875
11876 .vitem &$qualify_domain$&
11877 .vindex "&$qualify_domain$&"
11878 The value set for the &%qualify_domain%& option in the configuration file.
11879
11880 .vitem &$qualify_recipient$&
11881 .vindex "&$qualify_recipient$&"
11882 The value set for the &%qualify_recipient%& option in the configuration file,
11883 or if not set, the value of &$qualify_domain$&.
11884
11885 .vitem &$rcpt_count$&
11886 .vindex "&$rcpt_count$&"
11887 When a message is being received by SMTP, this variable contains the number of
11888 RCPT commands received for the current message. If this variable is used in a
11889 RCPT ACL, its value includes the current command.
11890
11891 .vitem &$rcpt_defer_count$&
11892 .vindex "&$rcpt_defer_count$&"
11893 .cindex "4&'xx'& responses" "count of"
11894 When a message is being received by SMTP, this variable contains the number of
11895 RCPT commands in the current message that have previously been rejected with a
11896 temporary (4&'xx'&) response.
11897
11898 .vitem &$rcpt_fail_count$&
11899 .vindex "&$rcpt_fail_count$&"
11900 When a message is being received by SMTP, this variable contains the number of
11901 RCPT commands in the current message that have previously been rejected with a
11902 permanent (5&'xx'&) response.
11903
11904 .vitem &$received_count$&
11905 .vindex "&$received_count$&"
11906 This variable contains the number of &'Received:'& header lines in the message,
11907 including the one added by Exim (so its value is always greater than zero). It
11908 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11909 delivering.
11910
11911 .vitem &$received_for$&
11912 .vindex "&$received_for$&"
11913 If there is only a single recipient address in an incoming message, this
11914 variable contains that address when the &'Received:'& header line is being
11915 built. The value is copied after recipient rewriting has happened, but before
11916 the &[local_scan()]& function is run.
11917
11918 .vitem &$received_ip_address$&
11919 .vindex "&$received_ip_address$&"
11920 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11921 variable is set to the address of the local IP interface, and &$received_port$&
11922 is set to the local port number. (The remote IP address and port are in
11923 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11924 the port value is -1 unless it has been set using the &%-oMi%& command line
11925 option.
11926
11927 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11928 could be used, for example, to make the file name for a TLS certificate depend
11929 on which interface and/or port is being used for the incoming connection. The
11930 values of &$received_ip_address$& and &$received_port$& are saved with any
11931 messages that are received, thus making these variables available at delivery
11932 time.
11933
11934 &*Note:*& There are no equivalent variables for outgoing connections, because
11935 the values are unknown (unless they are explicitly set by options of the
11936 &(smtp)& transport).
11937
11938 .vitem &$received_port$&
11939 .vindex "&$received_port$&"
11940 See &$received_ip_address$&.
11941
11942 .vitem &$received_protocol$&
11943 .vindex "&$received_protocol$&"
11944 When a message is being processed, this variable contains the name of the
11945 protocol by which it was received. Most of the names used by Exim are defined
11946 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11947 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11948 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11949 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11950 connection and the client was successfully authenticated.
11951
11952 Exim uses the protocol name &"smtps"& for the case when encryption is
11953 automatically set up on connection without the use of STARTTLS (see
11954 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11955 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11956 where the client initially uses EHLO, sets up an encrypted connection using
11957 STARTTLS, and then uses HELO afterwards.
11958
11959 The &%-oMr%& option provides a way of specifying a custom protocol name for
11960 messages that are injected locally by trusted callers. This is commonly used to
11961 identify messages that are being re-injected after some kind of scanning.
11962
11963 .vitem &$received_time$&
11964 .vindex "&$received_time$&"
11965 This variable contains the date and time when the current message was received,
11966 as a number of seconds since the start of the Unix epoch.
11967
11968 .vitem &$recipient_data$&
11969 .vindex "&$recipient_data$&"
11970 This variable is set after an indexing lookup success in an ACL &%recipients%&
11971 condition. It contains the data from the lookup, and the value remains set
11972 until the next &%recipients%& test. Thus, you can do things like this:
11973 .display
11974 &`require recipients  = cdb*@;/some/file`&
11975 &`deny    `&&'some further test involving'& &`$recipient_data`&
11976 .endd
11977 &*Warning*&: This variable is set only when a lookup is used as an indexing
11978 method in the address list, using the semicolon syntax as in the example above.
11979 The variable is not set for a lookup that is used as part of the string
11980 expansion that all such lists undergo before being interpreted.
11981
11982 .vitem &$recipient_verify_failure$&
11983 .vindex "&$recipient_verify_failure$&"
11984 In an ACL, when a recipient verification fails, this variable contains
11985 information about the failure. It is set to one of the following words:
11986
11987 .ilist
11988 &"qualify"&: The address was unqualified (no domain), and the message
11989 was neither local nor came from an exempted host.
11990
11991 .next
11992 &"route"&: Routing failed.
11993
11994 .next
11995 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11996 or before the MAIL command (that is, on initial connection, HELO, or
11997 MAIL).
11998
11999 .next
12000 &"recipient"&: The RCPT command in a callout was rejected.
12001 .next
12002
12003 &"postmaster"&: The postmaster check in a callout was rejected.
12004 .endlist
12005
12006 The main use of this variable is expected to be to distinguish between
12007 rejections of MAIL and rejections of RCPT.
12008
12009 .vitem &$recipients$&
12010 .vindex "&$recipients$&"
12011 This variable contains a list of envelope recipients for a message. A comma and
12012 a space separate the addresses in the replacement text. However, the variable
12013 is not generally available, to prevent exposure of Bcc recipients in
12014 unprivileged users' filter files. You can use &$recipients$& only in these
12015 cases:
12016
12017 .olist
12018 In a system filter file.
12019 .next
12020 In the ACLs associated with the DATA command and with non-SMTP messages, that
12021 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12022 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12023 &%acl_not_smtp_mime%&.
12024 .next
12025 From within a &[local_scan()]& function.
12026 .endlist
12027
12028
12029 .vitem &$recipients_count$&
12030 .vindex "&$recipients_count$&"
12031 When a message is being processed, this variable contains the number of
12032 envelope recipients that came with the message. Duplicates are not excluded
12033 from the count. While a message is being received over SMTP, the number
12034 increases for each accepted recipient. It can be referenced in an ACL.
12035
12036
12037 .vitem &$regex_match_string$&
12038 .vindex "&$regex_match_string$&"
12039 This variable is set to contain the matching regular expression after a
12040 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12041
12042
12043 .vitem &$reply_address$&
12044 .vindex "&$reply_address$&"
12045 When a message is being processed, this variable contains the contents of the
12046 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12047 contents of the &'From:'& header line. Apart from the removal of leading
12048 white space, the value is not processed in any way. In particular, no RFC 2047
12049 decoding or character code translation takes place.
12050
12051 .vitem &$return_path$&
12052 .vindex "&$return_path$&"
12053 When a message is being delivered, this variable contains the return path &--
12054 the sender field that will be sent as part of the envelope. It is not enclosed
12055 in <> characters. At the start of routing an address, &$return_path$& has the
12056 same value as &$sender_address$&, but if, for example, an incoming message to a
12057 mailing list has been expanded by a router which specifies a different address
12058 for bounce messages, &$return_path$& subsequently contains the new bounce
12059 address, whereas &$sender_address$& always contains the original sender address
12060 that was received with the message. In other words, &$sender_address$& contains
12061 the incoming envelope sender, and &$return_path$& contains the outgoing
12062 envelope sender.
12063
12064 .vitem &$return_size_limit$&
12065 .vindex "&$return_size_limit$&"
12066 This is an obsolete name for &$bounce_return_size_limit$&.
12067
12068 .vitem &$router_name$&
12069 .cindex "router" "name"
12070 .cindex "name" "of router"
12071 .vindex "&$router_name$&"
12072 During the running of a router this variable contains its name.
12073
12074 .vitem &$runrc$&
12075 .cindex "return code" "from &%run%& expansion"
12076 .vindex "&$runrc$&"
12077 This variable contains the return code from a command that is run by the
12078 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12079 assume the order in which option values are expanded, except for those
12080 preconditions whose order of testing is documented. Therefore, you cannot
12081 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12082 another.
12083
12084 .vitem &$self_hostname$&
12085 .oindex "&%self%&" "value of host name"
12086 .vindex "&$self_hostname$&"
12087 When an address is routed to a supposedly remote host that turns out to be the
12088 local host, what happens is controlled by the &%self%& generic router option.
12089 One of its values causes the address to be passed to another router. When this
12090 happens, &$self_hostname$& is set to the name of the local host that the
12091 original router encountered. In other circumstances its contents are null.
12092
12093 .vitem &$sender_address$&
12094 .vindex "&$sender_address$&"
12095 When a message is being processed, this variable contains the sender's address
12096 that was received in the message's envelope. The case of letters in the address
12097 is retained, in both the local part and the domain. For bounce messages, the
12098 value of this variable is the empty string. See also &$return_path$&.
12099
12100 .vitem &$sender_address_data$&
12101 .vindex "&$address_data$&"
12102 .vindex "&$sender_address_data$&"
12103 If &$address_data$& is set when the routers are called from an ACL to verify a
12104 sender address, the final value is preserved in &$sender_address_data$&, to
12105 distinguish it from data from a recipient address. The value does not persist
12106 after the end of the current ACL statement. If you want to preserve it for
12107 longer, you can save it in an ACL variable.
12108
12109 .vitem &$sender_address_domain$&
12110 .vindex "&$sender_address_domain$&"
12111 The domain portion of &$sender_address$&.
12112
12113 .vitem &$sender_address_local_part$&
12114 .vindex "&$sender_address_local_part$&"
12115 The local part portion of &$sender_address$&.
12116
12117 .vitem &$sender_data$&
12118 .vindex "&$sender_data$&"
12119 This variable is set after a lookup success in an ACL &%senders%& condition or
12120 in a router &%senders%& option. It contains the data from the lookup, and the
12121 value remains set until the next &%senders%& test. Thus, you can do things like
12122 this:
12123 .display
12124 &`require senders      = cdb*@;/some/file`&
12125 &`deny    `&&'some further test involving'& &`$sender_data`&
12126 .endd
12127 &*Warning*&: This variable is set only when a lookup is used as an indexing
12128 method in the address list, using the semicolon syntax as in the example above.
12129 The variable is not set for a lookup that is used as part of the string
12130 expansion that all such lists undergo before being interpreted.
12131
12132 .vitem &$sender_fullhost$&
12133 .vindex "&$sender_fullhost$&"
12134 When a message is received from a remote host, this variable contains the host
12135 name and IP address in a single string. It ends with the IP address in square
12136 brackets, followed by a colon and a port number if the logging of ports is
12137 enabled. The format of the rest of the string depends on whether the host
12138 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12139 looking up its IP address. (Looking up the IP address can be forced by the
12140 &%host_lookup%& option, independent of verification.) A plain host name at the
12141 start of the string is a verified host name; if this is not present,
12142 verification either failed or was not requested. A host name in parentheses is
12143 the argument of a HELO or EHLO command. This is omitted if it is identical to
12144 the verified host name or to the host's IP address in square brackets.
12145
12146 .vitem &$sender_helo_name$&
12147 .vindex "&$sender_helo_name$&"
12148 When a message is received from a remote host that has issued a HELO or EHLO
12149 command, the argument of that command is placed in this variable. It is also
12150 set if HELO or EHLO is used when a message is received using SMTP locally via
12151 the &%-bs%& or &%-bS%& options.
12152
12153 .vitem &$sender_host_address$&
12154 .vindex "&$sender_host_address$&"
12155 When a message is received from a remote host using SMTP,
12156 this variable contains that
12157 host's IP address. For locally non-SMTP submitted messages, it is empty.
12158
12159 .vitem &$sender_host_authenticated$&
12160 .vindex "&$sender_host_authenticated$&"
12161 This variable contains the name (not the public name) of the authenticator
12162 driver that successfully authenticated the client from which the message was
12163 received. It is empty if there was no successful authentication. See also
12164 &$authenticated_id$&.
12165
12166 .vitem &$sender_host_dnssec$&
12167 .vindex "&$sender_host_dnssec$&"
12168 If an attempt to populate &$sender_host_name$& has been made
12169 (by reference, &%hosts_lookup%& or
12170 otherwise) then this boolean will have been set true if, and only if, the
12171 resolver library states that the reverse DNS was authenticated data.  At all
12172 other times, this variable is false.
12173
12174 It is likely that you will need to coerce DNSSEC support on in the resolver
12175 library, by setting:
12176 .code
12177 dns_dnssec_ok = 1
12178 .endd
12179
12180 Exim does not perform DNSSEC validation itself, instead leaving that to a
12181 validating resolver (eg, unbound, or bind with suitable configuration).
12182
12183 Exim does not (currently) check to see if the forward DNS was also secured
12184 with DNSSEC, only the reverse DNS.
12185
12186 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12187 mechanism in the list, then this variable will be false.
12188
12189
12190 .vitem &$sender_host_name$&
12191 .vindex "&$sender_host_name$&"
12192 When a message is received from a remote host, this variable contains the
12193 host's name as obtained by looking up its IP address. For messages received by
12194 other means, this variable is empty.
12195
12196 .vindex "&$host_lookup_failed$&"
12197 If the host name has not previously been looked up, a reference to
12198 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12199 A looked up name is accepted only if it leads back to the original IP address
12200 via a forward lookup. If either the reverse or the forward lookup fails to find
12201 any data, or if the forward lookup does not yield the original IP address,
12202 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12203
12204 .vindex "&$host_lookup_deferred$&"
12205 However, if either of the lookups cannot be completed (for example, there is a
12206 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12207 &$host_lookup_failed$& remains set to &"0"&.
12208
12209 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12210 host name again if there is a subsequent reference to &$sender_host_name$&
12211 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12212 is set to &"1"&.
12213
12214 Exim does not automatically look up every calling host's name. If you want
12215 maximum efficiency, you should arrange your configuration so that it avoids
12216 these lookups altogether. The lookup happens only if one or more of the
12217 following are true:
12218
12219 .ilist
12220 A string containing &$sender_host_name$& is expanded.
12221 .next
12222 The calling host matches the list in &%host_lookup%&. In the default
12223 configuration, this option is set to *, so it must be changed if lookups are
12224 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12225 .next
12226 Exim needs the host name in order to test an item in a host list. The items
12227 that require this are described in sections &<<SECThoslispatnam>>& and
12228 &<<SECThoslispatnamsk>>&.
12229 .next
12230 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12231 In this case, the host name is required to compare with the name quoted in any
12232 EHLO or HELO commands that the client issues.
12233 .next
12234 The remote host issues a EHLO or HELO command that quotes one of the
12235 domains in &%helo_lookup_domains%&. The default value of this option is
12236 . ==== As this is a nested list, any displays it contains must be indented
12237 . ==== as otherwise they are too far to the left.
12238 .code
12239   helo_lookup_domains = @ : @[]
12240 .endd
12241 which causes a lookup if a remote host (incorrectly) gives the server's name or
12242 IP address in an EHLO or HELO command.
12243 .endlist
12244
12245
12246 .vitem &$sender_host_port$&
12247 .vindex "&$sender_host_port$&"
12248 When a message is received from a remote host, this variable contains the port
12249 number that was used on the remote host.
12250
12251 .vitem &$sender_ident$&
12252 .vindex "&$sender_ident$&"
12253 When a message is received from a remote host, this variable contains the
12254 identification received in response to an RFC 1413 request. When a message has
12255 been received locally, this variable contains the login name of the user that
12256 called Exim.
12257
12258 .vitem &$sender_rate_$&&'xxx'&
12259 A number of variables whose names begin &$sender_rate_$& are set as part of the
12260 &%ratelimit%& ACL condition. Details are given in section
12261 &<<SECTratelimiting>>&.
12262
12263 .vitem &$sender_rcvhost$&
12264 .cindex "DNS" "reverse lookup"
12265 .cindex "reverse DNS lookup"
12266 .vindex "&$sender_rcvhost$&"
12267 This is provided specifically for use in &'Received:'& headers. It starts with
12268 either the verified host name (as obtained from a reverse DNS lookup) or, if
12269 there is no verified host name, the IP address in square brackets. After that
12270 there may be text in parentheses. When the first item is a verified host name,
12271 the first thing in the parentheses is the IP address in square brackets,
12272 followed by a colon and a port number if port logging is enabled. When the
12273 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12274 the parentheses.
12275
12276 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12277 was used and its argument was not identical to the real host name or IP
12278 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12279 all three items are present in the parentheses, a newline and tab are inserted
12280 into the string, to improve the formatting of the &'Received:'& header.
12281
12282 .vitem &$sender_verify_failure$&
12283 .vindex "&$sender_verify_failure$&"
12284 In an ACL, when a sender verification fails, this variable contains information
12285 about the failure. The details are the same as for
12286 &$recipient_verify_failure$&.
12287
12288 .vitem &$sending_ip_address$&
12289 .vindex "&$sending_ip_address$&"
12290 This variable is set whenever an outgoing SMTP connection to another host has
12291 been set up. It contains the IP address of the local interface that is being
12292 used. This is useful if a host that has more than one IP address wants to take
12293 on different personalities depending on which one is being used. For incoming
12294 connections, see &$received_ip_address$&.
12295
12296 .vitem &$sending_port$&
12297 .vindex "&$sending_port$&"
12298 This variable is set whenever an outgoing SMTP connection to another host has
12299 been set up. It contains the local port that is being used. For incoming
12300 connections, see &$received_port$&.
12301
12302 .vitem &$smtp_active_hostname$&
12303 .vindex "&$smtp_active_hostname$&"
12304 During an incoming SMTP session, this variable contains the value of the active
12305 host name, as specified by the &%smtp_active_hostname%& option. The value of
12306 &$smtp_active_hostname$& is saved with any message that is received, so its
12307 value can be consulted during routing and delivery.
12308
12309 .vitem &$smtp_command$&
12310 .vindex "&$smtp_command$&"
12311 During the processing of an incoming SMTP command, this variable contains the
12312 entire command. This makes it possible to distinguish between HELO and EHLO in
12313 the HELO ACL, and also to distinguish between commands such as these:
12314 .code
12315 MAIL FROM:<>
12316 MAIL FROM: <>
12317 .endd
12318 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12319 command, the address in &$smtp_command$& is the original address before any
12320 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12321 the address after SMTP-time rewriting.
12322
12323 .vitem &$smtp_command_argument$&
12324 .cindex "SMTP" "command, argument for"
12325 .vindex "&$smtp_command_argument$&"
12326 While an ACL is running to check an SMTP command, this variable contains the
12327 argument, that is, the text that follows the command name, with leading white
12328 space removed. Following the introduction of &$smtp_command$&, this variable is
12329 somewhat redundant, but is retained for backwards compatibility.
12330
12331 .vitem &$smtp_count_at_connection_start$&
12332 .vindex "&$smtp_count_at_connection_start$&"
12333 This variable is set greater than zero only in processes spawned by the Exim
12334 daemon for handling incoming SMTP connections. The name is deliberately long,
12335 in order to emphasize what the contents are. When the daemon accepts a new
12336 connection, it increments this variable. A copy of the variable is passed to
12337 the child process that handles the connection, but its value is fixed, and
12338 never changes. It is only an approximation of how many incoming connections
12339 there actually are, because many other connections may come and go while a
12340 single connection is being processed. When a child process terminates, the
12341 daemon decrements its copy of the variable.
12342
12343 .vitem "&$sn0$& &-- &$sn9$&"
12344 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12345 that were current at the end of the system filter file. This allows a system
12346 filter file to set values that can be tested in users' filter files. For
12347 example, a system filter could set a value indicating how likely it is that a
12348 message is junk mail.
12349
12350 .vitem &$spam_$&&'xxx'&
12351 A number of variables whose names start with &$spam$& are available when Exim
12352 is compiled with the content-scanning extension. For details, see section
12353 &<<SECTscanspamass>>&.
12354
12355
12356 .vitem &$spool_directory$&
12357 .vindex "&$spool_directory$&"
12358 The name of Exim's spool directory.
12359
12360 .vitem &$spool_inodes$&
12361 .vindex "&$spool_inodes$&"
12362 The number of free inodes in the disk partition where Exim's spool files are
12363 being written. The value is recalculated whenever the variable is referenced.
12364 If the relevant file system does not have the concept of inodes, the value of
12365 is -1. See also the &%check_spool_inodes%& option.
12366
12367 .vitem &$spool_space$&
12368 .vindex "&$spool_space$&"
12369 The amount of free space (as a number of kilobytes) in the disk partition where
12370 Exim's spool files are being written. The value is recalculated whenever the
12371 variable is referenced. If the operating system does not have the ability to
12372 find the amount of free space (only true for experimental systems), the space
12373 value is -1. For example, to check in an ACL that there is at least 50
12374 megabytes free on the spool, you could write:
12375 .code
12376 condition = ${if > {$spool_space}{50000}}
12377 .endd
12378 See also the &%check_spool_space%& option.
12379
12380
12381 .vitem &$thisaddress$&
12382 .vindex "&$thisaddress$&"
12383 This variable is set only during the processing of the &%foranyaddress%&
12384 command in a filter file. Its use is explained in the description of that
12385 command, which can be found in the separate document entitled &'Exim's
12386 interfaces to mail filtering'&.
12387
12388 .vitem &$tls_in_bits$&
12389 .vindex "&$tls_in_bits$&"
12390 Contains an approximation of the TLS cipher's bit-strength
12391 on the inbound connection; the meaning of
12392 this depends upon the TLS implementation used.
12393 If TLS has not been negotiated, the value will be 0.
12394 The value of this is automatically fed into the Cyrus SASL authenticator
12395 when acting as a server, to specify the "external SSF" (a SASL term).
12396
12397 The deprecated &$tls_bits$& variable refers to the inbound side
12398 except when used in the context of an outbound SMTP delivery, when it refers to
12399 the outbound.
12400
12401 .vitem &$tls_out_bits$&
12402 .vindex "&$tls_out_bits$&"
12403 Contains an approximation of the TLS cipher's bit-strength
12404 on an outbound SMTP connection; the meaning of
12405 this depends upon the TLS implementation used.
12406 If TLS has not been negotiated, the value will be 0.
12407
12408 .vitem &$tls_in_ourcert$&
12409 .vindex "&$tls_in_ourcert$&"
12410 This variable refers to the certificate presented to the peer of an
12411 inbound connection when the message was received.
12412 It is only useful as the argument of a
12413 .new
12414 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12415 .wen
12416 or a &%def%& condition.
12417
12418 .vitem &$tls_in_peercert$&
12419 .vindex "&$tls_in_peercert$&"
12420 This variable refers to the certificate presented by the peer of an
12421 inbound connection when the message was received.
12422 It is only useful as the argument of a
12423 .new
12424 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12425 .wen
12426 or a &%def%& condition.
12427
12428 .vitem &$tls_out_ourcert$&
12429 .vindex "&$tls_out_ourcert$&"
12430 This variable refers to the certificate presented to the peer of an
12431 outbound connection.  It is only useful as the argument of a
12432 .new
12433 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12434 .wen
12435 or a &%def%& condition.
12436
12437 .vitem &$tls_out_peercert$&
12438 .vindex "&$tls_out_peercert$&"
12439 This variable refers to the certificate presented by the peer of an
12440 outbound connection.  It is only useful as the argument of a
12441 .new
12442 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12443 .wen
12444 or a &%def%& condition.
12445
12446 .vitem &$tls_in_certificate_verified$&
12447 .vindex "&$tls_in_certificate_verified$&"
12448 This variable is set to &"1"& if a TLS certificate was verified when the
12449 message was received, and &"0"& otherwise.
12450
12451 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12452 except when used in the context of an outbound SMTP delivery, when it refers to
12453 the outbound.
12454
12455 .vitem &$tls_out_certificate_verified$&
12456 .vindex "&$tls_out_certificate_verified$&"
12457 This variable is set to &"1"& if a TLS certificate was verified when an
12458 outbound SMTP connection was made,
12459 and &"0"& otherwise.
12460
12461 .vitem &$tls_in_cipher$&
12462 .vindex "&$tls_in_cipher$&"
12463 .vindex "&$tls_cipher$&"
12464 When a message is received from a remote host over an encrypted SMTP
12465 connection, this variable is set to the cipher suite that was negotiated, for
12466 example DES-CBC3-SHA. In other circumstances, in particular, for message
12467 received over unencrypted connections, the variable is empty. Testing
12468 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12469 non-encrypted connections during ACL processing.
12470
12471 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12472 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12473 becomes the same as &$tls_out_cipher$&.
12474
12475 .vitem &$tls_out_cipher$&
12476 .vindex "&$tls_out_cipher$&"
12477 This variable is
12478 cleared before any outgoing SMTP connection is made,
12479 and then set to the outgoing cipher suite if one is negotiated. See chapter
12480 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12481 details of the &(smtp)& transport.
12482
12483 .vitem &$tls_in_ocsp$&
12484 .vindex "&$tls_in_ocsp$&"
12485 When a message is received from a remote client connection
12486 the result of any OCSP request from the client is encoded in this variable:
12487 .code
12488 0 OCSP proof was not requested (default value)
12489 1 No response to request
12490 2 Response not verified
12491 3 Verification failed
12492 4 Verification succeeded
12493 .endd
12494
12495 .vitem &$tls_out_ocsp$&
12496 .vindex "&$tls_out_ocsp$&"
12497 When a message is sent to a remote host connection
12498 the result of any OCSP request made is encoded in this variable.
12499 See &$tls_in_ocsp$& for values.
12500
12501 .vitem &$tls_in_peerdn$&
12502 .vindex "&$tls_in_peerdn$&"
12503 .vindex "&$tls_peerdn$&"
12504 When a message is received from a remote host over an encrypted SMTP
12505 connection, and Exim is configured to request a certificate from the client,
12506 the value of the Distinguished Name of the certificate is made available in the
12507 &$tls_in_peerdn$& during subsequent processing.
12508
12509 The deprecated &$tls_peerdn$& variable refers to the inbound side
12510 except when used in the context of an outbound SMTP delivery, when it refers to
12511 the outbound.
12512
12513 .vitem &$tls_out_peerdn$&
12514 .vindex "&$tls_out_peerdn$&"
12515 When a message is being delivered to a remote host over an encrypted SMTP
12516 connection, and Exim is configured to request a certificate from the server,
12517 the value of the Distinguished Name of the certificate is made available in the
12518 &$tls_out_peerdn$& during subsequent processing.
12519
12520 .vitem &$tls_in_sni$&
12521 .vindex "&$tls_in_sni$&"
12522 .vindex "&$tls_sni$&"
12523 .cindex "TLS" "Server Name Indication"
12524 When a TLS session is being established, if the client sends the Server
12525 Name Indication extension, the value will be placed in this variable.
12526 If the variable appears in &%tls_certificate%& then this option and
12527 some others, described in &<<SECTtlssni>>&,
12528 will be re-expanded early in the TLS session, to permit
12529 a different certificate to be presented (and optionally a different key to be
12530 used) to the client, based upon the value of the SNI extension.
12531
12532 The deprecated &$tls_sni$& variable refers to the inbound side
12533 except when used in the context of an outbound SMTP delivery, when it refers to
12534 the outbound.
12535
12536 .vitem &$tls_out_sni$&
12537 .vindex "&$tls_out_sni$&"
12538 .cindex "TLS" "Server Name Indication"
12539 During outbound
12540 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12541 the transport.
12542
12543 .vitem &$tod_bsdinbox$&
12544 .vindex "&$tod_bsdinbox$&"
12545 The time of day and the date, in the format required for BSD-style mailbox
12546 files, for example: Thu Oct 17 17:14:09 1995.
12547
12548 .vitem &$tod_epoch$&
12549 .vindex "&$tod_epoch$&"
12550 The time and date as a number of seconds since the start of the Unix epoch.
12551
12552 .vitem &$tod_epoch_l$&
12553 .vindex "&$tod_epoch_l$&"
12554 The time and date as a number of microseconds since the start of the Unix epoch.
12555
12556 .vitem &$tod_full$&
12557 .vindex "&$tod_full$&"
12558 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12559 +0100. The timezone is always given as a numerical offset from UTC, with
12560 positive values used for timezones that are ahead (east) of UTC, and negative
12561 values for those that are behind (west).
12562
12563 .vitem &$tod_log$&
12564 .vindex "&$tod_log$&"
12565 The time and date in the format used for writing Exim's log files, for example:
12566 1995-10-12 15:32:29, but without a timezone.
12567
12568 .vitem &$tod_logfile$&
12569 .vindex "&$tod_logfile$&"
12570 This variable contains the date in the format yyyymmdd. This is the format that
12571 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12572 flag.
12573
12574 .vitem &$tod_zone$&
12575 .vindex "&$tod_zone$&"
12576 This variable contains the numerical value of the local timezone, for example:
12577 -0500.
12578
12579 .vitem &$tod_zulu$&
12580 .vindex "&$tod_zulu$&"
12581 This variable contains the UTC date and time in &"Zulu"& format, as specified
12582 by ISO 8601, for example: 20030221154023Z.
12583
12584 .vitem &$transport_name$&
12585 .cindex "transport" "name"
12586 .cindex "name" "of transport"
12587 .vindex "&$transport_name$&"
12588 During the running of a transport, this variable contains its name.
12589
12590 .vitem &$value$&
12591 .vindex "&$value$&"
12592 This variable contains the result of an expansion lookup, extraction operation,
12593 or external command, as described above. It is also used during a
12594 &*reduce*& expansion.
12595
12596 .vitem &$verify_mode$&
12597 .vindex "&$verify_mode$&"
12598 While a router or transport is being run in verify mode
12599 or for cutthrough delivery,
12600 contains "S" for sender-verification or "R" for recipient-verification.
12601 Otherwise, empty.
12602
12603 .vitem &$version_number$&
12604 .vindex "&$version_number$&"
12605 The version number of Exim.
12606
12607 .vitem &$warn_message_delay$&
12608 .vindex "&$warn_message_delay$&"
12609 This variable is set only during the creation of a message warning about a
12610 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12611
12612 .vitem &$warn_message_recipients$&
12613 .vindex "&$warn_message_recipients$&"
12614 This variable is set only during the creation of a message warning about a
12615 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12616 .endlist
12617 .ecindex IIDstrexp
12618
12619
12620
12621 . ////////////////////////////////////////////////////////////////////////////
12622 . ////////////////////////////////////////////////////////////////////////////
12623
12624 .chapter "Embedded Perl" "CHAPperl"
12625 .scindex IIDperl "Perl" "calling from Exim"
12626 Exim can be built to include an embedded Perl interpreter. When this is done,
12627 Perl subroutines can be called as part of the string expansion process. To make
12628 use of the Perl support, you need version 5.004 or later of Perl installed on
12629 your system. To include the embedded interpreter in the Exim binary, include
12630 the line
12631 .code
12632 EXIM_PERL = perl.o
12633 .endd
12634 in your &_Local/Makefile_& and then build Exim in the normal way.
12635
12636
12637 .section "Setting up so Perl can be used" "SECID85"
12638 .oindex "&%perl_startup%&"
12639 Access to Perl subroutines is via a global configuration option called
12640 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12641 no &%perl_startup%& option in the Exim configuration file then no Perl
12642 interpreter is started and there is almost no overhead for Exim (since none of
12643 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12644 option then the associated value is taken to be Perl code which is executed in
12645 a newly created Perl interpreter.
12646
12647 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12648 need backslashes before any characters to escape special meanings. The option
12649 should usually be something like
12650 .code
12651 perl_startup = do '/etc/exim.pl'
12652 .endd
12653 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12654 use from Exim. Exim can be configured either to start up a Perl interpreter as
12655 soon as it is entered, or to wait until the first time it is needed. Starting
12656 the interpreter at the beginning ensures that it is done while Exim still has
12657 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12658 fact used in a particular run. Also, note that this does not mean that Exim is
12659 necessarily running as root when Perl is called at a later time. By default,
12660 the interpreter is started only when it is needed, but this can be changed in
12661 two ways:
12662
12663 .ilist
12664 .oindex "&%perl_at_start%&"
12665 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12666 a startup when Exim is entered.
12667 .next
12668 The command line option &%-ps%& also requests a startup when Exim is entered,
12669 overriding the setting of &%perl_at_start%&.
12670 .endlist
12671
12672 There is also a command line option &%-pd%& (for delay) which suppresses the
12673 initial startup, even if &%perl_at_start%& is set.
12674
12675
12676 .section "Calling Perl subroutines" "SECID86"
12677 When the configuration file includes a &%perl_startup%& option you can make use
12678 of the string expansion item to call the Perl subroutines that are defined
12679 by the &%perl_startup%& code. The operator is used in any of the following
12680 forms:
12681 .code
12682 ${perl{foo}}
12683 ${perl{foo}{argument}}
12684 ${perl{foo}{argument1}{argument2} ... }
12685 .endd
12686 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12687 arguments may be passed. Passing more than this results in an expansion failure
12688 with an error message of the form
12689 .code
12690 Too many arguments passed to Perl subroutine "foo" (max is 8)
12691 .endd
12692 The return value of the Perl subroutine is evaluated in a scalar context before
12693 it is passed back to Exim to be inserted into the expanded string. If the
12694 return value is &'undef'&, the expansion is forced to fail in the same way as
12695 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12696 by obeying Perl's &%die%& function, the expansion fails with the error message
12697 that was passed to &%die%&.
12698
12699
12700 .section "Calling Exim functions from Perl" "SECID87"
12701 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12702 is available to call back into Exim's string expansion function. For example,
12703 the Perl code
12704 .code
12705 my $lp = Exim::expand_string('$local_part');
12706 .endd
12707 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12708 Note those are single quotes and not double quotes to protect against
12709 &$local_part$& being interpolated as a Perl variable.
12710
12711 If the string expansion is forced to fail by a &"fail"& item, the result of
12712 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12713 expansion string, the Perl call from the original expansion string fails with
12714 an appropriate error message, in the same way as if &%die%& were used.
12715
12716 .cindex "debugging" "from embedded Perl"
12717 .cindex "log" "writing from embedded Perl"
12718 Two other Exim functions are available for use from within Perl code.
12719 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12720 debugging is enabled. If you want a newline at the end, you must supply it.
12721 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12722 timestamp. In this case, you should not supply a terminating newline.
12723
12724
12725 .section "Use of standard output and error by Perl" "SECID88"
12726 .cindex "Perl" "standard output and error"
12727 You should not write to the standard error or output streams from within your
12728 Perl code, as it is not defined how these are set up. In versions of Exim
12729 before 4.50, it is possible for the standard output or error to refer to the
12730 SMTP connection during message reception via the daemon. Writing to this stream
12731 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12732 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12733 avoided, but the output is lost.
12734
12735 .cindex "Perl" "use of &%warn%&"
12736 The Perl &%warn%& statement writes to the standard error stream by default.
12737 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12738 you have no control. When Exim starts up the Perl interpreter, it arranges for
12739 output from the &%warn%& statement to be written to the Exim main log. You can
12740 change this by including appropriate Perl magic somewhere in your Perl code.
12741 For example, to discard &%warn%& output completely, you need this:
12742 .code
12743 $SIG{__WARN__} = sub { };
12744 .endd
12745 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12746 example, the code for the subroutine is empty, so it does nothing, but you can
12747 include any Perl code that you like. The text of the &%warn%& message is passed
12748 as the first subroutine argument.
12749 .ecindex IIDperl
12750
12751
12752 . ////////////////////////////////////////////////////////////////////////////
12753 . ////////////////////////////////////////////////////////////////////////////
12754
12755 .chapter "Starting the daemon and the use of network interfaces" &&&
12756          "CHAPinterfaces" &&&
12757          "Starting the daemon"
12758 .cindex "daemon" "starting"
12759 .cindex "interface" "listening"
12760 .cindex "network interface"
12761 .cindex "interface" "network"
12762 .cindex "IP address" "for listening"
12763 .cindex "daemon" "listening IP addresses"
12764 .cindex "TCP/IP" "setting listening interfaces"
12765 .cindex "TCP/IP" "setting listening ports"
12766 A host that is connected to a TCP/IP network may have one or more physical
12767 hardware network interfaces. Each of these interfaces may be configured as one
12768 or more &"logical"& interfaces, which are the entities that a program actually
12769 works with. Each of these logical interfaces is associated with an IP address.
12770 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12771 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12772 knowledge about the host's interfaces for use in three different circumstances:
12773
12774 .olist
12775 When a listening daemon is started, Exim needs to know which interfaces
12776 and ports to listen on.
12777 .next
12778 When Exim is routing an address, it needs to know which IP addresses
12779 are associated with local interfaces. This is required for the correct
12780 processing of MX lists by removing the local host and others with the
12781 same or higher priority values. Also, Exim needs to detect cases
12782 when an address is routed to an IP address that in fact belongs to the
12783 local host. Unless the &%self%& router option or the &%allow_localhost%&
12784 option of the smtp transport is set (as appropriate), this is treated
12785 as an error situation.
12786 .next
12787 When Exim connects to a remote host, it may need to know which interface to use
12788 for the outgoing connection.
12789 .endlist
12790
12791
12792 Exim's default behaviour is likely to be appropriate in the vast majority
12793 of cases. If your host has only one interface, and you want all its IP
12794 addresses to be treated in the same way, and you are using only the
12795 standard SMTP port, you should not need to take any special action. The
12796 rest of this chapter does not apply to you.
12797
12798 In a more complicated situation you may want to listen only on certain
12799 interfaces, or on different ports, and for this reason there are a number of
12800 options that can be used to influence Exim's behaviour. The rest of this
12801 chapter describes how they operate.
12802
12803 When a message is received over TCP/IP, the interface and port that were
12804 actually used are set in &$received_ip_address$& and &$received_port$&.
12805
12806
12807
12808 .section "Starting a listening daemon" "SECID89"
12809 When a listening daemon is started (by means of the &%-bd%& command line
12810 option), the interfaces and ports on which it listens are controlled by the
12811 following options:
12812
12813 .ilist
12814 &%daemon_smtp_ports%& contains a list of default ports
12815 or service names.
12816 (For backward compatibility, this option can also be specified in the singular.)
12817 .next
12818 &%local_interfaces%& contains list of interface IP addresses on which to
12819 listen. Each item may optionally also specify a port.
12820 .endlist
12821
12822 The default list separator in both cases is a colon, but this can be changed as
12823 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12824 it is usually best to change the separator to avoid having to double all the
12825 colons. For example:
12826 .code
12827 local_interfaces = <; 127.0.0.1 ; \
12828                       192.168.23.65 ; \
12829                       ::1 ; \
12830                       3ffe:ffff:836f::fe86:a061
12831 .endd
12832 There are two different formats for specifying a port along with an IP address
12833 in &%local_interfaces%&:
12834
12835 .olist
12836 The port is added onto the address with a dot separator. For example, to listen
12837 on port 1234 on two different IP addresses:
12838 .code
12839 local_interfaces = <; 192.168.23.65.1234 ; \
12840                       3ffe:ffff:836f::fe86:a061.1234
12841 .endd
12842 .next
12843 The IP address is enclosed in square brackets, and the port is added
12844 with a colon separator, for example:
12845 .code
12846 local_interfaces = <; [192.168.23.65]:1234 ; \
12847                       [3ffe:ffff:836f::fe86:a061]:1234
12848 .endd
12849 .endlist
12850
12851 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12852 default setting contains just one port:
12853 .code
12854 daemon_smtp_ports = smtp
12855 .endd
12856 If more than one port is listed, each interface that does not have its own port
12857 specified listens on all of them. Ports that are listed in
12858 &%daemon_smtp_ports%& can be identified either by name (defined in
12859 &_/etc/services_&) or by number. However, when ports are given with individual
12860 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12861
12862
12863
12864 .section "Special IP listening addresses" "SECID90"
12865 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12866 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12867 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12868 instead of setting up separate listening sockets for each interface. The
12869 default value of &%local_interfaces%& is
12870 .code
12871 local_interfaces = 0.0.0.0
12872 .endd
12873 when Exim is built without IPv6 support; otherwise it is:
12874 .code
12875 local_interfaces = <; ::0 ; 0.0.0.0
12876 .endd
12877 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12878
12879
12880
12881 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12882 The &%-oX%& command line option can be used to override the values of
12883 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12884 instance. Another way of doing this would be to use macros and the &%-D%&
12885 option. However, &%-oX%& can be used by any admin user, whereas modification of
12886 the runtime configuration by &%-D%& is allowed only when the caller is root or
12887 exim.
12888
12889 The value of &%-oX%& is a list of items. The default colon separator can be
12890 changed in the usual way if required. If there are any items that do not
12891 contain dots or colons (that is, are not IP addresses), the value of
12892 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12893 items that do contain dots or colons, the value of &%local_interfaces%& is
12894 replaced by those items. Thus, for example,
12895 .code
12896 -oX 1225
12897 .endd
12898 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12899 whereas
12900 .code
12901 -oX 192.168.34.5.1125
12902 .endd
12903 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12904 (However, since &%local_interfaces%& now contains no items without ports, the
12905 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12906
12907
12908
12909 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12910 .cindex "ssmtp protocol"
12911 .cindex "smtps protocol"
12912 .cindex "SMTP" "ssmtp protocol"
12913 .cindex "SMTP" "smtps protocol"
12914 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12915 before the STARTTLS command was standardized for SMTP. Some legacy clients
12916 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12917 list of port numbers or service names,
12918 connections to those ports must use SSMTP. The most
12919 common use of this option is expected to be
12920 .code
12921 tls_on_connect_ports = 465
12922 .endd
12923 because 465 is the usual port number used by the legacy clients. There is also
12924 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12925 this way when a daemon is started.
12926
12927 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12928 daemon to listen on those ports. You must still specify them in
12929 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12930 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12931 connections via the daemon.)
12932
12933
12934
12935
12936 .section "IPv6 address scopes" "SECID92"
12937 .cindex "IPv6" "address scopes"
12938 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12939 can, in principle, have the same link-local IPv6 address on different
12940 interfaces. Thus, additional information is needed, over and above the IP
12941 address, to distinguish individual interfaces. A convention of using a
12942 percent sign followed by something (often the interface name) has been
12943 adopted in some cases, leading to addresses like this:
12944 .code
12945 fe80::202:b3ff:fe03:45c1%eth0
12946 .endd
12947 To accommodate this usage, a percent sign followed by an arbitrary string is
12948 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12949 to convert a textual IPv6 address for actual use. This function recognizes the
12950 percent convention in operating systems that support it, and it processes the
12951 address appropriately. Unfortunately, some older libraries have problems with
12952 &[getaddrinfo()]&. If
12953 .code
12954 IPV6_USE_INET_PTON=yes
12955 .endd
12956 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12957 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12958 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12959 function.) Of course, this means that the additional functionality of
12960 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12961
12962 .section "Disabling IPv6" "SECID93"
12963 .cindex "IPv6" "disabling"
12964 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12965 run on a host whose kernel does not support IPv6. The binary will fall back to
12966 using IPv4, but it may waste resources looking up AAAA records, and trying to
12967 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12968 .oindex "&%disable_ipv6%&"
12969 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12970 activities take place. AAAA records are never looked up, and any IPv6 addresses
12971 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12972 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12973 to handle IPv6 literal addresses.
12974
12975 On the other hand, when IPv6 is in use, there may be times when you want to
12976 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12977 option to globally suppress the lookup of AAAA records for specified domains,
12978 and you can use the &%ignore_target_hosts%& generic router option to ignore
12979 IPv6 addresses in an individual router.
12980
12981
12982
12983 .section "Examples of starting a listening daemon" "SECID94"
12984 The default case in an IPv6 environment is
12985 .code
12986 daemon_smtp_ports = smtp
12987 local_interfaces = <; ::0 ; 0.0.0.0
12988 .endd
12989 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12990 Either one or two sockets may be used, depending on the characteristics of
12991 the TCP/IP stack. (This is complicated and messy; for more information,
12992 read the comments in the &_daemon.c_& source file.)
12993
12994 To specify listening on ports 25 and 26 on all interfaces:
12995 .code
12996 daemon_smtp_ports = 25 : 26
12997 .endd
12998 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12999 .code
13000 local_interfaces = <; ::0.25     ; ::0.26 \
13001                       0.0.0.0.25 ; 0.0.0.0.26
13002 .endd
13003 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13004 IPv4 loopback address only:
13005 .code
13006 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13007 .endd
13008 To specify listening on the default port on specific interfaces only:
13009 .code
13010 local_interfaces = 10.0.0.67 : 192.168.34.67
13011 .endd
13012 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13013
13014
13015
13016 .section "Recognizing the local host" "SECTreclocipadd"
13017 The &%local_interfaces%& option is also used when Exim needs to determine
13018 whether or not an IP address refers to the local host. That is, the IP
13019 addresses of all the interfaces on which a daemon is listening are always
13020 treated as local.
13021
13022 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13023 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13024 available interfaces from the operating system, and extracts the relevant
13025 (that is, IPv4 or IPv6) addresses to use for checking.
13026
13027 Some systems set up large numbers of virtual interfaces in order to provide
13028 many virtual web servers. In this situation, you may want to listen for
13029 email on only a few of the available interfaces, but nevertheless treat all
13030 interfaces as local when routing. You can do this by setting
13031 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13032 &"all"& wildcard values. These addresses are recognized as local, but are not
13033 used for listening. Consider this example:
13034 .code
13035 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13036                       192.168.53.235 ; \
13037                       3ffe:2101:12:1:a00:20ff:fe86:a061
13038
13039 extra_local_interfaces = <; ::0 ; 0.0.0.0
13040 .endd
13041 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13042 address, but all available interface addresses are treated as local when
13043 Exim is routing.
13044
13045 In some environments the local host name may be in an MX list, but with an IP
13046 address that is not assigned to any local interface. In other cases it may be
13047 desirable to treat other host names as if they referred to the local host. Both
13048 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13049 This contains host names rather than IP addresses. When a host is referenced
13050 during routing, either via an MX record or directly, it is treated as the local
13051 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13052 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13053
13054
13055
13056 .section "Delivering to a remote host" "SECID95"
13057 Delivery to a remote host is handled by the smtp transport. By default, it
13058 allows the system's TCP/IP functions to choose which interface to use (if
13059 there is more than one) when connecting to a remote host. However, the
13060 &%interface%& option can be set to specify which interface is used. See the
13061 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13062 details.
13063
13064
13065
13066
13067 . ////////////////////////////////////////////////////////////////////////////
13068 . ////////////////////////////////////////////////////////////////////////////
13069
13070 .chapter "Main configuration" "CHAPmainconfig"
13071 .scindex IIDconfima "configuration file" "main section"
13072 .scindex IIDmaiconf "main configuration"
13073 The first part of the run time configuration file contains three types of item:
13074
13075 .ilist
13076 Macro definitions: These lines start with an upper case letter. See section
13077 &<<SECTmacrodefs>>& for details of macro processing.
13078 .next
13079 Named list definitions: These lines start with one of the words &"domainlist"&,
13080 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13081 section &<<SECTnamedlists>>&.
13082 .next
13083 Main configuration settings: Each setting occupies one line of the file
13084 (with possible continuations). If any setting is preceded by the word
13085 &"hide"&, the &%-bP%& command line option displays its value to admin users
13086 only. See section &<<SECTcos>>& for a description of the syntax of these option
13087 settings.
13088 .endlist
13089
13090 This chapter specifies all the main configuration options, along with their
13091 types and default values. For ease of finding a particular option, they appear
13092 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13093 are now so many options, they are first listed briefly in functional groups, as
13094 an aid to finding the name of the option you are looking for. Some options are
13095 listed in more than one group.
13096
13097 .section "Miscellaneous" "SECID96"
13098 .table2
13099 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13100 .row &%disable_ipv6%&                "do no IPv6 processing"
13101 .row &%keep_malformed%&              "for broken files &-- should not happen"
13102 .row &%localhost_number%&            "for unique message ids in clusters"
13103 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13104 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13105 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13106 .row &%print_topbitchars%&           "top-bit characters are printing"
13107 .row &%timezone%&                    "force time zone"
13108 .endtable
13109
13110
13111 .section "Exim parameters" "SECID97"
13112 .table2
13113 .row &%exim_group%&                  "override compiled-in value"
13114 .row &%exim_path%&                   "override compiled-in value"
13115 .row &%exim_user%&                   "override compiled-in value"
13116 .row &%primary_hostname%&            "default from &[uname()]&"
13117 .row &%split_spool_directory%&       "use multiple directories"
13118 .row &%spool_directory%&             "override compiled-in value"
13119 .endtable
13120
13121
13122
13123 .section "Privilege controls" "SECID98"
13124 .table2
13125 .row &%admin_groups%&                "groups that are Exim admin users"
13126 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13127 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13128 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13129 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13130 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13131 .row &%never_users%&                 "do not run deliveries as these"
13132 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13133 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13134 .row &%trusted_groups%&              "groups that are trusted"
13135 .row &%trusted_users%&               "users that are trusted"
13136 .endtable
13137
13138
13139
13140 .section "Logging" "SECID99"
13141 .table2
13142 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13143 .row &%log_file_path%&               "override compiled-in value"
13144 .row &%log_selector%&                "set/unset optional logging"
13145 .row &%log_timezone%&                "add timezone to log lines"
13146 .row &%message_logs%&                "create per-message logs"
13147 .row &%preserve_message_logs%&       "after message completion"
13148 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13149 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13150 .row &%syslog_facility%&             "set syslog &""facility""& field"
13151 .row &%syslog_processname%&          "set syslog &""ident""& field"
13152 .row &%syslog_timestamp%&            "timestamp syslog lines"
13153 .row &%write_rejectlog%&             "control use of message log"
13154 .endtable
13155
13156
13157
13158 .section "Frozen messages" "SECID100"
13159 .table2
13160 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13161 .row &%freeze_tell%&                 "send message when freezing"
13162 .row &%move_frozen_messages%&        "to another directory"
13163 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13164 .endtable
13165
13166
13167
13168 .section "Data lookups" "SECID101"
13169 .table2
13170 .row &%ibase_servers%&               "InterBase servers"
13171 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13172 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13173 .row &%ldap_cert_file%&              "client cert file for LDAP"
13174 .row &%ldap_cert_key%&               "client key file for LDAP"
13175 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13176 .row &%ldap_default_servers%&        "used if no server in query"
13177 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13178 .row &%ldap_start_tls%&              "require TLS within LDAP"
13179 .row &%ldap_version%&                "set protocol version"
13180 .row &%lookup_open_max%&             "lookup files held open"
13181 .row &%mysql_servers%&               "default MySQL servers"
13182 .row &%oracle_servers%&              "Oracle servers"
13183 .row &%pgsql_servers%&               "default PostgreSQL servers"
13184 .row &%sqlite_lock_timeout%&         "as it says"
13185 .endtable
13186
13187
13188
13189 .section "Message ids" "SECID102"
13190 .table2
13191 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13192 .row &%message_id_header_text%&      "ditto"
13193 .endtable
13194
13195
13196
13197 .section "Embedded Perl Startup" "SECID103"
13198 .table2
13199 .row &%perl_at_start%&               "always start the interpreter"
13200 .row &%perl_startup%&                "code to obey when starting Perl"
13201 .endtable
13202
13203
13204
13205 .section "Daemon" "SECID104"
13206 .table2
13207 .row &%daemon_smtp_ports%&           "default ports"
13208 .row &%daemon_startup_retries%&      "number of times to retry"
13209 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13210 .row &%extra_local_interfaces%&      "not necessarily listened on"
13211 .row &%local_interfaces%&            "on which to listen, with optional ports"
13212 .row &%pid_file_path%&               "override compiled-in value"
13213 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13214 .endtable
13215
13216
13217
13218 .section "Resource control" "SECID105"
13219 .table2
13220 .row &%check_log_inodes%&            "before accepting a message"
13221 .row &%check_log_space%&             "before accepting a message"
13222 .row &%check_spool_inodes%&          "before accepting a message"
13223 .row &%check_spool_space%&           "before accepting a message"
13224 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13225 .row &%queue_only_load%&             "queue incoming if load high"
13226 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13227 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13228 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13229 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13230 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13231 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13232 .row &%smtp_accept_max_per_connection%& "messages per connection"
13233 .row &%smtp_accept_max_per_host%&    "connections from one host"
13234 .row &%smtp_accept_queue%&           "queue mail if more connections"
13235 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13236                                            connection"
13237 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13238 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13239 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13240 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13241 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13242 .endtable
13243
13244
13245
13246 .section "Policy controls" "SECID106"
13247 .table2
13248 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13249 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13250 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13251 .row &%acl_smtp_auth%&               "ACL for AUTH"
13252 .row &%acl_smtp_connect%&            "ACL for connection"
13253 .row &%acl_smtp_data%&               "ACL for DATA"
13254 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13255 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13256 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13257 .row &%acl_smtp_expn%&               "ACL for EXPN"
13258 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13259 .row &%acl_smtp_mail%&               "ACL for MAIL"
13260 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13261 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13262 .row &%acl_smtp_predata%&            "ACL for start of data"
13263 .row &%acl_smtp_quit%&               "ACL for QUIT"
13264 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13265 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13266 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13267 .row &%av_scanner%&                  "specify virus scanner"
13268 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13269                                       words""&"
13270 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13271 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13272 .row &%header_maxsize%&              "total size of message header"
13273 .row &%header_line_maxsize%&         "individual header line limit"
13274 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13275 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13276 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13277 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13278 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13279 .row &%host_lookup%&                 "host name looked up for these hosts"
13280 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13281 .row &%host_reject_connection%&      "reject connection from these hosts"
13282 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13283 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13284 .row &%message_size_limit%&          "for all messages"
13285 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13286 .row &%spamd_address%&               "set interface to SpamAssassin"
13287 .row &%strict_acl_vars%&             "object to unset ACL variables"
13288 .endtable
13289
13290
13291
13292 .section "Callout cache" "SECID107"
13293 .table2
13294 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13295                                          item"
13296 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13297                                          item"
13298 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13299 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13300 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13301 .endtable
13302
13303
13304
13305 .section "TLS" "SECID108"
13306 .table2
13307 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13308 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13309 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13310 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13311 .row &%tls_certificate%&             "location of server certificate"
13312 .row &%tls_crl%&                     "certificate revocation list"
13313 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13314 .row &%tls_dhparam%&                 "DH parameters for server"
13315 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13316 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13317 .row &%tls_privatekey%&              "location of server private key"
13318 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13319 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13320 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13321 .row &%tls_verify_certificates%&     "expected client certificates"
13322 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13323 .endtable
13324
13325
13326
13327 .section "Local user handling" "SECID109"
13328 .table2
13329 .row &%finduser_retries%&            "useful in NIS environments"
13330 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13331 .row &%gecos_pattern%&               "ditto"
13332 .row &%max_username_length%&         "for systems that truncate"
13333 .row &%unknown_login%&               "used when no login name found"
13334 .row &%unknown_username%&            "ditto"
13335 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13336 .row &%uucp_from_sender%&            "ditto"
13337 .endtable
13338
13339
13340
13341 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13342 .table2
13343 .row &%header_maxsize%&              "total size of message header"
13344 .row &%header_line_maxsize%&         "individual header line limit"
13345 .row &%message_size_limit%&          "applies to all messages"
13346 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13347 .row &%received_header_text%&        "expanded to make &'Received:'&"
13348 .row &%received_headers_max%&        "for mail loop detection"
13349 .row &%recipients_max%&              "limit per message"
13350 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13351 .endtable
13352
13353
13354
13355
13356 .section "Non-SMTP incoming messages" "SECID111"
13357 .table2
13358 .row &%receive_timeout%&             "for non-SMTP messages"
13359 .endtable
13360
13361
13362
13363
13364
13365 .section "Incoming SMTP messages" "SECID112"
13366 See also the &'Policy controls'& section above.
13367
13368 .table2
13369 .row &%host_lookup%&                 "host name looked up for these hosts"
13370 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13371 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13372 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13373 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13374 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13375 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13376 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13377 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13378 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13379 .row &%smtp_accept_max_per_connection%& "messages per connection"
13380 .row &%smtp_accept_max_per_host%&    "connections from one host"
13381 .row &%smtp_accept_queue%&           "queue mail if more connections"
13382 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13383                                            connection"
13384 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13385 .row &%smtp_active_hostname%&        "host name to use in messages"
13386 .row &%smtp_banner%&                 "text for welcome banner"
13387 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13388 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13389 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13390 .row &%smtp_etrn_command%&           "what to run for ETRN"
13391 .row &%smtp_etrn_serialize%&         "only one at once"
13392 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13393 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13394 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13395 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13396 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13397 .row &%smtp_receive_timeout%&        "per command or data line"
13398 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13399 .row &%smtp_return_error_details%&   "give detail on rejections"
13400 .endtable
13401
13402
13403
13404 .section "SMTP extensions" "SECID113"
13405 .table2
13406 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13407 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13408 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13409 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13410 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13411 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13412 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13413 .endtable
13414
13415
13416
13417 .section "Processing messages" "SECID114"
13418 .table2
13419 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13420 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13421 .row &%allow_utf8_domains%&          "in addresses"
13422 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13423                                       words""&"
13424 .row &%delivery_date_remove%&        "from incoming messages"
13425 .row &%envelope_to_remove%&          "from incoming messages"
13426 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13427 .row &%headers_charset%&             "default for translations"
13428 .row &%qualify_domain%&              "default for senders"
13429 .row &%qualify_recipient%&           "default for recipients"
13430 .row &%return_path_remove%&          "from incoming messages"
13431 .row &%strip_excess_angle_brackets%& "in addresses"
13432 .row &%strip_trailing_dot%&          "at end of addresses"
13433 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13434 .endtable
13435
13436
13437
13438 .section "System filter" "SECID115"
13439 .table2
13440 .row &%system_filter%&               "locate system filter"
13441 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13442                                             directory"
13443 .row &%system_filter_file_transport%& "transport for delivery to a file"
13444 .row &%system_filter_group%&         "group for filter running"
13445 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13446 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13447 .row &%system_filter_user%&          "user for filter running"
13448 .endtable
13449
13450
13451
13452 .section "Routing and delivery" "SECID116"
13453 .table2
13454 .row &%disable_ipv6%&                "do no IPv6 processing"
13455 .row &%dns_again_means_nonexist%&    "for broken domains"
13456 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13457 .row &%dns_dnssec_ok%&               "parameter for resolver"
13458 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13459 .row &%dns_retrans%&                 "parameter for resolver"
13460 .row &%dns_retry%&                   "parameter for resolver"
13461 .row &%dns_use_edns0%&               "parameter for resolver"
13462 .row &%hold_domains%&                "hold delivery for these domains"
13463 .row &%local_interfaces%&            "for routing checks"
13464 .row &%queue_domains%&               "no immediate delivery for these"
13465 .row &%queue_only%&                  "no immediate delivery at all"
13466 .row &%queue_only_file%&             "no immediate delivery if file exists"
13467 .row &%queue_only_load%&             "no immediate delivery if load is high"
13468 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13469 .row &%queue_only_override%&         "allow command line to override"
13470 .row &%queue_run_in_order%&          "order of arrival"
13471 .row &%queue_run_max%&               "of simultaneous queue runners"
13472 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13473 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13474 .row &%remote_sort_domains%&         "order of remote deliveries"
13475 .row &%retry_data_expire%&           "timeout for retry data"
13476 .row &%retry_interval_max%&          "safety net for retry rules"
13477 .endtable
13478
13479
13480
13481 .section "Bounce and warning messages" "SECID117"
13482 .table2
13483 .row &%bounce_message_file%&         "content of bounce"
13484 .row &%bounce_message_text%&         "content of bounce"
13485 .row &%bounce_return_body%&          "include body if returning message"
13486 .row &%bounce_return_message%&       "include original message in bounce"
13487 .row &%bounce_return_size_limit%&    "limit on returned message"
13488 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13489 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13490 .row &%errors_copy%&                 "copy bounce messages"
13491 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13492 .row &%delay_warning%&               "time schedule"
13493 .row &%delay_warning_condition%&     "condition for warning messages"
13494 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13495 .row &%smtp_return_error_details%&   "give detail on rejections"
13496 .row &%warn_message_file%&           "content of warning message"
13497 .endtable
13498
13499
13500
13501 .section "Alphabetical list of main options" "SECTalomo"
13502 Those options that undergo string expansion before use are marked with
13503 &dagger;.
13504
13505 .option accept_8bitmime main boolean true
13506 .cindex "8BITMIME"
13507 .cindex "8-bit characters"
13508 .cindex "log" "selectors"
13509 .cindex "log" "8BITMIME"
13510 This option causes Exim to send 8BITMIME in its response to an SMTP
13511 EHLO command, and to accept the BODY= parameter on MAIL commands.
13512 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13513 takes no steps to do anything special with messages received by this route.
13514
13515 Historically Exim kept this option off by default, but the maintainers
13516 feel that in today's Internet, this causes more problems than it solves.
13517 It now defaults to true.
13518 A more detailed analysis of the issues is provided by Dan Bernstein:
13519 .display
13520 &url(http://cr.yp.to/smtp/8bitmime.html)
13521 .endd
13522
13523 To log received 8BITMIME status use
13524 .code
13525 log_selector = +8bitmime
13526 .endd
13527
13528 .option acl_not_smtp main string&!! unset
13529 .cindex "&ACL;" "for non-SMTP messages"
13530 .cindex "non-SMTP messages" "ACLs for"
13531 This option defines the ACL that is run when a non-SMTP message has been
13532 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13533 further details.
13534
13535 .option acl_not_smtp_mime main string&!! unset
13536 This option defines the ACL that is run for individual MIME parts of non-SMTP
13537 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13538 SMTP messages.
13539
13540 .option acl_not_smtp_start main string&!! unset
13541 .cindex "&ACL;" "at start of non-SMTP message"
13542 .cindex "non-SMTP messages" "ACLs for"
13543 This option defines the ACL that is run before Exim starts reading a
13544 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13545
13546 .option acl_smtp_auth main string&!! unset
13547 .cindex "&ACL;" "setting up for SMTP commands"
13548 .cindex "AUTH" "ACL for"
13549 This option defines the ACL that is run when an SMTP AUTH command is
13550 received. See chapter &<<CHAPACL>>& for further details.
13551
13552 .option acl_smtp_connect main string&!! unset
13553 .cindex "&ACL;" "on SMTP connection"
13554 This option defines the ACL that is run when an SMTP connection is received.
13555 See chapter &<<CHAPACL>>& for further details.
13556
13557 .option acl_smtp_data main string&!! unset
13558 .cindex "DATA" "ACL for"
13559 This option defines the ACL that is run after an SMTP DATA command has been
13560 processed and the message itself has been received, but before the final
13561 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13562
13563 .option acl_smtp_data_prdr main string&!! unset
13564 .cindex "DATA" "ACL for"
13565 .cindex "&ACL;" "PRDR-related"
13566 .cindex "&ACL;" "per-user data processing"
13567 This option defines the ACL that,
13568 if the PRDR feature has been negotiated,
13569 is run for each recipient after an SMTP DATA command has been
13570 processed and the message itself has been received, but before the
13571 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13572
13573 .option acl_smtp_etrn main string&!! unset
13574 .cindex "ETRN" "ACL for"
13575 This option defines the ACL that is run when an SMTP ETRN command is
13576 received. See chapter &<<CHAPACL>>& for further details.
13577
13578 .option acl_smtp_expn main string&!! unset
13579 .cindex "EXPN" "ACL for"
13580 This option defines the ACL that is run when an SMTP EXPN command is
13581 received. See chapter &<<CHAPACL>>& for further details.
13582
13583 .option acl_smtp_helo main string&!! unset
13584 .cindex "EHLO" "ACL for"
13585 .cindex "HELO" "ACL for"
13586 This option defines the ACL that is run when an SMTP EHLO or HELO
13587 command is received. See chapter &<<CHAPACL>>& for further details.
13588
13589
13590 .option acl_smtp_mail main string&!! unset
13591 .cindex "MAIL" "ACL for"
13592 This option defines the ACL that is run when an SMTP MAIL command is
13593 received. See chapter &<<CHAPACL>>& for further details.
13594
13595 .option acl_smtp_mailauth main string&!! unset
13596 .cindex "AUTH" "on MAIL command"
13597 This option defines the ACL that is run when there is an AUTH parameter on
13598 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13599 &<<CHAPSMTPAUTH>>& for details of authentication.
13600
13601 .option acl_smtp_mime main string&!! unset
13602 .cindex "MIME content scanning" "ACL for"
13603 This option is available when Exim is built with the content-scanning
13604 extension. It defines the ACL that is run for each MIME part in a message. See
13605 section &<<SECTscanmimepart>>& for details.
13606
13607 .option acl_smtp_predata main string&!! unset
13608 This option defines the ACL that is run when an SMTP DATA command is
13609 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13610 further details.
13611
13612 .option acl_smtp_quit main string&!! unset
13613 .cindex "QUIT, ACL for"
13614 This option defines the ACL that is run when an SMTP QUIT command is
13615 received. See chapter &<<CHAPACL>>& for further details.
13616
13617 .option acl_smtp_rcpt main string&!! unset
13618 .cindex "RCPT" "ACL for"
13619 This option defines the ACL that is run when an SMTP RCPT command is
13620 received. See chapter &<<CHAPACL>>& for further details.
13621
13622 .option acl_smtp_starttls main string&!! unset
13623 .cindex "STARTTLS, ACL for"
13624 This option defines the ACL that is run when an SMTP STARTTLS command is
13625 received. See chapter &<<CHAPACL>>& for further details.
13626
13627 .option acl_smtp_vrfy main string&!! unset
13628 .cindex "VRFY" "ACL for"
13629 This option defines the ACL that is run when an SMTP VRFY command is
13630 received. See chapter &<<CHAPACL>>& for further details.
13631
13632 .option admin_groups main "string list&!!" unset
13633 .cindex "admin user"
13634 This option is expanded just once, at the start of Exim's processing. If the
13635 current group or any of the supplementary groups of an Exim caller is in this
13636 colon-separated list, the caller has admin privileges. If all your system
13637 programmers are in a specific group, for example, you can give them all Exim
13638 admin privileges by putting that group in &%admin_groups%&. However, this does
13639 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13640 To permit this, you have to add individuals to the Exim group.
13641
13642 .option allow_domain_literals main boolean false
13643 .cindex "domain literal"
13644 If this option is set, the RFC 2822 domain literal format is permitted in
13645 email addresses. The option is not set by default, because the domain literal
13646 format is not normally required these days, and few people know about it. It
13647 has, however, been exploited by mail abusers.
13648
13649 Unfortunately, it seems that some DNS black list maintainers are using this
13650 format to report black listing to postmasters. If you want to accept messages
13651 addressed to your hosts by IP address, you need to set
13652 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13653 domains (defined in the named domain list &%local_domains%& in the default
13654 configuration). This &"magic string"& matches the domain literal form of all
13655 the local host's IP addresses.
13656
13657
13658 .option allow_mx_to_ip main boolean false
13659 .cindex "MX record" "pointing to IP address"
13660 It appears that more and more DNS zone administrators are breaking the rules
13661 and putting domain names that look like IP addresses on the right hand side of
13662 MX records. Exim follows the rules and rejects this, giving an error message
13663 that explains the mis-configuration. However, some other MTAs support this
13664 practice, so to avoid &"Why can't Exim do this?"& complaints,
13665 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13666 recommended, except when you have no other choice.
13667
13668 .option allow_utf8_domains main boolean false
13669 .cindex "domain" "UTF-8 characters in"
13670 .cindex "UTF-8" "in domain name"
13671 Lots of discussion is going on about internationalized domain names. One
13672 camp is strongly in favour of just using UTF-8 characters, and it seems
13673 that at least two other MTAs permit this. This option allows Exim users to
13674 experiment if they wish.
13675
13676 If it is set true, Exim's domain parsing function allows valid
13677 UTF-8 multicharacters to appear in domain name components, in addition to
13678 letters, digits, and hyphens. However, just setting this option is not
13679 enough; if you want to look up these domain names in the DNS, you must also
13680 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13681 suitable setting is:
13682 .code
13683 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13684   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13685 .endd
13686 Alternatively, you can just disable this feature by setting
13687 .code
13688 dns_check_names_pattern =
13689 .endd
13690 That is, set the option to an empty string so that no check is done.
13691
13692
13693 .option auth_advertise_hosts main "host list&!!" *
13694 .cindex "authentication" "advertising"
13695 .cindex "AUTH" "advertising"
13696 If any server authentication mechanisms are configured, Exim advertises them in
13697 response to an EHLO command only if the calling host matches this list.
13698 Otherwise, Exim does not advertise AUTH.
13699 Exim does not accept AUTH commands from clients to which it has not
13700 advertised the availability of AUTH. The advertising of individual
13701 authentication mechanisms can be controlled by the use of the
13702 &%server_advertise_condition%& generic authenticator option on the individual
13703 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13704
13705 Certain mail clients (for example, Netscape) require the user to provide a name
13706 and password for authentication if AUTH is advertised, even though it may
13707 not be needed (the host may accept messages from hosts on its local LAN without
13708 authentication, for example). The &%auth_advertise_hosts%& option can be used
13709 to make these clients more friendly by excluding them from the set of hosts to
13710 which Exim advertises AUTH.
13711
13712 .cindex "AUTH" "advertising when encrypted"
13713 If you want to advertise the availability of AUTH only when the connection
13714 is encrypted using TLS, you can make use of the fact that the value of this
13715 option is expanded, with a setting like this:
13716 .code
13717 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13718 .endd
13719 .vindex "&$tls_in_cipher$&"
13720 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13721 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13722 expansion is *, which matches all hosts.
13723
13724
13725 .option auto_thaw main time 0s
13726 .cindex "thawing messages"
13727 .cindex "unfreezing messages"
13728 If this option is set to a time greater than zero, a queue runner will try a
13729 new delivery attempt on any frozen message, other than a bounce message, if
13730 this much time has passed since it was frozen. This may result in the message
13731 being re-frozen if nothing has changed since the last attempt. It is a way of
13732 saying &"keep on trying, even though there are big problems"&.
13733
13734 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13735 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13736 thought to be very useful any more, and its use should probably be avoided.
13737
13738
13739 .option av_scanner main string "see below"
13740 This option is available if Exim is built with the content-scanning extension.
13741 It specifies which anti-virus scanner to use. The default value is:
13742 .code
13743 sophie:/var/run/sophie
13744 .endd
13745 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13746 before use. See section &<<SECTscanvirus>>& for further details.
13747
13748
13749 .option bi_command main string unset
13750 .oindex "&%-bi%&"
13751 This option supplies the name of a command that is run when Exim is called with
13752 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13753 just the command name, it is not a complete command line. If an argument is
13754 required, it must come from the &%-oA%& command line option.
13755
13756
13757 .option bounce_message_file main string unset
13758 .cindex "bounce message" "customizing"
13759 .cindex "customizing" "bounce message"
13760 This option defines a template file containing paragraphs of text to be used
13761 for constructing bounce messages.  Details of the file's contents are given in
13762 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13763
13764
13765 .option bounce_message_text main string unset
13766 When this option is set, its contents are included in the default bounce
13767 message immediately after &"This message was created automatically by mail
13768 delivery software."& It is not used if &%bounce_message_file%& is set.
13769
13770 .option bounce_return_body main boolean true
13771 .cindex "bounce message" "including body"
13772 This option controls whether the body of an incoming message is included in a
13773 bounce message when &%bounce_return_message%& is true. The default setting
13774 causes the entire message, both header and body, to be returned (subject to the
13775 value of &%bounce_return_size_limit%&). If this option is false, only the
13776 message header is included. In the case of a non-SMTP message containing an
13777 error that is detected during reception, only those header lines preceding the
13778 point at which the error was detected are returned.
13779 .cindex "bounce message" "including original"
13780
13781 .option bounce_return_message main boolean true
13782 If this option is set false, none of the original message is included in
13783 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13784 &%bounce_return_body%&.
13785
13786
13787 .option bounce_return_size_limit main integer 100K
13788 .cindex "size" "of bounce, limit"
13789 .cindex "bounce message" "size limit"
13790 .cindex "limit" "bounce message size"
13791 This option sets a limit in bytes on the size of messages that are returned to
13792 senders as part of bounce messages when &%bounce_return_message%& is true. The
13793 limit should be less than the value of the global &%message_size_limit%& and of
13794 any &%message_size_limit%& settings on transports, to allow for the bounce text
13795 that Exim generates. If this option is set to zero there is no limit.
13796
13797 When the body of any message that is to be included in a bounce message is
13798 greater than the limit, it is truncated, and a comment pointing this out is
13799 added at the top. The actual cutoff may be greater than the value given, owing
13800 to the use of buffering for transferring the message in chunks (typically 8K in
13801 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13802 messages.
13803
13804 .option bounce_sender_authentication main string unset
13805 .cindex "bounce message" "sender authentication"
13806 .cindex "authentication" "bounce message"
13807 .cindex "AUTH" "on bounce message"
13808 This option provides an authenticated sender address that is sent with any
13809 bounce messages generated by Exim that are sent over an authenticated SMTP
13810 connection. A typical setting might be:
13811 .code
13812 bounce_sender_authentication = mailer-daemon@my.domain.example
13813 .endd
13814 which would cause bounce messages to be sent using the SMTP command:
13815 .code
13816 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13817 .endd
13818 The value of &%bounce_sender_authentication%& must always be a complete email
13819 address.
13820
13821 .option callout_domain_negative_expire main time 3h
13822 .cindex "caching" "callout timeouts"
13823 .cindex "callout" "caching timeouts"
13824 This option specifies the expiry time for negative callout cache data for a
13825 domain. See section &<<SECTcallver>>& for details of callout verification, and
13826 section &<<SECTcallvercache>>& for details of the caching.
13827
13828
13829 .option callout_domain_positive_expire main time 7d
13830 This option specifies the expiry time for positive callout cache data for a
13831 domain. See section &<<SECTcallver>>& for details of callout verification, and
13832 section &<<SECTcallvercache>>& for details of the caching.
13833
13834
13835 .option callout_negative_expire main time 2h
13836 This option specifies the expiry time for negative callout cache data for an
13837 address. See section &<<SECTcallver>>& for details of callout verification, and
13838 section &<<SECTcallvercache>>& for details of the caching.
13839
13840
13841 .option callout_positive_expire main time 24h
13842 This option specifies the expiry time for positive callout cache data for an
13843 address. See section &<<SECTcallver>>& for details of callout verification, and
13844 section &<<SECTcallvercache>>& for details of the caching.
13845
13846
13847 .option callout_random_local_part main string&!! "see below"
13848 This option defines the &"random"& local part that can be used as part of
13849 callout verification. The default value is
13850 .code
13851 $primary_hostname-$tod_epoch-testing
13852 .endd
13853 See section &<<CALLaddparcall>>& for details of how this value is used.
13854
13855
13856 .option check_log_inodes main integer 0
13857 See &%check_spool_space%& below.
13858
13859
13860 .option check_log_space main integer 0
13861 See &%check_spool_space%& below.
13862
13863 .oindex "&%check_rfc2047_length%&"
13864 .cindex "RFC 2047" "disabling length check"
13865 .option check_rfc2047_length main boolean true
13866 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13867 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13868 word; strings to be encoded that exceed this length are supposed to use
13869 multiple encoded words. By default, Exim does not recognize encoded words that
13870 exceed the maximum length. However, it seems that some software, in violation
13871 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13872 set false, Exim recognizes encoded words of any length.
13873
13874
13875 .option check_spool_inodes main integer 0
13876 See &%check_spool_space%& below.
13877
13878
13879 .option check_spool_space main integer 0
13880 .cindex "checking disk space"
13881 .cindex "disk space, checking"
13882 .cindex "spool directory" "checking space"
13883 The four &%check_...%& options allow for checking of disk resources before a
13884 message is accepted.
13885
13886 .vindex "&$log_inodes$&"
13887 .vindex "&$log_space$&"
13888 .vindex "&$spool_inodes$&"
13889 .vindex "&$spool_space$&"
13890 When any of these options are set, they apply to all incoming messages. If you
13891 want to apply different checks to different kinds of message, you can do so by
13892 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13893 &$spool_space$& in an ACL with appropriate additional conditions.
13894
13895
13896 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13897 either value is greater than zero, for example:
13898 .code
13899 check_spool_space = 10M
13900 check_spool_inodes = 100
13901 .endd
13902 The spool partition is the one that contains the directory defined by
13903 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13904 transit.
13905
13906 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13907 files are written if either is greater than zero. These should be set only if
13908 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13909
13910 If there is less space or fewer inodes than requested, Exim refuses to accept
13911 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13912 error response to the MAIL command. If ESMTP is in use and there was a
13913 SIZE parameter on the MAIL command, its value is added to the
13914 &%check_spool_space%& value, and the check is performed even if
13915 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13916
13917 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13918 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13919
13920 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13921 failure a message is written to stderr and Exim exits with a non-zero code, as
13922 it obviously cannot send an error message of any kind.
13923
13924 .option daemon_smtp_ports main string &`smtp`&
13925 .cindex "port" "for daemon"
13926 .cindex "TCP/IP" "setting listening ports"
13927 This option specifies one or more default SMTP ports on which the Exim daemon
13928 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13929 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13930
13931 .option daemon_startup_retries main integer 9
13932 .cindex "daemon startup, retrying"
13933 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13934 the daemon at startup when it cannot immediately bind a listening socket
13935 (typically because the socket is already in use): &%daemon_startup_retries%&
13936 defines the number of retries after the first failure, and
13937 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13938
13939 .option daemon_startup_sleep main time 30s
13940 See &%daemon_startup_retries%&.
13941
13942 .option delay_warning main "time list" 24h
13943 .cindex "warning of delay"
13944 .cindex "delay warning, specifying"
13945 When a message is delayed, Exim sends a warning message to the sender at
13946 intervals specified by this option. The data is a colon-separated list of times
13947 after which to send warning messages. If the value of the option is an empty
13948 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13949 message has been on the queue for longer than the last time, the last interval
13950 between the times is used to compute subsequent warning times. For example,
13951 with
13952 .code
13953 delay_warning = 4h:8h:24h
13954 .endd
13955 the first message is sent after 4 hours, the second after 8 hours, and
13956 the third one after 24 hours. After that, messages are sent every 16 hours,
13957 because that is the interval between the last two times on the list. If you set
13958 just one time, it specifies the repeat interval. For example, with:
13959 .code
13960 delay_warning = 6h
13961 .endd
13962 messages are repeated every six hours. To stop warnings after a given time, set
13963 a very large time at the end of the list. For example:
13964 .code
13965 delay_warning = 2h:12h:99d
13966 .endd
13967 Note that the option is only evaluated at the time a delivery attempt fails,
13968 which depends on retry and queue-runner configuration.
13969 Typically retries will be configured more frequently than warning messages.
13970
13971 .option delay_warning_condition main string&!! "see below"
13972 .vindex "&$domain$&"
13973 The string is expanded at the time a warning message might be sent. If all the
13974 deferred addresses have the same domain, it is set in &$domain$& during the
13975 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13976 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13977 &"false"& (the comparison being done caselessly) then the warning message is
13978 not sent. The default is:
13979 .code
13980 delay_warning_condition = ${if or {\
13981   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13982   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13983   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13984   } {no}{yes}}
13985 .endd
13986 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13987 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13988 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13989 &"auto-replied"& in an &'Auto-Submitted:'& header.
13990
13991 .option deliver_drop_privilege main boolean false
13992 .cindex "unprivileged delivery"
13993 .cindex "delivery" "unprivileged"
13994 If this option is set true, Exim drops its root privilege at the start of a
13995 delivery process, and runs as the Exim user throughout. This severely restricts
13996 the kinds of local delivery that are possible, but is viable in certain types
13997 of configuration. There is a discussion about the use of root privilege in
13998 chapter &<<CHAPsecurity>>&.
13999
14000 .option deliver_queue_load_max main fixed-point unset
14001 .cindex "load average"
14002 .cindex "queue runner" "abandoning"
14003 When this option is set, a queue run is abandoned if the system load average
14004 becomes greater than the value of the option. The option has no effect on
14005 ancient operating systems on which Exim cannot determine the load average.
14006 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14007
14008
14009 .option delivery_date_remove main boolean true
14010 .cindex "&'Delivery-date:'& header line"
14011 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14012 message when it is delivered, in exactly the same way as &'Return-path:'& is
14013 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14014 should not be present in incoming messages, and this option causes them to be
14015 removed at the time the message is received, to avoid any problems that might
14016 occur when a delivered message is subsequently sent on to some other recipient.
14017
14018 .option disable_fsync main boolean false
14019 .cindex "&[fsync()]&, disabling"
14020 This option is available only if Exim was built with the compile-time option
14021 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14022 a runtime configuration generates an &"unknown option"& error. You should not
14023 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14024 really, really, really understand what you are doing. &'No pre-compiled
14025 distributions of Exim should ever make this option available.'&
14026
14027 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14028 updated files' data to be written to disc before continuing. Unexpected events
14029 such as crashes and power outages may cause data to be lost or scrambled.
14030 Here be Dragons. &*Beware.*&
14031
14032
14033 .option disable_ipv6 main boolean false
14034 .cindex "IPv6" "disabling"
14035 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14036 activities take place. AAAA records are never looked up, and any IPv6 addresses
14037 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14038 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14039 to handle IPv6 literal addresses.
14040
14041
14042 .option dns_again_means_nonexist main "domain list&!!" unset
14043 .cindex "DNS" "&""try again""& response; overriding"
14044 DNS lookups give a &"try again"& response for the DNS errors
14045 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14046 keep trying to deliver a message, or to give repeated temporary errors to
14047 incoming mail. Sometimes the effect is caused by a badly set up name server and
14048 may persist for a long time. If a domain which exhibits this problem matches
14049 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14050 This option should be used with care. You can make it apply to reverse lookups
14051 by a setting such as this:
14052 .code
14053 dns_again_means_nonexist = *.in-addr.arpa
14054 .endd
14055 This option applies to all DNS lookups that Exim does. It also applies when the
14056 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14057 since these are most likely to be caused by DNS lookup problems. The
14058 &(dnslookup)& router has some options of its own for controlling what happens
14059 when lookups for MX or SRV records give temporary errors. These more specific
14060 options are applied after this global option.
14061
14062 .option dns_check_names_pattern main string "see below"
14063 .cindex "DNS" "pre-check of name syntax"
14064 When this option is set to a non-empty string, it causes Exim to check domain
14065 names for characters that are not allowed in host names before handing them to
14066 the DNS resolver, because some resolvers give temporary errors for names that
14067 contain unusual characters. If a domain name contains any unwanted characters,
14068 a &"not found"& result is forced, and the resolver is not called. The check is
14069 done by matching the domain name against a regular expression, which is the
14070 value of this option. The default pattern is
14071 .code
14072 dns_check_names_pattern = \
14073   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14074 .endd
14075 which permits only letters, digits, slashes, and hyphens in components, but
14076 they must start and end with a letter or digit. Slashes are not, in fact,
14077 permitted in host names, but they are found in certain NS records (which can be
14078 accessed in Exim by using a &%dnsdb%& lookup). If you set
14079 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14080 empty string.
14081
14082 .option dns_csa_search_limit main integer 5
14083 This option controls the depth of parental searching for CSA SRV records in the
14084 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14085
14086 .option dns_csa_use_reverse main boolean true
14087 This option controls whether or not an IP address, given as a CSA domain, is
14088 reversed and looked up in the reverse DNS, as described in more detail in
14089 section &<<SECTverifyCSA>>&.
14090
14091
14092 .option dns_dnssec_ok main integer -1
14093 .cindex "DNS" "resolver options"
14094 .cindex "DNS" "DNSSEC"
14095 If this option is set to a non-negative number then Exim will initialise the
14096 DNS resolver library to either use or not use DNSSEC, overriding the system
14097 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14098
14099 If the resolver library does not support DNSSEC then this option has no effect.
14100
14101
14102 .option dns_ipv4_lookup main "domain list&!!" unset
14103 .cindex "IPv6" "DNS lookup for AAAA records"
14104 .cindex "DNS" "IPv6 lookup for AAAA records"
14105 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14106 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14107 (A records) when trying to find IP addresses for hosts, unless the host's
14108 domain matches this list.
14109
14110 This is a fudge to help with name servers that give big delays or otherwise do
14111 not work for the AAAA record type. In due course, when the world's name
14112 servers have all been upgraded, there should be no need for this option.
14113
14114
14115 .option dns_retrans main time 0s
14116 .cindex "DNS" "resolver options"
14117 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14118 retransmission and retry parameters for DNS lookups. Values of zero (the
14119 defaults) leave the system default settings unchanged. The first value is the
14120 time between retries, and the second is the number of retries. It isn't
14121 totally clear exactly how these settings affect the total time a DNS lookup may
14122 take. I haven't found any documentation about timeouts on DNS lookups; these
14123 parameter values are available in the external resolver interface structure,
14124 but nowhere does it seem to describe how they are used or what you might want
14125 to set in them.
14126
14127
14128 .option dns_retry main integer 0
14129 See &%dns_retrans%& above.
14130
14131
14132 .option dns_use_edns0 main integer -1
14133 .cindex "DNS" "resolver options"
14134 .cindex "DNS" "EDNS0"
14135 If this option is set to a non-negative number then Exim will initialise the
14136 DNS resolver library to either use or not use EDNS0 extensions, overriding
14137 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14138 on.
14139
14140 If the resolver library does not support EDNS0 then this option has no effect.
14141
14142
14143 .option drop_cr main boolean false
14144 This is an obsolete option that is now a no-op. It used to affect the way Exim
14145 handled CR and LF characters in incoming messages. What happens now is
14146 described in section &<<SECTlineendings>>&.
14147
14148 .option dsn_from main "string&!!" "see below"
14149 .cindex "&'From:'& header line" "in bounces"
14150 .cindex "bounce messages" "&'From:'& line, specifying"
14151 This option can be used to vary the contents of &'From:'& header lines in
14152 bounces and other automatically generated messages (&"Delivery Status
14153 Notifications"& &-- hence the name of the option). The default setting is:
14154 .code
14155 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14156 .endd
14157 The value is expanded every time it is needed. If the expansion fails, a
14158 panic is logged, and the default value is used.
14159
14160 .option envelope_to_remove main boolean true
14161 .cindex "&'Envelope-to:'& header line"
14162 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14163 message when it is delivered, in exactly the same way as &'Return-path:'& is
14164 handled. &'Envelope-to:'& records the original recipient address from the
14165 messages's envelope that caused the delivery to happen. Such headers should not
14166 be present in incoming messages, and this option causes them to be removed at
14167 the time the message is received, to avoid any problems that might occur when a
14168 delivered message is subsequently sent on to some other recipient.
14169
14170
14171 .option errors_copy main "string list&!!" unset
14172 .cindex "bounce message" "copy to other address"
14173 .cindex "copy of bounce message"
14174 Setting this option causes Exim to send bcc copies of bounce messages that it
14175 generates to other addresses. &*Note*&: This does not apply to bounce messages
14176 coming from elsewhere. The value of the option is a colon-separated list of
14177 items. Each item consists of a pattern, terminated by white space, followed by
14178 a comma-separated list of email addresses. If a pattern contains spaces, it
14179 must be enclosed in double quotes.
14180
14181 Each pattern is processed in the same way as a single item in an address list
14182 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14183 the bounce message, the message is copied to the addresses on the list. The
14184 items are scanned in order, and once a matching one is found, no further items
14185 are examined. For example:
14186 .code
14187 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14188               rqps@mydomain   hostmaster@mydomain.example,\
14189                               postmaster@mydomain.example
14190 .endd
14191 .vindex "&$domain$&"
14192 .vindex "&$local_part$&"
14193 The address list is expanded before use. The expansion variables &$local_part$&
14194 and &$domain$& are set from the original recipient of the error message, and if
14195 there was any wildcard matching in the pattern, the expansion
14196 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14197 variables &$0$&, &$1$&, etc. are set in the normal way.
14198
14199
14200 .option errors_reply_to main string unset
14201 .cindex "bounce message" "&'Reply-to:'& in"
14202 By default, Exim's bounce and delivery warning messages contain the header line
14203 .display
14204 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14205 .endd
14206 .oindex &%quota_warn_message%&
14207 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14208 A warning message that is generated by the &%quota_warn_message%& option in an
14209 &(appendfile)& transport may contain its own &'From:'& header line that
14210 overrides the default.
14211
14212 Experience shows that people reply to bounce messages. If the
14213 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14214 and warning messages. For example:
14215 .code
14216 errors_reply_to = postmaster@my.domain.example
14217 .endd
14218 The value of the option is not expanded. It must specify a valid RFC 2822
14219 address. However, if a warning message that is generated by the
14220 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14221 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14222 not used.
14223
14224
14225 .option exim_group main string "compile-time configured"
14226 .cindex "gid (group id)" "Exim's own"
14227 .cindex "Exim group"
14228 This option changes the gid under which Exim runs when it gives up root
14229 privilege. The default value is compiled into the binary. The value of this
14230 option is used only when &%exim_user%& is also set. Unless it consists entirely
14231 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14232 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14233 security issues.
14234
14235
14236 .option exim_path main string "see below"
14237 .cindex "Exim binary, path name"
14238 This option specifies the path name of the Exim binary, which is used when Exim
14239 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14240 the directory configured at compile time by the BIN_DIRECTORY setting. It
14241 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14242 other place.
14243 &*Warning*&: Do not use a macro to define the value of this option, because
14244 you will break those Exim utilities that scan the configuration file to find
14245 where the binary is. (They then use the &%-bP%& option to extract option
14246 settings such as the value of &%spool_directory%&.)
14247
14248
14249 .option exim_user main string "compile-time configured"
14250 .cindex "uid (user id)" "Exim's own"
14251 .cindex "Exim user"
14252 This option changes the uid under which Exim runs when it gives up root
14253 privilege. The default value is compiled into the binary. Ownership of the run
14254 time configuration file and the use of the &%-C%& and &%-D%& command line
14255 options is checked against the values in the binary, not what is set here.
14256
14257 Unless it consists entirely of digits, the string is looked up using
14258 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14259 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14260 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14261
14262
14263 .option extra_local_interfaces main "string list" unset
14264 This option defines network interfaces that are to be considered local when
14265 routing, but which are not used for listening by the daemon. See section
14266 &<<SECTreclocipadd>>& for details.
14267
14268
14269 . Allow this long option name to split; give it unsplit as a fifth argument
14270 . for the automatic .oindex that is generated by .option.
14271
14272 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14273          extract_addresses_remove_arguments
14274 .oindex "&%-t%&"
14275 .cindex "command line" "addresses with &%-t%&"
14276 .cindex "Sendmail compatibility" "&%-t%& option"
14277 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14278 are present on the command line when the &%-t%& option is used to build an
14279 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14280 line addresses are removed from the recipients list. This is also how Smail
14281 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14282 command line addresses are added to those obtained from the header lines. When
14283 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14284 argument headers. If it is set false, Exim adds rather than removes argument
14285 addresses.
14286
14287
14288 .option finduser_retries main integer 0
14289 .cindex "NIS, retrying user lookups"
14290 On systems running NIS or other schemes in which user and group information is
14291 distributed from a remote system, there can be times when &[getpwnam()]& and
14292 related functions fail, even when given valid data, because things time out.
14293 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14294 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14295 many extra times to find a user or a group, waiting for one second between
14296 retries.
14297
14298 .cindex "&_/etc/passwd_&" "multiple reading of"
14299 You should not set this option greater than zero if your user information is in
14300 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14301 search the file multiple times for non-existent users, and also cause delay.
14302
14303
14304
14305 .option freeze_tell main "string list, comma separated" unset
14306 .cindex "freezing messages" "sending a message when freezing"
14307 On encountering certain errors, or when configured to do so in a system filter,
14308 ACL, or special router, Exim freezes a message. This means that no further
14309 delivery attempts take place until an administrator thaws the message, or the
14310 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14311 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14312 warning message whenever it freezes something, unless the message it is
14313 freezing is a locally-generated bounce message. (Without this exception there
14314 is the possibility of looping.) The warning message is sent to the addresses
14315 supplied as the comma-separated value of this option. If several of the
14316 message's addresses cause freezing, only a single message is sent. If the
14317 freezing was automatic, the reason(s) for freezing can be found in the message
14318 log. If you configure freezing in a filter or ACL, you must arrange for any
14319 logging that you require.
14320
14321
14322 .option gecos_name main string&!! unset
14323 .cindex "HP-UX"
14324 .cindex "&""gecos""& field, parsing"
14325 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14326 password file to hold other information in addition to users' real names. Exim
14327 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14328 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14329 of the field are used unchanged, except that, if an ampersand is encountered,
14330 it is replaced by the user's login name with the first character forced to
14331 upper case, since this is a convention that is observed on many systems.
14332
14333 When these options are set, &%gecos_pattern%& is treated as a regular
14334 expression that is to be applied to the field (again with && replaced by the
14335 login name), and if it matches, &%gecos_name%& is expanded and used as the
14336 user's name.
14337
14338 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14339 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14340 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14341 name terminates at the first comma, the following can be used:
14342 .code
14343 gecos_pattern = ([^,]*)
14344 gecos_name = $1
14345 .endd
14346
14347 .option gecos_pattern main string unset
14348 See &%gecos_name%& above.
14349
14350
14351 .option gnutls_compat_mode main boolean unset
14352 This option controls whether GnuTLS is used in compatibility mode in an Exim
14353 server. This reduces security slightly, but improves interworking with older
14354 implementations of TLS.
14355
14356
14357 option gnutls_allow_auto_pkcs11 main boolean unset
14358 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14359 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14360
14361 See
14362 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14363 for documentation.
14364
14365
14366
14367 .option headers_charset main string "see below"
14368 This option sets a default character set for translating from encoded MIME
14369 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14370 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14371 ultimate default is ISO-8859-1. For more details see the description of header
14372 insertions in section &<<SECTexpansionitems>>&.
14373
14374
14375
14376 .option header_maxsize main integer "see below"
14377 .cindex "header section" "maximum size of"
14378 .cindex "limit" "size of message header section"
14379 This option controls the overall maximum size of a message's header
14380 section. The default is the value of HEADER_MAXSIZE in
14381 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14382 sections are rejected.
14383
14384
14385 .option header_line_maxsize main integer 0
14386 .cindex "header lines" "maximum size of"
14387 .cindex "limit" "size of one header line"
14388 This option limits the length of any individual header line in a message, after
14389 all the continuations have been joined together. Messages with individual
14390 header lines that are longer than the limit are rejected. The default value of
14391 zero means &"no limit"&.
14392
14393
14394
14395
14396 .option helo_accept_junk_hosts main "host list&!!" unset
14397 .cindex "HELO" "accepting junk data"
14398 .cindex "EHLO" "accepting junk data"
14399 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14400 mail, and gives an error response for invalid data. Unfortunately, there are
14401 some SMTP clients that send syntactic junk. They can be accommodated by setting
14402 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14403 if you want to do semantic checking.
14404 See also &%helo_allow_chars%& for a way of extending the permitted character
14405 set.
14406
14407
14408 .option helo_allow_chars main string unset
14409 .cindex "HELO" "underscores in"
14410 .cindex "EHLO" "underscores in"
14411 .cindex "underscore in EHLO/HELO"
14412 This option can be set to a string of rogue characters that are permitted in
14413 all EHLO and HELO names in addition to the standard letters, digits,
14414 hyphens, and dots. If you really must allow underscores, you can set
14415 .code
14416 helo_allow_chars = _
14417 .endd
14418 Note that the value is one string, not a list.
14419
14420
14421 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14422 .cindex "HELO" "forcing reverse lookup"
14423 .cindex "EHLO" "forcing reverse lookup"
14424 If the domain given by a client in a HELO or EHLO command matches this
14425 list, a reverse lookup is done in order to establish the host's true name. The
14426 default forces a lookup if the client host gives the server's name or any of
14427 its IP addresses (in brackets), something that broken clients have been seen to
14428 do.
14429
14430
14431 .option helo_try_verify_hosts main "host list&!!" unset
14432 .cindex "HELO verifying" "optional"
14433 .cindex "EHLO" "verifying, optional"
14434 By default, Exim just checks the syntax of HELO and EHLO commands (see
14435 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14436 to do more extensive checking of the data supplied by these commands. The ACL
14437 condition &`verify = helo`& is provided to make this possible.
14438 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14439 to force the check to occur. From release 4.53 onwards, this is no longer
14440 necessary. If the check has not been done before &`verify = helo`& is
14441 encountered, it is done at that time. Consequently, this option is obsolete.
14442 Its specification is retained here for backwards compatibility.
14443
14444 When an EHLO or HELO command is received, if the calling host matches
14445 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14446 EHLO command either:
14447
14448 .ilist
14449 is an IP literal matching the calling address of the host, or
14450 .next
14451 .cindex "DNS" "reverse lookup"
14452 .cindex "reverse DNS lookup"
14453 matches the host name that Exim obtains by doing a reverse lookup of the
14454 calling host address, or
14455 .next
14456 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14457 available) yields the calling host address.
14458 .endlist
14459
14460 However, the EHLO or HELO command is not rejected if any of the checks
14461 fail. Processing continues, but the result of the check is remembered, and can
14462 be detected later in an ACL by the &`verify = helo`& condition.
14463
14464 .option helo_verify_hosts main "host list&!!" unset
14465 .cindex "HELO verifying" "mandatory"
14466 .cindex "EHLO" "verifying, mandatory"
14467 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14468 backwards compatibility. For hosts that match this option, Exim checks the host
14469 name given in the HELO or EHLO in the same way as for
14470 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14471 rejected with a 550 error, and entries are written to the main and reject logs.
14472 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14473 error.
14474
14475 .option hold_domains main "domain list&!!" unset
14476 .cindex "domain" "delaying delivery"
14477 .cindex "delivery" "delaying certain domains"
14478 This option allows mail for particular domains to be held on the queue
14479 manually. The option is overridden if a message delivery is forced with the
14480 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14481 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14482 item in &%hold_domains%&, no routing or delivery for that address is done, and
14483 it is deferred every time the message is looked at.
14484
14485 This option is intended as a temporary operational measure for delaying the
14486 delivery of mail while some problem is being sorted out, or some new
14487 configuration tested. If you just want to delay the processing of some
14488 domains until a queue run occurs, you should use &%queue_domains%& or
14489 &%queue_smtp_domains%&, not &%hold_domains%&.
14490
14491 A setting of &%hold_domains%& does not override Exim's code for removing
14492 messages from the queue if they have been there longer than the longest retry
14493 time in any retry rule. If you want to hold messages for longer than the normal
14494 retry times, insert a dummy retry rule with a long retry time.
14495
14496
14497 .option host_lookup main "host list&!!" unset
14498 .cindex "host name" "lookup, forcing"
14499 Exim does not look up the name of a calling host from its IP address unless it
14500 is required to compare against some host list, or the host matches
14501 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14502 option (which normally contains IP addresses rather than host names). The
14503 default configuration file contains
14504 .code
14505 host_lookup = *
14506 .endd
14507 which causes a lookup to happen for all hosts. If the expense of these lookups
14508 is felt to be too great, the setting can be changed or removed.
14509
14510 After a successful reverse lookup, Exim does a forward lookup on the name it
14511 has obtained, to verify that it yields the IP address that it started with. If
14512 this check fails, Exim behaves as if the name lookup failed.
14513
14514 .vindex "&$host_lookup_failed$&"
14515 .vindex "&$sender_host_name$&"
14516 After any kind of failure, the host name (in &$sender_host_name$&) remains
14517 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14518 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14519 &`verify = reverse_host_lookup`& in ACLs.
14520
14521
14522 .option host_lookup_order main "string list" &`bydns:byaddr`&
14523 This option specifies the order of different lookup methods when Exim is trying
14524 to find a host name from an IP address. The default is to do a DNS lookup
14525 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14526 if that fails. You can change the order of these lookups, or omit one entirely,
14527 if you want.
14528
14529 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14530 multiple PTR records in the DNS and the IP address is not listed in
14531 &_/etc/hosts_&. Different operating systems give different results in this
14532 case. That is why the default tries a DNS lookup first.
14533
14534
14535
14536 .option host_reject_connection main "host list&!!" unset
14537 .cindex "host" "rejecting connections from"
14538 If this option is set, incoming SMTP calls from the hosts listed are rejected
14539 as soon as the connection is made.
14540 This option is obsolete, and retained only for backward compatibility, because
14541 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14542 connections immediately.
14543
14544 The ability to give an immediate rejection (either by this option or using an
14545 ACL) is provided for use in unusual cases. Many hosts will just try again,
14546 sometimes without much delay. Normally, it is better to use an ACL to reject
14547 incoming messages at a later stage, such as after RCPT commands. See
14548 chapter &<<CHAPACL>>&.
14549
14550
14551 .option hosts_connection_nolog main "host list&!!" unset
14552 .cindex "host" "not logging connections from"
14553 This option defines a list of hosts for which connection logging does not
14554 happen, even though the &%smtp_connection%& log selector is set. For example,
14555 you might want not to log SMTP connections from local processes, or from
14556 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14557 the daemon; you should therefore strive to restrict its value to a short inline
14558 list of IP addresses and networks. To disable logging SMTP connections from
14559 local processes, you must create a host list with an empty item. For example:
14560 .code
14561 hosts_connection_nolog = :
14562 .endd
14563 If the &%smtp_connection%& log selector is not set, this option has no effect.
14564
14565
14566
14567 .option hosts_treat_as_local main "domain list&!!" unset
14568 .cindex "local host" "domains treated as"
14569 .cindex "host" "treated as local"
14570 If this option is set, any host names that match the domain list are treated as
14571 if they were the local host when Exim is scanning host lists obtained from MX
14572 records
14573 or other sources. Note that the value of this option is a domain list, not a
14574 host list, because it is always used to check host names, not IP addresses.
14575
14576 This option also applies when Exim is matching the special items
14577 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14578 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14579 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14580 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14581 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14582 interfaces and recognizing the local host.
14583
14584
14585 .option ibase_servers main "string list" unset
14586 .cindex "InterBase" "server list"
14587 This option provides a list of InterBase servers and associated connection data,
14588 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14589 The option is available only if Exim has been built with InterBase support.
14590
14591
14592
14593 .option ignore_bounce_errors_after main time 10w
14594 .cindex "bounce message" "discarding"
14595 .cindex "discarding bounce message"
14596 This option affects the processing of bounce messages that cannot be delivered,
14597 that is, those that suffer a permanent delivery failure. (Bounce messages that
14598 suffer temporary delivery failures are of course retried in the usual way.)
14599
14600 After a permanent delivery failure, bounce messages are frozen,
14601 because there is no sender to whom they can be returned. When a frozen bounce
14602 message has been on the queue for more than the given time, it is unfrozen at
14603 the next queue run, and a further delivery is attempted. If delivery fails
14604 again, the bounce message is discarded. This makes it possible to keep failed
14605 bounce messages around for a shorter time than the normal maximum retry time
14606 for frozen messages. For example,
14607 .code
14608 ignore_bounce_errors_after = 12h
14609 .endd
14610 retries failed bounce message deliveries after 12 hours, discarding any further
14611 failures. If the value of this option is set to a zero time period, bounce
14612 failures are discarded immediately. Setting a very long time (as in the default
14613 value) has the effect of disabling this option. For ways of automatically
14614 dealing with other kinds of frozen message, see &%auto_thaw%& and
14615 &%timeout_frozen_after%&.
14616
14617
14618 .option ignore_fromline_hosts main "host list&!!" unset
14619 .cindex "&""From""& line"
14620 .cindex "UUCP" "&""From""& line"
14621 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14622 the headers of a message. By default this is treated as the start of the
14623 message's body, which means that any following headers are not recognized as
14624 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14625 match those hosts that insist on sending it. If the sender is actually a local
14626 process rather than a remote host, and is using &%-bs%& to inject the messages,
14627 &%ignore_fromline_local%& must be set to achieve this effect.
14628
14629
14630 .option ignore_fromline_local main boolean false
14631 See &%ignore_fromline_hosts%& above.
14632
14633
14634 .option keep_malformed main time 4d
14635 This option specifies the length of time to keep messages whose spool files
14636 have been corrupted in some way. This should, of course, never happen. At the
14637 next attempt to deliver such a message, it gets removed. The incident is
14638 logged.
14639
14640
14641 .option ldap_ca_cert_dir main string unset
14642 .cindex "LDAP", "TLS CA certificate directory"
14643 This option indicates which directory contains CA certificates for verifying
14644 a TLS certificate presented by an LDAP server.
14645 While Exim does not provide a default value, your SSL library may.
14646 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14647 and constrained to be a directory.
14648
14649
14650 .option ldap_ca_cert_file main string unset
14651 .cindex "LDAP", "TLS CA certificate file"
14652 This option indicates which file contains CA certificates for verifying
14653 a TLS certificate presented by an LDAP server.
14654 While Exim does not provide a default value, your SSL library may.
14655 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14656 and constrained to be a file.
14657
14658
14659 .option ldap_cert_file main string unset
14660 .cindex "LDAP" "TLS client certificate file"
14661 This option indicates which file contains an TLS client certificate which
14662 Exim should present to the LDAP server during TLS negotiation.
14663 Should be used together with &%ldap_cert_key%&.
14664
14665
14666 .option ldap_cert_key main string unset
14667 .cindex "LDAP" "TLS client key file"
14668 This option indicates which file contains the secret/private key to use
14669 to prove identity to the LDAP server during TLS negotiation.
14670 Should be used together with &%ldap_cert_file%&, which contains the
14671 identity to be proven.
14672
14673
14674 .option ldap_cipher_suite main string unset
14675 .cindex "LDAP" "TLS cipher suite"
14676 This controls the TLS cipher-suite negotiation during TLS negotiation with
14677 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14678 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14679
14680
14681 .option ldap_default_servers main "string list" unset
14682 .cindex "LDAP" "default servers"
14683 This option provides a list of LDAP servers which are tried in turn when an
14684 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14685 details of LDAP queries. This option is available only when Exim has been built
14686 with LDAP support.
14687
14688
14689 .option ldap_require_cert main string unset.
14690 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14691 This should be one of the values "hard", "demand", "allow", "try" or "never".
14692 A value other than one of these is interpreted as "never".
14693 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14694 Although Exim does not set a default, the LDAP library probably defaults
14695 to hard/demand.
14696
14697
14698 .option ldap_start_tls main boolean false
14699 .cindex "LDAP" "whether or not to negotiate TLS"
14700 If set, Exim will attempt to negotiate TLS with the LDAP server when
14701 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14702 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14703 of SSL-on-connect.
14704 In the event of failure to negotiate TLS, the action taken is controlled
14705 by &%ldap_require_cert%&.
14706
14707
14708 .option ldap_version main integer unset
14709 .cindex "LDAP" "protocol version, forcing"
14710 This option can be used to force Exim to set a specific protocol version for
14711 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14712 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14713 the LDAP headers; otherwise it is 2. This option is available only when Exim
14714 has been built with LDAP support.
14715
14716
14717
14718 .option local_from_check main boolean true
14719 .cindex "&'Sender:'& header line" "disabling addition of"
14720 .cindex "&'From:'& header line" "disabling checking of"
14721 When a message is submitted locally (that is, not over a TCP/IP connection) by
14722 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14723 checks that the &'From:'& header line matches the login of the calling user and
14724 the domain specified by &%qualify_domain%&.
14725
14726 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14727 locally submitted message is automatically qualified by Exim, unless the
14728 &%-bnq%& command line option is used.
14729
14730 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14731 on the local part. If the &'From:'& header line does not match, Exim adds a
14732 &'Sender:'& header with an address constructed from the calling user's login
14733 and the default qualify domain.
14734
14735 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14736 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14737 &'Sender:'& header lines supplied by untrusted users, you must also set
14738 &%local_sender_retain%& to be true.
14739
14740 .cindex "envelope sender"
14741 These options affect only the header lines in the message. The envelope sender
14742 is still forced to be the login id at the qualify domain unless
14743 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14744
14745 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14746 request similar header line checking. See section &<<SECTthesenhea>>&, which
14747 has more details about &'Sender:'& processing.
14748
14749
14750
14751
14752 .option local_from_prefix main string unset
14753 When Exim checks the &'From:'& header line of locally submitted messages for
14754 matching the login id (see &%local_from_check%& above), it can be configured to
14755 ignore certain prefixes and suffixes in the local part of the address. This is
14756 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14757 appropriate lists, in the same form as the &%local_part_prefix%& and
14758 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14759 example, if
14760 .code
14761 local_from_prefix = *-
14762 .endd
14763 is set, a &'From:'& line containing
14764 .code
14765 From: anything-user@your.domain.example
14766 .endd
14767 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14768 matches the actual sender address that is constructed from the login name and
14769 qualify domain.
14770
14771
14772 .option local_from_suffix main string unset
14773 See &%local_from_prefix%& above.
14774
14775
14776 .option local_interfaces main "string list" "see below"
14777 This option controls which network interfaces are used by the daemon for
14778 listening; they are also used to identify the local host when routing. Chapter
14779 &<<CHAPinterfaces>>& contains a full description of this option and the related
14780 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14781 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14782 &%local_interfaces%& is
14783 .code
14784 local_interfaces = 0.0.0.0
14785 .endd
14786 when Exim is built without IPv6 support; otherwise it is
14787 .code
14788 local_interfaces = <; ::0 ; 0.0.0.0
14789 .endd
14790
14791 .option local_scan_timeout main time 5m
14792 .cindex "timeout" "for &[local_scan()]& function"
14793 .cindex "&[local_scan()]& function" "timeout"
14794 This timeout applies to the &[local_scan()]& function (see chapter
14795 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14796 the incoming message is rejected with a temporary error if it is an SMTP
14797 message. For a non-SMTP message, the message is dropped and Exim ends with a
14798 non-zero code. The incident is logged on the main and reject logs.
14799
14800
14801
14802 .option local_sender_retain main boolean false
14803 .cindex "&'Sender:'& header line" "retaining from local submission"
14804 When a message is submitted locally (that is, not over a TCP/IP connection) by
14805 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14806 do not want this to happen, you must set &%local_sender_retain%&, and you must
14807 also set &%local_from_check%& to be false (Exim will complain if you do not).
14808 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14809 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14810
14811
14812
14813
14814 .option localhost_number main string&!! unset
14815 .cindex "host" "locally unique number for"
14816 .cindex "message ids" "with multiple hosts"
14817 .vindex "&$localhost_number$&"
14818 Exim's message ids are normally unique only within the local host. If
14819 uniqueness among a set of hosts is required, each host must set a different
14820 value for the &%localhost_number%& option. The string is expanded immediately
14821 after reading the configuration file (so that a number can be computed from the
14822 host name, for example) and the result of the expansion must be a number in the
14823 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14824 systems). This is available in subsequent string expansions via the variable
14825 &$localhost_number$&. When &%localhost_number is set%&, the final two
14826 characters of the message id, instead of just being a fractional part of the
14827 time, are computed from the time and the local host number as described in
14828 section &<<SECTmessiden>>&.
14829
14830
14831
14832 .option log_file_path main "string list&!!" "set at compile time"
14833 .cindex "log" "file path for"
14834 This option sets the path which is used to determine the names of Exim's log
14835 files, or indicates that logging is to be to syslog, or both. It is expanded
14836 when Exim is entered, so it can, for example, contain a reference to the host
14837 name. If no specific path is set for the log files at compile or run time, they
14838 are written in a sub-directory called &_log_& in Exim's spool directory.
14839 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14840 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14841 used. If this string is fixed at your installation (contains no expansion
14842 variables) it is recommended that you do not set this option in the
14843 configuration file, but instead supply the path using LOG_FILE_PATH in
14844 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14845 early on &-- in particular, failure to read the configuration file.
14846
14847
14848 .option log_selector main string unset
14849 .cindex "log" "selectors"
14850 This option can be used to reduce or increase the number of things that Exim
14851 writes to its log files. Its argument is made up of names preceded by plus or
14852 minus characters. For example:
14853 .code
14854 log_selector = +arguments -retry_defer
14855 .endd
14856 A list of possible names and what they control is given in the chapter on
14857 logging, in section &<<SECTlogselector>>&.
14858
14859
14860 .option log_timezone main boolean false
14861 .cindex "log" "timezone for entries"
14862 .vindex "&$tod_log$&"
14863 .vindex "&$tod_zone$&"
14864 By default, the timestamps on log lines are in local time without the
14865 timezone. This means that if your timezone changes twice a year, the timestamps
14866 in log lines are ambiguous for an hour when the clocks go back. One way of
14867 avoiding this problem is to set the timezone to UTC. An alternative is to set
14868 &%log_timezone%& true. This turns on the addition of the timezone offset to
14869 timestamps in log lines. Turning on this option can add quite a lot to the size
14870 of log files because each line is extended by 6 characters. Note that the
14871 &$tod_log$& variable contains the log timestamp without the zone, but there is
14872 another variable called &$tod_zone$& that contains just the timezone offset.
14873
14874
14875 .option lookup_open_max main integer 25
14876 .cindex "too many open files"
14877 .cindex "open files, too many"
14878 .cindex "file" "too many open"
14879 .cindex "lookup" "maximum open files"
14880 .cindex "limit" "open files for lookups"
14881 This option limits the number of simultaneously open files for single-key
14882 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14883 Exim normally keeps these files open during routing, because often the same
14884 file is required several times. If the limit is reached, Exim closes the least
14885 recently used file. Note that if you are using the &'ndbm'& library, it
14886 actually opens two files for each logical DBM database, though it still counts
14887 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14888 open files"& errors with NDBM, you need to reduce the value of
14889 &%lookup_open_max%&.
14890
14891
14892 .option max_username_length main integer 0
14893 .cindex "length of login name"
14894 .cindex "user name" "maximum length"
14895 .cindex "limit" "user name length"
14896 Some operating systems are broken in that they truncate long arguments to
14897 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14898 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14899 an argument that is longer behaves as if &[getpwnam()]& failed.
14900
14901
14902 .option message_body_newlines main bool false
14903 .cindex "message body" "newlines in variables"
14904 .cindex "newline" "in message body variables"
14905 .vindex "&$message_body$&"
14906 .vindex "&$message_body_end$&"
14907 By default, newlines in the message body are replaced by spaces when setting
14908 the &$message_body$& and &$message_body_end$& expansion variables. If this
14909 option is set true, this no longer happens.
14910
14911
14912 .option message_body_visible main integer 500
14913 .cindex "body of message" "visible size"
14914 .cindex "message body" "visible size"
14915 .vindex "&$message_body$&"
14916 .vindex "&$message_body_end$&"
14917 This option specifies how much of a message's body is to be included in the
14918 &$message_body$& and &$message_body_end$& expansion variables.
14919
14920
14921 .option message_id_header_domain main string&!! unset
14922 .cindex "&'Message-ID:'& header line"
14923 If this option is set, the string is expanded and used as the right hand side
14924 (domain) of the &'Message-ID:'& header that Exim creates if a
14925 locally-originated incoming message does not have one. &"Locally-originated"&
14926 means &"not received over TCP/IP."&
14927 Otherwise, the primary host name is used.
14928 Only letters, digits, dot and hyphen are accepted; any other characters are
14929 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14930 empty string, the option is ignored.
14931
14932
14933 .option message_id_header_text main string&!! unset
14934 If this variable is set, the string is expanded and used to augment the text of
14935 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14936 message does not have one. The text of this header is required by RFC 2822 to
14937 take the form of an address. By default, Exim uses its internal message id as
14938 the local part, and the primary host name as the domain. If this option is set,
14939 it is expanded, and provided the expansion is not forced to fail, and does not
14940 yield an empty string, the result is inserted into the header immediately
14941 before the @, separated from the internal message id by a dot. Any characters
14942 that are illegal in an address are automatically converted into hyphens. This
14943 means that variables such as &$tod_log$& can be used, because the spaces and
14944 colons will become hyphens.
14945
14946
14947 .option message_logs main boolean true
14948 .cindex "message logs" "disabling"
14949 .cindex "log" "message log; disabling"
14950 If this option is turned off, per-message log files are not created in the
14951 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14952 Exim, by reducing the number of files involved in handling a message from a
14953 minimum of four (header spool file, body spool file, delivery journal, and
14954 per-message log) to three. The other major I/O activity is Exim's main log,
14955 which is not affected by this option.
14956
14957
14958 .option message_size_limit main string&!! 50M
14959 .cindex "message" "size limit"
14960 .cindex "limit" "message size"
14961 .cindex "size" "of message, limit"
14962 This option limits the maximum size of message that Exim will process. The
14963 value is expanded for each incoming connection so, for example, it can be made
14964 to depend on the IP address of the remote host for messages arriving via
14965 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14966 optionally followed by K or M.
14967
14968 &*Note*&: This limit cannot be made to depend on a message's sender or any
14969 other properties of an individual message, because it has to be advertised in
14970 the server's response to EHLO. String expansion failure causes a temporary
14971 error. A value of zero means no limit, but its use is not recommended. See also
14972 &%bounce_return_size_limit%&.
14973
14974 Incoming SMTP messages are failed with a 552 error if the limit is
14975 exceeded; locally-generated messages either get a stderr message or a delivery
14976 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14977 an oversized message is logged in both the main and the reject logs. See also
14978 the generic transport option &%message_size_limit%&, which limits the size of
14979 message that an individual transport can process.
14980
14981 If you use a virus-scanner and set this option to to a value larger than the
14982 maximum size that your virus-scanner is configured to support, you may get
14983 failures triggered by large mails.  The right size to configure for the
14984 virus-scanner depends upon what data is passed and the options in use but it's
14985 probably safest to just set it to a little larger than this value.  Eg, with a
14986 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14987 some problems may result.
14988
14989 A value of 0 will disable size limit checking; Exim will still advertise the
14990 SIZE extension in an EHLO response, but without a limit, so as to permit
14991 SMTP clients to still indicate the message size along with the MAIL verb.
14992
14993
14994 .option move_frozen_messages main boolean false
14995 .cindex "frozen messages" "moving"
14996 This option, which is available only if Exim has been built with the setting
14997 .code
14998 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14999 .endd
15000 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15001 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15002 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15003 standard utilities for handling such moved messages, and they do not show up in
15004 lists generated by &%-bp%& or by the Exim monitor.
15005
15006
15007 .option mua_wrapper main boolean false
15008 Setting this option true causes Exim to run in a very restrictive mode in which
15009 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15010 contains a full description of this facility.
15011
15012
15013
15014 .option mysql_servers main "string list" unset
15015 .cindex "MySQL" "server list"
15016 This option provides a list of MySQL servers and associated connection data, to
15017 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15018 option is available only if Exim has been built with MySQL support.
15019
15020
15021 .option never_users main "string list&!!" unset
15022 This option is expanded just once, at the start of Exim's processing. Local
15023 message deliveries are normally run in processes that are setuid to the
15024 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15025 It is usually desirable to prevent any deliveries from running as root, as a
15026 safety precaution.
15027
15028 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15029 list of users that must not be used for local deliveries. This list is fixed in
15030 the binary and cannot be overridden by the configuration file. By default, it
15031 contains just the single user name &"root"&. The &%never_users%& runtime option
15032 can be used to add more users to the fixed list.
15033
15034 If a message is to be delivered as one of the users on the fixed list or the
15035 &%never_users%& list, an error occurs, and delivery is deferred. A common
15036 example is
15037 .code
15038 never_users = root:daemon:bin
15039 .endd
15040 Including root is redundant if it is also on the fixed list, but it does no
15041 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15042 transport driver.
15043
15044
15045 .option openssl_options main "string list" "+no_sslv2"
15046 .cindex "OpenSSL "compatibility options"
15047 This option allows an administrator to adjust the SSL options applied
15048 by OpenSSL to connections.  It is given as a space-separated list of items,
15049 each one to be +added or -subtracted from the current value.
15050
15051 This option is only available if Exim is built against OpenSSL.  The values
15052 available for this option vary according to the age of your OpenSSL install.
15053 The &"all"& value controls a subset of flags which are available, typically
15054 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15055 list the values known on your system and Exim should support all the
15056 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15057 names lose the leading &"SSL_OP_"& and are lower-cased.
15058
15059 Note that adjusting the options can have severe impact upon the security of
15060 SSL as used by Exim.  It is possible to disable safety checks and shoot
15061 yourself in the foot in various unpleasant ways.  This option should not be
15062 adjusted lightly.  An unrecognised item will be detected at startup, by
15063 invoking Exim with the &%-bV%& flag.
15064
15065 The option affects Exim operating both as a server and as a client.
15066
15067 Historical note: prior to release 4.80, Exim defaulted this value to
15068 "+dont_insert_empty_fragments", which may still be needed for compatibility
15069 with some clients, but which lowers security by increasing exposure to
15070 some now infamous attacks.
15071
15072 Examples:
15073 .code
15074 # Make both old MS and old Eudora happy:
15075 openssl_options = -all +microsoft_big_sslv3_buffer \
15076                        +dont_insert_empty_fragments
15077
15078 # Disable older protocol versions:
15079 openssl_options = +no_sslv2 +no_sslv3
15080 .endd
15081
15082 Possible options may include:
15083 .ilist
15084 &`all`&
15085 .next
15086 &`allow_unsafe_legacy_renegotiation`&
15087 .next
15088 &`cipher_server_preference`&
15089 .next
15090 &`dont_insert_empty_fragments`&
15091 .next
15092 &`ephemeral_rsa`&
15093 .next
15094 &`legacy_server_connect`&
15095 .next
15096 &`microsoft_big_sslv3_buffer`&
15097 .next
15098 &`microsoft_sess_id_bug`&
15099 .next
15100 &`msie_sslv2_rsa_padding`&
15101 .next
15102 &`netscape_challenge_bug`&
15103 .next
15104 &`netscape_reuse_cipher_change_bug`&
15105 .next
15106 &`no_compression`&
15107 .next
15108 &`no_session_resumption_on_renegotiation`&
15109 .next
15110 &`no_sslv2`&
15111 .next
15112 &`no_sslv3`&
15113 .next
15114 &`no_ticket`&
15115 .next
15116 &`no_tlsv1`&
15117 .next
15118 &`no_tlsv1_1`&
15119 .next
15120 &`no_tlsv1_2`&
15121 .next
15122 &`safari_ecdhe_ecdsa_bug`&
15123 .next
15124 &`single_dh_use`&
15125 .next
15126 &`single_ecdh_use`&
15127 .next
15128 &`ssleay_080_client_dh_bug`&
15129 .next
15130 &`sslref2_reuse_cert_type_bug`&
15131 .next
15132 &`tls_block_padding_bug`&
15133 .next
15134 &`tls_d5_bug`&
15135 .next
15136 &`tls_rollback_bug`&
15137 .endlist
15138
15139 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15140 all clients connecting using the MacOS SecureTransport TLS facility prior
15141 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15142 to negotiate TLS then this option value might help, provided that your OpenSSL
15143 release is new enough to contain this work-around.  This may be a situation
15144 where you have to upgrade OpenSSL to get buggy clients working.
15145
15146
15147 .option oracle_servers main "string list" unset
15148 .cindex "Oracle" "server list"
15149 This option provides a list of Oracle servers and associated connection data,
15150 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15151 The option is available only if Exim has been built with Oracle support.
15152
15153
15154 .option percent_hack_domains main "domain list&!!" unset
15155 .cindex "&""percent hack""&"
15156 .cindex "source routing" "in email address"
15157 .cindex "address" "source-routed"
15158 The &"percent hack"& is the convention whereby a local part containing a
15159 percent sign is re-interpreted as a new email address, with the percent
15160 replaced by @. This is sometimes called &"source routing"&, though that term is
15161 also applied to RFC 2822 addresses that begin with an @ character. If this
15162 option is set, Exim implements the percent facility for those domains listed,
15163 but no others. This happens before an incoming SMTP address is tested against
15164 an ACL.
15165
15166 &*Warning*&: The &"percent hack"& has often been abused by people who are
15167 trying to get round relaying restrictions. For this reason, it is best avoided
15168 if at all possible. Unfortunately, a number of less security-conscious MTAs
15169 implement it unconditionally. If you are running Exim on a gateway host, and
15170 routing mail through to internal MTAs without processing the local parts, it is
15171 a good idea to reject recipient addresses with percent characters in their
15172 local parts. Exim's default configuration does this.
15173
15174
15175 .option perl_at_start main boolean false
15176 This option is available only when Exim is built with an embedded Perl
15177 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15178
15179
15180 .option perl_startup main string unset
15181 This option is available only when Exim is built with an embedded Perl
15182 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15183
15184
15185 .option pgsql_servers main "string list" unset
15186 .cindex "PostgreSQL lookup type" "server list"
15187 This option provides a list of PostgreSQL servers and associated connection
15188 data, to be used in conjunction with &(pgsql)& lookups (see section
15189 &<<SECID72>>&). The option is available only if Exim has been built with
15190 PostgreSQL support.
15191
15192
15193 .option pid_file_path main string&!! "set at compile time"
15194 .cindex "daemon" "pid file path"
15195 .cindex "pid file, path for"
15196 This option sets the name of the file to which the Exim daemon writes its
15197 process id. The string is expanded, so it can contain, for example, references
15198 to the host name:
15199 .code
15200 pid_file_path = /var/log/$primary_hostname/exim.pid
15201 .endd
15202 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15203 spool directory.
15204 The value set by the option can be overridden by the &%-oP%& command line
15205 option. A pid file is not written if a &"non-standard"& daemon is run by means
15206 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15207
15208
15209 .option pipelining_advertise_hosts main "host list&!!" *
15210 .cindex "PIPELINING" "suppressing advertising"
15211 This option can be used to suppress the advertisement of the SMTP
15212 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15213 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15214 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15215 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15216 that clients will use it; &"out of order"& commands that are &"expected"& do
15217 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15218
15219
15220 .option prdr_enable main boolean false
15221 .cindex "PRDR" "enabling on server"
15222 This option can be used to enable the Per-Recipient Data Response extension
15223 to SMTP, defined by Eric Hall.
15224 If the option is set, PRDR is advertised by Exim when operating as a server.
15225 If the client requests PRDR, and more than one recipient, for a message 
15226 an additional ACL is called for each recipient after the message content
15227 is recieved.  See section &<<SECTPRDRACL>>&.
15228
15229 .option preserve_message_logs main boolean false
15230 .cindex "message logs" "preserving"
15231 If this option is set, message log files are not deleted when messages are
15232 completed. Instead, they are moved to a sub-directory of the spool directory
15233 called &_msglog.OLD_&, where they remain available for statistical or debugging
15234 purposes. This is a dangerous option to set on systems with any appreciable
15235 volume of mail. Use with care!
15236
15237
15238 .option primary_hostname main string "see below"
15239 .cindex "name" "of local host"
15240 .cindex "host" "name of local"
15241 .cindex "local host" "name of"
15242 .vindex "&$primary_hostname$&"
15243 This specifies the name of the current host. It is used in the default EHLO or
15244 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15245 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15246 The value is also used by default in some SMTP response messages from an Exim
15247 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15248
15249 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15250 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15251 contains only one component, Exim passes it to &[gethostbyname()]& (or
15252 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15253 version. The variable &$primary_hostname$& contains the host name, whether set
15254 explicitly by this option, or defaulted.
15255
15256
15257 .option print_topbitchars main boolean false
15258 .cindex "printing characters"
15259 .cindex "8-bit characters"
15260 By default, Exim considers only those characters whose codes lie in the range
15261 32&--126 to be printing characters. In a number of circumstances (for example,
15262 when writing log entries) non-printing characters are converted into escape
15263 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15264 is set, code values of 128 and above are also considered to be printing
15265 characters.
15266
15267 This option also affects the header syntax checks performed by the
15268 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15269 the user's full name when constructing From: and Sender: addresses (as
15270 described in section &<<SECTconstr>>&). Setting this option can cause
15271 Exim to generate eight bit message headers that do not conform to the
15272 standards.
15273
15274
15275 .option process_log_path main string unset
15276 .cindex "process log path"
15277 .cindex "log" "process log"
15278 .cindex "&'exiwhat'&"
15279 This option sets the name of the file to which an Exim process writes its
15280 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15281 utility script. If this option is unset, the file called &_exim-process.info_&
15282 in Exim's spool directory is used. The ability to specify the name explicitly
15283 can be useful in environments where two different Exims are running, using
15284 different spool directories.
15285
15286
15287 .option prod_requires_admin main boolean true
15288 .oindex "&%-M%&"
15289 .oindex "&%-R%&"
15290 .oindex "&%-q%&"
15291 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15292 admin user unless &%prod_requires_admin%& is set false. See also
15293 &%queue_list_requires_admin%&.
15294
15295
15296 .option qualify_domain main string "see below"
15297 .cindex "domain" "for qualifying addresses"
15298 .cindex "address" "qualification"
15299 This option specifies the domain name that is added to any envelope sender
15300 addresses that do not have a domain qualification. It also applies to
15301 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15302 are accepted by default only for locally-generated messages. Qualification is
15303 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15304 locally-generated messages, unless the &%-bnq%& command line option is used.
15305
15306 Messages from external sources must always contain fully qualified addresses,
15307 unless the sending host matches &%sender_unqualified_hosts%& or
15308 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15309 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15310 necessary. Internally, Exim always works with fully qualified envelope
15311 addresses. If &%qualify_domain%& is not set, it defaults to the
15312 &%primary_hostname%& value.
15313
15314
15315 .option qualify_recipient main string "see below"
15316 This option allows you to specify a different domain for qualifying recipient
15317 addresses to the one that is used for senders. See &%qualify_domain%& above.
15318
15319
15320
15321 .option queue_domains main "domain list&!!" unset
15322 .cindex "domain" "specifying non-immediate delivery"
15323 .cindex "queueing incoming messages"
15324 .cindex "message" "queueing certain domains"
15325 This option lists domains for which immediate delivery is not required.
15326 A delivery process is started whenever a message is received, but only those
15327 domains that do not match are processed. All other deliveries wait until the
15328 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15329
15330
15331 .option queue_list_requires_admin main boolean true
15332 .oindex "&%-bp%&"
15333 The &%-bp%& command-line option, which lists the messages that are on the
15334 queue, requires the caller to be an admin user unless
15335 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15336
15337
15338 .option queue_only main boolean false
15339 .cindex "queueing incoming messages"
15340 .cindex "message" "queueing unconditionally"
15341 If &%queue_only%& is set, a delivery process is not automatically started
15342 whenever a message is received. Instead, the message waits on the queue for the
15343 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15344 delivered immediately when certain conditions (such as heavy load) occur.
15345
15346 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15347 and &%-odi%& command line options override &%queue_only%& unless
15348 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15349 &%queue_only_load%&, and &%smtp_accept_queue%&.
15350
15351
15352 .option queue_only_file main string unset
15353 .cindex "queueing incoming messages"
15354 .cindex "message" "queueing by file existence"
15355 This option can be set to a colon-separated list of absolute path names, each
15356 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15357 it tests for the existence of each listed path using a call to &[stat()]&. For
15358 each path that exists, the corresponding queueing option is set.
15359 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15360 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15361 .code
15362 queue_only_file = smtp/some/file
15363 .endd
15364 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15365 &_/some/file_& exists.
15366
15367
15368 .option queue_only_load main fixed-point unset
15369 .cindex "load average"
15370 .cindex "queueing incoming messages"
15371 .cindex "message" "queueing by load"
15372 If the system load average is higher than this value, incoming messages from
15373 all sources are queued, and no automatic deliveries are started. If this
15374 happens during local or remote SMTP input, all subsequent messages received on
15375 the same SMTP connection are queued by default, whatever happens to the load in
15376 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15377 false.
15378
15379 Deliveries will subsequently be performed by queue runner processes. This
15380 option has no effect on ancient operating systems on which Exim cannot
15381 determine the load average. See also &%deliver_queue_load_max%& and
15382 &%smtp_load_reserve%&.
15383
15384
15385 .option queue_only_load_latch main boolean true
15386 .cindex "load average" "re-evaluating per message"
15387 When this option is true (the default), once one message has been queued
15388 because the load average is higher than the value set by &%queue_only_load%&,
15389 all subsequent messages received on the same SMTP connection are also queued.
15390 This is a deliberate choice; even though the load average may fall below the
15391 threshold, it doesn't seem right to deliver later messages on the same
15392 connection when not delivering earlier ones. However, there are special
15393 circumstances such as very long-lived connections from scanning appliances
15394 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15395 should be set false. This causes the value of the load average to be
15396 re-evaluated for each message.
15397
15398
15399 .option queue_only_override main boolean true
15400 .cindex "queueing incoming messages"
15401 When this option is true, the &%-od%&&'x'& command line options override the
15402 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15403 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15404 to override; they are accepted, but ignored.
15405
15406
15407 .option queue_run_in_order main boolean false
15408 .cindex "queue runner" "processing messages in order"
15409 If this option is set, queue runs happen in order of message arrival instead of
15410 in an arbitrary order. For this to happen, a complete list of the entire queue
15411 must be set up before the deliveries start. When the queue is all held in a
15412 single directory (the default), a single list is created for both the ordered
15413 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15414 single list is not created when &%queue_run_in_order%& is false. In this case,
15415 the sub-directories are processed one at a time (in a random order), and this
15416 avoids setting up one huge list for the whole queue. Thus, setting
15417 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15418 when the queue is large, because of the extra work in setting up the single,
15419 large list. In most situations, &%queue_run_in_order%& should not be set.
15420
15421
15422
15423 .option queue_run_max main integer 5
15424 .cindex "queue runner" "maximum number of"
15425 This controls the maximum number of queue runner processes that an Exim daemon
15426 can run simultaneously. This does not mean that it starts them all at once,
15427 but rather that if the maximum number are still running when the time comes to
15428 start another one, it refrains from starting another one. This can happen with
15429 very large queues and/or very sluggish deliveries. This option does not,
15430 however, interlock with other processes, so additional queue runners can be
15431 started by other means, or by killing and restarting the daemon.
15432
15433 Setting this option to zero does not suppress queue runs; rather, it disables
15434 the limit, allowing any number of simultaneous queue runner processes to be
15435 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15436 the daemon's command line.
15437
15438 .option queue_smtp_domains main "domain list&!!" unset
15439 .cindex "queueing incoming messages"
15440 .cindex "message" "queueing remote deliveries"
15441 When this option is set, a delivery process is started whenever a message is
15442 received, routing is performed, and local deliveries take place.
15443 However, if any SMTP deliveries are required for domains that match
15444 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15445 message waits on the queue for the next queue run. Since routing of the message
15446 has taken place, Exim knows to which remote hosts it must be delivered, and so
15447 when the queue run happens, multiple messages for the same host are delivered
15448 over a single SMTP connection. The &%-odqs%& command line option causes all
15449 SMTP deliveries to be queued in this way, and is equivalent to setting
15450 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15451 &%queue_domains%&.
15452
15453
15454 .option receive_timeout main time 0s
15455 .cindex "timeout" "for non-SMTP input"
15456 This option sets the timeout for accepting a non-SMTP message, that is, the
15457 maximum time that Exim waits when reading a message on the standard input. If
15458 the value is zero, it will wait for ever. This setting is overridden by the
15459 &%-or%& command line option. The timeout for incoming SMTP messages is
15460 controlled by &%smtp_receive_timeout%&.
15461
15462 .option received_header_text main string&!! "see below"
15463 .cindex "customizing" "&'Received:'& header"
15464 .cindex "&'Received:'& header line" "customizing"
15465 This string defines the contents of the &'Received:'& message header that is
15466 added to each message, except for the timestamp, which is automatically added
15467 on at the end (preceded by a semicolon). The string is expanded each time it is
15468 used. If the expansion yields an empty string, no &'Received:'& header line is
15469 added to the message. Otherwise, the string should start with the text
15470 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15471 header lines. The default setting is:
15472
15473 .code
15474 received_header_text = Received: \
15475   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15476   {${if def:sender_ident \
15477   {from ${quote_local_part:$sender_ident} }}\
15478   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15479   by $primary_hostname \
15480   ${if def:received_protocol {with $received_protocol}} \
15481   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15482   (Exim $version_number)\n\t\
15483   ${if def:sender_address \
15484   {(envelope-from <$sender_address>)\n\t}}\
15485   id $message_exim_id\
15486   ${if def:received_for {\n\tfor $received_for}}
15487 .endd
15488
15489 The reference to the TLS cipher is omitted when Exim is built without TLS
15490 support. The use of conditional expansions ensures that this works for both
15491 locally generated messages and messages received from remote hosts, giving
15492 header lines such as the following:
15493 .code
15494 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15495 by marley.carol.example with esmtp (Exim 4.00)
15496 (envelope-from <bob@carol.example>)
15497 id 16IOWa-00019l-00
15498 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15499 Received: by scrooge.carol.example with local (Exim 4.00)
15500 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15501 .endd
15502 Until the body of the message has been received, the timestamp is the time when
15503 the message started to be received. Once the body has arrived, and all policy
15504 checks have taken place, the timestamp is updated to the time at which the
15505 message was accepted.
15506
15507
15508 .option received_headers_max main integer 30
15509 .cindex "loop" "prevention"
15510 .cindex "mail loop prevention"
15511 .cindex "&'Received:'& header line" "counting"
15512 When a message is to be delivered, the number of &'Received:'& headers is
15513 counted, and if it is greater than this parameter, a mail loop is assumed to
15514 have occurred, the delivery is abandoned, and an error message is generated.
15515 This applies to both local and remote deliveries.
15516
15517
15518 .option recipient_unqualified_hosts main "host list&!!" unset
15519 .cindex "unqualified addresses"
15520 .cindex "host" "unqualified addresses from"
15521 This option lists those hosts from which Exim is prepared to accept unqualified
15522 recipient addresses in message envelopes. The addresses are made fully
15523 qualified by the addition of the &%qualify_recipient%& value. This option also
15524 affects message header lines. Exim does not reject unqualified recipient
15525 addresses in headers, but it qualifies them only if the message came from a
15526 host that matches &%recipient_unqualified_hosts%&,
15527 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15528 option was not set.
15529
15530
15531 .option recipients_max main integer 0
15532 .cindex "limit" "number of recipients"
15533 .cindex "recipient" "maximum number"
15534 If this option is set greater than zero, it specifies the maximum number of
15535 original recipients for any message. Additional recipients that are generated
15536 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15537 all recipients over the limit; earlier recipients are delivered as normal.
15538 Non-SMTP messages with too many recipients are failed, and no deliveries are
15539 done.
15540
15541 .cindex "RCPT" "maximum number of incoming"
15542 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15543 RCPT commands in a single message.
15544
15545
15546 .option recipients_max_reject main boolean false
15547 If this option is set true, Exim rejects SMTP messages containing too many
15548 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15549 error to the eventual DATA command. Otherwise (the default) it gives a 452
15550 error to the surplus RCPT commands and accepts the message on behalf of the
15551 initial set of recipients. The remote server should then re-send the message
15552 for the remaining recipients at a later time.
15553
15554
15555 .option remote_max_parallel main integer 2
15556 .cindex "delivery" "parallelism for remote"
15557 This option controls parallel delivery of one message to a number of remote
15558 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15559 does all the remote deliveries for a message one by one. Otherwise, if a single
15560 message has to be delivered to more than one remote host, or if several copies
15561 have to be sent to the same remote host, up to &%remote_max_parallel%&
15562 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15563 deliveries are required, the maximum number of processes are started, and as
15564 each one finishes, another is begun. The order of starting processes is the
15565 same as if sequential delivery were being done, and can be controlled by the
15566 &%remote_sort_domains%& option. If parallel delivery takes place while running
15567 with debugging turned on, the debugging output from each delivery process is
15568 tagged with its process id.
15569
15570 This option controls only the maximum number of parallel deliveries for one
15571 message in one Exim delivery process. Because Exim has no central queue
15572 manager, there is no way of controlling the total number of simultaneous
15573 deliveries if the configuration allows a delivery attempt as soon as a message
15574 is received.
15575
15576 .cindex "number of deliveries"
15577 .cindex "delivery" "maximum number of"
15578 If you want to control the total number of deliveries on the system, you
15579 need to set the &%queue_only%& option. This ensures that all incoming messages
15580 are added to the queue without starting a delivery process. Then set up an Exim
15581 daemon to start queue runner processes at appropriate intervals (probably
15582 fairly often, for example, every minute), and limit the total number of queue
15583 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15584 delivers only one message at a time, the maximum number of deliveries that can
15585 then take place at once is &%queue_run_max%& multiplied by
15586 &%remote_max_parallel%&.
15587
15588 If it is purely remote deliveries you want to control, use
15589 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15590 doing the SMTP routing before queueing, so that several messages for the same
15591 host will eventually get delivered down the same connection.
15592
15593
15594 .option remote_sort_domains main "domain list&!!" unset
15595 .cindex "sorting remote deliveries"
15596 .cindex "delivery" "sorting remote"
15597 When there are a number of remote deliveries for a message, they are sorted by
15598 domain into the order given by this list. For example,
15599 .code
15600 remote_sort_domains = *.cam.ac.uk:*.uk
15601 .endd
15602 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15603 then to those in the &%uk%& domain, then to any others.
15604
15605
15606 .option retry_data_expire main time 7d
15607 .cindex "hints database" "data expiry"
15608 This option sets a &"use before"& time on retry information in Exim's hints
15609 database. Any older retry data is ignored. This means that, for example, once a
15610 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15611 past failures.
15612
15613
15614 .option retry_interval_max main time 24h
15615 .cindex "retry" "limit on interval"
15616 .cindex "limit" "on retry interval"
15617 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15618 intervals between delivery attempts for messages that cannot be delivered
15619 straight away. This option sets an overall limit to the length of time between
15620 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15621 the default value.
15622
15623
15624 .option return_path_remove main boolean true
15625 .cindex "&'Return-path:'& header line" "removing"
15626 RFC 2821, section 4.4, states that an SMTP server must insert a
15627 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15628 The &'Return-path:'& header preserves the sender address as received in the
15629 MAIL command. This description implies that this header should not be present
15630 in an incoming message. If &%return_path_remove%& is true, any existing
15631 &'Return-path:'& headers are removed from messages at the time they are
15632 received. Exim's transports have options for adding &'Return-path:'& headers at
15633 the time of delivery. They are normally used only for final local deliveries.
15634
15635
15636 .option return_size_limit main integer 100K
15637 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15638
15639
15640 .option rfc1413_hosts main "host list&!!" *
15641 .cindex "RFC 1413"
15642 .cindex "host" "for RFC 1413 calls"
15643 RFC 1413 identification calls are made to any client host which matches an item
15644 in the list.
15645
15646 .option rfc1413_query_timeout main time 5s
15647 .cindex "RFC 1413" "query timeout"
15648 .cindex "timeout" "for RFC 1413 call"
15649 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15650 no RFC 1413 calls are ever made.
15651
15652
15653 .option sender_unqualified_hosts main "host list&!!" unset
15654 .cindex "unqualified addresses"
15655 .cindex "host" "unqualified addresses from"
15656 This option lists those hosts from which Exim is prepared to accept unqualified
15657 sender addresses. The addresses are made fully qualified by the addition of
15658 &%qualify_domain%&. This option also affects message header lines. Exim does
15659 not reject unqualified addresses in headers that contain sender addresses, but
15660 it qualifies them only if the message came from a host that matches
15661 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15662 using TCP/IP), and the &%-bnq%& option was not set.
15663
15664
15665 .option smtp_accept_keepalive main boolean true
15666 .cindex "keepalive" "on incoming connection"
15667 This option controls the setting of the SO_KEEPALIVE option on incoming
15668 TCP/IP socket connections. When set, it causes the kernel to probe idle
15669 connections periodically, by sending packets with &"old"& sequence numbers. The
15670 other end of the connection should send an acknowledgment if the connection is
15671 still okay or a reset if the connection has been aborted. The reason for doing
15672 this is that it has the beneficial effect of freeing up certain types of
15673 connection that can get stuck when the remote host is disconnected without
15674 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15675 hours to detect unreachable hosts.
15676
15677
15678
15679 .option smtp_accept_max main integer 20
15680 .cindex "limit" "incoming SMTP connections"
15681 .cindex "SMTP" "incoming connection count"
15682 .cindex "inetd"
15683 This option specifies the maximum number of simultaneous incoming SMTP calls
15684 that Exim will accept. It applies only to the listening daemon; there is no
15685 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15686 value is set to zero, no limit is applied. However, it is required to be
15687 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15688 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15689
15690 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15691 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15692 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15693 and &%smtp_load_reserve%& are then checked before accepting the connection.
15694
15695
15696 .option smtp_accept_max_nonmail main integer 10
15697 .cindex "limit" "non-mail SMTP commands"
15698 .cindex "SMTP" "limiting non-mail commands"
15699 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15700 the connection if there are too many. This option defines &"too many"&. The
15701 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15702 client looping sending EHLO, for example. The check is applied only if the
15703 client host matches &%smtp_accept_max_nonmail_hosts%&.
15704
15705 When a new message is expected, one occurrence of RSET is not counted. This
15706 allows a client to send one RSET between messages (this is not necessary,
15707 but some clients do it). Exim also allows one uncounted occurrence of HELO
15708 or EHLO, and one occurrence of STARTTLS between messages. After
15709 starting up a TLS session, another EHLO is expected, and so it too is not
15710 counted. The first occurrence of AUTH in a connection, or immediately
15711 following STARTTLS is not counted. Otherwise, all commands other than
15712 MAIL, RCPT, DATA, and QUIT are counted.
15713
15714
15715 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15716 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15717 check by setting this option. The default value makes it apply to all hosts. By
15718 changing the value, you can exclude any badly-behaved hosts that you have to
15719 live with.
15720
15721
15722 . Allow this long option name to split; give it unsplit as a fifth argument
15723 . for the automatic .oindex that is generated by .option.
15724 . We insert " &~&~" which is both pretty nasty visually and results in
15725 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15726 . zero-width-space, which would be nicer visually and results in (at least)
15727 . html that Firefox will split on when it's forced to reflow (rather than
15728 . inserting a horizontal scrollbar).  However, the text is still not
15729 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15730 . the option name to split.
15731
15732 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15733          smtp_accept_max_per_connection
15734 .cindex "SMTP" "limiting incoming message count"
15735 .cindex "limit" "messages per SMTP connection"
15736 The value of this option limits the number of MAIL commands that Exim is
15737 prepared to accept over a single SMTP connection, whether or not each command
15738 results in the transfer of a message. After the limit is reached, a 421
15739 response is given to subsequent MAIL commands. This limit is a safety
15740 precaution against a client that goes mad (incidents of this type have been
15741 seen).
15742
15743
15744 .option smtp_accept_max_per_host main string&!! unset
15745 .cindex "limit" "SMTP connections from one host"
15746 .cindex "host" "limiting SMTP connections from"
15747 This option restricts the number of simultaneous IP connections from a single
15748 host (strictly, from a single IP address) to the Exim daemon. The option is
15749 expanded, to enable different limits to be applied to different hosts by
15750 reference to &$sender_host_address$&. Once the limit is reached, additional
15751 connection attempts from the same host are rejected with error code 421. This
15752 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15753 of zero imposes no limit. If this option is set greater than zero, it is
15754 required that &%smtp_accept_max%& be non-zero.
15755
15756 &*Warning*&: When setting this option you should not use any expansion
15757 constructions that take an appreciable amount of time. The expansion and test
15758 happen in the main daemon loop, in order to reject additional connections
15759 without forking additional processes (otherwise a denial-of-service attack
15760 could cause a vast number or processes to be created). While the daemon is
15761 doing this processing, it cannot accept any other incoming connections.
15762
15763
15764
15765 .option smtp_accept_queue main integer 0
15766 .cindex "SMTP" "incoming connection count"
15767 .cindex "queueing incoming messages"
15768 .cindex "message" "queueing by SMTP connection count"
15769 If the number of simultaneous incoming SMTP connections being handled via the
15770 listening daemon exceeds this value, messages received by SMTP are just placed
15771 on the queue; no delivery processes are started automatically. The count is
15772 fixed at the start of an SMTP connection. It cannot be updated in the
15773 subprocess that receives messages, and so the queueing or not queueing applies
15774 to all messages received in the same connection.
15775
15776 A value of zero implies no limit, and clearly any non-zero value is useful only
15777 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15778 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15779 various &%-od%&&'x'& command line options.
15780
15781
15782 . See the comment on smtp_accept_max_per_connection
15783
15784 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15785          smtp_accept_queue_per_connection
15786 .cindex "queueing incoming messages"
15787 .cindex "message" "queueing by message count"
15788 This option limits the number of delivery processes that Exim starts
15789 automatically when receiving messages via SMTP, whether via the daemon or by
15790 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15791 and the number of messages received in a single SMTP session exceeds this
15792 number, subsequent messages are placed on the queue, but no delivery processes
15793 are started. This helps to limit the number of Exim processes when a server
15794 restarts after downtime and there is a lot of mail waiting for it on other
15795 systems. On large systems, the default should probably be increased, and on
15796 dial-in client systems it should probably be set to zero (that is, disabled).
15797
15798
15799 .option smtp_accept_reserve main integer 0
15800 .cindex "SMTP" "incoming call count"
15801 .cindex "host" "reserved"
15802 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15803 number of SMTP connections that are reserved for connections from the hosts
15804 that are specified in &%smtp_reserve_hosts%&. The value set in
15805 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15806 restricted to this number of connections; the option specifies a minimum number
15807 of connection slots for them, not a maximum. It is a guarantee that this group
15808 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15809 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15810 individual host.
15811
15812 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15813 set to 5, once there are 45 active connections (from any hosts), new
15814 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15815 provided the other criteria for acceptance are met.
15816
15817
15818 .option smtp_active_hostname main string&!! unset
15819 .cindex "host" "name in SMTP responses"
15820 .cindex "SMTP" "host name in responses"
15821 .vindex "&$primary_hostname$&"
15822 This option is provided for multi-homed servers that want to masquerade as
15823 several different hosts. At the start of an incoming SMTP connection, its value
15824 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15825 responses. For example, it is used as domain name in the response to an
15826 incoming HELO or EHLO command.
15827
15828 .vindex "&$smtp_active_hostname$&"
15829 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15830 is saved with any messages that are received. It is therefore available for use
15831 in routers and transports when the message is later delivered.
15832
15833 If this option is unset, or if its expansion is forced to fail, or if the
15834 expansion results in an empty string, the value of &$primary_hostname$& is
15835 used. Other expansion failures cause a message to be written to the main and
15836 panic logs, and the SMTP command receives a temporary error. Typically, the
15837 value of &%smtp_active_hostname%& depends on the incoming interface address.
15838 For example:
15839 .code
15840 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15841   {cox.mydomain}{box.mydomain}}
15842 .endd
15843
15844 Although &$smtp_active_hostname$& is primarily concerned with incoming
15845 messages, it is also used as the default for HELO commands in callout
15846 verification if there is no remote transport from which to obtain a
15847 &%helo_data%& value.
15848
15849 .option smtp_banner main string&!! "see below"
15850 .cindex "SMTP" "welcome banner"
15851 .cindex "banner for SMTP"
15852 .cindex "welcome banner for SMTP"
15853 .cindex "customizing" "SMTP banner"
15854 This string, which is expanded every time it is used, is output as the initial
15855 positive response to an SMTP connection. The default setting is:
15856 .code
15857 smtp_banner = $smtp_active_hostname ESMTP Exim \
15858   $version_number $tod_full
15859 .endd
15860 Failure to expand the string causes a panic error. If you want to create a
15861 multiline response to the initial SMTP connection, use &"\n"& in the string at
15862 appropriate points, but not at the end. Note that the 220 code is not included
15863 in this string. Exim adds it automatically (several times in the case of a
15864 multiline response).
15865
15866
15867 .option smtp_check_spool_space main boolean true
15868 .cindex "checking disk space"
15869 .cindex "disk space, checking"
15870 .cindex "spool directory" "checking space"
15871 When this option is set, if an incoming SMTP session encounters the SIZE
15872 option on a MAIL command, it checks that there is enough space in the
15873 spool directory's partition to accept a message of that size, while still
15874 leaving free the amount specified by &%check_spool_space%& (even if that value
15875 is zero). If there isn't enough space, a temporary error code is returned.
15876
15877
15878 .option smtp_connect_backlog main integer 20
15879 .cindex "connection backlog"
15880 .cindex "SMTP" "connection backlog"
15881 .cindex "backlog of connections"
15882 This option specifies a maximum number of waiting SMTP connections. Exim passes
15883 this value to the TCP/IP system when it sets up its listener. Once this number
15884 of connections are waiting for the daemon's attention, subsequent connection
15885 attempts are refused at the TCP/IP level. At least, that is what the manuals
15886 say; in some circumstances such connection attempts have been observed to time
15887 out instead. For large systems it is probably a good idea to increase the
15888 value (to 50, say). It also gives some protection against denial-of-service
15889 attacks by SYN flooding.
15890
15891
15892 .option smtp_enforce_sync main boolean true
15893 .cindex "SMTP" "synchronization checking"
15894 .cindex "synchronization checking in SMTP"
15895 The SMTP protocol specification requires the client to wait for a response from
15896 the server at certain points in the dialogue. Without PIPELINING these
15897 synchronization points are after every command; with PIPELINING they are
15898 fewer, but they still exist.
15899
15900 Some spamming sites send out a complete set of SMTP commands without waiting
15901 for any response. Exim protects against this by rejecting a message if the
15902 client has sent further input when it should not have. The error response &"554
15903 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15904 for this error cannot be perfect because of transmission delays (unexpected
15905 input may be on its way but not yet received when Exim checks). However, it
15906 does detect many instances.
15907
15908 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15909 If you want to disable the check selectively (for example, only for certain
15910 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15911 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15912
15913
15914
15915 .option smtp_etrn_command main string&!! unset
15916 .cindex "ETRN" "command to be run"
15917 .vindex "&$domain$&"
15918 If this option is set, the given command is run whenever an SMTP ETRN
15919 command is received from a host that is permitted to issue such commands (see
15920 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15921 are independently expanded. The expansion variable &$domain$& is set to the
15922 argument of the ETRN command, and no syntax checking is done on it. For
15923 example:
15924 .code
15925 smtp_etrn_command = /etc/etrn_command $domain \
15926                     $sender_host_address
15927 .endd
15928 A new process is created to run the command, but Exim does not wait for it to
15929 complete. Consequently, its status cannot be checked. If the command cannot be
15930 run, a line is written to the panic log, but the ETRN caller still receives
15931 a 250 success response. Exim is normally running under its own uid when
15932 receiving SMTP, so it is not possible for it to change the uid before running
15933 the command.
15934
15935
15936 .option smtp_etrn_serialize main boolean true
15937 .cindex "ETRN" "serializing"
15938 When this option is set, it prevents the simultaneous execution of more than
15939 one identical command as a result of ETRN in an SMTP connection. See
15940 section &<<SECTETRN>>& for details.
15941
15942
15943 .option smtp_load_reserve main fixed-point unset
15944 .cindex "load average"
15945 If the system load average ever gets higher than this, incoming SMTP calls are
15946 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15947 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15948 the load is over the limit. The option has no effect on ancient operating
15949 systems on which Exim cannot determine the load average. See also
15950 &%deliver_queue_load_max%& and &%queue_only_load%&.
15951
15952
15953
15954 .option smtp_max_synprot_errors main integer 3
15955 .cindex "SMTP" "limiting syntax and protocol errors"
15956 .cindex "limit" "SMTP syntax and protocol errors"
15957 Exim rejects SMTP commands that contain syntax or protocol errors. In
15958 particular, a syntactically invalid email address, as in this command:
15959 .code
15960 RCPT TO:<abc xyz@a.b.c>
15961 .endd
15962 causes immediate rejection of the command, before any other tests are done.
15963 (The ACL cannot be run if there is no valid address to set up for it.) An
15964 example of a protocol error is receiving RCPT before MAIL. If there are
15965 too many syntax or protocol errors in one SMTP session, the connection is
15966 dropped. The limit is set by this option.
15967
15968 .cindex "PIPELINING" "expected errors"
15969 When the PIPELINING extension to SMTP is in use, some protocol errors are
15970 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15971 Exim assumes that PIPELINING will be used if it advertises it (see
15972 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15973 not count towards the limit.
15974
15975
15976
15977 .option smtp_max_unknown_commands main integer 3
15978 .cindex "SMTP" "limiting unknown commands"
15979 .cindex "limit" "unknown SMTP commands"
15980 If there are too many unrecognized commands in an incoming SMTP session, an
15981 Exim server drops the connection. This is a defence against some kinds of abuse
15982 that subvert web
15983 clients
15984 into making connections to SMTP ports; in these circumstances, a number of
15985 non-SMTP command lines are sent first.
15986
15987
15988
15989 .option smtp_ratelimit_hosts main "host list&!!" unset
15990 .cindex "SMTP" "rate limiting"
15991 .cindex "limit" "rate of message arrival"
15992 .cindex "RCPT" "rate limiting"
15993 Some sites find it helpful to be able to limit the rate at which certain hosts
15994 can send them messages, and the rate at which an individual message can specify
15995 recipients.
15996
15997 Exim has two rate-limiting facilities. This section describes the older
15998 facility, which can limit rates within a single connection. The newer
15999 &%ratelimit%& ACL condition can limit rates across all connections. See section
16000 &<<SECTratelimiting>>& for details of the newer facility.
16001
16002 When a host matches &%smtp_ratelimit_hosts%&, the values of
16003 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16004 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16005 respectively. Each option, if set, must contain a set of four comma-separated
16006 values:
16007
16008 .ilist
16009 A threshold, before which there is no rate limiting.
16010 .next
16011 An initial time delay. Unlike other times in Exim, numbers with decimal
16012 fractional parts are allowed here.
16013 .next
16014 A factor by which to increase the delay each time.
16015 .next
16016 A maximum value for the delay. This should normally be less than 5 minutes,
16017 because after that time, the client is liable to timeout the SMTP command.
16018 .endlist
16019
16020 For example, these settings have been used successfully at the site which
16021 first suggested this feature, for controlling mail from their customers:
16022 .code
16023 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16024 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16025 .endd
16026 The first setting specifies delays that are applied to MAIL commands after
16027 two have been received over a single connection. The initial delay is 0.5
16028 seconds, increasing by a factor of 1.05 each time. The second setting applies
16029 delays to RCPT commands when more than four occur in a single message.
16030
16031
16032 .option smtp_ratelimit_mail main string unset
16033 See &%smtp_ratelimit_hosts%& above.
16034
16035
16036 .option smtp_ratelimit_rcpt main string unset
16037 See &%smtp_ratelimit_hosts%& above.
16038
16039
16040 .option smtp_receive_timeout main time 5m
16041 .cindex "timeout" "for SMTP input"
16042 .cindex "SMTP" "input timeout"
16043 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16044 input, including batch SMTP. If a line of input (either an SMTP command or a
16045 data line) is not received within this time, the SMTP connection is dropped and
16046 the message is abandoned.
16047 A line is written to the log containing one of the following messages:
16048 .code
16049 SMTP command timeout on connection from...
16050 SMTP data timeout on connection from...
16051 .endd
16052 The former means that Exim was expecting to read an SMTP command; the latter
16053 means that it was in the DATA phase, reading the contents of a message.
16054
16055
16056 .oindex "&%-os%&"
16057 The value set by this option can be overridden by the
16058 &%-os%& command-line option. A setting of zero time disables the timeout, but
16059 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16060 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16061 timeout is controlled by &%receive_timeout%& and &%-or%&.
16062
16063
16064 .option smtp_reserve_hosts main "host list&!!" unset
16065 This option defines hosts for which SMTP connections are reserved; see
16066 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16067
16068
16069 .option smtp_return_error_details main boolean false
16070 .cindex "SMTP" "details policy failures"
16071 .cindex "policy control" "rejection, returning details"
16072 In the default state, Exim uses bland messages such as
16073 &"Administrative prohibition"& when it rejects SMTP commands for policy
16074 reasons. Many sysadmins like this because it gives away little information
16075 to spammers. However, some other sysadmins who are applying strict checking
16076 policies want to give out much fuller information about failures. Setting
16077 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16078 example, instead of &"Administrative prohibition"&, it might give:
16079 .code
16080 550-Rejected after DATA: '>' missing at end of address:
16081 550 failing address in "From" header is: <user@dom.ain
16082 .endd
16083
16084 .option spamd_address main string "see below"
16085 This option is available when Exim is compiled with the content-scanning
16086 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16087 The default value is
16088 .code
16089 127.0.0.1 783
16090 .endd
16091 See section &<<SECTscanspamass>>& for more details.
16092
16093
16094
16095 .option split_spool_directory main boolean false
16096 .cindex "multiple spool directories"
16097 .cindex "spool directory" "split"
16098 .cindex "directories, multiple"
16099 If this option is set, it causes Exim to split its input directory into 62
16100 subdirectories, each with a single alphanumeric character as its name. The
16101 sixth character of the message id is used to allocate messages to
16102 subdirectories; this is the least significant base-62 digit of the time of
16103 arrival of the message.
16104
16105 Splitting up the spool in this way may provide better performance on systems
16106 where there are long mail queues, by reducing the number of files in any one
16107 directory. The msglog directory is also split up in a similar way to the input
16108 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16109 are still placed in the single directory &_msglog.OLD_&.
16110
16111 It is not necessary to take any special action for existing messages when
16112 changing &%split_spool_directory%&. Exim notices messages that are in the
16113 &"wrong"& place, and continues to process them. If the option is turned off
16114 after a period of being on, the subdirectories will eventually empty and be
16115 automatically deleted.
16116
16117 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16118 changes. Instead of creating a list of all messages in the queue, and then
16119 trying to deliver each one in turn, it constructs a list of those in one
16120 sub-directory and tries to deliver them, before moving on to the next
16121 sub-directory. The sub-directories are processed in a random order. This
16122 spreads out the scanning of the input directories, and uses less memory. It is
16123 particularly beneficial when there are lots of messages on the queue. However,
16124 if &%queue_run_in_order%& is set, none of this new processing happens. The
16125 entire queue has to be scanned and sorted before any deliveries can start.
16126
16127
16128 .option spool_directory main string&!! "set at compile time"
16129 .cindex "spool directory" "path to"
16130 This defines the directory in which Exim keeps its spool, that is, the messages
16131 it is waiting to deliver. The default value is taken from the compile-time
16132 configuration setting, if there is one. If not, this option must be set. The
16133 string is expanded, so it can contain, for example, a reference to
16134 &$primary_hostname$&.
16135
16136 If the spool directory name is fixed on your installation, it is recommended
16137 that you set it at build time rather than from this option, particularly if the
16138 log files are being written to the spool directory (see &%log_file_path%&).
16139 Otherwise log files cannot be used for errors that are detected early on, such
16140 as failures in the configuration file.
16141
16142 By using this option to override the compiled-in path, it is possible to run
16143 tests of Exim without using the standard spool.
16144
16145 .option sqlite_lock_timeout main time 5s
16146 .cindex "sqlite lookup type" "lock timeout"
16147 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16148 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16149
16150 .option strict_acl_vars main boolean false
16151 .cindex "&ACL;" "variables, handling unset"
16152 This option controls what happens if a syntactically valid but undefined ACL
16153 variable is referenced. If it is false (the default), an empty string
16154 is substituted; if it is true, an error is generated. See section
16155 &<<SECTaclvariables>>& for details of ACL variables.
16156
16157 .option strip_excess_angle_brackets main boolean false
16158 .cindex "angle brackets, excess"
16159 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16160 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16161 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16162 passed on to another MTA, the excess angle brackets are not passed on. If this
16163 option is not set, multiple pairs of angle brackets cause a syntax error.
16164
16165
16166 .option strip_trailing_dot main boolean false
16167 .cindex "trailing dot on domain"
16168 .cindex "dot" "trailing on domain"
16169 If this option is set, a trailing dot at the end of a domain in an address is
16170 ignored. If this is in the envelope and the message is passed on to another
16171 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16172 domain causes a syntax error.
16173 However, addresses in header lines are checked only when an ACL requests header
16174 syntax checking.
16175
16176
16177 .option syslog_duplication main boolean true
16178 .cindex "syslog" "duplicate log lines; suppressing"
16179 When Exim is logging to syslog, it writes the log lines for its three
16180 separate logs at different syslog priorities so that they can in principle
16181 be separated on the logging hosts. Some installations do not require this
16182 separation, and in those cases, the duplication of certain log lines is a
16183 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16184 particular log line is written to syslog. For lines that normally go to
16185 both the main log and the reject log, the reject log version (possibly
16186 containing message header lines) is written, at LOG_NOTICE priority.
16187 Lines that normally go to both the main and the panic log are written at
16188 the LOG_ALERT priority.
16189
16190
16191 .option syslog_facility main string unset
16192 .cindex "syslog" "facility; setting"
16193 This option sets the syslog &"facility"& name, used when Exim is logging to
16194 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16195 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16196 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16197 details of Exim's logging.
16198
16199
16200
16201 .option syslog_processname main string &`exim`&
16202 .cindex "syslog" "process name; setting"
16203 This option sets the syslog &"ident"& name, used when Exim is logging to
16204 syslog. The value must be no longer than 32 characters. See chapter
16205 &<<CHAPlog>>& for details of Exim's logging.
16206
16207
16208
16209 .option syslog_timestamp main boolean true
16210 .cindex "syslog" "timestamps"
16211 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16212 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16213 details of Exim's logging.
16214
16215
16216 .option system_filter main string&!! unset
16217 .cindex "filter" "system filter"
16218 .cindex "system filter" "specifying"
16219 .cindex "Sieve filter" "not available for system filter"
16220 This option specifies an Exim filter file that is applied to all messages at
16221 the start of each delivery attempt, before any routing is done. System filters
16222 must be Exim filters; they cannot be Sieve filters. If the system filter
16223 generates any deliveries to files or pipes, or any new mail messages, the
16224 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16225 which transports are to be used. Details of this facility are given in chapter
16226 &<<CHAPsystemfilter>>&.
16227
16228
16229 .option system_filter_directory_transport main string&!! unset
16230 .vindex "&$address_file$&"
16231 This sets the name of the transport driver that is to be used when the
16232 &%save%& command in a system message filter specifies a path ending in &"/"&,
16233 implying delivery of each message into a separate file in some directory.
16234 During the delivery, the variable &$address_file$& contains the path name.
16235
16236
16237 .option system_filter_file_transport main string&!! unset
16238 .cindex "file" "transport for system filter"
16239 This sets the name of the transport driver that is to be used when the &%save%&
16240 command in a system message filter specifies a path not ending in &"/"&. During
16241 the delivery, the variable &$address_file$& contains the path name.
16242
16243 .option system_filter_group main string unset
16244 .cindex "gid (group id)" "system filter"
16245 This option is used only when &%system_filter_user%& is also set. It sets the
16246 gid under which the system filter is run, overriding any gid that is associated
16247 with the user. The value may be numerical or symbolic.
16248
16249 .option system_filter_pipe_transport main string&!! unset
16250 .cindex "&(pipe)& transport" "for system filter"
16251 .vindex "&$address_pipe$&"
16252 This specifies the transport driver that is to be used when a &%pipe%& command
16253 is used in a system filter. During the delivery, the variable &$address_pipe$&
16254 contains the pipe command.
16255
16256
16257 .option system_filter_reply_transport main string&!! unset
16258 .cindex "&(autoreply)& transport" "for system filter"
16259 This specifies the transport driver that is to be used when a &%mail%& command
16260 is used in a system filter.
16261
16262
16263 .option system_filter_user main string unset
16264 .cindex "uid (user id)" "system filter"
16265 If this option is set to root, the system filter is run in the main Exim
16266 delivery process, as root.  Otherwise, the system filter runs in a separate
16267 process, as the given user, defaulting to the Exim run-time user.
16268 Unless the string consists entirely of digits, it
16269 is looked up in the password data. Failure to find the named user causes a
16270 configuration error. The gid is either taken from the password data, or
16271 specified by &%system_filter_group%&. When the uid is specified numerically,
16272 &%system_filter_group%& is required to be set.
16273
16274 If the system filter generates any pipe, file, or reply deliveries, the uid
16275 under which the filter is run is used when transporting them, unless a
16276 transport option overrides.
16277
16278
16279 .option tcp_nodelay main boolean true
16280 .cindex "daemon" "TCP_NODELAY on sockets"
16281 .cindex "Nagle algorithm"
16282 .cindex "TCP_NODELAY on listening sockets"
16283 If this option is set false, it stops the Exim daemon setting the
16284 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16285 turns off the &"Nagle algorithm"&, which is a way of improving network
16286 performance in interactive (character-by-character) situations. Turning it off
16287 should improve Exim's performance a bit, so that is what happens by default.
16288 However, it appears that some broken clients cannot cope, and time out. Hence
16289 this option. It affects only those sockets that are set up for listening by the
16290 daemon. Sockets created by the smtp transport for delivering mail always set
16291 TCP_NODELAY.
16292
16293
16294 .option timeout_frozen_after main time 0s
16295 .cindex "frozen messages" "timing out"
16296 .cindex "timeout" "frozen messages"
16297 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16298 message of any kind that has been on the queue for longer than the given time
16299 is automatically cancelled at the next queue run. If the frozen message is a
16300 bounce message, it is just discarded; otherwise, a bounce is sent to the
16301 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16302 If you want to timeout frozen bounce messages earlier than other kinds of
16303 frozen message, see &%ignore_bounce_errors_after%&.
16304
16305 &*Note:*& the default value of zero means no timeouts; with this setting,
16306 frozen messages remain on the queue forever (except for any frozen bounce
16307 messages that are released by &%ignore_bounce_errors_after%&).
16308
16309
16310 .option timezone main string unset
16311 .cindex "timezone, setting"
16312 The value of &%timezone%& is used to set the environment variable TZ while
16313 running Exim (if it is different on entry). This ensures that all timestamps
16314 created by Exim are in the required timezone. If you want all your timestamps
16315 to be in UTC (aka GMT) you should set
16316 .code
16317 timezone = UTC
16318 .endd
16319 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16320 or, if that is not set, from the value of the TZ environment variable when Exim
16321 is built. If &%timezone%& is set to the empty string, either at build or run
16322 time, any existing TZ variable is removed from the environment when Exim
16323 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16324 unfortunately not all, operating systems.
16325
16326
16327 .option tls_advertise_hosts main "host list&!!" unset
16328 .cindex "TLS" "advertising"
16329 .cindex "encryption" "on SMTP connection"
16330 .cindex "SMTP" "encrypted connection"
16331 When Exim is built with support for TLS encrypted connections, the availability
16332 of the STARTTLS command to set up an encrypted session is advertised in
16333 response to EHLO only to those client hosts that match this option. See
16334 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16335
16336
16337 .option tls_certificate main string&!! unset
16338 .cindex "TLS" "server certificate; location of"
16339 .cindex "certificate" "server, location of"
16340 The value of this option is expanded, and must then be the absolute path to a
16341 file which contains the server's certificates. The server's private key is also
16342 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16343 &<<CHAPTLS>>& for further details.
16344
16345 &*Note*&: The certificates defined by this option are used only when Exim is
16346 receiving incoming messages as a server. If you want to supply certificates for
16347 use when sending messages as a client, you must set the &%tls_certificate%&
16348 option in the relevant &(smtp)& transport.
16349
16350 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16351 if the OpenSSL build supports TLS extensions and the TLS client sends the
16352 Server Name Indication extension, then this option and others documented in
16353 &<<SECTtlssni>>& will be re-expanded.
16354
16355 .option tls_crl main string&!! unset
16356 .cindex "TLS" "server certificate revocation list"
16357 .cindex "certificate" "revocation list for server"
16358 This option specifies a certificate revocation list. The expanded value must
16359 be the name of a file that contains a CRL in PEM format.
16360
16361 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16362
16363
16364 .option tls_dh_max_bits main integer 2236
16365 .cindex "TLS" "D-H bit count"
16366 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16367 the chosen TLS library.  That value might prove to be too high for
16368 interoperability.  This option provides a maximum clamp on the value
16369 suggested, trading off security for interoperability.
16370
16371 The value must be at least 1024.
16372
16373 The value 2236 was chosen because, at time of adding the option, it was the
16374 hard-coded maximum value supported by the NSS cryptographic library, as used
16375 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16376
16377 If you prefer more security and are willing to break some clients, raise this
16378 number.
16379
16380 Note that the value passed to GnuTLS for *generating* a new prime may be a
16381 little less than this figure, because GnuTLS is inexact and may produce a
16382 larger prime than requested.
16383
16384
16385 .option tls_dhparam main string&!! unset
16386 .cindex "TLS" "D-H parameters for server"
16387 The value of this option is expanded and indicates the source of DH parameters
16388 to be used by Exim.
16389
16390 If it is a filename starting with a &`/`&, then it names a file from which DH
16391 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16392 PKCS#3 representation of the DH prime.  If the file does not exist, for
16393 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16394 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16395 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16396 and treated as though the &%tls_dhparam%& were set to "none".
16397
16398 If this option expands to the string "none", then no DH parameters will be
16399 loaded by Exim.
16400
16401 If this option expands to the string "historic" and Exim is using GnuTLS, then
16402 Exim will attempt to load a file from inside the spool directory.  If the file
16403 does not exist, Exim will attempt to create it.
16404 See section &<<SECTgnutlsparam>>& for further details.
16405
16406 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16407 a default DH prime; the default is the 2048 bit prime described in section
16408 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16409 in IKE is assigned number 23.
16410
16411 Otherwise, the option must expand to the name used by Exim for any of a number
16412 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16413 "ike" followed by the number used by IKE, of "default" which corresponds to
16414 "ike23".
16415
16416 The available primes are:
16417 &`ike1`&, &`ike2`&, &`ike5`&,
16418 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16419 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16420
16421 Some of these will be too small to be accepted by clients.
16422 Some may be too large to be accepted by clients.
16423
16424 The TLS protocol does not negotiate an acceptable size for this; clients tend
16425 to hard-drop connections if what is offered by the server is unacceptable,
16426 whether too large or too small, and there's no provision for the client to
16427 tell the server what these constraints are.  Thus, as a server operator, you
16428 need to make an educated guess as to what is most likely to work for your
16429 userbase.
16430
16431 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16432 is most likely to maximise interoperability.  The upper bound comes from
16433 applications using the Mozilla Network Security Services (NSS) library, which
16434 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16435 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16436 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16437 acceptable bound from 1024 to 2048.
16438
16439
16440 .option tls_ocsp_file main string&!! unset
16441 This option
16442 must if set expand to the absolute path to a file which contains a current
16443 status proof for the server's certificate, as obtained from the
16444 Certificate Authority.
16445
16446
16447 .option tls_on_connect_ports main "string list" unset
16448 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16449 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16450 set up without waiting for the client to issue a STARTTLS command. For
16451 further details, see section &<<SECTsupobssmt>>&.
16452
16453
16454
16455 .option tls_privatekey main string&!! unset
16456 .cindex "TLS" "server private key; location of"
16457 The value of this option is expanded, and must then be the absolute path to a
16458 file which contains the server's private key. If this option is unset, or if
16459 the expansion is forced to fail, or the result is an empty string, the private
16460 key is assumed to be in the same file as the server's certificates. See chapter
16461 &<<CHAPTLS>>& for further details.
16462
16463 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16464
16465
16466 .option tls_remember_esmtp main boolean false
16467 .cindex "TLS" "esmtp state; remembering"
16468 .cindex "TLS" "broken clients"
16469 If this option is set true, Exim violates the RFCs by remembering that it is in
16470 &"esmtp"& state after successfully negotiating a TLS session. This provides
16471 support for broken clients that fail to send a new EHLO after starting a
16472 TLS session.
16473
16474
16475 .option tls_require_ciphers main string&!! unset
16476 .cindex "TLS" "requiring specific ciphers"
16477 .cindex "cipher" "requiring specific"
16478 This option controls which ciphers can be used for incoming TLS connections.
16479 The &(smtp)& transport has an option of the same name for controlling outgoing
16480 connections. This option is expanded for each connection, so can be varied for
16481 different clients if required. The value of this option must be a list of
16482 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16483 in somewhat different ways. If GnuTLS is being used, the client controls the
16484 preference order of the available ciphers. Details are given in sections
16485 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16486
16487
16488 .option tls_try_verify_hosts main "host list&!!" unset
16489 .cindex "TLS" "client certificate verification"
16490 .cindex "certificate" "verification of client"
16491 See &%tls_verify_hosts%& below.
16492
16493
16494 .option tls_verify_certificates main string&!! unset
16495 .cindex "TLS" "client certificate verification"
16496 .cindex "certificate" "verification of client"
16497 The value of this option is expanded, and must then be the absolute path to
16498 a file containing permitted certificates for clients that
16499 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16500 are using either GnuTLS version 3.3.6 (or later) or OpenSSL,
16501 you can set &%tls_verify_certificates%& to the name of a
16502 directory containing certificate files.
16503 For earlier versions of GnuTLS
16504 the option must be set to the name of a single file.
16505
16506 These certificates should be for the certificate authorities trusted, rather
16507 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16508 the value is a file then the certificates are sent by Exim as a server to
16509 connecting clients, defining the list of accepted certificate authorities.
16510 Thus the values defined should be considered public data.  To avoid this,
16511 use OpenSSL with a directory.
16512
16513 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16514
16515 A forced expansion failure or setting to an empty string is equivalent to
16516 being unset.
16517
16518
16519 .option tls_verify_hosts main "host list&!!" unset
16520 .cindex "TLS" "client certificate verification"
16521 .cindex "certificate" "verification of client"
16522 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16523 certificates from clients. The expected certificates are defined by
16524 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16525 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16526 &%tls_verify_certificates%& is not set.
16527
16528 Any client that matches &%tls_verify_hosts%& is constrained by
16529 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16530 present one of the listed certificates. If it does not, the connection is
16531 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16532 the host to use TLS. It can still send SMTP commands through unencrypted
16533 connections. Forcing a client to use TLS has to be done separately using an
16534 ACL to reject inappropriate commands when the connection is not encrypted.
16535
16536 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16537 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16538 certificate and checks it against &%tls_verify_certificates%&, but does not
16539 abort the connection if there is no certificate or if it does not match. This
16540 state can be detected in an ACL, which makes it possible to implement policies
16541 such as &"accept for relay only if a verified certificate has been received,
16542 but accept for local delivery if encrypted, even without a verified
16543 certificate"&.
16544
16545 Client hosts that match neither of these lists are not asked to present
16546 certificates.
16547
16548
16549 .option trusted_groups main "string list&!!" unset
16550 .cindex "trusted groups"
16551 .cindex "groups" "trusted"
16552 This option is expanded just once, at the start of Exim's processing. If this
16553 option is set, any process that is running in one of the listed groups, or
16554 which has one of them as a supplementary group, is trusted. The groups can be
16555 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16556 details of what trusted callers are permitted to do. If neither
16557 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16558 are trusted.
16559
16560 .option trusted_users main "string list&!!" unset
16561 .cindex "trusted users"
16562 .cindex "user" "trusted"
16563 This option is expanded just once, at the start of Exim's processing. If this
16564 option is set, any process that is running as one of the listed users is
16565 trusted. The users can be specified numerically or by name. See section
16566 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16567 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16568 Exim user are trusted.
16569
16570 .option unknown_login main string&!! unset
16571 .cindex "uid (user id)" "unknown caller"
16572 .vindex "&$caller_uid$&"
16573 This is a specialized feature for use in unusual configurations. By default, if
16574 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16575 gives up. The &%unknown_login%& option can be used to set a login name to be
16576 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16577 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16578 is used for the user's real name (gecos field), unless this has been set by the
16579 &%-F%& option.
16580
16581 .option unknown_username main string unset
16582 See &%unknown_login%&.
16583
16584 .option untrusted_set_sender main "address list&!!" unset
16585 .cindex "trusted users"
16586 .cindex "sender" "setting by untrusted user"
16587 .cindex "untrusted user setting sender"
16588 .cindex "user" "untrusted setting sender"
16589 .cindex "envelope sender"
16590 When an untrusted user submits a message to Exim using the standard input, Exim
16591 normally creates an envelope sender address from the user's login and the
16592 default qualification domain. Data from the &%-f%& option (for setting envelope
16593 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16594 is used) is ignored.
16595
16596 However, untrusted users are permitted to set an empty envelope sender address,
16597 to declare that a message should never generate any bounces. For example:
16598 .code
16599 exim -f '<>' user@domain.example
16600 .endd
16601 .vindex "&$sender_ident$&"
16602 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16603 other envelope sender addresses in a controlled way. When it is set, untrusted
16604 users are allowed to set envelope sender addresses that match any of the
16605 patterns in the list. Like all address lists, the string is expanded. The
16606 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16607 users to setting senders that start with their login ids
16608 followed by a hyphen
16609 by a setting like this:
16610 .code
16611 untrusted_set_sender = ^$sender_ident-
16612 .endd
16613 If you want to allow untrusted users to set envelope sender addresses without
16614 restriction, you can use
16615 .code
16616 untrusted_set_sender = *
16617 .endd
16618 The &%untrusted_set_sender%& option applies to all forms of local input, but
16619 only to the setting of the envelope sender. It does not permit untrusted users
16620 to use the other options which trusted user can use to override message
16621 parameters. Furthermore, it does not stop Exim from removing an existing
16622 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16623 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16624 overriding these actions. The handling of the &'Sender:'& header is also
16625 described in section &<<SECTthesenhea>>&.
16626
16627 The log line for a message's arrival shows the envelope sender following
16628 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16629 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16630 envelope sender address, the user's login is shown in parentheses after the
16631 sender address.
16632
16633
16634 .option uucp_from_pattern main string "see below"
16635 .cindex "&""From""& line"
16636 .cindex "UUCP" "&""From""& line"
16637 Some applications that pass messages to an MTA via a command line interface use
16638 an initial line starting with &"From&~"& to pass the envelope sender. In
16639 particular, this is used by UUCP software. Exim recognizes such a line by means
16640 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16641 matches, the sender address is constructed by expanding the contents of
16642 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16643 default pattern recognizes lines in the following two forms:
16644 .code
16645 From ph10 Fri Jan  5 12:35 GMT 1996
16646 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16647 .endd
16648 The pattern can be seen by running
16649 .code
16650 exim -bP uucp_from_pattern
16651 .endd
16652 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16653 year in the second case. The first word after &"From&~"& is matched in the
16654 regular expression by a parenthesized subpattern. The default value for
16655 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16656 (&"ph10"& in the example above) as the message's sender. See also
16657 &%ignore_fromline_hosts%&.
16658
16659
16660 .option uucp_from_sender main string&!! &`$1`&
16661 See &%uucp_from_pattern%& above.
16662
16663
16664 .option warn_message_file main string unset
16665 .cindex "warning of delay" "customizing the message"
16666 .cindex "customizing" "warning message"
16667 This option defines a template file containing paragraphs of text to be used
16668 for constructing the warning message which is sent by Exim when a message has
16669 been on the queue for a specified amount of time, as specified by
16670 &%delay_warning%&. Details of the file's contents are given in chapter
16671 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16672
16673
16674 .option write_rejectlog main boolean true
16675 .cindex "reject log" "disabling"
16676 If this option is set false, Exim no longer writes anything to the reject log.
16677 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16678 .ecindex IIDconfima
16679 .ecindex IIDmaiconf
16680
16681
16682
16683
16684 . ////////////////////////////////////////////////////////////////////////////
16685 . ////////////////////////////////////////////////////////////////////////////
16686
16687 .chapter "Generic options for routers" "CHAProutergeneric"
16688 .scindex IIDgenoprou1 "options" "generic; for routers"
16689 .scindex IIDgenoprou2 "generic options" "router"
16690 This chapter describes the generic options that apply to all routers.
16691 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16692
16693 For a general description of how a router operates, see sections
16694 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16695 which the preconditions are tested. The order of expansion of the options that
16696 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16697 &%headers_remove%&, &%transport%&.
16698
16699
16700
16701 .option address_data routers string&!! unset
16702 .cindex "router" "data attached to address"
16703 The string is expanded just before the router is run, that is, after all the
16704 precondition tests have succeeded. If the expansion is forced to fail, the
16705 router declines, the value of &%address_data%& remains unchanged, and the
16706 &%more%& option controls what happens next. Other expansion failures cause
16707 delivery of the address to be deferred.
16708
16709 .vindex "&$address_data$&"
16710 When the expansion succeeds, the value is retained with the address, and can be
16711 accessed using the variable &$address_data$& in the current router, subsequent
16712 routers, and the eventual transport.
16713
16714 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16715 that runs a user's filter file, the contents of &$address_data$& are accessible
16716 in the filter. This is not normally a problem, because such data is usually
16717 either not confidential or it &"belongs"& to the current user, but if you do
16718 put confidential data into &$address_data$& you need to remember this point.
16719
16720 Even if the router declines or passes, the value of &$address_data$& remains
16721 with the address, though it can be changed by another &%address_data%& setting
16722 on a subsequent router. If a router generates child addresses, the value of
16723 &$address_data$& propagates to them. This also applies to the special kind of
16724 &"child"& that is generated by a router with the &%unseen%& option.
16725
16726 The idea of &%address_data%& is that you can use it to look up a lot of data
16727 for the address once, and then pick out parts of the data later. For example,
16728 you could use a single LDAP lookup to return a string of the form
16729 .code
16730 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16731 .endd
16732 In the transport you could pick out the mailbox by a setting such as
16733 .code
16734 file = ${extract{mailbox}{$address_data}}
16735 .endd
16736 This makes the configuration file less messy, and also reduces the number of
16737 lookups (though Exim does cache lookups).
16738
16739 .vindex "&$sender_address_data$&"
16740 .vindex "&$address_data$&"
16741 The &%address_data%& facility is also useful as a means of passing information
16742 from one router to another, and from a router to a transport. In addition, if
16743 &$address_data$& is set by a router when verifying a recipient address from an
16744 ACL, it remains available for use in the rest of the ACL statement. After
16745 verifying a sender, the value is transferred to &$sender_address_data$&.
16746
16747
16748
16749 .option address_test routers&!? boolean true
16750 .oindex "&%-bt%&"
16751 .cindex "router" "skipping when address testing"
16752 If this option is set false, the router is skipped when routing is being tested
16753 by means of the &%-bt%& command line option. This can be a convenience when
16754 your first router sends messages to an external scanner, because it saves you
16755 having to set the &"already scanned"& indicator when testing real address
16756 routing.
16757
16758
16759
16760 .option cannot_route_message routers string&!! unset
16761 .cindex "router" "customizing &""cannot route""& message"
16762 .cindex "customizing" "&""cannot route""& message"
16763 This option specifies a text message that is used when an address cannot be
16764 routed because Exim has run out of routers. The default message is
16765 &"Unrouteable address"&. This option is useful only on routers that have
16766 &%more%& set false, or on the very last router in a configuration, because the
16767 value that is used is taken from the last router that is considered. This
16768 includes a router that is skipped because its preconditions are not met, as
16769 well as a router that declines. For example, using the default configuration,
16770 you could put:
16771 .code
16772 cannot_route_message = Remote domain not found in DNS
16773 .endd
16774 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16775 and
16776 .code
16777 cannot_route_message = Unknown local user
16778 .endd
16779 on the final router that checks for local users. If string expansion fails for
16780 this option, the default message is used. Unless the expansion failure was
16781 explicitly forced, a message about the failure is written to the main and panic
16782 logs, in addition to the normal message about the routing failure.
16783
16784
16785 .option caseful_local_part routers boolean false
16786 .cindex "case of local parts"
16787 .cindex "router" "case of local parts"
16788 By default, routers handle the local parts of addresses in a case-insensitive
16789 manner, though the actual case is preserved for transmission with the message.
16790 If you want the case of letters to be significant in a router, you must set
16791 this option true. For individual router options that contain address or local
16792 part lists (for example, &%local_parts%&), case-sensitive matching can be
16793 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16794 more details.
16795
16796 .vindex "&$local_part$&"
16797 .vindex "&$original_local_part$&"
16798 .vindex "&$parent_local_part$&"
16799 The value of the &$local_part$& variable is forced to lower case while a
16800 router is running unless &%caseful_local_part%& is set. When a router assigns
16801 an address to a transport, the value of &$local_part$& when the transport runs
16802 is the same as it was in the router. Similarly, when a router generates child
16803 addresses by aliasing or forwarding, the values of &$original_local_part$&
16804 and &$parent_local_part$& are those that were used by the redirecting router.
16805
16806 This option applies to the processing of an address by a router. When a
16807 recipient address is being processed in an ACL, there is a separate &%control%&
16808 modifier that can be used to specify case-sensitive processing within the ACL
16809 (see section &<<SECTcontrols>>&).
16810
16811
16812
16813 .option check_local_user routers&!? boolean false
16814 .cindex "local user, checking in router"
16815 .cindex "router" "checking for local user"
16816 .cindex "&_/etc/passwd_&"
16817 .vindex "&$home$&"
16818 When this option is true, Exim checks that the local part of the recipient
16819 address (with affixes removed if relevant) is the name of an account on the
16820 local system. The check is done by calling the &[getpwnam()]& function rather
16821 than trying to read &_/etc/passwd_& directly. This means that other methods of
16822 holding password data (such as NIS) are supported. If the local part is a local
16823 user, &$home$& is set from the password data, and can be tested in other
16824 preconditions that are evaluated after this one (the order of evaluation is
16825 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16826 overridden by &%router_home_directory%&. If the local part is not a local user,
16827 the router is skipped.
16828
16829 If you want to check that the local part is either the name of a local user
16830 or matches something else, you cannot combine &%check_local_user%& with a
16831 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16832 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16833 setting to achieve this. For example:
16834 .code
16835 local_parts = passwd;$local_part : lsearch;/etc/other/users
16836 .endd
16837 Note, however, that the side effects of &%check_local_user%& (such as setting
16838 up a home directory) do not occur when a &(passwd)& lookup is used in a
16839 &%local_parts%& (or any other) precondition.
16840
16841
16842
16843 .option condition routers&!? string&!! unset
16844 .cindex "router" "customized precondition"
16845 This option specifies a general precondition test that has to succeed for the
16846 router to be called. The &%condition%& option is the last precondition to be
16847 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16848 result is a forced failure, or an empty string, or one of the strings &"0"& or
16849 &"no"& or &"false"& (checked without regard to the case of the letters), the
16850 router is skipped, and the address is offered to the next one.
16851
16852 If the result is any other value, the router is run (as this is the last
16853 precondition to be evaluated, all the other preconditions must be true).
16854
16855 This option is unusual in that multiple &%condition%& options may be present.
16856 All &%condition%& options must succeed.
16857
16858 The &%condition%& option provides a means of applying custom conditions to the
16859 running of routers. Note that in the case of a simple conditional expansion,
16860 the default expansion values are exactly what is wanted. For example:
16861 .code
16862 condition = ${if >{$message_age}{600}}
16863 .endd
16864 Because of the default behaviour of the string expansion, this is equivalent to
16865 .code
16866 condition = ${if >{$message_age}{600}{true}{}}
16867 .endd
16868
16869 A multiple condition example, which succeeds:
16870 .code
16871 condition = ${if >{$message_age}{600}}
16872 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16873 condition = foobar
16874 .endd
16875
16876 If the expansion fails (other than forced failure) delivery is deferred. Some
16877 of the other precondition options are common special cases that could in fact
16878 be specified using &%condition%&.
16879
16880 .new
16881 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16882 are far older, and use one set of semantics.  ACLs are newer and when
16883 they were created, the ACL &%condition%& process was given far stricter
16884 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16885 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16886 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16887 Router rules processing behavior.
16888
16889 This is best illustrated in an example:
16890 .code
16891 # If used in an ACL condition will fail with a syntax error, but
16892 # in a router condition any extra characters are treated as a string
16893
16894 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16895 true {yes} {no}}
16896
16897 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16898  {yes} {no}}
16899 .endd
16900 In each example above, the &%if%& statement actually ends after
16901 &"{google.com}}"&.  Since no true or false braces were defined, the
16902 default &%if%& behavior is to return a boolean true or a null answer
16903 (which evaluates to false). The rest of the line is then treated as a
16904 string. So the first example resulted in the boolean answer &"true"&
16905 with the string &" {yes} {no}}"& appended to it. The second example
16906 resulted in the null output (indicating false) with the string
16907 &" {yes} {no}}"& appended to it.
16908
16909 In fact you can put excess forward braces in too.  In the router
16910 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16911 mean something, like after a &"$"& or when required as part of a
16912 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16913 string characters.
16914
16915 Thus, in a Router, the above expansion strings will both always evaluate
16916 true, as the result of expansion is a non-empty string which doesn't
16917 match an explicit false value.  This can be tricky to debug.  By
16918 contrast, in an ACL either of those strings will always result in an
16919 expansion error because the result doesn't look sufficiently boolean.
16920 .wen
16921
16922
16923 .option debug_print routers string&!! unset
16924 .cindex "testing" "variables in drivers"
16925 If this option is set and debugging is enabled (see the &%-d%& command line
16926 option) or in address-testing mode (see the &%-bt%& command line option),
16927 the string is expanded and included in the debugging output.
16928 If expansion of the string fails, the error message is written to the debugging
16929 output, and Exim carries on processing.
16930 This option is provided to help with checking out the values of variables and
16931 so on when debugging router configurations. For example, if a &%condition%&
16932 option appears not to be working, &%debug_print%& can be used to output the
16933 variables it references. The output happens after checks for &%domains%&,
16934 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16935 are tested. A newline is added to the text if it does not end with one.
16936 The variable &$router_name$& contains the name of the router.
16937
16938
16939
16940 .option disable_logging routers boolean false
16941 If this option is set true, nothing is logged for any routing errors
16942 or for any deliveries caused by this router. You should not set this option
16943 unless you really, really know what you are doing. See also the generic
16944 transport option of the same name.
16945
16946
16947 .option domains routers&!? "domain list&!!" unset
16948 .cindex "router" "restricting to specific domains"
16949 .vindex "&$domain_data$&"
16950 If this option is set, the router is skipped unless the current domain matches
16951 the list. If the match is achieved by means of a file lookup, the data that the
16952 lookup returned for the domain is placed in &$domain_data$& for use in string
16953 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16954 a list of the order in which preconditions are evaluated.
16955
16956
16957
16958 .option driver routers string unset
16959 This option must always be set. It specifies which of the available routers is
16960 to be used.
16961
16962
16963
16964 .option errors_to routers string&!! unset
16965 .cindex "envelope sender"
16966 .cindex "router" "changing address for errors"
16967 If a router successfully handles an address, it may assign the address to a
16968 transport for delivery or it may generate child addresses. In both cases, if
16969 there is a delivery problem during later processing, the resulting bounce
16970 message is sent to the address that results from expanding this string,
16971 provided that the address verifies successfully. The &%errors_to%& option is
16972 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16973
16974 The &%errors_to%& setting associated with an address can be overridden if it
16975 subsequently passes through other routers that have their own &%errors_to%&
16976 settings, or if the message is delivered by a transport with a &%return_path%&
16977 setting.
16978
16979 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16980 the expansion fails to verify, the errors address associated with the incoming
16981 address is used. At top level, this is the envelope sender. A non-forced
16982 expansion failure causes delivery to be deferred.
16983
16984 If an address for which &%errors_to%& has been set ends up being delivered over
16985 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16986 any bounces that are generated by other MTAs on the delivery route are also
16987 sent there. You can set &%errors_to%& to the empty string by either of these
16988 settings:
16989 .code
16990 errors_to =
16991 errors_to = ""
16992 .endd
16993 An expansion item that yields an empty string has the same effect. If you do
16994 this, a locally detected delivery error for addresses processed by this router
16995 no longer gives rise to a bounce message; the error is discarded. If the
16996 address is delivered to a remote host, the return path is set to &`<>`&, unless
16997 overridden by the &%return_path%& option on the transport.
16998
16999 .vindex "&$address_data$&"
17000 If for some reason you want to discard local errors, but use a non-empty
17001 MAIL command for remote delivery, you can preserve the original return
17002 path in &$address_data$& in the router, and reinstate it in the transport by
17003 setting &%return_path%&.
17004
17005 The most common use of &%errors_to%& is to direct mailing list bounces to the
17006 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17007 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17008
17009
17010
17011 .option expn routers&!? boolean true
17012 .cindex "address" "testing"
17013 .cindex "testing" "addresses"
17014 .cindex "EXPN" "router skipping"
17015 .cindex "router" "skipping for EXPN"
17016 If this option is turned off, the router is skipped when testing an address
17017 as a result of processing an SMTP EXPN command. You might, for example,
17018 want to turn it off on a router for users' &_.forward_& files, while leaving it
17019 on for the system alias file.
17020 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17021 are evaluated.
17022
17023 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17024 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17025 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17026
17027
17028
17029 .option fail_verify routers boolean false
17030 .cindex "router" "forcing verification failure"
17031 Setting this option has the effect of setting both &%fail_verify_sender%& and
17032 &%fail_verify_recipient%& to the same value.
17033
17034
17035
17036 .option fail_verify_recipient routers boolean false
17037 If this option is true and an address is accepted by this router when
17038 verifying a recipient, verification fails.
17039
17040
17041
17042 .option fail_verify_sender routers boolean false
17043 If this option is true and an address is accepted by this router when
17044 verifying a sender, verification fails.
17045
17046
17047
17048 .option fallback_hosts routers "string list" unset
17049 .cindex "router" "fallback hosts"
17050 .cindex "fallback" "hosts specified on router"
17051 String expansion is not applied to this option. The argument must be a
17052 colon-separated list of host names or IP addresses. The list separator can be
17053 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17054 each name or address. In fact, the format of each item is exactly the same as
17055 defined for the list of hosts in a &(manualroute)& router (see section
17056 &<<SECTformatonehostitem>>&).
17057
17058 If a router queues an address for a remote transport, this host list is
17059 associated with the address, and used instead of the transport's fallback host
17060 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17061 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17062 transport for further details.
17063
17064
17065 .option group routers string&!! "see below"
17066 .cindex "gid (group id)" "local delivery"
17067 .cindex "local transports" "uid and gid"
17068 .cindex "transport" "local"
17069 .cindex "router" "setting group"
17070 When a router queues an address for a transport, and the transport does not
17071 specify a group, the group given here is used when running the delivery
17072 process.
17073 The group may be specified numerically or by name. If expansion fails, the
17074 error is logged and delivery is deferred.
17075 The default is unset, unless &%check_local_user%& is set, when the default
17076 is taken from the password information. See also &%initgroups%& and &%user%&
17077 and the discussion in chapter &<<CHAPenvironment>>&.
17078
17079
17080
17081 .option headers_add routers list&!! unset
17082 .cindex "header lines" "adding"
17083 .cindex "router" "adding header lines"
17084 This option specifies a list of text headers, newline-separated,
17085 that is associated with any addresses that are accepted by the router.
17086 Each item is separately expanded, at routing time.  However, this
17087 option has no effect when an address is just being verified. The way in which
17088 the text is used to add header lines at transport time is described in section
17089 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17090 message is in the process of being transported. This means that references to
17091 header lines in string expansions in the transport's configuration do not
17092 &"see"& the added header lines.
17093
17094 The &%headers_add%& option is expanded after &%errors_to%&, but before
17095 &%headers_remove%& and &%transport%&. If an item is empty, or if
17096 an item expansion is forced to fail, the item has no effect. Other expansion
17097 failures are treated as configuration errors.
17098
17099 Unlike most options, &%headers_add%& can be specified multiple times
17100 for a router; all listed headers are added.
17101
17102 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17103 router that has the &%one_time%& option set.
17104
17105 .cindex "duplicate addresses"
17106 .oindex "&%unseen%&"
17107 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17108 additions are deleted when the address is passed on to subsequent routers.
17109 For a &%redirect%& router, if a generated address is the same as the incoming
17110 address, this can lead to duplicate addresses with different header
17111 modifications. Exim does not do duplicate deliveries (except, in certain
17112 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17113 which of the duplicates is discarded, so this ambiguous situation should be
17114 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17115
17116
17117
17118 .option headers_remove routers list&!! unset
17119 .cindex "header lines" "removing"
17120 .cindex "router" "removing header lines"
17121 This option specifies a list of text headers, colon-separated,
17122 that is associated with any addresses that are accepted by the router.
17123 Each item is separately expanded, at routing time.  However, this
17124 option has no effect when an address is just being verified. The way in which
17125 the text is used to remove header lines at transport time is described in
17126 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17127 the message is in the process of being transported. This means that references
17128 to header lines in string expansions in the transport's configuration still
17129 &"see"& the original header lines.
17130
17131 The &%headers_remove%& option is expanded after &%errors_to%& and
17132 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17133 the item has no effect. Other expansion failures are treated as configuration
17134 errors.
17135
17136 Unlike most options, &%headers_remove%& can be specified multiple times
17137 for a router; all listed headers are removed.
17138
17139 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17140 router that has the &%one_time%& option set.
17141
17142 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17143 removal requests are deleted when the address is passed on to subsequent
17144 routers, and this can lead to problems with duplicates -- see the similar
17145 warning for &%headers_add%& above.
17146
17147
17148 .option ignore_target_hosts routers "host list&!!" unset
17149 .cindex "IP address" "discarding"
17150 .cindex "router" "discarding IP addresses"
17151 Although this option is a host list, it should normally contain IP address
17152 entries rather than names. If any host that is looked up by the router has an
17153 IP address that matches an item in this list, Exim behaves as if that IP
17154 address did not exist. This option allows you to cope with rogue DNS entries
17155 like
17156 .code
17157 remote.domain.example.  A  127.0.0.1
17158 .endd
17159 by setting
17160 .code
17161 ignore_target_hosts = 127.0.0.1
17162 .endd
17163 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17164 discarded in this way, the router declines. In a conventional configuration, an
17165 attempt to mail to such a domain would normally provoke the &"unrouteable
17166 domain"& error, and an attempt to verify an address in the domain would fail.
17167 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17168 router declines if presented with one of the listed addresses.
17169
17170 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17171 means of the first or the second of the following settings, respectively:
17172 .code
17173 ignore_target_hosts = 0.0.0.0/0
17174 ignore_target_hosts = <; 0::0/0
17175 .endd
17176 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17177 in the second line matches all IPv6 addresses.
17178
17179 This option may also be useful for ignoring link-local and site-local IPv6
17180 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17181 is expanded before use as a list, it is possible to make it dependent on the
17182 domain that is being routed.
17183
17184 .vindex "&$host_address$&"
17185 During its expansion, &$host_address$& is set to the IP address that is being
17186 checked.
17187
17188 .option initgroups routers boolean false
17189 .cindex "additional groups"
17190 .cindex "groups" "additional"
17191 .cindex "local transports" "uid and gid"
17192 .cindex "transport" "local"
17193 If the router queues an address for a transport, and this option is true, and
17194 the uid supplied by the router is not overridden by the transport, the
17195 &[initgroups()]& function is called when running the transport to ensure that
17196 any additional groups associated with the uid are set up. See also &%group%&
17197 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17198
17199
17200
17201 .option local_part_prefix routers&!? "string list" unset
17202 .cindex "router" "prefix for local part"
17203 .cindex "prefix" "for local part, used in router"
17204 If this option is set, the router is skipped unless the local part starts with
17205 one of the given strings, or &%local_part_prefix_optional%& is true. See
17206 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17207 evaluated.
17208
17209 The list is scanned from left to right, and the first prefix that matches is
17210 used. A limited form of wildcard is available; if the prefix begins with an
17211 asterisk, it matches the longest possible sequence of arbitrary characters at
17212 the start of the local part. An asterisk should therefore always be followed by
17213 some character that does not occur in normal local parts.
17214 .cindex "multiple mailboxes"
17215 .cindex "mailbox" "multiple"
17216 Wildcarding can be used to set up multiple user mailboxes, as described in
17217 section &<<SECTmulbox>>&.
17218
17219 .vindex "&$local_part$&"
17220 .vindex "&$local_part_prefix$&"
17221 During the testing of the &%local_parts%& option, and while the router is
17222 running, the prefix is removed from the local part, and is available in the
17223 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17224 the router accepts the address, this remains true during subsequent delivery by
17225 a transport. In particular, the local part that is transmitted in the RCPT
17226 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17227 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17228 the relevant transport.
17229
17230 When an address is being verified, &%local_part_prefix%& affects only the
17231 behaviour of the router. If the callout feature of verification is in use, this
17232 means that the full address, including the prefix, will be used during the
17233 callout.
17234
17235 The prefix facility is commonly used to handle local parts of the form
17236 &%owner-something%&. Another common use is to support local parts of the form
17237 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17238 to tell a user their forwarding is broken &-- by placing a router like this one
17239 immediately before the router that handles &_.forward_& files:
17240 .code
17241 real_localuser:
17242   driver = accept
17243   local_part_prefix = real-
17244   check_local_user
17245   transport = local_delivery
17246 .endd
17247 For security, it would probably be a good idea to restrict the use of this
17248 router to locally-generated messages, using a condition such as this:
17249 .code
17250   condition = ${if match {$sender_host_address}\
17251                          {\N^(|127\.0\.0\.1)$\N}}
17252 .endd
17253
17254 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17255 both conditions must be met if not optional. Care must be taken if wildcards
17256 are used in both a prefix and a suffix on the same router. Different
17257 separator characters must be used to avoid ambiguity.
17258
17259
17260 .option local_part_prefix_optional routers boolean false
17261 See &%local_part_prefix%& above.
17262
17263
17264
17265 .option local_part_suffix routers&!? "string list" unset
17266 .cindex "router" "suffix for local part"
17267 .cindex "suffix for local part" "used in router"
17268 This option operates in the same way as &%local_part_prefix%&, except that the
17269 local part must end (rather than start) with the given string, the
17270 &%local_part_suffix_optional%& option determines whether the suffix is
17271 mandatory, and the wildcard * character, if present, must be the last
17272 character of the suffix. This option facility is commonly used to handle local
17273 parts of the form &%something-request%& and multiple user mailboxes of the form
17274 &%username-foo%&.
17275
17276
17277 .option local_part_suffix_optional routers boolean false
17278 See &%local_part_suffix%& above.
17279
17280
17281
17282 .option local_parts routers&!? "local part list&!!" unset
17283 .cindex "router" "restricting to specific local parts"
17284 .cindex "local part" "checking in router"
17285 The router is run only if the local part of the address matches the list.
17286 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17287 are evaluated, and
17288 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17289 string is expanded, it is possible to make it depend on the domain, for
17290 example:
17291 .code
17292 local_parts = dbm;/usr/local/specials/$domain
17293 .endd
17294 .vindex "&$local_part_data$&"
17295 If the match is achieved by a lookup, the data that the lookup returned
17296 for the local part is placed in the variable &$local_part_data$& for use in
17297 expansions of the router's private options. You might use this option, for
17298 example, if you have a large number of local virtual domains, and you want to
17299 send all postmaster mail to the same place without having to set up an alias in
17300 each virtual domain:
17301 .code
17302 postmaster:
17303   driver = redirect
17304   local_parts = postmaster
17305   data = postmaster@real.domain.example
17306 .endd
17307
17308
17309 .option log_as_local routers boolean "see below"
17310 .cindex "log" "delivery line"
17311 .cindex "delivery" "log line format"
17312 Exim has two logging styles for delivery, the idea being to make local
17313 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17314 recipient address is given just as the local part, without a domain. The use of
17315 this style is controlled by this option. It defaults to true for the &(accept)&
17316 router, and false for all the others. This option applies only when a
17317 router assigns an address to a transport. It has no effect on routers that
17318 redirect addresses.
17319
17320
17321
17322 .option more routers boolean&!! true
17323 The result of string expansion for this option must be a valid boolean value,
17324 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17325 result causes an error, and delivery is deferred. If the expansion is forced to
17326 fail, the default value for the option (true) is used. Other failures cause
17327 delivery to be deferred.
17328
17329 If this option is set false, and the router declines to handle the address, no
17330 further routers are tried, routing fails, and the address is bounced.
17331 .oindex "&%self%&"
17332 However, if the router explicitly passes an address to the following router by
17333 means of the setting
17334 .code
17335 self = pass
17336 .endd
17337 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17338 does not affect the behaviour if one of the precondition tests fails. In that
17339 case, the address is always passed to the next router.
17340
17341 Note that &%address_data%& is not considered to be a precondition. If its
17342 expansion is forced to fail, the router declines, and the value of &%more%&
17343 controls what happens next.
17344
17345
17346 .option pass_on_timeout routers boolean false
17347 .cindex "timeout" "of router"
17348 .cindex "router" "timeout"
17349 If a router times out during a host lookup, it normally causes deferral of the
17350 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17351 router, overriding &%no_more%&. This may be helpful for systems that are
17352 intermittently connected to the Internet, or those that want to pass to a smart
17353 host any messages that cannot immediately be delivered.
17354
17355 There are occasional other temporary errors that can occur while doing DNS
17356 lookups. They are treated in the same way as a timeout, and this option
17357 applies to all of them.
17358
17359
17360
17361 .option pass_router routers string unset
17362 .cindex "router" "go to after &""pass""&"
17363 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17364 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17365 routing to continue, and overriding a false setting of &%more%&. When one of
17366 these routers returns &"pass"&, the address is normally handed on to the next
17367 router in sequence. This can be changed by setting &%pass_router%& to the name
17368 of another router. However (unlike &%redirect_router%&) the named router must
17369 be below the current router, to avoid loops. Note that this option applies only
17370 to the special case of &"pass"&. It does not apply when a router returns
17371 &"decline"& because it cannot handle an address.
17372
17373
17374
17375 .option redirect_router routers string unset
17376 .cindex "router" "start at after redirection"
17377 Sometimes an administrator knows that it is pointless to reprocess addresses
17378 generated from alias or forward files with the same router again. For
17379 example, if an alias file translates real names into login ids there is no
17380 point searching the alias file a second time, especially if it is a large file.
17381
17382 The &%redirect_router%& option can be set to the name of any router instance.
17383 It causes the routing of any generated addresses to start at the named router
17384 instead of at the first router. This option has no effect if the router in
17385 which it is set does not generate new addresses.
17386
17387
17388
17389 .option require_files routers&!? "string list&!!" unset
17390 .cindex "file" "requiring for router"
17391 .cindex "router" "requiring file existence"
17392 This option provides a general mechanism for predicating the running of a
17393 router on the existence or non-existence of certain files or directories.
17394 Before running a router, as one of its precondition tests, Exim works its way
17395 through the &%require_files%& list, expanding each item separately.
17396
17397 Because the list is split before expansion, any colons in expansion items must
17398 be doubled, or the facility for using a different list separator must be used.
17399 If any expansion is forced to fail, the item is ignored. Other expansion
17400 failures cause routing of the address to be deferred.
17401
17402 If any expanded string is empty, it is ignored. Otherwise, except as described
17403 below, each string must be a fully qualified file path, optionally preceded by
17404 &"!"&. The paths are passed to the &[stat()]& function to test for the
17405 existence of the files or directories. The router is skipped if any paths not
17406 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17407
17408 .cindex "NFS"
17409 If &[stat()]& cannot determine whether a file exists or not, delivery of
17410 the message is deferred. This can happen when NFS-mounted filesystems are
17411 unavailable.
17412
17413 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17414 options, so you cannot use it to check for the existence of a file in which to
17415 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17416 full list of the order in which preconditions are evaluated.) However, as
17417 these options are all expanded, you can use the &%exists%& expansion condition
17418 to make such tests. The &%require_files%& option is intended for checking files
17419 that the router may be going to use internally, or which are needed by a
17420 transport (for example &_.procmailrc_&).
17421
17422 During delivery, the &[stat()]& function is run as root, but there is a
17423 facility for some checking of the accessibility of a file by another user.
17424 This is not a proper permissions check, but just a &"rough"& check that
17425 operates as follows:
17426
17427 If an item in a &%require_files%& list does not contain any forward slash
17428 characters, it is taken to be the user (and optional group, separated by a
17429 comma) to be checked for subsequent files in the list. If no group is specified
17430 but the user is specified symbolically, the gid associated with the uid is
17431 used. For example:
17432 .code
17433 require_files = mail:/some/file
17434 require_files = $local_part:$home/.procmailrc
17435 .endd
17436 If a user or group name in a &%require_files%& list does not exist, the
17437 &%require_files%& condition fails.
17438
17439 Exim performs the check by scanning along the components of the file path, and
17440 checking the access for the given uid and gid. It checks for &"x"& access on
17441 directories, and &"r"& access on the final file. Note that this means that file
17442 access control lists, if the operating system has them, are ignored.
17443
17444 &*Warning 1*&: When the router is being run to verify addresses for an
17445 incoming SMTP message, Exim is not running as root, but under its own uid. This
17446 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17447 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17448 user is not permitted to read one of the directories on the file's path.
17449
17450 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17451 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17452 without root access. In this case, if a check for access by a particular user
17453 is requested, Exim creates a subprocess that runs as that user, and tries the
17454 check again in that process.
17455
17456 The default action for handling an unresolved EACCES is to consider it to
17457 be caused by a configuration error, and routing is deferred because the
17458 existence or non-existence of the file cannot be determined. However, in some
17459 circumstances it may be desirable to treat this condition as if the file did
17460 not exist. If the file name (or the exclamation mark that precedes the file
17461 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17462 as if the file did not exist. For example:
17463 .code
17464 require_files = +/some/file
17465 .endd
17466 If the router is not an essential part of verification (for example, it
17467 handles users' &_.forward_& files), another solution is to set the &%verify%&
17468 option false so that the router is skipped when verifying.
17469
17470
17471
17472 .option retry_use_local_part routers boolean "see below"
17473 .cindex "hints database" "retry keys"
17474 .cindex "local part" "in retry keys"
17475 When a delivery suffers a temporary routing failure, a retry record is created
17476 in Exim's hints database. For addresses whose routing depends only on the
17477 domain, the key for the retry record should not involve the local part, but for
17478 other addresses, both the domain and the local part should be included.
17479 Usually, remote routing is of the former kind, and local routing is of the
17480 latter kind.
17481
17482 This option controls whether the local part is used to form the key for retry
17483 hints for addresses that suffer temporary errors while being handled by this
17484 router. The default value is true for any router that has &%check_local_user%&
17485 set, and false otherwise. Note that this option does not apply to hints keys
17486 for transport delays; they are controlled by a generic transport option of the
17487 same name.
17488
17489 The setting of &%retry_use_local_part%& applies only to the router on which it
17490 appears. If the router generates child addresses, they are routed
17491 independently; this setting does not become attached to them.
17492
17493
17494
17495 .option router_home_directory routers string&!! unset
17496 .cindex "router" "home directory for"
17497 .cindex "home directory" "for router"
17498 .vindex "&$home$&"
17499 This option sets a home directory for use while the router is running. (Compare
17500 &%transport_home_directory%&, which sets a home directory for later
17501 transporting.) In particular, if used on a &(redirect)& router, this option
17502 sets a value for &$home$& while a filter is running. The value is expanded;
17503 forced expansion failure causes the option to be ignored &-- other failures
17504 cause the router to defer.
17505
17506 Expansion of &%router_home_directory%& happens immediately after the
17507 &%check_local_user%& test (if configured), before any further expansions take
17508 place.
17509 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17510 are evaluated.)
17511 While the router is running, &%router_home_directory%& overrides the value of
17512 &$home$& that came from &%check_local_user%&.
17513
17514 When a router accepts an address and assigns it to a local transport (including
17515 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17516 delivery), the home directory setting for the transport is taken from the first
17517 of these values that is set:
17518
17519 .ilist
17520 The &%home_directory%& option on the transport;
17521 .next
17522 The &%transport_home_directory%& option on the router;
17523 .next
17524 The password data if &%check_local_user%& is set on the router;
17525 .next
17526 The &%router_home_directory%& option on the router.
17527 .endlist
17528
17529 In other words, &%router_home_directory%& overrides the password data for the
17530 router, but not for the transport.
17531
17532
17533
17534 .option self routers string freeze
17535 .cindex "MX record" "pointing to local host"
17536 .cindex "local host" "MX pointing to"
17537 This option applies to those routers that use a recipient address to find a
17538 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17539 and &(manualroute)& routers.
17540 Certain configurations of the &(queryprogram)& router can also specify a list
17541 of remote hosts.
17542 Usually such routers are configured to send the message to a remote host via an
17543 &(smtp)& transport. The &%self%& option specifies what happens when the first
17544 host on the list turns out to be the local host.
17545 The way in which Exim checks for the local host is described in section
17546 &<<SECTreclocipadd>>&.
17547
17548 Normally this situation indicates either an error in Exim's configuration (for
17549 example, the router should be configured not to process this domain), or an
17550 error in the DNS (for example, the MX should not point to this host). For this
17551 reason, the default action is to log the incident, defer the address, and
17552 freeze the message. The following alternatives are provided for use in special
17553 cases:
17554
17555 .vlist
17556 .vitem &%defer%&
17557 Delivery of the message is tried again later, but the message is not frozen.
17558
17559 .vitem "&%reroute%&: <&'domain'&>"
17560 The domain is changed to the given domain, and the address is passed back to
17561 be reprocessed by the routers. No rewriting of headers takes place. This
17562 behaviour is essentially a redirection.
17563
17564 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17565 The domain is changed to the given domain, and the address is passed back to be
17566 reprocessed by the routers. Any headers that contain the original domain are
17567 rewritten.
17568
17569 .vitem &%pass%&
17570 .oindex "&%more%&"
17571 .vindex "&$self_hostname$&"
17572 The router passes the address to the next router, or to the router named in the
17573 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17574 subsequent routing and delivery, the variable &$self_hostname$& contains the
17575 name of the local host that the router encountered. This can be used to
17576 distinguish between different cases for hosts with multiple names. The
17577 combination
17578 .code
17579 self = pass
17580 no_more
17581 .endd
17582 ensures that only those addresses that routed to the local host are passed on.
17583 Without &%no_more%&, addresses that were declined for other reasons would also
17584 be passed to the next router.
17585
17586 .vitem &%fail%&
17587 Delivery fails and an error report is generated.
17588
17589 .vitem &%send%&
17590 .cindex "local host" "sending to"
17591 The anomaly is ignored and the address is queued for the transport. This
17592 setting should be used with extreme caution. For an &(smtp)& transport, it
17593 makes sense only in cases where the program that is listening on the SMTP port
17594 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17595 different configuration file that handles the domain in another way.
17596 .endlist
17597
17598
17599
17600 .option senders routers&!? "address list&!!" unset
17601 .cindex "router" "checking senders"
17602 If this option is set, the router is skipped unless the message's sender
17603 address matches something on the list.
17604 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17605 are evaluated.
17606
17607 There are issues concerning verification when the running of routers is
17608 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17609 setting, it sets the sender to the null string. When using the &%-bt%& option
17610 to check a configuration file, it is necessary also to use the &%-f%& option to
17611 set an appropriate sender. For incoming mail, the sender is unset when
17612 verifying the sender, but is available when verifying any recipients. If the
17613 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17614 matters.
17615
17616
17617 .option translate_ip_address routers string&!! unset
17618 .cindex "IP address" "translating"
17619 .cindex "packet radio"
17620 .cindex "router" "IP address translation"
17621 There exist some rare networking situations (for example, packet radio) where
17622 it is helpful to be able to translate IP addresses generated by normal routing
17623 mechanisms into other IP addresses, thus performing a kind of manual IP
17624 routing. This should be done only if the normal IP routing of the TCP/IP stack
17625 is inadequate or broken. Because this is an extremely uncommon requirement, the
17626 code to support this option is not included in the Exim binary unless
17627 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17628
17629 .vindex "&$host_address$&"
17630 The &%translate_ip_address%& string is expanded for every IP address generated
17631 by the router, with the generated address set in &$host_address$&. If the
17632 expansion is forced to fail, no action is taken.
17633 For any other expansion error, delivery of the message is deferred.
17634 If the result of the expansion is an IP address, that replaces the original
17635 address; otherwise the result is assumed to be a host name &-- this is looked
17636 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17637 produce one or more replacement IP addresses. For example, to subvert all IP
17638 addresses in some specific networks, this could be added to a router:
17639 .code
17640 translate_ip_address = \
17641   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17642     {$value}fail}}
17643 .endd
17644 The file would contain lines like
17645 .code
17646 10.2.3.128/26    some.host
17647 10.8.4.34/26     10.44.8.15
17648 .endd
17649 You should not make use of this facility unless you really understand what you
17650 are doing.
17651
17652
17653
17654 .option transport routers string&!! unset
17655 This option specifies the transport to be used when a router accepts an address
17656 and sets it up for delivery. A transport is never needed if a router is used
17657 only for verification. The value of the option is expanded at routing time,
17658 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17659 and result must be the name of one of the configured transports. If it is not,
17660 delivery is deferred.
17661
17662 The &%transport%& option is not used by the &(redirect)& router, but it does
17663 have some private options that set up transports for pipe and file deliveries
17664 (see chapter &<<CHAPredirect>>&).
17665
17666
17667
17668 .option transport_current_directory routers string&!! unset
17669 .cindex "current directory for local transport"
17670 This option associates a current directory with any address that is routed
17671 to a local transport. This can happen either because a transport is
17672 explicitly configured for the router, or because it generates a delivery to a
17673 file or a pipe. During the delivery process (that is, at transport time), this
17674 option string is expanded and is set as the current directory, unless
17675 overridden by a setting on the transport.
17676 If the expansion fails for any reason, including forced failure, an error is
17677 logged, and delivery is deferred.
17678 See chapter &<<CHAPenvironment>>& for details of the local delivery
17679 environment.
17680
17681
17682
17683
17684 .option transport_home_directory routers string&!! "see below"
17685 .cindex "home directory" "for local transport"
17686 This option associates a home directory with any address that is routed to a
17687 local transport. This can happen either because a transport is explicitly
17688 configured for the router, or because it generates a delivery to a file or a
17689 pipe. During the delivery process (that is, at transport time), the option
17690 string is expanded and is set as the home directory, unless overridden by a
17691 setting of &%home_directory%& on the transport.
17692 If the expansion fails for any reason, including forced failure, an error is
17693 logged, and delivery is deferred.
17694
17695 If the transport does not specify a home directory, and
17696 &%transport_home_directory%& is not set for the router, the home directory for
17697 the transport is taken from the password data if &%check_local_user%& is set for
17698 the router. Otherwise it is taken from &%router_home_directory%& if that option
17699 is set; if not, no home directory is set for the transport.
17700
17701 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17702 environment.
17703
17704
17705
17706
17707 .option unseen routers boolean&!! false
17708 .cindex "router" "carrying on after success"
17709 The result of string expansion for this option must be a valid boolean value,
17710 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17711 result causes an error, and delivery is deferred. If the expansion is forced to
17712 fail, the default value for the option (false) is used. Other failures cause
17713 delivery to be deferred.
17714
17715 When this option is set true, routing does not cease if the router accepts the
17716 address. Instead, a copy of the incoming address is passed to the next router,
17717 overriding a false setting of &%more%&. There is little point in setting
17718 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17719 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17720 sometimes true and sometimes false).
17721
17722 .cindex "copy of message (&%unseen%& option)"
17723 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17724 qualifier in filter files. It can be used to cause copies of messages to be
17725 delivered to some other destination, while also carrying out a normal delivery.
17726 In effect, the current address is made into a &"parent"& that has two children
17727 &-- one that is delivered as specified by this router, and a clone that goes on
17728 to be routed further. For this reason, &%unseen%& may not be combined with the
17729 &%one_time%& option in a &(redirect)& router.
17730
17731 &*Warning*&: Header lines added to the address (or specified for removal) by
17732 this router or by previous routers affect the &"unseen"& copy of the message
17733 only. The clone that continues to be processed by further routers starts with
17734 no added headers and none specified for removal. For a &%redirect%& router, if
17735 a generated address is the same as the incoming address, this can lead to
17736 duplicate addresses with different header modifications. Exim does not do
17737 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17738 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17739 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17740 &%redirect%& router may be of help.
17741
17742 Unlike the handling of header modifications, any data that was set by the
17743 &%address_data%& option in the current or previous routers &'is'& passed on to
17744 subsequent routers.
17745
17746
17747 .option user routers string&!! "see below"
17748 .cindex "uid (user id)" "local delivery"
17749 .cindex "local transports" "uid and gid"
17750 .cindex "transport" "local"
17751 .cindex "router" "user for filter processing"
17752 .cindex "filter" "user for processing"
17753 When a router queues an address for a transport, and the transport does not
17754 specify a user, the user given here is used when running the delivery process.
17755 The user may be specified numerically or by name. If expansion fails, the
17756 error is logged and delivery is deferred.
17757 This user is also used by the &(redirect)& router when running a filter file.
17758 The default is unset, except when &%check_local_user%& is set. In this case,
17759 the default is taken from the password information. If the user is specified as
17760 a name, and &%group%& is not set, the group associated with the user is used.
17761 See also &%initgroups%& and &%group%& and the discussion in chapter
17762 &<<CHAPenvironment>>&.
17763
17764
17765
17766 .option verify routers&!? boolean true
17767 Setting this option has the effect of setting &%verify_sender%& and
17768 &%verify_recipient%& to the same value.
17769
17770
17771 .option verify_only routers&!? boolean false
17772 .cindex "EXPN" "with &%verify_only%&"
17773 .oindex "&%-bv%&"
17774 .cindex "router" "used only when verifying"
17775 If this option is set, the router is used only when verifying an address,
17776 delivering in cutthrough mode or
17777 testing with the &%-bv%& option, not when actually doing a delivery, testing
17778 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17779 restricted to verifying only senders or recipients by means of
17780 &%verify_sender%& and &%verify_recipient%&.
17781
17782 &*Warning*&: When the router is being run to verify addresses for an incoming
17783 SMTP message, Exim is not running as root, but under its own uid. If the router
17784 accesses any files, you need to make sure that they are accessible to the Exim
17785 user or group.
17786
17787
17788 .option verify_recipient routers&!? boolean true
17789 If this option is false, the router is skipped when verifying recipient
17790 addresses,
17791 delivering in cutthrough mode
17792 or testing recipient verification using &%-bv%&.
17793 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17794 are evaluated.
17795 See also the &$verify_mode$& variable.
17796
17797
17798 .option verify_sender routers&!? boolean true
17799 If this option is false, the router is skipped when verifying sender addresses
17800 or testing sender verification using &%-bvs%&.
17801 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17802 are evaluated.
17803 See also the &$verify_mode$& variable.
17804 .ecindex IIDgenoprou1
17805 .ecindex IIDgenoprou2
17806
17807
17808
17809
17810
17811
17812 . ////////////////////////////////////////////////////////////////////////////
17813 . ////////////////////////////////////////////////////////////////////////////
17814
17815 .chapter "The accept router" "CHID4"
17816 .cindex "&(accept)& router"
17817 .cindex "routers" "&(accept)&"
17818 The &(accept)& router has no private options of its own. Unless it is being
17819 used purely for verification (see &%verify_only%&) a transport is required to
17820 be defined by the generic &%transport%& option. If the preconditions that are
17821 specified by generic options are met, the router accepts the address and queues
17822 it for the given transport. The most common use of this router is for setting
17823 up deliveries to local mailboxes. For example:
17824 .code
17825 localusers:
17826   driver = accept
17827   domains = mydomain.example
17828   check_local_user
17829   transport = local_delivery
17830 .endd
17831 The &%domains%& condition in this example checks the domain of the address, and
17832 &%check_local_user%& checks that the local part is the login of a local user.
17833 When both preconditions are met, the &(accept)& router runs, and queues the
17834 address for the &(local_delivery)& transport.
17835
17836
17837
17838
17839
17840
17841 . ////////////////////////////////////////////////////////////////////////////
17842 . ////////////////////////////////////////////////////////////////////////////
17843
17844 .chapter "The dnslookup router" "CHAPdnslookup"
17845 .scindex IIDdnsrou1 "&(dnslookup)& router"
17846 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17847 The &(dnslookup)& router looks up the hosts that handle mail for the
17848 recipient's domain in the DNS. A transport must always be set for this router,
17849 unless &%verify_only%& is set.
17850
17851 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17852 SRV records. If none are found, or if SRV support is not configured,
17853 MX records are looked up. If no MX records exist, address records are sought.
17854 However, &%mx_domains%& can be set to disable the direct use of address
17855 records.
17856
17857 MX records of equal priority are sorted by Exim into a random order. Exim then
17858 looks for address records for the host names obtained from MX or SRV records.
17859 When a host has more than one IP address, they are sorted into a random order,
17860 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17861 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17862 generic option, the router declines.
17863
17864 Unless they have the highest priority (lowest MX value), MX records that point
17865 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17866 are discarded, together with any other MX records of equal or lower priority.
17867
17868 .cindex "MX record" "pointing to local host"
17869 .cindex "local host" "MX pointing to"
17870 .oindex "&%self%&" "in &(dnslookup)& router"
17871 If the host pointed to by the highest priority MX record, or looked up as an
17872 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17873 happens is controlled by the generic &%self%& option.
17874
17875
17876 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17877 There have been problems with DNS servers when SRV records are looked up.
17878 Some mis-behaving servers return a DNS error or timeout when a non-existent
17879 SRV record is sought. Similar problems have in the past been reported for
17880 MX records. The global &%dns_again_means_nonexist%& option can help with this
17881 problem, but it is heavy-handed because it is a global option.
17882
17883 For this reason, there are two options, &%srv_fail_domains%& and
17884 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17885 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17886 an attempt to look up an SRV or MX record causes one of these results, and the
17887 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17888 such record"&. In the case of an SRV lookup, this means that the router
17889 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17890 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17891 case routing fails.
17892
17893
17894 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17895 .cindex "&(dnslookup)& router" "declines"
17896 There are a few cases where a &(dnslookup)& router will decline to accept
17897 an address; if such a router is expected to handle "all remaining non-local
17898 domains", then it is important to set &%no_more%&.
17899
17900 Reasons for a &(dnslookup)& router to decline currently include:
17901 .ilist
17902 The domain does not exist in DNS
17903 .next
17904 The domain exists but the MX record's host part is just "."; this is a common
17905 convention (borrowed from SRV) used to indicate that there is no such service
17906 for this domain and to not fall back to trying A/AAAA records.
17907 .next
17908 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17909 .next
17910 MX record points to a non-existent host.
17911 .next
17912 MX record points to an IP address and the main section option
17913 &%allow_mx_to_ip%& is not set.
17914 .next
17915 MX records exist and point to valid hosts, but all hosts resolve only to
17916 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17917 .next
17918 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17919 &%dns_check_names_pattern%& for handling one variant of this)
17920 .next
17921 &%check_secondary_mx%& is set on this router but the local host can
17922 not be found in the MX records (see below)
17923 .endlist
17924
17925
17926
17927
17928 .section "Private options for dnslookup" "SECID118"
17929 .cindex "options" "&(dnslookup)& router"
17930 The private options for the &(dnslookup)& router are as follows:
17931
17932 .option check_secondary_mx dnslookup boolean false
17933 .cindex "MX record" "checking for secondary"
17934 If this option is set, the router declines unless the local host is found in
17935 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17936 process domains for which the local host is a secondary mail exchanger
17937 differently to other domains. The way in which Exim decides whether a host is
17938 the local host is described in section &<<SECTreclocipadd>>&.
17939
17940
17941 .option check_srv dnslookup string&!! unset
17942 .cindex "SRV record" "enabling use of"
17943 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17944 addition to MX and address records. The support is disabled by default. To
17945 enable SRV support, set the &%check_srv%& option to the name of the service
17946 required. For example,
17947 .code
17948 check_srv = smtp
17949 .endd
17950 looks for SRV records that refer to the normal smtp service. The option is
17951 expanded, so the service name can vary from message to message or address
17952 to address. This might be helpful if SRV records are being used for a
17953 submission service. If the expansion is forced to fail, the &%check_srv%&
17954 option is ignored, and the router proceeds to look for MX records in the
17955 normal way.
17956
17957 When the expansion succeeds, the router searches first for SRV records for
17958 the given service (it assumes TCP protocol). A single SRV record with a
17959 host name that consists of just a single dot indicates &"no such service for
17960 this domain"&; if this is encountered, the router declines. If other kinds of
17961 SRV record are found, they are used to construct a host list for delivery
17962 according to the rules of RFC 2782. MX records are not sought in this case.
17963
17964 When no SRV records are found, MX records (and address records) are sought in
17965 the traditional way. In other words, SRV records take precedence over MX
17966 records, just as MX records take precedence over address records. Note that
17967 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17968 defined it. It is apparently believed that MX records are sufficient for email
17969 and that SRV records should not be used for this purpose. However, SRV records
17970 have an additional &"weight"& feature which some people might find useful when
17971 trying to split an SMTP load between hosts of different power.
17972
17973 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17974 when there is a DNS lookup error.
17975
17976
17977
17978 .option dnssec_request_domains dnslookup "domain list&!!" unset
17979 .cindex "MX record" "security"
17980 .cindex "DNSSEC" "MX lookup"
17981 .cindex "security" "MX lookup"
17982 .cindex "DNS" "DNSSEC"
17983 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17984 the dnssec request bit set.
17985 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17986
17987
17988
17989 .option dnssec_require_domains dnslookup "domain list&!!" unset
17990 .cindex "MX record" "security"
17991 .cindex "DNSSEC" "MX lookup"
17992 .cindex "security" "MX lookup"
17993 .cindex "DNS" "DNSSEC"
17994 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17995 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17996 (AD bit) set wil be ignored and logged as a host-lookup failure.
17997 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
17998
17999
18000
18001 .option mx_domains dnslookup "domain list&!!" unset
18002 .cindex "MX record" "required to exist"
18003 .cindex "SRV record" "required to exist"
18004 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18005 record in order to be recognized. (The name of this option could be improved.)
18006 For example, if all the mail hosts in &'fict.example'& are known to have MX
18007 records, except for those in &'discworld.fict.example'&, you could use this
18008 setting:
18009 .code
18010 mx_domains = ! *.discworld.fict.example : *.fict.example
18011 .endd
18012 This specifies that messages addressed to a domain that matches the list but
18013 has no MX record should be bounced immediately instead of being routed using
18014 the address record.
18015
18016
18017 .option mx_fail_domains dnslookup "domain list&!!" unset
18018 If the DNS lookup for MX records for one of the domains in this list causes a
18019 DNS lookup error, Exim behaves as if no MX records were found. See section
18020 &<<SECTprowitdnsloo>>& for more discussion.
18021
18022
18023
18024
18025 .option qualify_single dnslookup boolean true
18026 .cindex "DNS" "resolver options"
18027 .cindex "DNS" "qualifying single-component names"
18028 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18029 lookups. Typically, but not standardly, this causes the resolver to qualify
18030 single-component names with the default domain. For example, on a machine
18031 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18032 &'thesaurus.ref.example'& inside the resolver. For details of what your
18033 resolver actually does, consult your man pages for &'resolver'& and
18034 &'resolv.conf'&.
18035
18036
18037
18038 .option rewrite_headers dnslookup boolean true
18039 .cindex "rewriting" "header lines"
18040 .cindex "header lines" "rewriting"
18041 If the domain name in the address that is being processed is not fully
18042 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18043 an address is specified as &'dormouse@teaparty'&, the domain might be
18044 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18045 occur as a result of setting the &%widen_domains%& option. If
18046 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18047 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18048 header lines of the message are rewritten with the full domain name.
18049
18050 This option should be turned off only when it is known that no message is
18051 ever going to be sent outside an environment where the abbreviation makes
18052 sense.
18053
18054 When an MX record is looked up in the DNS and matches a wildcard record, name
18055 servers normally return a record containing the name that has been looked up,
18056 making it impossible to detect whether a wildcard was present or not. However,
18057 some name servers have recently been seen to return the wildcard entry. If the
18058 name returned by a DNS lookup begins with an asterisk, it is not used for
18059 header rewriting.
18060
18061
18062 .option same_domain_copy_routing dnslookup boolean false
18063 .cindex "address" "copying routing"
18064 Addresses with the same domain are normally routed by the &(dnslookup)& router
18065 to the same list of hosts. However, this cannot be presumed, because the router
18066 options and preconditions may refer to the local part of the address. By
18067 default, therefore, Exim routes each address in a message independently. DNS
18068 servers run caches, so repeated DNS lookups are not normally expensive, and in
18069 any case, personal messages rarely have more than a few recipients.
18070
18071 If you are running mailing lists with large numbers of subscribers at the same
18072 domain, and you are using a &(dnslookup)& router which is independent of the
18073 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18074 lookups for identical domains in one message. In this case, when &(dnslookup)&
18075 routes an address to a remote transport, any other unrouted addresses in the
18076 message that have the same domain are automatically given the same routing
18077 without processing them independently,
18078 provided the following conditions are met:
18079
18080 .ilist
18081 No router that processed the address specified &%headers_add%& or
18082 &%headers_remove%&.
18083 .next
18084 The router did not change the address in any way, for example, by &"widening"&
18085 the domain.
18086 .endlist
18087
18088
18089
18090
18091 .option search_parents dnslookup boolean false
18092 .cindex "DNS" "resolver options"
18093 When this option is true, the resolver option RES_DNSRCH is set for DNS
18094 lookups. This is different from the &%qualify_single%& option in that it
18095 applies to domains containing dots. Typically, but not standardly, it causes
18096 the resolver to search for the name in the current domain and in parent
18097 domains. For example, on a machine in the &'fict.example'& domain, if looking
18098 up &'teaparty.wonderland'& failed, the resolver would try
18099 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18100 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18101
18102 Setting this option true can cause problems in domains that have a wildcard MX
18103 record, because any domain that does not have its own MX record matches the
18104 local wildcard.
18105
18106
18107
18108 .option srv_fail_domains dnslookup "domain list&!!" unset
18109 If the DNS lookup for SRV records for one of the domains in this list causes a
18110 DNS lookup error, Exim behaves as if no SRV records were found. See section
18111 &<<SECTprowitdnsloo>>& for more discussion.
18112
18113
18114
18115
18116 .option widen_domains dnslookup "string list" unset
18117 .cindex "domain" "partial; widening"
18118 If a DNS lookup fails and this option is set, each of its strings in turn is
18119 added onto the end of the domain, and the lookup is tried again. For example,
18120 if
18121 .code
18122 widen_domains = fict.example:ref.example
18123 .endd
18124 is set and a lookup of &'klingon.dictionary'& fails,
18125 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18126 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18127 and &%search_parents%& options can cause some widening to be undertaken inside
18128 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18129 when verifying, unless &%rewrite_headers%& is false (not the default).
18130
18131
18132 .section "Effect of qualify_single and search_parents" "SECID119"
18133 When a domain from an envelope recipient is changed by the resolver as a result
18134 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18135 corresponding address in the message's header lines unless &%rewrite_headers%&
18136 is set false. Exim then re-routes the address, using the full domain.
18137
18138 These two options affect only the DNS lookup that takes place inside the router
18139 for the domain of the address that is being routed. They do not affect lookups
18140 such as that implied by
18141 .code
18142 domains = @mx_any
18143 .endd
18144 that may happen while processing a router precondition before the router is
18145 entered. No widening ever takes place for these lookups.
18146 .ecindex IIDdnsrou1
18147 .ecindex IIDdnsrou2
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157 . ////////////////////////////////////////////////////////////////////////////
18158 . ////////////////////////////////////////////////////////////////////////////
18159
18160 .chapter "The ipliteral router" "CHID5"
18161 .cindex "&(ipliteral)& router"
18162 .cindex "domain literal" "routing"
18163 .cindex "routers" "&(ipliteral)&"
18164 This router has no private options. Unless it is being used purely for
18165 verification (see &%verify_only%&) a transport is required to be defined by the
18166 generic &%transport%& option. The router accepts the address if its domain part
18167 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18168 router handles the address
18169 .code
18170 root@[192.168.1.1]
18171 .endd
18172 by setting up delivery to the host with that IP address. IPv4 domain literals
18173 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18174 are similar, but the address is preceded by &`ipv6:`&. For example:
18175 .code
18176 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18177 .endd
18178 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18179 grounds that sooner or later somebody will try it.
18180
18181 .oindex "&%self%&" "in &(ipliteral)& router"
18182 If the IP address matches something in &%ignore_target_hosts%&, the router
18183 declines. If an IP literal turns out to refer to the local host, the generic
18184 &%self%& option determines what happens.
18185
18186 The RFCs require support for domain literals; however, their use is
18187 controversial in today's Internet. If you want to use this router, you must
18188 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18189 Exim will not recognize the domain literal syntax in addresses.
18190
18191
18192
18193 . ////////////////////////////////////////////////////////////////////////////
18194 . ////////////////////////////////////////////////////////////////////////////
18195
18196 .chapter "The iplookup router" "CHID6"
18197 .cindex "&(iplookup)& router"
18198 .cindex "routers" "&(iplookup)&"
18199 The &(iplookup)& router was written to fulfil a specific requirement in
18200 Cambridge University (which in fact no longer exists). For this reason, it is
18201 not included in the binary of Exim by default. If you want to include it, you
18202 must set
18203 .code
18204 ROUTER_IPLOOKUP=yes
18205 .endd
18206 in your &_Local/Makefile_& configuration file.
18207
18208 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18209 connection to one or more specific hosts. The host can then return the same or
18210 a different address &-- in effect rewriting the recipient address in the
18211 message's envelope. The new address is then passed on to subsequent routers. If
18212 this process fails, the address can be passed on to other routers, or delivery
18213 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18214 must not be specified for it.
18215
18216 .cindex "options" "&(iplookup)& router"
18217 .option hosts iplookup string unset
18218 This option must be supplied. Its value is a colon-separated list of host
18219 names. The hosts are looked up using &[gethostbyname()]&
18220 (or &[getipnodebyname()]& when available)
18221 and are tried in order until one responds to the query. If none respond, what
18222 happens is controlled by &%optional%&.
18223
18224
18225 .option optional iplookup boolean false
18226 If &%optional%& is true, if no response is obtained from any host, the address
18227 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18228 delivery to the address is deferred.
18229
18230
18231 .option port iplookup integer 0
18232 .cindex "port" "&(iplookup)& router"
18233 This option must be supplied. It specifies the port number for the TCP or UDP
18234 call.
18235
18236
18237 .option protocol iplookup string udp
18238 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18239 protocols is to be used.
18240
18241
18242 .option query iplookup string&!! "see below"
18243 This defines the content of the query that is sent to the remote hosts. The
18244 default value is:
18245 .code
18246 $local_part@$domain $local_part@$domain
18247 .endd
18248 The repetition serves as a way of checking that a response is to the correct
18249 query in the default case (see &%response_pattern%& below).
18250
18251
18252 .option reroute iplookup string&!! unset
18253 If this option is not set, the rerouted address is precisely the byte string
18254 returned by the remote host, up to the first white space, if any. If set, the
18255 string is expanded to form the rerouted address. It can include parts matched
18256 in the response by &%response_pattern%& by means of numeric variables such as
18257 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18258 whether or not a pattern is in use. In all cases, the rerouted address must end
18259 up in the form &'local_part@domain'&.
18260
18261
18262 .option response_pattern iplookup string unset
18263 This option can be set to a regular expression that is applied to the string
18264 returned from the remote host. If the pattern does not match the response, the
18265 router declines. If &%response_pattern%& is not set, no checking of the
18266 response is done, unless the query was defaulted, in which case there is a
18267 check that the text returned after the first white space is the original
18268 address. This checks that the answer that has been received is in response to
18269 the correct question. For example, if the response is just a new domain, the
18270 following could be used:
18271 .code
18272 response_pattern = ^([^@]+)$
18273 reroute = $local_part@$1
18274 .endd
18275
18276 .option timeout iplookup time 5s
18277 This specifies the amount of time to wait for a response from the remote
18278 machine. The same timeout is used for the &[connect()]& function for a TCP
18279 call. It does not apply to UDP.
18280
18281
18282
18283
18284 . ////////////////////////////////////////////////////////////////////////////
18285 . ////////////////////////////////////////////////////////////////////////////
18286
18287 .chapter "The manualroute router" "CHID7"
18288 .scindex IIDmanrou1 "&(manualroute)& router"
18289 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18290 .cindex "domain" "manually routing"
18291 The &(manualroute)& router is so-called because it provides a way of manually
18292 routing an address according to its domain. It is mainly used when you want to
18293 route addresses to remote hosts according to your own rules, bypassing the
18294 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18295 route to local transports, a facility that may be useful if you want to save
18296 messages for dial-in hosts in local files.
18297
18298 The &(manualroute)& router compares a list of domain patterns with the domain
18299 it is trying to route. If there is no match, the router declines. Each pattern
18300 has associated with it a list of hosts and some other optional data, which may
18301 include a transport. The combination of a pattern and its data is called a
18302 &"routing rule"&. For patterns that do not have an associated transport, the
18303 generic &%transport%& option must specify a transport, unless the router is
18304 being used purely for verification (see &%verify_only%&).
18305
18306 .vindex "&$host$&"
18307 In the case of verification, matching the domain pattern is sufficient for the
18308 router to accept the address. When actually routing an address for delivery,
18309 an address that matches a domain pattern is queued for the associated
18310 transport. If the transport is not a local one, a host list must be associated
18311 with the pattern; IP addresses are looked up for the hosts, and these are
18312 passed to the transport along with the mail address. For local transports, a
18313 host list is optional. If it is present, it is passed in &$host$& as a single
18314 text string.
18315
18316 The list of routing rules can be provided as an inline string in
18317 &%route_list%&, or the data can be obtained by looking up the domain in a file
18318 or database by setting &%route_data%&. Only one of these settings may appear in
18319 any one instance of &(manualroute)&. The format of routing rules is described
18320 below, following the list of private options.
18321
18322
18323 .section "Private options for manualroute" "SECTprioptman"
18324
18325 .cindex "options" "&(manualroute)& router"
18326 The private options for the &(manualroute)& router are as follows:
18327
18328 .option host_all_ignored manualroute string defer
18329 See &%host_find_failed%&.
18330
18331 .option host_find_failed manualroute string freeze
18332 This option controls what happens when &(manualroute)& tries to find an IP
18333 address for a host, and the host does not exist. The option can be set to one
18334 of the following values:
18335 .code
18336 decline
18337 defer
18338 fail
18339 freeze
18340 ignore
18341 pass
18342 .endd
18343 The default (&"freeze"&) assumes that this state is a serious configuration
18344 error. The difference between &"pass"& and &"decline"& is that the former
18345 forces the address to be passed to the next router (or the router defined by
18346 &%pass_router%&),
18347 .oindex "&%more%&"
18348 overriding &%no_more%&, whereas the latter passes the address to the next
18349 router only if &%more%& is true.
18350
18351 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18352 cannot be found. If all the hosts in the list are ignored, the behaviour is
18353 controlled by the &%host_all_ignored%& option. This takes the same values
18354 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18355
18356 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18357 state; if a host lookup gets a temporary error, delivery is deferred unless the
18358 generic &%pass_on_timeout%& option is set.
18359
18360
18361 .option hosts_randomize manualroute boolean false
18362 .cindex "randomized host list"
18363 .cindex "host" "list of; randomized"
18364 If this option is set, the order of the items in a host list in a routing rule
18365 is randomized each time the list is used, unless an option in the routing rule
18366 overrides (see below). Randomizing the order of a host list can be used to do
18367 crude load sharing. However, if more than one mail address is routed by the
18368 same router to the same host list, the host lists are considered to be the same
18369 (even though they may be randomized into different orders) for the purpose of
18370 deciding whether to batch the deliveries into a single SMTP transaction.
18371
18372 When &%hosts_randomize%& is true, a host list may be split
18373 into groups whose order is separately randomized. This makes it possible to
18374 set up MX-like behaviour. The boundaries between groups are indicated by an
18375 item that is just &`+`& in the host list. For example:
18376 .code
18377 route_list = * host1:host2:host3:+:host4:host5
18378 .endd
18379 The order of the first three hosts and the order of the last two hosts is
18380 randomized for each use, but the first three always end up before the last two.
18381 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18382 randomized host list is passed to an &(smtp)& transport that also has
18383 &%hosts_randomize set%&, the list is not re-randomized.
18384
18385
18386 .option route_data manualroute string&!! unset
18387 If this option is set, it must expand to yield the data part of a routing rule.
18388 Typically, the expansion string includes a lookup based on the domain. For
18389 example:
18390 .code
18391 route_data = ${lookup{$domain}dbm{/etc/routes}}
18392 .endd
18393 If the expansion is forced to fail, or the result is an empty string, the
18394 router declines. Other kinds of expansion failure cause delivery to be
18395 deferred.
18396
18397
18398 .option route_list manualroute "string list" unset
18399 This string is a list of routing rules, in the form defined below. Note that,
18400 unlike most string lists, the items are separated by semicolons. This is so
18401 that they may contain colon-separated host lists.
18402
18403
18404 .option same_domain_copy_routing manualroute boolean false
18405 .cindex "address" "copying routing"
18406 Addresses with the same domain are normally routed by the &(manualroute)&
18407 router to the same list of hosts. However, this cannot be presumed, because the
18408 router options and preconditions may refer to the local part of the address. By
18409 default, therefore, Exim routes each address in a message independently. DNS
18410 servers run caches, so repeated DNS lookups are not normally expensive, and in
18411 any case, personal messages rarely have more than a few recipients.
18412
18413 If you are running mailing lists with large numbers of subscribers at the same
18414 domain, and you are using a &(manualroute)& router which is independent of the
18415 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18416 lookups for identical domains in one message. In this case, when
18417 &(manualroute)& routes an address to a remote transport, any other unrouted
18418 addresses in the message that have the same domain are automatically given the
18419 same routing without processing them independently. However, this is only done
18420 if &%headers_add%& and &%headers_remove%& are unset.
18421
18422
18423
18424
18425 .section "Routing rules in route_list" "SECID120"
18426 The value of &%route_list%& is a string consisting of a sequence of routing
18427 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18428 entered as two semicolons. Alternatively, the list separator can be changed as
18429 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18430 Empty rules are ignored. The format of each rule is
18431 .display
18432 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18433 .endd
18434 The following example contains two rules, each with a simple domain pattern and
18435 no options:
18436 .code
18437 route_list = \
18438   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18439   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18440 .endd
18441 The three parts of a rule are separated by white space. The pattern and the
18442 list of hosts can be enclosed in quotes if necessary, and if they are, the
18443 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18444 single domain pattern, which is the only mandatory item in the rule. The
18445 pattern is in the same format as one item in a domain list (see section
18446 &<<SECTdomainlist>>&),
18447 except that it may not be the name of an interpolated file.
18448 That is, it may be wildcarded, or a regular expression, or a file or database
18449 lookup (with semicolons doubled, because of the use of semicolon as a separator
18450 in a &%route_list%&).
18451
18452 The rules in &%route_list%& are searched in order until one of the patterns
18453 matches the domain that is being routed. The list of hosts and then options are
18454 then used as described below. If there is no match, the router declines. When
18455 &%route_list%& is set, &%route_data%& must not be set.
18456
18457
18458
18459 .section "Routing rules in route_data" "SECID121"
18460 The use of &%route_list%& is convenient when there are only a small number of
18461 routing rules. For larger numbers, it is easier to use a file or database to
18462 hold the routing information, and use the &%route_data%& option instead.
18463 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18464 Most commonly, &%route_data%& is set as a string that contains an
18465 expansion lookup. For example, suppose we place two routing rules in a file
18466 like this:
18467 .code
18468 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18469 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18470 .endd
18471 This data can be accessed by setting
18472 .code
18473 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18474 .endd
18475 Failure of the lookup results in an empty string, causing the router to
18476 decline. However, you do not have to use a lookup in &%route_data%&. The only
18477 requirement is that the result of expanding the string is a list of hosts,
18478 possibly followed by options, separated by white space. The list of hosts must
18479 be enclosed in quotes if it contains white space.
18480
18481
18482
18483
18484 .section "Format of the list of hosts" "SECID122"
18485 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18486 always separately expanded before use. If the expansion fails, the router
18487 declines. The result of the expansion must be a colon-separated list of names
18488 and/or IP addresses, optionally also including ports. The format of each item
18489 in the list is described in the next section. The list separator can be changed
18490 as described in section &<<SECTlistconstruct>>&.
18491
18492 If the list of hosts was obtained from a &%route_list%& item, the following
18493 variables are set during its expansion:
18494
18495 .ilist
18496 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18497 If the domain was matched against a regular expression, the numeric variables
18498 &$1$&, &$2$&, etc. may be set. For example:
18499 .code
18500 route_list = ^domain(\d+)   host-$1.text.example
18501 .endd
18502 .next
18503 &$0$& is always set to the entire domain.
18504 .next
18505 &$1$& is also set when partial matching is done in a file lookup.
18506
18507 .next
18508 .vindex "&$value$&"
18509 If the pattern that matched the domain was a lookup item, the data that was
18510 looked up is available in the expansion variable &$value$&. For example:
18511 .code
18512 route_list = lsearch;;/some/file.routes  $value
18513 .endd
18514 .endlist
18515
18516 Note the doubling of the semicolon in the pattern that is necessary because
18517 semicolon is the default route list separator.
18518
18519
18520
18521 .section "Format of one host item" "SECTformatonehostitem"
18522 Each item in the list of hosts is either a host name or an IP address,
18523 optionally with an attached port number. When no port is given, an IP address
18524 is not enclosed in brackets. When a port is specified, it overrides the port
18525 specification on the transport. The port is separated from the name or address
18526 by a colon. This leads to some complications:
18527
18528 .ilist
18529 Because colon is the default separator for the list of hosts, either
18530 the colon that specifies a port must be doubled, or the list separator must
18531 be changed. The following two examples have the same effect:
18532 .code
18533 route_list = * "host1.tld::1225 : host2.tld::1226"
18534 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18535 .endd
18536 .next
18537 When IPv6 addresses are involved, it gets worse, because they contain
18538 colons of their own. To make this case easier, it is permitted to
18539 enclose an IP address (either v4 or v6) in square brackets if a port
18540 number follows. For example:
18541 .code
18542 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18543 .endd
18544 .endlist
18545
18546 .section "How the list of hosts is used" "SECThostshowused"
18547 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18548 the hosts is tried, in the order specified, when carrying out the SMTP
18549 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18550 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18551 transport.
18552
18553 Hosts may be listed by name or by IP address. An unadorned name in the list of
18554 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18555 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18556 records in the DNS. For example:
18557 .code
18558 route_list = *  x.y.z:p.q.r/MX:e.f.g
18559 .endd
18560 If this feature is used with a port specifier, the port must come last. For
18561 example:
18562 .code
18563 route_list = *  dom1.tld/mx::1225
18564 .endd
18565 If the &%hosts_randomize%& option is set, the order of the items in the list is
18566 randomized before any lookups are done. Exim then scans the list; for any name
18567 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18568 be an interface on the local host and the item is not the first in the list,
18569 Exim discards it and any subsequent items. If it is the first item, what
18570 happens is controlled by the
18571 .oindex "&%self%&" "in &(manualroute)& router"
18572 &%self%& option of the router.
18573
18574 A name on the list that is followed by &`/MX`& is replaced with the list of
18575 hosts obtained by looking up MX records for the name. This is always a DNS
18576 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18577 below) are not relevant here. The order of these hosts is determined by the
18578 preference values in the MX records, according to the usual rules. Because
18579 randomizing happens before the MX lookup, it does not affect the order that is
18580 defined by MX preferences.
18581
18582 If the local host is present in the sublist obtained from MX records, but is
18583 not the most preferred host in that list, it and any equally or less
18584 preferred hosts are removed before the sublist is inserted into the main list.
18585
18586 If the local host is the most preferred host in the MX list, what happens
18587 depends on where in the original list of hosts the &`/MX`& item appears. If it
18588 is not the first item (that is, there are previous hosts in the main list),
18589 Exim discards this name and any subsequent items in the main list.
18590
18591 If the MX item is first in the list of hosts, and the local host is the
18592 most preferred host, what happens is controlled by the &%self%& option of the
18593 router.
18594
18595 DNS failures when lookup up the MX records are treated in the same way as DNS
18596 failures when looking up IP addresses: &%pass_on_timeout%& and
18597 &%host_find_failed%& are used when relevant.
18598
18599 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18600 whether obtained from an MX lookup or not.
18601
18602
18603
18604 .section "How the options are used" "SECThowoptused"
18605 The options are a sequence of words; in practice no more than three are ever
18606 present. One of the words can be the name of a transport; this overrides the
18607 &%transport%& option on the router for this particular routing rule only. The
18608 other words (if present) control randomization of the list of hosts on a
18609 per-rule basis, and how the IP addresses of the hosts are to be found when
18610 routing to a remote transport. These options are as follows:
18611
18612 .ilist
18613 &%randomize%&: randomize the order of the hosts in this list, overriding the
18614 setting of &%hosts_randomize%& for this routing rule only.
18615 .next
18616 &%no_randomize%&: do not randomize the order of the hosts in this list,
18617 overriding the setting of &%hosts_randomize%& for this routing rule only.
18618 .next
18619 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18620 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18621 also look in &_/etc/hosts_& or other sources of information.
18622 .next
18623 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18624 no address records are found. If there is a temporary DNS error (such as a
18625 timeout), delivery is deferred.
18626 .endlist
18627
18628 For example:
18629 .code
18630 route_list = domain1  host1:host2:host3  randomize bydns;\
18631              domain2  host4:host5
18632 .endd
18633 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18634 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18635 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18636 or &[gethostbyname()]&, and the result of the lookup is the result of that
18637 call.
18638
18639 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18640 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18641 instead of TRY_AGAIN. That is why the default action is to try a DNS
18642 lookup first. Only if that gives a definite &"no such host"& is the local
18643 function called.
18644
18645
18646
18647 If no IP address for a host can be found, what happens is controlled by the
18648 &%host_find_failed%& option.
18649
18650 .vindex "&$host$&"
18651 When an address is routed to a local transport, IP addresses are not looked up.
18652 The host list is passed to the transport in the &$host$& variable.
18653
18654
18655
18656 .section "Manualroute examples" "SECID123"
18657 In some of the examples that follow, the presence of the &%remote_smtp%&
18658 transport, as defined in the default configuration file, is assumed:
18659
18660 .ilist
18661 .cindex "smart host" "example router"
18662 The &(manualroute)& router can be used to forward all external mail to a
18663 &'smart host'&. If you have set up, in the main part of the configuration, a
18664 named domain list that contains your local domains, for example:
18665 .code
18666 domainlist local_domains = my.domain.example
18667 .endd
18668 You can arrange for all other domains to be routed to a smart host by making
18669 your first router something like this:
18670 .code
18671 smart_route:
18672   driver = manualroute
18673   domains = !+local_domains
18674   transport = remote_smtp
18675   route_list = * smarthost.ref.example
18676 .endd
18677 This causes all non-local addresses to be sent to the single host
18678 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18679 they are tried in order
18680 (but you can use &%hosts_randomize%& to vary the order each time).
18681 Another way of configuring the same thing is this:
18682 .code
18683 smart_route:
18684   driver = manualroute
18685   transport = remote_smtp
18686   route_list = !+local_domains  smarthost.ref.example
18687 .endd
18688 There is no difference in behaviour between these two routers as they stand.
18689 However, they behave differently if &%no_more%& is added to them. In the first
18690 example, the router is skipped if the domain does not match the &%domains%&
18691 precondition; the following router is always tried. If the router runs, it
18692 always matches the domain and so can never decline. Therefore, &%no_more%&
18693 would have no effect. In the second case, the router is never skipped; it
18694 always runs. However, if it doesn't match the domain, it declines. In this case
18695 &%no_more%& would prevent subsequent routers from running.
18696
18697 .next
18698 .cindex "mail hub example"
18699 A &'mail hub'& is a host which receives mail for a number of domains via MX
18700 records in the DNS and delivers it via its own private routing mechanism. Often
18701 the final destinations are behind a firewall, with the mail hub being the one
18702 machine that can connect to machines both inside and outside the firewall. The
18703 &(manualroute)& router is usually used on a mail hub to route incoming messages
18704 to the correct hosts. For a small number of domains, the routing can be inline,
18705 using the &%route_list%& option, but for a larger number a file or database
18706 lookup is easier to manage.
18707
18708 If the domain names are in fact the names of the machines to which the mail is
18709 to be sent by the mail hub, the configuration can be quite simple. For
18710 example:
18711 .code
18712 hub_route:
18713   driver = manualroute
18714   transport = remote_smtp
18715   route_list = *.rhodes.tvs.example  $domain
18716 .endd
18717 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18718 whose names are the same as the mail domains. A similar approach can be taken
18719 if the host name can be obtained from the domain name by a string manipulation
18720 that the expansion facilities can handle. Otherwise, a lookup based on the
18721 domain can be used to find the host:
18722 .code
18723 through_firewall:
18724   driver = manualroute
18725   transport = remote_smtp
18726   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18727 .endd
18728 The result of the lookup must be the name or IP address of the host (or
18729 hosts) to which the address is to be routed. If the lookup fails, the route
18730 data is empty, causing the router to decline. The address then passes to the
18731 next router.
18732
18733 .next
18734 .cindex "batched SMTP output example"
18735 .cindex "SMTP" "batched outgoing; example"
18736 You can use &(manualroute)& to deliver messages to pipes or files in batched
18737 SMTP format for onward transportation by some other means. This is one way of
18738 storing mail for a dial-up host when it is not connected. The route list entry
18739 can be as simple as a single domain name in a configuration like this:
18740 .code
18741 save_in_file:
18742   driver = manualroute
18743   transport = batchsmtp_appendfile
18744   route_list = saved.domain.example
18745 .endd
18746 though often a pattern is used to pick up more than one domain. If there are
18747 several domains or groups of domains with different transport requirements,
18748 different transports can be listed in the routing information:
18749 .code
18750 save_in_file:
18751   driver = manualroute
18752   route_list = \
18753     *.saved.domain1.example  $domain  batch_appendfile; \
18754     *.saved.domain2.example  \
18755       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18756       batch_pipe
18757 .endd
18758 .vindex "&$domain$&"
18759 .vindex "&$host$&"
18760 The first of these just passes the domain in the &$host$& variable, which
18761 doesn't achieve much (since it is also in &$domain$&), but the second does a
18762 file lookup to find a value to pass, causing the router to decline to handle
18763 the address if the lookup fails.
18764
18765 .next
18766 .cindex "UUCP" "example of router for"
18767 Routing mail directly to UUCP software is a specific case of the use of
18768 &(manualroute)& in a gateway to another mail environment. This is an example of
18769 one way it can be done:
18770 .code
18771 # Transport
18772 uucp:
18773   driver = pipe
18774   user = nobody
18775   command = /usr/local/bin/uux -r - \
18776     ${substr_-5:$host}!rmail ${local_part}
18777   return_fail_output = true
18778
18779 # Router
18780 uucphost:
18781   transport = uucp
18782   driver = manualroute
18783   route_data = \
18784     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18785 .endd
18786 The file &_/usr/local/exim/uucphosts_& contains entries like
18787 .code
18788 darksite.ethereal.example:           darksite.UUCP
18789 .endd
18790 It can be set up more simply without adding and removing &".UUCP"& but this way
18791 makes clear the distinction between the domain name
18792 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18793 .endlist
18794 .ecindex IIDmanrou1
18795 .ecindex IIDmanrou2
18796
18797
18798
18799
18800
18801
18802
18803
18804 . ////////////////////////////////////////////////////////////////////////////
18805 . ////////////////////////////////////////////////////////////////////////////
18806
18807 .chapter "The queryprogram router" "CHAPdriverlast"
18808 .scindex IIDquerou1 "&(queryprogram)& router"
18809 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18810 .cindex "routing" "by external program"
18811 The &(queryprogram)& router routes an address by running an external command
18812 and acting on its output. This is an expensive way to route, and is intended
18813 mainly for use in lightly-loaded systems, or for performing experiments.
18814 However, if it is possible to use the precondition options (&%domains%&,
18815 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18816 be used in special cases, even on a busy host. There are the following private
18817 options:
18818 .cindex "options" "&(queryprogram)& router"
18819
18820 .option command queryprogram string&!! unset
18821 This option must be set. It specifies the command that is to be run. The
18822 command is split up into a command name and arguments, and then each is
18823 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18824 &<<CHAPpipetransport>>&).
18825
18826
18827 .option command_group queryprogram string unset
18828 .cindex "gid (group id)" "in &(queryprogram)& router"
18829 This option specifies a gid to be set when running the command while routing an
18830 address for deliver. It must be set if &%command_user%& specifies a numerical
18831 uid. If it begins with a digit, it is interpreted as the numerical value of the
18832 gid. Otherwise it is looked up using &[getgrnam()]&.
18833
18834
18835 .option command_user queryprogram string unset
18836 .cindex "uid (user id)" "for &(queryprogram)&"
18837 This option must be set. It specifies the uid which is set when running the
18838 command while routing an address for delivery. If the value begins with a digit,
18839 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18840 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18841 not set, a value for the gid also.
18842
18843 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18844 root, which it does during a normal delivery in a conventional configuration.
18845 However, when an address is being verified during message reception, Exim is
18846 usually running as the Exim user, not as root. If the &(queryprogram)& router
18847 is called from a non-root process, Exim cannot change uid or gid before running
18848 the command. In this circumstance the command runs under the current uid and
18849 gid.
18850
18851
18852 .option current_directory queryprogram string /
18853 This option specifies an absolute path which is made the current directory
18854 before running the command.
18855
18856
18857 .option timeout queryprogram time 1h
18858 If the command does not complete within the timeout period, its process group
18859 is killed and the message is frozen. A value of zero time specifies no
18860 timeout.
18861
18862
18863 The standard output of the command is connected to a pipe, which is read when
18864 the command terminates. It should consist of a single line of output,
18865 containing up to five fields, separated by white space. The maximum length of
18866 the line is 1023 characters. Longer lines are silently truncated. The first
18867 field is one of the following words (case-insensitive):
18868
18869 .ilist
18870 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18871 below).
18872 .next
18873 &'Decline'&: the router declines; pass the address to the next router, unless
18874 &%no_more%& is set.
18875 .next
18876 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18877 subsequent text on the line is an error message. If the router is run as part
18878 of address verification during an incoming SMTP message, the message is
18879 included in the SMTP response.
18880 .next
18881 &'Defer'&: routing could not be completed at this time; try again later. Any
18882 subsequent text on the line is an error message which is logged. It is not
18883 included in any SMTP response.
18884 .next
18885 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18886 .next
18887 &'Pass'&: pass the address to the next router (or the router specified by
18888 &%pass_router%&), overriding &%no_more%&.
18889 .next
18890 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18891 new addresses, which are routed independently, starting with the first router,
18892 or the router specified by &%redirect_router%&, if set.
18893 .endlist
18894
18895 When the first word is &'accept'&, the remainder of the line consists of a
18896 number of keyed data values, as follows (split into two lines here, to fit on
18897 the page):
18898 .code
18899 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18900 LOOKUP=byname|bydns DATA=<text>
18901 .endd
18902 The data items can be given in any order, and all are optional. If no transport
18903 is included, the transport specified by the generic &%transport%& option is
18904 used. The list of hosts and the lookup type are needed only if the transport is
18905 an &(smtp)& transport that does not itself supply a list of hosts.
18906
18907 The format of the list of hosts is the same as for the &(manualroute)& router.
18908 As well as host names and IP addresses with optional port numbers, as described
18909 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18910 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18911 (see section &<<SECThostshowused>>&).
18912
18913 If the lookup type is not specified, Exim behaves as follows when trying to
18914 find an IP address for each host: First, a DNS lookup is done. If this yields
18915 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18916 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18917 result of the lookup is the result of that call.
18918
18919 .vindex "&$address_data$&"
18920 If the DATA field is set, its value is placed in the &$address_data$&
18921 variable. For example, this return line
18922 .code
18923 accept hosts=x1.y.example:x2.y.example data="rule1"
18924 .endd
18925 routes the address to the default transport, passing a list of two hosts. When
18926 the transport runs, the string &"rule1"& is in &$address_data$&.
18927 .ecindex IIDquerou1
18928 .ecindex IIDquerou2
18929
18930
18931
18932
18933 . ////////////////////////////////////////////////////////////////////////////
18934 . ////////////////////////////////////////////////////////////////////////////
18935
18936 .chapter "The redirect router" "CHAPredirect"
18937 .scindex IIDredrou1 "&(redirect)& router"
18938 .scindex IIDredrou2 "routers" "&(redirect)&"
18939 .cindex "alias file" "in a &(redirect)& router"
18940 .cindex "address redirection" "&(redirect)& router"
18941 The &(redirect)& router handles several kinds of address redirection. Its most
18942 common uses are for resolving local part aliases from a central alias file
18943 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18944 files, but it has many other potential uses. The incoming address can be
18945 redirected in several different ways:
18946
18947 .ilist
18948 It can be replaced by one or more new addresses which are themselves routed
18949 independently.
18950 .next
18951 It can be routed to be delivered to a given file or directory.
18952 .next
18953 It can be routed to be delivered to a specified pipe command.
18954 .next
18955 It can cause an automatic reply to be generated.
18956 .next
18957 It can be forced to fail, optionally with a custom error message.
18958 .next
18959 It can be temporarily deferred, optionally with a custom message.
18960 .next
18961 It can be discarded.
18962 .endlist
18963
18964 The generic &%transport%& option must not be set for &(redirect)& routers.
18965 However, there are some private options which define transports for delivery to
18966 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18967 &%pipe_transport%& and &%reply_transport%& descriptions below.
18968
18969
18970
18971 .section "Redirection data" "SECID124"
18972 The router operates by interpreting a text string which it obtains either by
18973 expanding the contents of the &%data%& option, or by reading the entire
18974 contents of a file whose name is given in the &%file%& option. These two
18975 options are mutually exclusive. The first is commonly used for handling system
18976 aliases, in a configuration like this:
18977 .code
18978 system_aliases:
18979   driver = redirect
18980   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18981 .endd
18982 If the lookup fails, the expanded string in this example is empty. When the
18983 expansion of &%data%& results in an empty string, the router declines. A forced
18984 expansion failure also causes the router to decline; other expansion failures
18985 cause delivery to be deferred.
18986
18987 A configuration using &%file%& is commonly used for handling users'
18988 &_.forward_& files, like this:
18989 .code
18990 userforward:
18991   driver = redirect
18992   check_local_user
18993   file = $home/.forward
18994   no_verify
18995 .endd
18996 If the file does not exist, or causes no action to be taken (for example, it is
18997 empty or consists only of comments), the router declines. &*Warning*&: This
18998 is not the case when the file contains syntactically valid items that happen to
18999 yield empty addresses, for example, items containing only RFC 2822 address
19000 comments.
19001
19002
19003
19004 .section "Forward files and address verification" "SECID125"
19005 .cindex "address redirection" "while verifying"
19006 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19007 &_.forward_& files, as in the example above. There are two reasons for this:
19008
19009 .ilist
19010 When Exim is receiving an incoming SMTP message from a remote host, it is
19011 running under the Exim uid, not as root. Exim is unable to change uid to read
19012 the file as the user, and it may not be able to read it as the Exim user. So in
19013 practice the router may not be able to operate.
19014 .next
19015 However, even when the router can operate, the existence of a &_.forward_& file
19016 is unimportant when verifying an address. What should be checked is whether the
19017 local part is a valid user name or not. Cutting out the redirection processing
19018 saves some resources.
19019 .endlist
19020
19021
19022
19023
19024
19025
19026 .section "Interpreting redirection data" "SECID126"
19027 .cindex "Sieve filter" "specifying in redirection data"
19028 .cindex "filter" "specifying in redirection data"
19029 The contents of the data string, whether obtained from &%data%& or &%file%&,
19030 can be interpreted in two different ways:
19031
19032 .ilist
19033 If the &%allow_filter%& option is set true, and the data begins with the text
19034 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19035 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19036 respectively. Details of the syntax and semantics of filter files are described
19037 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19038 document is intended for use by end users.
19039 .next
19040 Otherwise, the data must be a comma-separated list of redirection items, as
19041 described in the next section.
19042 .endlist
19043
19044 When a message is redirected to a file (a &"mail folder"&), the file name given
19045 in a non-filter redirection list must always be an absolute path. A filter may
19046 generate a relative path &-- how this is handled depends on the transport's
19047 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19048 for the &(appendfile)& transport.
19049
19050
19051
19052 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19053 .cindex "address redirection" "non-filter list items"
19054 When the redirection data is not an Exim or Sieve filter, for example, if it
19055 comes from a conventional alias or forward file, it consists of a list of
19056 addresses, file names, pipe commands, or certain special items (see section
19057 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19058 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19059 depending on their default values. The items in the list are separated by
19060 commas or newlines.
19061 If a comma is required in an item, the entire item must be enclosed in double
19062 quotes.
19063
19064 Lines starting with a # character are comments, and are ignored, and # may
19065 also appear following a comma, in which case everything between the # and the
19066 next newline character is ignored.
19067
19068 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19069 double quotes are retained because some forms of mail address require their use
19070 (but never to enclose the entire address). In the following description,
19071 &"item"& refers to what remains after any surrounding double quotes have been
19072 removed.
19073
19074 .vindex "&$local_part$&"
19075 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19076 and the expansion contains a reference to &$local_part$&, you should make use
19077 of the &%quote_local_part%& expansion operator, in case the local part contains
19078 special characters. For example, to redirect all mail for the domain
19079 &'obsolete.example'&, retaining the existing local part, you could use this
19080 setting:
19081 .code
19082 data = ${quote_local_part:$local_part}@newdomain.example
19083 .endd
19084
19085
19086 .section "Redirecting to a local mailbox" "SECTredlocmai"
19087 .cindex "routing" "loops in"
19088 .cindex "loop" "while routing, avoidance of"
19089 .cindex "address redirection" "to local mailbox"
19090 A redirection item may safely be the same as the address currently under
19091 consideration. This does not cause a routing loop, because a router is
19092 automatically skipped if any ancestor of the address that is being processed
19093 is the same as the current address and was processed by the current router.
19094 Such an address is therefore passed to the following routers, so it is handled
19095 as if there were no redirection. When making this loop-avoidance test, the
19096 complete local part, including any prefix or suffix, is used.
19097
19098 .cindex "address redirection" "local part without domain"
19099 Specifying the same local part without a domain is a common usage in personal
19100 filter files when the user wants to have messages delivered to the local
19101 mailbox and also forwarded elsewhere. For example, the user whose login is
19102 &'cleo'& might have a &_.forward_& file containing this:
19103 .code
19104 cleo, cleopatra@egypt.example
19105 .endd
19106 .cindex "backslash in alias file"
19107 .cindex "alias file" "backslash in"
19108 For compatibility with other MTAs, such unqualified local parts may be
19109 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19110 it does make a difference if more than one domain is being handled
19111 synonymously.
19112
19113 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19114 2822 address that does not include a domain, the item is qualified using the
19115 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19116 addresses are qualified using the value in &%qualify_recipient%&, but you can
19117 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19118
19119 Care must be taken if there are alias names for local users.
19120 Consider an MTA handling a single local domain where the system alias file
19121 contains:
19122 .code
19123 Sam.Reman: spqr
19124 .endd
19125 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19126 messages in the local mailbox, and also forward copies elsewhere. He creates
19127 this forward file:
19128 .code
19129 Sam.Reman, spqr@reme.elsewhere.example
19130 .endd
19131 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19132 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19133 second time round, because it has previously routed it,
19134 and the following routers presumably cannot handle the alias. The forward file
19135 should really contain
19136 .code
19137 spqr, spqr@reme.elsewhere.example
19138 .endd
19139 but because this is such a common error, the &%check_ancestor%& option (see
19140 below) exists to provide a way to get round it. This is normally set on a
19141 &(redirect)& router that is handling users' &_.forward_& files.
19142
19143
19144
19145 .section "Special items in redirection lists" "SECTspecitredli"
19146 In addition to addresses, the following types of item may appear in redirection
19147 lists (that is, in non-filter redirection data):
19148
19149 .ilist
19150 .cindex "pipe" "in redirection list"
19151 .cindex "address redirection" "to pipe"
19152 An item is treated as a pipe command if it begins with &"|"& and does not parse
19153 as a valid RFC 2822 address that includes a domain. A transport for running the
19154 command must be specified by the &%pipe_transport%& option.
19155 Normally, either the router or the transport specifies a user and a group under
19156 which to run the delivery. The default is to use the Exim user and group.
19157
19158 Single or double quotes can be used for enclosing the individual arguments of
19159 the pipe command; no interpretation of escapes is done for single quotes. If
19160 the command contains a comma character, it is necessary to put the whole item
19161 in double quotes, for example:
19162 .code
19163 "|/some/command ready,steady,go"
19164 .endd
19165 since items in redirection lists are terminated by commas. Do not, however,
19166 quote just the command. An item such as
19167 .code
19168 |"/some/command ready,steady,go"
19169 .endd
19170 is interpreted as a pipe with a rather strange command name, and no arguments.
19171
19172 Note that the above example assumes that the text comes from a lookup source
19173 of some sort, so that the quotes are part of the data.  If composing a
19174 redirect router with a &%data%& option directly specifying this command, the
19175 quotes will be used by the configuration parser to define the extent of one
19176 string, but will not be passed down into the redirect router itself.  There
19177 are two main approaches to get around this: escape quotes to be part of the
19178 data itself, or avoid using this mechanism and instead create a custom
19179 transport with the &%command%& option set and reference that transport from
19180 an &%accept%& router.
19181
19182 .next
19183 .cindex "file" "in redirection list"
19184 .cindex "address redirection" "to file"
19185 An item is interpreted as a path name if it begins with &"/"& and does not
19186 parse as a valid RFC 2822 address that includes a domain. For example,
19187 .code
19188 /home/world/minbari
19189 .endd
19190 is treated as a file name, but
19191 .code
19192 /s=molari/o=babylon/@x400gate.way
19193 .endd
19194 is treated as an address. For a file name, a transport must be specified using
19195 the &%file_transport%& option. However, if the generated path name ends with a
19196 forward slash character, it is interpreted as a directory name rather than a
19197 file name, and &%directory_transport%& is used instead.
19198
19199 Normally, either the router or the transport specifies a user and a group under
19200 which to run the delivery. The default is to use the Exim user and group.
19201
19202 .cindex "&_/dev/null_&"
19203 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19204 bypassed at a high level, and the log entry shows &"**bypassed**"&
19205 instead of a transport name. In this case the user and group are not used.
19206
19207 .next
19208 .cindex "included address list"
19209 .cindex "address redirection" "included external list"
19210 If an item is of the form
19211 .code
19212 :include:<path name>
19213 .endd
19214 a list of further items is taken from the given file and included at that
19215 point. &*Note*&: Such a file can not be a filter file; it is just an
19216 out-of-line addition to the list. The items in the included list are separated
19217 by commas or newlines and are not subject to expansion. If this is the first
19218 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19219 the alias name. This example is incorrect:
19220 .code
19221 list1    :include:/opt/lists/list1
19222 .endd
19223 It must be given as
19224 .code
19225 list1:   :include:/opt/lists/list1
19226 .endd
19227 .next
19228 .cindex "address redirection" "to black hole"
19229 Sometimes you want to throw away mail to a particular local part. Making the
19230 &%data%& option expand to an empty string does not work, because that causes
19231 the router to decline. Instead, the alias item
19232 .cindex "black hole"
19233 .cindex "abandoning mail"
19234 &':blackhole:'& can be used. It does what its name implies. No delivery is
19235 done, and no error message is generated. This has the same effect as specifing
19236 &_/dev/null_& as a destination, but it can be independently disabled.
19237
19238 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19239 delivery is done for the original local part, even if other redirection items
19240 are present. If you are generating a multi-item list (for example, by reading a
19241 database) and need the ability to provide a no-op item, you must use
19242 &_/dev/null_&.
19243
19244 .next
19245 .cindex "delivery" "forcing failure"
19246 .cindex "delivery" "forcing deferral"
19247 .cindex "failing delivery" "forcing"
19248 .cindex "deferred delivery, forcing"
19249 .cindex "customizing" "failure message"
19250 An attempt to deliver a particular address can be deferred or forced to fail by
19251 redirection items of the form
19252 .code
19253 :defer:
19254 :fail:
19255 .endd
19256 respectively. When a redirection list contains such an item, it applies
19257 to the entire redirection; any other items in the list are ignored. Any
19258 text following &':fail:'& or &':defer:'& is placed in the error text
19259 associated with the failure. For example, an alias file might contain:
19260 .code
19261 X.Employee:  :fail: Gone away, no forwarding address
19262 .endd
19263 In the case of an address that is being verified from an ACL or as the subject
19264 of a
19265 .cindex "VRFY" "error text, display of"
19266 VRFY command, the text is included in the SMTP error response by
19267 default.
19268 .cindex "EXPN" "error text, display of"
19269 The text is not included in the response to an EXPN command. In non-SMTP cases
19270 the text is included in the error message that Exim generates.
19271
19272 .cindex "SMTP" "error codes"
19273 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19274 &':fail:'&. However, if the message starts with three digits followed by a
19275 space, optionally followed by an extended code of the form &'n.n.n'&, also
19276 followed by a space, and the very first digit is the same as the default error
19277 code, the code from the message is used instead. If the very first digit is
19278 incorrect, a panic error is logged, and the default code is used. You can
19279 suppress the use of the supplied code in a redirect router by setting the
19280 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19281 ignored.
19282
19283 .vindex "&$acl_verify_message$&"
19284 In an ACL, an explicitly provided message overrides the default, but the
19285 default message is available in the variable &$acl_verify_message$& and can
19286 therefore be included in a custom message if this is desired.
19287
19288 Normally the error text is the rest of the redirection list &-- a comma does
19289 not terminate it &-- but a newline does act as a terminator. Newlines are not
19290 normally present in alias expansions. In &(lsearch)& lookups they are removed
19291 as part of the continuation process, but they may exist in other kinds of
19292 lookup and in &':include:'& files.
19293
19294 During routing for message delivery (as opposed to verification), a redirection
19295 containing &':fail:'& causes an immediate failure of the incoming address,
19296 whereas &':defer:'& causes the message to remain on the queue so that a
19297 subsequent delivery attempt can happen at a later time. If an address is
19298 deferred for too long, it will ultimately fail, because the normal retry
19299 rules still apply.
19300
19301 .next
19302 .cindex "alias file" "exception to default"
19303 Sometimes it is useful to use a single-key search type with a default (see
19304 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19305 for exceptions to the default. These can be handled by aliasing them to
19306 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19307 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19308 results in an empty redirection list has the same effect.
19309 .endlist
19310
19311
19312 .section "Duplicate addresses" "SECTdupaddr"
19313 .cindex "duplicate addresses"
19314 .cindex "address duplicate, discarding"
19315 .cindex "pipe" "duplicated"
19316 Exim removes duplicate addresses from the list to which it is delivering, so as
19317 to deliver just one copy to each address. This does not apply to deliveries
19318 routed to pipes by different immediate parent addresses, but an indirect
19319 aliasing scheme of the type
19320 .code
19321 pipe:       |/some/command $local_part
19322 localpart1: pipe
19323 localpart2: pipe
19324 .endd
19325 does not work with a message that is addressed to both local parts, because
19326 when the second is aliased to the intermediate local part &"pipe"& it gets
19327 discarded as being the same as a previously handled address. However, a scheme
19328 such as
19329 .code
19330 localpart1: |/some/command $local_part
19331 localpart2: |/some/command $local_part
19332 .endd
19333 does result in two different pipe deliveries, because the immediate parents of
19334 the pipes are distinct.
19335
19336
19337
19338 .section "Repeated redirection expansion" "SECID128"
19339 .cindex "repeated redirection expansion"
19340 .cindex "address redirection" "repeated for each delivery attempt"
19341 When a message cannot be delivered to all of its recipients immediately,
19342 leading to two or more delivery attempts, redirection expansion is carried out
19343 afresh each time for those addresses whose children were not all previously
19344 delivered. If redirection is being used as a mailing list, this can lead to new
19345 members of the list receiving copies of old messages. The &%one_time%& option
19346 can be used to avoid this.
19347
19348
19349 .section "Errors in redirection lists" "SECID129"
19350 .cindex "address redirection" "errors"
19351 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19352 error is skipped, and an entry is written to the main log. This may be useful
19353 for mailing lists that are automatically managed. Otherwise, if an error is
19354 detected while generating the list of new addresses, the original address is
19355 deferred. See also &%syntax_errors_to%&.
19356
19357
19358
19359 .section "Private options for the redirect router" "SECID130"
19360
19361 .cindex "options" "&(redirect)& router"
19362 The private options for the &(redirect)& router are as follows:
19363
19364
19365 .option allow_defer redirect boolean false
19366 Setting this option allows the use of &':defer:'& in non-filter redirection
19367 data, or the &%defer%& command in an Exim filter file.
19368
19369
19370 .option allow_fail redirect boolean false
19371 .cindex "failing delivery" "from filter"
19372 If this option is true, the &':fail:'& item can be used in a redirection list,
19373 and the &%fail%& command may be used in an Exim filter file.
19374
19375
19376 .option allow_filter redirect boolean false
19377 .cindex "filter" "enabling use of"
19378 .cindex "Sieve filter" "enabling use of"
19379 Setting this option allows Exim to interpret redirection data that starts with
19380 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19381 are some features of Exim filter files that some administrators may wish to
19382 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19383
19384 It is also possible to lock out Exim filters or Sieve filters while allowing
19385 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19386
19387
19388 The filter is run using the uid and gid set by the generic &%user%& and
19389 &%group%& options. These take their defaults from the password data if
19390 &%check_local_user%& is set, so in the normal case of users' personal filter
19391 files, the filter is run as the relevant user. When &%allow_filter%& is set
19392 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19393
19394
19395
19396 .option allow_freeze redirect boolean false
19397 .cindex "freezing messages" "allowing in filter"
19398 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19399 This command is more normally encountered in system filters, and is disabled by
19400 default for redirection filters because it isn't something you usually want to
19401 let ordinary users do.
19402
19403
19404
19405 .option check_ancestor redirect boolean false
19406 This option is concerned with handling generated addresses that are the same
19407 as some address in the list of redirection ancestors of the current address.
19408 Although it is turned off by default in the code, it is set in the default
19409 configuration file for handling users' &_.forward_& files. It is recommended
19410 for this use of the &(redirect)& router.
19411
19412 When &%check_ancestor%& is set, if a generated address (including the domain)
19413 is the same as any ancestor of the current address, it is replaced by a copy of
19414 the current address. This helps in the case where local part A is aliased to B,
19415 and B has a &_.forward_& file pointing back to A. For example, within a single
19416 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19417 &_&~jb/.forward_& contains:
19418 .code
19419 \Joe.Bloggs, <other item(s)>
19420 .endd
19421 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19422 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19423 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19424 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19425 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19426 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19427 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19428 original address. See also the &%repeat_use%& option below.
19429
19430
19431 .option check_group redirect boolean "see below"
19432 When the &%file%& option is used, the group owner of the file is checked only
19433 when this option is set. The permitted groups are those listed in the
19434 &%owngroups%& option, together with the user's default group if
19435 &%check_local_user%& is set. If the file has the wrong group, routing is
19436 deferred. The default setting for this option is true if &%check_local_user%&
19437 is set and the &%modemask%& option permits the group write bit, or if the
19438 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19439
19440
19441
19442 .option check_owner redirect boolean "see below"
19443 When the &%file%& option is used, the owner of the file is checked only when
19444 this option is set. If &%check_local_user%& is set, the local user is
19445 permitted; otherwise the owner must be one of those listed in the &%owners%&
19446 option. The default value for this option is true if &%check_local_user%& or
19447 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19448
19449
19450 .option data redirect string&!! unset
19451 This option is mutually exclusive with &%file%&. One or other of them must be
19452 set, but not both. The contents of &%data%& are expanded, and then used as the
19453 list of forwarding items, or as a set of filtering instructions. If the
19454 expansion is forced to fail, or the result is an empty string or a string that
19455 has no effect (consists entirely of comments), the router declines.
19456
19457 When filtering instructions are used, the string must begin with &"#Exim
19458 filter"&, and all comments in the string, including this initial one, must be
19459 terminated with newline characters. For example:
19460 .code
19461 data = #Exim filter\n\
19462        if $h_to: contains Exim then save $home/mail/exim endif
19463 .endd
19464 If you are reading the data from a database where newlines cannot be included,
19465 you can use the &${sg}$& expansion item to turn the escape string of your
19466 choice into a newline.
19467
19468
19469 .option directory_transport redirect string&!! unset
19470 A &(redirect)& router sets up a direct delivery to a directory when a path name
19471 ending with a slash is specified as a new &"address"&. The transport used is
19472 specified by this option, which, after expansion, must be the name of a
19473 configured transport. This should normally be an &(appendfile)& transport.
19474
19475
19476 .option file redirect string&!! unset
19477 This option specifies the name of a file that contains the redirection data. It
19478 is mutually exclusive with the &%data%& option. The string is expanded before
19479 use; if the expansion is forced to fail, the router declines. Other expansion
19480 failures cause delivery to be deferred. The result of a successful expansion
19481 must be an absolute path. The entire file is read and used as the redirection
19482 data. If the data is an empty string or a string that has no effect (consists
19483 entirely of comments), the router declines.
19484
19485 .cindex "NFS" "checking for file existence"
19486 If the attempt to open the file fails with a &"does not exist"& error, Exim
19487 runs a check on the containing directory,
19488 unless &%ignore_enotdir%& is true (see below).
19489 If the directory does not appear to exist, delivery is deferred. This can
19490 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19491 is a mount problem. If the containing directory does exist, but the file does
19492 not, the router declines.
19493
19494
19495 .option file_transport redirect string&!! unset
19496 .vindex "&$address_file$&"
19497 A &(redirect)& router sets up a direct delivery to a file when a path name not
19498 ending in a slash is specified as a new &"address"&. The transport used is
19499 specified by this option, which, after expansion, must be the name of a
19500 configured transport. This should normally be an &(appendfile)& transport. When
19501 it is running, the file name is in &$address_file$&.
19502
19503
19504 .option filter_prepend_home redirect boolean true
19505 When this option is true, if a &(save)& command in an Exim filter specifies a
19506 relative path, and &$home$& is defined, it is automatically prepended to the
19507 relative path. If this option is set false, this action does not happen. The
19508 relative path is then passed to the transport unmodified.
19509
19510
19511 .option forbid_blackhole redirect boolean false
19512 If this option is true, the &':blackhole:'& item may not appear in a
19513 redirection list.
19514
19515
19516 .option forbid_exim_filter redirect boolean false
19517 If this option is set true, only Sieve filters are permitted when
19518 &%allow_filter%& is true.
19519
19520
19521
19522
19523 .option forbid_file redirect boolean false
19524 .cindex "delivery" "to file; forbidding"
19525 .cindex "Sieve filter" "forbidding delivery to a file"
19526 .cindex "Sieve filter" "&""keep""& facility; disabling"
19527 If this option is true, this router may not generate a new address that
19528 specifies delivery to a local file or directory, either from a filter or from a
19529 conventional forward file. This option is forced to be true if &%one_time%& is
19530 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19531 locks out the Sieve's &"keep"& facility.
19532
19533
19534 .option forbid_filter_dlfunc redirect boolean false
19535 .cindex "filter" "locking out certain features"
19536 If this option is true, string expansions in Exim filters are not allowed to
19537 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19538 functions.
19539
19540 .option forbid_filter_existstest redirect boolean false
19541 .cindex "expansion" "statting a file"
19542 If this option is true, string expansions in Exim filters are not allowed to
19543 make use of the &%exists%& condition or the &%stat%& expansion item.
19544
19545 .option forbid_filter_logwrite redirect boolean false
19546 If this option is true, use of the logging facility in Exim filters is not
19547 permitted. Logging is in any case available only if the filter is being run
19548 under some unprivileged uid (which is normally the case for ordinary users'
19549 &_.forward_& files).
19550
19551
19552 .option forbid_filter_lookup redirect boolean false
19553 If this option is true, string expansions in Exim filter files are not allowed
19554 to make use of &%lookup%& items.
19555
19556
19557 .option forbid_filter_perl redirect boolean false
19558 This option has an effect only if Exim is built with embedded Perl support. If
19559 it is true, string expansions in Exim filter files are not allowed to make use
19560 of the embedded Perl support.
19561
19562
19563 .option forbid_filter_readfile redirect boolean false
19564 If this option is true, string expansions in Exim filter files are not allowed
19565 to make use of &%readfile%& items.
19566
19567
19568 .option forbid_filter_readsocket redirect boolean false
19569 If this option is true, string expansions in Exim filter files are not allowed
19570 to make use of &%readsocket%& items.
19571
19572
19573 .option forbid_filter_reply redirect boolean false
19574 If this option is true, this router may not generate an automatic reply
19575 message. Automatic replies can be generated only from Exim or Sieve filter
19576 files, not from traditional forward files. This option is forced to be true if
19577 &%one_time%& is set.
19578
19579
19580 .option forbid_filter_run redirect boolean false
19581 If this option is true, string expansions in Exim filter files are not allowed
19582 to make use of &%run%& items.
19583
19584
19585 .option forbid_include redirect boolean false
19586 If this option is true, items of the form
19587 .code
19588 :include:<path name>
19589 .endd
19590 are not permitted in non-filter redirection lists.
19591
19592
19593 .option forbid_pipe redirect boolean false
19594 .cindex "delivery" "to pipe; forbidding"
19595 If this option is true, this router may not generate a new address which
19596 specifies delivery to a pipe, either from an Exim filter or from a conventional
19597 forward file. This option is forced to be true if &%one_time%& is set.
19598
19599
19600 .option forbid_sieve_filter redirect boolean false
19601 If this option is set true, only Exim filters are permitted when
19602 &%allow_filter%& is true.
19603
19604
19605 .cindex "SMTP" "error codes"
19606 .option forbid_smtp_code redirect boolean false
19607 If this option is set true, any SMTP error codes that are present at the start
19608 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19609 the default codes (451 and 550, respectively) are always used.
19610
19611
19612
19613
19614 .option hide_child_in_errmsg redirect boolean false
19615 .cindex "bounce message" "redirection details; suppressing"
19616 If this option is true, it prevents Exim from quoting a child address if it
19617 generates a bounce or delay message for it. Instead it says &"an address
19618 generated from <&'the top level address'&>"&. Of course, this applies only to
19619 bounces generated locally. If a message is forwarded to another host, &'its'&
19620 bounce may well quote the generated address.
19621
19622
19623 .option ignore_eacces redirect boolean false
19624 .cindex "EACCES"
19625 If this option is set and an attempt to open a redirection file yields the
19626 EACCES error (permission denied), the &(redirect)& router behaves as if the
19627 file did not exist.
19628
19629
19630 .option ignore_enotdir redirect boolean false
19631 .cindex "ENOTDIR"
19632 If this option is set and an attempt to open a redirection file yields the
19633 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19634 router behaves as if the file did not exist.
19635
19636 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19637 router that has the &%file%& option set discovers that the file does not exist
19638 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19639 against unmounted NFS directories. If the parent can not be statted, delivery
19640 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19641 is set, because that option tells Exim to ignore &"something on the path is not
19642 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19643 that some operating systems give ENOENT where others give ENOTDIR.
19644
19645
19646
19647 .option include_directory redirect string unset
19648 If this option is set, the path names of any &':include:'& items in a
19649 redirection list must start with this directory.
19650
19651
19652 .option modemask redirect "octal integer" 022
19653 This specifies mode bits which must not be set for a file specified by the
19654 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19655
19656
19657 .option one_time redirect boolean false
19658 .cindex "one-time aliasing/forwarding expansion"
19659 .cindex "alias file" "one-time expansion"
19660 .cindex "forward file" "one-time expansion"
19661 .cindex "mailing lists" "one-time expansion"
19662 .cindex "address redirection" "one-time expansion"
19663 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19664 files each time it tries to deliver a message causes a problem when one or more
19665 of the generated addresses fails be delivered at the first attempt. The problem
19666 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19667 but of what happens when the redirection list changes during the time that the
19668 message is on Exim's queue. This is particularly true in the case of mailing
19669 lists, where new subscribers might receive copies of messages that were posted
19670 before they subscribed.
19671
19672 If &%one_time%& is set and any addresses generated by the router fail to
19673 deliver at the first attempt, the failing addresses are added to the message as
19674 &"top level"& addresses, and the parent address that generated them is marked
19675 &"delivered"&. Thus, redirection does not happen again at the next delivery
19676 attempt.
19677
19678 &*Warning 1*&: Any header line addition or removal that is specified by this
19679 router would be lost if delivery did not succeed at the first attempt. For this
19680 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19681 permitted when &%one_time%& is set.
19682
19683 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19684 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19685 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19686
19687 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19688 &%one_time%&.
19689
19690 The original top-level address is remembered with each of the generated
19691 addresses, and is output in any log messages. However, any intermediate parent
19692 addresses are not recorded. This makes a difference to the log only if
19693 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19694 typically be used for mailing lists, where there is normally just one level of
19695 expansion.
19696
19697
19698 .option owners redirect "string list" unset
19699 .cindex "ownership" "alias file"
19700 .cindex "ownership" "forward file"
19701 .cindex "alias file" "ownership"
19702 .cindex "forward file" "ownership"
19703 This specifies a list of permitted owners for the file specified by &%file%&.
19704 This list is in addition to the local user when &%check_local_user%& is set.
19705 See &%check_owner%& above.
19706
19707
19708 .option owngroups redirect "string list" unset
19709 This specifies a list of permitted groups for the file specified by &%file%&.
19710 The list is in addition to the local user's primary group when
19711 &%check_local_user%& is set. See &%check_group%& above.
19712
19713
19714 .option pipe_transport redirect string&!! unset
19715 .vindex "&$address_pipe$&"
19716 A &(redirect)& router sets up a direct delivery to a pipe when a string
19717 starting with a vertical bar character is specified as a new &"address"&. The
19718 transport used is specified by this option, which, after expansion, must be the
19719 name of a configured transport. This should normally be a &(pipe)& transport.
19720 When the transport is run, the pipe command is in &$address_pipe$&.
19721
19722
19723 .option qualify_domain redirect string&!! unset
19724 .vindex "&$qualify_recipient$&"
19725 If this option is set, and an unqualified address (one without a domain) is
19726 generated, and that address would normally be qualified by the global setting
19727 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19728 expanding this string. If the expansion fails, the router declines. If you want
19729 to revert to the default, you can have the expansion generate
19730 &$qualify_recipient$&.
19731
19732 This option applies to all unqualified addresses generated by Exim filters,
19733 but for traditional &_.forward_& files, it applies only to addresses that are
19734 not preceded by a backslash. Sieve filters cannot generate unqualified
19735 addresses.
19736
19737 .option qualify_preserve_domain redirect boolean false
19738 .cindex "domain" "in redirection; preserving"
19739 .cindex "preserving domain in redirection"
19740 .cindex "address redirection" "domain; preserving"
19741 If this option is set, the router's local &%qualify_domain%& option must not be
19742 set (a configuration error occurs if it is). If an unqualified address (one
19743 without a domain) is generated, it is qualified with the domain of the parent
19744 address (the immediately preceding ancestor) instead of the global
19745 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19746 this applies whether or not the address is preceded by a backslash.
19747
19748
19749 .option repeat_use redirect boolean true
19750 If this option is set false, the router is skipped for a child address that has
19751 any ancestor that was routed by this router. This test happens before any of
19752 the other preconditions are tested. Exim's default anti-looping rules skip
19753 only when the ancestor is the same as the current address. See also
19754 &%check_ancestor%& above and the generic &%redirect_router%& option.
19755
19756
19757 .option reply_transport redirect string&!! unset
19758 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19759 &%vacation%& command is used in a filter file. The transport used is specified
19760 by this option, which, after expansion, must be the name of a configured
19761 transport. This should normally be an &(autoreply)& transport. Other transports
19762 are unlikely to do anything sensible or useful.
19763
19764
19765 .option rewrite redirect boolean true
19766 .cindex "address redirection" "disabling rewriting"
19767 If this option is set false, addresses generated by the router are not
19768 subject to address rewriting. Otherwise, they are treated like new addresses
19769 and are rewritten according to the global rewriting rules.
19770
19771
19772 .option sieve_subaddress redirect string&!! unset
19773 The value of this option is passed to a Sieve filter to specify the
19774 :subaddress part of an address.
19775
19776 .option sieve_useraddress redirect string&!! unset
19777 The value of this option is passed to a Sieve filter to specify the :user part
19778 of an address. However, if it is unset, the entire original local part
19779 (including any prefix or suffix) is used for :user.
19780
19781
19782 .option sieve_vacation_directory redirect string&!! unset
19783 .cindex "Sieve filter" "vacation directory"
19784 To enable the &"vacation"& extension for Sieve filters, you must set
19785 &%sieve_vacation_directory%& to the directory where vacation databases are held
19786 (do not put anything else in that directory), and ensure that the
19787 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19788 needs their own directory; Exim will create it if necessary.
19789
19790
19791
19792 .option skip_syntax_errors redirect boolean false
19793 .cindex "forward file" "broken"
19794 .cindex "address redirection" "broken files"
19795 .cindex "alias file" "broken"
19796 .cindex "broken alias or forward files"
19797 .cindex "ignoring faulty addresses"
19798 .cindex "skipping faulty addresses"
19799 .cindex "error" "skipping bad syntax"
19800 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19801 non-filter redirection data are skipped, and each failing address is logged. If
19802 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19803 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19804 are expanded and placed at the head of the error message generated by
19805 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19806 be the same address as the generic &%errors_to%& option. The
19807 &%skip_syntax_errors%& option is often used when handling mailing lists.
19808
19809 If all the addresses in a redirection list are skipped because of syntax
19810 errors, the router declines to handle the original address, and it is passed to
19811 the following routers.
19812
19813 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19814 error in the filter causes filtering to be abandoned without any action being
19815 taken. The incident is logged, and the router declines to handle the address,
19816 so it is passed to the following routers.
19817
19818 .cindex "Sieve filter" "syntax errors in"
19819 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19820 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19821 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19822
19823 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19824 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19825 option, used with an address that does not get redirected, can be used to
19826 notify users of these errors, by means of a router like this:
19827 .code
19828 userforward:
19829   driver = redirect
19830   allow_filter
19831   check_local_user
19832   file = $home/.forward
19833   file_transport = address_file
19834   pipe_transport = address_pipe
19835   reply_transport = address_reply
19836   no_verify
19837   skip_syntax_errors
19838   syntax_errors_to = real-$local_part@$domain
19839   syntax_errors_text = \
19840    This is an automatically generated message. An error has\n\
19841    been found in your .forward file. Details of the error are\n\
19842    reported below. While this error persists, you will receive\n\
19843    a copy of this message for every message that is addressed\n\
19844    to you. If your .forward file is a filter file, or if it is\n\
19845    a non-filter file containing no valid forwarding addresses,\n\
19846    a copy of each incoming message will be put in your normal\n\
19847    mailbox. If a non-filter file contains at least one valid\n\
19848    forwarding address, forwarding to the valid addresses will\n\
19849    happen, and those will be the only deliveries that occur.
19850 .endd
19851 You also need a router to ensure that local addresses that are prefixed by
19852 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19853 put this immediately before the &(userforward)& router:
19854 .code
19855 real_localuser:
19856   driver = accept
19857   check_local_user
19858   local_part_prefix = real-
19859   transport = local_delivery
19860 .endd
19861 For security, it would probably be a good idea to restrict the use of this
19862 router to locally-generated messages, using a condition such as this:
19863 .code
19864   condition = ${if match {$sender_host_address}\
19865                          {\N^(|127\.0\.0\.1)$\N}}
19866 .endd
19867
19868
19869 .option syntax_errors_text redirect string&!! unset
19870 See &%skip_syntax_errors%& above.
19871
19872
19873 .option syntax_errors_to redirect string unset
19874 See &%skip_syntax_errors%& above.
19875 .ecindex IIDredrou1
19876 .ecindex IIDredrou2
19877
19878
19879
19880
19881
19882
19883 . ////////////////////////////////////////////////////////////////////////////
19884 . ////////////////////////////////////////////////////////////////////////////
19885
19886 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19887          "Environment for local transports"
19888 .scindex IIDenvlotra1 "local transports" "environment for"
19889 .scindex IIDenvlotra2 "environment for local transports"
19890 .scindex IIDenvlotra3 "transport" "local; environment for"
19891 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19892 transport can be thought of as similar to a pipe.) Exim always runs transports
19893 in subprocesses, under specified uids and gids. Typical deliveries to local
19894 mailboxes run under the uid and gid of the local user.
19895
19896 Exim also sets a specific current directory while running the transport; for
19897 some transports a home directory setting is also relevant. The &(pipe)&
19898 transport is the only one that sets up environment variables; see section
19899 &<<SECTpipeenv>>& for details.
19900
19901 The values used for the uid, gid, and the directories may come from several
19902 different places. In many cases, the router that handles the address associates
19903 settings with that address as a result of its &%check_local_user%&, &%group%&,
19904 or &%user%& options. However, values may also be given in the transport's own
19905 configuration, and these override anything that comes from the router.
19906
19907
19908
19909 .section "Concurrent deliveries" "SECID131"
19910 .cindex "concurrent deliveries"
19911 .cindex "simultaneous deliveries"
19912 If two different messages for the same local recipient arrive more or less
19913 simultaneously, the two delivery processes are likely to run concurrently. When
19914 the &(appendfile)& transport is used to write to a file, Exim applies locking
19915 rules to stop concurrent processes from writing to the same file at the same
19916 time.
19917
19918 However, when you use a &(pipe)& transport, it is up to you to arrange any
19919 locking that is needed. Here is a silly example:
19920 .code
19921 my_transport:
19922   driver = pipe
19923   command = /bin/sh -c 'cat >>/some/file'
19924 .endd
19925 This is supposed to write the message at the end of the file. However, if two
19926 messages arrive at the same time, the file will be scrambled. You can use the
19927 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19928 file using the same algorithm that Exim itself uses.
19929
19930
19931
19932
19933 .section "Uids and gids" "SECTenvuidgid"
19934 .cindex "local transports" "uid and gid"
19935 .cindex "transport" "local; uid and gid"
19936 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19937 overrides any group that the router set in the address, even if &%user%& is not
19938 set for the transport. This makes it possible, for example, to run local mail
19939 delivery under the uid of the recipient (set by the router), but in a special
19940 group (set by the transport). For example:
19941 .code
19942 # Routers ...
19943 # User/group are set by check_local_user in this router
19944 local_users:
19945   driver = accept
19946   check_local_user
19947   transport = group_delivery
19948
19949 # Transports ...
19950 # This transport overrides the group
19951 group_delivery:
19952   driver = appendfile
19953   file = /var/spool/mail/$local_part
19954   group = mail
19955 .endd
19956 If &%user%& is set for a transport, its value overrides what is set in the
19957 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19958 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19959 set.
19960
19961 .oindex "&%initgroups%&"
19962 When the uid is taken from the transport's configuration, the &[initgroups()]&
19963 function is called for the groups associated with that uid if the
19964 &%initgroups%& option is set for the transport. When the uid is not specified
19965 by the transport, but is associated with the address by a router, the option
19966 for calling &[initgroups()]& is taken from the router configuration.
19967
19968 .cindex "&(pipe)& transport" "uid for"
19969 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19970 is set and &%user%& is not set, the uid of the process that called Exim to
19971 receive the message is used, and if &%group%& is not set, the corresponding
19972 original gid is also used.
19973
19974 This is the detailed preference order for obtaining a gid; the first of the
19975 following that is set is used:
19976
19977 .ilist
19978 A &%group%& setting of the transport;
19979 .next
19980 A &%group%& setting of the router;
19981 .next
19982 A gid associated with a user setting of the router, either as a result of
19983 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19984 .next
19985 The group associated with a non-numeric &%user%& setting of the transport;
19986 .next
19987 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19988 the uid is the creator's uid;
19989 .next
19990 The Exim gid if the Exim uid is being used as a default.
19991 .endlist
19992
19993 If, for example, the user is specified numerically on the router and there are
19994 no group settings, no gid is available. In this situation, an error occurs.
19995 This is different for the uid, for which there always is an ultimate default.
19996 The first of the following that is set is used:
19997
19998 .ilist
19999 A &%user%& setting of the transport;
20000 .next
20001 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20002 .next
20003 A &%user%& setting of the router;
20004 .next
20005 A &%check_local_user%& setting of the router;
20006 .next
20007 The Exim uid.
20008 .endlist
20009
20010 Of course, an error will still occur if the uid that is chosen is on the
20011 &%never_users%& list.
20012
20013
20014
20015
20016
20017 .section "Current and home directories" "SECID132"
20018 .cindex "current directory for local transport"
20019 .cindex "home directory" "for local transport"
20020 .cindex "transport" "local; home directory for"
20021 .cindex "transport" "local; current directory for"
20022 Routers may set current and home directories for local transports by means of
20023 the &%transport_current_directory%& and &%transport_home_directory%& options.
20024 However, if the transport's &%current_directory%& or &%home_directory%& options
20025 are set, they override the router's values. In detail, the home directory
20026 for a local transport is taken from the first of these values that is set:
20027
20028 .ilist
20029 The &%home_directory%& option on the transport;
20030 .next
20031 The &%transport_home_directory%& option on the router;
20032 .next
20033 The password data if &%check_local_user%& is set on the router;
20034 .next
20035 The &%router_home_directory%& option on the router.
20036 .endlist
20037
20038 The current directory is taken from the first of these values that is set:
20039
20040 .ilist
20041 The &%current_directory%& option on the transport;
20042 .next
20043 The &%transport_current_directory%& option on the router.
20044 .endlist
20045
20046
20047 If neither the router nor the transport sets a current directory, Exim uses the
20048 value of the home directory, if it is set. Otherwise it sets the current
20049 directory to &_/_& before running a local transport.
20050
20051
20052
20053 .section "Expansion variables derived from the address" "SECID133"
20054 .vindex "&$domain$&"
20055 .vindex "&$local_part$&"
20056 .vindex "&$original_domain$&"
20057 Normally a local delivery is handling a single address, and in that case the
20058 variables such as &$domain$& and &$local_part$& are set during local
20059 deliveries. However, in some circumstances more than one address may be handled
20060 at once (for example, while writing batch SMTP for onward transmission by some
20061 other means). In this case, the variables associated with the local part are
20062 never set, &$domain$& is set only if all the addresses have the same domain,
20063 and &$original_domain$& is never set.
20064 .ecindex IIDenvlotra1
20065 .ecindex IIDenvlotra2
20066 .ecindex IIDenvlotra3
20067
20068
20069
20070
20071
20072
20073
20074 . ////////////////////////////////////////////////////////////////////////////
20075 . ////////////////////////////////////////////////////////////////////////////
20076
20077 .chapter "Generic options for transports" "CHAPtransportgeneric"
20078 .scindex IIDgenoptra1 "generic options" "transport"
20079 .scindex IIDgenoptra2 "options" "generic; for transports"
20080 .scindex IIDgenoptra3 "transport" "generic options for"
20081 The following generic options apply to all transports:
20082
20083
20084 .option body_only transports boolean false
20085 .cindex "transport" "body only"
20086 .cindex "message" "transporting body only"
20087 .cindex "body of message" "transporting"
20088 If this option is set, the message's headers are not transported. It is
20089 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20090 or &(pipe)& transports, the settings of &%message_prefix%& and
20091 &%message_suffix%& should be checked, because this option does not
20092 automatically suppress them.
20093
20094
20095 .option current_directory transports string&!! unset
20096 .cindex "transport" "current directory for"
20097 This specifies the current directory that is to be set while running the
20098 transport, overriding any value that may have been set by the router.
20099 If the expansion fails for any reason, including forced failure, an error is
20100 logged, and delivery is deferred.
20101
20102
20103 .option disable_logging transports boolean false
20104 If this option is set true, nothing is logged for any
20105 deliveries by the transport or for any
20106 transport errors. You should not set this option unless you really, really know
20107 what you are doing.
20108
20109
20110 .option debug_print transports string&!! unset
20111 .cindex "testing" "variables in drivers"
20112 If this option is set and debugging is enabled (see the &%-d%& command line
20113 option), the string is expanded and included in the debugging output when the
20114 transport is run.
20115 If expansion of the string fails, the error message is written to the debugging
20116 output, and Exim carries on processing.
20117 This facility is provided to help with checking out the values of variables and
20118 so on when debugging driver configurations. For example, if a &%headers_add%&
20119 option is not working properly, &%debug_print%& could be used to output the
20120 variables it references. A newline is added to the text if it does not end with
20121 one.
20122 The variables &$transport_name$& and &$router_name$& contain the name of the
20123 transport and the router that called it.
20124
20125 .option delivery_date_add transports boolean false
20126 .cindex "&'Delivery-date:'& header line"
20127 If this option is true, a &'Delivery-date:'& header is added to the message.
20128 This gives the actual time the delivery was made. As this is not a standard
20129 header, Exim has a configuration option (&%delivery_date_remove%&) which
20130 requests its removal from incoming messages, so that delivered messages can
20131 safely be resent to other recipients.
20132
20133
20134 .option driver transports string unset
20135 This specifies which of the available transport drivers is to be used.
20136 There is no default, and this option must be set for every transport.
20137
20138
20139 .option envelope_to_add transports boolean false
20140 .cindex "&'Envelope-to:'& header line"
20141 If this option is true, an &'Envelope-to:'& header is added to the message.
20142 This gives the original address(es) in the incoming envelope that caused this
20143 delivery to happen. More than one address may be present if the transport is
20144 configured to handle several addresses at once, or if more than one original
20145 address was redirected to the same final address. As this is not a standard
20146 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20147 its removal from incoming messages, so that delivered messages can safely be
20148 resent to other recipients.
20149
20150
20151 .option group transports string&!! "Exim group"
20152 .cindex "transport" "group; specifying"
20153 This option specifies a gid for running the transport process, overriding any
20154 value that the router supplies, and also overriding any value associated with
20155 &%user%& (see below).
20156
20157
20158 .option headers_add transports list&!! unset
20159 .cindex "header lines" "adding in transport"
20160 .cindex "transport" "header lines; adding"
20161 This option specifies a list of text headers, newline-separated,
20162 which are (separately) expanded and added to the header
20163 portion of a message as it is transported, as described in section
20164 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20165 routers. If the result of the expansion is an empty string, or if the expansion
20166 is forced to fail, no action is taken. Other expansion failures are treated as
20167 errors and cause the delivery to be deferred.
20168
20169 Unlike most options, &%headers_add%& can be specified multiple times
20170 for a transport; all listed headers are added.
20171
20172
20173 .option headers_only transports boolean false
20174 .cindex "transport" "header lines only"
20175 .cindex "message" "transporting headers only"
20176 .cindex "header lines" "transporting"
20177 If this option is set, the message's body is not transported. It is mutually
20178 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20179 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20180 checked, since this option does not automatically suppress them.
20181
20182
20183 .option headers_remove transports list&!! unset
20184 .cindex "header lines" "removing"
20185 .cindex "transport" "header lines; removing"
20186 This option specifies a list of header names, colon-separated;
20187 these headers are omitted from the message as it is transported, as described
20188 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20189 routers.
20190 Each list item is separately expanded.
20191 If the result of the expansion is an empty string, or if the expansion
20192 is forced to fail, no action is taken. Other expansion failures are treated as
20193 errors and cause the delivery to be deferred.
20194
20195 Unlike most options, &%headers_remove%& can be specified multiple times
20196 for a router; all listed headers are removed.
20197
20198
20199
20200 .option headers_rewrite transports string unset
20201 .cindex "transport" "header lines; rewriting"
20202 .cindex "rewriting" "at transport time"
20203 This option allows addresses in header lines to be rewritten at transport time,
20204 that is, as the message is being copied to its destination. The contents of the
20205 option are a colon-separated list of rewriting rules. Each rule is in exactly
20206 the same form as one of the general rewriting rules that are applied when a
20207 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20208 example,
20209 .code
20210 headers_rewrite = a@b c@d f : \
20211                   x@y w@z
20212 .endd
20213 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20214 &'w@z'& in all address-bearing header lines. The rules are applied to the
20215 header lines just before they are written out at transport time, so they affect
20216 only those copies of the message that pass through the transport. However, only
20217 the message's original header lines, and any that were added by a system
20218 filter, are rewritten. If a router or transport adds header lines, they are not
20219 affected by this option. These rewriting rules are &'not'& applied to the
20220 envelope. You can change the return path using &%return_path%&, but you cannot
20221 change envelope recipients at this time.
20222
20223
20224 .option home_directory transports string&!! unset
20225 .cindex "transport" "home directory for"
20226 .vindex "&$home$&"
20227 This option specifies a home directory setting for a local transport,
20228 overriding any value that may be set by the router. The home directory is
20229 placed in &$home$& while expanding the transport's private options. It is also
20230 used as the current directory if no current directory is set by the
20231 &%current_directory%& option on the transport or the
20232 &%transport_current_directory%& option on the router. If the expansion fails
20233 for any reason, including forced failure, an error is logged, and delivery is
20234 deferred.
20235
20236
20237 .option initgroups transports boolean false
20238 .cindex "additional groups"
20239 .cindex "groups" "additional"
20240 .cindex "transport" "group; additional"
20241 If this option is true and the uid for the delivery process is provided by the
20242 transport, the &[initgroups()]& function is called when running the transport
20243 to ensure that any additional groups associated with the uid are set up.
20244
20245
20246 .option message_size_limit transports string&!! 0
20247 .cindex "limit" "message size per transport"
20248 .cindex "size" "of message, limit"
20249 .cindex "transport" "message size; limiting"
20250 This option controls the size of messages passed through the transport. It is
20251 expanded before use; the result of the expansion must be a sequence of decimal
20252 digits, optionally followed by K or M. If the expansion fails for any reason,
20253 including forced failure, or if the result is not of the required form,
20254 delivery is deferred. If the value is greater than zero and the size of a
20255 message exceeds this limit, the address is failed. If there is any chance that
20256 the resulting bounce message could be routed to the same transport, you should
20257 ensure that &%return_size_limit%& is less than the transport's
20258 &%message_size_limit%&, as otherwise the bounce message will fail to get
20259 delivered.
20260
20261
20262
20263 .option rcpt_include_affixes transports boolean false
20264 .cindex "prefix" "for local part, including in envelope"
20265 .cindex "suffix for local part" "including in envelope"
20266 .cindex "local part" "prefix"
20267 .cindex "local part" "suffix"
20268 When this option is false (the default), and an address that has had any
20269 affixes (prefixes or suffixes) removed from the local part is delivered by any
20270 form of SMTP or LMTP, the affixes are not included. For example, if a router
20271 that contains
20272 .code
20273 local_part_prefix = *-
20274 .endd
20275 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20276 is delivered with
20277 .code
20278 RCPT TO:<xyz@some.domain>
20279 .endd
20280 This is also the case when an ACL-time callout is being used to verify a
20281 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20282 whole local part is included in the RCPT command. This option applies to BSMTP
20283 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20284 &(lmtp)& and &(smtp)& transports.
20285
20286
20287 .option retry_use_local_part transports boolean "see below"
20288 .cindex "hints database" "retry keys"
20289 When a delivery suffers a temporary failure, a retry record is created
20290 in Exim's hints database. For remote deliveries, the key for the retry record
20291 is based on the name and/or IP address of the failing remote host. For local
20292 deliveries, the key is normally the entire address, including both the local
20293 part and the domain. This is suitable for most common cases of local delivery
20294 temporary failure &-- for example, exceeding a mailbox quota should delay only
20295 deliveries to that mailbox, not to the whole domain.
20296
20297 However, in some special cases you may want to treat a temporary local delivery
20298 as a failure associated with the domain, and not with a particular local part.
20299 (For example, if you are storing all mail for some domain in files.) You can do
20300 this by setting &%retry_use_local_part%& false.
20301
20302 For all the local transports, its default value is true. For remote transports,
20303 the default value is false for tidiness, but changing the value has no effect
20304 on a remote transport in the current implementation.
20305
20306
20307 .option return_path transports string&!! unset
20308 .cindex "envelope sender"
20309 .cindex "transport" "return path; changing"
20310 .cindex "return path" "changing in transport"
20311 If this option is set, the string is expanded at transport time and replaces
20312 the existing return path (envelope sender) value in the copy of the message
20313 that is being delivered. An empty return path is permitted. This feature is
20314 designed for remote deliveries, where the value of this option is used in the
20315 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20316 only effect is to change the address that is placed in the &'Return-path:'&
20317 header line, if one is added to the message (see the next option).
20318
20319 &*Note:*& A changed return path is not logged unless you add
20320 &%return_path_on_delivery%& to the log selector.
20321
20322 .vindex "&$return_path$&"
20323 The expansion can refer to the existing value via &$return_path$&. This is
20324 either the message's envelope sender, or an address set by the
20325 &%errors_to%& option on a router. If the expansion is forced to fail, no
20326 replacement occurs; if it fails for another reason, delivery is deferred. This
20327 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20328 section &<<SECTverp>>&.
20329
20330 &*Note*&: If a delivery error is detected locally, including the case when a
20331 remote server rejects a message at SMTP time, the bounce message is not sent to
20332 the value of this option. It is sent to the previously set errors address.
20333 This defaults to the incoming sender address, but can be changed by setting
20334 &%errors_to%& in a router.
20335
20336
20337
20338 .option return_path_add transports boolean false
20339 .cindex "&'Return-path:'& header line"
20340 If this option is true, a &'Return-path:'& header is added to the message.
20341 Although the return path is normally available in the prefix line of BSD
20342 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20343 have easy access to it.
20344
20345 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20346 the delivery SMTP server makes the final delivery"&. This implies that this
20347 header should not be present in incoming messages. Exim has a configuration
20348 option, &%return_path_remove%&, which requests removal of this header from
20349 incoming messages, so that delivered messages can safely be resent to other
20350 recipients.
20351
20352
20353 .option shadow_condition transports string&!! unset
20354 See &%shadow_transport%& below.
20355
20356
20357 .option shadow_transport transports string unset
20358 .cindex "shadow transport"
20359 .cindex "transport" "shadow"
20360 A local transport may set the &%shadow_transport%& option to the name of
20361 another local transport. Shadow remote transports are not supported.
20362
20363 Whenever a delivery to the main transport succeeds, and either
20364 &%shadow_condition%& is unset, or its expansion does not result in the empty
20365 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20366 passed to the shadow transport, with the same delivery address or addresses. If
20367 expansion fails, no action is taken except that non-forced expansion failures
20368 cause a log line to be written.
20369
20370 The result of the shadow transport is discarded and does not affect the
20371 subsequent processing of the message. Only a single level of shadowing is
20372 provided; the &%shadow_transport%& option is ignored on any transport when it
20373 is running as a shadow. Options concerned with output from pipes are also
20374 ignored. The log line for the successful delivery has an item added on the end,
20375 of the form
20376 .code
20377 ST=<shadow transport name>
20378 .endd
20379 If the shadow transport did not succeed, the error message is put in
20380 parentheses afterwards. Shadow transports can be used for a number of different
20381 purposes, including keeping more detailed log information than Exim normally
20382 provides, and implementing automatic acknowledgment policies based on message
20383 headers that some sites insist on.
20384
20385
20386 .option transport_filter transports string&!! unset
20387 .cindex "transport" "filter"
20388 .cindex "filter" "transport filter"
20389 This option sets up a filtering (in the Unix shell sense) process for messages
20390 at transport time. It should not be confused with mail filtering as set up by
20391 individual users or via a system filter.
20392
20393 When the message is about to be written out, the command specified by
20394 &%transport_filter%& is started up in a separate, parallel process, and
20395 the entire message, including the header lines, is passed to it on its standard
20396 input (this in fact is done from a third process, to avoid deadlock). The
20397 command must be specified as an absolute path.
20398
20399 The lines of the message that are written to the transport filter are
20400 terminated by newline (&"\n"&). The message is passed to the filter before any
20401 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20402 lines beginning with a dot, and also before any processing implied by the
20403 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20404 &(pipe)& transports.
20405
20406 The standard error for the filter process is set to the same destination as its
20407 standard output; this is read and written to the message's ultimate
20408 destination. The process that writes the message to the filter, the
20409 filter itself, and the original process that reads the result and delivers it
20410 are all run in parallel, like a shell pipeline.
20411
20412 The filter can perform any transformations it likes, but of course should take
20413 care not to break RFC 2822 syntax. Exim does not check the result, except to
20414 test for a final newline when SMTP is in use. All messages transmitted over
20415 SMTP must end with a newline, so Exim supplies one if it is missing.
20416
20417 .cindex "content scanning" "per user"
20418 A transport filter can be used to provide content-scanning on a per-user basis
20419 at delivery time if the only required effect of the scan is to modify the
20420 message. For example, a content scan could insert a new header line containing
20421 a spam score. This could be interpreted by a filter in the user's MUA. It is
20422 not possible to discard a message at this stage.
20423
20424 .cindex "SMTP" "SIZE"
20425 A problem might arise if the filter increases the size of a message that is
20426 being sent down an SMTP connection. If the receiving SMTP server has indicated
20427 support for the SIZE parameter, Exim will have sent the size of the message
20428 at the start of the SMTP session. If what is actually sent is substantially
20429 more, the server might reject the message. This can be worked round by setting
20430 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20431 additions to the message, or to disable the use of SIZE altogether.
20432
20433 .vindex "&$pipe_addresses$&"
20434 The value of the &%transport_filter%& option is the command string for starting
20435 the filter, which is run directly from Exim, not under a shell. The string is
20436 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20437 Exim breaks it up into arguments and then expands each argument separately (see
20438 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20439 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20440 of arguments, one for each address that applies to this delivery. (This isn't
20441 an ideal name for this feature here, but as it was already implemented for the
20442 &(pipe)& transport, it seemed sensible not to change it.)
20443
20444 .vindex "&$host$&"
20445 .vindex "&$host_address$&"
20446 The expansion variables &$host$& and &$host_address$& are available when the
20447 transport is a remote one. They contain the name and IP address of the host to
20448 which the message is being sent. For example:
20449 .code
20450 transport_filter = /some/directory/transport-filter.pl \
20451   $host $host_address $sender_address $pipe_addresses
20452 .endd
20453
20454 Two problems arise if you want to use more complicated expansion items to
20455 generate transport filter commands, both of which due to the fact that the
20456 command is split up &'before'& expansion.
20457 .ilist
20458 If an expansion item contains white space, you must quote it, so that it is all
20459 part of the same command item. If the entire option setting is one such
20460 expansion item, you have to take care what kind of quoting you use. For
20461 example:
20462 .code
20463 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20464 .endd
20465 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20466 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20467 stripped by Exim when it read the option's value. When the value is used, if
20468 the single quotes were missing, the line would be split into two items,
20469 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20470 Exim tried to expand the first one.
20471 .next
20472 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20473 expansion cannot generate multiple arguments, or a command name followed by
20474 arguments. Consider this example:
20475 .code
20476 transport_filter = ${lookup{$host}lsearch{/a/file}\
20477                     {$value}{/bin/cat}}
20478 .endd
20479 The result of the lookup is interpreted as the name of the command, even
20480 if it contains white space. The simplest way round this is to use a shell:
20481 .code
20482 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20483                                {$value}{/bin/cat}}
20484 .endd
20485 .endlist
20486
20487 The filter process is run under the same uid and gid as the normal delivery.
20488 For remote deliveries this is the Exim uid/gid by default. The command should
20489 normally yield a zero return code. Transport filters are not supposed to fail.
20490 A non-zero code is taken to mean that the transport filter encountered some
20491 serious problem. Delivery of the message is deferred; the message remains on
20492 the queue and is tried again later. It is not possible to cause a message to be
20493 bounced from a transport filter.
20494
20495 If a transport filter is set on an autoreply transport, the original message is
20496 passed through the filter as it is being copied into the newly generated
20497 message, which happens if the &%return_message%& option is set.
20498
20499
20500 .option transport_filter_timeout transports time 5m
20501 .cindex "transport" "filter, timeout"
20502 When Exim is reading the output of a transport filter, it applies a timeout
20503 that can be set by this option. Exceeding the timeout is normally treated as a
20504 temporary delivery failure. However, if a transport filter is used with a
20505 &(pipe)& transport, a timeout in the transport filter is treated in the same
20506 way as a timeout in the pipe command itself. By default, a timeout is a hard
20507 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20508 becomes a temporary error.
20509
20510
20511 .option user transports string&!! "Exim user"
20512 .cindex "uid (user id)" "local delivery"
20513 .cindex "transport" "user, specifying"
20514 This option specifies the user under whose uid the delivery process is to be
20515 run, overriding any uid that may have been set by the router. If the user is
20516 given as a name, the uid is looked up from the password data, and the
20517 associated group is taken as the value of the gid to be used if the &%group%&
20518 option is not set.
20519
20520 For deliveries that use local transports, a user and group are normally
20521 specified explicitly or implicitly (for example, as a result of
20522 &%check_local_user%&) by the router or transport.
20523
20524 .cindex "hints database" "access by remote transport"
20525 For remote transports, you should leave this option unset unless you really are
20526 sure you know what you are doing. When a remote transport is running, it needs
20527 to be able to access Exim's hints databases, because each host may have its own
20528 retry data.
20529 .ecindex IIDgenoptra1
20530 .ecindex IIDgenoptra2
20531 .ecindex IIDgenoptra3
20532
20533
20534
20535
20536
20537
20538 . ////////////////////////////////////////////////////////////////////////////
20539 . ////////////////////////////////////////////////////////////////////////////
20540
20541 .chapter "Address batching in local transports" "CHAPbatching" &&&
20542          "Address batching"
20543 .cindex "transport" "local; address batching in"
20544 The only remote transport (&(smtp)&) is normally configured to handle more than
20545 one address at a time, so that when several addresses are routed to the same
20546 remote host, just one copy of the message is sent. Local transports, however,
20547 normally handle one address at a time. That is, a separate instance of the
20548 transport is run for each address that is routed to the transport. A separate
20549 copy of the message is delivered each time.
20550
20551 .cindex "batched local delivery"
20552 .oindex "&%batch_max%&"
20553 .oindex "&%batch_id%&"
20554 In special cases, it may be desirable to handle several addresses at once in a
20555 local transport, for example:
20556
20557 .ilist
20558 In an &(appendfile)& transport, when storing messages in files for later
20559 delivery by some other means, a single copy of the message with multiple
20560 recipients saves space.
20561 .next
20562 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20563 a single copy saves time, and is the normal way LMTP is expected to work.
20564 .next
20565 In a &(pipe)& transport, when passing the message
20566 to a scanner program or
20567 to some other delivery mechanism such as UUCP, multiple recipients may be
20568 acceptable.
20569 .endlist
20570
20571 These three local transports all have the same options for controlling multiple
20572 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20573 repeating the information for each transport, these options are described here.
20574
20575 The &%batch_max%& option specifies the maximum number of addresses that can be
20576 delivered together in a single run of the transport. Its default value is one
20577 (no batching). When more than one address is routed to a transport that has a
20578 &%batch_max%& value greater than one, the addresses are delivered in a batch
20579 (that is, in a single run of the transport with multiple recipients), subject
20580 to certain conditions:
20581
20582 .ilist
20583 .vindex "&$local_part$&"
20584 If any of the transport's options contain a reference to &$local_part$&, no
20585 batching is possible.
20586 .next
20587 .vindex "&$domain$&"
20588 If any of the transport's options contain a reference to &$domain$&, only
20589 addresses with the same domain are batched.
20590 .next
20591 .cindex "customizing" "batching condition"
20592 If &%batch_id%& is set, it is expanded for each address, and only those
20593 addresses with the same expanded value are batched. This allows you to specify
20594 customized batching conditions. Failure of the expansion for any reason,
20595 including forced failure, disables batching, but it does not stop the delivery
20596 from taking place.
20597 .next
20598 Batched addresses must also have the same errors address (where to send
20599 delivery errors), the same header additions and removals, the same user and
20600 group for the transport, and if a host list is present, the first host must
20601 be the same.
20602 .endlist
20603
20604 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20605 both when the file or pipe command is specified in the transport, and when it
20606 is specified by a &(redirect)& router, but all the batched addresses must of
20607 course be routed to the same file or pipe command. These two transports have an
20608 option called &%use_bsmtp%&, which causes them to deliver the message in
20609 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20610 &%check_string%& and &%escape_string%& options are forced to the values
20611 .code
20612 check_string = "."
20613 escape_string = ".."
20614 .endd
20615 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20616 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20617 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20618
20619 .cindex "&'Envelope-to:'& header line"
20620 If the generic &%envelope_to_add%& option is set for a batching transport, the
20621 &'Envelope-to:'& header that is added to the message contains all the addresses
20622 that are being processed together. If you are using a batching &(appendfile)&
20623 transport without &%use_bsmtp%&, the only way to preserve the recipient
20624 addresses is to set the &%envelope_to_add%& option.
20625
20626 .cindex "&(pipe)& transport" "with multiple addresses"
20627 .vindex "&$pipe_addresses$&"
20628 If you are using a &(pipe)& transport without BSMTP, and setting the
20629 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20630 the command. This is not a true variable; it is a bit of magic that causes each
20631 of the recipient addresses to be inserted into the command as a separate
20632 argument. This provides a way of accessing all the addresses that are being
20633 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20634 are specified by a &(redirect)& router.
20635
20636
20637
20638
20639 . ////////////////////////////////////////////////////////////////////////////
20640 . ////////////////////////////////////////////////////////////////////////////
20641
20642 .chapter "The appendfile transport" "CHAPappendfile"
20643 .scindex IIDapptra1 "&(appendfile)& transport"
20644 .scindex IIDapptra2 "transports" "&(appendfile)&"
20645 .cindex "directory creation"
20646 .cindex "creating directories"
20647 The &(appendfile)& transport delivers a message by appending it to an existing
20648 file, or by creating an entirely new file in a specified directory. Single
20649 files to which messages are appended can be in the traditional Unix mailbox
20650 format, or optionally in the MBX format supported by the Pine MUA and
20651 University of Washington IMAP daemon, &'inter alia'&. When each message is
20652 being delivered as a separate file, &"maildir"& format can optionally be used
20653 to give added protection against failures that happen part-way through the
20654 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20655 supported. For all file formats, Exim attempts to create as many levels of
20656 directory as necessary, provided that &%create_directory%& is set.
20657
20658 The code for the optional formats is not included in the Exim binary by
20659 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20660 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20661 included.
20662
20663 .cindex "quota" "system"
20664 Exim recognizes system quota errors, and generates an appropriate message. Exim
20665 also supports its own quota control within the transport, for use when the
20666 system facility is unavailable or cannot be used for some reason.
20667
20668 If there is an error while appending to a file (for example, quota exceeded or
20669 partition filled), Exim attempts to reset the file's length and last
20670 modification time back to what they were before. If there is an error while
20671 creating an entirely new file, the new file is removed.
20672
20673 Before appending to a file, a number of security checks are made, and the
20674 file is locked. A detailed description is given below, after the list of
20675 private options.
20676
20677 The &(appendfile)& transport is most commonly used for local deliveries to
20678 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20679 putting messages into files for remote delivery by some means other than Exim.
20680 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20681 option).
20682
20683
20684
20685 .section "The file and directory options" "SECTfildiropt"
20686 The &%file%& option specifies a single file, to which the message is appended;
20687 the &%directory%& option specifies a directory, in which a new file containing
20688 the message is created. Only one of these two options can be set, and for
20689 normal deliveries to mailboxes, one of them &'must'& be set.
20690
20691 .vindex "&$address_file$&"
20692 .vindex "&$local_part$&"
20693 However, &(appendfile)& is also used for delivering messages to files or
20694 directories whose names (or parts of names) are obtained from alias,
20695 forwarding, or filtering operations (for example, a &%save%& command in a
20696 user's Exim filter). When such a transport is running, &$local_part$& contains
20697 the local part that was aliased or forwarded, and &$address_file$& contains the
20698 name (or partial name) of the file or directory generated by the redirection
20699 operation. There are two cases:
20700
20701 .ilist
20702 If neither &%file%& nor &%directory%& is set, the redirection operation
20703 must specify an absolute path (one that begins with &`/`&). This is the most
20704 common case when users with local accounts use filtering to sort mail into
20705 different folders. See for example, the &(address_file)& transport in the
20706 default configuration. If the path ends with a slash, it is assumed to be the
20707 name of a directory. A delivery to a directory can also be forced by setting
20708 &%maildir_format%& or &%mailstore_format%&.
20709 .next
20710 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20711 used to determine the file or directory name for the delivery. Normally, the
20712 contents of &$address_file$& are used in some way in the string expansion.
20713 .endlist
20714
20715
20716 .cindex "Sieve filter" "configuring &(appendfile)&"
20717 .cindex "Sieve filter" "relative mailbox path handling"
20718 As an example of the second case, consider an environment where users do not
20719 have home directories. They may be permitted to use Exim filter commands of the
20720 form:
20721 .code
20722 save folder23
20723 .endd
20724 or Sieve filter commands of the form:
20725 .code
20726 require "fileinto";
20727 fileinto "folder23";
20728 .endd
20729 In this situation, the expansion of &%file%& or &%directory%& in the transport
20730 must transform the relative path into an appropriate absolute file name. In the
20731 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20732 is used as a result of a &"keep"& action in the filter. This example shows one
20733 way of handling this requirement:
20734 .code
20735 file = ${if eq{$address_file}{inbox} \
20736             {/var/mail/$local_part} \
20737             {${if eq{${substr_0_1:$address_file}}{/} \
20738                   {$address_file} \
20739                   {$home/mail/$address_file} \
20740             }} \
20741        }
20742 .endd
20743 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20744 location, absolute paths are used without change, and other folders are in the
20745 &_mail_& directory within the home directory.
20746
20747 &*Note 1*&: While processing an Exim filter, a relative path such as
20748 &_folder23_& is turned into an absolute path if a home directory is known to
20749 the router. In particular, this is the case if &%check_local_user%& is set. If
20750 you want to prevent this happening at routing time, you can set
20751 &%router_home_directory%& empty. This forces the router to pass the relative
20752 path to the transport.
20753
20754 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20755 the &%file%& or &%directory%& option is still used if it is set.
20756
20757
20758
20759
20760 .section "Private options for appendfile" "SECID134"
20761 .cindex "options" "&(appendfile)& transport"
20762
20763
20764
20765 .option allow_fifo appendfile boolean false
20766 .cindex "fifo (named pipe)"
20767 .cindex "named pipe (fifo)"
20768 .cindex "pipe" "named (fifo)"
20769 Setting this option permits delivery to named pipes (FIFOs) as well as to
20770 regular files. If no process is reading the named pipe at delivery time, the
20771 delivery is deferred.
20772
20773
20774 .option allow_symlink appendfile boolean false
20775 .cindex "symbolic link" "to mailbox"
20776 .cindex "mailbox" "symbolic link"
20777 By default, &(appendfile)& will not deliver if the path name for the file is
20778 that of a symbolic link. Setting this option relaxes that constraint, but there
20779 are security issues involved in the use of symbolic links. Be sure you know
20780 what you are doing if you set this. Details of exactly what this option affects
20781 are included in the discussion which follows this list of options.
20782
20783
20784 .option batch_id appendfile string&!! unset
20785 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20786 However, batching is automatically disabled for &(appendfile)& deliveries that
20787 happen as a result of forwarding or aliasing or other redirection directly to a
20788 file.
20789
20790
20791 .option batch_max appendfile integer 1
20792 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20793
20794
20795 .option check_group appendfile boolean false
20796 When this option is set, the group owner of the file defined by the &%file%&
20797 option is checked to see that it is the same as the group under which the
20798 delivery process is running. The default setting is false because the default
20799 file mode is 0600, which means that the group is irrelevant.
20800
20801
20802 .option check_owner appendfile boolean true
20803 When this option is set, the owner of the file defined by the &%file%& option
20804 is checked to ensure that it is the same as the user under which the delivery
20805 process is running.
20806
20807
20808 .option check_string appendfile string "see below"
20809 .cindex "&""From""& line"
20810 As &(appendfile)& writes the message, the start of each line is tested for
20811 matching &%check_string%&, and if it does, the initial matching characters are
20812 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20813 a literal string, not a regular expression, and the case of any letters it
20814 contains is significant.
20815
20816 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20817 are forced to &"."& and &".."& respectively, and any settings in the
20818 configuration are ignored. Otherwise, they default to &"From&~"& and
20819 &">From&~"& when the &%file%& option is set, and unset when any of the
20820 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20821
20822 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20823 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20824 &"From&~"& indicates the start of a new message. All four options need changing
20825 if another format is used. For example, to deliver to mailboxes in MMDF format:
20826 .cindex "MMDF format mailbox"
20827 .cindex "mailbox" "MMDF format"
20828 .code
20829 check_string = "\1\1\1\1\n"
20830 escape_string = "\1\1\1\1 \n"
20831 message_prefix = "\1\1\1\1\n"
20832 message_suffix = "\1\1\1\1\n"
20833 .endd
20834 .option create_directory appendfile boolean true
20835 .cindex "directory creation"
20836 When this option is true, Exim attempts to create any missing superior
20837 directories for the file that it is about to write. A created directory's mode
20838 is given by the &%directory_mode%& option.
20839
20840 The group ownership of a newly created directory is highly dependent on the
20841 operating system (and possibly the file system) that is being used. For
20842 example, in Solaris, if the parent directory has the setgid bit set, its group
20843 is propagated to the child; if not, the currently set group is used. However,
20844 in FreeBSD, the parent's group is always used.
20845
20846
20847
20848 .option create_file appendfile string anywhere
20849 This option constrains the location of files and directories that are created
20850 by this transport. It applies to files defined by the &%file%& option and
20851 directories defined by the &%directory%& option. In the case of maildir
20852 delivery, it applies to the top level directory, not the maildir directories
20853 beneath.
20854
20855 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20856 &"belowhome"&. In the second and third cases, a home directory must have been
20857 set for the transport. This option is not useful when an explicit file name is
20858 given for normal mailbox deliveries. It is intended for the case when file
20859 names are generated from users' &_.forward_& files. These are usually handled
20860 by an &(appendfile)& transport called &%address_file%&. See also
20861 &%file_must_exist%&.
20862
20863
20864 .option directory appendfile string&!! unset
20865 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20866 or &%directory%& must be set, unless the delivery is the direct result of a
20867 redirection (see section &<<SECTfildiropt>>&).
20868
20869 When &%directory%& is set, the string is expanded, and the message is delivered
20870 into a new file or files in or below the given directory, instead of being
20871 appended to a single mailbox file. A number of different formats are provided
20872 (see &%maildir_format%& and &%mailstore_format%&), and see section
20873 &<<SECTopdir>>& for further details of this form of delivery.
20874
20875
20876 .option directory_file appendfile string&!! "see below"
20877 .cindex "base62"
20878 .vindex "&$inode$&"
20879 When &%directory%& is set, but neither &%maildir_format%& nor
20880 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20881 whose name is obtained by expanding this string. The default value is:
20882 .code
20883 q${base62:$tod_epoch}-$inode
20884 .endd
20885 This generates a unique name from the current time, in base 62 form, and the
20886 inode of the file. The variable &$inode$& is available only when expanding this
20887 option.
20888
20889
20890 .option directory_mode appendfile "octal integer" 0700
20891 If &(appendfile)& creates any directories as a result of the
20892 &%create_directory%& option, their mode is specified by this option.
20893
20894
20895 .option escape_string appendfile string "see description"
20896 See &%check_string%& above.
20897
20898
20899 .option file appendfile string&!! unset
20900 This option is mutually exclusive with the &%directory%& option, but one of
20901 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20902 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20903 specifies a single file, to which the message is appended. One or more of
20904 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20905 &%file%&.
20906
20907 .cindex "NFS" "lock file"
20908 .cindex "locking files"
20909 .cindex "lock files"
20910 If you are using more than one host to deliver over NFS into the same
20911 mailboxes, you should always use lock files.
20912
20913 The string value is expanded for each delivery, and must yield an absolute
20914 path. The most common settings of this option are variations on one of these
20915 examples:
20916 .code
20917 file = /var/spool/mail/$local_part
20918 file = /home/$local_part/inbox
20919 file = $home/inbox
20920 .endd
20921 .cindex "&""sticky""& bit"
20922 In the first example, all deliveries are done into the same directory. If Exim
20923 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20924 create a file in the directory, so the &"sticky"& bit must be turned on for
20925 deliveries to be possible, or alternatively the &%group%& option can be used to
20926 run the delivery under a group id which has write access to the directory.
20927
20928
20929
20930 .option file_format appendfile string unset
20931 .cindex "file" "mailbox; checking existing format"
20932 This option requests the transport to check the format of an existing file
20933 before adding to it. The check consists of matching a specific string at the
20934 start of the file. The value of the option consists of an even number of
20935 colon-separated strings. The first of each pair is the test string, and the
20936 second is the name of a transport. If the transport associated with a matched
20937 string is not the current transport, control is passed over to the other
20938 transport. For example, suppose the standard &(local_delivery)& transport has
20939 this added to it:
20940 .code
20941 file_format = "From       : local_delivery :\
20942                \1\1\1\1\n : local_mmdf_delivery"
20943 .endd
20944 Mailboxes that begin with &"From"& are still handled by this transport, but if
20945 a mailbox begins with four binary ones followed by a newline, control is passed
20946 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20947 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20948 is assumed to match the current transport. If the start of a mailbox doesn't
20949 match any string, or if the transport named for a given string is not defined,
20950 delivery is deferred.
20951
20952
20953 .option file_must_exist appendfile boolean false
20954 If this option is true, the file specified by the &%file%& option must exist.
20955 A temporary error occurs if it does not, causing delivery to be deferred.
20956 If this option is false, the file is created if it does not exist.
20957
20958
20959 .option lock_fcntl_timeout appendfile time 0s
20960 .cindex "timeout" "mailbox locking"
20961 .cindex "mailbox" "locking, blocking and non-blocking"
20962 .cindex "locking files"
20963 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20964 when locking an open mailbox file. If the call fails, the delivery process
20965 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20966 Non-blocking calls are used so that the file is not kept open during the wait
20967 for the lock; the reason for this is to make it as safe as possible for
20968 deliveries over NFS in the case when processes might be accessing an NFS
20969 mailbox without using a lock file. This should not be done, but
20970 misunderstandings and hence misconfigurations are not unknown.
20971
20972 On a busy system, however, the performance of a non-blocking lock approach is
20973 not as good as using a blocking lock with a timeout. In this case, the waiting
20974 is done inside the system call, and Exim's delivery process acquires the lock
20975 and can proceed as soon as the previous lock holder releases it.
20976
20977 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20978 timeout, are used. There may still be some retrying: the maximum number of
20979 retries is
20980 .code
20981 (lock_retries * lock_interval) / lock_fcntl_timeout
20982 .endd
20983 rounded up to the next whole number. In other words, the total time during
20984 which &(appendfile)& is trying to get a lock is roughly the same, unless
20985 &%lock_fcntl_timeout%& is set very large.
20986
20987 You should consider setting this option if you are getting a lot of delayed
20988 local deliveries because of errors of the form
20989 .code
20990 failed to lock mailbox /some/file (fcntl)
20991 .endd
20992
20993 .option lock_flock_timeout appendfile time 0s
20994 This timeout applies to file locking when using &[flock()]& (see
20995 &%use_flock%&); the timeout operates in a similar manner to
20996 &%lock_fcntl_timeout%&.
20997
20998
20999 .option lock_interval appendfile time 3s
21000 This specifies the time to wait between attempts to lock the file. See below
21001 for details of locking.
21002
21003
21004 .option lock_retries appendfile integer 10
21005 This specifies the maximum number of attempts to lock the file. A value of zero
21006 is treated as 1. See below for details of locking.
21007
21008
21009 .option lockfile_mode appendfile "octal integer" 0600
21010 This specifies the mode of the created lock file, when a lock file is being
21011 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21012
21013
21014 .option lockfile_timeout appendfile time 30m
21015 .cindex "timeout" "mailbox locking"
21016 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21017 exists and is older than this value, it is assumed to have been left behind by
21018 accident, and Exim attempts to remove it.
21019
21020
21021 .option mailbox_filecount appendfile string&!! unset
21022 .cindex "mailbox" "specifying size of"
21023 .cindex "size" "of mailbox"
21024 If this option is set, it is expanded, and the result is taken as the current
21025 number of files in the mailbox. It must be a decimal number, optionally
21026 followed by K or M. This provides a way of obtaining this information from an
21027 external source that maintains the data.
21028
21029
21030 .option mailbox_size appendfile string&!! unset
21031 .cindex "mailbox" "specifying size of"
21032 .cindex "size" "of mailbox"
21033 If this option is set, it is expanded, and the result is taken as the current
21034 size the mailbox. It must be a decimal number, optionally followed by K or M.
21035 This provides a way of obtaining this information from an external source that
21036 maintains the data. This is likely to be helpful for maildir deliveries where
21037 it is computationally expensive to compute the size of a mailbox.
21038
21039
21040
21041 .option maildir_format appendfile boolean false
21042 .cindex "maildir format" "specifying"
21043 If this option is set with the &%directory%& option, the delivery is into a new
21044 file, in the &"maildir"& format that is used by other mail software. When the
21045 transport is activated directly from a &(redirect)& router (for example, the
21046 &(address_file)& transport in the default configuration), setting
21047 &%maildir_format%& causes the path received from the router to be treated as a
21048 directory, whether or not it ends with &`/`&. This option is available only if
21049 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21050 &<<SECTmaildirdelivery>>& below for further details.
21051
21052
21053 .option maildir_quota_directory_regex appendfile string "See below"
21054 .cindex "maildir format" "quota; directories included in"
21055 .cindex "quota" "maildir; directories included in"
21056 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21057 a regular expression for specifying directories, relative to the quota
21058 directory (see &%quota_directory%&), that should be included in the quota
21059 calculation. The default value is:
21060 .code
21061 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21062 .endd
21063 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21064 (directories whose names begin with a dot). If you want to exclude the
21065 &_Trash_&
21066 folder from the count (as some sites do), you need to change this setting to
21067 .code
21068 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21069 .endd
21070 This uses a negative lookahead in the regular expression to exclude the
21071 directory whose name is &_.Trash_&. When a directory is excluded from quota
21072 calculations, quota processing is bypassed for any messages that are delivered
21073 directly into that directory.
21074
21075
21076 .option maildir_retries appendfile integer 10
21077 This option specifies the number of times to retry when writing a file in
21078 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21079
21080
21081 .option maildir_tag appendfile string&!! unset
21082 This option applies only to deliveries in maildir format, and is described in
21083 section &<<SECTmaildirdelivery>>& below.
21084
21085
21086 .option maildir_use_size_file appendfile&!! boolean false
21087 .cindex "maildir format" "&_maildirsize_& file"
21088 The result of string expansion for this option must be a valid boolean value.
21089 If it is true, it enables support for &_maildirsize_& files. Exim
21090 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21091 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21092 value is zero. See &%maildir_quota_directory_regex%& above and section
21093 &<<SECTmaildirdelivery>>& below for further details.
21094
21095 .option maildirfolder_create_regex appendfile string unset
21096 .cindex "maildir format" "&_maildirfolder_& file"
21097 .cindex "&_maildirfolder_&, creating"
21098 The value of this option is a regular expression. If it is unset, it has no
21099 effect. Otherwise, before a maildir delivery takes place, the pattern is
21100 matched against the name of the maildir directory, that is, the directory
21101 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21102 delivery. If there is a match, Exim checks for the existence of a file called
21103 &_maildirfolder_& in the directory, and creates it if it does not exist.
21104 See section &<<SECTmaildirdelivery>>& for more details.
21105
21106
21107 .option mailstore_format appendfile boolean false
21108 .cindex "mailstore format" "specifying"
21109 If this option is set with the &%directory%& option, the delivery is into two
21110 new files in  &"mailstore"& format. The option is available only if
21111 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21112 below for further details.
21113
21114
21115 .option mailstore_prefix appendfile string&!! unset
21116 This option applies only to deliveries in mailstore format, and is described in
21117 section &<<SECTopdir>>& below.
21118
21119
21120 .option mailstore_suffix appendfile string&!! unset
21121 This option applies only to deliveries in mailstore format, and is described in
21122 section &<<SECTopdir>>& below.
21123
21124
21125 .option mbx_format appendfile boolean false
21126 .cindex "locking files"
21127 .cindex "file" "locking"
21128 .cindex "file" "MBX format"
21129 .cindex "MBX format, specifying"
21130 This option is available only if Exim has been compiled with SUPPORT_MBX
21131 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21132 the message is appended to the mailbox file in MBX format instead of
21133 traditional Unix format. This format is supported by Pine4 and its associated
21134 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21135
21136 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21137 automatically changed by the use of &%mbx_format%&. They should normally be set
21138 empty when using MBX format, so this option almost always appears in this
21139 combination:
21140 .code
21141 mbx_format = true
21142 message_prefix =
21143 message_suffix =
21144 .endd
21145 If none of the locking options are mentioned in the configuration,
21146 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21147 is possible to specify the other kinds of locking with &%mbx_format%&, but
21148 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21149 interworks with &'c-client'&, providing for shared access to the mailbox. It
21150 should not be used if any program that does not use this form of locking is
21151 going to access the mailbox, nor should it be used if the mailbox file is NFS
21152 mounted, because it works only when the mailbox is accessed from a single host.
21153
21154 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21155 the standard version of &'c-client'&, because as long as it has a mailbox open
21156 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21157 append messages to it.
21158
21159
21160 .option message_prefix appendfile string&!! "see below"
21161 .cindex "&""From""& line"
21162 The string specified here is expanded and output at the start of every message.
21163 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21164 in which case it is:
21165 .code
21166 message_prefix = "From ${if def:return_path{$return_path}\
21167   {MAILER-DAEMON}} $tod_bsdinbox\n"
21168 .endd
21169 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21170 &`\n`& to &`\r\n`& in &%message_prefix%&.
21171
21172 .option message_suffix appendfile string&!! "see below"
21173 The string specified here is expanded and output at the end of every message.
21174 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21175 in which case it is a single newline character. The suffix can be suppressed by
21176 setting
21177 .code
21178 message_suffix =
21179 .endd
21180 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21181 &`\n`& to &`\r\n`& in &%message_suffix%&.
21182
21183 .option mode appendfile "octal integer" 0600
21184 If the output file is created, it is given this mode. If it already exists and
21185 has wider permissions, they are reduced to this mode. If it has narrower
21186 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21187 if the delivery is the result of a &%save%& command in a filter file specifying
21188 a particular mode, the mode of the output file is always forced to take that
21189 value, and this option is ignored.
21190
21191
21192 .option mode_fail_narrower appendfile boolean true
21193 This option applies in the case when an existing mailbox file has a narrower
21194 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21195 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21196 continues with the delivery attempt, using the existing mode of the file.
21197
21198
21199 .option notify_comsat appendfile boolean false
21200 If this option is true, the &'comsat'& daemon is notified after every
21201 successful delivery to a user mailbox. This is the daemon that notifies logged
21202 on users about incoming mail.
21203
21204
21205 .option quota appendfile string&!! unset
21206 .cindex "quota" "imposed by Exim"
21207 This option imposes a limit on the size of the file to which Exim is appending,
21208 or to the total space used in the directory tree when the &%directory%& option
21209 is set. In the latter case, computation of the space used is expensive, because
21210 all the files in the directory (and any sub-directories) have to be
21211 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21212 &%maildir_use_size_file%& for ways to avoid this in environments where users
21213 have no shell access to their mailboxes).
21214
21215 As there is no interlock against two simultaneous deliveries into a
21216 multi-file mailbox, it is possible for the quota to be overrun in this case.
21217 For single-file mailboxes, of course, an interlock is a necessity.
21218
21219 A file's size is taken as its &'used'& value. Because of blocking effects, this
21220 may be a lot less than the actual amount of disk space allocated to the file.
21221 If the sizes of a number of files are being added up, the rounding effect can
21222 become quite noticeable, especially on systems that have large block sizes.
21223 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21224 the obvious value which users understand most easily.
21225
21226 The value of the option is expanded, and must then be a numerical value
21227 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21228 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21229 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21230 be handled.
21231
21232 &*Note*&: A value of zero is interpreted as &"no quota"&.
21233
21234 The expansion happens while Exim is running as root, before it changes uid for
21235 the delivery. This means that files that are inaccessible to the end user can
21236 be used to hold quota values that are looked up in the expansion. When delivery
21237 fails because this quota is exceeded, the handling of the error is as for
21238 system quota failures.
21239
21240 By default, Exim's quota checking mimics system quotas, and restricts the
21241 mailbox to the specified maximum size, though the value is not accurate to the
21242 last byte, owing to separator lines and additional headers that may get added
21243 during message delivery. When a mailbox is nearly full, large messages may get
21244 refused even though small ones are accepted, because the size of the current
21245 message is added to the quota when the check is made. This behaviour can be
21246 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21247 for exceeding the quota does not include the current message. Thus, deliveries
21248 continue until the quota has been exceeded; thereafter, no further messages are
21249 delivered. See also &%quota_warn_threshold%&.
21250
21251
21252 .option quota_directory appendfile string&!! unset
21253 This option defines the directory to check for quota purposes when delivering
21254 into individual files. The default is the delivery directory, or, if a file
21255 called &_maildirfolder_& exists in a maildir directory, the parent of the
21256 delivery directory.
21257
21258
21259 .option quota_filecount appendfile string&!! 0
21260 This option applies when the &%directory%& option is set. It limits the total
21261 number of files in the directory (compare the inode limit in system quotas). It
21262 can only be used if &%quota%& is also set. The value is expanded; an expansion
21263 failure causes delivery to be deferred. A value of zero is interpreted as
21264 &"no quota"&.
21265
21266
21267 .option quota_is_inclusive appendfile boolean true
21268 See &%quota%& above.
21269
21270
21271 .option quota_size_regex appendfile string unset
21272 This option applies when one of the delivery modes that writes a separate file
21273 for each message is being used. When Exim wants to find the size of one of
21274 these files in order to test the quota, it first checks &%quota_size_regex%&.
21275 If this is set to a regular expression that matches the file name, and it
21276 captures one string, that string is interpreted as a representation of the
21277 file's size. The value of &%quota_size_regex%& is not expanded.
21278
21279 This feature is useful only when users have no shell access to their mailboxes
21280 &-- otherwise they could defeat the quota simply by renaming the files. This
21281 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21282 the file length to the file name. For example:
21283 .code
21284 maildir_tag = ,S=$message_size
21285 quota_size_regex = ,S=(\d+)
21286 .endd
21287 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21288 number of lines in the message.
21289
21290 The regular expression should not assume that the length is at the end of the
21291 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21292 sometimes add other information onto the ends of message file names.
21293
21294 Section &<<SECID136>>& contains further information.
21295
21296
21297 .option quota_warn_message appendfile string&!! "see below"
21298 See below for the use of this option. If it is not set when
21299 &%quota_warn_threshold%& is set, it defaults to
21300 .code
21301 quota_warn_message = "\
21302   To: $local_part@$domain\n\
21303   Subject: Your mailbox\n\n\
21304   This message is automatically created \
21305   by mail delivery software.\n\n\
21306   The size of your mailbox has exceeded \
21307   a warning threshold that is\n\
21308   set by the system administrator.\n"
21309 .endd
21310
21311
21312 .option quota_warn_threshold appendfile string&!! 0
21313 .cindex "quota" "warning threshold"
21314 .cindex "mailbox" "size warning"
21315 .cindex "size" "of mailbox"
21316 This option is expanded in the same way as &%quota%& (see above). If the
21317 resulting value is greater than zero, and delivery of the message causes the
21318 size of the file or total space in the directory tree to cross the given
21319 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21320 may be specified as a percentage of it by following the value with a percent
21321 sign. For example:
21322 .code
21323 quota = 10M
21324 quota_warn_threshold = 75%
21325 .endd
21326 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21327 percent sign is ignored.
21328
21329 The warning message itself is specified by the &%quota_warn_message%& option,
21330 and it must start with a &'To:'& header line containing the recipient(s) of the
21331 warning message. These do not necessarily have to include the recipient(s) of
21332 the original message. A &'Subject:'& line should also normally be supplied. You
21333 can include any other header lines that you want. If you do not include a
21334 &'From:'& line, the default is:
21335 .code
21336 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21337 .endd
21338 .oindex &%errors_reply_to%&
21339 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21340 option.
21341
21342 The &%quota%& option does not have to be set in order to use this option; they
21343 are independent of one another except when the threshold is specified as a
21344 percentage.
21345
21346
21347 .option use_bsmtp appendfile boolean false
21348 .cindex "envelope sender"
21349 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21350 format, with the envelope sender and recipient(s) included as SMTP commands. If
21351 you want to include a leading HELO command with such messages, you can do
21352 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21353 for details of batch SMTP.
21354
21355
21356 .option use_crlf appendfile boolean false
21357 .cindex "carriage return"
21358 .cindex "linefeed"
21359 This option causes lines to be terminated with the two-character CRLF sequence
21360 (carriage return, linefeed) instead of just a linefeed character. In the case
21361 of batched SMTP, the byte sequence written to the file is then an exact image
21362 of what would be sent down a real SMTP connection.
21363
21364 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21365 (which are used to supply the traditional &"From&~"& and blank line separators
21366 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21367 carriage return characters if these are needed. In cases where these options
21368 have non-empty defaults, the values end with a single linefeed, so they must be
21369 changed to end with &`\r\n`& if &%use_crlf%& is set.
21370
21371
21372 .option use_fcntl_lock appendfile boolean "see below"
21373 This option controls the use of the &[fcntl()]& function to lock a file for
21374 exclusive use when a message is being appended. It is set by default unless
21375 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21376 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21377 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21378
21379
21380 .option use_flock_lock appendfile boolean false
21381 This option is provided to support the use of &[flock()]& for file locking, for
21382 the few situations where it is needed. Most modern operating systems support
21383 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21384 each other. Exim uses &[fcntl()]& locking by default.
21385
21386 This option is required only if you are using an operating system where
21387 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21388 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21389 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21390
21391 .cindex "Solaris" "&[flock()]& support"
21392 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21393 have it (and some, I think, provide a not quite right version built on top of
21394 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21395 the ability to use it, and any attempt to do so will cause a configuration
21396 error.
21397
21398 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21399 is just being mapped onto &[fcntl()]& by the OS).
21400
21401
21402 .option use_lockfile appendfile boolean "see below"
21403 If this option is turned off, Exim does not attempt to create a lock file when
21404 appending to a mailbox file. In this situation, the only locking is by
21405 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21406 sure that every MUA that is ever going to look at your users' mailboxes uses
21407 &[fcntl()]& rather than a lock file, and even then only when you are not
21408 delivering over NFS from more than one host.
21409
21410 .cindex "NFS" "lock file"
21411 In order to append to an NFS file safely from more than one host, it is
21412 necessary to take out a lock &'before'& opening the file, and the lock file
21413 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21414 file corruption.
21415
21416 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21417 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21418 except when &%mbx_format%& is set.
21419
21420
21421 .option use_mbx_lock appendfile boolean "see below"
21422 This option is available only if Exim has been compiled with SUPPORT_MBX
21423 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21424 locking rules be used. It is set by default if &%mbx_format%& is set and none
21425 of the locking options are mentioned in the configuration. The locking rules
21426 are the same as are used by the &'c-client'& library that underlies Pine and
21427 the IMAP4 and POP daemons that come with it (see the discussion below). The
21428 rules allow for shared access to the mailbox. However, this kind of locking
21429 does not work when the mailbox is NFS mounted.
21430
21431 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21432 &%use_flock_lock%& to control what kind of locking is used in implementing the
21433 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21434 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21435
21436
21437
21438
21439 .section "Operational details for appending" "SECTopappend"
21440 .cindex "appending to a file"
21441 .cindex "file" "appending"
21442 Before appending to a file, the following preparations are made:
21443
21444 .ilist
21445 If the name of the file is &_/dev/null_&, no action is taken, and a success
21446 return is given.
21447
21448 .next
21449 .cindex "directory creation"
21450 If any directories on the file's path are missing, Exim creates them if the
21451 &%create_directory%& option is set. A created directory's mode is given by the
21452 &%directory_mode%& option.
21453
21454 .next
21455 If &%file_format%& is set, the format of an existing file is checked. If this
21456 indicates that a different transport should be used, control is passed to that
21457 transport.
21458
21459 .next
21460 .cindex "file" "locking"
21461 .cindex "locking files"
21462 .cindex "NFS" "lock file"
21463 If &%use_lockfile%& is set, a lock file is built in a way that will work
21464 reliably over NFS, as follows:
21465
21466 .olist
21467 Create a &"hitching post"& file whose name is that of the lock file with the
21468 current time, primary host name, and process id added, by opening for writing
21469 as a new file. If this fails with an access error, delivery is deferred.
21470 .next
21471 Close the hitching post file, and hard link it to the lock file name.
21472 .next
21473 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21474 Unlink the hitching post name.
21475 .next
21476 Otherwise, use &[stat()]& to get information about the hitching post file, and
21477 then unlink hitching post name. If the number of links is exactly two, creation
21478 of the lock file succeeded but something (for example, an NFS server crash and
21479 restart) caused this fact not to be communicated to the &[link()]& call.
21480 .next
21481 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21482 up to &%lock_retries%& times. However, since any program that writes to a
21483 mailbox should complete its task very quickly, it is reasonable to time out old
21484 lock files that are normally the result of user agent and system crashes. If an
21485 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21486 it before trying again.
21487 .endlist olist
21488
21489 .next
21490 A call is made to &[lstat()]& to discover whether the main file exists, and if
21491 so, what its characteristics are. If &[lstat()]& fails for any reason other
21492 than non-existence, delivery is deferred.
21493
21494 .next
21495 .cindex "symbolic link" "to mailbox"
21496 .cindex "mailbox" "symbolic link"
21497 If the file does exist and is a symbolic link, delivery is deferred, unless the
21498 &%allow_symlink%& option is set, in which case the ownership of the link is
21499 checked, and then &[stat()]& is called to find out about the real file, which
21500 is then subjected to the checks below. The check on the top-level link
21501 ownership prevents one user creating a link for another's mailbox in a sticky
21502 directory, though allowing symbolic links in this case is definitely not a good
21503 idea. If there is a chain of symbolic links, the intermediate ones are not
21504 checked.
21505
21506 .next
21507 If the file already exists but is not a regular file, or if the file's owner
21508 and group (if the group is being checked &-- see &%check_group%& above) are
21509 different from the user and group under which the delivery is running,
21510 delivery is deferred.
21511
21512 .next
21513 If the file's permissions are more generous than specified, they are reduced.
21514 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21515 is set false, in which case the delivery is tried using the existing
21516 permissions.
21517
21518 .next
21519 The file's inode number is saved, and the file is then opened for appending.
21520 If this fails because the file has vanished, &(appendfile)& behaves as if it
21521 hadn't existed (see below). For any other failures, delivery is deferred.
21522
21523 .next
21524 If the file is opened successfully, check that the inode number hasn't
21525 changed, that it is still a regular file, and that the owner and permissions
21526 have not changed. If anything is wrong, defer delivery and freeze the message.
21527
21528 .next
21529 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21530 option is set. Otherwise, check that the file is being created in a permitted
21531 directory if the &%create_file%& option is set (deferring on failure), and then
21532 open for writing as a new file, with the O_EXCL and O_CREAT options,
21533 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21534 set). In this case, which can happen if the link points to a non-existent file,
21535 the file is opened for writing using O_CREAT but not O_EXCL, because
21536 that prevents link following.
21537
21538 .next
21539 .cindex "loop" "while file testing"
21540 If opening fails because the file exists, obey the tests given above for
21541 existing files. However, to avoid looping in a situation where the file is
21542 being continuously created and destroyed, the exists/not-exists loop is broken
21543 after 10 repetitions, and the message is then frozen.
21544
21545 .next
21546 If opening fails with any other error, defer delivery.
21547
21548 .next
21549 .cindex "file" "locking"
21550 .cindex "locking files"
21551 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21552 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21553 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21554 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21555 file, and an exclusive lock on the file whose name is
21556 .code
21557 /tmp/.<device-number>.<inode-number>
21558 .endd
21559 using the device and inode numbers of the open mailbox file, in accordance with
21560 the MBX locking rules. This file is created with a mode that is specified by
21561 the &%lockfile_mode%& option.
21562
21563 If Exim fails to lock the file, there are two possible courses of action,
21564 depending on the value of the locking timeout. This is obtained from
21565 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21566
21567 If the timeout value is zero, the file is closed, Exim waits for
21568 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21569 to lock it again. This happens up to &%lock_retries%& times, after which the
21570 delivery is deferred.
21571
21572 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21573 &[flock()]& are used (with the given timeout), so there has already been some
21574 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21575 immediately. It retries up to
21576 .code
21577 (lock_retries * lock_interval) / <timeout>
21578 .endd
21579 times (rounded up).
21580 .endlist
21581
21582 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21583 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21584
21585
21586 .section "Operational details for delivery to a new file" "SECTopdir"
21587 .cindex "delivery" "to single file"
21588 .cindex "&""From""& line"
21589 When the &%directory%& option is set instead of &%file%&, each message is
21590 delivered into a newly-created file or set of files. When &(appendfile)& is
21591 activated directly from a &(redirect)& router, neither &%file%& nor
21592 &%directory%& is normally set, because the path for delivery is supplied by the
21593 router. (See for example, the &(address_file)& transport in the default
21594 configuration.) In this case, delivery is to a new file if either the path name
21595 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21596
21597 No locking is required while writing the message to a new file, so the various
21598 locking options of the transport are ignored. The &"From"& line that by default
21599 separates messages in a single file is not normally needed, nor is the escaping
21600 of message lines that start with &"From"&, and there is no need to ensure a
21601 newline at the end of each message. Consequently, the default values for
21602 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21603 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21604
21605 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21606 the files in the delivery directory by default. However, you can specify a
21607 different directory by setting &%quota_directory%&. Also, for maildir
21608 deliveries (see below) the &_maildirfolder_& convention is honoured.
21609
21610
21611 .cindex "maildir format"
21612 .cindex "mailstore format"
21613 There are three different ways in which delivery to individual files can be
21614 done, controlled by the settings of the &%maildir_format%& and
21615 &%mailstore_format%& options. Note that code to support maildir or mailstore
21616 formats is not included in the binary unless SUPPORT_MAILDIR or
21617 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21618
21619 .cindex "directory creation"
21620 In all three cases an attempt is made to create the directory and any necessary
21621 sub-directories if they do not exist, provided that the &%create_directory%&
21622 option is set (the default). The location of a created directory can be
21623 constrained by setting &%create_file%&. A created directory's mode is given by
21624 the &%directory_mode%& option. If creation fails, or if the
21625 &%create_directory%& option is not set when creation is required, delivery is
21626 deferred.
21627
21628
21629
21630 .section "Maildir delivery" "SECTmaildirdelivery"
21631 .cindex "maildir format" "description of"
21632 If the &%maildir_format%& option is true, Exim delivers each message by writing
21633 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21634 directory that is defined by the &%directory%& option (the &"delivery
21635 directory"&). If the delivery is successful, the file is renamed into the
21636 &_new_& subdirectory.
21637
21638 In the file name, <&'stime'&> is the current time of day in seconds, and
21639 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21640 Exim checks that the time-of-day clock has moved on by at least one microsecond
21641 before terminating the delivery process. This guarantees uniqueness for the
21642 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21643 opening it. If any response other than ENOENT (does not exist) is given,
21644 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21645
21646 Before Exim carries out a maildir delivery, it ensures that subdirectories
21647 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21648 do not exist, Exim tries to create them and any superior directories in their
21649 path, subject to the &%create_directory%& and &%create_file%& options. If the
21650 &%maildirfolder_create_regex%& option is set, and the regular expression it
21651 contains matches the delivery directory, Exim also ensures that a file called
21652 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21653 &_maildirfolder_& file cannot be created, delivery is deferred.
21654
21655 These features make it possible to use Exim to create all the necessary files
21656 and directories in a maildir mailbox, including subdirectories for maildir++
21657 folders. Consider this example:
21658 .code
21659 maildir_format = true
21660 directory = /var/mail/$local_part\
21661            ${if eq{$local_part_suffix}{}{}\
21662            {/.${substr_1:$local_part_suffix}}}
21663 maildirfolder_create_regex = /\.[^/]+$
21664 .endd
21665 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21666 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21667 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21668 not match this name, so Exim will not look for or create the file
21669 &_/var/mail/pimbo/maildirfolder_&, though it will create
21670 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21671
21672 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21673 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21674 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21675 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21676 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21677
21678 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21679 not inadvertently match the toplevel maildir directory, because a
21680 &_maildirfolder_& file at top level would completely break quota calculations.
21681
21682 .cindex "quota" "in maildir delivery"
21683 .cindex "maildir++"
21684 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21685 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21686 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21687 Exim assumes the directory is a maildir++ folder directory, which is one level
21688 down from the user's top level mailbox directory. This causes it to start at
21689 the parent directory instead of the current directory when calculating the
21690 amount of space used.
21691
21692 One problem with delivering into a multi-file mailbox is that it is
21693 computationally expensive to compute the size of the mailbox for quota
21694 checking. Various approaches have been taken to reduce the amount of work
21695 needed. The next two sections describe two of them. A third alternative is to
21696 use some external process for maintaining the size data, and use the expansion
21697 of the &%mailbox_size%& option as a way of importing it into Exim.
21698
21699
21700
21701
21702 .section "Using tags to record message sizes" "SECID135"
21703 If &%maildir_tag%& is set, the string is expanded for each delivery.
21704 When the maildir file is renamed into the &_new_& sub-directory, the
21705 tag is added to its name. However, if adding the tag takes the length of the
21706 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21707 the tag is dropped and the maildir file is created with no tag.
21708
21709
21710 .vindex "&$message_size$&"
21711 Tags can be used to encode the size of files in their names; see
21712 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21713 happens after the message has been written. The value of the &$message_size$&
21714 variable is set to the number of bytes actually written. If the expansion is
21715 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21716 be deferred. The expanded tag may contain any printing characters except &"/"&.
21717 Non-printing characters in the string are ignored; if the resulting string is
21718 empty, it is ignored. If it starts with an alphanumeric character, a leading
21719 colon is inserted; this default has not proven to be the path that popular
21720 maildir implementations have chosen (but changing it in Exim would break
21721 backwards compatibility).
21722
21723 For one common implementation, you might set:
21724 .code
21725 maildir_tag = ,S=${message_size}
21726 .endd
21727 but you should check the documentation of the other software to be sure.
21728
21729 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21730 as this allows Exim to extract the size from your tag, instead of having to
21731 &[stat()]& each message file.
21732
21733
21734 .section "Using a maildirsize file" "SECID136"
21735 .cindex "quota" "in maildir delivery"
21736 .cindex "maildir format" "&_maildirsize_& file"
21737 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21738 storing quota and message size information in a file called &_maildirsize_&
21739 within the toplevel maildir directory. If this file does not exist, Exim
21740 creates it, setting the quota from the &%quota%& option of the transport. If
21741 the maildir directory itself does not exist, it is created before any attempt
21742 to write a &_maildirsize_& file.
21743
21744 The &_maildirsize_& file is used to hold information about the sizes of
21745 messages in the maildir, thus speeding up quota calculations. The quota value
21746 in the file is just a cache; if the quota is changed in the transport, the new
21747 value overrides the cached value when the next message is delivered. The cache
21748 is maintained for the benefit of other programs that access the maildir and
21749 need to know the quota.
21750
21751 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21752 file is maintained (with a zero quota setting), but no quota is imposed.
21753
21754 A regular expression is available for controlling which directories in the
21755 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21756 See the description of the &%maildir_quota_directory_regex%& option above for
21757 details.
21758
21759
21760 .section "Mailstore delivery" "SECID137"
21761 .cindex "mailstore format" "description of"
21762 If the &%mailstore_format%& option is true, each message is written as two
21763 files in the given directory. A unique base name is constructed from the
21764 message id and the current delivery process, and the files that are written use
21765 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21766 contains the message's envelope, and the &_.msg_& file contains the message
21767 itself. The base name is placed in the variable &$mailstore_basename$&.
21768
21769 During delivery, the envelope is first written to a file with the suffix
21770 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21771 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21772 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21773 file before accessing either of them. An alternative approach is to wait for
21774 the absence of a &_.tmp_& file.
21775
21776 The envelope file starts with any text defined by the &%mailstore_prefix%&
21777 option, expanded and terminated by a newline if there isn't one. Then follows
21778 the sender address on one line, then all the recipient addresses, one per line.
21779 There can be more than one recipient only if the &%batch_max%& option is set
21780 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21781 appended to the file, followed by a newline if it does not end with one.
21782
21783 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21784 failure, it is ignored. Other expansion errors are treated as serious
21785 configuration errors, and delivery is deferred. The variable
21786 &$mailstore_basename$& is available for use during these expansions.
21787
21788
21789 .section "Non-special new file delivery" "SECID138"
21790 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21791 file is created directly in the named directory. For example, when delivering
21792 messages into files in batched SMTP format for later delivery to some host (see
21793 section &<<SECTbatchSMTP>>&), a setting such as
21794 .code
21795 directory = /var/bsmtp/$host
21796 .endd
21797 might be used. A message is written to a file with a temporary name, which is
21798 then renamed when the delivery is complete. The final name is obtained by
21799 expanding the contents of the &%directory_file%& option.
21800 .ecindex IIDapptra1
21801 .ecindex IIDapptra2
21802
21803
21804
21805
21806
21807
21808 . ////////////////////////////////////////////////////////////////////////////
21809 . ////////////////////////////////////////////////////////////////////////////
21810
21811 .chapter "The autoreply transport" "CHID8"
21812 .scindex IIDauttra1 "transports" "&(autoreply)&"
21813 .scindex IIDauttra2 "&(autoreply)& transport"
21814 The &(autoreply)& transport is not a true transport in that it does not cause
21815 the message to be transmitted. Instead, it generates a new mail message as an
21816 automatic reply to the incoming message. &'References:'& and
21817 &'Auto-Submitted:'& header lines are included. These are constructed according
21818 to the rules in RFCs 2822 and 3834, respectively.
21819
21820 If the router that passes the message to this transport does not have the
21821 &%unseen%& option set, the original message (for the current recipient) is not
21822 delivered anywhere. However, when the &%unseen%& option is set on the router
21823 that passes the message to this transport, routing of the address continues, so
21824 another router can set up a normal message delivery.
21825
21826
21827 The &(autoreply)& transport is usually run as the result of mail filtering, a
21828 &"vacation"& message being the standard example. However, it can also be run
21829 directly from a router like any other transport. To reduce the possibility of
21830 message cascades, messages created by the &(autoreply)& transport always have
21831 empty envelope sender addresses, like bounce messages.
21832
21833 The parameters of the message to be sent can be specified in the configuration
21834 by options described below. However, these are used only when the address
21835 passed to the transport does not contain its own reply information. When the
21836 transport is run as a consequence of a
21837 &%mail%&
21838 or &%vacation%& command in a filter file, the parameters of the message are
21839 supplied by the filter, and passed with the address. The transport's options
21840 that define the message are then ignored (so they are not usually set in this
21841 case). The message is specified entirely by the filter or by the transport; it
21842 is never built from a mixture of options. However, the &%file_optional%&,
21843 &%mode%&, and &%return_message%& options apply in all cases.
21844
21845 &(Autoreply)& is implemented as a local transport. When used as a result of a
21846 command in a user's filter file, &(autoreply)& normally runs under the uid and
21847 gid of the user, and with appropriate current and home directories (see chapter
21848 &<<CHAPenvironment>>&).
21849
21850 There is a subtle difference between routing a message to a &(pipe)& transport
21851 that generates some text to be returned to the sender, and routing it to an
21852 &(autoreply)& transport. This difference is noticeable only if more than one
21853 address from the same message is so handled. In the case of a pipe, the
21854 separate outputs from the different addresses are gathered up and returned to
21855 the sender in a single message, whereas if &(autoreply)& is used, a separate
21856 message is generated for each address that is passed to it.
21857
21858 Non-printing characters are not permitted in the header lines generated for the
21859 message that &(autoreply)& creates, with the exception of newlines that are
21860 immediately followed by white space. If any non-printing characters are found,
21861 the transport defers.
21862 Whether characters with the top bit set count as printing characters or not is
21863 controlled by the &%print_topbitchars%& global option.
21864
21865 If any of the generic options for manipulating headers (for example,
21866 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21867 of the original message that is included in the generated message when
21868 &%return_message%& is set. They do not apply to the generated message itself.
21869
21870 .vindex "&$sender_address$&"
21871 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21872 the message, indicating that there were no recipients, it does not treat this
21873 as an error. This means that autoreplies sent to &$sender_address$& when this
21874 is empty (because the incoming message is a bounce message) do not cause
21875 problems. They are just discarded.
21876
21877
21878
21879 .section "Private options for autoreply" "SECID139"
21880 .cindex "options" "&(autoreply)& transport"
21881
21882 .option bcc autoreply string&!! unset
21883 This specifies the addresses that are to receive &"blind carbon copies"& of the
21884 message when the message is specified by the transport.
21885
21886
21887 .option cc autoreply string&!! unset
21888 This specifies recipients of the message and the contents of the &'Cc:'& header
21889 when the message is specified by the transport.
21890
21891
21892 .option file autoreply string&!! unset
21893 The contents of the file are sent as the body of the message when the message
21894 is specified by the transport. If both &%file%& and &%text%& are set, the text
21895 string comes first.
21896
21897
21898 .option file_expand autoreply boolean false
21899 If this is set, the contents of the file named by the &%file%& option are
21900 subjected to string expansion as they are added to the message.
21901
21902
21903 .option file_optional autoreply boolean false
21904 If this option is true, no error is generated if the file named by the &%file%&
21905 option or passed with the address does not exist or cannot be read.
21906
21907
21908 .option from autoreply string&!! unset
21909 This specifies the contents of the &'From:'& header when the message is
21910 specified by the transport.
21911
21912
21913 .option headers autoreply string&!! unset
21914 This specifies additional RFC 2822 headers that are to be added to the message
21915 when the message is specified by the transport. Several can be given by using
21916 &"\n"& to separate them. There is no check on the format.
21917
21918
21919 .option log autoreply string&!! unset
21920 This option names a file in which a record of every message sent is logged when
21921 the message is specified by the transport.
21922
21923
21924 .option mode autoreply "octal integer" 0600
21925 If either the log file or the &"once"& file has to be created, this mode is
21926 used.
21927
21928
21929 .option never_mail autoreply "address list&!!" unset
21930 If any run of the transport creates a message with a recipient that matches any
21931 item in the list, that recipient is quietly discarded. If all recipients are
21932 discarded, no message is created. This applies both when the recipients are
21933 generated by a filter and when they are specified in the transport.
21934
21935
21936
21937 .option once autoreply string&!! unset
21938 This option names a file or DBM database in which a record of each &'To:'&
21939 recipient is kept when the message is specified by the transport. &*Note*&:
21940 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21941
21942 If &%once%& is unset, or is set to an empty string, the message is always sent.
21943 By default, if &%once%& is set to a non-empty file name, the message
21944 is not sent if a potential recipient is already listed in the database.
21945 However, if the &%once_repeat%& option specifies a time greater than zero, the
21946 message is sent if that much time has elapsed since a message was last sent to
21947 this recipient. A setting of zero time for &%once_repeat%& (the default)
21948 prevents a message from being sent a second time &-- in this case, zero means
21949 infinity.
21950
21951 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21952 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21953 greater than zero, it changes the way Exim implements the &%once%& option.
21954 Instead of using a DBM file to record every recipient it sends to, it uses a
21955 regular file, whose size will never get larger than the given value.
21956
21957 In the file, Exim keeps a linear list of recipient addresses and the times at
21958 which they were sent messages. If the file is full when a new address needs to
21959 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21960 means that a given recipient may receive multiple messages, but at
21961 unpredictable intervals that depend on the rate of turnover of addresses in the
21962 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21963
21964
21965 .option once_file_size autoreply integer 0
21966 See &%once%& above.
21967
21968
21969 .option once_repeat autoreply time&!! 0s
21970 See &%once%& above.
21971 After expansion, the value of this option must be a valid time value.
21972
21973
21974 .option reply_to autoreply string&!! unset
21975 This specifies the contents of the &'Reply-To:'& header when the message is
21976 specified by the transport.
21977
21978
21979 .option return_message autoreply boolean false
21980 If this is set, a copy of the original message is returned with the new
21981 message, subject to the maximum size set in the &%return_size_limit%& global
21982 configuration option.
21983
21984
21985 .option subject autoreply string&!! unset
21986 This specifies the contents of the &'Subject:'& header when the message is
21987 specified by the transport. It is tempting to quote the original subject in
21988 automatic responses. For example:
21989 .code
21990 subject = Re: $h_subject:
21991 .endd
21992 There is a danger in doing this, however. It may allow a third party to
21993 subscribe your users to an opt-in mailing list, provided that the list accepts
21994 bounce messages as subscription confirmations. Well-managed lists require a
21995 non-bounce message to confirm a subscription, so the danger is relatively
21996 small.
21997
21998
21999
22000 .option text autoreply string&!! unset
22001 This specifies a single string to be used as the body of the message when the
22002 message is specified by the transport. If both &%text%& and &%file%& are set,
22003 the text comes first.
22004
22005
22006 .option to autoreply string&!! unset
22007 This specifies recipients of the message and the contents of the &'To:'& header
22008 when the message is specified by the transport.
22009 .ecindex IIDauttra1
22010 .ecindex IIDauttra2
22011
22012
22013
22014
22015 . ////////////////////////////////////////////////////////////////////////////
22016 . ////////////////////////////////////////////////////////////////////////////
22017
22018 .chapter "The lmtp transport" "CHAPLMTP"
22019 .cindex "transports" "&(lmtp)&"
22020 .cindex "&(lmtp)& transport"
22021 .cindex "LMTP" "over a pipe"
22022 .cindex "LMTP" "over a socket"
22023 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22024 specified command
22025 or by interacting with a Unix domain socket.
22026 This transport is something of a cross between the &(pipe)& and &(smtp)&
22027 transports. Exim also has support for using LMTP over TCP/IP; this is
22028 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22029 to be of minority interest, the default build-time configure in &_src/EDITME_&
22030 has it commented out. You need to ensure that
22031 .code
22032 TRANSPORT_LMTP=yes
22033 .endd
22034 .cindex "options" "&(lmtp)& transport"
22035 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22036 included in the Exim binary. The private options of the &(lmtp)& transport are
22037 as follows:
22038
22039 .option batch_id lmtp string&!! unset
22040 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22041
22042
22043 .option batch_max lmtp integer 1
22044 This limits the number of addresses that can be handled in a single delivery.
22045 Most LMTP servers can handle several addresses at once, so it is normally a
22046 good idea to increase this value. See the description of local delivery
22047 batching in chapter &<<CHAPbatching>>&.
22048
22049
22050 .option command lmtp string&!! unset
22051 This option must be set if &%socket%& is not set. The string is a command which
22052 is run in a separate process. It is split up into a command name and list of
22053 arguments, each of which is separately expanded (so expansion cannot change the
22054 number of arguments). The command is run directly, not via a shell. The message
22055 is passed to the new process using the standard input and output to operate the
22056 LMTP protocol.
22057
22058 .option ignore_quota lmtp boolean false
22059 .cindex "LMTP" "ignoring quota errors"
22060 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22061 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22062 in its response to the LHLO command.
22063
22064 .option socket lmtp string&!! unset
22065 This option must be set if &%command%& is not set. The result of expansion must
22066 be the name of a Unix domain socket. The transport connects to the socket and
22067 delivers the message to it using the LMTP protocol.
22068
22069
22070 .option timeout lmtp time 5m
22071 The transport is aborted if the created process or Unix domain socket does not
22072 respond to LMTP commands or message input within this timeout. Delivery
22073 is deferred, and will be tried again later. Here is an example of a typical
22074 LMTP transport:
22075 .code
22076 lmtp:
22077   driver = lmtp
22078   command = /some/local/lmtp/delivery/program
22079   batch_max = 20
22080   user = exim
22081 .endd
22082 This delivers up to 20 addresses at a time, in a mixture of domains if
22083 necessary, running as the user &'exim'&.
22084
22085
22086
22087 . ////////////////////////////////////////////////////////////////////////////
22088 . ////////////////////////////////////////////////////////////////////////////
22089
22090 .chapter "The pipe transport" "CHAPpipetransport"
22091 .scindex IIDpiptra1 "transports" "&(pipe)&"
22092 .scindex IIDpiptra2 "&(pipe)& transport"
22093 The &(pipe)& transport is used to deliver messages via a pipe to a command
22094 running in another process. One example is the use of &(pipe)& as a
22095 pseudo-remote transport for passing messages to some other delivery mechanism
22096 (such as UUCP). Another is the use by individual users to automatically process
22097 their incoming messages. The &(pipe)& transport can be used in one of the
22098 following ways:
22099
22100 .ilist
22101 .vindex "&$local_part$&"
22102 A router routes one address to a transport in the normal way, and the
22103 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22104 contains the local part of the address (as usual), and the command that is run
22105 is specified by the &%command%& option on the transport.
22106 .next
22107 .vindex "&$pipe_addresses$&"
22108 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22109 transport can handle more than one address in a single run. In this case, when
22110 more than one address is routed to the transport, &$local_part$& is not set
22111 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22112 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22113 that are routed to the transport.
22114 .next
22115 .vindex "&$address_pipe$&"
22116 A router redirects an address directly to a pipe command (for example, from an
22117 alias or forward file). In this case, &$address_pipe$& contains the text of the
22118 pipe command, and the &%command%& option on the transport is ignored unless
22119 &%force_command%& is set. If only one address is being transported
22120 (&%batch_max%& is not greater than one, or only one address was redirected to
22121 this pipe command), &$local_part$& contains the local part that was redirected.
22122 .endlist
22123
22124
22125 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22126 deliver messages over pipes using the LMTP interactive protocol. This is
22127 implemented by the &(lmtp)& transport.
22128
22129 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22130 &_.forward_& file, the command runs under the uid and gid of that user. In
22131 other cases, the uid and gid have to be specified explicitly, either on the
22132 transport or on the router that handles the address. Current and &"home"&
22133 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22134 details of the local delivery environment and chapter &<<CHAPbatching>>&
22135 for a discussion of local delivery batching.
22136
22137
22138 .section "Concurrent delivery" "SECID140"
22139 If two messages arrive at almost the same time, and both are routed to a pipe
22140 delivery, the two pipe transports may be run concurrently. You must ensure that
22141 any pipe commands you set up are robust against this happening. If the commands
22142 write to a file, the &%exim_lock%& utility might be of use.
22143
22144
22145
22146
22147 .section "Returned status and data" "SECID141"
22148 .cindex "&(pipe)& transport" "returned data"
22149 If the command exits with a non-zero return code, the delivery is deemed to
22150 have failed, unless either the &%ignore_status%& option is set (in which case
22151 the return code is treated as zero), or the return code is one of those listed
22152 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22153 later"&. In this case, delivery is deferred. Details of a permanent failure are
22154 logged, but are not included in the bounce message, which merely contains
22155 &"local delivery failed"&.
22156
22157 If the command exits on a signal and the &%freeze_signal%& option is set then
22158 the message will be frozen in the queue. If that option is not set, a bounce
22159 will be sent as normal.
22160
22161 If the return code is greater than 128 and the command being run is a shell
22162 script, it normally means that the script was terminated by a signal whose
22163 value is the return code minus 128. The &%freeze_signal%& option does not
22164 apply in this case.
22165
22166 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22167 return code is set to 127. This is the value that a shell returns if it is
22168 asked to run a non-existent command. The wording for the log line suggests that
22169 a non-existent command may be the problem.
22170
22171 The &%return_output%& option can affect the result of a pipe delivery. If it is
22172 set and the command produces any output on its standard output or standard
22173 error streams, the command is considered to have failed, even if it gave a zero
22174 return code or if &%ignore_status%& is set. The output from the command is
22175 included as part of the bounce message. The &%return_fail_output%& option is
22176 similar, except that output is returned only when the command exits with a
22177 failure return code, that is, a value other than zero or a code that matches
22178 &%temp_errors%&.
22179
22180
22181
22182 .section "How the command is run" "SECThowcommandrun"
22183 .cindex "&(pipe)& transport" "path for command"
22184 The command line is (by default) broken down into a command name and arguments
22185 by the &(pipe)& transport itself. The &%allow_commands%& and
22186 &%restrict_to_path%& options can be used to restrict the commands that may be
22187 run.
22188
22189 .cindex "quoting" "in pipe command"
22190 Unquoted arguments are delimited by white space. If an argument appears in
22191 double quotes, backslash is interpreted as an escape character in the usual
22192 way. If an argument appears in single quotes, no escaping is done.
22193
22194 String expansion is applied to the command line except when it comes from a
22195 traditional &_.forward_& file (commands from a filter file are expanded). The
22196 expansion is applied to each argument in turn rather than to the whole line.
22197 For this reason, any string expansion item that contains white space must be
22198 quoted so as to be contained within a single argument. A setting such as
22199 .code
22200 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22201 .endd
22202 will not work, because the expansion item gets split between several
22203 arguments. You have to write
22204 .code
22205 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22206 .endd
22207 to ensure that it is all in one argument. The expansion is done in this way,
22208 argument by argument, so that the number of arguments cannot be changed as a
22209 result of expansion, and quotes or backslashes in inserted variables do not
22210 interact with external quoting. However, this leads to problems if you want to
22211 generate multiple arguments (or the command name plus arguments) from a single
22212 expansion. In this situation, the simplest solution is to use a shell. For
22213 example:
22214 .code
22215 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22216 .endd
22217
22218 .cindex "transport" "filter"
22219 .cindex "filter" "transport filter"
22220 .vindex "&$pipe_addresses$&"
22221 Special handling takes place when an argument consists of precisely the text
22222 &`$pipe_addresses`&. This is not a general expansion variable; the only
22223 place this string is recognized is when it appears as an argument for a pipe or
22224 transport filter command. It causes each address that is being handled to be
22225 inserted in the argument list at that point &'as a separate argument'&. This
22226 avoids any problems with spaces or shell metacharacters, and is of use when a
22227 &(pipe)& transport is handling groups of addresses in a batch.
22228
22229 If &%force_command%& is enabled on the transport, Special handling takes place
22230 for an argument that consists of precisely the text &`$address_pipe`&.  It
22231 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22232 argument is inserted in the argument list at that point
22233 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22234 the only item in the argument; in fact, if it were then &%force_command%&
22235 should behave as a no-op.  Rather, it should be used to adjust the command
22236 run while preserving the argument vector separation.
22237
22238 After splitting up into arguments and expansion, the resulting command is run
22239 in a subprocess directly from the transport, &'not'& under a shell. The
22240 message that is being delivered is supplied on the standard input, and the
22241 standard output and standard error are both connected to a single pipe that is
22242 read by Exim. The &%max_output%& option controls how much output the command
22243 may produce, and the &%return_output%& and &%return_fail_output%& options
22244 control what is done with it.
22245
22246 Not running the command under a shell (by default) lessens the security risks
22247 in cases when a command from a user's filter file is built out of data that was
22248 taken from an incoming message. If a shell is required, it can of course be
22249 explicitly specified as the command to be run. However, there are circumstances
22250 where existing commands (for example, in &_.forward_& files) expect to be run
22251 under a shell and cannot easily be modified. To allow for these cases, there is
22252 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22253 works. Instead of breaking up the command line as just described, it expands it
22254 as a single string and passes the result to &_/bin/sh_&. The
22255 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22256 with &%use_shell%&, and the whole mechanism is inherently less secure.
22257
22258
22259
22260 .section "Environment variables" "SECTpipeenv"
22261 .cindex "&(pipe)& transport" "environment for command"
22262 .cindex "environment for pipe transport"
22263 The environment variables listed below are set up when the command is invoked.
22264 This list is a compromise for maximum compatibility with other MTAs. Note that
22265 the &%environment%& option can be used to add additional variables to this
22266 environment.
22267 .display
22268 &`DOMAIN            `&   the domain of the address
22269 &`HOME              `&   the home directory, if set
22270 &`HOST              `&   the host name when called from a router (see below)
22271 &`LOCAL_PART        `&   see below
22272 &`LOCAL_PART_PREFIX `&   see below
22273 &`LOCAL_PART_SUFFIX `&   see below
22274 &`LOGNAME           `&   see below
22275 &`MESSAGE_ID        `&   Exim's local ID for the message
22276 &`PATH              `&   as specified by the &%path%& option below
22277 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22278 &`RECIPIENT         `&   the complete recipient address
22279 &`SENDER            `&   the sender of the message (empty if a bounce)
22280 &`SHELL             `&   &`/bin/sh`&
22281 &`TZ                `&   the value of the &%timezone%& option, if set
22282 &`USER              `&   see below
22283 .endd
22284 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22285 router, LOCAL_PART is set to the local part of the address. When it is
22286 called as a result of a forward or alias expansion, LOCAL_PART is set to
22287 the local part of the address that was expanded. In both cases, any affixes are
22288 removed from the local part, and made available in LOCAL_PART_PREFIX and
22289 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22290 same value as LOCAL_PART for compatibility with other MTAs.
22291
22292 .cindex "HOST"
22293 HOST is set only when a &(pipe)& transport is called from a router that
22294 associates hosts with an address, typically when using &(pipe)& as a
22295 pseudo-remote transport. HOST is set to the first host name specified by
22296 the router.
22297
22298 .cindex "HOME"
22299 If the transport's generic &%home_directory%& option is set, its value is used
22300 for the HOME environment variable. Otherwise, a home directory may be set
22301 by the router's &%transport_home_directory%& option, which defaults to the
22302 user's home directory if &%check_local_user%& is set.
22303
22304
22305 .section "Private options for pipe" "SECID142"
22306 .cindex "options" "&(pipe)& transport"
22307
22308
22309
22310 .option allow_commands pipe "string list&!!" unset
22311 .cindex "&(pipe)& transport" "permitted commands"
22312 The string is expanded, and is then interpreted as a colon-separated list of
22313 permitted commands. If &%restrict_to_path%& is not set, the only commands
22314 permitted are those in the &%allow_commands%& list. They need not be absolute
22315 paths; the &%path%& option is still used for relative paths. If
22316 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22317 in the &%allow_commands%& list, or a name without any slashes that is found on
22318 the path. In other words, if neither &%allow_commands%& nor
22319 &%restrict_to_path%& is set, there is no restriction on the command, but
22320 otherwise only commands that are permitted by one or the other are allowed. For
22321 example, if
22322 .code
22323 allow_commands = /usr/bin/vacation
22324 .endd
22325 and &%restrict_to_path%& is not set, the only permitted command is
22326 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22327 &%use_shell%& is set.
22328
22329
22330 .option batch_id pipe string&!! unset
22331 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22332
22333
22334 .option batch_max pipe integer 1
22335 This limits the number of addresses that can be handled in a single delivery.
22336 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22337
22338
22339 .option check_string pipe string unset
22340 As &(pipe)& writes the message, the start of each line is tested for matching
22341 &%check_string%&, and if it does, the initial matching characters are replaced
22342 by the contents of &%escape_string%&, provided both are set. The value of
22343 &%check_string%& is a literal string, not a regular expression, and the case of
22344 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22345 of &%check_string%& and &%escape_string%& are forced to values that implement
22346 the SMTP escaping protocol. Any settings made in the configuration file are
22347 ignored.
22348
22349
22350 .option command pipe string&!! unset
22351 This option need not be set when &(pipe)& is being used to deliver to pipes
22352 obtained directly from address redirections. In other cases, the option must be
22353 set, to provide a command to be run. It need not yield an absolute path (see
22354 the &%path%& option below). The command is split up into separate arguments by
22355 Exim, and each argument is separately expanded, as described in section
22356 &<<SECThowcommandrun>>& above.
22357
22358
22359 .option environment pipe string&!! unset
22360 .cindex "&(pipe)& transport" "environment for command"
22361 .cindex "environment for &(pipe)& transport"
22362 This option is used to add additional variables to the environment in which the
22363 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22364 a string which is expanded, and then interpreted as a colon-separated list of
22365 environment settings of the form <&'name'&>=<&'value'&>.
22366
22367
22368 .option escape_string pipe string unset
22369 See &%check_string%& above.
22370
22371
22372 .option freeze_exec_fail pipe boolean false
22373 .cindex "exec failure"
22374 .cindex "failure of exec"
22375 .cindex "&(pipe)& transport" "failure of exec"
22376 Failure to exec the command in a pipe transport is by default treated like
22377 any other failure while running the command. However, if &%freeze_exec_fail%&
22378 is set, failure to exec is treated specially, and causes the message to be
22379 frozen, whatever the setting of &%ignore_status%&.
22380
22381
22382 .option freeze_signal pipe boolean false
22383 .cindex "signal exit"
22384 .cindex "&(pipe)& transport", "signal exit"
22385 Normally if the process run by a command in a pipe transport exits on a signal,
22386 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22387 frozen in Exim's queue instead.
22388
22389
22390 .option force_command pipe boolean false
22391 .cindex "force command"
22392 .cindex "&(pipe)& transport", "force command"
22393 Normally when a router redirects an address directly to a pipe command
22394 the &%command%& option on the transport is ignored.  If &%force_command%&
22395 is set, the &%command%& option will used. This is especially
22396 useful for forcing a wrapper or additional argument to be added to the
22397 command. For example:
22398 .code
22399 command = /usr/bin/remote_exec myhost -- $address_pipe
22400 force_command
22401 .endd
22402
22403 Note that &$address_pipe$& is handled specially in &%command%& when
22404 &%force_command%& is set, expanding out to the original argument vector as
22405 separate items, similarly to a Unix shell &`"$@"`& construct.
22406
22407 .option ignore_status pipe boolean false
22408 If this option is true, the status returned by the subprocess that is set up to
22409 run the command is ignored, and Exim behaves as if zero had been returned.
22410 Otherwise, a non-zero status or termination by signal causes an error return
22411 from the transport unless the status value is one of those listed in
22412 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22413
22414 &*Note*&: This option does not apply to timeouts, which do not return a status.
22415 See the &%timeout_defer%& option for how timeouts are handled.
22416
22417 .option log_defer_output pipe boolean false
22418 .cindex "&(pipe)& transport" "logging output"
22419 If this option is set, and the status returned by the command is
22420 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22421 and any output was produced, the first line of it is written to the main log.
22422
22423
22424 .option log_fail_output pipe boolean false
22425 If this option is set, and the command returns any output, and also ends with a
22426 return code that is neither zero nor one of the return codes listed in
22427 &%temp_errors%& (that is, the delivery failed), the first line of output is
22428 written to the main log. This option and &%log_output%& are mutually exclusive.
22429 Only one of them may be set.
22430
22431
22432
22433 .option log_output pipe boolean false
22434 If this option is set and the command returns any output, the first line of
22435 output is written to the main log, whatever the return code. This option and
22436 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22437
22438
22439
22440 .option max_output pipe integer 20K
22441 This specifies the maximum amount of output that the command may produce on its
22442 standard output and standard error file combined. If the limit is exceeded, the
22443 process running the command is killed. This is intended as a safety measure to
22444 catch runaway processes. The limit is applied independently of the settings of
22445 the options that control what is done with such output (for example,
22446 &%return_output%&). Because of buffering effects, the amount of output may
22447 exceed the limit by a small amount before Exim notices.
22448
22449
22450 .option message_prefix pipe string&!! "see below"
22451 The string specified here is expanded and output at the start of every message.
22452 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22453 .code
22454 message_prefix = \
22455   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22456   ${tod_bsdinbox}\n
22457 .endd
22458 .cindex "Cyrus"
22459 .cindex "&%tmail%&"
22460 .cindex "&""From""& line"
22461 This is required by the commonly used &_/usr/bin/vacation_& program.
22462 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22463 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22464 setting
22465 .code
22466 message_prefix =
22467 .endd
22468 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22469 &`\n`& to &`\r\n`& in &%message_prefix%&.
22470
22471
22472 .option message_suffix pipe string&!! "see below"
22473 The string specified here is expanded and output at the end of every message.
22474 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22475 The suffix can be suppressed by setting
22476 .code
22477 message_suffix =
22478 .endd
22479 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22480 &`\n`& to &`\r\n`& in &%message_suffix%&.
22481
22482
22483 .option path pipe string "see below"
22484 This option specifies the string that is set up in the PATH environment
22485 variable of the subprocess. The default is:
22486 .code
22487 /bin:/usr/bin
22488 .endd
22489 If the &%command%& option does not yield an absolute path name, the command is
22490 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22491 apply to a command specified as a transport filter.
22492
22493
22494 .option permit_coredump pipe boolean false
22495 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22496 a core-dump of a pipe command, enable this command.  This enables core-dumps
22497 during delivery and affects both the Exim binary and the pipe command run.
22498 It is recommended that this option remain off unless and until you have a need
22499 for it and that this only be enabled when needed, as the risk of excessive
22500 resource consumption can be quite high.  Note also that Exim is typically
22501 installed as a setuid binary and most operating systems will inhibit coredumps
22502 of these by default, so further OS-specific action may be required.
22503
22504
22505 .option pipe_as_creator pipe boolean false
22506 .cindex "uid (user id)" "local delivery"
22507 If the generic &%user%& option is not set and this option is true, the delivery
22508 process is run under the uid that was in force when Exim was originally called
22509 to accept the message. If the group id is not otherwise set (via the generic
22510 &%group%& option), the gid that was in force when Exim was originally called to
22511 accept the message is used.
22512
22513
22514 .option restrict_to_path pipe boolean false
22515 When this option is set, any command name not listed in &%allow_commands%& must
22516 contain no slashes. The command is searched for only in the directories listed
22517 in the &%path%& option. This option is intended for use in the case when a pipe
22518 command has been generated from a user's &_.forward_& file. This is usually
22519 handled by a &(pipe)& transport called &%address_pipe%&.
22520
22521
22522 .option return_fail_output pipe boolean false
22523 If this option is true, and the command produced any output and ended with a
22524 return code other than zero or one of the codes listed in &%temp_errors%& (that
22525 is, the delivery failed), the output is returned in the bounce message.
22526 However, if the message has a null sender (that is, it is itself a bounce
22527 message), output from the command is discarded. This option and
22528 &%return_output%& are mutually exclusive. Only one of them may be set.
22529
22530
22531
22532 .option return_output pipe boolean false
22533 If this option is true, and the command produced any output, the delivery is
22534 deemed to have failed whatever the return code from the command, and the output
22535 is returned in the bounce message. Otherwise, the output is just discarded.
22536 However, if the message has a null sender (that is, it is a bounce message),
22537 output from the command is always discarded, whatever the setting of this
22538 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22539 of them may be set.
22540
22541
22542
22543 .option temp_errors pipe "string list" "see below"
22544 .cindex "&(pipe)& transport" "temporary failure"
22545 This option contains either a colon-separated list of numbers, or a single
22546 asterisk. If &%ignore_status%& is false
22547 and &%return_output%& is not set,
22548 and the command exits with a non-zero return code, the failure is treated as
22549 temporary and the delivery is deferred if the return code matches one of the
22550 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22551 codes are treated as permanent errors. The default setting contains the codes
22552 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22553 compiled on a system that does not define these macros, it assumes values of 75
22554 and 73, respectively.
22555
22556
22557 .option timeout pipe time 1h
22558 If the command fails to complete within this time, it is killed. This normally
22559 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22560 specifies no timeout. In order to ensure that any subprocesses created by the
22561 command are also killed, Exim makes the initial process a process group leader,
22562 and kills the whole process group on a timeout. However, this can be defeated
22563 if one of the processes starts a new process group.
22564
22565 .option timeout_defer pipe boolean false
22566 A timeout in a &(pipe)& transport, either in the command that the transport
22567 runs, or in a transport filter that is associated with it, is by default
22568 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22569 is set true, both kinds of timeout become temporary errors, causing the
22570 delivery to be deferred.
22571
22572 .option umask pipe "octal integer" 022
22573 This specifies the umask setting for the subprocess that runs the command.
22574
22575
22576 .option use_bsmtp pipe boolean false
22577 .cindex "envelope sender"
22578 If this option is set true, the &(pipe)& transport writes messages in &"batch
22579 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22580 commands. If you want to include a leading HELO command with such messages,
22581 you can do so by setting the &%message_prefix%& option. See section
22582 &<<SECTbatchSMTP>>& for details of batch SMTP.
22583
22584 .option use_classresources pipe boolean false
22585 .cindex "class resources (BSD)"
22586 This option is available only when Exim is running on FreeBSD, NetBSD, or
22587 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22588 resource limits when a &(pipe)& transport is run to perform a delivery. The
22589 limits for the uid under which the pipe is to run are obtained from the login
22590 class database.
22591
22592
22593 .option use_crlf pipe boolean false
22594 .cindex "carriage return"
22595 .cindex "linefeed"
22596 This option causes lines to be terminated with the two-character CRLF sequence
22597 (carriage return, linefeed) instead of just a linefeed character. In the case
22598 of batched SMTP, the byte sequence written to the pipe is then an exact image
22599 of what would be sent down a real SMTP connection.
22600
22601 The contents of the &%message_prefix%& and &%message_suffix%& options are
22602 written verbatim, so must contain their own carriage return characters if these
22603 are needed. When &%use_bsmtp%& is not set, the default values for both
22604 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22605 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22606
22607
22608 .option use_shell pipe boolean false
22609 .vindex "&$pipe_addresses$&"
22610 If this option is set, it causes the command to be passed to &_/bin/sh_&
22611 instead of being run directly from the transport, as described in section
22612 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22613 where the command is expected to be run under a shell and cannot easily be
22614 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22615 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22616 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22617 its &%-c%& option.
22618
22619
22620
22621 .section "Using an external local delivery agent" "SECID143"
22622 .cindex "local delivery" "using an external agent"
22623 .cindex "&'procmail'&"
22624 .cindex "external local delivery"
22625 .cindex "delivery" "&'procmail'&"
22626 .cindex "delivery" "by external agent"
22627 The &(pipe)& transport can be used to pass all messages that require local
22628 delivery to a separate local delivery agent such as &%procmail%&. When doing
22629 this, care must be taken to ensure that the pipe is run under an appropriate
22630 uid and gid. In some configurations one wants this to be a uid that is trusted
22631 by the delivery agent to supply the correct sender of the message. It may be
22632 necessary to recompile or reconfigure the delivery agent so that it trusts an
22633 appropriate user. The following is an example transport and router
22634 configuration for &%procmail%&:
22635 .code
22636 # transport
22637 procmail_pipe:
22638   driver = pipe
22639   command = /usr/local/bin/procmail -d $local_part
22640   return_path_add
22641   delivery_date_add
22642   envelope_to_add
22643   check_string = "From "
22644   escape_string = ">From "
22645   umask = 077
22646   user = $local_part
22647   group = mail
22648
22649 # router
22650 procmail:
22651   driver = accept
22652   check_local_user
22653   transport = procmail_pipe
22654 .endd
22655 In this example, the pipe is run as the local user, but with the group set to
22656 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22657 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22658 user to supply a correct sender address. If you do not specify either a
22659 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22660 home directory is the user's home directory by default.
22661
22662 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22663 .code
22664 IFS=" "
22665 .endd
22666 as shown in some &%procmail%& documentation, because Exim does not by default
22667 use a shell to run pipe commands.
22668
22669 .cindex "Cyrus"
22670 The next example shows a transport and a router for a system where local
22671 deliveries are handled by the Cyrus IMAP server.
22672 .code
22673 # transport
22674 local_delivery_cyrus:
22675   driver = pipe
22676   command = /usr/cyrus/bin/deliver \
22677             -m ${substr_1:$local_part_suffix} -- $local_part
22678   user = cyrus
22679   group = mail
22680   return_output
22681   log_output
22682   message_prefix =
22683   message_suffix =
22684
22685 # router
22686 local_user_cyrus:
22687   driver = accept
22688   check_local_user
22689   local_part_suffix = .*
22690   transport = local_delivery_cyrus
22691 .endd
22692 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22693 &%return_output%& to cause any text written by Cyrus to be returned to the
22694 sender.
22695 .ecindex IIDpiptra1
22696 .ecindex IIDpiptra2
22697
22698
22699 . ////////////////////////////////////////////////////////////////////////////
22700 . ////////////////////////////////////////////////////////////////////////////
22701
22702 .chapter "The smtp transport" "CHAPsmtptrans"
22703 .scindex IIDsmttra1 "transports" "&(smtp)&"
22704 .scindex IIDsmttra2 "&(smtp)& transport"
22705 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22706 or LMTP protocol. The list of hosts to try can either be taken from the address
22707 that is being processed (having been set up by the router), or specified
22708 explicitly for the transport. Timeout and retry processing (see chapter
22709 &<<CHAPretry>>&) is applied to each IP address independently.
22710
22711
22712 .section "Multiple messages on a single connection" "SECID144"
22713 The sending of multiple messages over a single TCP/IP connection can arise in
22714 two ways:
22715
22716 .ilist
22717 If a message contains more than &%max_rcpt%& (see below) addresses that are
22718 routed to the same host, more than one copy of the message has to be sent to
22719 that host. In this situation, multiple copies may be sent in a single run of
22720 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22721 does when it has too many addresses to send in one message also depends on the
22722 value of the global &%remote_max_parallel%& option. Details are given in
22723 section &<<SECToutSMTPTCP>>&.)
22724 .next
22725 .cindex "hints database" "remembering routing"
22726 When a message has been successfully delivered over a TCP/IP connection, Exim
22727 looks in its hints database to see if there are any other messages awaiting a
22728 connection to the same host. If there are, a new delivery process is started
22729 for one of them, and the current TCP/IP connection is passed on to it. The new
22730 process may in turn send multiple copies and possibly create yet another
22731 process.
22732 .endlist
22733
22734
22735 For each copy sent over the same TCP/IP connection, a sequence counter is
22736 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22737 no further messages are sent over that connection.
22738
22739
22740
22741 .section "Use of the $host and $host_address variables" "SECID145"
22742 .vindex "&$host$&"
22743 .vindex "&$host_address$&"
22744 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22745 &$host_address$& are the name and IP address of the first host on the host list
22746 passed by the router. However, when the transport is about to connect to a
22747 specific host, and while it is connected to that host, &$host$& and
22748 &$host_address$& are set to the values for that host. These are the values
22749 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22750 &%serialize_hosts%&, and the various TLS options are expanded.
22751
22752
22753 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22754 .vindex &$tls_bits$&
22755 .vindex &$tls_cipher$&
22756 .vindex &$tls_peerdn$&
22757 .vindex &$tls_sni$&
22758 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22759 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22760 are the values that were set when the message was received.
22761 These are the values that are used for options that are expanded before any
22762 SMTP connections are made. Just before each connection is made, these four
22763 variables are emptied. If TLS is subsequently started, they are set to the
22764 appropriate values for the outgoing connection, and these are the values that
22765 are in force when any authenticators are run and when the
22766 &%authenticated_sender%& option is expanded.
22767
22768 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22769 and will be removed in a future release.
22770
22771
22772 .section "Private options for smtp" "SECID146"
22773 .cindex "options" "&(smtp)& transport"
22774 The private options of the &(smtp)& transport are as follows:
22775
22776
22777 .option address_retry_include_sender smtp boolean true
22778 .cindex "4&'xx'& responses" "retrying after"
22779 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22780 is the combination of sender and recipient that is delayed in subsequent queue
22781 runs until the retry time is reached. You can delay the recipient without
22782 reference to the sender (which is what earlier versions of Exim did), by
22783 setting &%address_retry_include_sender%& false. However, this can lead to
22784 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22785
22786 .option allow_localhost smtp boolean false
22787 .cindex "local host" "sending to"
22788 .cindex "fallback" "hosts specified on transport"
22789 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22790 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22791 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22792 the delivery anyway. This should be used only in special cases when the
22793 configuration ensures that no looping will result (for example, a differently
22794 configured Exim is listening on the port to which the message is sent).
22795
22796
22797 .option authenticated_sender smtp string&!! unset
22798 .cindex "Cyrus"
22799 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22800 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22801 overriding any existing authenticated sender value. If the string expansion is
22802 forced to fail, the option is ignored. Other expansion failures cause delivery
22803 to be deferred. If the result of expansion is an empty string, that is also
22804 ignored.
22805
22806 The expansion happens after the outgoing connection has been made and TLS
22807 started, if required. This means that the &$host$&, &$host_address$&,
22808 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22809 particular connection.
22810
22811 If the SMTP session is not authenticated, the expansion of
22812 &%authenticated_sender%& still happens (and can cause the delivery to be
22813 deferred if it fails), but no AUTH= item is added to MAIL commands
22814 unless &%authenticated_sender_force%& is true.
22815
22816 This option allows you to use the &(smtp)& transport in LMTP mode to
22817 deliver mail to Cyrus IMAP and provide the proper local part as the
22818 &"authenticated sender"&, via a setting such as:
22819 .code
22820 authenticated_sender = $local_part
22821 .endd
22822 This removes the need for IMAP subfolders to be assigned special ACLs to
22823 allow direct delivery to those subfolders.
22824
22825 Because of expected uses such as that just described for Cyrus (when no
22826 domain is involved), there is no checking on the syntax of the provided
22827 value.
22828
22829
22830 .option authenticated_sender_force smtp boolean false
22831 If this option is set true, the &%authenticated_sender%& option's value
22832 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22833 authenticated as a client.
22834
22835
22836 .option command_timeout smtp time 5m
22837 This sets a timeout for receiving a response to an SMTP command that has been
22838 sent out. It is also used when waiting for the initial banner line from the
22839 remote host. Its value must not be zero.
22840
22841
22842 .option connect_timeout smtp time 5m
22843 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22844 to a remote host. A setting of zero allows the system timeout (typically
22845 several minutes) to act. To have any effect, the value of this option must be
22846 less than the system timeout. However, it has been observed that on some
22847 systems there is no system timeout, which is why the default value for this
22848 option is 5 minutes, a value recommended by RFC 1123.
22849
22850
22851 .option connection_max_messages smtp integer 500
22852 .cindex "SMTP" "passed connection"
22853 .cindex "SMTP" "multiple deliveries"
22854 .cindex "multiple SMTP deliveries"
22855 This controls the maximum number of separate message deliveries that are sent
22856 over a single TCP/IP connection. If the value is zero, there is no limit.
22857 For testing purposes, this value can be overridden by the &%-oB%& command line
22858 option.
22859
22860
22861 .option data_timeout smtp time 5m
22862 This sets a timeout for the transmission of each block in the data portion of
22863 the message. As a result, the overall timeout for a message depends on the size
22864 of the message. Its value must not be zero. See also &%final_timeout%&.
22865
22866
22867 .option delay_after_cutoff smtp boolean true
22868 This option controls what happens when all remote IP addresses for a given
22869 domain have been inaccessible for so long that they have passed their retry
22870 cutoff times.
22871
22872 In the default state, if the next retry time has not been reached for any of
22873 them, the address is bounced without trying any deliveries. In other words,
22874 Exim delays retrying an IP address after the final cutoff time until a new
22875 retry time is reached, and can therefore bounce an address without ever trying
22876 a delivery, when machines have been down for a long time. Some people are
22877 unhappy at this prospect, so...
22878
22879 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22880 addresses are past their final cutoff time, Exim tries to deliver to those
22881 IP addresses that have not been tried since the message arrived. If there are
22882 none, of if they all fail, the address is bounced. In other words, it does not
22883 delay when a new message arrives, but immediately tries those expired IP
22884 addresses that haven't been tried since the message arrived. If there is a
22885 continuous stream of messages for the dead hosts, unsetting
22886 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22887 to them.
22888
22889
22890 .option dns_qualify_single smtp boolean true
22891 If the &%hosts%& or &%fallback_hosts%& option is being used,
22892 and the &%gethostbyname%& option is false,
22893 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22894 in chapter &<<CHAPdnslookup>>& for more details.
22895
22896
22897 .option dns_search_parents smtp boolean false
22898 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22899 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22900 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22901 details.
22902
22903
22904 .option dnssec_request_domains smtp "domain list&!!" unset
22905 .cindex "MX record" "security"
22906 .cindex "DNSSEC" "MX lookup"
22907 .cindex "security" "MX lookup"
22908 .cindex "DNS" "DNSSEC"
22909 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22910 the dnssec request bit set.
22911 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22912
22913
22914
22915 .option dnssec_require_domains smtp "domain list&!!" unset
22916 .cindex "MX record" "security"
22917 .cindex "DNSSEC" "MX lookup"
22918 .cindex "security" "MX lookup"
22919 .cindex "DNS" "DNSSEC"
22920 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22921 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22922 (AD bit) set wil be ignored and logged as a host-lookup failure.
22923 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22924
22925
22926
22927 .option dscp smtp string&!! unset
22928 .cindex "DCSP" "outbound"
22929 This option causes the DSCP value associated with a socket to be set to one
22930 of a number of fixed strings or to numeric value.
22931 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22932 Common values include &`throughput`&, &`mincost`&, and on newer systems
22933 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22934
22935 The outbound packets from Exim will be marked with this value in the header
22936 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22937 that these values will have any effect, not be stripped by networking
22938 equipment, or do much of anything without cooperation with your Network
22939 Engineer and those of all network operators between the source and destination.
22940
22941
22942 .option fallback_hosts smtp "string list" unset
22943 .cindex "fallback" "hosts specified on transport"
22944 String expansion is not applied to this option. The argument must be a
22945 colon-separated list of host names or IP addresses, optionally also including
22946 port numbers, though the separator can be changed, as described in section
22947 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22948 item in a &%route_list%& setting for the &(manualroute)& router, as described
22949 in section &<<SECTformatonehostitem>>&.
22950
22951 Fallback hosts can also be specified on routers, which associate them with the
22952 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22953 &%fallback_hosts%& specified on the transport is used only if the address does
22954 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22955 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22956 However, &%hosts_randomize%& does apply to fallback host lists.
22957
22958 If Exim is unable to deliver to any of the hosts for a particular address, and
22959 the errors are not permanent rejections, the address is put on a separate
22960 transport queue with its host list replaced by the fallback hosts, unless the
22961 address was routed via MX records and the current host was in the original MX
22962 list. In that situation, the fallback host list is not used.
22963
22964 Once normal deliveries are complete, the fallback queue is delivered by
22965 re-running the same transports with the new host lists. If several failing
22966 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22967 copy of the message is sent.
22968
22969 The resolution of the host names on the fallback list is controlled by the
22970 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22971 both to cases when the host list comes with the address and when it is taken
22972 from &%hosts%&. This option provides a &"use a smart host only if delivery
22973 fails"& facility.
22974
22975
22976 .option final_timeout smtp time 10m
22977 This is the timeout that applies while waiting for the response to the final
22978 line containing just &"."& that terminates a message. Its value must not be
22979 zero.
22980
22981 .option gethostbyname smtp boolean false
22982 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22983 being used, names are looked up using &[gethostbyname()]&
22984 (or &[getipnodebyname()]& when available)
22985 instead of using the DNS. Of course, that function may in fact use the DNS, but
22986 it may also consult other sources of information such as &_/etc/hosts_&.
22987
22988 .option gnutls_compat_mode smtp boolean unset
22989 This option controls whether GnuTLS is used in compatibility mode in an Exim
22990 server. This reduces security slightly, but improves interworking with older
22991 implementations of TLS.
22992
22993 .option helo_data smtp string&!! "see below"
22994 .cindex "HELO" "argument, setting"
22995 .cindex "EHLO" "argument, setting"
22996 .cindex "LHLO argument setting"
22997 The value of this option is expanded after a connection to a another host has
22998 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22999 command that starts the outgoing SMTP or LMTP session. The default value of the
23000 option is:
23001 .code
23002 $primary_hostname
23003 .endd
23004 During the expansion, the variables &$host$& and &$host_address$& are set to
23005 the identity of the remote host, and the variables &$sending_ip_address$& and
23006 &$sending_port$& are set to the local IP address and port number that are being
23007 used. These variables can be used to generate different values for different
23008 servers or different local IP addresses. For example, if you want the string
23009 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23010 interface address, you could use this:
23011 .code
23012 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23013   {$primary_hostname}}
23014 .endd
23015 The use of &%helo_data%& applies both to sending messages and when doing
23016 callouts.
23017
23018 .option hosts smtp "string list&!!" unset
23019 Hosts are associated with an address by a router such as &(dnslookup)&, which
23020 finds the hosts by looking up the address domain in the DNS, or by
23021 &(manualroute)&, which has lists of hosts in its configuration. However,
23022 email addresses can be passed to the &(smtp)& transport by any router, and not
23023 all of them can provide an associated list of hosts.
23024
23025 The &%hosts%& option specifies a list of hosts to be used if the address being
23026 processed does not have any hosts associated with it. The hosts specified by
23027 &%hosts%& are also used, whether or not the address has its own hosts, if
23028 &%hosts_override%& is set.
23029
23030 The string is first expanded, before being interpreted as a colon-separated
23031 list of host names or IP addresses, possibly including port numbers. The
23032 separator may be changed to something other than colon, as described in section
23033 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23034 item in a &%route_list%& setting for the &(manualroute)& router, as described
23035 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23036 of the &(manualroute)& router is not available here.
23037
23038 If the expansion fails, delivery is deferred. Unless the failure was caused by
23039 the inability to complete a lookup, the error is logged to the panic log as
23040 well as the main log. Host names are looked up either by searching directly for
23041 address records in the DNS or by calling &[gethostbyname()]& (or
23042 &[getipnodebyname()]& when available), depending on the setting of the
23043 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23044 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23045 address are used.
23046
23047 During delivery, the hosts are tried in order, subject to their retry status,
23048 unless &%hosts_randomize%& is set.
23049
23050
23051 .option hosts_avoid_esmtp smtp "host list&!!" unset
23052 .cindex "ESMTP, avoiding use of"
23053 .cindex "HELO" "forcing use of"
23054 .cindex "EHLO" "avoiding use of"
23055 .cindex "PIPELINING" "avoiding the use of"
23056 This option is for use with broken hosts that announce ESMTP facilities (for
23057 example, PIPELINING) and then fail to implement them properly. When a host
23058 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23059 start of the SMTP session. This means that it cannot use any of the ESMTP
23060 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23061
23062
23063 .option hosts_avoid_pipelining smtp "host list&!!" unset
23064 .cindex "PIPELINING" "avoiding the use of"
23065 Exim will not use the SMTP PIPELINING extension when delivering to any host
23066 that matches this list, even if the server host advertises PIPELINING support.
23067
23068
23069 .option hosts_avoid_tls smtp "host list&!!" unset
23070 .cindex "TLS" "avoiding for certain hosts"
23071 Exim will not try to start a TLS session when delivering to any host that
23072 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23073
23074 .option hosts_verify_avoid_tls smtp "host list&!!" *
23075 .cindex "TLS" "avoiding for certain hosts"
23076 Exim will not try to start a TLS session for a verify callout,
23077 or when delivering in cutthrough mode,
23078 to any host that matches this list.
23079 Note that the default is to not use TLS.
23080
23081
23082 .option hosts_max_try smtp integer 5
23083 .cindex "host" "maximum number to try"
23084 .cindex "limit" "number of hosts tried"
23085 .cindex "limit" "number of MX tried"
23086 .cindex "MX record" "maximum tried"
23087 This option limits the number of IP addresses that are tried for any one
23088 delivery in cases where there are temporary delivery errors. Section
23089 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23090
23091
23092 .option hosts_max_try_hardlimit smtp integer 50
23093 This is an additional check on the maximum number of IP addresses that Exim
23094 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23095 why it exists.
23096
23097
23098
23099 .option hosts_nopass_tls smtp "host list&!!" unset
23100 .cindex "TLS" "passing connection"
23101 .cindex "multiple SMTP deliveries"
23102 .cindex "TLS" "multiple message deliveries"
23103 For any host that matches this list, a connection on which a TLS session has
23104 been started will not be passed to a new delivery process for sending another
23105 message on the same connection. See section &<<SECTmulmessam>>& for an
23106 explanation of when this might be needed.
23107
23108
23109 .option hosts_override smtp boolean false
23110 If this option is set and the &%hosts%& option is also set, any hosts that are
23111 attached to the address are ignored, and instead the hosts specified by the
23112 &%hosts%& option are always used. This option does not apply to
23113 &%fallback_hosts%&.
23114
23115
23116 .option hosts_randomize smtp boolean false
23117 .cindex "randomized host list"
23118 .cindex "host" "list of; randomized"
23119 .cindex "fallback" "randomized hosts"
23120 If this option is set, and either the list of hosts is taken from the
23121 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23122 were not obtained from MX records (this includes fallback hosts from the
23123 router), and were not randomized by the router, the order of trying the hosts
23124 is randomized each time the transport runs. Randomizing the order of a host
23125 list can be used to do crude load sharing.
23126
23127 When &%hosts_randomize%& is true, a host list may be split into groups whose
23128 order is separately randomized. This makes it possible to set up MX-like
23129 behaviour. The boundaries between groups are indicated by an item that is just
23130 &`+`& in the host list. For example:
23131 .code
23132 hosts = host1:host2:host3:+:host4:host5
23133 .endd
23134 The order of the first three hosts and the order of the last two hosts is
23135 randomized for each use, but the first three always end up before the last two.
23136 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23137
23138 .option hosts_require_auth smtp "host list&!!" unset
23139 .cindex "authentication" "required by client"
23140 This option provides a list of servers for which authentication must succeed
23141 before Exim will try to transfer a message. If authentication fails for
23142 servers which are not in this list, Exim tries to send unauthenticated. If
23143 authentication fails for one of these servers, delivery is deferred. This
23144 temporary error is detectable in the retry rules, so it can be turned into a
23145 hard failure if required. See also &%hosts_try_auth%&, and chapter
23146 &<<CHAPSMTPAUTH>>& for details of authentication.
23147
23148
23149 .option hosts_request_ocsp smtp "host list&!!" *
23150 .cindex "TLS" "requiring for certain servers"
23151 Exim will request a Certificate Status on a
23152 TLS session for any host that matches this list.
23153 &%tls_verify_certificates%& should also be set for the transport.
23154
23155 .option hosts_require_ocsp smtp "host list&!!" unset
23156 .cindex "TLS" "requiring for certain servers"
23157 Exim will request, and check for a valid Certificate Status being given, on a
23158 TLS session for any host that matches this list.
23159 &%tls_verify_certificates%& should also be set for the transport.
23160
23161 .option hosts_require_tls smtp "host list&!!" unset
23162 .cindex "TLS" "requiring for certain servers"
23163 Exim will insist on using a TLS session when delivering to any host that
23164 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23165 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23166 incoming messages, use an appropriate ACL.
23167
23168 .option hosts_try_auth smtp "host list&!!" unset
23169 .cindex "authentication" "optional in client"
23170 This option provides a list of servers to which, provided they announce
23171 authentication support, Exim will attempt to authenticate as a client when it
23172 connects. If authentication fails, Exim will try to transfer the message
23173 unauthenticated. See also &%hosts_require_auth%&, and chapter
23174 &<<CHAPSMTPAUTH>>& for details of authentication.
23175
23176 .option hosts_try_prdr smtp "host list&!!" unset
23177 .cindex "PRDR" "enabling, optional in client"
23178 This option provides a list of servers to which, provided they announce
23179 PRDR support, Exim will attempt to negotiate PRDR
23180 for multi-recipient messages.
23181
23182 .option interface smtp "string list&!!" unset
23183 .cindex "bind IP address"
23184 .cindex "IP address" "binding"
23185 .vindex "&$host$&"
23186 .vindex "&$host_address$&"
23187 This option specifies which interface to bind to when making an outgoing SMTP
23188 call. The value is an IP address, not an interface name such as
23189 &`eth0`&. Do not confuse this with the interface address that was used when a
23190 message was received, which is in &$received_ip_address$&, formerly known as
23191 &$interface_address$&. The name was changed to minimize confusion with the
23192 outgoing interface address. There is no variable that contains an outgoing
23193 interface address because, unless it is set by this option, its value is
23194 unknown.
23195
23196 During the expansion of the &%interface%& option the variables &$host$& and
23197 &$host_address$& refer to the host to which a connection is about to be made
23198 during the expansion of the string. Forced expansion failure, or an empty
23199 string result causes the option to be ignored. Otherwise, after expansion, the
23200 string must be a list of IP addresses, colon-separated by default, but the
23201 separator can be changed in the usual way. For example:
23202 .code
23203 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23204 .endd
23205 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23206 connection. If none of them are the correct type, the option is ignored. If
23207 &%interface%& is not set, or is ignored, the system's IP functions choose which
23208 interface to use if the host has more than one.
23209
23210
23211 .option keepalive smtp boolean true
23212 .cindex "keepalive" "on outgoing connection"
23213 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23214 connections. When set, it causes the kernel to probe idle connections
23215 periodically, by sending packets with &"old"& sequence numbers. The other end
23216 of the connection should send a acknowledgment if the connection is still okay
23217 or a reset if the connection has been aborted. The reason for doing this is
23218 that it has the beneficial effect of freeing up certain types of connection
23219 that can get stuck when the remote host is disconnected without tidying up the
23220 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23221 unreachable hosts.
23222
23223
23224 .option lmtp_ignore_quota smtp boolean false
23225 .cindex "LMTP" "ignoring quota errors"
23226 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23227 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23228 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23229
23230 .option max_rcpt smtp integer 100
23231 .cindex "RCPT" "maximum number of outgoing"
23232 This option limits the number of RCPT commands that are sent in a single
23233 SMTP message transaction. Each set of addresses is treated independently, and
23234 so can cause parallel connections to the same host if &%remote_max_parallel%&
23235 permits this.
23236
23237
23238 .option multi_domain smtp boolean true
23239 .vindex "&$domain$&"
23240 When this option is set, the &(smtp)& transport can handle a number of
23241 addresses containing a mixture of different domains provided they all resolve
23242 to the same list of hosts. Turning the option off restricts the transport to
23243 handling only one domain at a time. This is useful if you want to use
23244 &$domain$& in an expansion for the transport, because it is set only when there
23245 is a single domain involved in a remote delivery.
23246
23247
23248 .option port smtp string&!! "see below"
23249 .cindex "port" "sending TCP/IP"
23250 .cindex "TCP/IP" "setting outgoing port"
23251 This option specifies the TCP/IP port on the server to which Exim connects.
23252 &*Note:*& Do not confuse this with the port that was used when a message was
23253 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23254 The name was changed to minimize confusion with the outgoing port. There is no
23255 variable that contains an outgoing port.
23256
23257 If the value of this option begins with a digit it is taken as a port number;
23258 otherwise it is looked up using &[getservbyname()]&. The default value is
23259 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23260 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23261 is deferred.
23262
23263
23264
23265 .option protocol smtp string smtp
23266 .cindex "LMTP" "over TCP/IP"
23267 .cindex "ssmtp protocol" "outbound"
23268 .cindex "TLS" "SSL-on-connect outbound"
23269 .vindex "&$port$&"
23270 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23271 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23272 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23273 deliveries into closed message stores. Exim also has support for running LMTP
23274 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23275
23276 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23277 changes to &"smtps"&, and the transport initiates TLS immediately after
23278 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23279 The Internet standards bodies strongly discourage use of this mode.
23280
23281
23282 .option retry_include_ip_address smtp boolean true
23283 Exim normally includes both the host name and the IP address in the key it
23284 constructs for indexing retry data after a temporary delivery failure. This
23285 means that when one of several IP addresses for a host is failing, it gets
23286 tried periodically (controlled by the retry rules), but use of the other IP
23287 addresses is not affected.
23288
23289 However, in some dialup environments hosts are assigned a different IP address
23290 each time they connect. In this situation the use of the IP address as part of
23291 the retry key leads to undesirable behaviour. Setting this option false causes
23292 Exim to use only the host name. This should normally be done on a separate
23293 instance of the &(smtp)& transport, set up specially to handle the dialup
23294 hosts.
23295
23296
23297 .option serialize_hosts smtp "host list&!!" unset
23298 .cindex "serializing connections"
23299 .cindex "host" "serializing connections"
23300 Because Exim operates in a distributed manner, if several messages for the same
23301 host arrive at around the same time, more than one simultaneous connection to
23302 the remote host can occur. This is not usually a problem except when there is a
23303 slow link between the hosts. In that situation it may be helpful to restrict
23304 Exim to one connection at a time. This can be done by setting
23305 &%serialize_hosts%& to match the relevant hosts.
23306
23307 .cindex "hints database" "serializing deliveries to a host"
23308 Exim implements serialization by means of a hints database in which a record is
23309 written whenever a process connects to one of the restricted hosts. The record
23310 is deleted when the connection is completed. Obviously there is scope for
23311 records to get left lying around if there is a system or program crash. To
23312 guard against this, Exim ignores any records that are more than six hours old.
23313
23314 If you set up this kind of serialization, you should also arrange to delete the
23315 relevant hints database whenever your system reboots. The names of the files
23316 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23317 may be one or two files, depending on the type of DBM in use. The same files
23318 are used for ETRN serialization.
23319
23320
23321 .option size_addition smtp integer 1024
23322 .cindex "SMTP" "SIZE"
23323 .cindex "message" "size issue for transport filter"
23324 .cindex "size" "of message"
23325 .cindex "transport" "filter"
23326 .cindex "filter" "transport filter"
23327 If a remote SMTP server indicates that it supports the SIZE option of the
23328 MAIL command, Exim uses this to pass over the message size at the start of
23329 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23330 sends, to allow for headers and other text that may be added during delivery by
23331 configuration options or in a transport filter. It may be necessary to increase
23332 this if a lot of text is added to messages.
23333
23334 Alternatively, if the value of &%size_addition%& is set negative, it disables
23335 the use of the SIZE option altogether.
23336
23337
23338 .option tls_certificate smtp string&!! unset
23339 .cindex "TLS" "client certificate, location of"
23340 .cindex "certificate" "client, location of"
23341 .vindex "&$host$&"
23342 .vindex "&$host_address$&"
23343 The value of this option must be the absolute path to a file which contains the
23344 client's certificate, for possible use when sending a message over an encrypted
23345 connection. The values of &$host$& and &$host_address$& are set to the name and
23346 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23347 details of TLS.
23348
23349 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23350 certificate when sending messages as a client. The global option of the same
23351 name specifies the certificate for Exim as a server; it is not automatically
23352 assumed that the same certificate should be used when Exim is operating as a
23353 client.
23354
23355
23356 .option tls_crl smtp string&!! unset
23357 .cindex "TLS" "client certificate revocation list"
23358 .cindex "certificate" "revocation list for client"
23359 This option specifies a certificate revocation list. The expanded value must
23360 be the name of a file that contains a CRL in PEM format.
23361
23362
23363 .option tls_dh_min_bits smtp integer 1024
23364 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23365 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23366 key agreement is negotiated, the server will provide a large prime number
23367 for use.  This option establishes the minimum acceptable size of that number.
23368 If the parameter offered by the server is too small, then the TLS handshake
23369 will fail.
23370
23371 Only supported when using GnuTLS.
23372
23373
23374 .option tls_privatekey smtp string&!! unset
23375 .cindex "TLS" "client private key, location of"
23376 .vindex "&$host$&"
23377 .vindex "&$host_address$&"
23378 The value of this option must be the absolute path to a file which contains the
23379 client's private key. This is used when sending a message over an encrypted
23380 connection using a client certificate. The values of &$host$& and
23381 &$host_address$& are set to the name and address of the server during the
23382 expansion. If this option is unset, or the expansion is forced to fail, or the
23383 result is an empty string, the private key is assumed to be in the same file as
23384 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23385
23386
23387 .option tls_require_ciphers smtp string&!! unset
23388 .cindex "TLS" "requiring specific ciphers"
23389 .cindex "cipher" "requiring specific"
23390 .vindex "&$host$&"
23391 .vindex "&$host_address$&"
23392 The value of this option must be a list of permitted cipher suites, for use
23393 when setting up an outgoing encrypted connection. (There is a global option of
23394 the same name for controlling incoming connections.) The values of &$host$& and
23395 &$host_address$& are set to the name and address of the server during the
23396 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23397 is used in different ways by OpenSSL and GnuTLS (see sections
23398 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23399 ciphers is a preference order.
23400
23401
23402
23403 .option tls_sni smtp string&!! unset
23404 .cindex "TLS" "Server Name Indication"
23405 .vindex "&$tls_sni$&"
23406 If this option is set then it sets the $tls_out_sni variable and causes any
23407 TLS session to pass this value as the Server Name Indication extension to
23408 the remote side, which can be used by the remote side to select an appropriate
23409 certificate and private key for the session.
23410
23411 See &<<SECTtlssni>>& for more information.
23412
23413 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23414 TLS extensions.
23415
23416
23417
23418
23419 .option tls_tempfail_tryclear smtp boolean true
23420 .cindex "4&'xx'& responses" "to STARTTLS"
23421 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23422 setting up a TLS session, this option determines whether or not Exim should try
23423 to deliver the message unencrypted. If it is set false, delivery to the
23424 current host is deferred; if there are other hosts, they are tried. If this
23425 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23426 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23427 TLS negotiation fails, Exim closes the current connection (because it is in an
23428 unknown state), opens a new one to the same host, and then tries the delivery
23429 in clear.
23430
23431
23432 .option tls_try_verify_hosts smtp "host list&!! unset
23433 .cindex "TLS" "server certificate verification"
23434 .cindex "certificate" "verification of server"
23435 This option gives a list of hosts for which, on encrypted connections,
23436 certificate verification will be tried but need not succeed.
23437 The &%tls_verify_certificates%& option must also be set.
23438 Note that unless the host is in this list
23439 TLS connections will be denied to hosts using self-signed certificates
23440 when &%tls_verify_certificates%& is set.
23441 The &$tls_out_certificate_verified$& variable is set when
23442 certificate verification succeeds.
23443
23444
23445 .option tls_verify_certificates smtp string&!! unset
23446 .cindex "TLS" "server certificate verification"
23447 .cindex "certificate" "verification of server"
23448 .vindex "&$host$&"
23449 .vindex "&$host_address$&"
23450 The value of this option must be the absolute path to a file containing
23451 permitted server certificates, for use when setting up an encrypted connection.
23452 Alternatively,
23453 if you are using either GnuTLS version 3.3.6 (or later) or OpenSSL,
23454 you can set
23455 &%tls_verify_certificates%& to the name of a directory containing certificate
23456 files.
23457 For earlier versions of GnuTLS the option must be set to the name of a
23458 single file.
23459 The values of &$host$& and
23460 &$host_address$& are set to the name and address of the server during the
23461 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23462
23463 For back-compatability,
23464 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23465 and certificate verification fails the TLS connection is closed.
23466
23467
23468 .option tls_verify_hosts smtp "host list&!! unset
23469 .cindex "TLS" "server certificate verification"
23470 .cindex "certificate" "verification of server"
23471 This option gives a list of hosts for which. on encrypted connections,
23472 certificate verification must succeed.
23473 The &%tls_verify_certificates%& option must also be set.
23474 If both this option and &%tls_try_verify_hosts%& are unset
23475 operation is as if this option selected all hosts.
23476
23477
23478
23479
23480 .section "How the limits for the number of hosts to try are used" &&&
23481          "SECTvalhosmax"
23482 .cindex "host" "maximum number to try"
23483 .cindex "limit" "hosts; maximum number tried"
23484 There are two options that are concerned with the number of hosts that are
23485 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23486 &%hosts_max_try_hardlimit%&.
23487
23488
23489 The &%hosts_max_try%& option limits the number of hosts that are tried
23490 for a single delivery. However, despite the term &"host"& in its name, the
23491 option actually applies to each IP address independently. In other words, a
23492 multihomed host is treated as several independent hosts, just as it is for
23493 retrying.
23494
23495 Many of the larger ISPs have multiple MX records which often point to
23496 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23497 created as a result of routing one of these domains.
23498
23499 Trying every single IP address on such a long list does not seem sensible; if
23500 several at the top of the list fail, it is reasonable to assume there is some
23501 problem that is likely to affect all of them. Roughly speaking, the value of
23502 &%hosts_max_try%& is the maximum number that are tried before deferring the
23503 delivery. However, the logic cannot be quite that simple.
23504
23505 Firstly, IP addresses that are skipped because their retry times have not
23506 arrived do not count, and in addition, addresses that are past their retry
23507 limits are also not counted, even when they are tried. This means that when
23508 some IP addresses are past their retry limits, more than the value of
23509 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23510 that all IP addresses are considered before timing out an email address (but
23511 see below for an exception).
23512
23513 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23514 list to see if there is a subsequent host with a different (higher valued) MX.
23515 If there is, that host is considered next, and the current IP address is used
23516 but not counted. This behaviour helps in the case of a domain with a retry rule
23517 that hardly ever delays any hosts, as is now explained:
23518
23519 Consider the case of a long list of hosts with one MX value, and a few with a
23520 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23521 hosts at the top of the list are tried at first. With the default retry rule,
23522 which specifies increasing retry times, the higher MX hosts are eventually
23523 tried when those at the top of the list are skipped because they have not
23524 reached their retry times.
23525
23526 However, it is common practice to put a fixed short retry time on domains for
23527 large ISPs, on the grounds that their servers are rarely down for very long.
23528 Unfortunately, these are exactly the domains that tend to resolve to long lists
23529 of hosts. The short retry time means that the lowest MX hosts are tried every
23530 time. The attempts may be in a different order because of random sorting, but
23531 without the special MX check, the higher MX hosts would never be tried until
23532 all the lower MX hosts had timed out (which might be several days), because
23533 there are always some lower MX hosts that have reached their retry times. With
23534 the special check, Exim considers at least one IP address from each MX value at
23535 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23536 reached.
23537
23538 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23539 particular, Exim normally eventually tries all the IP addresses before timing
23540 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23541 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23542 been set up with hundreds of IP addresses for some domains. It can
23543 take a very long time indeed for an address to time out in these cases.
23544
23545 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23546 Exim never tries more than this number of IP addresses; if it hits this limit
23547 and they are all timed out, the email address is bounced, even though not all
23548 possible IP addresses have been tried.
23549 .ecindex IIDsmttra1
23550 .ecindex IIDsmttra2
23551
23552
23553
23554
23555
23556 . ////////////////////////////////////////////////////////////////////////////
23557 . ////////////////////////////////////////////////////////////////////////////
23558
23559 .chapter "Address rewriting" "CHAPrewrite"
23560 .scindex IIDaddrew "rewriting" "addresses"
23561 There are some circumstances in which Exim automatically rewrites domains in
23562 addresses. The two most common are when an address is given without a domain
23563 (referred to as an &"unqualified address"&) or when an address contains an
23564 abbreviated domain that is expanded by DNS lookup.
23565
23566 Unqualified envelope addresses are accepted only for locally submitted
23567 messages, or for messages that are received from hosts matching
23568 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23569 appropriate. Unqualified addresses in header lines are qualified if they are in
23570 locally submitted messages, or messages from hosts that are permitted to send
23571 unqualified envelope addresses. Otherwise, unqualified addresses in header
23572 lines are neither qualified nor rewritten.
23573
23574 One situation in which Exim does &'not'& automatically rewrite a domain is
23575 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23576 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23577 do this. The new RFCs do not contain this suggestion.
23578
23579
23580 .section "Explicitly configured address rewriting" "SECID147"
23581 This chapter describes the rewriting rules that can be used in the
23582 main rewrite section of the configuration file, and also in the generic
23583 &%headers_rewrite%& option that can be set on any transport.
23584
23585 Some people believe that configured address rewriting is a Mortal Sin.
23586 Others believe that life is not possible without it. Exim provides the
23587 facility; you do not have to use it.
23588
23589 The main rewriting rules that appear in the &"rewrite"& section of the
23590 configuration file are applied to addresses in incoming messages, both envelope
23591 addresses and addresses in header lines. Each rule specifies the types of
23592 address to which it applies.
23593
23594 Whether or not addresses in header lines are rewritten depends on the origin of
23595 the headers and the type of rewriting. Global rewriting, that is, rewriting
23596 rules from the rewrite section of the configuration file, is applied only to
23597 those headers that were received with the message. Header lines that are added
23598 by ACLs or by a system filter or by individual routers or transports (which
23599 are specific to individual recipient addresses) are not rewritten by the global
23600 rules.
23601
23602 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23603 applies all headers except those added by routers and transports. That is, as
23604 well as the headers that were received with the message, it also applies to
23605 headers that were added by an ACL or a system filter.
23606
23607
23608 In general, rewriting addresses from your own system or domain has some
23609 legitimacy. Rewriting other addresses should be done only with great care and
23610 in special circumstances. The author of Exim believes that rewriting should be
23611 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23612 Although it can sometimes be used as a routing tool, this is very strongly
23613 discouraged.
23614
23615 There are two commonly encountered circumstances where rewriting is used, as
23616 illustrated by these examples:
23617
23618 .ilist
23619 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23620 exchange mail with each other behind a firewall, but there is only a single
23621 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23622 &'hitch.fict.example'& when sending mail off-site.
23623 .next
23624 A host rewrites the local parts of its own users so that, for example,
23625 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23626 .endlist
23627
23628
23629
23630 .section "When does rewriting happen?" "SECID148"
23631 .cindex "rewriting" "timing of"
23632 .cindex "&ACL;" "rewriting addresses in"
23633 Configured address rewriting can take place at several different stages of a
23634 message's processing.
23635
23636 .vindex "&$sender_address$&"
23637 At the start of an ACL for MAIL, the sender address may have been rewritten
23638 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23639 ordinary rewrite rules have yet been applied. If, however, the sender address
23640 is verified in the ACL, it is rewritten before verification, and remains
23641 rewritten thereafter. The subsequent value of &$sender_address$& is the
23642 rewritten address. This also applies if sender verification happens in a
23643 RCPT ACL. Otherwise, when the sender address is not verified, it is
23644 rewritten as soon as a message's header lines have been received.
23645
23646 .vindex "&$domain$&"
23647 .vindex "&$local_part$&"
23648 Similarly, at the start of an ACL for RCPT, the current recipient's address
23649 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23650 rewrite rules have yet been applied to it. However, the behaviour is different
23651 from the sender address when a recipient is verified. The address is rewritten
23652 for the verification, but the rewriting is not remembered at this stage. The
23653 value of &$local_part$& and &$domain$& after verification are always the same
23654 as they were before (that is, they contain the unrewritten &-- except for
23655 SMTP-time rewriting &-- address).
23656
23657 As soon as a message's header lines have been received, all the envelope
23658 recipient addresses are permanently rewritten, and rewriting is also applied to
23659 the addresses in the header lines (if configured). This happens before adding
23660 any header lines that were specified in MAIL or RCPT ACLs, and
23661 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23662 before the DATA ACL and &[local_scan()]& functions are run.
23663
23664 When an address is being routed, either for delivery or for verification,
23665 rewriting is applied immediately to child addresses that are generated by
23666 redirection, unless &%no_rewrite%& is set on the router.
23667
23668 .cindex "envelope sender" "rewriting at transport time"
23669 .cindex "rewriting" "at transport time"
23670 .cindex "header lines" "rewriting at transport time"
23671 At transport time, additional rewriting of addresses in header lines can be
23672 specified by setting the generic &%headers_rewrite%& option on a transport.
23673 This option contains rules that are identical in form to those in the rewrite
23674 section of the configuration file. They are applied to the original message
23675 header lines and any that were added by ACLs or a system filter. They are not
23676 applied to header lines that are added by routers or the transport.
23677
23678 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23679 transport option. However, it is not possible to rewrite envelope recipients at
23680 transport time.
23681
23682
23683
23684
23685 .section "Testing the rewriting rules that apply on input" "SECID149"
23686 .cindex "rewriting" "testing"
23687 .cindex "testing" "rewriting"
23688 Exim's input rewriting configuration appears in a part of the run time
23689 configuration file headed by &"begin rewrite"&. It can be tested by the
23690 &%-brw%& command line option. This takes an address (which can be a full RFC
23691 2822 address) as its argument. The output is a list of how the address would be
23692 transformed by the rewriting rules for each of the different places it might
23693 appear in an incoming message, that is, for each different header and for the
23694 envelope sender and recipient fields. For example,
23695 .code
23696 exim -brw ph10@exim.workshop.example
23697 .endd
23698 might produce the output
23699 .code
23700 sender: Philip.Hazel@exim.workshop.example
23701 from: Philip.Hazel@exim.workshop.example
23702 to: ph10@exim.workshop.example
23703 cc: ph10@exim.workshop.example
23704 bcc: ph10@exim.workshop.example
23705 reply-to: Philip.Hazel@exim.workshop.example
23706 env-from: Philip.Hazel@exim.workshop.example
23707 env-to: ph10@exim.workshop.example
23708 .endd
23709 which shows that rewriting has been set up for that address when used in any of
23710 the source fields, but not when it appears as a recipient address. At the
23711 present time, there is no equivalent way of testing rewriting rules that are
23712 set for a particular transport.
23713
23714
23715 .section "Rewriting rules" "SECID150"
23716 .cindex "rewriting" "rules"
23717 The rewrite section of the configuration file consists of lines of rewriting
23718 rules in the form
23719 .display
23720 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23721 .endd
23722 Rewriting rules that are specified for the &%headers_rewrite%& generic
23723 transport option are given as a colon-separated list. Each item in the list
23724 takes the same form as a line in the main rewriting configuration (except that
23725 any colons must be doubled, of course).
23726
23727 The formats of source patterns and replacement strings are described below.
23728 Each is terminated by white space, unless enclosed in double quotes, in which
23729 case normal quoting conventions apply inside the quotes. The flags are single
23730 characters which may appear in any order. Spaces and tabs between them are
23731 ignored.
23732
23733 For each address that could potentially be rewritten, the rules are scanned in
23734 order, and replacements for the address from earlier rules can themselves be
23735 replaced by later rules (but see the &"q"& and &"R"& flags).
23736
23737 The order in which addresses are rewritten is undefined, may change between
23738 releases, and must not be relied on, with one exception: when a message is
23739 received, the envelope sender is always rewritten first, before any header
23740 lines are rewritten. For example, the replacement string for a rewrite of an
23741 address in &'To:'& must not assume that the message's address in &'From:'& has
23742 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23743 that the envelope sender has already been rewritten.
23744
23745 .vindex "&$domain$&"
23746 .vindex "&$local_part$&"
23747 The variables &$local_part$& and &$domain$& can be used in the replacement
23748 string to refer to the address that is being rewritten. Note that lookup-driven
23749 rewriting can be done by a rule of the form
23750 .code
23751 *@*   ${lookup ...
23752 .endd
23753 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23754 refer to the address that is being rewritten.
23755
23756
23757 .section "Rewriting patterns" "SECID151"
23758 .cindex "rewriting" "patterns"
23759 .cindex "address list" "in a rewriting pattern"
23760 The source pattern in a rewriting rule is any item which may appear in an
23761 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23762 single-item address list, which means that it is expanded before being tested
23763 against the address. As always, if you use a regular expression as a pattern,
23764 you must take care to escape dollar and backslash characters, or use the &`\N`&
23765 facility to suppress string expansion within the regular expression.
23766
23767 Domains in patterns should be given in lower case. Local parts in patterns are
23768 case-sensitive. If you want to do case-insensitive matching of local parts, you
23769 can use a regular expression that starts with &`^(?i)`&.
23770
23771 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23772 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23773 depending on the type of match which occurred. These can be used in the
23774 replacement string to insert portions of the incoming address. &$0$& always
23775 refers to the complete incoming address. When a regular expression is used, the
23776 numerical variables are set from its capturing subexpressions. For other types
23777 of pattern they are set as follows:
23778
23779 .ilist
23780 If a local part or domain starts with an asterisk, the numerical variables
23781 refer to the character strings matched by asterisks, with &$1$& associated with
23782 the first asterisk, and &$2$& with the second, if present. For example, if the
23783 pattern
23784 .code
23785 *queen@*.fict.example
23786 .endd
23787 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23788 .code
23789 $0 = hearts-queen@wonderland.fict.example
23790 $1 = hearts-
23791 $2 = wonderland
23792 .endd
23793 Note that if the local part does not start with an asterisk, but the domain
23794 does, it is &$1$& that contains the wild part of the domain.
23795
23796 .next
23797 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23798 of the domain are placed in the next available numerical variables. Suppose,
23799 for example, that the address &'foo@bar.baz.example'& is processed by a
23800 rewriting rule of the form
23801 .display
23802 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23803 .endd
23804 and the key in the file that matches the domain is &`*.baz.example`&. Then
23805 .code
23806 $1 = foo
23807 $2 = bar
23808 $3 = baz.example
23809 .endd
23810 If the address &'foo@baz.example'& is looked up, this matches the same
23811 wildcard file entry, and in this case &$2$& is set to the empty string, but
23812 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23813 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23814 whole domain. For non-partial domain lookups, no numerical variables are set.
23815 .endlist
23816
23817
23818 .section "Rewriting replacements" "SECID152"
23819 .cindex "rewriting" "replacements"
23820 If the replacement string for a rule is a single asterisk, addresses that
23821 match the pattern and the flags are &'not'& rewritten, and no subsequent
23822 rewriting rules are scanned. For example,
23823 .code
23824 hatta@lookingglass.fict.example  *  f
23825 .endd
23826 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23827 &'From:'& headers.
23828
23829 .vindex "&$domain$&"
23830 .vindex "&$local_part$&"
23831 If the replacement string is not a single asterisk, it is expanded, and must
23832 yield a fully qualified address. Within the expansion, the variables
23833 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23834 Any letters they contain retain their original case &-- they are not lower
23835 cased. The numerical variables are set up according to the type of pattern that
23836 matched the address, as described above. If the expansion is forced to fail by
23837 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23838 current rule is abandoned, but subsequent rules may take effect. Any other
23839 expansion failure causes the entire rewriting operation to be abandoned, and an
23840 entry written to the panic log.
23841
23842
23843
23844 .section "Rewriting flags" "SECID153"
23845 There are three different kinds of flag that may appear on rewriting rules:
23846
23847 .ilist
23848 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23849 c, f, h, r, s, t.
23850 .next
23851 A flag that specifies rewriting at SMTP time: S.
23852 .next
23853 Flags that control the rewriting process: Q, q, R, w.
23854 .endlist
23855
23856 For rules that are part of the &%headers_rewrite%& generic transport option,
23857 E, F, T, and S are not permitted.
23858
23859
23860
23861 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23862          "SECID154"
23863 .cindex "rewriting" "flags"
23864 If none of the following flag letters, nor the &"S"& flag (see section
23865 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23866 and to both the sender and recipient fields of the envelope, whereas a
23867 transport-time rewriting rule just applies to all headers. Otherwise, the
23868 rewriting rule is skipped unless the relevant addresses are being processed.
23869 .display
23870 &`E`&       rewrite all envelope fields
23871 &`F`&       rewrite the envelope From field
23872 &`T`&       rewrite the envelope To field
23873 &`b`&       rewrite the &'Bcc:'& header
23874 &`c`&       rewrite the &'Cc:'& header
23875 &`f`&       rewrite the &'From:'& header
23876 &`h`&       rewrite all headers
23877 &`r`&       rewrite the &'Reply-To:'& header
23878 &`s`&       rewrite the &'Sender:'& header
23879 &`t`&       rewrite the &'To:'& header
23880 .endd
23881 "All headers" means all of the headers listed above that can be selected
23882 individually, plus their &'Resent-'& versions. It does not include
23883 other headers such as &'Subject:'& etc.
23884
23885 You should be particularly careful about rewriting &'Sender:'& headers, and
23886 restrict this to special known cases in your own domains.
23887
23888
23889 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23890 .cindex "SMTP" "rewriting malformed addresses"
23891 .cindex "RCPT" "rewriting argument of"
23892 .cindex "MAIL" "rewriting argument of"
23893 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23894 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23895 before any other processing; even before syntax checking. The pattern is
23896 required to be a regular expression, and it is matched against the whole of the
23897 data for the command, including any surrounding angle brackets.
23898
23899 .vindex "&$domain$&"
23900 .vindex "&$local_part$&"
23901 This form of rewrite rule allows for the handling of addresses that are not
23902 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23903 input). Because the input is not required to be a syntactically valid address,
23904 the variables &$local_part$& and &$domain$& are not available during the
23905 expansion of the replacement string. The result of rewriting replaces the
23906 original address in the MAIL or RCPT command.
23907
23908
23909 .section "Flags controlling the rewriting process" "SECID155"
23910 There are four flags which control the way the rewriting process works. These
23911 take effect only when a rule is invoked, that is, when the address is of the
23912 correct type (matches the flags) and matches the pattern:
23913
23914 .ilist
23915 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23916 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23917 absence of &"Q"& the rewritten address must always include a domain.
23918 .next
23919 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23920 even if no rewriting actually takes place because of a &"fail"& in the
23921 expansion. The &"q"& flag is not effective if the address is of the wrong type
23922 (does not match the flags) or does not match the pattern.
23923 .next
23924 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23925 address, up to ten times. It can be combined with the &"q"& flag, to stop
23926 rewriting once it fails to match (after at least one successful rewrite).
23927 .next
23928 .cindex "rewriting" "whole addresses"
23929 When an address in a header is rewritten, the rewriting normally applies only
23930 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23931 left unchanged. For example, rewriting might change
23932 .code
23933 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23934 .endd
23935 into
23936 .code
23937 From: Ford Prefect <prefectf@hitch.fict.example>
23938 .endd
23939 .cindex "RFC 2047"
23940 Sometimes there is a need to replace the whole address item, and this can be
23941 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23942 causes an address in a header line to be rewritten, the entire address is
23943 replaced, not just the working part. The replacement must be a complete RFC
23944 2822 address, including the angle brackets if necessary. If text outside angle
23945 brackets contains a character whose value is greater than 126 or less than 32
23946 (except for tab), the text is encoded according to RFC 2047. The character set
23947 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23948
23949 When the &"w"& flag is set on a rule that causes an envelope address to be
23950 rewritten, all but the working part of the replacement address is discarded.
23951 .endlist
23952
23953
23954 .section "Rewriting examples" "SECID156"
23955 Here is an example of the two common rewriting paradigms:
23956 .code
23957 *@*.hitch.fict.example  $1@hitch.fict.example
23958 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23959                      {$value}fail}@hitch.fict.example bctfrF
23960 .endd
23961 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23962 the string expansion to fail if the lookup does not succeed. In this context it
23963 has the effect of leaving the original address unchanged, but Exim goes on to
23964 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23965 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23966 explicitly, which would cause the rewritten address to be the same as before,
23967 at the cost of a small bit of processing. Not supplying either of these is an
23968 error, since the rewritten address would then contain no local part.
23969
23970 The first example above replaces the domain with a superior, more general
23971 domain. This may not be desirable for certain local parts. If the rule
23972 .code
23973 root@*.hitch.fict.example  *
23974 .endd
23975 were inserted before the first rule, rewriting would be suppressed for the
23976 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23977
23978 Rewriting can be made conditional on a number of tests, by making use of
23979 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23980 messages that originate outside the local host:
23981 .code
23982 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23983                          {$1@hitch.fict.example}fail}"
23984 .endd
23985 The replacement string is quoted in this example because it contains white
23986 space.
23987
23988 .cindex "rewriting" "bang paths"
23989 .cindex "bang paths" "rewriting"
23990 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23991 an address it treats it as an unqualified local part which it qualifies with
23992 the local qualification domain (if the source of the message is local or if the
23993 remote host is permitted to send unqualified addresses). Rewriting can
23994 sometimes be used to handle simple bang paths with a fixed number of
23995 components. For example, the rule
23996 .code
23997 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23998 .endd
23999 rewrites a two-component bang path &'host.name!user'& as the domain address
24000 &'user@host.name'&. However, there is a security implication in using this as
24001 a global rewriting rule for envelope addresses. It can provide a backdoor
24002 method for using your system as a relay, because the incoming addresses appear
24003 to be local. If the bang path addresses are received via SMTP, it is safer to
24004 use the &"S"& flag to rewrite them as they are received, so that relay checking
24005 can be done on the rewritten addresses.
24006 .ecindex IIDaddrew
24007
24008
24009
24010
24011
24012 . ////////////////////////////////////////////////////////////////////////////
24013 . ////////////////////////////////////////////////////////////////////////////
24014
24015 .chapter "Retry configuration" "CHAPretry"
24016 .scindex IIDretconf1 "retry" "configuration, description of"
24017 .scindex IIDregconf2 "configuration file" "retry section"
24018 The &"retry"& section of the runtime configuration file contains a list of
24019 retry rules that control how often Exim tries to deliver messages that cannot
24020 be delivered at the first attempt. If there are no retry rules (the section is
24021 empty or not present), there are no retries. In this situation, temporary
24022 errors are treated as permanent. The default configuration contains a single,
24023 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24024 line option can be used to test which retry rule will be used for a given
24025 address, domain and error.
24026
24027 The most common cause of retries is temporary failure to deliver to a remote
24028 host because the host is down, or inaccessible because of a network problem.
24029 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24030 address) basis, not on a per-message basis. Thus, if one message has recently
24031 been delayed, delivery of a new message to the same host is not immediately
24032 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24033 log selector is set, the message
24034 .cindex "retry" "time not reached"
24035 &"retry time not reached"& is written to the main log whenever a delivery is
24036 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24037 the handling of errors during remote deliveries.
24038
24039 Retry processing applies to routing as well as to delivering, except as covered
24040 in the next paragraph. The retry rules do not distinguish between these
24041 actions. It is not possible, for example, to specify different behaviour for
24042 failures to route the domain &'snark.fict.example'& and failures to deliver to
24043 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24044 added complication, so did not implement it. However, although they share the
24045 same retry rule, the actual retry times for routing and transporting a given
24046 domain are maintained independently.
24047
24048 When a delivery is not part of a queue run (typically an immediate delivery on
24049 receipt of a message), the routers are always run, and local deliveries are
24050 always attempted, even if retry times are set for them. This makes for better
24051 behaviour if one particular message is causing problems (for example, causing
24052 quota overflow, or provoking an error in a filter file). If such a delivery
24053 suffers a temporary failure, the retry data is updated as normal, and
24054 subsequent delivery attempts from queue runs occur only when the retry time for
24055 the local address is reached.
24056
24057 .section "Changing retry rules" "SECID157"
24058 If you change the retry rules in your configuration, you should consider
24059 whether or not to delete the retry data that is stored in Exim's spool area in
24060 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24061 always safe; that is why they are called &"hints"&.
24062
24063 The hints retry data contains suggested retry times based on the previous
24064 rules. In the case of a long-running problem with a remote host, it might
24065 record the fact that the host has timed out. If your new rules increase the
24066 timeout time for such a host, you should definitely remove the old retry data
24067 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24068 messages that it should now be retaining.
24069
24070
24071
24072 .section "Format of retry rules" "SECID158"
24073 .cindex "retry" "rules"
24074 Each retry rule occupies one line and consists of three or four parts,
24075 separated by white space: a pattern, an error name, an optional list of sender
24076 addresses, and a list of retry parameters. The pattern and sender lists must be
24077 enclosed in double quotes if they contain white space. The rules are searched
24078 in order until one is found where the pattern, error name, and sender list (if
24079 present) match the failing host or address, the error that occurred, and the
24080 message's sender, respectively.
24081
24082
24083 The pattern is any single item that may appear in an address list (see section
24084 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24085 which means that it is expanded before being tested against the address that
24086 has been delayed. A negated address list item is permitted. Address
24087 list processing treats a plain domain name as if it were preceded by &"*@"&,
24088 which makes it possible for many retry rules to start with just a domain. For
24089 example,
24090 .code
24091 lookingglass.fict.example        *  F,24h,30m;
24092 .endd
24093 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24094 whereas
24095 .code
24096 alice@lookingglass.fict.example  *  F,24h,30m;
24097 .endd
24098 applies only to temporary failures involving the local part &%alice%&.
24099 In practice, almost all rules start with a domain name pattern without a local
24100 part.
24101
24102 .cindex "regular expressions" "in retry rules"
24103 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24104 must match a complete address, not just a domain, because that is how regular
24105 expressions work in address lists.
24106 .display
24107 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24108 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24109 .endd
24110
24111
24112 .section "Choosing which retry rule to use for address errors" "SECID159"
24113 When Exim is looking for a retry rule after a routing attempt has failed (for
24114 example, after a DNS timeout), each line in the retry configuration is tested
24115 against the complete address only if &%retry_use_local_part%& is set for the
24116 router. Otherwise, only the domain is used, except when matching against a
24117 regular expression, when the local part of the address is replaced with &"*"&.
24118 A domain on its own can match a domain pattern, or a pattern that starts with
24119 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24120 &%check_local_user%& is true, and false for other routers.
24121
24122 Similarly, when Exim is looking for a retry rule after a local delivery has
24123 failed (for example, after a mailbox full error), each line in the retry
24124 configuration is tested against the complete address only if
24125 &%retry_use_local_part%& is set for the transport (it defaults true for all
24126 local transports).
24127
24128 .cindex "4&'xx'& responses" "retry rules for"
24129 However, when Exim is looking for a retry rule after a remote delivery attempt
24130 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24131 whole address is always used as the key when searching the retry rules. The
24132 rule that is found is used to create a retry time for the combination of the
24133 failing address and the message's sender. It is the combination of sender and
24134 recipient that is delayed in subsequent queue runs until its retry time is
24135 reached. You can delay the recipient without regard to the sender by setting
24136 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24137 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24138 commands.
24139
24140
24141
24142 .section "Choosing which retry rule to use for host and message errors" &&&
24143          "SECID160"
24144 For a temporary error that is not related to an individual address (for
24145 example, a connection timeout), each line in the retry configuration is checked
24146 twice. First, the name of the remote host is used as a domain name (preceded by
24147 &"*@"& when matching a regular expression). If this does not match the line,
24148 the domain from the email address is tried in a similar fashion. For example,
24149 suppose the MX records for &'a.b.c.example'& are
24150 .code
24151 a.b.c.example  MX  5  x.y.z.example
24152                MX  6  p.q.r.example
24153                MX  7  m.n.o.example
24154 .endd
24155 and the retry rules are
24156 .code
24157 p.q.r.example    *      F,24h,30m;
24158 a.b.c.example    *      F,4d,45m;
24159 .endd
24160 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24161 first rule matches neither the host nor the domain, so Exim looks at the second
24162 rule. This does not match the host, but it does match the domain, so it is used
24163 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24164 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24165 first retry rule is used, because it matches the host.
24166
24167 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24168 first rule to determine retry times, but for all the other hosts for the domain
24169 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24170 routing to &'a.b.c.example'& suffers a temporary failure.
24171
24172 &*Note*&: The host name is used when matching the patterns, not its IP address.
24173 However, if a message is routed directly to an IP address without the use of a
24174 host name, for example, if a &(manualroute)& router contains a setting such as:
24175 .code
24176 route_list = *.a.example  192.168.34.23
24177 .endd
24178 then the &"host name"& that is used when searching for a retry rule is the
24179 textual form of the IP address.
24180
24181 .section "Retry rules for specific errors" "SECID161"
24182 .cindex "retry" "specific errors; specifying"
24183 The second field in a retry rule is the name of a particular error, or an
24184 asterisk, which matches any error. The errors that can be tested for are:
24185
24186 .vlist
24187 .vitem &%auth_failed%&
24188 Authentication failed when trying to send to a host in the
24189 &%hosts_require_auth%& list in an &(smtp)& transport.
24190
24191 .vitem &%data_4xx%&
24192 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24193 after the command, or after sending the message's data.
24194
24195 .vitem &%mail_4xx%&
24196 A 4&'xx'& error was received for an outgoing MAIL command.
24197
24198 .vitem &%rcpt_4xx%&
24199 A 4&'xx'& error was received for an outgoing RCPT command.
24200 .endlist
24201
24202 For the three 4&'xx'& errors, either the first or both of the x's can be given
24203 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24204 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24205 and have retries every ten minutes with a one-hour timeout, you could set up a
24206 retry rule of this form:
24207 .code
24208 the.domain.name  rcpt_452   F,1h,10m
24209 .endd
24210 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24211 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24212
24213 .vlist
24214 .vitem &%lost_connection%&
24215 A server unexpectedly closed the SMTP connection. There may, of course,
24216 legitimate reasons for this (host died, network died), but if it repeats a lot
24217 for the same host, it indicates something odd.
24218
24219 .vitem &%refused_MX%&
24220 A connection to a host obtained from an MX record was refused.
24221
24222 .vitem &%refused_A%&
24223 A connection to a host not obtained from an MX record was refused.
24224
24225 .vitem &%refused%&
24226 A connection was refused.
24227
24228 .vitem &%timeout_connect_MX%&
24229 A connection attempt to a host obtained from an MX record timed out.
24230
24231 .vitem &%timeout_connect_A%&
24232 A connection attempt to a host not obtained from an MX record timed out.
24233
24234 .vitem &%timeout_connect%&
24235 A connection attempt timed out.
24236
24237 .vitem &%timeout_MX%&
24238 There was a timeout while connecting or during an SMTP session with a host
24239 obtained from an MX record.
24240
24241 .vitem &%timeout_A%&
24242 There was a timeout while connecting or during an SMTP session with a host not
24243 obtained from an MX record.
24244
24245 .vitem &%timeout%&
24246 There was a timeout while connecting or during an SMTP session.
24247
24248 .vitem &%tls_required%&
24249 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24250 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24251 to STARTTLS, or there was a problem setting up the TLS connection.
24252
24253 .vitem &%quota%&
24254 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24255 transport.
24256
24257 .vitem &%quota_%&<&'time'&>
24258 .cindex "quota" "error testing in retry rule"
24259 .cindex "retry" "quota error testing"
24260 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24261 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24262 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24263 for four days.
24264 .endlist
24265
24266 .cindex "mailbox" "time of last read"
24267 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24268 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24269 it should be based on the last time that the user accessed the mailbox.
24270 However, it is not always possible to determine this. Exim uses the following
24271 heuristic rules:
24272
24273 .ilist
24274 If the mailbox is a single file, the time of last access (the &"atime"&) is
24275 used. As no new messages are being delivered (because the mailbox is over
24276 quota), Exim does not access the file, so this is the time of last user access.
24277 .next
24278 .cindex "maildir format" "time of last read"
24279 For a maildir delivery, the time of last modification of the &_new_&
24280 subdirectory is used. As the mailbox is over quota, no new files are created in
24281 the &_new_& subdirectory, because no new messages are being delivered. Any
24282 change to the &_new_& subdirectory is therefore assumed to be the result of an
24283 MUA moving a new message to the &_cur_& directory when it is first read. The
24284 time that is used is therefore the last time that the user read a new message.
24285 .next
24286 For other kinds of multi-file mailbox, the time of last access cannot be
24287 obtained, so a retry rule that uses this type of error field is never matched.
24288 .endlist
24289
24290 The quota errors apply both to system-enforced quotas and to Exim's own quota
24291 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24292 when a local delivery is deferred because a partition is full (the ENOSPC
24293 error).
24294
24295
24296
24297 .section "Retry rules for specified senders" "SECID162"
24298 .cindex "retry" "rules; sender-specific"
24299 You can specify retry rules that apply only when the failing message has a
24300 specific sender. In particular, this can be used to define retry rules that
24301 apply only to bounce messages. The third item in a retry rule can be of this
24302 form:
24303 .display
24304 &`senders=`&<&'address list'&>
24305 .endd
24306 The retry timings themselves are then the fourth item. For example:
24307 .code
24308 *   rcpt_4xx   senders=:   F,1h,30m
24309 .endd
24310 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24311 host. If the address list contains white space, it must be enclosed in quotes.
24312 For example:
24313 .code
24314 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24315 .endd
24316 &*Warning*&: This facility can be unhelpful if it is used for host errors
24317 (which do not depend on the recipient). The reason is that the sender is used
24318 only to match the retry rule. Once the rule has been found for a host error,
24319 its contents are used to set a retry time for the host, and this will apply to
24320 all messages, not just those with specific senders.
24321
24322 When testing retry rules using &%-brt%&, you can supply a sender using the
24323 &%-f%& command line option, like this:
24324 .code
24325 exim -f "" -brt user@dom.ain
24326 .endd
24327 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24328 list is never matched.
24329
24330
24331
24332
24333
24334 .section "Retry parameters" "SECID163"
24335 .cindex "retry" "parameters in rules"
24336 The third (or fourth, if a senders list is present) field in a retry rule is a
24337 sequence of retry parameter sets, separated by semicolons. Each set consists of
24338 .display
24339 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24340 .endd
24341 The letter identifies the algorithm for computing a new retry time; the cutoff
24342 time is the time beyond which this algorithm no longer applies, and the
24343 arguments vary the algorithm's action. The cutoff time is measured from the
24344 time that the first failure for the domain (combined with the local part if
24345 relevant) was detected, not from the time the message was received.
24346
24347 .cindex "retry" "algorithms"
24348 .cindex "retry" "fixed intervals"
24349 .cindex "retry" "increasing intervals"
24350 .cindex "retry" "random intervals"
24351 The available algorithms are:
24352
24353 .ilist
24354 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24355 the interval.
24356 .next
24357 &'G'&: retry at geometrically increasing intervals. The first argument
24358 specifies a starting value for the interval, and the second a multiplier, which
24359 is used to increase the size of the interval at each retry.
24360 .next
24361 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24362 retry, the previous interval is multiplied by the factor in order to get a
24363 maximum for the next interval. The minimum interval is the first argument of
24364 the parameter, and an actual interval is chosen randomly between them. Such a
24365 rule has been found to be helpful in cluster configurations when all the
24366 members of the cluster restart at once, and may therefore synchronize their
24367 queue processing times.
24368 .endlist
24369
24370 When computing the next retry time, the algorithm definitions are scanned in
24371 order until one whose cutoff time has not yet passed is reached. This is then
24372 used to compute a new retry time that is later than the current time. In the
24373 case of fixed interval retries, this simply means adding the interval to the
24374 current time. For geometrically increasing intervals, retry intervals are
24375 computed from the rule's parameters until one that is greater than the previous
24376 interval is found. The main configuration variable
24377 .cindex "limit" "retry interval"
24378 .cindex "retry" "interval, maximum"
24379 .oindex "&%retry_interval_max%&"
24380 &%retry_interval_max%& limits the maximum interval between retries. It
24381 cannot be set greater than &`24h`&, which is its default value.
24382
24383 A single remote domain may have a number of hosts associated with it, and each
24384 host may have more than one IP address. Retry algorithms are selected on the
24385 basis of the domain name, but are applied to each IP address independently. If,
24386 for example, a host has two IP addresses and one is unusable, Exim will
24387 generate retry times for it and will not try to use it until its next retry
24388 time comes. Thus the good IP address is likely to be tried first most of the
24389 time.
24390
24391 .cindex "hints database" "use for retrying"
24392 Retry times are hints rather than promises. Exim does not make any attempt to
24393 run deliveries exactly at the computed times. Instead, a queue runner process
24394 starts delivery processes for delayed messages periodically, and these attempt
24395 new deliveries only for those addresses that have passed their next retry time.
24396 If a new message arrives for a deferred address, an immediate delivery attempt
24397 occurs only if the address has passed its retry time. In the absence of new
24398 messages, the minimum time between retries is the interval between queue runner
24399 processes. There is not much point in setting retry times of five minutes if
24400 your queue runners happen only once an hour, unless there are a significant
24401 number of incoming messages (which might be the case on a system that is
24402 sending everything to a smart host, for example).
24403
24404 The data in the retry hints database can be inspected by using the
24405 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24406 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24407 &'exinext'& utility script can be used to find out what the next retry times
24408 are for the hosts associated with a particular mail domain, and also for local
24409 deliveries that have been deferred.
24410
24411
24412 .section "Retry rule examples" "SECID164"
24413 Here are some example retry rules:
24414 .code
24415 alice@wonderland.fict.example quota_5d  F,7d,3h
24416 wonderland.fict.example       quota_5d
24417 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24418 lookingglass.fict.example     *         F,24h,30m;
24419 *                 refused_A   F,2h,20m;
24420 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24421 .endd
24422 The first rule sets up special handling for mail to
24423 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24424 mailbox has not been read for at least 5 days. Retries continue every three
24425 hours for 7 days. The second rule handles over-quota errors for all other local
24426 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24427 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24428 fail are bounced immediately if the mailbox has not been read for at least 5
24429 days.
24430
24431 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24432 happen every 15 minutes for an hour, then with geometrically increasing
24433 intervals until two days have passed since a delivery first failed. After the
24434 first hour there is a delay of one hour, then two hours, then four hours, and
24435 so on (this is a rather extreme example).
24436
24437 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24438 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24439 all other domains, with special action for connection refusal from hosts that
24440 were not obtained from an MX record.
24441
24442 The final rule in a retry configuration should always have asterisks in the
24443 first two fields so as to provide a general catch-all for any addresses that do
24444 not have their own special handling. This example tries every 15 minutes for 2
24445 hours, then with intervals starting at one hour and increasing by a factor of
24446 1.5 up to 16 hours, then every 8 hours up to 5 days.
24447
24448
24449
24450 .section "Timeout of retry data" "SECID165"
24451 .cindex "timeout" "of retry data"
24452 .oindex "&%retry_data_expire%&"
24453 .cindex "hints database" "data expiry"
24454 .cindex "retry" "timeout of data"
24455 Exim timestamps the data that it writes to its retry hints database. When it
24456 consults the data during a delivery it ignores any that is older than the value
24457 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24458 been tried for 7 days, Exim will try to deliver to it immediately a message
24459 arrives, and if that fails, it will calculate a retry time as if it were
24460 failing for the first time.
24461
24462 This improves the behaviour for messages routed to rarely-used hosts such as MX
24463 backups. If such a host was down at one time, and happens to be down again when
24464 Exim tries a month later, using the old retry data would imply that it had been
24465 down all the time, which is not a justified assumption.
24466
24467 If a host really is permanently dead, this behaviour causes a burst of retries
24468 every now and again, but only if messages routed to it are rare. If there is a
24469 message at least once every 7 days the retry data never expires.
24470
24471
24472
24473
24474 .section "Long-term failures" "SECID166"
24475 .cindex "delivery failure, long-term"
24476 .cindex "retry" "after long-term failure"
24477 Special processing happens when an email address has been failing for so long
24478 that the cutoff time for the last algorithm is reached. For example, using the
24479 default retry rule:
24480 .code
24481 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24482 .endd
24483 the cutoff time is four days. Reaching the retry cutoff is independent of how
24484 long any specific message has been failing; it is the length of continuous
24485 failure for the recipient address that counts.
24486
24487 When the cutoff time is reached for a local delivery, or for all the IP
24488 addresses associated with a remote delivery, a subsequent delivery failure
24489 causes Exim to give up on the address, and a bounce message is generated.
24490 In order to cater for new messages that use the failing address, a next retry
24491 time is still computed from the final algorithm, and is used as follows:
24492
24493 For local deliveries, one delivery attempt is always made for any subsequent
24494 messages. If this delivery fails, the address fails immediately. The
24495 post-cutoff retry time is not used.
24496
24497 If the delivery is remote, there are two possibilities, controlled by the
24498 .oindex "&%delay_after_cutoff%&"
24499 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24500 default. Until the post-cutoff retry time for one of the IP addresses is
24501 reached, the failing email address is bounced immediately, without a delivery
24502 attempt taking place. After that time, one new delivery attempt is made to
24503 those IP addresses that are past their retry times, and if that still fails,
24504 the address is bounced and new retry times are computed.
24505
24506 In other words, when all the hosts for a given email address have been failing
24507 for a long time, Exim bounces rather then defers until one of the hosts' retry
24508 times is reached. Then it tries once, and bounces if that attempt fails. This
24509 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24510 to a broken destination, but if the host does recover, Exim will eventually
24511 notice.
24512
24513 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24514 addresses are past their final cutoff time, Exim tries to deliver to those IP
24515 addresses that have not been tried since the message arrived. If there are
24516 no suitable IP addresses, or if they all fail, the address is bounced. In other
24517 words, it does not delay when a new message arrives, but tries the expired
24518 addresses immediately, unless they have been tried since the message arrived.
24519 If there is a continuous stream of messages for the failing domains, setting
24520 &%delay_after_cutoff%& false means that there will be many more attempts to
24521 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24522 true.
24523
24524 .section "Deliveries that work intermittently" "SECID167"
24525 .cindex "retry" "intermittently working deliveries"
24526 Some additional logic is needed to cope with cases where a host is
24527 intermittently available, or when a message has some attribute that prevents
24528 its delivery when others to the same address get through. In this situation,
24529 because some messages are successfully delivered, the &"retry clock"& for the
24530 host or address keeps getting reset by the successful deliveries, and so
24531 failing messages remain on the queue for ever because the cutoff time is never
24532 reached.
24533
24534 Two exceptional actions are applied to prevent this happening. The first
24535 applies to errors that are related to a message rather than a remote host.
24536 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24537 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24538 commands, and quota failures. For this type of error, if a message's arrival
24539 time is earlier than the &"first failed"& time for the error, the earlier time
24540 is used when scanning the retry rules to decide when to try next and when to
24541 time out the address.
24542
24543 The exceptional second action applies in all cases. If a message has been on
24544 the queue for longer than the cutoff time of any applicable retry rule for a
24545 given address, a delivery is attempted for that address, even if it is not yet
24546 time, and if this delivery fails, the address is timed out. A new retry time is
24547 not computed in this case, so that other messages for the same address are
24548 considered immediately.
24549 .ecindex IIDretconf1
24550 .ecindex IIDregconf2
24551
24552
24553
24554
24555
24556
24557 . ////////////////////////////////////////////////////////////////////////////
24558 . ////////////////////////////////////////////////////////////////////////////
24559
24560 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24561 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24562 .scindex IIDauthconf2 "authentication"
24563 The &"authenticators"& section of Exim's run time configuration is concerned
24564 with SMTP authentication. This facility is an extension to the SMTP protocol,
24565 described in RFC 2554, which allows a client SMTP host to authenticate itself
24566 to a server. This is a common way for a server to recognize clients that are
24567 permitted to use it as a relay. SMTP authentication is not of relevance to the
24568 transfer of mail between servers that have no managerial connection with each
24569 other.
24570
24571 .cindex "AUTH" "description of"
24572 Very briefly, the way SMTP authentication works is as follows:
24573
24574 .ilist
24575 The server advertises a number of authentication &'mechanisms'& in response to
24576 the client's EHLO command.
24577 .next
24578 The client issues an AUTH command, naming a specific mechanism. The command
24579 may, optionally, contain some authentication data.
24580 .next
24581 The server may issue one or more &'challenges'&, to which the client must send
24582 appropriate responses. In simple authentication mechanisms, the challenges are
24583 just prompts for user names and passwords. The server does not have to issue
24584 any challenges &-- in some mechanisms the relevant data may all be transmitted
24585 with the AUTH command.
24586 .next
24587 The server either accepts or denies authentication.
24588 .next
24589 If authentication succeeds, the client may optionally make use of the AUTH
24590 option on the MAIL command to pass an authenticated sender in subsequent
24591 mail transactions. Authentication lasts for the remainder of the SMTP
24592 connection.
24593 .next
24594 If authentication fails, the client may give up, or it may try a different
24595 authentication mechanism, or it may try transferring mail over the
24596 unauthenticated connection.
24597 .endlist
24598
24599 If you are setting up a client, and want to know which authentication
24600 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24601 SMTP port) on the server, and issue an EHLO command. The response to this
24602 includes the list of supported mechanisms. For example:
24603 .display
24604 &`$ `&&*&`telnet server.example 25`&*&
24605 &`Trying 192.168.34.25...`&
24606 &`Connected to server.example.`&
24607 &`Escape character is &#x0027;^]&#x0027;.`&
24608 &`220 server.example ESMTP Exim 4.20 ...`&
24609 &*&`ehlo client.example`&*&
24610 &`250-server.example Hello client.example [10.8.4.5]`&
24611 &`250-SIZE 52428800`&
24612 &`250-PIPELINING`&
24613 &`250-AUTH PLAIN`&
24614 &`250 HELP`&
24615 .endd
24616 The second-last line of this example output shows that the server supports
24617 authentication using the PLAIN mechanism. In Exim, the different authentication
24618 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24619 routers and transports, which authenticators are included in the binary is
24620 controlled by build-time definitions. The following are currently available,
24621 included by setting
24622 .code
24623 AUTH_CRAM_MD5=yes
24624 AUTH_CYRUS_SASL=yes
24625 AUTH_DOVECOT=yes
24626 AUTH_GSASL=yes
24627 AUTH_HEIMDAL_GSSAPI=yes
24628 AUTH_PLAINTEXT=yes
24629 AUTH_SPA=yes
24630 .endd
24631 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24632 authentication mechanism (RFC 2195), and the second provides an interface to
24633 the Cyrus SASL authentication library.
24634 The third is an interface to Dovecot's authentication system, delegating the
24635 work via a socket interface.
24636 The fourth provides an interface to the GNU SASL authentication library, which
24637 provides mechanisms but typically not data sources.
24638 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24639 supporting setting a server keytab.
24640 The sixth can be configured to support
24641 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24642 not formally documented, but used by several MUAs. The seventh authenticator
24643 supports Microsoft's &'Secure Password Authentication'& mechanism.
24644
24645 The authenticators are configured using the same syntax as other drivers (see
24646 section &<<SECTfordricon>>&). If no authenticators are required, no
24647 authentication section need be present in the configuration file. Each
24648 authenticator can in principle have both server and client functions. When Exim
24649 is receiving SMTP mail, it is acting as a server; when it is sending out
24650 messages over SMTP, it is acting as a client. Authenticator configuration
24651 options are provided for use in both these circumstances.
24652
24653 To make it clear which options apply to which situation, the prefixes
24654 &%server_%& and &%client_%& are used on option names that are specific to
24655 either the server or the client function, respectively. Server and client
24656 functions are disabled if none of their options are set. If an authenticator is
24657 to be used for both server and client functions, a single definition, using
24658 both sets of options, is required. For example:
24659 .code
24660 cram:
24661   driver = cram_md5
24662   public_name = CRAM-MD5
24663   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24664   client_name = ph10
24665   client_secret = secret2
24666 .endd
24667 The &%server_%& option is used when Exim is acting as a server, and the
24668 &%client_%& options when it is acting as a client.
24669
24670 Descriptions of the individual authenticators are given in subsequent chapters.
24671 The remainder of this chapter covers the generic options for the
24672 authenticators, followed by general discussion of the way authentication works
24673 in Exim.
24674
24675 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24676 per-mechanism basis.  Please read carefully to determine which variables hold
24677 account labels such as usercodes and which hold passwords or other
24678 authenticating data.
24679
24680 Note that some mechanisms support two different identifiers for accounts: the
24681 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24682 and &'authz'& are commonly encountered.  The American spelling is standard here.
24683 Conceptually, authentication data such as passwords are tied to the identifier
24684 used to authenticate; servers may have rules to permit one user to act as a
24685 second user, so that after login the session is treated as though that second
24686 user had logged in.  That second user is the &'authorization id'&.  A robust
24687 configuration might confirm that the &'authz'& field is empty or matches the
24688 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24689 as verified data, the &'authz'& as an unverified request which the server might
24690 choose to honour.
24691
24692 A &'realm'& is a text string, typically a domain name, presented by a server
24693 to a client to help it select an account and credentials to use.  In some
24694 mechanisms, the client and server provably agree on the realm, but clients
24695 typically can not treat the realm as secure data to be blindly trusted.
24696
24697
24698
24699 .section "Generic options for authenticators" "SECID168"
24700 .cindex "authentication" "generic options"
24701 .cindex "options" "generic; for authenticators"
24702
24703 .option client_condition authenticators string&!! unset
24704 When Exim is authenticating as a client, it skips any authenticator whose
24705 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24706 used, for example, to skip plain text authenticators when the connection is not
24707 encrypted by a setting such as:
24708 .code
24709 client_condition = ${if !eq{$tls_out_cipher}{}}
24710 .endd
24711
24712
24713 .option client_set_id authenticators string&!! unset
24714 When client authentication succeeds, this condition is expanded; the
24715 result is used in the log lines for outbound messasges.
24716 Typically it will be the user name used for authentication.
24717
24718
24719 .option driver authenticators string unset
24720 This option must always be set. It specifies which of the available
24721 authenticators is to be used.
24722
24723
24724 .option public_name authenticators string unset
24725 This option specifies the name of the authentication mechanism that the driver
24726 implements, and by which it is known to the outside world. These names should
24727 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24728 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24729 defaults to the driver's instance name.
24730
24731
24732 .option server_advertise_condition authenticators string&!! unset
24733 When a server is about to advertise an authentication mechanism, the condition
24734 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24735 mechanism is not advertised.
24736 If the expansion fails, the mechanism is not advertised. If the failure was not
24737 forced, and was not caused by a lookup defer, the incident is logged.
24738 See section &<<SECTauthexiser>>& below for further discussion.
24739
24740
24741 .option server_condition authenticators string&!! unset
24742 This option must be set for a &%plaintext%& server authenticator, where it
24743 is used directly to control authentication. See section &<<SECTplainserver>>&
24744 for details.
24745
24746 For the &(gsasl)& authenticator, this option is required for various
24747 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24748
24749 For the other authenticators, &%server_condition%& can be used as an additional
24750 authentication or authorization mechanism that is applied after the other
24751 authenticator conditions succeed. If it is set, it is expanded when the
24752 authenticator would otherwise return a success code. If the expansion is forced
24753 to fail, authentication fails. Any other expansion failure causes a temporary
24754 error code to be returned. If the result of a successful expansion is an empty
24755 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24756 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24757 other result, a temporary error code is returned, with the expanded string as
24758 the error text.
24759
24760
24761 .option server_debug_print authenticators string&!! unset
24762 If this option is set and authentication debugging is enabled (see the &%-d%&
24763 command line option), the string is expanded and included in the debugging
24764 output when the authenticator is run as a server. This can help with checking
24765 out the values of variables.
24766 If expansion of the string fails, the error message is written to the debugging
24767 output, and Exim carries on processing.
24768
24769
24770 .option server_set_id authenticators string&!! unset
24771 .vindex "&$authenticated_id$&"
24772 When an Exim server successfully authenticates a client, this string is
24773 expanded using data from the authentication, and preserved for any incoming
24774 messages in the variable &$authenticated_id$&. It is also included in the log
24775 lines for incoming messages. For example, a user/password authenticator
24776 configuration might preserve the user name that was used to authenticate, and
24777 refer to it subsequently during delivery of the message.
24778 If expansion fails, the option is ignored.
24779
24780
24781 .option server_mail_auth_condition authenticators string&!! unset
24782 This option allows a server to discard authenticated sender addresses supplied
24783 as part of MAIL commands in SMTP connections that are authenticated by the
24784 driver on which &%server_mail_auth_condition%& is set. The option is not used
24785 as part of the authentication process; instead its (unexpanded) value is
24786 remembered for later use.
24787 How it is used is described in the following section.
24788
24789
24790
24791
24792
24793 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24794 .cindex "authentication" "sender; authenticated"
24795 .cindex "AUTH" "on MAIL command"
24796 When a client supplied an AUTH= item on a MAIL command, Exim applies
24797 the following checks before accepting it as the authenticated sender of the
24798 message:
24799
24800 .ilist
24801 If the connection is not using extended SMTP (that is, HELO was used rather
24802 than EHLO), the use of AUTH= is a syntax error.
24803 .next
24804 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24805 .next
24806 .vindex "&$authenticated_sender$&"
24807 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24808 running, the value of &$authenticated_sender$& is set to the value obtained
24809 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24810 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24811 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24812 given for the MAIL command.
24813 .next
24814 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24815 is accepted and placed in &$authenticated_sender$& only if the client has
24816 authenticated.
24817 .next
24818 If the AUTH= value was accepted by either of the two previous rules, and
24819 the client has authenticated, and the authenticator has a setting for the
24820 &%server_mail_auth_condition%&, the condition is checked at this point. The
24821 valued that was saved from the authenticator is expanded. If the expansion
24822 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24823 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24824 the value of &$authenticated_sender$& is retained and passed on with the
24825 message.
24826 .endlist
24827
24828
24829 When &$authenticated_sender$& is set for a message, it is passed on to other
24830 hosts to which Exim authenticates as a client. Do not confuse this value with
24831 &$authenticated_id$&, which is a string obtained from the authentication
24832 process, and which is not usually a complete email address.
24833
24834 .vindex "&$sender_address$&"
24835 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24836 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24837 therefore make use of &$authenticated_sender$&. The converse is not true: the
24838 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24839 ACL is run.
24840
24841
24842
24843 .section "Authentication on an Exim server" "SECTauthexiser"
24844 .cindex "authentication" "on an Exim server"
24845 When Exim receives an EHLO command, it advertises the public names of those
24846 authenticators that are configured as servers, subject to the following
24847 conditions:
24848
24849 .ilist
24850 The client host must match &%auth_advertise_hosts%& (default *).
24851 .next
24852 It the &%server_advertise_condition%& option is set, its expansion must not
24853 yield the empty string, &"0"&, &"no"&, or &"false"&.
24854 .endlist
24855
24856 The order in which the authenticators are defined controls the order in which
24857 the mechanisms are advertised.
24858
24859 Some mail clients (for example, some versions of Netscape) require the user to
24860 provide a name and password for authentication whenever AUTH is advertised,
24861 even though authentication may not in fact be needed (for example, Exim may be
24862 set up to allow unconditional relaying from the client by an IP address check).
24863 You can make such clients more friendly by not advertising AUTH to them.
24864 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24865 that runs for RCPT) to relay without authentication, you should set
24866 .code
24867 auth_advertise_hosts = ! 10.9.8.0/24
24868 .endd
24869 so that no authentication mechanisms are advertised to them.
24870
24871 The &%server_advertise_condition%& controls the advertisement of individual
24872 authentication mechanisms. For example, it can be used to restrict the
24873 advertisement of a particular mechanism to encrypted connections, by a setting
24874 such as:
24875 .code
24876 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24877 .endd
24878 .vindex "&$tls_in_cipher$&"
24879 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24880 yields &"yes"&, which allows the advertisement to happen.
24881
24882 When an Exim server receives an AUTH command from a client, it rejects it
24883 immediately if AUTH was not advertised in response to an earlier EHLO
24884 command. This is the case if
24885
24886 .ilist
24887 The client host does not match &%auth_advertise_hosts%&; or
24888 .next
24889 No authenticators are configured with server options; or
24890 .next
24891 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24892 server authenticators.
24893 .endlist
24894
24895
24896 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24897 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24898 AUTH is accepted from any client host.
24899
24900 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24901 server authentication mechanism that was advertised in response to EHLO and
24902 that matches the one named in the AUTH command. If it finds one, it runs
24903 the appropriate authentication protocol, and authentication either succeeds or
24904 fails. If there is no matching advertised mechanism, the AUTH command is
24905 rejected with a 504 error.
24906
24907 .vindex "&$received_protocol$&"
24908 .vindex "&$sender_host_authenticated$&"
24909 When a message is received from an authenticated host, the value of
24910 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24911 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24912 public name) of the authenticator driver that successfully authenticated the
24913 client from which the message was received. This variable is empty if there was
24914 no successful authentication.
24915
24916
24917
24918
24919 .section "Testing server authentication" "SECID169"
24920 .cindex "authentication" "testing a server"
24921 .cindex "AUTH" "testing a server"
24922 .cindex "base64 encoding" "creating authentication test data"
24923 Exim's &%-bh%& option can be useful for testing server authentication
24924 configurations. The data for the AUTH command has to be sent using base64
24925 encoding. A quick way to produce such data for testing is the following Perl
24926 script:
24927 .code
24928 use MIME::Base64;
24929 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24930 .endd
24931 .cindex "binary zero" "in authentication data"
24932 This interprets its argument as a Perl string, and then encodes it. The
24933 interpretation as a Perl string allows binary zeros, which are required for
24934 some kinds of authentication, to be included in the data. For example, a
24935 command line to run this script on such data might be
24936 .code
24937 encode '\0user\0password'
24938 .endd
24939 Note the use of single quotes to prevent the shell interpreting the
24940 backslashes, so that they can be interpreted by Perl to specify characters
24941 whose code value is zero.
24942
24943 &*Warning 1*&: If either of the user or password strings starts with an octal
24944 digit, you must use three zeros instead of one after the leading backslash. If
24945 you do not, the octal digit that starts your string will be incorrectly
24946 interpreted as part of the code for the first character.
24947
24948 &*Warning 2*&: If there are characters in the strings that Perl interprets
24949 specially, you must use a Perl escape to prevent them being misinterpreted. For
24950 example, a command such as
24951 .code
24952 encode '\0user@domain.com\0pas$$word'
24953 .endd
24954 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24955
24956 If you have the &%mimencode%& command installed, another way to do produce
24957 base64-encoded strings is to run the command
24958 .code
24959 echo -e -n `\0user\0password' | mimencode
24960 .endd
24961 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24962 in the argument, and the &%-n%& option specifies no newline at the end of its
24963 output. However, not all versions of &%echo%& recognize these options, so you
24964 should check your version before relying on this suggestion.
24965
24966
24967
24968 .section "Authentication by an Exim client" "SECID170"
24969 .cindex "authentication" "on an Exim client"
24970 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24971 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24972 announces support for authentication, and the host matches an entry in either
24973 of these options, Exim (as a client) tries to authenticate as follows:
24974
24975 .ilist
24976 For each authenticator that is configured as a client, in the order in which
24977 they are defined in the configuration, it searches the authentication
24978 mechanisms announced by the server for one whose name matches the public name
24979 of the authenticator.
24980 .next
24981 .vindex "&$host$&"
24982 .vindex "&$host_address$&"
24983 When it finds one that matches, it runs the authenticator's client code. The
24984 variables &$host$& and &$host_address$& are available for any string expansions
24985 that the client might do. They are set to the server's name and IP address. If
24986 any expansion is forced to fail, the authentication attempt is abandoned, and
24987 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24988 delivery to be deferred.
24989 .next
24990 If the result of the authentication attempt is a temporary error or a timeout,
24991 Exim abandons trying to send the message to the host for the moment. It will
24992 try again later. If there are any backup hosts available, they are tried in the
24993 usual way.
24994 .next
24995 If the response to authentication is a permanent error (5&'xx'& code), Exim
24996 carries on searching the list of authenticators and tries another one if
24997 possible. If all authentication attempts give permanent errors, or if there are
24998 no attempts because no mechanisms match (or option expansions force failure),
24999 what happens depends on whether the host matches &%hosts_require_auth%& or
25000 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25001 delivery is deferred. The error can be detected in the retry rules, and thereby
25002 turned into a permanent error if you wish. In the second case, Exim tries to
25003 deliver the message unauthenticated.
25004 .endlist
25005
25006 .cindex "AUTH" "on MAIL command"
25007 When Exim has authenticated itself to a remote server, it adds the AUTH
25008 parameter to the MAIL commands it sends, if it has an authenticated sender for
25009 the message. If the message came from a remote host, the authenticated sender
25010 is the one that was receiving on an incoming MAIL command, provided that the
25011 incoming connection was authenticated and the &%server_mail_auth%& condition
25012 allowed the authenticated sender to be retained. If a local process calls Exim
25013 to send a message, the sender address that is built from the login name and
25014 &%qualify_domain%& is treated as authenticated. However, if the
25015 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25016 the authenticated sender that was received with the message.
25017 .ecindex IIDauthconf1
25018 .ecindex IIDauthconf2
25019
25020
25021
25022
25023
25024
25025 . ////////////////////////////////////////////////////////////////////////////
25026 . ////////////////////////////////////////////////////////////////////////////
25027
25028 .chapter "The plaintext authenticator" "CHAPplaintext"
25029 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25030 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25031 The &(plaintext)& authenticator can be configured to support the PLAIN and
25032 LOGIN authentication mechanisms, both of which transfer authentication data as
25033 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25034 security risk; you are strongly advised to insist on the use of SMTP encryption
25035 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25036 use unencrypted plain text, you should not use the same passwords for SMTP
25037 connections as you do for login accounts.
25038
25039 .section "Plaintext options" "SECID171"
25040 .cindex "options" "&(plaintext)& authenticator (server)"
25041 When configured as a server, &(plaintext)& uses the following options:
25042
25043 .option server_condition authenticators string&!! unset
25044 This is actually a global authentication option, but it must be set in order to
25045 configure the &(plaintext)& driver as a server. Its use is described below.
25046
25047 .option server_prompts plaintext string&!! unset
25048 The contents of this option, after expansion, must be a colon-separated list of
25049 prompt strings. If expansion fails, a temporary authentication rejection is
25050 given.
25051
25052 .section "Using plaintext in a server" "SECTplainserver"
25053 .cindex "AUTH" "in &(plaintext)& authenticator"
25054 .cindex "binary zero" "in &(plaintext)& authenticator"
25055 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25056         "in &(plaintext)& authenticator"
25057 .vindex "&$auth1$&, &$auth2$&, etc"
25058 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25059
25060 When running as a server, &(plaintext)& performs the authentication test by
25061 expanding a string. The data sent by the client with the AUTH command, or in
25062 response to subsequent prompts, is base64 encoded, and so may contain any byte
25063 values when decoded. If any data is supplied with the command, it is treated as
25064 a list of strings, separated by NULs (binary zeros), the first three of which
25065 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25066 (neither LOGIN nor PLAIN uses more than three strings).
25067
25068 For compatibility with previous releases of Exim, the values are also placed in
25069 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25070 variables for this purpose is now deprecated, as it can lead to confusion in
25071 string expansions that also use them for other things.
25072
25073 If there are more strings in &%server_prompts%& than the number of strings
25074 supplied with the AUTH command, the remaining prompts are used to obtain more
25075 data. Each response from the client may be a list of NUL-separated strings.
25076
25077 .vindex "&$authenticated_id$&"
25078 Once a sufficient number of data strings have been received,
25079 &%server_condition%& is expanded. If the expansion is forced to fail,
25080 authentication fails. Any other expansion failure causes a temporary error code
25081 to be returned. If the result of a successful expansion is an empty string,
25082 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25083 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25084 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25085 For any other result, a temporary error code is returned, with the expanded
25086 string as the error text
25087
25088 &*Warning*&: If you use a lookup in the expansion to find the user's
25089 password, be sure to make the authentication fail if the user is unknown.
25090 There are good and bad examples at the end of the next section.
25091
25092
25093
25094 .section "The PLAIN authentication mechanism" "SECID172"
25095 .cindex "PLAIN authentication mechanism"
25096 .cindex "authentication" "PLAIN mechanism"
25097 .cindex "binary zero" "in &(plaintext)& authenticator"
25098 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25099 sent as one item of data (that is, one combined string containing two NUL
25100 separators). The data is sent either as part of the AUTH command, or
25101 subsequently in response to an empty prompt from the server.
25102
25103 The second and third strings are a user name and a corresponding password.
25104 Using a single fixed user name and password as an example, this could be
25105 configured as follows:
25106 .code
25107 fixed_plain:
25108   driver = plaintext
25109   public_name = PLAIN
25110   server_prompts = :
25111   server_condition = \
25112     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25113   server_set_id = $auth2
25114 .endd
25115 Note that the default result strings from &%if%& (&"true"& or an empty string)
25116 are exactly what we want here, so they need not be specified. Obviously, if the
25117 password contains expansion-significant characters such as dollar, backslash,
25118 or closing brace, they have to be escaped.
25119
25120 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25121 the end of a string list are ignored). If all the data comes as part of the
25122 AUTH command, as is commonly the case, the prompt is not used. This
25123 authenticator is advertised in the response to EHLO as
25124 .code
25125 250-AUTH PLAIN
25126 .endd
25127 and a client host can authenticate itself by sending the command
25128 .code
25129 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25130 .endd
25131 As this contains three strings (more than the number of prompts), no further
25132 data is required from the client. Alternatively, the client may just send
25133 .code
25134 AUTH PLAIN
25135 .endd
25136 to initiate authentication, in which case the server replies with an empty
25137 prompt. The client must respond with the combined data string.
25138
25139 The data string is base64 encoded, as required by the RFC. This example,
25140 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25141 represents a zero byte. This is split up into three strings, the first of which
25142 is empty. The &%server_condition%& option in the authenticator checks that the
25143 second two are &`username`& and &`mysecret`& respectively.
25144
25145 Having just one fixed user name and password, as in this example, is not very
25146 realistic, though for a small organization with only a handful of
25147 authenticating clients it could make sense.
25148
25149 A more sophisticated instance of this authenticator could use the user name in
25150 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25151 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25152 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25153 This is an incorrect example:
25154 .code
25155 server_condition = \
25156   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25157 .endd
25158 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25159 which it then compares to the supplied password (&$auth3$&). Why is this example
25160 incorrect? It works fine for existing users, but consider what happens if a
25161 non-existent user name is given. The lookup fails, but as no success/failure
25162 strings are given for the lookup, it yields an empty string. Thus, to defeat
25163 the authentication, all a client has to do is to supply a non-existent user
25164 name and an empty password. The correct way of writing this test is:
25165 .code
25166 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25167   {${if eq{$value}{$auth3}}} {false}}
25168 .endd
25169 In this case, if the lookup succeeds, the result is checked; if the lookup
25170 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25171 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25172 always fails if its second argument is empty. However, the second way of
25173 writing the test makes the logic clearer.
25174
25175
25176 .section "The LOGIN authentication mechanism" "SECID173"
25177 .cindex "LOGIN authentication mechanism"
25178 .cindex "authentication" "LOGIN mechanism"
25179 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25180 in a number of programs. No data is sent with the AUTH command. Instead, a
25181 user name and password are supplied separately, in response to prompts. The
25182 plaintext authenticator can be configured to support this as in this example:
25183 .code
25184 fixed_login:
25185   driver = plaintext
25186   public_name = LOGIN
25187   server_prompts = User Name : Password
25188   server_condition = \
25189     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25190   server_set_id = $auth1
25191 .endd
25192 Because of the way plaintext operates, this authenticator accepts data supplied
25193 with the AUTH command (in contravention of the specification of LOGIN), but
25194 if the client does not supply it (as is the case for LOGIN clients), the prompt
25195 strings are used to obtain two data items.
25196
25197 Some clients are very particular about the precise text of the prompts. For
25198 example, Outlook Express is reported to recognize only &"Username:"& and
25199 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25200 strings. It uses the &%ldapauth%& expansion condition to check the user
25201 name and password by binding to an LDAP server:
25202 .code
25203 login:
25204   driver = plaintext
25205   public_name = LOGIN
25206   server_prompts = Username:: : Password::
25207   server_condition = ${if and{{ \
25208     !eq{}{$auth1} }{ \
25209     ldapauth{\
25210       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25211       pass=${quote:$auth2} \
25212       ldap://ldap.example.org/} }} }
25213   server_set_id = uid=$auth1,ou=people,o=example.org
25214 .endd
25215 We have to check that the username is not empty before using it, because LDAP
25216 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25217 operator to correctly quote the DN for authentication. However, the basic
25218 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25219 correct one to use for the password, because quoting is needed only to make
25220 the password conform to the Exim syntax. At the LDAP level, the password is an
25221 uninterpreted string.
25222
25223
25224 .section "Support for different kinds of authentication" "SECID174"
25225 A number of string expansion features are provided for the purpose of
25226 interfacing to different ways of user authentication. These include checking
25227 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25228 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25229 &<<SECTexpcond>>&.
25230
25231
25232
25233
25234 .section "Using plaintext in a client" "SECID175"
25235 .cindex "options" "&(plaintext)& authenticator (client)"
25236 The &(plaintext)& authenticator has two client options:
25237
25238 .option client_ignore_invalid_base64 plaintext boolean false
25239 If the client receives a server prompt that is not a valid base64 string,
25240 authentication is abandoned by default. However, if this option is set true,
25241 the error in the challenge is ignored and the client sends the response as
25242 usual.
25243
25244 .option client_send plaintext string&!! unset
25245 The string is a colon-separated list of authentication data strings. Each
25246 string is independently expanded before being sent to the server. The first
25247 string is sent with the AUTH command; any more strings are sent in response
25248 to prompts from the server. Before each string is expanded, the value of the
25249 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25250 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25251 way. Thus, the prompt that is received in response to sending the first string
25252 (with the AUTH command) can be used in the expansion of the second string, and
25253 so on. If an invalid base64 string is received when
25254 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25255 &$auth$&<&'n'&> variable.
25256
25257 &*Note*&: You cannot use expansion to create multiple strings, because
25258 splitting takes priority and happens first.
25259
25260 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25261 the data, further processing is applied to each string before it is sent. If
25262 there are any single circumflex characters in the string, they are converted to
25263 NULs. Should an actual circumflex be required as data, it must be doubled in
25264 the string.
25265
25266 This is an example of a client configuration that implements the PLAIN
25267 authentication mechanism with a fixed user name and password:
25268 .code
25269 fixed_plain:
25270   driver = plaintext
25271   public_name = PLAIN
25272   client_send = ^username^mysecret
25273 .endd
25274 The lack of colons means that the entire text is sent with the AUTH
25275 command, with the circumflex characters converted to NULs. A similar example
25276 that uses the LOGIN mechanism is:
25277 .code
25278 fixed_login:
25279   driver = plaintext
25280   public_name = LOGIN
25281   client_send = : username : mysecret
25282 .endd
25283 The initial colon means that the first string is empty, so no data is sent with
25284 the AUTH command itself. The remaining strings are sent in response to
25285 prompts.
25286 .ecindex IIDplaiauth1
25287 .ecindex IIDplaiauth2
25288
25289
25290
25291
25292 . ////////////////////////////////////////////////////////////////////////////
25293 . ////////////////////////////////////////////////////////////////////////////
25294
25295 .chapter "The cram_md5 authenticator" "CHID9"
25296 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25297 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25298 .cindex "CRAM-MD5 authentication mechanism"
25299 .cindex "authentication" "CRAM-MD5 mechanism"
25300 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25301 sends a challenge string to the client, and the response consists of a user
25302 name and the CRAM-MD5 digest of the challenge string combined with a secret
25303 string (password) which is known to both server and client. Thus, the secret
25304 is not sent over the network as plain text, which makes this authenticator more
25305 secure than &(plaintext)&. However, the downside is that the secret has to be
25306 available in plain text at either end.
25307
25308
25309 .section "Using cram_md5 as a server" "SECID176"
25310 .cindex "options" "&(cram_md5)& authenticator (server)"
25311 This authenticator has one server option, which must be set to configure the
25312 authenticator as a server:
25313
25314 .option server_secret cram_md5 string&!! unset
25315 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25316 When the server receives the client's response, the user name is placed in
25317 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25318 obtain the password for that user. The server then computes the CRAM-MD5 digest
25319 that the client should have sent, and checks that it received the correct
25320 string. If the expansion of &%server_secret%& is forced to fail, authentication
25321 fails. If the expansion fails for some other reason, a temporary error code is
25322 returned to the client.
25323
25324 For compatibility with previous releases of Exim, the user name is also placed
25325 in &$1$&. However, the use of this variables for this purpose is now
25326 deprecated, as it can lead to confusion in string expansions that also use
25327 numeric variables for other things.
25328
25329 For example, the following authenticator checks that the user name given by the
25330 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25331 user name, authentication fails.
25332 .code
25333 fixed_cram:
25334   driver = cram_md5
25335   public_name = CRAM-MD5
25336   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25337   server_set_id = $auth1
25338 .endd
25339 .vindex "&$authenticated_id$&"
25340 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25341 name in &$authenticated_id$&. A more typical configuration might look up the
25342 secret string in a file, using the user name as the key. For example:
25343 .code
25344 lookup_cram:
25345   driver = cram_md5
25346   public_name = CRAM-MD5
25347   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25348                   {$value}fail}
25349   server_set_id = $auth1
25350 .endd
25351 Note that this expansion explicitly forces failure if the lookup fails
25352 because &$auth1$& contains an unknown user name.
25353
25354 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25355 using the relevant libraries, you need to know the realm to specify in the
25356 lookup and then ask for the &"userPassword"& attribute for that user in that
25357 realm, with:
25358 .code
25359 cyrusless_crammd5:
25360   driver = cram_md5
25361   public_name = CRAM-MD5
25362   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25363                   dbmjz{/etc/sasldb2}}
25364   server_set_id = $auth1
25365 .endd
25366
25367 .section "Using cram_md5 as a client" "SECID177"
25368 .cindex "options" "&(cram_md5)& authenticator (client)"
25369 When used as a client, the &(cram_md5)& authenticator has two options:
25370
25371
25372
25373 .option client_name cram_md5 string&!! "the primary host name"
25374 This string is expanded, and the result used as the user name data when
25375 computing the response to the server's challenge.
25376
25377
25378 .option client_secret cram_md5 string&!! unset
25379 This option must be set for the authenticator to work as a client. Its value is
25380 expanded and the result used as the secret string when computing the response.
25381
25382
25383 .vindex "&$host$&"
25384 .vindex "&$host_address$&"
25385 Different user names and secrets can be used for different servers by referring
25386 to &$host$& or &$host_address$& in the options. Forced failure of either
25387 expansion string is treated as an indication that this authenticator is not
25388 prepared to handle this case. Exim moves on to the next configured client
25389 authenticator. Any other expansion failure causes Exim to give up trying to
25390 send the message to the current server.
25391
25392 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25393 strings, is:
25394 .code
25395 fixed_cram:
25396   driver = cram_md5
25397   public_name = CRAM-MD5
25398   client_name = ph10
25399   client_secret = secret
25400 .endd
25401 .ecindex IIDcramauth1
25402 .ecindex IIDcramauth2
25403
25404
25405
25406 . ////////////////////////////////////////////////////////////////////////////
25407 . ////////////////////////////////////////////////////////////////////////////
25408
25409 .chapter "The cyrus_sasl authenticator" "CHID10"
25410 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25411 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25412 .cindex "Cyrus" "SASL library"
25413 .cindex "Kerberos"
25414 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25415 Digital Ltd (&url(http://www.aldigital.co.uk)).
25416
25417 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25418 library implementation of the RFC 2222 (&"Simple Authentication and Security
25419 Layer"&). This library supports a number of authentication mechanisms,
25420 including PLAIN and LOGIN, but also several others that Exim does not support
25421 directly. In particular, there is support for Kerberos authentication.
25422
25423 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25424 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25425 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25426 name of the driver to determine which mechanism to support.
25427
25428 Where access to some kind of secret file is required, for example in GSSAPI
25429 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25430 user, and that the Cyrus SASL library has no way of escalating privileges
25431 by default. You may also find you need to set environment variables,
25432 depending on the driver you are using.
25433
25434 The application name provided by Exim is &"exim"&, so various SASL options may
25435 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25436 Kerberos, note that because of limitations in the GSSAPI interface,
25437 changing the server keytab might need to be communicated down to the Kerberos
25438 layer independently. The mechanism for doing so is dependent upon the Kerberos
25439 implementation.
25440
25441 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25442 may be set to point to an alternative keytab file. Exim will pass this
25443 variable through from its own inherited environment when started as root or the
25444 Exim user. The keytab file needs to be readable by the Exim user.
25445 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25446 environment variable.  In practice, for those releases, the Cyrus authenticator
25447 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25448 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25449
25450
25451 .section "Using cyrus_sasl as a server" "SECID178"
25452 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25453 (on a successful authentication) into &$auth1$&. For compatibility with
25454 previous releases of Exim, the username is also placed in &$1$&. However, the
25455 use of this variable for this purpose is now deprecated, as it can lead to
25456 confusion in string expansions that also use numeric variables for other
25457 things.
25458
25459
25460 .option server_hostname cyrus_sasl string&!! "see below"
25461 This option selects the hostname that is used when communicating with the
25462 library. The default value is &`$primary_hostname`&. It is up to the underlying
25463 SASL plug-in what it does with this data.
25464
25465
25466 .option server_mech cyrus_sasl string "see below"
25467 This option selects the authentication mechanism this driver should use. The
25468 default is the value of the generic &%public_name%& option. This option allows
25469 you to use a different underlying mechanism from the advertised name. For
25470 example:
25471 .code
25472 sasl:
25473   driver = cyrus_sasl
25474   public_name = X-ANYTHING
25475   server_mech = CRAM-MD5
25476   server_set_id = $auth1
25477 .endd
25478
25479 .option server_realm cyrus_sasl string&!! unset
25480 This specifies the SASL realm that the server claims to be in.
25481
25482
25483 .option server_service cyrus_sasl string &`smtp`&
25484 This is the SASL service that the server claims to implement.
25485
25486
25487 For straightforward cases, you do not need to set any of the authenticator's
25488 private options. All you need to do is to specify an appropriate mechanism as
25489 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25490 PLAIN, you could have two authenticators as follows:
25491 .code
25492 sasl_cram_md5:
25493   driver = cyrus_sasl
25494   public_name = CRAM-MD5
25495   server_set_id = $auth1
25496
25497 sasl_plain:
25498   driver = cyrus_sasl
25499   public_name = PLAIN
25500   server_set_id = $auth2
25501 .endd
25502 Cyrus SASL does implement the LOGIN authentication method, even though it is
25503 not a standard method. It is disabled by default in the source distribution,
25504 but it is present in many binary distributions.
25505 .ecindex IIDcyrauth1
25506 .ecindex IIDcyrauth2
25507
25508
25509
25510
25511 . ////////////////////////////////////////////////////////////////////////////
25512 . ////////////////////////////////////////////////////////////////////////////
25513 .chapter "The dovecot authenticator" "CHAPdovecot"
25514 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25515 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25516 This authenticator is an interface to the authentication facility of the
25517 Dovecot POP/IMAP server, which can support a number of authentication methods.
25518 Note that Dovecot must be configured to use auth-client not auth-userdb.
25519 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25520 to use the same mechanisms for SMTP authentication. This is a server
25521 authenticator only. There is only one option:
25522
25523 .option server_socket dovecot string unset
25524
25525 This option must specify the socket that is the interface to Dovecot
25526 authentication. The &%public_name%& option must specify an authentication
25527 mechanism that Dovecot is configured to support. You can have several
25528 authenticators for different mechanisms. For example:
25529 .code
25530 dovecot_plain:
25531   driver = dovecot
25532   public_name = PLAIN
25533   server_socket = /var/run/dovecot/auth-client
25534   server_set_id = $auth1
25535
25536 dovecot_ntlm:
25537   driver = dovecot
25538   public_name = NTLM
25539   server_socket = /var/run/dovecot/auth-client
25540   server_set_id = $auth1
25541 .endd
25542 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25543 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25544 option is passed in the Dovecot authentication command. If, for a TLS
25545 connection, a client certificate has been verified, the &"valid-client-cert"&
25546 option is passed. When authentication succeeds, the identity of the user
25547 who authenticated is placed in &$auth1$&.
25548 .ecindex IIDdcotauth1
25549 .ecindex IIDdcotauth2
25550
25551
25552 . ////////////////////////////////////////////////////////////////////////////
25553 . ////////////////////////////////////////////////////////////////////////////
25554 .chapter "The gsasl authenticator" "CHAPgsasl"
25555 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25556 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25557 .cindex "authentication" "GNU SASL"
25558 .cindex "authentication" "SASL"
25559 .cindex "authentication" "EXTERNAL"
25560 .cindex "authentication" "ANONYMOUS"
25561 .cindex "authentication" "PLAIN"
25562 .cindex "authentication" "LOGIN"
25563 .cindex "authentication" "DIGEST-MD5"
25564 .cindex "authentication" "CRAM-MD5"
25565 .cindex "authentication" "SCRAM-SHA-1"
25566 The &(gsasl)& authenticator provides server integration for the GNU SASL
25567 library and the mechanisms it provides.  This is new as of the 4.80 release
25568 and there are a few areas where the library does not let Exim smoothly
25569 scale to handle future authentication mechanisms, so no guarantee can be
25570 made that any particular new authentication mechanism will be supported
25571 without code changes in Exim.
25572
25573
25574 .option server_channelbinding gsasl boolean false
25575 Some authentication mechanisms are able to use external context at both ends
25576 of the session to bind the authentication to that context, and fail the
25577 authentication process if that context differs.  Specifically, some TLS
25578 ciphersuites can provide identifying information about the cryptographic
25579 context.
25580
25581 This means that certificate identity and verification becomes a non-issue,
25582 as a man-in-the-middle attack will cause the correct client and server to
25583 see different identifiers and authentication will fail.
25584
25585 This is currently only supported when using the GnuTLS library.  This is
25586 only usable by mechanisms which support "channel binding"; at time of
25587 writing, that's the SCRAM family.
25588
25589 This defaults off to ensure smooth upgrade across Exim releases, in case
25590 this option causes some clients to start failing.  Some future release
25591 of Exim may switch the default to be true.
25592
25593
25594 .option server_hostname gsasl string&!! "see below"
25595 This option selects the hostname that is used when communicating with the
25596 library. The default value is &`$primary_hostname`&.
25597 Some mechanisms will use this data.
25598
25599
25600 .option server_mech gsasl string "see below"
25601 This option selects the authentication mechanism this driver should use. The
25602 default is the value of the generic &%public_name%& option. This option allows
25603 you to use a different underlying mechanism from the advertised name. For
25604 example:
25605 .code
25606 sasl:
25607   driver = gsasl
25608   public_name = X-ANYTHING
25609   server_mech = CRAM-MD5
25610   server_set_id = $auth1
25611 .endd
25612
25613
25614 .option server_password gsasl string&!! unset
25615 Various mechanisms need access to the cleartext password on the server, so
25616 that proof-of-possession can be demonstrated on the wire, without sending
25617 the password itself.
25618
25619 The data available for lookup varies per mechanism.
25620 In all cases, &$auth1$& is set to the &'authentication id'&.
25621 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25622 if available, else the empty string.
25623 The &$auth3$& variable will always be the &'realm'& if available,
25624 else the empty string.
25625
25626 A forced failure will cause authentication to defer.
25627
25628 If using this option, it may make sense to set the &%server_condition%&
25629 option to be simply "true".
25630
25631
25632 .option server_realm gsasl string&!! unset
25633 This specifies the SASL realm that the server claims to be in.
25634 Some mechanisms will use this data.
25635
25636
25637 .option server_scram_iter gsasl string&!! unset
25638 This option provides data for the SCRAM family of mechanisms.
25639 &$auth1$& is not available at evaluation time.
25640 (This may change, as we receive feedback on use)
25641
25642
25643 .option server_scram_salt gsasl string&!! unset
25644 This option provides data for the SCRAM family of mechanisms.
25645 &$auth1$& is not available at evaluation time.
25646 (This may change, as we receive feedback on use)
25647
25648
25649 .option server_service gsasl string &`smtp`&
25650 This is the SASL service that the server claims to implement.
25651 Some mechanisms will use this data.
25652
25653
25654 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25655 .vindex "&$auth1$&, &$auth2$&, etc"
25656 These may be set when evaluating specific options, as detailed above.
25657 They will also be set when evaluating &%server_condition%&.
25658
25659 Unless otherwise stated below, the &(gsasl)& integration will use the following
25660 meanings for these variables:
25661
25662 .ilist
25663 .vindex "&$auth1$&"
25664 &$auth1$&: the &'authentication id'&
25665 .next
25666 .vindex "&$auth2$&"
25667 &$auth2$&: the &'authorization id'&
25668 .next
25669 .vindex "&$auth3$&"
25670 &$auth3$&: the &'realm'&
25671 .endlist
25672
25673 On a per-mechanism basis:
25674
25675 .ilist
25676 .cindex "authentication" "EXTERNAL"
25677 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25678 the &%server_condition%& option must be present.
25679 .next
25680 .cindex "authentication" "ANONYMOUS"
25681 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25682 the &%server_condition%& option must be present.
25683 .next
25684 .cindex "authentication" "GSSAPI"
25685 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25686 &$auth2$& will be set to the &'authorization id'&,
25687 the &%server_condition%& option must be present.
25688 .endlist
25689
25690 An &'anonymous token'& is something passed along as an unauthenticated
25691 identifier; this is analogous to FTP anonymous authentication passing an
25692 email address, or software-identifier@, as the "password".
25693
25694
25695 An example showing the password having the realm specified in the callback
25696 and demonstrating a Cyrus SASL to GSASL migration approach is:
25697 .code
25698 gsasl_cyrusless_crammd5:
25699   driver = gsasl
25700   public_name = CRAM-MD5
25701   server_realm = imap.example.org
25702   server_password = ${lookup{$auth1:$auth3:userPassword}\
25703                     dbmjz{/etc/sasldb2}{$value}fail}
25704   server_set_id = ${quote:$auth1}
25705   server_condition = yes
25706 .endd
25707
25708
25709 . ////////////////////////////////////////////////////////////////////////////
25710 . ////////////////////////////////////////////////////////////////////////////
25711
25712 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25713 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25714 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25715 .cindex "authentication" "GSSAPI"
25716 .cindex "authentication" "Kerberos"
25717 The &(heimdal_gssapi)& authenticator provides server integration for the
25718 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25719 reliably.
25720
25721 .option server_hostname heimdal_gssapi string&!! "see below"
25722 This option selects the hostname that is used, with &%server_service%&,
25723 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25724 identifier.  The default value is &`$primary_hostname`&.
25725
25726 .option server_keytab heimdal_gssapi string&!! unset
25727 If set, then Heimdal will not use the system default keytab (typically
25728 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25729 The value should be a pathname, with no &"file:"& prefix.
25730
25731 .option server_service heimdal_gssapi string&!! "smtp"
25732 This option specifies the service identifier used, in conjunction with
25733 &%server_hostname%&, for building the identifer for finding credentials
25734 from the keytab.
25735
25736
25737 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25738 Beware that these variables will typically include a realm, thus will appear
25739 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25740 not verified, so a malicious client can set it to anything.
25741
25742 The &$auth1$& field should be safely trustable as a value from the Key
25743 Distribution Center.  Note that these are not quite email addresses.
25744 Each identifier is for a role, and so the left-hand-side may include a
25745 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25746
25747 .vindex "&$auth1$&, &$auth2$&, etc"
25748 .ilist
25749 .vindex "&$auth1$&"
25750 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25751 .next
25752 .vindex "&$auth2$&"
25753 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25754 authentication.  If that was empty, this will also be set to the
25755 GSS Display Name.
25756 .endlist
25757
25758
25759 . ////////////////////////////////////////////////////////////////////////////
25760 . ////////////////////////////////////////////////////////////////////////////
25761
25762 .chapter "The spa authenticator" "CHAPspa"
25763 .scindex IIDspaauth1 "&(spa)& authenticator"
25764 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25765 .cindex "authentication" "Microsoft Secure Password"
25766 .cindex "authentication" "NTLM"
25767 .cindex "Microsoft Secure Password Authentication"
25768 .cindex "NTLM authentication"
25769 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25770 Password Authentication'& mechanism,
25771 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25772 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25773 taken from the Samba project (&url(http://www.samba.org)). The code for the
25774 server side was subsequently contributed by Tom Kistner. The mechanism works as
25775 follows:
25776
25777 .ilist
25778 After the AUTH command has been accepted, the client sends an SPA
25779 authentication request based on the user name and optional domain.
25780 .next
25781 The server sends back a challenge.
25782 .next
25783 The client builds a challenge response which makes use of the user's password
25784 and sends it to the server, which then accepts or rejects it.
25785 .endlist
25786
25787 Encryption is used to protect the password in transit.
25788
25789
25790
25791 .section "Using spa as a server" "SECID179"
25792 .cindex "options" "&(spa)& authenticator (server)"
25793 The &(spa)& authenticator has just one server option:
25794
25795 .option server_password spa string&!! unset
25796 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25797 This option is expanded, and the result must be the cleartext password for the
25798 authenticating user, whose name is at this point in &$auth1$&. For
25799 compatibility with previous releases of Exim, the user name is also placed in
25800 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25801 it can lead to confusion in string expansions that also use numeric variables
25802 for other things. For example:
25803 .code
25804 spa:
25805   driver = spa
25806   public_name = NTLM
25807   server_password = \
25808     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25809 .endd
25810 If the expansion is forced to fail, authentication fails. Any other expansion
25811 failure causes a temporary error code to be returned.
25812
25813
25814
25815
25816
25817 .section "Using spa as a client" "SECID180"
25818 .cindex "options" "&(spa)& authenticator (client)"
25819 The &(spa)& authenticator has the following client options:
25820
25821
25822
25823 .option client_domain spa string&!! unset
25824 This option specifies an optional domain for the authentication.
25825
25826
25827 .option client_password spa string&!! unset
25828 This option specifies the user's password, and must be set.
25829
25830
25831 .option client_username spa string&!! unset
25832 This option specifies the user name, and must be set. Here is an example of a
25833 configuration of this authenticator for use with the mail servers at
25834 &'msn.com'&:
25835 .code
25836 msn:
25837   driver = spa
25838   public_name = MSN
25839   client_username = msn/msn_username
25840   client_password = msn_plaintext_password
25841   client_domain = DOMAIN_OR_UNSET
25842 .endd
25843 .ecindex IIDspaauth1
25844 .ecindex IIDspaauth2
25845
25846
25847
25848
25849
25850 . ////////////////////////////////////////////////////////////////////////////
25851 . ////////////////////////////////////////////////////////////////////////////
25852
25853 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25854          "Encrypted SMTP connections"
25855 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25856 .scindex IIDencsmtp2 "SMTP" "encryption"
25857 .cindex "TLS" "on SMTP connection"
25858 .cindex "OpenSSL"
25859 .cindex "GnuTLS"
25860 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25861 Sockets Layer), is implemented by making use of the OpenSSL library or the
25862 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25863 cryptographic code in the Exim distribution itself for implementing TLS. In
25864 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25865 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25866 You also need to understand the basic concepts of encryption at a managerial
25867 level, and in particular, the way that public keys, private keys, and
25868 certificates are used.
25869
25870 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25871 connection is established, the client issues a STARTTLS command. If the
25872 server accepts this, the client and the server negotiate an encryption
25873 mechanism. If the negotiation succeeds, the data that subsequently passes
25874 between them is encrypted.
25875
25876 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25877 and if so, what cipher suite is in use, whether the client supplied a
25878 certificate, and whether or not that certificate was verified. This makes it
25879 possible for an Exim server to deny or accept certain commands based on the
25880 encryption state.
25881
25882 &*Warning*&: Certain types of firewall and certain anti-virus products can
25883 disrupt TLS connections. You need to turn off SMTP scanning for these products
25884 in order to get TLS to work.
25885
25886
25887
25888 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25889          "SECID284"
25890 .cindex "ssmtp protocol"
25891 .cindex "smtps protocol"
25892 .cindex "SMTP" "ssmtp protocol"
25893 .cindex "SMTP" "smtps protocol"
25894 Early implementations of encrypted SMTP used a different TCP port from normal
25895 SMTP, and expected an encryption negotiation to start immediately, instead of
25896 waiting for a STARTTLS command from the client using the standard SMTP
25897 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25898 allocated for this purpose.
25899
25900 This approach was abandoned when encrypted SMTP was standardized, but there are
25901 still some legacy clients that use it. Exim supports these clients by means of
25902 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25903 numbers; the most common use is expected to be:
25904 .code
25905 tls_on_connect_ports = 465
25906 .endd
25907 The port numbers specified by this option apply to all SMTP connections, both
25908 via the daemon and via &'inetd'&. You still need to specify all the ports that
25909 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25910 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25911 an extra port &-- rather, it specifies different behaviour on a port that is
25912 defined elsewhere.
25913
25914 There is also a &%-tls-on-connect%& command line option. This overrides
25915 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25916
25917
25918
25919
25920
25921
25922 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25923 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25924 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25925 followed later, when the first versions of GnuTLS were released. To build Exim
25926 to use GnuTLS, you need to set
25927 .code
25928 USE_GNUTLS=yes
25929 .endd
25930 in Local/Makefile, in addition to
25931 .code
25932 SUPPORT_TLS=yes
25933 .endd
25934 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25935 include files and libraries for GnuTLS can be found.
25936
25937 There are some differences in usage when using GnuTLS instead of OpenSSL:
25938
25939 .ilist
25940 The &%tls_verify_certificates%& option must contain the name of a file, not the
25941 name of a directory for GnuTLS versions before 3.3.6
25942 (for later versions, or OpenSSL, it can be either).
25943 .next
25944 The default value for &%tls_dhparam%& differs for historical reasons.
25945 .next
25946 .vindex "&$tls_in_peerdn$&"
25947 .vindex "&$tls_out_peerdn$&"
25948 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25949 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25950 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25951 .next
25952 OpenSSL identifies cipher suites using hyphens as separators, for example:
25953 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25954 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25955 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25956 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25957 to handle its own older variants) when processing lists of cipher suites in the
25958 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25959 option).
25960 .next
25961 The &%tls_require_ciphers%& options operate differently, as described in the
25962 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25963 .next
25964 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25965 When using OpenSSL, this option is ignored.
25966 (If an API is found to let OpenSSL be configured in this way,
25967 let the Exim Maintainers know and we'll likely use it).
25968 .next
25969 Some other recently added features may only be available in one or the other.
25970 This should be documented with the feature.  If the documentation does not
25971 explicitly state that the feature is infeasible in the other TLS
25972 implementation, then patches are welcome.
25973 .endlist
25974
25975
25976 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25977 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25978 an explicit path; if the latter, then the text about generation still applies,
25979 but not the chosen filename.
25980 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25981 See the documentation of &%tls_dhparam%& for more information.
25982
25983 GnuTLS uses D-H parameters that may take a substantial amount of time
25984 to compute. It is unreasonable to re-compute them for every TLS session.
25985 Therefore, Exim keeps this data in a file in its spool directory, called
25986 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25987 of bits requested.
25988 The file is owned by the Exim user and is readable only by
25989 its owner. Every Exim process that start up GnuTLS reads the D-H
25990 parameters from this file. If the file does not exist, the first Exim process
25991 that needs it computes the data and writes it to a temporary file which is
25992 renamed once it is complete. It does not matter if several Exim processes do
25993 this simultaneously (apart from wasting a few resources). Once a file is in
25994 place, new Exim processes immediately start using it.
25995
25996 For maximum security, the parameters that are stored in this file should be
25997 recalculated periodically, the frequency depending on your paranoia level.
25998 If you are avoiding using the fixed D-H primes published in RFCs, then you
25999 are concerned about some advanced attacks and will wish to do this; if you do
26000 not regenerate then you might as well stick to the standard primes.
26001
26002 Arranging this is easy in principle; just delete the file when you want new
26003 values to be computed. However, there may be a problem. The calculation of new
26004 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26005 If the system is not very active, &_/dev/random_& may delay returning data
26006 until enough randomness (entropy) is available. This may cause Exim to hang for
26007 a substantial amount of time, causing timeouts on incoming connections.
26008
26009 The solution is to generate the parameters externally to Exim. They are stored
26010 in &_gnutls-params-N_& in PEM format, which means that they can be
26011 generated externally using the &(certtool)& command that is part of GnuTLS.
26012
26013 To replace the parameters with new ones, instead of deleting the file
26014 and letting Exim re-create it, you can generate new parameters using
26015 &(certtool)& and, when this has been done, replace Exim's cache file by
26016 renaming. The relevant commands are something like this:
26017 .code
26018 # ls
26019 [ look for file; assume gnutls-params-2236 is the most recent ]
26020 # rm -f new-params
26021 # touch new-params
26022 # chown exim:exim new-params
26023 # chmod 0600 new-params
26024 # certtool --generate-dh-params --bits 2236 >>new-params
26025 # openssl dhparam -noout -text -in new-params | head
26026 [ check the first line, make sure it's not more than 2236;
26027   if it is, then go back to the start ("rm") and repeat
26028   until the size generated is at most the size requested ]
26029 # chmod 0400 new-params
26030 # mv new-params gnutls-params-2236
26031 .endd
26032 If Exim never has to generate the parameters itself, the possibility of
26033 stalling is removed.
26034
26035 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26036 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26037 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26038 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26039 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26040 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26041 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26042 which applies to all D-H usage, client or server.  If the value returned by
26043 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26044 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26045 limit, which is still much higher than Exim historically used.
26046
26047 The filename and bits used will change as the GnuTLS maintainers change the
26048 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26049 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26050 2432 bits, while NSS is limited to 2236 bits.
26051
26052 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26053 increase the chance of the generated prime actually being within acceptable
26054 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26055 procedure above.  There is no sane procedure available to Exim to double-check
26056 the size of the generated prime, so it might still be too large.
26057
26058
26059 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26060 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26061 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26062 There is a function in the OpenSSL library that can be passed a list of cipher
26063 suites before the cipher negotiation takes place. This specifies which ciphers
26064 are acceptable. The list is colon separated and may contain names like
26065 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26066 directly to this function call.
26067 Many systems will install the OpenSSL manual-pages, so you may have
26068 &'ciphers(1)'& available to you.
26069 The following quotation from the OpenSSL
26070 documentation specifies what forms of item are allowed in the cipher string:
26071
26072 .ilist
26073 It can consist of a single cipher suite such as RC4-SHA.
26074 .next
26075 It can represent a list of cipher suites containing a certain algorithm,
26076 or cipher suites of a certain type. For example SHA1 represents all
26077 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26078 SSL v3 algorithms.
26079 .next
26080 Lists of cipher suites can be combined in a single cipher string using
26081 the + character. This is used as a logical and operation. For example
26082 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26083 algorithms.
26084 .endlist
26085
26086 Each cipher string can be optionally preceded by one of the characters &`!`&,
26087 &`-`& or &`+`&.
26088 .ilist
26089 If &`!`& is used, the ciphers are permanently deleted from the list. The
26090 ciphers deleted can never reappear in the list even if they are explicitly
26091 stated.
26092 .next
26093 If &`-`& is used, the ciphers are deleted from the list, but some or all
26094 of the ciphers can be added again by later options.
26095 .next
26096 If &`+`& is used, the ciphers are moved to the end of the list. This
26097 option does not add any new ciphers; it just moves matching existing ones.
26098 .endlist
26099
26100 If none of these characters is present, the string is interpreted as
26101 a list of ciphers to be appended to the current preference list. If the list
26102 includes any ciphers already present they will be ignored: that is, they will
26103 not be moved to the end of the list.
26104 .endlist
26105
26106 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26107 string:
26108 .code
26109 # note single-quotes to get ! past any shell history expansion
26110 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26111 .endd
26112
26113 This example will let the library defaults be permitted on the MX port, where
26114 there's probably no identity verification anyway, but ups the ante on the
26115 submission ports where the administrator might have some influence on the
26116 choice of clients used:
26117 .code
26118 # OpenSSL variant; see man ciphers(1)
26119 tls_require_ciphers = ${if =={$received_port}{25}\
26120                            {DEFAULT}\
26121                            {HIGH:!MD5:!SHA1}}
26122 .endd
26123
26124
26125
26126 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26127          "SECTreqciphgnu"
26128 .cindex "GnuTLS" "specifying parameters for"
26129 .cindex "TLS" "specifying ciphers (GnuTLS)"
26130 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26131 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26132 .cindex "TLS" "specifying protocols (GnuTLS)"
26133 .cindex "TLS" "specifying priority string (GnuTLS)"
26134 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26135 The GnuTLS library allows the caller to provide a "priority string", documented
26136 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26137 ciphersuite specification in OpenSSL.
26138
26139 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26140 and controls both protocols and ciphers.
26141
26142 The &%tls_require_ciphers%& option is available both as an global option,
26143 controlling how Exim behaves as a server, and also as an option of the
26144 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26145 the value is string expanded.  The resulting string is not an Exim list and
26146 the string is given to the GnuTLS library, so that Exim does not need to be
26147 aware of future feature enhancements of GnuTLS.
26148
26149 Documentation of the strings accepted may be found in the GnuTLS manual, under
26150 "Priority strings".  This is online as
26151 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26152 but beware that this relates to GnuTLS 3, which may be newer than the version
26153 installed on your system.  If you are using GnuTLS 3,
26154 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26155 on that site can be used to test a given string.
26156
26157 For example:
26158 .code
26159 # Disable older versions of protocols
26160 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26161 .endd
26162
26163 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26164 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26165 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26166
26167 This example will let the library defaults be permitted on the MX port, where
26168 there's probably no identity verification anyway, and lowers security further
26169 by increasing compatibility; but this ups the ante on the submission ports
26170 where the administrator might have some influence on the choice of clients
26171 used:
26172 .code
26173 # GnuTLS variant
26174 tls_require_ciphers = ${if =={$received_port}{25}\
26175                            {NORMAL:%COMPAT}\
26176                            {SECURE128}}
26177 .endd
26178
26179
26180 .section "Configuring an Exim server to use TLS" "SECID182"
26181 .cindex "TLS" "configuring an Exim server"
26182 When Exim has been built with TLS support, it advertises the availability of
26183 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26184 but not to any others. The default value of this option is unset, which means
26185 that STARTTLS is not advertised at all. This default is chosen because you
26186 need to set some other options in order to make TLS available, and also it is
26187 sensible for systems that want to use TLS only as a client.
26188
26189 If a client issues a STARTTLS command and there is some configuration
26190 problem in the server, the command is rejected with a 454 error. If the client
26191 persists in trying to issue SMTP commands, all except QUIT are rejected
26192 with the error
26193 .code
26194 554 Security failure
26195 .endd
26196 If a STARTTLS command is issued within an existing TLS session, it is
26197 rejected with a 554 error code.
26198
26199 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26200 match some hosts. You can, of course, set it to * to match all hosts.
26201 However, this is not all you need to do. TLS sessions to a server won't work
26202 without some further configuration at the server end.
26203
26204 It is rumoured that all existing clients that support TLS/SSL use RSA
26205 encryption. To make this work you need to set, in the server,
26206 .code
26207 tls_certificate = /some/file/name
26208 tls_privatekey = /some/file/name
26209 .endd
26210 These options are, in fact, expanded strings, so you can make them depend on
26211 the identity of the client that is connected if you wish. The first file
26212 contains the server's X509 certificate, and the second contains the private key
26213 that goes with it. These files need to be
26214 PEM format and readable by the Exim user, and must
26215 always be given as full path names.
26216 The key must not be password-protected.
26217 They can be the same file if both the
26218 certificate and the key are contained within it. If &%tls_privatekey%& is not
26219 set, or if its expansion is forced to fail or results in an empty string, this
26220 is assumed to be the case. The certificate file may also contain intermediate
26221 certificates that need to be sent to the client to enable it to authenticate
26222 the server's certificate.
26223
26224 If you do not understand about certificates and keys, please try to find a
26225 source of this background information, which is not Exim-specific. (There are a
26226 few comments below in section &<<SECTcerandall>>&.)
26227
26228 &*Note*&: These options do not apply when Exim is operating as a client &--
26229 they apply only in the case of a server. If you need to use a certificate in an
26230 Exim client, you must set the options of the same names in an &(smtp)&
26231 transport.
26232
26233 With just these options, an Exim server will be able to use TLS. It does not
26234 require the client to have a certificate (but see below for how to insist on
26235 this). There is one other option that may be needed in other situations. If
26236 .code
26237 tls_dhparam = /some/file/name
26238 .endd
26239 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26240 with the parameters contained in the file.
26241 Set this to &`none`& to disable use of DH entirely, by making no prime
26242 available:
26243 .code
26244 tls_dhparam = none
26245 .endd
26246 This may also be set to a string identifying a standard prime to be used for
26247 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26248 used is &`ike23`&.  There are a few standard primes available, see the
26249 documentation for &%tls_dhparam%& for the complete list.
26250
26251 See the command
26252 .code
26253 openssl dhparam
26254 .endd
26255 for a way of generating file data.
26256
26257 The strings supplied for these three options are expanded every time a client
26258 host connects. It is therefore possible to use different certificates and keys
26259 for different hosts, if you so wish, by making use of the client's IP address
26260 in &$sender_host_address$& to control the expansion. If a string expansion is
26261 forced to fail, Exim behaves as if the option is not set.
26262
26263 .cindex "cipher" "logging"
26264 .cindex "log" "TLS cipher"
26265 .vindex "&$tls_in_cipher$&"
26266 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26267 an incoming TLS connection. It is included in the &'Received:'& header of an
26268 incoming message (by default &-- you can, of course, change this), and it is
26269 also included in the log line that records a message's arrival, keyed by
26270 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26271 condition can be used to test for specific cipher suites in ACLs.
26272
26273 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26274 can check the name of the cipher suite and vary their actions accordingly. The
26275 cipher suite names vary, depending on which TLS library is being used. For
26276 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26277 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26278 documentation for more details.
26279
26280 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26281 (again depending on the &%tls_cipher%& log selector).
26282
26283
26284 .section "Requesting and verifying client certificates" "SECID183"
26285 .cindex "certificate" "verification of client"
26286 .cindex "TLS" "client certificate verification"
26287 If you want an Exim server to request a certificate when negotiating a TLS
26288 session with a client, you must set either &%tls_verify_hosts%& or
26289 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26290 apply to all TLS connections. For any host that matches one of these options,
26291 Exim requests a certificate as part of the setup of the TLS session. The
26292 contents of the certificate are verified by comparing it with a list of
26293 expected certificates. These must be available in a file or,
26294 for OpenSSL only (not GnuTLS), a directory, identified by
26295 &%tls_verify_certificates%&.
26296
26297 A file can contain multiple certificates, concatenated end to end. If a
26298 directory is used
26299 (OpenSSL only),
26300 each certificate must be in a separate file, with a name (or a symbolic link)
26301 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26302 certificate. You can compute the relevant hash by running the command
26303 .code
26304 openssl x509 -hash -noout -in /cert/file
26305 .endd
26306 where &_/cert/file_& contains a single certificate.
26307
26308 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26309 what happens if the client does not supply a certificate, or if the certificate
26310 does not match any of the certificates in the collection named by
26311 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26312 attempt to set up a TLS session is aborted, and the incoming connection is
26313 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26314 session continues. ACLs that run for subsequent SMTP commands can detect the
26315 fact that no certificate was verified, and vary their actions accordingly. For
26316 example, you can insist on a certificate before accepting a message for
26317 relaying, but not when the message is destined for local delivery.
26318
26319 .vindex "&$tls_in_peerdn$&"
26320 When a client supplies a certificate (whether it verifies or not), the value of
26321 the Distinguished Name of the certificate is made available in the variable
26322 &$tls_in_peerdn$& during subsequent processing of the message.
26323
26324 .cindex "log" "distinguished name"
26325 Because it is often a long text string, it is not included in the log line or
26326 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26327 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26328 &%received_header_text%& to change the &'Received:'& header. When no
26329 certificate is supplied, &$tls_in_peerdn$& is empty.
26330
26331
26332 .section "Revoked certificates" "SECID184"
26333 .cindex "TLS" "revoked certificates"
26334 .cindex "revocation list"
26335 .cindex "certificate" "revocation list"
26336 .cindex "OCSP" "stapling"
26337 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26338 certificates are revoked. If you have such a list, you can pass it to an Exim
26339 server using the global option called &%tls_crl%& and to an Exim client using
26340 an identically named option for the &(smtp)& transport. In each case, the value
26341 of the option is expanded and must then be the name of a file that contains a
26342 CRL in PEM format.
26343 The downside is that clients have to periodically re-download a potentially huge
26344 file from every certificate authority they know of.
26345
26346 The way with most moving parts at query time is Online Certificate
26347 Status Protocol (OCSP), where the client verifies the certificate
26348 against an OCSP server run by the CA.  This lets the CA track all
26349 usage of the certs.  It requires running software with access to the
26350 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26351 is based on HTTP and can be proxied accordingly.
26352
26353 The only widespread OCSP server implementation (known to this writer)
26354 comes as part of OpenSSL and aborts on an invalid request, such as
26355 connecting to the port and then disconnecting.  This requires
26356 re-entering the passphrase each time some random client does this.
26357
26358 The third way is OCSP Stapling; in this, the server using a certificate
26359 issued by the CA periodically requests an OCSP proof of validity from
26360 the OCSP server, then serves it up inline as part of the TLS
26361 negotiation.   This approach adds no extra round trips, does not let the
26362 CA track users, scales well with number of certs issued by the CA and is
26363 resilient to temporary OCSP server failures, as long as the server
26364 starts retrying to fetch an OCSP proof some time before its current
26365 proof expires.  The downside is that it requires server support.
26366
26367 Unless Exim is built with the support disabled,
26368 or with GnuTLS earlier than version 3.1.3,
26369 support for OCSP stapling is included.
26370
26371 There is a global option called &%tls_ocsp_file%&.
26372 The file specified therein is expected to be in DER format, and contain
26373 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26374 option will be re-expanded for SNI, if the &%tls_certificate%& option
26375 contains &`tls_in_sni`&, as per other TLS options.
26376
26377 Exim does not at this time implement any support for fetching a new OCSP
26378 proof.  The burden is on the administrator to handle this, outside of
26379 Exim.  The file specified should be replaced atomically, so that the
26380 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26381 on each connection, so a new file will be handled transparently on the
26382 next connection.
26383
26384 When built with OpenSSL Exim will check for a valid next update timestamp
26385 in the OCSP proof; if not present, or if the proof has expired, it will be
26386 ignored.
26387
26388 For the client to be able to verify the stapled OCSP the server must
26389 also supply, in its stapled information, any intermediate
26390 certificates for the chain leading to the OCSP proof from the signer
26391 of the server certificate.  There may be zero or one such. These
26392 intermediate certificates should be added to the server OCSP stapling
26393 file named by &%tls_ocsp_file%&.
26394
26395 Note that the proof only covers the terminal server certificate,
26396 not any of the chain from CA to it.
26397
26398 There is no current way to staple a proof for a client certificate.
26399
26400 .code
26401   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26402   OCSP server is supplied.  The server URL may be included in the
26403   server certificate, if the CA is helpful.
26404
26405   One failure mode seen was the OCSP Signer cert expiring before the end
26406   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26407   noted this as invalid overall, but the re-fetch script did not.
26408 .endd
26409
26410
26411
26412
26413 .section "Configuring an Exim client to use TLS" "SECID185"
26414 .cindex "cipher" "logging"
26415 .cindex "log" "TLS cipher"
26416 .cindex "log" "distinguished name"
26417 .cindex "TLS" "configuring an Exim client"
26418 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26419 deliveries as well as to incoming, the latter one causing logging of the
26420 server certificate's DN. The remaining client configuration for TLS is all
26421 within the &(smtp)& transport.
26422
26423 It is not necessary to set any options to have TLS work in the &(smtp)&
26424 transport. If Exim is built with TLS support, and TLS is advertised by a
26425 server, the &(smtp)& transport always tries to start a TLS session. However,
26426 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26427 transport) to a list of server hosts for which TLS should not be used.
26428
26429 If you do not want Exim to attempt to send messages unencrypted when an attempt
26430 to set up an encrypted connection fails in any way, you can set
26431 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26432 those hosts, delivery is always deferred if an encrypted connection cannot be
26433 set up. If there are any other hosts for the address, they are tried in the
26434 usual way.
26435
26436 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26437 the message unencrypted. It always does this if the response to STARTTLS is
26438 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26439 session after a success response code, what happens is controlled by the
26440 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26441 delivery to this host is deferred, and other hosts (if available) are tried. If
26442 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26443 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26444 negotiation fails, Exim closes the current connection (because it is in an
26445 unknown state), opens a new one to the same host, and then tries the delivery
26446 unencrypted.
26447
26448 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26449 transport provide the client with a certificate, which is passed to the server
26450 if it requests it. If the server is Exim, it will request a certificate only if
26451 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26452
26453 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26454 must name a file or,
26455 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
26456 expected server certificates. The client verifies the server's certificate
26457 against this collection, taking into account any revoked certificates that are
26458 in the list defined by &%tls_crl%&.
26459 Failure to verify fails the TLS connection unless either of the
26460 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26461
26462 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26463 certificate verification to the listed servers.  Verification either must
26464 or need not succeed respectively.
26465
26466 The &(smtp)& transport has two OCSP-related options:
26467 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26468 is requested and required for the connection to proceed.  The default
26469 value is empty.
26470 &%hosts_request_ocsp%&; a host-list for which (additionally)
26471 a Certificate Status is requested (but not necessarily verified).  The default
26472 value is "*" meaning that requests are made unless configured
26473 otherwise.
26474
26475 The host(s) should also be in &%hosts_require_tls%&, and
26476 &%tls_verify_certificates%& configured for the transport,
26477 for OCSP to be relevant.
26478
26479 If
26480 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26481 list of permitted cipher suites. If either of these checks fails, delivery to
26482 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26483 alternative hosts, if any.
26484
26485  &*Note*&:
26486 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26487 is operating as a client. Exim does not assume that a server certificate (set
26488 by the global options of the same name) should also be used when operating as a
26489 client.
26490
26491 .vindex "&$host$&"
26492 .vindex "&$host_address$&"
26493 All the TLS options in the &(smtp)& transport are expanded before use, with
26494 &$host$& and &$host_address$& containing the name and address of the server to
26495 which the client is connected. Forced failure of an expansion causes Exim to
26496 behave as if the relevant option were unset.
26497
26498 .vindex &$tls_out_bits$&
26499 .vindex &$tls_out_cipher$&
26500 .vindex &$tls_out_peerdn$&
26501 .vindex &$tls_out_sni$&
26502 Before an SMTP connection is established, the
26503 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26504 variables are emptied. (Until the first connection, they contain the values
26505 that were set when the message was received.) If STARTTLS is subsequently
26506 successfully obeyed, these variables are set to the relevant values for the
26507 outgoing connection.
26508
26509
26510
26511 .section "Use of TLS Server Name Indication" "SECTtlssni"
26512 .cindex "TLS" "Server Name Indication"
26513 .vindex "&$tls_in_sni$&"
26514 .oindex "&%tls_in_sni%&"
26515 With TLS1.0 or above, there is an extension mechanism by which extra
26516 information can be included at various points in the protocol.  One of these
26517 extensions, documented in RFC 6066 (and before that RFC 4366) is
26518 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26519 client in the initial handshake, so that the server can examine the servername
26520 within and possibly choose to use different certificates and keys (and more)
26521 for this session.
26522
26523 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26524 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26525 address.
26526
26527 With SMTP to MX, there are the same problems here as in choosing the identity
26528 against which to validate a certificate: you can't rely on insecure DNS to
26529 provide the identity which you then cryptographically verify.  So this will
26530 be of limited use in that environment.
26531
26532 With SMTP to Submission, there is a well-defined hostname which clients are
26533 connecting to and can validate certificates against.  Thus clients &*can*&
26534 choose to include this information in the TLS negotiation.  If this becomes
26535 wide-spread, then hosters can choose to present different certificates to
26536 different clients.  Or even negotiate different cipher suites.
26537
26538 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26539 if not empty, will be sent on a TLS session as part of the handshake.  There's
26540 nothing more to it.  Choosing a sensible value not derived insecurely is the
26541 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26542 for the lifetime of the client connection (including during authentication).
26543
26544 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26545 received from a client.
26546 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26547
26548 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26549 option (prior to expansion) then the following options will be re-expanded
26550 during TLS session handshake, to permit alternative values to be chosen:
26551
26552 .ilist
26553 .vindex "&%tls_certificate%&"
26554 &%tls_certificate%&
26555 .next
26556 .vindex "&%tls_crl%&"
26557 &%tls_crl%&
26558 .next
26559 .vindex "&%tls_privatekey%&"
26560 &%tls_privatekey%&
26561 .next
26562 .vindex "&%tls_verify_certificates%&"
26563 &%tls_verify_certificates%&
26564 .next
26565 .vindex "&%tls_ocsp_file%&"
26566 &%tls_verify_certificates%&
26567 .endlist
26568
26569 Great care should be taken to deal with matters of case, various injection
26570 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26571 can always be referenced; it is important to remember that &$tls_sni$& is
26572 arbitrary unverified data provided prior to authentication.
26573
26574 The Exim developers are proceeding cautiously and so far no other TLS options
26575 are re-expanded.
26576
26577 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26578 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26579 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26580 see &`-servername`& in the output, then OpenSSL has support.
26581
26582 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26583 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26584 built, then you have SNI support).
26585
26586
26587
26588 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26589          "SECTmulmessam"
26590 .cindex "multiple SMTP deliveries with TLS"
26591 .cindex "TLS" "multiple message deliveries"
26592 Exim sends multiple messages down the same TCP/IP connection by starting up
26593 an entirely new delivery process for each message, passing the socket from
26594 one process to the next. This implementation does not fit well with the use
26595 of TLS, because there is quite a lot of state information associated with a TLS
26596 connection, not just a socket identification. Passing all the state information
26597 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26598 session before passing the socket to a new process. The new process may then
26599 try to start a new TLS session, and if successful, may try to re-authenticate
26600 if AUTH is in use, before sending the next message.
26601
26602 The RFC is not clear as to whether or not an SMTP session continues in clear
26603 after TLS has been shut down, or whether TLS may be restarted again later, as
26604 just described. However, if the server is Exim, this shutdown and
26605 reinitialization works. It is not known which (if any) other servers operate
26606 successfully if the client closes a TLS session and continues with unencrypted
26607 SMTP, but there are certainly some that do not work. For such servers, Exim
26608 should not pass the socket to another process, because the failure of the
26609 subsequent attempt to use it would cause Exim to record a temporary host error,
26610 and delay other deliveries to that host.
26611
26612 To test for this case, Exim sends an EHLO command to the server after
26613 closing down the TLS session. If this fails in any way, the connection is
26614 closed instead of being passed to a new delivery process, but no retry
26615 information is recorded.
26616
26617 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26618 &(smtp)& transport to match those hosts for which Exim should not pass
26619 connections to new processes if TLS has been used.
26620
26621
26622
26623
26624 .section "Certificates and all that" "SECTcerandall"
26625 .cindex "certificate" "references to discussion"
26626 In order to understand fully how TLS works, you need to know about
26627 certificates, certificate signing, and certificate authorities. This is not the
26628 place to give a tutorial, especially as I do not know very much about it
26629 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26630 to Apache, currently at
26631 .display
26632 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26633 .endd
26634 Other parts of the &'modssl'& documentation are also helpful, and have
26635 links to further files.
26636 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26637 0-201-61598-3), contains both introductory and more in-depth descriptions.
26638 Some sample programs taken from the book are available from
26639 .display
26640 &url(http://www.rtfm.com/openssl-examples/)
26641 .endd
26642
26643
26644 .section "Certificate chains" "SECID186"
26645 The file named by &%tls_certificate%& may contain more than one
26646 certificate. This is useful in the case where the certificate that is being
26647 sent is validated by an intermediate certificate which the other end does
26648 not have. Multiple certificates must be in the correct order in the file.
26649 First the host's certificate itself, then the first intermediate
26650 certificate to validate the issuer of the host certificate, then the next
26651 intermediate certificate to validate the issuer of the first intermediate
26652 certificate, and so on, until finally (optionally) the root certificate.
26653 The root certificate must already be trusted by the recipient for
26654 validation to succeed, of course, but if it's not preinstalled, sending the
26655 root certificate along with the rest makes it available for the user to
26656 install if the receiving end is a client MUA that can interact with a user.
26657
26658 Note that certificates using MD5 are unlikely to work on today's Internet;
26659 even if your libraries allow loading them for use in Exim when acting as a
26660 server, increasingly clients will not accept such certificates.  The error
26661 diagnostics in such a case can be frustratingly vague.
26662
26663
26664
26665 .section "Self-signed certificates" "SECID187"
26666 .cindex "certificate" "self-signed"
26667 You can create a self-signed certificate using the &'req'& command provided
26668 with OpenSSL, like this:
26669 . ==== Do not shorten the duration here without reading and considering
26670 . ==== the text below.  Please leave it at 9999 days.
26671 .code
26672 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26673             -days 9999 -nodes
26674 .endd
26675 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26676 delimited and so can be identified independently. The &%-days%& option
26677 specifies a period for which the certificate is valid. The &%-nodes%& option is
26678 important: if you do not set it, the key is encrypted with a passphrase
26679 that you are prompted for, and any use that is made of the key causes more
26680 prompting for the passphrase. This is not helpful if you are going to use
26681 this certificate and key in an MTA, where prompting is not possible.
26682
26683 . ==== I expect to still be working 26 years from now.  The less technical
26684 . ==== debt I create, in terms of storing up trouble for my later years, the
26685 . ==== happier I will be then.  We really have reached the point where we
26686 . ==== should start, at the very least, provoking thought and making folks
26687 . ==== pause before proceeding, instead of leaving all the fixes until two
26688 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26689 . ==== -pdp, 2012
26690 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26691 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26692 the above command might produce a date in the past.  Think carefully about
26693 the lifetime of the systems you're deploying, and either reduce the duration
26694 of the certificate or reconsider your platform deployment.  (At time of
26695 writing, reducing the duration is the most likely choice, but the inexorable
26696 progression of time takes us steadily towards an era where this will not
26697 be a sensible resolution).
26698
26699 A self-signed certificate made in this way is sufficient for testing, and
26700 may be adequate for all your requirements if you are mainly interested in
26701 encrypting transfers, and not in secure identification.
26702
26703 However, many clients require that the certificate presented by the server be a
26704 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26705 certificate. In this situation, the self-signed certificate described above
26706 must be installed on the client host as a trusted root &'certification
26707 authority'& (CA), and the certificate used by Exim must be a user certificate
26708 signed with that self-signed certificate.
26709
26710 For information on creating self-signed CA certificates and using them to sign
26711 user certificates, see the &'General implementation overview'& chapter of the
26712 Open-source PKI book, available online at
26713 &url(http://ospkibook.sourceforge.net/).
26714 .ecindex IIDencsmtp1
26715 .ecindex IIDencsmtp2
26716
26717
26718
26719 . ////////////////////////////////////////////////////////////////////////////
26720 . ////////////////////////////////////////////////////////////////////////////
26721
26722 .chapter "Access control lists" "CHAPACL"
26723 .scindex IIDacl "&ACL;" "description"
26724 .cindex "control of incoming mail"
26725 .cindex "message" "controlling incoming"
26726 .cindex "policy control" "access control lists"
26727 Access Control Lists (ACLs) are defined in a separate section of the run time
26728 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26729 name, terminated by a colon. Here is a complete ACL section that contains just
26730 one very small ACL:
26731 .code
26732 begin acl
26733 small_acl:
26734   accept   hosts = one.host.only
26735 .endd
26736 You can have as many lists as you like in the ACL section, and the order in
26737 which they appear does not matter. The lists are self-terminating.
26738
26739 The majority of ACLs are used to control Exim's behaviour when it receives
26740 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26741 when a local process submits a message using SMTP by specifying the &%-bs%&
26742 option. The most common use is for controlling which recipients are accepted
26743 in incoming messages. In addition, you can define an ACL that is used to check
26744 local non-SMTP messages. The default configuration file contains an example of
26745 a realistic ACL for checking RCPT commands. This is discussed in chapter
26746 &<<CHAPdefconfil>>&.
26747
26748
26749 .section "Testing ACLs" "SECID188"
26750 The &%-bh%& command line option provides a way of testing your ACL
26751 configuration locally by running a fake SMTP session with which you interact.
26752 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26753 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26754
26755
26756
26757 .section "Specifying when ACLs are used" "SECID189"
26758 .cindex "&ACL;" "options for specifying"
26759 In order to cause an ACL to be used, you have to name it in one of the relevant
26760 options in the main part of the configuration. These options are:
26761 .cindex "AUTH" "ACL for"
26762 .cindex "DATA" "ACLs for"
26763 .cindex "ETRN" "ACL for"
26764 .cindex "EXPN" "ACL for"
26765 .cindex "HELO" "ACL for"
26766 .cindex "EHLO" "ACL for"
26767 .cindex "MAIL" "ACL for"
26768 .cindex "QUIT, ACL for"
26769 .cindex "RCPT" "ACL for"
26770 .cindex "STARTTLS, ACL for"
26771 .cindex "VRFY" "ACL for"
26772 .cindex "SMTP" "connection, ACL for"
26773 .cindex "non-SMTP messages" "ACLs for"
26774 .cindex "MIME content scanning" "ACL for"
26775 .cindex "PRDR" "ACL for"
26776
26777 .table2 140pt
26778 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26779 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26780 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26781 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26782 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26783 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26784 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26785 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26786 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26787 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26788 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26789 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26790 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26791 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26792 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26793 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26794 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26795 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26796 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26797 .endtable
26798
26799 For example, if you set
26800 .code
26801 acl_smtp_rcpt = small_acl
26802 .endd
26803 the little ACL defined above is used whenever Exim receives a RCPT command
26804 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26805 done when RCPT commands arrive. A rejection of RCPT should cause the
26806 sending MTA to give up on the recipient address contained in the RCPT
26807 command, whereas rejection at other times may cause the client MTA to keep on
26808 trying to deliver the message. It is therefore recommended that you do as much
26809 testing as possible at RCPT time.
26810
26811
26812 .section "The non-SMTP ACLs" "SECID190"
26813 .cindex "non-SMTP messages" "ACLs for"
26814 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26815 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26816 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26817 the state of the SMTP connection such as encryption and authentication) are not
26818 relevant and are forbidden in these ACLs. However, the sender and recipients
26819 are known, so the &%senders%& and &%sender_domains%& conditions and the
26820 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26821 &$authenticated_sender$& are also available. You can specify added header lines
26822 in any of these ACLs.
26823
26824 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26825 non-SMTP message, before any of the message has been read. (This is the
26826 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26827 batched SMTP input, it runs after the DATA command has been reached. The
26828 result of this ACL is ignored; it cannot be used to reject a message. If you
26829 really need to, you could set a value in an ACL variable here and reject based
26830 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26831 controls, and in particular, it can be used to set
26832 .code
26833 control = suppress_local_fixups
26834 .endd
26835 This cannot be used in the other non-SMTP ACLs because by the time they are
26836 run, it is too late.
26837
26838 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26839 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26840
26841 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26842 kind of rejection is treated as permanent, because there is no way of sending a
26843 temporary error for these kinds of message.
26844
26845
26846 .section "The SMTP connect ACL" "SECID191"
26847 .cindex "SMTP" "connection, ACL for"
26848 .oindex &%smtp_banner%&
26849 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26850 session, after the test specified by &%host_reject_connection%& (which is now
26851 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26852 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26853 the message override the banner message that is otherwise specified by the
26854 &%smtp_banner%& option.
26855
26856
26857 .section "The EHLO/HELO ACL" "SECID192"
26858 .cindex "EHLO" "ACL for"
26859 .cindex "HELO" "ACL for"
26860 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26861 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26862 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26863 Note that a client may issue more than one EHLO or HELO command in an SMTP
26864 session, and indeed is required to issue a new EHLO or HELO after successfully
26865 setting up encryption following a STARTTLS command.
26866
26867 If the command is accepted by an &%accept%& verb that has a &%message%&
26868 modifier, the message may not contain more than one line (it will be truncated
26869 at the first newline and a panic logged if it does). Such a message cannot
26870 affect the EHLO options that are listed on the second and subsequent lines of
26871 an EHLO response.
26872
26873
26874 .section "The DATA ACLs" "SECID193"
26875 .cindex "DATA" "ACLs for"
26876 Two ACLs are associated with the DATA command, because it is two-stage
26877 command, with two responses being sent to the client.
26878 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26879 is obeyed. This gives you control after all the RCPT commands, but before
26880 the message itself is received. It offers the opportunity to give a negative
26881 response to the DATA command before the data is transmitted. Header lines
26882 added by MAIL or RCPT ACLs are not visible at this time, but any that
26883 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26884
26885 You cannot test the contents of the message, for example, to verify addresses
26886 in the headers, at RCPT time or when the DATA command is received. Such
26887 tests have to appear in the ACL that is run after the message itself has been
26888 received, before the final response to the DATA command is sent. This is
26889 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26890 associated with the DATA command.
26891
26892 For both of these ACLs, it is not possible to reject individual recipients. An
26893 error response rejects the entire message. Unfortunately, it is known that some
26894 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26895 before or after the data) correctly &-- they keep the message on their queues
26896 and try again later, but that is their problem, though it does waste some of
26897 your resources.
26898
26899 The &%acl_smtp_data%& ACL is run after
26900 the &%acl_smtp_data_prdr%&,
26901 the &%acl_smtp_dkim%&
26902 and the &%acl_smtp_mime%& ACLs.
26903
26904 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26905 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26906 enabled (which is the default).
26907
26908 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26909 received, and is executed for each DKIM signature found in a message.  If not
26910 otherwise specified, the default action is to accept.
26911
26912 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26913
26914 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26915
26916
26917 .section "The SMTP MIME ACL" "SECID194"
26918 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26919 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26920
26921 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26922
26923
26924 .section "The SMTP PRDR ACL" "SECTPRDRACL"
26925 .oindex "&%prdr_enable%&"
26926 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
26927 with PRDR support enabled (which is the default).
26928 It becomes active only when the PRDR feature is negotiated between
26929 client and server for a message, and more than one recipient
26930 has been accepted.
26931
26932 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
26933 has been recieved, and is executed for each recipient of the message.
26934 The test may accept or deny for inividual recipients.
26935 The &%acl_smtp_data%& will still be called after this ACL and
26936 can reject the message overall, even if this ACL has accepted it
26937 for some or all recipients.
26938
26939 PRDR may be used to support per-user content filtering.  Without it
26940 one must defer any recipient after the first that has a different
26941 content-filter configuration.  With PRDR, the RCPT-time check
26942 for this can be disabled when the MAIL-time $smtp_command included
26943 "PRDR".  Any required difference in behaviour of the main DATA-time
26944 ACL should however depend on the PRDR-time ACL having run, as Exim
26945 will avoid doing so in some situations (eg.  single-recipient mails).
26946
26947 See also the &%prdr_enable%& global option
26948 and the &%hosts_try_prdr%& smtp transport option.
26949
26950 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26951 If the ACL is not defined, processing completes as if
26952 the feature was not requested by the client.
26953
26954 .section "The QUIT ACL" "SECTQUITACL"
26955 .cindex "QUIT, ACL for"
26956 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26957 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26958 does not in fact control any access. For this reason, the only verbs that are
26959 permitted are &%accept%& and &%warn%&.
26960
26961 This ACL can be used for tasks such as custom logging at the end of an SMTP
26962 session. For example, you can use ACL variables in other ACLs to count
26963 messages, recipients, etc., and log the totals at QUIT time using one or
26964 more &%logwrite%& modifiers on a &%warn%& verb.
26965
26966 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26967 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26968
26969 You do not need to have a final &%accept%&, but if you do, you can use a
26970 &%message%& modifier to specify custom text that is sent as part of the 221
26971 response to QUIT.
26972
26973 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26974 failure (for example, failure to open a log file, or when Exim is bombing out
26975 because it has detected an unrecoverable error), all SMTP commands from the
26976 client are given temporary error responses until QUIT is received or the
26977 connection is closed. In these special cases, the QUIT ACL does not run.
26978
26979
26980 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26981 .vindex &$acl_smtp_notquit$&
26982 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26983 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26984 trouble, such as being unable to write to its log files, this ACL is not run,
26985 because it might try to do things (such as write to log files) that make the
26986 situation even worse.
26987
26988 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26989 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26990 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26991 and &%warn%&.
26992
26993 .vindex &$smtp_notquit_reason$&
26994 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26995 to a string that indicates the reason for the termination of the SMTP
26996 connection. The possible values are:
26997 .table2
26998 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26999 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27000 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27001 .irow &`connection-lost`&          "The SMTP connection has been lost"
27002 .irow &`data-timeout`&             "Timeout while reading message data"
27003 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27004 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27005 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27006 .irow &`synchronization-error`&    "SMTP synchronization error"
27007 .irow &`tls-failed`&               "TLS failed to start"
27008 .endtable
27009 In most cases when an SMTP connection is closed without having received QUIT,
27010 Exim sends an SMTP response message before actually closing the connection.
27011 With the exception of the &`acl-drop`& case, the default message can be
27012 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27013 &%drop%& verb in another ACL, it is the message from the other ACL that is
27014 used.
27015
27016
27017 .section "Finding an ACL to use" "SECID195"
27018 .cindex "&ACL;" "finding which to use"
27019 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27020 you can use different ACLs in different circumstances. For example,
27021 .code
27022 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27023                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27024 .endd
27025 In the default configuration file there are some example settings for
27026 providing an RFC 4409 message submission service on port 587 and a
27027 non-standard &"smtps"& service on port 465. You can use a string
27028 expansion like this to choose an ACL for MUAs on these ports which is
27029 more appropriate for this purpose than the default ACL on port 25.
27030
27031 The expanded string does not have to be the name of an ACL in the
27032 configuration file; there are other possibilities. Having expanded the
27033 string, Exim searches for an ACL as follows:
27034
27035 .ilist
27036 If the string begins with a slash, Exim uses it as a file name, and reads its
27037 contents as an ACL. The lines are processed in the same way as lines in the
27038 Exim configuration file. In particular, continuation lines are supported, blank
27039 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27040 If the file does not exist or cannot be read, an error occurs (typically
27041 causing a temporary failure of whatever caused the ACL to be run). For example:
27042 .code
27043 acl_smtp_data = /etc/acls/\
27044   ${lookup{$sender_host_address}lsearch\
27045   {/etc/acllist}{$value}{default}}
27046 .endd
27047 This looks up an ACL file to use on the basis of the host's IP address, falling
27048 back to a default if the lookup fails. If an ACL is successfully read from a
27049 file, it is retained in memory for the duration of the Exim process, so that it
27050 can be re-used without having to re-read the file.
27051 .next
27052 If the string does not start with a slash, and does not contain any spaces,
27053 Exim searches the ACL section of the configuration for an ACL whose name
27054 matches the string.
27055 .next
27056 If no named ACL is found, or if the string contains spaces, Exim parses
27057 the string as an inline ACL. This can save typing in cases where you just
27058 want to have something like
27059 .code
27060 acl_smtp_vrfy = accept
27061 .endd
27062 in order to allow free use of the VRFY command. Such a string may contain
27063 newlines; it is processed in the same way as an ACL that is read from a file.
27064 .endlist
27065
27066
27067
27068
27069 .section "ACL return codes" "SECID196"
27070 .cindex "&ACL;" "return codes"
27071 Except for the QUIT ACL, which does not affect the SMTP return code (see
27072 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27073 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27074 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27075 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27076 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27077 This also causes a 4&'xx'& return code.
27078
27079 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27080 &"deny"&, because there is no mechanism for passing temporary errors to the
27081 submitters of non-SMTP messages.
27082
27083
27084 ACLs that are relevant to message reception may also return &"discard"&. This
27085 has the effect of &"accept"&, but causes either the entire message or an
27086 individual recipient address to be discarded. In other words, it is a
27087 blackholing facility. Use it with care.
27088
27089 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27090 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27091 RCPT ACL is to discard just the one recipient address. If there are no
27092 recipients left when the message's data is received, the DATA ACL is not
27093 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27094 remaining recipients. The &"discard"& return is not permitted for the
27095 &%acl_smtp_predata%& ACL.
27096
27097
27098 .cindex "&[local_scan()]& function" "when all recipients discarded"
27099 The &[local_scan()]& function is always run, even if there are no remaining
27100 recipients; it may create new recipients.
27101
27102
27103
27104 .section "Unset ACL options" "SECID197"
27105 .cindex "&ACL;" "unset options"
27106 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27107 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27108 not defined at all. For any defined ACL, the default action when control
27109 reaches the end of the ACL statements is &"deny"&.
27110
27111 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27112 these two are ACLs that are used only for their side effects. They cannot be
27113 used to accept or reject anything.
27114
27115 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27116 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27117 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27118 when the ACL is not defined is &"accept"&.
27119
27120 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27121 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27122 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27123 messages over an SMTP connection. For an example, see the ACL in the default
27124 configuration file.
27125
27126
27127
27128
27129 .section "Data for message ACLs" "SECID198"
27130 .cindex "&ACL;" "data for message ACL"
27131 .vindex &$domain$&
27132 .vindex &$local_part$&
27133 .vindex &$sender_address$&
27134 .vindex &$sender_host_address$&
27135 .vindex &$smtp_command$&
27136 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27137 that contain information about the host and the message's sender (for example,
27138 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27139 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27140 &$local_part$& are set from the argument address. The entire SMTP command
27141 is available in &$smtp_command$&.
27142
27143 When an ACL for the AUTH parameter of MAIL is running, the variables that
27144 contain information about the host are set, but &$sender_address$& is not yet
27145 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27146 how it is used.
27147
27148 .vindex "&$message_size$&"
27149 The &$message_size$& variable is set to the value of the SIZE parameter on
27150 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27151 that parameter is not given. The value is updated to the true message size by
27152 the time the final DATA ACL is run (after the message data has been
27153 received).
27154
27155 .vindex "&$rcpt_count$&"
27156 .vindex "&$recipients_count$&"
27157 The &$rcpt_count$& variable increases by one for each RCPT command received.
27158 The &$recipients_count$& variable increases by one each time a RCPT command is
27159 accepted, so while an ACL for RCPT is being processed, it contains the number
27160 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27161 &$rcpt_count$& contains the total number of RCPT commands, and
27162 &$recipients_count$& contains the total number of accepted recipients.
27163
27164
27165
27166
27167
27168 .section "Data for non-message ACLs" "SECTdatfornon"
27169 .cindex "&ACL;" "data for non-message ACL"
27170 .vindex &$smtp_command_argument$&
27171 .vindex &$smtp_command$&
27172 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27173 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27174 and the entire SMTP command is available in &$smtp_command$&.
27175 These variables can be tested using a &%condition%& condition. For example,
27176 here is an ACL for use with AUTH, which insists that either the session is
27177 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27178 does not permit authentication methods that use cleartext passwords on
27179 unencrypted connections.
27180 .code
27181 acl_check_auth:
27182   accept encrypted = *
27183   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27184                      {CRAM-MD5}}
27185   deny   message   = TLS encryption or CRAM-MD5 required
27186 .endd
27187 (Another way of applying this restriction is to arrange for the authenticators
27188 that use cleartext passwords not to be advertised when the connection is not
27189 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27190 option to do this.)
27191
27192
27193
27194 .section "Format of an ACL" "SECID199"
27195 .cindex "&ACL;" "format of"
27196 .cindex "&ACL;" "verbs, definition of"
27197 An individual ACL consists of a number of statements. Each statement starts
27198 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27199 Modifiers can change the way the verb operates, define error and log messages,
27200 set variables, insert delays, and vary the processing of accepted messages.
27201
27202 If all the conditions are met, the verb is obeyed. The same condition may be
27203 used (with different arguments) more than once in the same statement. This
27204 provides a means of specifying an &"and"& conjunction between conditions. For
27205 example:
27206 .code
27207 deny  dnslists = list1.example
27208 dnslists = list2.example
27209 .endd
27210 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27211 the conditions and modifiers when it reaches a condition that fails. What
27212 happens then depends on the verb (and in one case, on a special modifier). Not
27213 all the conditions make sense at every testing point. For example, you cannot
27214 test a sender address in the ACL that is run for a VRFY command.
27215
27216
27217 .section "ACL verbs" "SECID200"
27218 The ACL verbs are as follows:
27219
27220 .ilist
27221 .cindex "&%accept%& ACL verb"
27222 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27223 of the conditions are not met, what happens depends on whether &%endpass%&
27224 appears among the conditions (for syntax see below). If the failing condition
27225 is before &%endpass%&, control is passed to the next ACL statement; if it is
27226 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27227 check a RCPT command:
27228 .code
27229 accept domains = +local_domains
27230 endpass
27231 verify = recipient
27232 .endd
27233 If the recipient domain does not match the &%domains%& condition, control
27234 passes to the next statement. If it does match, the recipient is verified, and
27235 the command is accepted if verification succeeds. However, if verification
27236 fails, the ACL yields &"deny"&, because the failing condition is after
27237 &%endpass%&.
27238
27239 The &%endpass%& feature has turned out to be confusing to many people, so its
27240 use is not recommended nowadays. It is always possible to rewrite an ACL so
27241 that &%endpass%& is not needed, and it is no longer used in the default
27242 configuration.
27243
27244 .cindex "&%message%& ACL modifier" "with &%accept%&"
27245 If a &%message%& modifier appears on an &%accept%& statement, its action
27246 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27247 (when an &%accept%& verb either accepts or passes control to the next
27248 statement), &%message%& can be used to vary the message that is sent when an
27249 SMTP command is accepted. For example, in a RCPT ACL you could have:
27250 .display
27251 &`accept  `&<&'some conditions'&>
27252 &`        message = OK, I will allow you through today`&
27253 .endd
27254 You can specify an SMTP response code, optionally followed by an &"extended
27255 response code"& at the start of the message, but the first digit must be the
27256 same as would be sent by default, which is 2 for an &%accept%& verb.
27257
27258 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27259 an error message that is used when access is denied. This behaviour is retained
27260 for backward compatibility, but current &"best practice"& is to avoid the use
27261 of &%endpass%&.
27262
27263
27264 .next
27265 .cindex "&%defer%& ACL verb"
27266 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27267 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27268 &%defer%& is the same as &%deny%&, because there is no way of sending a
27269 temporary error. For a RCPT command, &%defer%& is much the same as using a
27270 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27271 be used in any ACL, and even for a recipient it might be a simpler approach.
27272
27273
27274 .next
27275 .cindex "&%deny%& ACL verb"
27276 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27277 the conditions are not met, control is passed to the next ACL statement. For
27278 example,
27279 .code
27280 deny dnslists = blackholes.mail-abuse.org
27281 .endd
27282 rejects commands from hosts that are on a DNS black list.
27283
27284
27285 .next
27286 .cindex "&%discard%& ACL verb"
27287 &%discard%&: This verb behaves like &%accept%&, except that it returns
27288 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27289 that are concerned with receiving messages. When all the conditions are true,
27290 the sending entity receives a &"success"& response. However, &%discard%& causes
27291 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27292 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27293 message's recipients are discarded. Recipients that are discarded before DATA
27294 do not appear in the log line when the &%received_recipients%& log selector is set.
27295
27296 If the &%log_message%& modifier is set when &%discard%& operates,
27297 its contents are added to the line that is automatically written to the log.
27298 The &%message%& modifier operates exactly as it does for &%accept%&.
27299
27300
27301 .next
27302 .cindex "&%drop%& ACL verb"
27303 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27304 forcibly closed after the 5&'xx'& error message has been sent. For example:
27305 .code
27306 drop   message   = I don't take more than 20 RCPTs
27307        condition = ${if > {$rcpt_count}{20}}
27308 .endd
27309 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27310 The connection is always dropped after sending a 550 response.
27311
27312 .next
27313 .cindex "&%require%& ACL verb"
27314 &%require%&: If all the conditions are met, control is passed to the next ACL
27315 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27316 example, when checking a RCPT command,
27317 .code
27318 require message = Sender did not verify
27319         verify  = sender
27320 .endd
27321 passes control to subsequent statements only if the message's sender can be
27322 verified. Otherwise, it rejects the command. Note the positioning of the
27323 &%message%& modifier, before the &%verify%& condition. The reason for this is
27324 discussed in section &<<SECTcondmodproc>>&.
27325
27326 .next
27327 .cindex "&%warn%& ACL verb"
27328 &%warn%&: If all the conditions are true, a line specified by the
27329 &%log_message%& modifier is written to Exim's main log. Control always passes
27330 to the next ACL statement. If any condition is false, the log line is not
27331 written. If an identical log line is requested several times in the same
27332 message, only one copy is actually written to the log. If you want to force
27333 duplicates to be written, use the &%logwrite%& modifier instead.
27334
27335 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27336 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27337 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27338 first failing condition. There is more about adding header lines in section
27339 &<<SECTaddheadacl>>&.
27340
27341 If any condition on a &%warn%& statement cannot be completed (that is, there is
27342 some sort of defer), the log line specified by &%log_message%& is not written.
27343 This does not include the case of a forced failure from a lookup, which
27344 is considered to be a successful completion. After a defer, no further
27345 conditions or modifiers in the &%warn%& statement are processed. The incident
27346 is logged, and the ACL continues to be processed, from the next statement
27347 onwards.
27348
27349
27350 .vindex "&$acl_verify_message$&"
27351 When one of the &%warn%& conditions is an address verification that fails, the
27352 text of the verification failure message is in &$acl_verify_message$&. If you
27353 want this logged, you must set it up explicitly. For example:
27354 .code
27355 warn   !verify = sender
27356        log_message = sender verify failed: $acl_verify_message
27357 .endd
27358 .endlist
27359
27360 At the end of each ACL there is an implicit unconditional &%deny%&.
27361
27362 As you can see from the examples above, the conditions and modifiers are
27363 written one to a line, with the first one on the same line as the verb, and
27364 subsequent ones on following lines. If you have a very long condition, you can
27365 continue it onto several physical lines by the usual backslash continuation
27366 mechanism. It is conventional to align the conditions vertically.
27367
27368
27369
27370 .section "ACL variables" "SECTaclvariables"
27371 .cindex "&ACL;" "variables"
27372 There are some special variables that can be set during ACL processing. They
27373 can be used to pass information between different ACLs, different invocations
27374 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27375 transports, and filters that are used to deliver a message. The names of these
27376 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27377 an underscore, but the remainder of the name can be any sequence of
27378 alphanumeric characters and underscores that you choose. There is no limit on
27379 the number of ACL variables. The two sets act as follows:
27380 .ilist
27381 The values of those variables whose names begin with &$acl_c$& persist
27382 throughout an SMTP connection. They are never reset. Thus, a value that is set
27383 while receiving one message is still available when receiving the next message
27384 on the same SMTP connection.
27385 .next
27386 The values of those variables whose names begin with &$acl_m$& persist only
27387 while a message is being received. They are reset afterwards. They are also
27388 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27389 .endlist
27390
27391 When a message is accepted, the current values of all the ACL variables are
27392 preserved with the message and are subsequently made available at delivery
27393 time. The ACL variables are set by a modifier called &%set%&. For example:
27394 .code
27395 accept hosts = whatever
27396        set acl_m4 = some value
27397 accept authenticated = *
27398        set acl_c_auth = yes
27399 .endd
27400 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27401 be set. If you want to set a variable without taking any action, you can use a
27402 &%warn%& verb without any other modifiers or conditions.
27403
27404 .oindex &%strict_acl_vars%&
27405 What happens if a syntactically valid but undefined ACL variable is
27406 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27407 false (the default), an empty string is substituted; if it is true, an
27408 error is generated.
27409
27410 Versions of Exim before 4.64 have a limited set of numbered variables, but
27411 their names are compatible, so there is no problem with upgrading.
27412
27413
27414 .section "Condition and modifier processing" "SECTcondmodproc"
27415 .cindex "&ACL;" "conditions; processing"
27416 .cindex "&ACL;" "modifiers; processing"
27417 An exclamation mark preceding a condition negates its result. For example:
27418 .code
27419 deny   domains = *.dom.example
27420       !verify  = recipient
27421 .endd
27422 causes the ACL to return &"deny"& if the recipient domain ends in
27423 &'dom.example'& and the recipient address cannot be verified. Sometimes
27424 negation can be used on the right-hand side of a condition. For example, these
27425 two statements are equivalent:
27426 .code
27427 deny  hosts = !192.168.3.4
27428 deny !hosts =  192.168.3.4
27429 .endd
27430 However, for many conditions (&%verify%& being a good example), only left-hand
27431 side negation of the whole condition is possible.
27432
27433 The arguments of conditions and modifiers are expanded. A forced failure
27434 of an expansion causes a condition to be ignored, that is, it behaves as if the
27435 condition is true. Consider these two statements:
27436 .code
27437 accept  senders = ${lookup{$host_name}lsearch\
27438                   {/some/file}{$value}fail}
27439 accept  senders = ${lookup{$host_name}lsearch\
27440                   {/some/file}{$value}{}}
27441 .endd
27442 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27443 the returned list is searched, but if the lookup fails the behaviour is
27444 different in the two cases. The &%fail%& in the first statement causes the
27445 condition to be ignored, leaving no further conditions. The &%accept%& verb
27446 therefore succeeds. The second statement, however, generates an empty list when
27447 the lookup fails. No sender can match an empty list, so the condition fails,
27448 and therefore the &%accept%& also fails.
27449
27450 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27451 specify actions that are taken as the conditions for a statement are checked;
27452 others specify text for messages that are used when access is denied or a
27453 warning is generated. The &%control%& modifier affects the way an incoming
27454 message is handled.
27455
27456 The positioning of the modifiers in an ACL statement is important, because the
27457 processing of a verb ceases as soon as its outcome is known. Only those
27458 modifiers that have already been encountered will take effect. For example,
27459 consider this use of the &%message%& modifier:
27460 .code
27461 require message = Can't verify sender
27462         verify  = sender
27463         message = Can't verify recipient
27464         verify  = recipient
27465         message = This message cannot be used
27466 .endd
27467 If sender verification fails, Exim knows that the result of the statement is
27468 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27469 so its text is used as the error message. If sender verification succeeds, but
27470 recipient verification fails, the second message is used. If recipient
27471 verification succeeds, the third message becomes &"current"&, but is never used
27472 because there are no more conditions to cause failure.
27473
27474 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27475 modifier that is used, because all the conditions must be true for rejection to
27476 happen. Specifying more than one &%message%& modifier does not make sense, and
27477 the message can even be specified after all the conditions. For example:
27478 .code
27479 deny   hosts = ...
27480       !senders = *@my.domain.example
27481        message = Invalid sender from client host
27482 .endd
27483 The &"deny"& result does not happen until the end of the statement is reached,
27484 by which time Exim has set up the message.
27485
27486
27487
27488 .section "ACL modifiers" "SECTACLmodi"
27489 .cindex "&ACL;" "modifiers; list of"
27490 The ACL modifiers are as follows:
27491
27492 .vlist
27493 .vitem &*add_header*&&~=&~<&'text'&>
27494 This modifier specifies one or more header lines that are to be added to an
27495 incoming message, assuming, of course, that the message is ultimately
27496 accepted. For details, see section &<<SECTaddheadacl>>&.
27497
27498 .vitem &*continue*&&~=&~<&'text'&>
27499 .cindex "&%continue%& ACL modifier"
27500 .cindex "database" "updating in ACL"
27501 This modifier does nothing of itself, and processing of the ACL always
27502 continues with the next condition or modifier. The value of &%continue%& is in
27503 the side effects of expanding its argument. Typically this could be used to
27504 update a database. It is really just a syntactic tidiness, to avoid having to
27505 write rather ugly lines like this:
27506 .display
27507 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27508 .endd
27509 Instead, all you need is
27510 .display
27511 &`continue = `&<&'some expansion'&>
27512 .endd
27513
27514 .vitem &*control*&&~=&~<&'text'&>
27515 .cindex "&%control%& ACL modifier"
27516 This modifier affects the subsequent processing of the SMTP connection or of an
27517 incoming message that is accepted. The effect of the first type of control
27518 lasts for the duration of the connection, whereas the effect of the second type
27519 lasts only until the current message has been received. The message-specific
27520 controls always apply to the whole message, not to individual recipients,
27521 even if the &%control%& modifier appears in a RCPT ACL.
27522
27523 As there are now quite a few controls that can be applied, they are described
27524 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27525 in several different ways. For example:
27526
27527 . ==== As this is a nested list, any displays it contains must be indented
27528 . ==== as otherwise they are too far to the left. That comment applies only
27529 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27530 . ==== way.
27531
27532 .ilist
27533 It can be at the end of an &%accept%& statement:
27534 .code
27535     accept  ...some conditions
27536             control = queue_only
27537 .endd
27538 In this case, the control is applied when this statement yields &"accept"&, in
27539 other words, when the conditions are all true.
27540
27541 .next
27542 It can be in the middle of an &%accept%& statement:
27543 .code
27544     accept  ...some conditions...
27545             control = queue_only
27546             ...some more conditions...
27547 .endd
27548 If the first set of conditions are true, the control is applied, even if the
27549 statement does not accept because one of the second set of conditions is false.
27550 In this case, some subsequent statement must yield &"accept"& for the control
27551 to be relevant.
27552
27553 .next
27554 It can be used with &%warn%& to apply the control, leaving the
27555 decision about accepting or denying to a subsequent verb. For
27556 example:
27557 .code
27558     warn    ...some conditions...
27559             control = freeze
27560     accept  ...
27561 .endd
27562 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27563 &%logwrite%&, so it does not add anything to the message and does not write a
27564 log entry.
27565
27566 .next
27567 If you want to apply a control unconditionally, you can use it with a
27568 &%require%& verb. For example:
27569 .code
27570     require  control = no_multiline_responses
27571 .endd
27572 .endlist
27573
27574 .vitem &*delay*&&~=&~<&'time'&>
27575 .cindex "&%delay%& ACL modifier"
27576 .oindex "&%-bh%&"
27577 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27578 the time interval before proceeding. However, when testing Exim using the
27579 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27580 output instead). The time is given in the usual Exim notation, and the delay
27581 happens as soon as the modifier is processed. In an SMTP session, pending
27582 output is flushed before the delay is imposed.
27583
27584 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27585 example:
27586 .code
27587 deny    ...some conditions...
27588         delay = 30s
27589 .endd
27590 The delay happens if all the conditions are true, before the statement returns
27591 &"deny"&. Compare this with:
27592 .code
27593 deny    delay = 30s
27594         ...some conditions...
27595 .endd
27596 which waits for 30s before processing the conditions. The &%delay%& modifier
27597 can also be used with &%warn%& and together with &%control%&:
27598 .code
27599 warn    ...some conditions...
27600         delay = 2m
27601         control = freeze
27602 accept  ...
27603 .endd
27604
27605 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27606 responses to several commands are no longer buffered and sent in one packet (as
27607 they would normally be) because all output is flushed before imposing the
27608 delay. This optimization is disabled so that a number of small delays do not
27609 appear to the client as one large aggregated delay that might provoke an
27610 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27611 using a &%control%& modifier to set &%no_delay_flush%&.
27612
27613
27614 .vitem &*endpass*&
27615 .cindex "&%endpass%& ACL modifier"
27616 This modifier, which has no argument, is recognized only in &%accept%& and
27617 &%discard%& statements. It marks the boundary between the conditions whose
27618 failure causes control to pass to the next statement, and the conditions whose
27619 failure causes the ACL to return &"deny"&. This concept has proved to be
27620 confusing to some people, so the use of &%endpass%& is no longer recommended as
27621 &"best practice"&. See the description of &%accept%& above for more details.
27622
27623
27624 .vitem &*log_message*&&~=&~<&'text'&>
27625 .cindex "&%log_message%& ACL modifier"
27626 This modifier sets up a message that is used as part of the log message if the
27627 ACL denies access or a &%warn%& statement's conditions are true. For example:
27628 .code
27629 require log_message = wrong cipher suite $tls_in_cipher
27630         encrypted   = DES-CBC3-SHA
27631 .endd
27632 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27633 example:
27634 .display
27635 &`discard `&<&'some conditions'&>
27636 &`        log_message = Discarded $local_part@$domain because...`&
27637 .endd
27638 When access is denied, &%log_message%& adds to any underlying error message
27639 that may exist because of a condition failure. For example, while verifying a
27640 recipient address, a &':fail:'& redirection might have already set up a
27641 message.
27642
27643 The message may be defined before the conditions to which it applies, because
27644 the string expansion does not happen until Exim decides that access is to be
27645 denied. This means that any variables that are set by the condition are
27646 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27647 variables are set after a DNS black list lookup succeeds. If the expansion of
27648 &%log_message%& fails, or if the result is an empty string, the modifier is
27649 ignored.
27650
27651 .vindex "&$acl_verify_message$&"
27652 If you want to use a &%warn%& statement to log the result of an address
27653 verification, you can use &$acl_verify_message$& to include the verification
27654 error message.
27655
27656 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27657 the start of the logged message. If the same warning log message is requested
27658 more than once while receiving  a single email message, only one copy is
27659 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27660 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27661 is logged for a successful &%warn%& statement.
27662
27663 If &%log_message%& is not present and there is no underlying error message (for
27664 example, from the failure of address verification), but &%message%& is present,
27665 the &%message%& text is used for logging rejections. However, if any text for
27666 logging contains newlines, only the first line is logged. In the absence of
27667 both &%log_message%& and &%message%&, a default built-in message is used for
27668 logging rejections.
27669
27670
27671 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27672 .cindex "&%log_reject_target%& ACL modifier"
27673 .cindex "logging in ACL" "specifying which log"
27674 This modifier makes it possible to specify which logs are used for messages
27675 about ACL rejections. Its argument is a colon-separated list of words that can
27676 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27677 may be empty, in which case a rejection is not logged at all. For example, this
27678 ACL fragment writes no logging information when access is denied:
27679 .display
27680 &`deny `&<&'some conditions'&>
27681 &`     log_reject_target =`&
27682 .endd
27683 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27684 permanent and temporary rejections. Its effect lasts for the rest of the
27685 current ACL.
27686
27687
27688 .vitem &*logwrite*&&~=&~<&'text'&>
27689 .cindex "&%logwrite%& ACL modifier"
27690 .cindex "logging in ACL" "immediate"
27691 This modifier writes a message to a log file as soon as it is encountered when
27692 processing an ACL. (Compare &%log_message%&, which, except in the case of
27693 &%warn%& and &%discard%&, is used only if the ACL statement denies
27694 access.) The &%logwrite%& modifier can be used to log special incidents in
27695 ACLs. For example:
27696 .display
27697 &`accept `&<&'some special conditions'&>
27698 &`       control  = freeze`&
27699 &`       logwrite = froze message because ...`&
27700 .endd
27701 By default, the message is written to the main log. However, it may begin
27702 with a colon, followed by a comma-separated list of log names, and then
27703 another colon, to specify exactly which logs are to be written. For
27704 example:
27705 .code
27706 logwrite = :main,reject: text for main and reject logs
27707 logwrite = :panic: text for panic log only
27708 .endd
27709
27710
27711 .vitem &*message*&&~=&~<&'text'&>
27712 .cindex "&%message%& ACL modifier"
27713 This modifier sets up a text string that is expanded and used as a response
27714 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27715 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27716 there is some complication if &%endpass%& is involved; see the description of
27717 &%accept%& for details.)
27718
27719 The expansion of the message happens at the time Exim decides that the ACL is
27720 to end, not at the time it processes &%message%&. If the expansion fails, or
27721 generates an empty string, the modifier is ignored. Here is an example where
27722 &%message%& must be specified first, because the ACL ends with a rejection if
27723 the &%hosts%& condition fails:
27724 .code
27725 require  message = Host not recognized
27726          hosts = 10.0.0.0/8
27727 .endd
27728 (Once a condition has failed, no further conditions or modifiers are
27729 processed.)
27730
27731 .cindex "SMTP" "error codes"
27732 .oindex "&%smtp_banner%&
27733 For ACLs that are triggered by SMTP commands, the message is returned as part
27734 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27735 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27736 is accepted. In the case of the connect ACL, accepting with a message modifier
27737 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27738 accept message may not contain more than one line (otherwise it will be
27739 truncated at the first newline and a panic logged), and it cannot affect the
27740 EHLO options.
27741
27742 When SMTP is involved, the message may begin with an overriding response code,
27743 consisting of three digits optionally followed by an &"extended response code"&
27744 of the form &'n.n.n'&, each code being followed by a space. For example:
27745 .code
27746 deny  message = 599 1.2.3 Host not welcome
27747       hosts = 192.168.34.0/24
27748 .endd
27749 The first digit of the supplied response code must be the same as would be sent
27750 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27751 access, but for the predata ACL, note that the default success code is 354, not
27752 2&'xx'&.
27753
27754 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27755 the message modifier cannot override the 221 response code.
27756
27757 The text in a &%message%& modifier is literal; any quotes are taken as
27758 literals, but because the string is expanded, backslash escapes are processed
27759 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27760 response.
27761
27762 .vindex "&$acl_verify_message$&"
27763 .new
27764 For ACLs that are called by an &%acl =%& ACL condition, the message is
27765 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27766 .wen
27767
27768 If &%message%& is used on a statement that verifies an address, the message
27769 specified overrides any message that is generated by the verification process.
27770 However, the original message is available in the variable
27771 &$acl_verify_message$&, so you can incorporate it into your message if you
27772 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27773 routers to be passed back as part of the SMTP response, you should either not
27774 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27775
27776 For compatibility with previous releases of Exim, a &%message%& modifier that
27777 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27778 modifier, but this usage is now deprecated. However, &%message%& acts only when
27779 all the conditions are true, wherever it appears in an ACL command, whereas
27780 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27781 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27782 effect.
27783
27784
27785 .vitem &*remove_header*&&~=&~<&'text'&>
27786 This modifier specifies one or more header names in a colon-separated list
27787  that are to be removed from an incoming message, assuming, of course, that
27788 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27789
27790
27791 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27792 .cindex "&%set%& ACL modifier"
27793 This modifier puts a value into one of the ACL variables (see section
27794 &<<SECTaclvariables>>&).
27795
27796
27797 .vitem &*udpsend*&&~=&~<&'parameters'&>
27798 This modifier sends a UDP packet, for purposes such as statistics
27799 collection or behaviour monitoring. The parameters are expanded, and
27800 the result of the expansion must be a colon-separated list consisting
27801 of a destination server, port number, and the packet contents. The
27802 server can be specified as a host name or IPv4 or IPv6 address. The
27803 separator can be changed with the usual angle bracket syntax. For
27804 example, you might want to collect information on which hosts connect
27805 when:
27806 .code
27807 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27808              $tod_zulu $sender_host_address
27809 .endd
27810 .endlist
27811
27812
27813
27814
27815 .section "Use of the control modifier" "SECTcontrols"
27816 .cindex "&%control%& ACL modifier"
27817 The &%control%& modifier supports the following settings:
27818
27819 .vlist
27820 .vitem &*control&~=&~allow_auth_unadvertised*&
27821 This modifier allows a client host to use the SMTP AUTH command even when it
27822 has not been advertised in response to EHLO. Furthermore, because there are
27823 apparently some really broken clients that do this, Exim will accept AUTH after
27824 HELO (rather than EHLO) when this control is set. It should be used only if you
27825 really need it, and you should limit its use to those broken clients that do
27826 not work without it. For example:
27827 .code
27828 warn hosts   = 192.168.34.25
27829      control = allow_auth_unadvertised
27830 .endd
27831 Normally, when an Exim server receives an AUTH command, it checks the name of
27832 the authentication mechanism that is given in the command to ensure that it
27833 matches an advertised mechanism. When this control is set, the check that a
27834 mechanism has been advertised is bypassed. Any configured mechanism can be used
27835 by the client. This control is permitted only in the connection and HELO ACLs.
27836
27837
27838 .vitem &*control&~=&~caseful_local_part*& &&&
27839        &*control&~=&~caselower_local_part*&
27840 .cindex "&ACL;" "case of local part in"
27841 .cindex "case of local parts"
27842 .vindex "&$local_part$&"
27843 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27844 (that is, during RCPT processing). By default, the contents of &$local_part$&
27845 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27846 any uppercase letters in the original local part are restored in &$local_part$&
27847 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27848 is encountered.
27849
27850 These controls affect only the current recipient. Moreover, they apply only to
27851 local part handling that takes place directly in the ACL (for example, as a key
27852 in lookups). If a test to verify the recipient is obeyed, the case-related
27853 handling of the local part during the verification is controlled by the router
27854 configuration (see the &%caseful_local_part%& generic router option).
27855
27856 This facility could be used, for example, to add a spam score to local parts
27857 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27858 spam score:
27859 .code
27860 warn  control = caseful_local_part
27861       set acl_m4 = ${eval:\
27862                      $acl_m4 + \
27863                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27864                     }
27865       control = caselower_local_part
27866 .endd
27867 Notice that we put back the lower cased version afterwards, assuming that
27868 is what is wanted for subsequent tests.
27869
27870
27871 .vitem &*control&~=&~cutthrough_delivery*&
27872 .cindex "&ACL;" "cutthrough routing"
27873 .cindex "cutthrough" "requesting"
27874 This option requests delivery be attempted while the item is being received.
27875 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27876 from one SMTP connection to another.  If a recipient-verify callout connection is
27877 requested in the same ACL it is held open and used for the data, otherwise one is made
27878 after the ACL completes.
27879
27880 Note that routers are used in verify mode,
27881 and cannot depend on content of received headers.
27882 Note also that headers cannot be
27883 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27884 Headers may be modified by routers (subject to the above) and transports.
27885
27886 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27887 of outgoing messages is done, because it sends data to the ultimate destination
27888 before the entire message has been received from the source.
27889
27890 Should the ultimate destination system positively accept or reject the mail,
27891 a corresponding indication is given to the source system and nothing is queued.
27892 If there is a temporary error the item is queued for later delivery in the
27893 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27894 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27895 line.
27896
27897 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27898 sender when the destination system is doing content-scan based rejection.
27899
27900
27901 .vitem &*control&~=&~debug/*&<&'options'&>
27902 .cindex "&ACL;" "enabling debug logging"
27903 .cindex "debugging" "enabling from an ACL"
27904 This control turns on debug logging, almost as though Exim had been invoked
27905 with &`-d`&, with the output going to a new logfile, by default called
27906 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27907 may access any variables already defined.  The logging may be adjusted with
27908 the &'opts'& option, which takes the same values as the &`-d`& command-line
27909 option.  Some examples (which depend on variables that don't exist in all
27910 contexts):
27911 .code
27912       control = debug
27913       control = debug/tag=.$sender_host_address
27914       control = debug/opts=+expand+acl
27915       control = debug/tag=.$message_exim_id/opts=+expand
27916 .endd
27917
27918
27919 .vitem &*control&~=&~dkim_disable_verify*&
27920 .cindex "disable DKIM verify"
27921 .cindex "DKIM" "disable verify"
27922 This control turns off DKIM verification processing entirely.  For details on
27923 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27924
27925
27926 .vitem &*control&~=&~dscp/*&<&'value'&>
27927 .cindex "&ACL;" "setting DSCP value"
27928 .cindex "DSCP" "inbound"
27929 This option causes the DSCP value associated with the socket for the inbound
27930 connection to be adjusted to a given value, given as one of a number of fixed
27931 strings or to numeric value.
27932 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27933 Common values include &`throughput`&, &`mincost`&, and on newer systems
27934 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27935
27936 The outbound packets from Exim will be marked with this value in the header
27937 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27938 that these values will have any effect, not be stripped by networking
27939 equipment, or do much of anything without cooperation with your Network
27940 Engineer and those of all network operators between the source and destination.
27941
27942
27943 .vitem &*control&~=&~enforce_sync*& &&&
27944        &*control&~=&~no_enforce_sync*&
27945 .cindex "SMTP" "synchronization checking"
27946 .cindex "synchronization checking in SMTP"
27947 These controls make it possible to be selective about when SMTP synchronization
27948 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27949 state of the switch (it is true by default). See the description of this option
27950 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27951
27952 The effect of these two controls lasts for the remainder of the SMTP
27953 connection. They can appear in any ACL except the one for the non-SMTP
27954 messages. The most straightforward place to put them is in the ACL defined by
27955 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27956 before the first synchronization check. The expected use is to turn off the
27957 synchronization checks for badly-behaved hosts that you nevertheless need to
27958 work with.
27959
27960
27961 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27962 .cindex "fake defer"
27963 .cindex "defer, fake"
27964 This control works in exactly the same way as &%fakereject%& (described below)
27965 except that it causes an SMTP 450 response after the message data instead of a
27966 550 response. You must take care when using &%fakedefer%& because it causes the
27967 messages to be duplicated when the sender retries. Therefore, you should not
27968 use &%fakedefer%& if the message is to be delivered normally.
27969
27970 .vitem &*control&~=&~fakereject/*&<&'message'&>
27971 .cindex "fake rejection"
27972 .cindex "rejection, fake"
27973 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27974 words, only when an SMTP message is being received. If Exim accepts the
27975 message, instead the final 250 response, a 550 rejection message is sent.
27976 However, Exim proceeds to deliver the message as normal. The control applies
27977 only to the current message, not to any subsequent ones that may be received in
27978 the same SMTP connection.
27979
27980 The text for the 550 response is taken from the &%control%& modifier. If no
27981 message is supplied, the following is used:
27982 .code
27983 550-Your message has been rejected but is being
27984 550-kept for evaluation.
27985 550-If it was a legitimate message, it may still be
27986 550 delivered to the target recipient(s).
27987 .endd
27988 This facility should be used with extreme caution.
27989
27990 .vitem &*control&~=&~freeze*&
27991 .cindex "frozen messages" "forcing in ACL"
27992 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27993 other words, only when a message is being received. If the message is accepted,
27994 it is placed on Exim's queue and frozen. The control applies only to the
27995 current message, not to any subsequent ones that may be received in the same
27996 SMTP connection.
27997
27998 This modifier can optionally be followed by &`/no_tell`&. If the global option
27999 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28000 is told about the freezing), provided all the &*control=freeze*& modifiers that
28001 are obeyed for the current message have the &`/no_tell`& option.
28002
28003 .vitem &*control&~=&~no_delay_flush*&
28004 .cindex "SMTP" "output flushing, disabling for delay"
28005 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28006 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28007 use. This control, as long as it is encountered before the &%delay%& modifier,
28008 disables such output flushing.
28009
28010 .vitem &*control&~=&~no_callout_flush*&
28011 .cindex "SMTP" "output flushing, disabling for callout"
28012 Exim normally flushes SMTP output before performing a callout in an ACL, to
28013 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28014 use. This control, as long as it is encountered before the &%verify%& condition
28015 that causes the callout, disables such output flushing.
28016
28017 .vitem &*control&~=&~no_mbox_unspool*&
28018 This control is available when Exim is compiled with the content scanning
28019 extension. Content scanning may require a copy of the current message, or parts
28020 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28021 or spam scanner. Normally, such copies are deleted when they are no longer
28022 needed. If this control is set, the copies are not deleted. The control applies
28023 only to the current message, not to any subsequent ones that may be received in
28024 the same SMTP connection. It is provided for debugging purposes and is unlikely
28025 to be useful in production.
28026
28027 .vitem &*control&~=&~no_multiline_responses*&
28028 .cindex "multiline responses, suppressing"
28029 This control is permitted for any ACL except the one for non-SMTP messages.
28030 It seems that there are broken clients in use that cannot handle multiline
28031 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28032
28033 If this control is set, multiline SMTP responses from ACL rejections are
28034 suppressed. One way of doing this would have been to put out these responses as
28035 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28036 (&"use multiline responses for more"& it says &-- ha!), and some of the
28037 responses might get close to that. So this facility, which is after all only a
28038 sop to broken clients, is implemented by doing two very easy things:
28039
28040 .ilist
28041 Extra information that is normally output as part of a rejection caused by
28042 sender verification failure is omitted. Only the final line (typically &"sender
28043 verification failed"&) is sent.
28044 .next
28045 If a &%message%& modifier supplies a multiline response, only the first
28046 line is output.
28047 .endlist
28048
28049 The setting of the switch can, of course, be made conditional on the
28050 calling host. Its effect lasts until the end of the SMTP connection.
28051
28052 .vitem &*control&~=&~no_pipelining*&
28053 .cindex "PIPELINING" "suppressing advertising"
28054 This control turns off the advertising of the PIPELINING extension to SMTP in
28055 the current session. To be useful, it must be obeyed before Exim sends its
28056 response to an EHLO command. Therefore, it should normally appear in an ACL
28057 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28058 &%pipelining_advertise_hosts%&.
28059
28060 .vitem &*control&~=&~queue_only*&
28061 .oindex "&%queue_only%&"
28062 .cindex "queueing incoming messages"
28063 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28064 other words, only when a message is being received. If the message is accepted,
28065 it is placed on Exim's queue and left there for delivery by a subsequent queue
28066 runner. No immediate delivery process is started. In other words, it has the
28067 effect as the &%queue_only%& global option. However, the control applies only
28068 to the current message, not to any subsequent ones that may be received in the
28069 same SMTP connection.
28070
28071 .vitem &*control&~=&~submission/*&<&'options'&>
28072 .cindex "message" "submission"
28073 .cindex "submission mode"
28074 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28075 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28076 the current message is a submission from a local MUA. In this case, Exim
28077 operates in &"submission mode"&, and applies certain fixups to the message if
28078 necessary. For example, it adds a &'Date:'& header line if one is not present.
28079 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28080 late (the message has already been created).
28081
28082 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28083 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28084 submission mode; the available options for this control are described there.
28085 The control applies only to the current message, not to any subsequent ones
28086 that may be received in the same SMTP connection.
28087
28088 .vitem &*control&~=&~suppress_local_fixups*&
28089 .cindex "submission fixups, suppressing"
28090 This control applies to locally submitted (non TCP/IP) messages, and is the
28091 complement of &`control = submission`&. It disables the fixups that are
28092 normally applied to locally-submitted messages. Specifically:
28093
28094 .ilist
28095 Any &'Sender:'& header line is left alone (in this respect, it is a
28096 dynamic version of &%local_sender_retain%&).
28097 .next
28098 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28099 .next
28100 There is no check that &'From:'& corresponds to the actual sender.
28101 .endlist ilist
28102
28103 This control may be useful when a remotely-originated message is accepted,
28104 passed to some scanning program, and then re-submitted for delivery. It can be
28105 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28106 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28107 data is read.
28108
28109 &*Note:*& This control applies only to the current message, not to any others
28110 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28111 .endlist vlist
28112
28113
28114 .section "Summary of message fixup control" "SECTsummesfix"
28115 All four possibilities for message fixups can be specified:
28116
28117 .ilist
28118 Locally submitted, fixups applied: the default.
28119 .next
28120 Locally submitted, no fixups applied: use
28121 &`control = suppress_local_fixups`&.
28122 .next
28123 Remotely submitted, no fixups applied: the default.
28124 .next
28125 Remotely submitted, fixups applied: use &`control = submission`&.
28126 .endlist
28127
28128
28129
28130 .section "Adding header lines in ACLs" "SECTaddheadacl"
28131 .cindex "header lines" "adding in an ACL"
28132 .cindex "header lines" "position of added lines"
28133 .cindex "&%add_header%& ACL modifier"
28134 The &%add_header%& modifier can be used to add one or more extra header lines
28135 to an incoming message, as in this example:
28136 .code
28137 warn dnslists = sbl.spamhaus.org : \
28138                 dialup.mail-abuse.org
28139      add_header = X-blacklisted-at: $dnslist_domain
28140 .endd
28141 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28142 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28143 receiving a message). The message must ultimately be accepted for
28144 &%add_header%& to have any significant effect. You can use &%add_header%& with
28145 any ACL verb, including &%deny%& (though this is potentially useful only in a
28146 RCPT ACL).
28147
28148 Headers will not be added to the message if the modifier is used in
28149 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28150
28151 Leading and trailing newlines are removed from
28152 the data for the &%add_header%& modifier; if it then
28153 contains one or more newlines that
28154 are not followed by a space or a tab, it is assumed to contain multiple header
28155 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28156 front of any line that is not a valid header line.
28157
28158 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28159 They are added to the message before processing the DATA and MIME ACLs.
28160 However, if an identical header line is requested more than once, only one copy
28161 is actually added to the message. Further header lines may be accumulated
28162 during the DATA and MIME ACLs, after which they are added to the message, again
28163 with duplicates suppressed. Thus, it is possible to add two identical header
28164 lines to an SMTP message, but only if one is added before DATA and one after.
28165 In the case of non-SMTP messages, new headers are accumulated during the
28166 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28167 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28168 are included in the entry that is written to the reject log.
28169
28170 .cindex "header lines" "added; visibility of"
28171 Header lines are not visible in string expansions
28172 of message headers
28173 until they are added to the
28174 message. It follows that header lines defined in the MAIL, RCPT, and predata
28175 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28176 header lines that are added by the DATA or MIME ACLs are not visible in those
28177 ACLs. Because of this restriction, you cannot use header lines as a way of
28178 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28179 this, you can use ACL variables, as described in section
28180 &<<SECTaclvariables>>&.
28181
28182 The list of headers yet to be added is given by the &%$headers_added%& variable.
28183
28184 The &%add_header%& modifier acts immediately as it is encountered during the
28185 processing of an ACL. Notice the difference between these two cases:
28186 .display
28187 &`accept add_header = ADDED: some text`&
28188 &`       `&<&'some condition'&>
28189
28190 &`accept `&<&'some condition'&>
28191 &`       add_header = ADDED: some text`&
28192 .endd
28193 In the first case, the header line is always added, whether or not the
28194 condition is true. In the second case, the header line is added only if the
28195 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28196 ACL statement. All those that are encountered before a condition fails are
28197 honoured.
28198
28199 .cindex "&%warn%& ACL verb"
28200 For compatibility with previous versions of Exim, a &%message%& modifier for a
28201 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28202 effect only if all the conditions are true, even if it appears before some of
28203 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28204 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28205 are present on a &%warn%& verb, both are processed according to their
28206 specifications.
28207
28208 By default, new header lines are added to a message at the end of the existing
28209 header lines. However, you can specify that any particular header line should
28210 be added right at the start (before all the &'Received:'& lines), immediately
28211 after the first block of &'Received:'& lines, or immediately before any line
28212 that is not a &'Received:'& or &'Resent-something:'& header.
28213
28214 This is done by specifying &":at_start:"&, &":after_received:"&, or
28215 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28216 header line, respectively. (Header text cannot start with a colon, as there has
28217 to be a header name first.) For example:
28218 .code
28219 warn add_header = \
28220        :after_received:X-My-Header: something or other...
28221 .endd
28222 If more than one header line is supplied in a single &%add_header%& modifier,
28223 each one is treated independently and can therefore be placed differently. If
28224 you add more than one line at the start, or after the Received: block, they end
28225 up in reverse order.
28226
28227 &*Warning*&: This facility currently applies only to header lines that are
28228 added in an ACL. It does NOT work for header lines that are added in a
28229 system filter or in a router or transport.
28230
28231
28232
28233 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28234 .cindex "header lines" "removing in an ACL"
28235 .cindex "header lines" "position of removed lines"
28236 .cindex "&%remove_header%& ACL modifier"
28237 The &%remove_header%& modifier can be used to remove one or more header lines
28238 from an incoming message, as in this example:
28239 .code
28240 warn   message        = Remove internal headers
28241        remove_header  = x-route-mail1 : x-route-mail2
28242 .endd
28243 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28244 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28245 receiving a message). The message must ultimately be accepted for
28246 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28247 with any ACL verb, including &%deny%&, though this is really not useful for
28248 any verb that doesn't result in a delivered message.
28249
28250 Headers will not be removed to the message if the modifier is used in
28251 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28252
28253 More than one header can be removed at the same time by using a colon separated
28254 list of header names. The header matching is case insensitive. Wildcards are
28255 not permitted, nor is list expansion performed, so you cannot use hostlists to
28256 create a list of headers, however both connection and message variable expansion
28257 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28258 .code
28259 warn   hosts           = +internal_hosts
28260        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28261 warn   message         = Remove internal headers
28262        remove_header   = $acl_c_ihdrs
28263 .endd
28264 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28265 They are removed from the message before processing the DATA and MIME ACLs.
28266 There is no harm in attempting to remove the same header twice nor is removing
28267 a non-existent header. Further header lines to be removed may be accumulated
28268 during the DATA and MIME ACLs, after which they are removed from the message,
28269 if present. In the case of non-SMTP messages, headers to be removed are
28270 accumulated during the non-SMTP ACLs, and are removed from the message after
28271 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28272 ACL, there really is no effect because there is no logging of what headers
28273 would have been removed.
28274
28275 .cindex "header lines" "removed; visibility of"
28276 Header lines are not visible in string expansions until the DATA phase when it
28277 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28278 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28279 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28280 this restriction, you cannot use header lines as a way of controlling data
28281 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28282 you should instead use ACL variables, as described in section
28283 &<<SECTaclvariables>>&.
28284
28285 The &%remove_header%& modifier acts immediately as it is encountered during the
28286 processing of an ACL. Notice the difference between these two cases:
28287 .display
28288 &`accept remove_header = X-Internal`&
28289 &`       `&<&'some condition'&>
28290
28291 &`accept `&<&'some condition'&>
28292 &`       remove_header = X-Internal`&
28293 .endd
28294 In the first case, the header line is always removed, whether or not the
28295 condition is true. In the second case, the header line is removed only if the
28296 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28297 same ACL statement. All those that are encountered before a condition fails
28298 are honoured.
28299
28300 &*Warning*&: This facility currently applies only to header lines that are
28301 present during ACL processing. It does NOT remove header lines that are added
28302 in a system filter or in a router or transport.
28303
28304
28305
28306
28307 .section "ACL conditions" "SECTaclconditions"
28308 .cindex "&ACL;" "conditions; list of"
28309 Some of the conditions listed in this section are available only when Exim is
28310 compiled with the content-scanning extension. They are included here briefly
28311 for completeness. More detailed descriptions can be found in the discussion on
28312 content scanning in chapter &<<CHAPexiscan>>&.
28313
28314 Not all conditions are relevant in all circumstances. For example, testing
28315 senders and recipients does not make sense in an ACL that is being run as the
28316 result of the arrival of an ETRN command, and checks on message headers can be
28317 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28318 can use the same condition (with different parameters) more than once in the
28319 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28320 The conditions are as follows:
28321
28322
28323 .vlist
28324 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28325 .cindex "&ACL;" "nested"
28326 .cindex "&ACL;" "indirect"
28327 .cindex "&ACL;" "arguments"
28328 .cindex "&%acl%& ACL condition"
28329 The possible values of the argument are the same as for the
28330 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28331 &"accept"& the condition is true; if it returns &"deny"& the condition is
28332 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28333 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28334 condition false. This means that further processing of the &%warn%& verb
28335 ceases, but processing of the ACL continues.
28336
28337 If the argument is a named ACL, up to nine space-separated optional values
28338 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28339 and $acl_narg is set to the count of values.
28340 Previous values of these variables are restored after the call returns.
28341 The name and values are expanded separately.
28342 Note that spaces in complex expansions which are used as arguments
28343 will act as argument separators.
28344
28345 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28346 the connection is dropped. If it returns &"discard"&, the verb must be
28347 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28348 conditions are tested.
28349
28350 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28351 loops. This condition allows you to use different ACLs in different
28352 circumstances. For example, different ACLs can be used to handle RCPT commands
28353 for different local users or different local domains.
28354
28355 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28356 .cindex "&%authenticated%& ACL condition"
28357 .cindex "authentication" "ACL checking"
28358 .cindex "&ACL;" "testing for authentication"
28359 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28360 the name of the authenticator is tested against the list. To test for
28361 authentication by any authenticator, you can set
28362 .code
28363 authenticated = *
28364 .endd
28365
28366 .vitem &*condition&~=&~*&<&'string'&>
28367 .cindex "&%condition%& ACL condition"
28368 .cindex "customizing" "ACL condition"
28369 .cindex "&ACL;" "customized test"
28370 .cindex "&ACL;" "testing, customized"
28371 This feature allows you to make up custom conditions. If the result of
28372 expanding the string is an empty string, the number zero, or one of the strings
28373 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28374 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28375 any other value, some error is assumed to have occurred, and the ACL returns
28376 &"defer"&. However, if the expansion is forced to fail, the condition is
28377 ignored. The effect is to treat it as true, whether it is positive or
28378 negative.
28379
28380 .vitem &*decode&~=&~*&<&'location'&>
28381 .cindex "&%decode%& ACL condition"
28382 This condition is available only when Exim is compiled with the
28383 content-scanning extension, and it is allowed only in the ACL defined by
28384 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28385 If all goes well, the condition is true. It is false only if there are
28386 problems such as a syntax error or a memory shortage. For more details, see
28387 chapter &<<CHAPexiscan>>&.
28388
28389 .vitem &*demime&~=&~*&<&'extension&~list'&>
28390 .cindex "&%demime%& ACL condition"
28391 This condition is available only when Exim is compiled with the
28392 content-scanning extension. Its use is described in section
28393 &<<SECTdemimecond>>&.
28394
28395 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28396 .cindex "&%dnslists%& ACL condition"
28397 .cindex "DNS list" "in ACL"
28398 .cindex "black list (DNS)"
28399 .cindex "&ACL;" "testing a DNS list"
28400 This condition checks for entries in DNS black lists. These are also known as
28401 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28402 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28403 different variants of this condition to describe briefly here. See sections
28404 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28405
28406 .vitem &*domains&~=&~*&<&'domain&~list'&>
28407 .cindex "&%domains%& ACL condition"
28408 .cindex "domain" "ACL checking"
28409 .cindex "&ACL;" "testing a recipient domain"
28410 .vindex "&$domain_data$&"
28411 This condition is relevant only after a RCPT command. It checks that the domain
28412 of the recipient address is in the domain list. If percent-hack processing is
28413 enabled, it is done before this test is done. If the check succeeds with a
28414 lookup, the result of the lookup is placed in &$domain_data$& until the next
28415 &%domains%& test.
28416
28417 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28418 use &%domains%& in a DATA ACL.
28419
28420
28421 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28422 .cindex "&%encrypted%& ACL condition"
28423 .cindex "encryption" "checking in an ACL"
28424 .cindex "&ACL;" "testing for encryption"
28425 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28426 name of the cipher suite in use is tested against the list. To test for
28427 encryption without testing for any specific cipher suite(s), set
28428 .code
28429 encrypted = *
28430 .endd
28431
28432
28433 .vitem &*hosts&~=&~*&<&'host&~list'&>
28434 .cindex "&%hosts%& ACL condition"
28435 .cindex "host" "ACL checking"
28436 .cindex "&ACL;" "testing the client host"
28437 This condition tests that the calling host matches the host list. If you have
28438 name lookups or wildcarded host names and IP addresses in the same host list,
28439 you should normally put the IP addresses first. For example, you could have:
28440 .code
28441 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28442 .endd
28443 The lookup in this example uses the host name for its key. This is implied by
28444 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28445 and it wouldn't matter which way round you had these two items.)
28446
28447 The reason for the problem with host names lies in the left-to-right way that
28448 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28449 but when it reaches an item that requires a host name, it fails if it cannot
28450 find a host name to compare with the pattern. If the above list is given in the
28451 opposite order, the &%accept%& statement fails for a host whose name cannot be
28452 found, even if its IP address is 10.9.8.7.
28453
28454 If you really do want to do the name check first, and still recognize the IP
28455 address even if the name lookup fails, you can rewrite the ACL like this:
28456 .code
28457 accept hosts = dbm;/etc/friendly/hosts
28458 accept hosts = 10.9.8.7
28459 .endd
28460 The default action on failing to find the host name is to assume that the host
28461 is not in the list, so the first &%accept%& statement fails. The second
28462 statement can then check the IP address.
28463
28464 .vindex "&$host_data$&"
28465 If a &%hosts%& condition is satisfied by means of a lookup, the result
28466 of the lookup is made available in the &$host_data$& variable. This
28467 allows you, for example, to set up a statement like this:
28468 .code
28469 deny  hosts = net-lsearch;/some/file
28470 message = $host_data
28471 .endd
28472 which gives a custom error message for each denied host.
28473
28474 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28475 .cindex "&%local_parts%& ACL condition"
28476 .cindex "local part" "ACL checking"
28477 .cindex "&ACL;" "testing a local part"
28478 .vindex "&$local_part_data$&"
28479 This condition is relevant only after a RCPT command. It checks that the local
28480 part of the recipient address is in the list. If percent-hack processing is
28481 enabled, it is done before this test. If the check succeeds with a lookup, the
28482 result of the lookup is placed in &$local_part_data$&, which remains set until
28483 the next &%local_parts%& test.
28484
28485 .vitem &*malware&~=&~*&<&'option'&>
28486 .cindex "&%malware%& ACL condition"
28487 .cindex "&ACL;" "virus scanning"
28488 .cindex "&ACL;" "scanning for viruses"
28489 This condition is available only when Exim is compiled with the
28490 content-scanning extension. It causes the incoming message to be scanned for
28491 viruses. For details, see chapter &<<CHAPexiscan>>&.
28492
28493 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28494 .cindex "&%mime_regex%& ACL condition"
28495 .cindex "&ACL;" "testing by regex matching"
28496 This condition is available only when Exim is compiled with the
28497 content-scanning extension, and it is allowed only in the ACL defined by
28498 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28499 with any of the regular expressions. For details, see chapter
28500 &<<CHAPexiscan>>&.
28501
28502 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28503 .cindex "rate limiting"
28504 This condition can be used to limit the rate at which a user or host submits
28505 messages. Details are given in section &<<SECTratelimiting>>&.
28506
28507 .vitem &*recipients&~=&~*&<&'address&~list'&>
28508 .cindex "&%recipients%& ACL condition"
28509 .cindex "recipient" "ACL checking"
28510 .cindex "&ACL;" "testing a recipient"
28511 This condition is relevant only after a RCPT command. It checks the entire
28512 recipient address against a list of recipients.
28513
28514 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28515 .cindex "&%regex%& ACL condition"
28516 .cindex "&ACL;" "testing by regex matching"
28517 This condition is available only when Exim is compiled with the
28518 content-scanning extension, and is available only in the DATA, MIME, and
28519 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28520 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28521
28522 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28523 .cindex "&%sender_domains%& ACL condition"
28524 .cindex "sender" "ACL checking"
28525 .cindex "&ACL;" "testing a sender domain"
28526 .vindex "&$domain$&"
28527 .vindex "&$sender_address_domain$&"
28528 This condition tests the domain of the sender of the message against the given
28529 domain list. &*Note*&: The domain of the sender address is in
28530 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28531 of this condition. This is an exception to the general rule for testing domain
28532 lists. It is done this way so that, if this condition is used in an ACL for a
28533 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28534 influence the sender checking.
28535
28536 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28537 relaying, because sender addresses are easily, and commonly, forged.
28538
28539 .vitem &*senders&~=&~*&<&'address&~list'&>
28540 .cindex "&%senders%& ACL condition"
28541 .cindex "sender" "ACL checking"
28542 .cindex "&ACL;" "testing a sender"
28543 This condition tests the sender of the message against the given list. To test
28544 for a bounce message, which has an empty sender, set
28545 .code
28546 senders = :
28547 .endd
28548 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28549 relaying, because sender addresses are easily, and commonly, forged.
28550
28551 .vitem &*spam&~=&~*&<&'username'&>
28552 .cindex "&%spam%& ACL condition"
28553 .cindex "&ACL;" "scanning for spam"
28554 This condition is available only when Exim is compiled with the
28555 content-scanning extension. It causes the incoming message to be scanned by
28556 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28557
28558 .vitem &*verify&~=&~certificate*&
28559 .cindex "&%verify%& ACL condition"
28560 .cindex "TLS" "client certificate verification"
28561 .cindex "certificate" "verification of client"
28562 .cindex "&ACL;" "certificate verification"
28563 .cindex "&ACL;" "testing a TLS certificate"
28564 This condition is true in an SMTP session if the session is encrypted, and a
28565 certificate was received from the client, and the certificate was verified. The
28566 server requests a certificate only if the client matches &%tls_verify_hosts%&
28567 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28568
28569 .vitem &*verify&~=&~csa*&
28570 .cindex "CSA verification"
28571 This condition checks whether the sending host (the client) is authorized to
28572 send email. Details of how this works are given in section
28573 &<<SECTverifyCSA>>&.
28574
28575 .vitem &*verify&~=&~header_names_ascii*&
28576 .cindex "&%verify%& ACL condition"
28577 .cindex "&ACL;" "verifying header names only ASCII"
28578 .cindex "header lines" "verifying header names only ASCII"
28579 .cindex "verifying" "header names only ASCII"
28580 This condition is relevant only in an ACL that is run after a message has been
28581 received, that is, in an ACL specified by &%acl_smtp_data%& or
28582 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28583 there are no non-ASCII characters, also excluding control characters.  The
28584 allowable characters are decimal ASCII values 33 through 126.
28585
28586 Exim itself will handle headers with non-ASCII characters, but it can cause
28587 problems for downstream applications, so this option will allow their
28588 detection and rejection in the DATA ACL's.
28589
28590 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28591 .cindex "&%verify%& ACL condition"
28592 .cindex "&ACL;" "verifying sender in the header"
28593 .cindex "header lines" "verifying the sender in"
28594 .cindex "sender" "verifying in header"
28595 .cindex "verifying" "sender in header"
28596 This condition is relevant only in an ACL that is run after a message has been
28597 received, that is, in an ACL specified by &%acl_smtp_data%& or
28598 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28599 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28600 is loosely thought of as a &"sender"& address (hence the name of the test).
28601 However, an address that appears in one of these headers need not be an address
28602 that accepts bounce messages; only sender addresses in envelopes are required
28603 to accept bounces. Therefore, if you use the callout option on this check, you
28604 might want to arrange for a non-empty address in the MAIL command.
28605
28606 Details of address verification and the options are given later, starting at
28607 section &<<SECTaddressverification>>& (callouts are described in section
28608 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28609 condition to restrict it to bounce messages only:
28610 .code
28611 deny    senders = :
28612         message = A valid sender header is required for bounces
28613        !verify  = header_sender
28614 .endd
28615
28616 .vitem &*verify&~=&~header_syntax*&
28617 .cindex "&%verify%& ACL condition"
28618 .cindex "&ACL;" "verifying header syntax"
28619 .cindex "header lines" "verifying syntax"
28620 .cindex "verifying" "header syntax"
28621 This condition is relevant only in an ACL that is run after a message has been
28622 received, that is, in an ACL specified by &%acl_smtp_data%& or
28623 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28624 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28625 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28626 permitted only in locally generated messages and from hosts that match
28627 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28628 appropriate.
28629
28630 Note that this condition is a syntax check only. However, a common spamming
28631 ploy used to be to send syntactically invalid headers such as
28632 .code
28633 To: @
28634 .endd
28635 and this condition can be used to reject such messages, though they are not as
28636 common as they used to be.
28637
28638 .vitem &*verify&~=&~helo*&
28639 .cindex "&%verify%& ACL condition"
28640 .cindex "&ACL;" "verifying HELO/EHLO"
28641 .cindex "HELO" "verifying"
28642 .cindex "EHLO" "verifying"
28643 .cindex "verifying" "EHLO"
28644 .cindex "verifying" "HELO"
28645 This condition is true if a HELO or EHLO command has been received from the
28646 client host, and its contents have been verified. If there has been no previous
28647 attempt to verify the HELO/EHLO contents, it is carried out when this
28648 condition is encountered. See the description of the &%helo_verify_hosts%& and
28649 &%helo_try_verify_hosts%& options for details of how to request verification
28650 independently of this condition.
28651
28652 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28653 option), this condition is always true.
28654
28655
28656 .vitem &*verify&~=&~not_blind*&
28657 .cindex "verifying" "not blind"
28658 .cindex "bcc recipients, verifying none"
28659 This condition checks that there are no blind (bcc) recipients in the message.
28660 Every envelope recipient must appear either in a &'To:'& header line or in a
28661 &'Cc:'& header line for this condition to be true. Local parts are checked
28662 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28663 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28664 used only in a DATA or non-SMTP ACL.
28665
28666 There are, of course, many legitimate messages that make use of blind (bcc)
28667 recipients. This check should not be used on its own for blocking messages.
28668
28669
28670 .vitem &*verify&~=&~recipient/*&<&'options'&>
28671 .cindex "&%verify%& ACL condition"
28672 .cindex "&ACL;" "verifying recipient"
28673 .cindex "recipient" "verifying"
28674 .cindex "verifying" "recipient"
28675 .vindex "&$address_data$&"
28676 This condition is relevant only after a RCPT command. It verifies the current
28677 recipient. Details of address verification are given later, starting at section
28678 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28679 of &$address_data$& is the last value that was set while routing the address.
28680 This applies even if the verification fails. When an address that is being
28681 verified is redirected to a single address, verification continues with the new
28682 address, and in that case, the subsequent value of &$address_data$& is the
28683 value for the child address.
28684
28685 .vitem &*verify&~=&~reverse_host_lookup*&
28686 .cindex "&%verify%& ACL condition"
28687 .cindex "&ACL;" "verifying host reverse lookup"
28688 .cindex "host" "verifying reverse lookup"
28689 This condition ensures that a verified host name has been looked up from the IP
28690 address of the client host. (This may have happened already if the host name
28691 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28692 Verification ensures that the host name obtained from a reverse DNS lookup, or
28693 one of its aliases, does, when it is itself looked up in the DNS, yield the
28694 original IP address.
28695
28696 If this condition is used for a locally generated message (that is, when there
28697 is no client host involved), it always succeeds.
28698
28699 .vitem &*verify&~=&~sender/*&<&'options'&>
28700 .cindex "&%verify%& ACL condition"
28701 .cindex "&ACL;" "verifying sender"
28702 .cindex "sender" "verifying"
28703 .cindex "verifying" "sender"
28704 This condition is relevant only after a MAIL or RCPT command, or after a
28705 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28706 the message's sender is empty (that is, this is a bounce message), the
28707 condition is true. Otherwise, the sender address is verified.
28708
28709 .vindex "&$address_data$&"
28710 .vindex "&$sender_address_data$&"
28711 If there is data in the &$address_data$& variable at the end of routing, its
28712 value is placed in &$sender_address_data$& at the end of verification. This
28713 value can be used in subsequent conditions and modifiers in the same ACL
28714 statement. It does not persist after the end of the current statement. If you
28715 want to preserve the value for longer, you can save it in an ACL variable.
28716
28717 Details of verification are given later, starting at section
28718 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28719 to avoid doing it more than once per message.
28720
28721 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28722 .cindex "&%verify%& ACL condition"
28723 This is a variation of the previous option, in which a modified address is
28724 verified as a sender.
28725 .endlist
28726
28727
28728
28729 .section "Using DNS lists" "SECTmorednslists"
28730 .cindex "DNS list" "in ACL"
28731 .cindex "black list (DNS)"
28732 .cindex "&ACL;" "testing a DNS list"
28733 In its simplest form, the &%dnslists%& condition tests whether the calling host
28734 is on at least one of a number of DNS lists by looking up the inverted IP
28735 address in one or more DNS domains. (Note that DNS list domains are not mail
28736 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28737 special options instead.) For example, if the calling host's IP
28738 address is 192.168.62.43, and the ACL statement is
28739 .code
28740 deny dnslists = blackholes.mail-abuse.org : \
28741                 dialups.mail-abuse.org
28742 .endd
28743 the following records are looked up:
28744 .code
28745 43.62.168.192.blackholes.mail-abuse.org
28746 43.62.168.192.dialups.mail-abuse.org
28747 .endd
28748 As soon as Exim finds an existing DNS record, processing of the list stops.
28749 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28750 to test that a host is on more than one list (an &"and"& conjunction), you can
28751 use two separate conditions:
28752 .code
28753 deny dnslists = blackholes.mail-abuse.org
28754      dnslists = dialups.mail-abuse.org
28755 .endd
28756 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28757 behaves as if the host does not match the list item, that is, as if the DNS
28758 record does not exist. If there are further items in the DNS list, they are
28759 processed.
28760
28761 This is usually the required action when &%dnslists%& is used with &%deny%&
28762 (which is the most common usage), because it prevents a DNS failure from
28763 blocking mail. However, you can change this behaviour by putting one of the
28764 following special items in the list:
28765 .display
28766 &`+include_unknown `&   behave as if the item is on the list
28767 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28768 &`+defer_unknown   `&   give a temporary error
28769 .endd
28770 .cindex "&`+include_unknown`&"
28771 .cindex "&`+exclude_unknown`&"
28772 .cindex "&`+defer_unknown`&"
28773 Each of these applies to any subsequent items on the list. For example:
28774 .code
28775 deny dnslists = +defer_unknown : foo.bar.example
28776 .endd
28777 Testing the list of domains stops as soon as a match is found. If you want to
28778 warn for one list and block for another, you can use two different statements:
28779 .code
28780 deny  dnslists = blackholes.mail-abuse.org
28781 warn  message  = X-Warn: sending host is on dialups list
28782       dnslists = dialups.mail-abuse.org
28783 .endd
28784 DNS list lookups are cached by Exim for the duration of the SMTP session,
28785 so a lookup based on the IP address is done at most once for any incoming
28786 connection. Exim does not share information between multiple incoming
28787 connections (but your local name server cache should be active).
28788
28789
28790
28791 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28792 .cindex "DNS list" "keyed by explicit IP address"
28793 By default, the IP address that is used in a DNS list lookup is the IP address
28794 of the calling host. However, you can specify another IP address by listing it
28795 after the domain name, introduced by a slash. For example:
28796 .code
28797 deny dnslists = black.list.tld/192.168.1.2
28798 .endd
28799 This feature is not very helpful with explicit IP addresses; it is intended for
28800 use with IP addresses that are looked up, for example, the IP addresses of the
28801 MX hosts or nameservers of an email sender address. For an example, see section
28802 &<<SECTmulkeyfor>>& below.
28803
28804
28805
28806
28807 .section "DNS lists keyed on domain names" "SECID202"
28808 .cindex "DNS list" "keyed by domain name"
28809 There are some lists that are keyed on domain names rather than inverted IP
28810 addresses (see for example the &'domain based zones'& link at
28811 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28812 with these lists. You can change the name that is looked up in a DNS list by
28813 listing it after the domain name, introduced by a slash. For example,
28814 .code
28815 deny  message  = Sender's domain is listed at $dnslist_domain
28816       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28817 .endd
28818 This particular example is useful only in ACLs that are obeyed after the
28819 RCPT or DATA commands, when a sender address is available. If (for
28820 example) the message's sender is &'user@tld.example'& the name that is looked
28821 up by this example is
28822 .code
28823 tld.example.dsn.rfc-ignorant.org
28824 .endd
28825 A single &%dnslists%& condition can contain entries for both names and IP
28826 addresses. For example:
28827 .code
28828 deny dnslists = sbl.spamhaus.org : \
28829                 dsn.rfc-ignorant.org/$sender_address_domain
28830 .endd
28831 The first item checks the sending host's IP address; the second checks a domain
28832 name. The whole condition is true if either of the DNS lookups succeeds.
28833
28834
28835
28836
28837 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28838 .cindex "DNS list" "multiple keys for"
28839 The syntax described above for looking up explicitly-defined values (either
28840 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28841 name for the DNS list, what follows the slash can in fact be a list of items.
28842 As with all lists in Exim, the default separator is a colon. However, because
28843 this is a sublist within the list of DNS blacklist domains, it is necessary
28844 either to double the separators like this:
28845 .code
28846 dnslists = black.list.tld/name.1::name.2
28847 .endd
28848 or to change the separator character, like this:
28849 .code
28850 dnslists = black.list.tld/<;name.1;name.2
28851 .endd
28852 If an item in the list is an IP address, it is inverted before the DNS
28853 blacklist domain is appended. If it is not an IP address, no inversion
28854 occurs. Consider this condition:
28855 .code
28856 dnslists = black.list.tld/<;192.168.1.2;a.domain
28857 .endd
28858 The DNS lookups that occur are:
28859 .code
28860 2.1.168.192.black.list.tld
28861 a.domain.black.list.tld
28862 .endd
28863 Once a DNS record has been found (that matches a specific IP return
28864 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28865 are done. If there is a temporary DNS error, the rest of the sublist of domains
28866 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28867 only if no other DNS lookup in this sublist succeeds. In other words, a
28868 successful lookup for any of the items in the sublist overrides a temporary
28869 error for a previous item.
28870
28871 The ability to supply a list of items after the slash is in some sense just a
28872 syntactic convenience. These two examples have the same effect:
28873 .code
28874 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28875 dnslists = black.list.tld/a.domain::b.domain
28876 .endd
28877 However, when the data for the list is obtained from a lookup, the second form
28878 is usually much more convenient. Consider this example:
28879 .code
28880 deny message  = The mail servers for the domain \
28881                 $sender_address_domain \
28882                 are listed at $dnslist_domain ($dnslist_value); \
28883                 see $dnslist_text.
28884      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28885                                    ${lookup dnsdb {>|mxh=\
28886                                    $sender_address_domain} }} }
28887 .endd
28888 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28889 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28890 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28891 of expanding the condition might be something like this:
28892 .code
28893 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28894 .endd
28895 Thus, this example checks whether or not the IP addresses of the sender
28896 domain's mail servers are on the Spamhaus black list.
28897
28898 The key that was used for a successful DNS list lookup is put into the variable
28899 &$dnslist_matched$& (see section &<<SECID204>>&).
28900
28901
28902
28903
28904 .section "Data returned by DNS lists" "SECID203"
28905 .cindex "DNS list" "data returned from"
28906 DNS lists are constructed using address records in the DNS. The original RBL
28907 just used the address 127.0.0.1 on the right hand side of each record, but the
28908 RBL+ list and some other lists use a number of values with different meanings.
28909 The values used on the RBL+ list are:
28910 .display
28911 127.1.0.1  RBL
28912 127.1.0.2  DUL
28913 127.1.0.3  DUL and RBL
28914 127.1.0.4  RSS
28915 127.1.0.5  RSS and RBL
28916 127.1.0.6  RSS and DUL
28917 127.1.0.7  RSS and DUL and RBL
28918 .endd
28919 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28920 different values. Some DNS lists may return more than one address record;
28921 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28922
28923
28924 .section "Variables set from DNS lists" "SECID204"
28925 .cindex "expansion" "variables, set from DNS list"
28926 .cindex "DNS list" "variables set from"
28927 .vindex "&$dnslist_domain$&"
28928 .vindex "&$dnslist_matched$&"
28929 .vindex "&$dnslist_text$&"
28930 .vindex "&$dnslist_value$&"
28931 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28932 the name of the overall domain that matched (for example,
28933 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28934 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28935 the DNS record. When the key is an IP address, it is not reversed in
28936 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28937 cases, for example:
28938 .code
28939 deny dnslists = spamhaus.example
28940 .endd
28941 the key is also available in another variable (in this case,
28942 &$sender_host_address$&). In more complicated cases, however, this is not true.
28943 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28944 might generate a dnslists lookup like this:
28945 .code
28946 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28947 .endd
28948 If this condition succeeds, the value in &$dnslist_matched$& might be
28949 &`192.168.6.7`& (for example).
28950
28951 If more than one address record is returned by the DNS lookup, all the IP
28952 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28953 The variable &$dnslist_text$& contains the contents of any associated TXT
28954 record. For lists such as RBL+ the TXT record for a merged entry is often not
28955 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28956 information.
28957
28958 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28959 &-- although these appear before the condition in the ACL, they are not
28960 expanded until after it has failed. For example:
28961 .code
28962 deny    hosts = !+local_networks
28963         message = $sender_host_address is listed \
28964                   at $dnslist_domain
28965         dnslists = rbl-plus.mail-abuse.example
28966 .endd
28967
28968
28969
28970 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28971 .cindex "DNS list" "matching specific returned data"
28972 You can add an equals sign and an IP address after a &%dnslists%& domain name
28973 in order to restrict its action to DNS records with a matching right hand side.
28974 For example,
28975 .code
28976 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28977 .endd
28978 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28979 any address record is considered to be a match. For the moment, we assume
28980 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28981 describes how multiple records are handled.
28982
28983 More than one IP address may be given for checking, using a comma as a
28984 separator. These are alternatives &-- if any one of them matches, the
28985 &%dnslists%& condition is true. For example:
28986 .code
28987 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28988 .endd
28989 If you want to specify a constraining address list and also specify names or IP
28990 addresses to be looked up, the constraining address list must be specified
28991 first. For example:
28992 .code
28993 deny dnslists = dsn.rfc-ignorant.org\
28994                 =127.0.0.2/$sender_address_domain
28995 .endd
28996
28997 If the character &`&&`& is used instead of &`=`&, the comparison for each
28998 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28999 In other words, the listed addresses are used as bit masks. The comparison is
29000 true if all the bits in the mask are present in the address that is being
29001 tested. For example:
29002 .code
29003 dnslists = a.b.c&0.0.0.3
29004 .endd
29005 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29006 want to test whether one bit or another bit is present (as opposed to both
29007 being present), you must use multiple values. For example:
29008 .code
29009 dnslists = a.b.c&0.0.0.1,0.0.0.2
29010 .endd
29011 matches if the final component of the address is an odd number or two times
29012 an odd number.
29013
29014
29015
29016 .section "Negated DNS matching conditions" "SECID205"
29017 You can supply a negative list of IP addresses as part of a &%dnslists%&
29018 condition. Whereas
29019 .code
29020 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29021 .endd
29022 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29023 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29024 .code
29025 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29026 .endd
29027 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29028 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29029 words, the result of the test is inverted if an exclamation mark appears before
29030 the &`=`& (or the &`&&`&) sign.
29031
29032 &*Note*&: This kind of negation is not the same as negation in a domain,
29033 host, or address list (which is why the syntax is different).
29034
29035 If you are using just one list, the negation syntax does not gain you much. The
29036 previous example is precisely equivalent to
29037 .code
29038 deny  dnslists = a.b.c
29039      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29040 .endd
29041 However, if you are using multiple lists, the negation syntax is clearer.
29042 Consider this example:
29043 .code
29044 deny  dnslists = sbl.spamhaus.org : \
29045                  list.dsbl.org : \
29046                  dnsbl.njabl.org!=127.0.0.3 : \
29047                  relays.ordb.org
29048 .endd
29049 Using only positive lists, this would have to be:
29050 .code
29051 deny  dnslists = sbl.spamhaus.org : \
29052                  list.dsbl.org
29053 deny  dnslists = dnsbl.njabl.org
29054      !dnslists = dnsbl.njabl.org=127.0.0.3
29055 deny  dnslists = relays.ordb.org
29056 .endd
29057 which is less clear, and harder to maintain.
29058
29059
29060
29061
29062 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29063 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29064 thereby providing more than one IP address. When an item in a &%dnslists%& list
29065 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29066 the match to specific results from the DNS lookup, there are two ways in which
29067 the checking can be handled. For example, consider the condition:
29068 .code
29069 dnslists = a.b.c=127.0.0.1
29070 .endd
29071 What happens if the DNS lookup for the incoming IP address yields both
29072 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29073 condition true because at least one given value was found, or is it false
29074 because at least one of the found values was not listed? And how does this
29075 affect negated conditions? Both possibilities are provided for with the help of
29076 additional separators &`==`& and &`=&&`&.
29077
29078 .ilist
29079 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29080 IP addresses matches one of the listed addresses. For the example above, the
29081 condition is true because 127.0.0.1 matches.
29082 .next
29083 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29084 looked up IP addresses matches one of the listed addresses. If the condition is
29085 changed to:
29086 .code
29087 dnslists = a.b.c==127.0.0.1
29088 .endd
29089 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29090 false because 127.0.0.2 is not listed. You would need to have:
29091 .code
29092 dnslists = a.b.c==127.0.0.1,127.0.0.2
29093 .endd
29094 for the condition to be true.
29095 .endlist
29096
29097 When &`!`& is used to negate IP address matching, it inverts the result, giving
29098 the precise opposite of the behaviour above. Thus:
29099 .ilist
29100 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29101 addresses matches one of the listed addresses. Consider:
29102 .code
29103 dnslists = a.b.c!&0.0.0.1
29104 .endd
29105 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29106 false because 127.0.0.1 matches.
29107 .next
29108 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29109 looked up IP address that does not match. Consider:
29110 .code
29111 dnslists = a.b.c!=&0.0.0.1
29112 .endd
29113 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29114 true, because 127.0.0.2 does not match. You would need to have:
29115 .code
29116 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29117 .endd
29118 for the condition to be false.
29119 .endlist
29120 When the DNS lookup yields only a single IP address, there is no difference
29121 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29122
29123
29124
29125
29126 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29127 .cindex "DNS list" "information from merged"
29128 When the facility for restricting the matching IP values in a DNS list is used,
29129 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29130 the true reason for rejection. This happens when lists are merged and the IP
29131 address in the A record is used to distinguish them; unfortunately there is
29132 only one TXT record. One way round this is not to use merged lists, but that
29133 can be inefficient because it requires multiple DNS lookups where one would do
29134 in the vast majority of cases when the host of interest is not on any of the
29135 lists.
29136
29137 A less inefficient way of solving this problem is available. If
29138 two domain names, comma-separated, are given, the second is used first to
29139 do an initial check, making use of any IP value restrictions that are set.
29140 If there is a match, the first domain is used, without any IP value
29141 restrictions, to get the TXT record. As a byproduct of this, there is also
29142 a check that the IP being tested is indeed on the first list. The first
29143 domain is the one that is put in &$dnslist_domain$&. For example:
29144 .code
29145 reject message  = \
29146          rejected because $sender_host_address is blacklisted \
29147          at $dnslist_domain\n$dnslist_text
29148        dnslists = \
29149          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29150          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29151 .endd
29152 For the first blacklist item, this starts by doing a lookup in
29153 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29154 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29155 value, and as long as something is found, it looks for the corresponding TXT
29156 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29157 The second blacklist item is processed similarly.
29158
29159 If you are interested in more than one merged list, the same list must be
29160 given several times, but because the results of the DNS lookups are cached,
29161 the DNS calls themselves are not repeated. For example:
29162 .code
29163 reject dnslists = \
29164          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29165          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29166          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29167          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29168 .endd
29169 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29170 values matches (or if no record is found), this is the only lookup that is
29171 done. Only if there is a match is one of the more specific lists consulted.
29172
29173
29174
29175 .section "DNS lists and IPv6" "SECTmorednslistslast"
29176 .cindex "IPv6" "DNS black lists"
29177 .cindex "DNS list" "IPv6 usage"
29178 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29179 nibble by nibble. For example, if the calling host's IP address is
29180 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29181 .code
29182 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29183   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29184 .endd
29185 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29186 lists contain wildcard records, intended for IPv4, that interact badly with
29187 IPv6. For example, the DNS entry
29188 .code
29189 *.3.some.list.example.    A    127.0.0.1
29190 .endd
29191 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29192 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29193
29194 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29195 &%condition%& condition, as in this example:
29196 .code
29197 deny   condition = ${if isip4{$sender_host_address}}
29198        dnslists  = some.list.example
29199 .endd
29200
29201 If an explicit key is being used for a DNS lookup and it may be an IPv6
29202 address you should specify alternate list separators for both the outer
29203 (DNS list name) list and inner (lookup keys) list:
29204 .code
29205        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29206 .endd
29207
29208 .section "Rate limiting incoming messages" "SECTratelimiting"
29209 .cindex "rate limiting" "client sending"
29210 .cindex "limiting client sending rates"
29211 .oindex "&%smtp_ratelimit_*%&"
29212 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29213 which clients can send email. This is more powerful than the
29214 &%smtp_ratelimit_*%& options, because those options control the rate of
29215 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29216 works across all connections (concurrent and sequential) from the same client
29217 host. The syntax of the &%ratelimit%& condition is:
29218 .display
29219 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29220 .endd
29221 If the average client sending rate is less than &'m'& messages per time
29222 period &'p'& then the condition is false; otherwise it is true.
29223
29224 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29225 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29226 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29227 of &'p'&.
29228
29229 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29230 time interval, for example, &`8h`& for eight hours. A larger time constant
29231 means that it takes Exim longer to forget a client's past behaviour. The
29232 parameter &'m'& is the maximum number of messages that a client is permitted to
29233 send in each time interval. It also specifies the number of messages permitted
29234 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29235 constant, you can allow a client to send more messages in a burst without
29236 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29237 both small, messages must be sent at an even rate.
29238
29239 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29240 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29241 when deploying the &%ratelimit%& ACL condition. The script prints usage
29242 instructions when it is run with no arguments.
29243
29244 The key is used to look up the data for calculating the client's average
29245 sending rate. This data is stored in Exim's spool directory, alongside the
29246 retry and other hints databases. The default key is &$sender_host_address$&,
29247 which means Exim computes the sending rate of each client host IP address.
29248 By changing the key you can change how Exim identifies clients for the purpose
29249 of ratelimiting. For example, to limit the sending rate of each authenticated
29250 user, independent of the computer they are sending from, set the key to
29251 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29252 example, &$authenticated_id$& is only meaningful if the client has
29253 authenticated (which you can check with the &%authenticated%& ACL condition).
29254
29255 The lookup key does not have to identify clients: If you want to limit the
29256 rate at which a recipient receives messages, you can use the key
29257 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29258 ACL.
29259
29260 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29261 specifies what Exim measures the rate of, for example messages or recipients
29262 or bytes. You can adjust the measurement using the &%unique=%& and/or
29263 &%count=%& options. You can also control when Exim updates the recorded rate
29264 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29265 separated by a slash, like the other parameters. They may appear in any order.
29266
29267 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29268 any options that alter the meaning of the stored data. The limit &'m'& is not
29269 stored, so you can alter the configured maximum rate and Exim will still
29270 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29271 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29272 behaviour. The lookup key is not affected by changes to the update mode and
29273 the &%count=%& option.
29274
29275
29276 .section "Ratelimit options for what is being measured" "ratoptmea"
29277 .cindex "rate limiting" "per_* options"
29278 The &%per_conn%& option limits the client's connection rate. It is not
29279 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29280 &%acl_not_smtp_start%& ACLs.
29281
29282 The &%per_mail%& option limits the client's rate of sending messages. This is
29283 the default if none of the &%per_*%& options is specified. It can be used in
29284 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29285 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29286
29287 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29288 the same ACLs as the &%per_mail%& option, though it is best to use this option
29289 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29290 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29291 in its MAIL command, which may be inaccurate or completely missing. You can
29292 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29293 in kilobytes, megabytes, or gigabytes, respectively.
29294
29295 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29296 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29297 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29298 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29299 ACLs the rate is updated with the total recipient count in one go. Note that
29300 in either case the rate limiting engine will see a message with many
29301 recipients as a large high-speed burst.
29302
29303 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29304 number of different recipients that the client has sent messages to in the
29305 last time period. That is, if the client repeatedly sends messages to the same
29306 recipient, its measured rate is not increased. This option can only be used in
29307 &%acl_smtp_rcpt%&.
29308
29309 The &%per_cmd%& option causes Exim to recompute the rate every time the
29310 condition is processed. This can be used to limit the rate of any SMTP
29311 command. If it is used in multiple ACLs it can limit the aggregate rate of
29312 multiple different commands.
29313
29314 The &%count=%& option can be used to alter how much Exim adds to the client's
29315 measured rate. For example, the &%per_byte%& option is equivalent to
29316 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29317 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29318 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29319
29320 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29321
29322
29323 .section "Ratelimit update modes" "ratoptupd"
29324 .cindex "rate limiting" "reading data without updating"
29325 You can specify one of three options with the &%ratelimit%& condition to
29326 control when its database is updated. This section describes the &%readonly%&
29327 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29328
29329 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29330 previously-computed rate to check against the limit.
29331
29332 For example, you can test the client's sending rate and deny it access (when
29333 it is too fast) in the connect ACL. If the client passes this check then it
29334 can go on to send a message, in which case its recorded rate will be updated
29335 in the MAIL ACL. Subsequent connections from the same client will check this
29336 new rate.
29337 .code
29338 acl_check_connect:
29339  deny ratelimit = 100 / 5m / readonly
29340     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29341                   (max $sender_rate_limit)
29342 # ...
29343 acl_check_mail:
29344  warn ratelimit = 100 / 5m / strict
29345     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29346                   (max $sender_rate_limit)
29347 .endd
29348
29349 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29350 processing a message then it may increase the client's measured rate more than
29351 it should. For example, this will happen if you check the &%per_rcpt%& option
29352 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29353 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29354 multiple update problems by using the &%readonly%& option on later ratelimit
29355 checks.
29356
29357 The &%per_*%& options described above do not make sense in some ACLs. If you
29358 use a &%per_*%& option in an ACL where it is not normally permitted then the
29359 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29360 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29361 next section) so you must specify the &%readonly%& option explicitly.
29362
29363
29364 .section "Ratelimit options for handling fast clients" "ratoptfast"
29365 .cindex "rate limiting" "strict and leaky modes"
29366 If a client's average rate is greater than the maximum, the rate limiting
29367 engine can react in two possible ways, depending on the presence of the
29368 &%strict%& or &%leaky%& update modes. This is independent of the other
29369 counter-measures (such as rejecting the message) that may be specified by the
29370 rest of the ACL.
29371
29372 The &%leaky%& (default) option means that the client's recorded rate is not
29373 updated if it is above the limit. The effect of this is that Exim measures the
29374 client's average rate of successfully sent email, which cannot be greater than
29375 the maximum allowed. If the client is over the limit it may suffer some
29376 counter-measures (as specified in the ACL), but it will still be able to send
29377 email at the configured maximum rate, whatever the rate of its attempts. This
29378 is generally the better choice if you have clients that retry automatically.
29379 For example, it does not prevent a sender with an over-aggressive retry rate
29380 from getting any email through.
29381
29382 The &%strict%& option means that the client's recorded rate is always
29383 updated. The effect of this is that Exim measures the client's average rate
29384 of attempts to send email, which can be much higher than the maximum it is
29385 actually allowed. If the client is over the limit it may be subjected to
29386 counter-measures by the ACL. It must slow down and allow sufficient time to
29387 pass that its computed rate falls below the maximum before it can send email
29388 again. The time (the number of smoothing periods) it must wait and not
29389 attempt to send mail can be calculated with this formula:
29390 .code
29391         ln(peakrate/maxrate)
29392 .endd
29393
29394
29395 .section "Limiting the rate of different events" "ratoptuniq"
29396 .cindex "rate limiting" "counting unique events"
29397 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29398 rate of different events. For example, the &%per_addr%& option uses this
29399 mechanism to count the number of different recipients that the client has
29400 sent messages to in the last time period; it is equivalent to
29401 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29402 measure the rate that a client uses different sender addresses with the
29403 options &`per_mail/unique=$sender_address`&.
29404
29405 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29406 has seen for that key. The whole set is thrown away when it is older than the
29407 rate smoothing period &'p'&, so each different event is counted at most once
29408 per period. In the &%leaky%& update mode, an event that causes the client to
29409 go over the limit is not added to the set, in the same way that the client's
29410 recorded rate is not updated in the same situation.
29411
29412 When you combine the &%unique=%& and &%readonly%& options, the specific
29413 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29414 rate.
29415
29416 The &%unique=%& mechanism needs more space in the ratelimit database than the
29417 other &%ratelimit%& options in order to store the event set. The number of
29418 unique values is potentially as large as the rate limit, so the extra space
29419 required increases with larger limits.
29420
29421 The uniqueification is not perfect: there is a small probability that Exim
29422 will think a new event has happened before. If the sender's rate is less than
29423 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29424 the measured rate can go above the limit, in which case Exim may under-count
29425 events by a significant margin. Fortunately, if the rate is high enough (2.7
29426 times the limit) that the false positive rate goes above 9%, then Exim will
29427 throw away the over-full event set before the measured rate falls below the
29428 limit. Therefore the only harm should be that exceptionally high sending rates
29429 are logged incorrectly; any countermeasures you configure will be as effective
29430 as intended.
29431
29432
29433 .section "Using rate limiting" "useratlim"
29434 Exim's other ACL facilities are used to define what counter-measures are taken
29435 when the rate limit is exceeded. This might be anything from logging a warning
29436 (for example, while measuring existing sending rates in order to define
29437 policy), through time delays to slow down fast senders, up to rejecting the
29438 message. For example:
29439 .code
29440 # Log all senders' rates
29441 warn ratelimit = 0 / 1h / strict
29442      log_message = Sender rate $sender_rate / $sender_rate_period
29443
29444 # Slow down fast senders; note the need to truncate $sender_rate
29445 # at the decimal point.
29446 warn ratelimit = 100 / 1h / per_rcpt / strict
29447      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29448                    $sender_rate_limit }s
29449
29450 # Keep authenticated users under control
29451 deny authenticated = *
29452      ratelimit = 100 / 1d / strict / $authenticated_id
29453
29454 # System-wide rate limit
29455 defer message = Sorry, too busy. Try again later.
29456      ratelimit = 10 / 1s / $primary_hostname
29457
29458 # Restrict incoming rate from each host, with a default
29459 # set using a macro and special cases looked up in a table.
29460 defer message = Sender rate exceeds $sender_rate_limit \
29461                messages per $sender_rate_period
29462      ratelimit = ${lookup {$sender_host_address} \
29463                    cdb {DB/ratelimits.cdb} \
29464                    {$value} {RATELIMIT} }
29465 .endd
29466 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29467 especially with the &%per_rcpt%& option, you may suffer from a performance
29468 bottleneck caused by locking on the ratelimit hints database. Apart from
29469 making your ACLs less complicated, you can reduce the problem by using a
29470 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29471 this means that Exim will lose its hints data after a reboot (including retry
29472 hints, the callout cache, and ratelimit data).
29473
29474
29475
29476 .section "Address verification" "SECTaddressverification"
29477 .cindex "verifying address" "options for"
29478 .cindex "policy control" "address verification"
29479 Several of the &%verify%& conditions described in section
29480 &<<SECTaclconditions>>& cause addresses to be verified. Section
29481 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29482 The verification conditions can be followed by options that modify the
29483 verification process. The options are separated from the keyword and from each
29484 other by slashes, and some of them contain parameters. For example:
29485 .code
29486 verify = sender/callout
29487 verify = recipient/defer_ok/callout=10s,defer_ok
29488 .endd
29489 The first stage of address verification, which always happens, is to run the
29490 address through the routers, in &"verify mode"&. Routers can detect the
29491 difference between verification and routing for delivery, and their actions can
29492 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29493 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29494 The available options are as follows:
29495
29496 .ilist
29497 If the &%callout%& option is specified, successful routing to one or more
29498 remote hosts is followed by a &"callout"& to those hosts as an additional
29499 check. Callouts and their sub-options are discussed in the next section.
29500 .next
29501 If there is a defer error while doing verification routing, the ACL
29502 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29503 options, the condition is forced to be true instead. Note that this is a main
29504 verification option as well as a suboption for callouts.
29505 .next
29506 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29507 discusses the reporting of sender address verification failures.
29508 .next
29509 The &%success_on_redirect%& option causes verification always to succeed
29510 immediately after a successful redirection. By default, if a redirection
29511 generates just one address, that address is also verified. See further
29512 discussion in section &<<SECTredirwhilveri>>&.
29513 .endlist
29514
29515 .cindex "verifying address" "differentiating failures"
29516 .vindex "&$recipient_verify_failure$&"
29517 .vindex "&$sender_verify_failure$&"
29518 .vindex "&$acl_verify_message$&"
29519 After an address verification failure, &$acl_verify_message$& contains the
29520 error message that is associated with the failure. It can be preserved by
29521 coding like this:
29522 .code
29523 warn  !verify = sender
29524        set acl_m0 = $acl_verify_message
29525 .endd
29526 If you are writing your own custom rejection message or log message when
29527 denying access, you can use this variable to include information about the
29528 verification failure.
29529
29530 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29531 appropriate) contains one of the following words:
29532
29533 .ilist
29534 &%qualify%&: The address was unqualified (no domain), and the message
29535 was neither local nor came from an exempted host.
29536 .next
29537 &%route%&: Routing failed.
29538 .next
29539 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29540 occurred at or before the MAIL command (that is, on initial
29541 connection, HELO, or MAIL).
29542 .next
29543 &%recipient%&: The RCPT command in a callout was rejected.
29544 .next
29545 &%postmaster%&: The postmaster check in a callout was rejected.
29546 .endlist
29547
29548 The main use of these variables is expected to be to distinguish between
29549 rejections of MAIL and rejections of RCPT in callouts.
29550
29551
29552
29553
29554 .section "Callout verification" "SECTcallver"
29555 .cindex "verifying address" "by callout"
29556 .cindex "callout" "verification"
29557 .cindex "SMTP" "callout verification"
29558 For non-local addresses, routing verifies the domain, but is unable to do any
29559 checking of the local part. There are situations where some means of verifying
29560 the local part is desirable. One way this can be done is to make an SMTP
29561 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29562 a subsequent host for a recipient address, to see if the host accepts the
29563 address. We use the term &'callout'& to cover both cases. Note that for a
29564 sender address, the callback is not to the client host that is trying to
29565 deliver the message, but to one of the hosts that accepts incoming mail for the
29566 sender's domain.
29567
29568 Exim does not do callouts by default. If you want them to happen, you must
29569 request them by setting appropriate options on the &%verify%& condition, as
29570 described below. This facility should be used with care, because it can add a
29571 lot of resource usage to the cost of verifying an address. However, Exim does
29572 cache the results of callouts, which helps to reduce the cost. Details of
29573 caching are in section &<<SECTcallvercache>>&.
29574
29575 Recipient callouts are usually used only between hosts that are controlled by
29576 the same administration. For example, a corporate gateway host could use
29577 callouts to check for valid recipients on an internal mailserver. A successful
29578 callout does not guarantee that a real delivery to the address would succeed;
29579 on the other hand, a failing callout does guarantee that a delivery would fail.
29580
29581 If the &%callout%& option is present on a condition that verifies an address, a
29582 second stage of verification occurs if the address is successfully routed to
29583 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29584 &(manualroute)& router, where the router specifies the hosts. However, if a
29585 router that does not set up hosts routes to an &(smtp)& transport with a
29586 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29587 &%hosts_override%& set, its hosts are always used, whether or not the router
29588 supplies a host list.
29589 Callouts are only supported on &(smtp)& transports.
29590
29591 The port that is used is taken from the transport, if it is specified and is a
29592 remote transport. (For routers that do verification only, no transport need be
29593 specified.) Otherwise, the default SMTP port is used. If a remote transport
29594 specifies an outgoing interface, this is used; otherwise the interface is not
29595 specified. Likewise, the text that is used for the HELO command is taken from
29596 the transport's &%helo_data%& option; if there is no transport, the value of
29597 &$smtp_active_hostname$& is used.
29598
29599 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29600 test whether a bounce message could be delivered to the sender address. The
29601 following SMTP commands are sent:
29602 .display
29603 &`HELO `&<&'local host name'&>
29604 &`MAIL FROM:<>`&
29605 &`RCPT TO:`&<&'the address to be tested'&>
29606 &`QUIT`&
29607 .endd
29608 LHLO is used instead of HELO if the transport's &%protocol%& option is
29609 set to &"lmtp"&.
29610
29611 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29612 settings.
29613
29614 A recipient callout check is similar. By default, it also uses an empty address
29615 for the sender. This default is chosen because most hosts do not make use of
29616 the sender address when verifying a recipient. Using the same address means
29617 that a single cache entry can be used for each recipient. Some sites, however,
29618 do make use of the sender address when verifying. These are catered for by the
29619 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29620
29621 If the response to the RCPT command is a 2&'xx'& code, the verification
29622 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29623 Exim tries the next host, if any. If there is a problem with all the remote
29624 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29625 &%callout%& option is given, in which case the condition is forced to succeed.
29626
29627 .cindex "SMTP" "output flushing, disabling for callout"
29628 A callout may take a little time. For this reason, Exim normally flushes SMTP
29629 output before performing a callout in an ACL, to avoid unexpected timeouts in
29630 clients when the SMTP PIPELINING extension is in use. The flushing can be
29631 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29632
29633
29634
29635
29636 .section "Additional parameters for callouts" "CALLaddparcall"
29637 .cindex "callout" "additional parameters for"
29638 The &%callout%& option can be followed by an equals sign and a number of
29639 optional parameters, separated by commas. For example:
29640 .code
29641 verify = recipient/callout=10s,defer_ok
29642 .endd
29643 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29644 separate verify options, is retained for backwards compatibility, but is now
29645 deprecated. The additional parameters for &%callout%& are as follows:
29646
29647
29648 .vlist
29649 .vitem <&'a&~time&~interval'&>
29650 .cindex "callout" "timeout, specifying"
29651 This specifies the timeout that applies for the callout attempt to each host.
29652 For example:
29653 .code
29654 verify = sender/callout=5s
29655 .endd
29656 The default is 30 seconds. The timeout is used for each response from the
29657 remote host. It is also used for the initial connection, unless overridden by
29658 the &%connect%& parameter.
29659
29660
29661 .vitem &*connect&~=&~*&<&'time&~interval'&>
29662 .cindex "callout" "connection timeout, specifying"
29663 This parameter makes it possible to set a different (usually smaller) timeout
29664 for making the SMTP connection. For example:
29665 .code
29666 verify = sender/callout=5s,connect=1s
29667 .endd
29668 If not specified, this timeout defaults to the general timeout value.
29669
29670 .vitem &*defer_ok*&
29671 .cindex "callout" "defer, action on"
29672 When this parameter is present, failure to contact any host, or any other kind
29673 of temporary error, is treated as success by the ACL. However, the cache is not
29674 updated in this circumstance.
29675
29676 .vitem &*fullpostmaster*&
29677 .cindex "callout" "full postmaster check"
29678 This operates like the &%postmaster%& option (see below), but if the check for
29679 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29680 accordance with the specification in RFC 2821. The RFC states that the
29681 unqualified address &'postmaster'& should be accepted.
29682
29683
29684 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29685 .cindex "callout" "sender when verifying header"
29686 When verifying addresses in header lines using the &%header_sender%&
29687 verification option, Exim behaves by default as if the addresses are envelope
29688 sender addresses from a message. Callout verification therefore tests to see
29689 whether a bounce message could be delivered, by using an empty address in the
29690 MAIL command. However, it is arguable that these addresses might never be used
29691 as envelope senders, and could therefore justifiably reject bounce messages
29692 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29693 address to use in the MAIL command. For example:
29694 .code
29695 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29696 .endd
29697 This parameter is available only for the &%header_sender%& verification option.
29698
29699
29700 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29701 .cindex "callout" "overall timeout, specifying"
29702 This parameter sets an overall timeout for performing a callout verification.
29703 For example:
29704 .code
29705 verify = sender/callout=5s,maxwait=30s
29706 .endd
29707 This timeout defaults to four times the callout timeout for individual SMTP
29708 commands. The overall timeout applies when there is more than one host that can
29709 be tried. The timeout is checked before trying the next host. This prevents
29710 very long delays if there are a large number of hosts and all are timing out
29711 (for example, when network connections are timing out).
29712
29713
29714 .vitem &*no_cache*&
29715 .cindex "callout" "cache, suppressing"
29716 .cindex "caching callout, suppressing"
29717 When this parameter is given, the callout cache is neither read nor updated.
29718
29719 .vitem &*postmaster*&
29720 .cindex "callout" "postmaster; checking"
29721 When this parameter is set, a successful callout check is followed by a similar
29722 check for the local part &'postmaster'& at the same domain. If this address is
29723 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29724 the postmaster check is recorded in a cache record; if it is a failure, this is
29725 used to fail subsequent callouts for the domain without a connection being
29726 made, until the cache record expires.
29727
29728 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29729 The postmaster check uses an empty sender in the MAIL command by default.
29730 You can use this parameter to do a postmaster check using a different address.
29731 For example:
29732 .code
29733 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29734 .endd
29735 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29736 one overrides. The &%postmaster%& parameter is equivalent to this example:
29737 .code
29738 require  verify = sender/callout=postmaster_mailfrom=
29739 .endd
29740 &*Warning*&: The caching arrangements for postmaster checking do not take
29741 account of the sender address. It is assumed that either the empty address or
29742 a fixed non-empty address will be used. All that Exim remembers is that the
29743 postmaster check for the domain succeeded or failed.
29744
29745
29746 .vitem &*random*&
29747 .cindex "callout" "&""random""& check"
29748 When this parameter is set, before doing the normal callout check, Exim does a
29749 check for a &"random"& local part at the same domain. The local part is not
29750 really random &-- it is defined by the expansion of the option
29751 &%callout_random_local_part%&, which defaults to
29752 .code
29753 $primary_hostname-$tod_epoch-testing
29754 .endd
29755 The idea here is to try to determine whether the remote host accepts all local
29756 parts without checking. If it does, there is no point in doing callouts for
29757 specific local parts. If the &"random"& check succeeds, the result is saved in
29758 a cache record, and used to force the current and subsequent callout checks to
29759 succeed without a connection being made, until the cache record expires.
29760
29761 .vitem &*use_postmaster*&
29762 .cindex "callout" "sender for recipient check"
29763 This parameter applies to recipient callouts only. For example:
29764 .code
29765 deny  !verify = recipient/callout=use_postmaster
29766 .endd
29767 .vindex "&$qualify_domain$&"
29768 It causes a non-empty postmaster address to be used in the MAIL command when
29769 performing the callout for the recipient, and also for a &"random"& check if
29770 that is configured. The local part of the address is &`postmaster`& and the
29771 domain is the contents of &$qualify_domain$&.
29772
29773 .vitem &*use_sender*&
29774 This option applies to recipient callouts only. For example:
29775 .code
29776 require  verify = recipient/callout=use_sender
29777 .endd
29778 It causes the message's actual sender address to be used in the MAIL
29779 command when performing the callout, instead of an empty address. There is no
29780 need to use this option unless you know that the called hosts make use of the
29781 sender when checking recipients. If used indiscriminately, it reduces the
29782 usefulness of callout caching.
29783 .endlist
29784
29785 If you use any of the parameters that set a non-empty sender for the MAIL
29786 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29787 &%use_sender%&), you should think about possible loops. Recipient checking is
29788 usually done between two hosts that are under the same management, and the host
29789 that receives the callouts is not normally configured to do callouts itself.
29790 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29791 these circumstances.
29792
29793 However, if you use a non-empty sender address for a callout to an arbitrary
29794 host, there is the likelihood that the remote host will itself initiate a
29795 callout check back to your host. As it is checking what appears to be a message
29796 sender, it is likely to use an empty address in MAIL, thus avoiding a
29797 callout loop. However, to be on the safe side it would be best to set up your
29798 own ACLs so that they do not do sender verification checks when the recipient
29799 is the address you use for header sender or postmaster callout checking.
29800
29801 Another issue to think about when using non-empty senders for callouts is
29802 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29803 by the sender/recipient combination; thus, for any given recipient, many more
29804 actual callouts are performed than when an empty sender or postmaster is used.
29805
29806
29807
29808
29809 .section "Callout caching" "SECTcallvercache"
29810 .cindex "hints database" "callout cache"
29811 .cindex "callout" "cache, description of"
29812 .cindex "caching" "callout"
29813 Exim caches the results of callouts in order to reduce the amount of resources
29814 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29815 option. A hints database called &"callout"& is used for the cache. Two
29816 different record types are used: one records the result of a callout check for
29817 a specific address, and the other records information that applies to the
29818 entire domain (for example, that it accepts the local part &'postmaster'&).
29819
29820 When an original callout fails, a detailed SMTP error message is given about
29821 the failure. However, for subsequent failures use the cache data, this message
29822 is not available.
29823
29824 The expiry times for negative and positive address cache records are
29825 independent, and can be set by the global options &%callout_negative_expire%&
29826 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29827
29828 If a host gives a negative response to an SMTP connection, or rejects any
29829 commands up to and including
29830 .code
29831 MAIL FROM:<>
29832 .endd
29833 (but not including the MAIL command with a non-empty address),
29834 any callout attempt is bound to fail. Exim remembers such failures in a
29835 domain cache record, which it uses to fail callouts for the domain without
29836 making new connections, until the domain record times out. There are two
29837 separate expiry times for domain cache records:
29838 &%callout_domain_negative_expire%& (default 3h) and
29839 &%callout_domain_positive_expire%& (default 7d).
29840
29841 Domain records expire when the negative expiry time is reached if callouts
29842 cannot be made for the domain, or if the postmaster check failed.
29843 Otherwise, they expire when the positive expiry time is reached. This
29844 ensures that, for example, a host that stops accepting &"random"& local parts
29845 will eventually be noticed.
29846
29847 The callout caching mechanism is based on the domain of the address that is
29848 being tested. If the domain routes to several hosts, it is assumed that their
29849 behaviour will be the same.
29850
29851
29852
29853 .section "Sender address verification reporting" "SECTsenaddver"
29854 .cindex "verifying" "suppressing error details"
29855 See section &<<SECTaddressverification>>& for a general discussion of
29856 verification. When sender verification fails in an ACL, the details of the
29857 failure are given as additional output lines before the 550 response to the
29858 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29859 you might see:
29860 .code
29861 MAIL FROM:<xyz@abc.example>
29862 250 OK
29863 RCPT TO:<pqr@def.example>
29864 550-Verification failed for <xyz@abc.example>
29865 550-Called:   192.168.34.43
29866 550-Sent:     RCPT TO:<xyz@abc.example>
29867 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29868 550 Sender verification failed
29869 .endd
29870 If more than one RCPT command fails in the same way, the details are given
29871 only for the first of them. However, some administrators do not want to send
29872 out this much information. You can suppress the details by adding
29873 &`/no_details`& to the ACL statement that requests sender verification. For
29874 example:
29875 .code
29876 verify = sender/no_details
29877 .endd
29878
29879 .section "Redirection while verifying" "SECTredirwhilveri"
29880 .cindex "verifying" "redirection while"
29881 .cindex "address redirection" "while verifying"
29882 A dilemma arises when a local address is redirected by aliasing or forwarding
29883 during verification: should the generated addresses themselves be verified,
29884 or should the successful expansion of the original address be enough to verify
29885 it? By default, Exim takes the following pragmatic approach:
29886
29887 .ilist
29888 When an incoming address is redirected to just one child address, verification
29889 continues with the child address, and if that fails to verify, the original
29890 verification also fails.
29891 .next
29892 When an incoming address is redirected to more than one child address,
29893 verification does not continue. A success result is returned.
29894 .endlist
29895
29896 This seems the most reasonable behaviour for the common use of aliasing as a
29897 way of redirecting different local parts to the same mailbox. It means, for
29898 example, that a pair of alias entries of the form
29899 .code
29900 A.Wol:   aw123
29901 aw123:   :fail: Gone away, no forwarding address
29902 .endd
29903 work as expected, with both local parts causing verification failure. When a
29904 redirection generates more than one address, the behaviour is more like a
29905 mailing list, where the existence of the alias itself is sufficient for
29906 verification to succeed.
29907
29908 It is possible, however, to change the default behaviour so that all successful
29909 redirections count as successful verifications, however many new addresses are
29910 generated. This is specified by the &%success_on_redirect%& verification
29911 option. For example:
29912 .code
29913 require verify = recipient/success_on_redirect/callout=10s
29914 .endd
29915 In this example, verification succeeds if a router generates a new address, and
29916 the callout does not occur, because no address was routed to a remote host.
29917
29918 When verification is being tested via the &%-bv%& option, the treatment of
29919 redirections is as just described, unless the &%-v%& or any debugging option is
29920 also specified. In that case, full verification is done for every generated
29921 address and a report is output for each of them.
29922
29923
29924
29925 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29926 .cindex "CSA" "verifying"
29927 Client SMTP Authorization is a system that allows a site to advertise
29928 which machines are and are not permitted to send email. This is done by placing
29929 special SRV records in the DNS; these are looked up using the client's HELO
29930 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29931 Authorization checks in Exim are performed by the ACL condition:
29932 .code
29933 verify = csa
29934 .endd
29935 This fails if the client is not authorized. If there is a DNS problem, or if no
29936 valid CSA SRV record is found, or if the client is authorized, the condition
29937 succeeds. These three cases can be distinguished using the expansion variable
29938 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29939 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29940 be likely to cause problems for legitimate email.
29941
29942 The error messages produced by the CSA code include slightly more
29943 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29944 looking up the CSA SRV record, or problems looking up the CSA target
29945 address record. There are four reasons for &$csa_status$& being &"fail"&:
29946
29947 .ilist
29948 The client's host name is explicitly not authorized.
29949 .next
29950 The client's IP address does not match any of the CSA target IP addresses.
29951 .next
29952 The client's host name is authorized but it has no valid target IP addresses
29953 (for example, the target's addresses are IPv6 and the client is using IPv4).
29954 .next
29955 The client's host name has no CSA SRV record but a parent domain has asserted
29956 that all subdomains must be explicitly authorized.
29957 .endlist
29958
29959 The &%csa%& verification condition can take an argument which is the domain to
29960 use for the DNS query. The default is:
29961 .code
29962 verify = csa/$sender_helo_name
29963 .endd
29964 This implementation includes an extension to CSA. If the query domain
29965 is an address literal such as [192.0.2.95], or if it is a bare IP
29966 address, Exim searches for CSA SRV records in the reverse DNS as if
29967 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29968 meaningful to say:
29969 .code
29970 verify = csa/$sender_host_address
29971 .endd
29972 In fact, this is the check that Exim performs if the client does not say HELO.
29973 This extension can be turned off by setting the main configuration option
29974 &%dns_csa_use_reverse%& to be false.
29975
29976 If a CSA SRV record is not found for the domain itself, a search
29977 is performed through its parent domains for a record which might be
29978 making assertions about subdomains. The maximum depth of this search is limited
29979 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29980 default. Exim does not look for CSA SRV records in a top level domain, so the
29981 default settings handle HELO domains as long as seven
29982 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29983 of legitimate HELO domains.
29984
29985 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29986 direct SRV lookups, this is not sufficient because of the extra parent domain
29987 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29988 addresses into lookups in the reverse DNS space. The result of a successful
29989 lookup such as:
29990 .code
29991 ${lookup dnsdb {csa=$sender_helo_name}}
29992 .endd
29993 has two space-separated fields: an authorization code and a target host name.
29994 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29995 authorization required but absent, or &"?"& for unknown.
29996
29997
29998
29999
30000 .section "Bounce address tag validation" "SECTverifyPRVS"
30001 .cindex "BATV, verifying"
30002 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30003 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30004 Genuine incoming bounce messages should therefore always be addressed to
30005 recipients that have a valid tag. This scheme is a way of detecting unwanted
30006 bounce messages caused by sender address forgeries (often called &"collateral
30007 spam"&), because the recipients of such messages do not include valid tags.
30008
30009 There are two expansion items to help with the implementation of the BATV
30010 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30011 the original envelope sender address by using a simple key to add a hash of the
30012 address and some time-based randomizing information. The &%prvs%& expansion
30013 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30014 The syntax of these expansion items is described in section
30015 &<<SECTexpansionitems>>&.
30016
30017 As an example, suppose the secret per-address keys are stored in an MySQL
30018 database. A query to look up the key for an address could be defined as a macro
30019 like this:
30020 .code
30021 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30022                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30023                 }{$value}}
30024 .endd
30025 Suppose also that the senders who make use of BATV are defined by an address
30026 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30027 use this:
30028 .code
30029 # Bounces: drop unsigned addresses for BATV senders
30030 deny message = This address does not send an unsigned reverse path
30031      senders = :
30032      recipients = +batv_senders
30033
30034 # Bounces: In case of prvs-signed address, check signature.
30035 deny message = Invalid reverse path signature.
30036      senders = :
30037      condition  = ${prvscheck {$local_part@$domain}\
30038                   {PRVSCHECK_SQL}{1}}
30039      !condition = $prvscheck_result
30040 .endd
30041 The first statement rejects recipients for bounce messages that are addressed
30042 to plain BATV sender addresses, because it is known that BATV senders do not
30043 send out messages with plain sender addresses. The second statement rejects
30044 recipients that are prvs-signed, but with invalid signatures (either because
30045 the key is wrong, or the signature has timed out).
30046
30047 A non-prvs-signed address is not rejected by the second statement, because the
30048 &%prvscheck%& expansion yields an empty string if its first argument is not a
30049 prvs-signed address, thus causing the &%condition%& condition to be false. If
30050 the first argument is a syntactically valid prvs-signed address, the yield is
30051 the third string (in this case &"1"&), whether or not the cryptographic and
30052 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30053 of the checks (empty for failure, &"1"& for success).
30054
30055 There is one more issue you must consider when implementing prvs-signing:
30056 you have to ensure that the routers accept prvs-signed addresses and
30057 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30058 router to remove the signature with a configuration along these lines:
30059 .code
30060 batv_redirect:
30061   driver = redirect
30062   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30063 .endd
30064 This works because, if the third argument of &%prvscheck%& is empty, the result
30065 of the expansion of a prvs-signed address is the decoded value of the original
30066 address. This router should probably be the first of your routers that handles
30067 local addresses.
30068
30069 To create BATV-signed addresses in the first place, a transport of this form
30070 can be used:
30071 .code
30072 external_smtp_batv:
30073   driver = smtp
30074   return_path = ${prvs {$return_path} \
30075                        {${lookup mysql{SELECT \
30076                        secret FROM batv_prvs WHERE \
30077                        sender='${quote_mysql:$sender_address}'} \
30078                        {$value}fail}}}
30079 .endd
30080 If no key can be found for the existing return path, no signing takes place.
30081
30082
30083
30084 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30085 .cindex "&ACL;" "relay control"
30086 .cindex "relaying" "control by ACL"
30087 .cindex "policy control" "relay control"
30088 An MTA is said to &'relay'& a message if it receives it from some host and
30089 delivers it directly to another host as a result of a remote address contained
30090 within it. Redirecting a local address via an alias or forward file and then
30091 passing the message on to another host is not relaying,
30092 .cindex "&""percent hack""&"
30093 but a redirection as a result of the &"percent hack"& is.
30094
30095 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30096 A host which is acting as a gateway or an MX backup is concerned with incoming
30097 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30098 a host which is acting as a smart host for a number of clients is concerned
30099 with outgoing relaying from those clients to the Internet at large. Often the
30100 same host is fulfilling both functions,
30101 . ///
30102 . as illustrated in the diagram below,
30103 . ///
30104 but in principle these two kinds of relaying are entirely independent. What is
30105 not wanted is the transmission of mail from arbitrary remote hosts through your
30106 system to arbitrary domains.
30107
30108
30109 You can implement relay control by means of suitable statements in the ACL that
30110 runs for each RCPT command. For convenience, it is often easiest to use
30111 Exim's named list facility to define the domains and hosts involved. For
30112 example, suppose you want to do the following:
30113
30114 .ilist
30115 Deliver a number of domains to mailboxes on the local host (or process them
30116 locally in some other way). Let's say these are &'my.dom1.example'& and
30117 &'my.dom2.example'&.
30118 .next
30119 Relay mail for a number of other domains for which you are the secondary MX.
30120 These might be &'friend1.example'& and &'friend2.example'&.
30121 .next
30122 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30123 Suppose your LAN is 192.168.45.0/24.
30124 .endlist
30125
30126
30127 In the main part of the configuration, you put the following definitions:
30128 .code
30129 domainlist local_domains    = my.dom1.example : my.dom2.example
30130 domainlist relay_to_domains = friend1.example : friend2.example
30131 hostlist   relay_from_hosts = 192.168.45.0/24
30132 .endd
30133 Now you can use these definitions in the ACL that is run for every RCPT
30134 command:
30135 .code
30136 acl_check_rcpt:
30137   accept domains = +local_domains : +relay_to_domains
30138   accept hosts   = +relay_from_hosts
30139 .endd
30140 The first statement accepts any RCPT command that contains an address in
30141 the local or relay domains. For any other domain, control passes to the second
30142 statement, which accepts the command only if it comes from one of the relay
30143 hosts. In practice, you will probably want to make your ACL more sophisticated
30144 than this, for example, by including sender and recipient verification. The
30145 default configuration includes a more comprehensive example, which is described
30146 in chapter &<<CHAPdefconfil>>&.
30147
30148
30149
30150 .section "Checking a relay configuration" "SECTcheralcon"
30151 .cindex "relaying" "checking control of"
30152 You can check the relay characteristics of your configuration in the same way
30153 that you can test any ACL behaviour for an incoming SMTP connection, by using
30154 the &%-bh%& option to run a fake SMTP session with which you interact.
30155
30156 For specifically testing for unwanted relaying, the host
30157 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30158 host from the host on which Exim is running, using the normal telnet port, you
30159 will see a normal telnet connection message and then quite a long delay. Be
30160 patient. The remote host is making an SMTP connection back to your host, and
30161 trying a number of common probes to test for open relay vulnerability. The
30162 results of the tests will eventually appear on your terminal.
30163 .ecindex IIDacl
30164
30165
30166
30167 . ////////////////////////////////////////////////////////////////////////////
30168 . ////////////////////////////////////////////////////////////////////////////
30169
30170 .chapter "Content scanning at ACL time" "CHAPexiscan"
30171 .scindex IIDcosca "content scanning" "at ACL time"
30172 The extension of Exim to include content scanning at ACL time, formerly known
30173 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30174 was integrated into the main source for Exim release 4.50, and Tom continues to
30175 maintain it. Most of the wording of this chapter is taken from Tom's
30176 specification.
30177
30178 It is also possible to scan the content of messages at other times. The
30179 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30180 scanning after all the ACLs have run. A transport filter can be used to scan
30181 messages at delivery time (see the &%transport_filter%& option, described in
30182 chapter &<<CHAPtransportgeneric>>&).
30183
30184 If you want to include the ACL-time content-scanning features when you compile
30185 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30186 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30187
30188 .ilist
30189 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30190 for all MIME parts for SMTP and non-SMTP messages, respectively.
30191 .next
30192 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30193 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30194 run at the end of message reception (the &%acl_smtp_data%& ACL).
30195 .next
30196 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30197 of messages, or parts of messages, for debugging purposes.
30198 .next
30199 Additional expansion variables that are set in the new ACL and by the new
30200 conditions.
30201 .next
30202 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30203 .endlist
30204
30205 There is another content-scanning configuration option for &_Local/Makefile_&,
30206 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30207 condition is compiled, in addition to all the other content-scanning features.
30208
30209 Content-scanning is continually evolving, and new features are still being
30210 added. While such features are still unstable and liable to incompatible
30211 changes, they are made available in Exim by setting options whose names begin
30212 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30213 this manual. You can find out about them by reading the file called
30214 &_doc/experimental.txt_&.
30215
30216 All the content-scanning facilities work on a MBOX copy of the message that is
30217 temporarily created in a file called:
30218 .display
30219 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30220 .endd
30221 The &_.eml_& extension is a friendly hint to virus scanners that they can
30222 expect an MBOX-like structure inside that file. The file is created when the
30223 first content scanning facility is called. Subsequent calls to content
30224 scanning conditions open the same file again. The directory is recursively
30225 removed when the &%acl_smtp_data%& ACL has finished running, unless
30226 .code
30227 control = no_mbox_unspool
30228 .endd
30229 has been encountered. When the MIME ACL decodes files, they are put into the
30230 same directory by default.
30231
30232
30233
30234 .section "Scanning for viruses" "SECTscanvirus"
30235 .cindex "virus scanning"
30236 .cindex "content scanning" "for viruses"
30237 .cindex "content scanning" "the &%malware%& condition"
30238 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30239 It supports a &"generic"& interface to scanners called via the shell, and
30240 specialized interfaces for &"daemon"& type virus scanners, which are resident
30241 in memory and thus are much faster.
30242
30243
30244 .oindex "&%av_scanner%&"
30245 You can set the &%av_scanner%& option in first part of the Exim configuration
30246 file to specify which scanner to use, together with any additional options that
30247 are needed. The basic syntax is as follows:
30248 .display
30249 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30250 .endd
30251 If you do not set &%av_scanner%&, it defaults to
30252 .code
30253 av_scanner = sophie:/var/run/sophie
30254 .endd
30255 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30256 before use.
30257 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30258 The following scanner types are supported in this release:
30259
30260 .vlist
30261 .vitem &%aveserver%&
30262 .cindex "virus scanners" "Kaspersky"
30263 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30264 at &url(http://www.kaspersky.com). This scanner type takes one option,
30265 which is the path to the daemon's UNIX socket. The default is shown in this
30266 example:
30267 .code
30268 av_scanner = aveserver:/var/run/aveserver
30269 .endd
30270
30271
30272 .vitem &%clamd%&
30273 .cindex "virus scanners" "clamd"
30274 This daemon-type scanner is GPL and free. You can get it at
30275 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30276 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30277 in the MIME ACL. This no longer believed to be necessary. One option is
30278 required: either the path and name of a UNIX socket file, or a hostname or IP
30279 number, and a port, separated by space, as in the second of these examples:
30280 .code
30281 av_scanner = clamd:/opt/clamd/socket
30282 av_scanner = clamd:192.0.2.3 1234
30283 av_scanner = clamd:192.0.2.3 1234:local
30284 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30285 .endd
30286 If the value of av_scanner points to a UNIX socket file or contains the local
30287 keyword, then the ClamAV interface will pass a filename containing the data
30288 to be scanned, which will should normally result in less I/O happening and be
30289 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30290 Exim does not assume that there is a common filesystem with the remote host.
30291 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30292 you be running a version of ClamAV prior to 0.95.
30293
30294 The final example shows that multiple TCP targets can be specified.  Exim will
30295 randomly use one for each incoming email (i.e. it load balances them).  Note
30296 that only TCP targets may be used if specifying a list of scanners; a UNIX
30297 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30298 unavailable, Exim will try the remaining one(s) until it finds one that works.
30299 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30300 not keep track of scanner state between multiple messages, and the scanner
30301 selection is random, so the message will get logged in the mainlog for each
30302 email that the down scanner gets chosen first (message wrapped to be readable):
30303 .code
30304 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30305    clamd: connection to localhost, port 3310 failed
30306    (Connection refused)
30307 .endd
30308
30309 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30310 contributing the code for this scanner.
30311
30312 .vitem &%cmdline%&
30313 .cindex "virus scanners" "command line interface"
30314 This is the keyword for the generic command line scanner interface. It can be
30315 used to attach virus scanners that are invoked from the shell. This scanner
30316 type takes 3 mandatory options:
30317
30318 .olist
30319 The full path and name of the scanner binary, with all command line options,
30320 and a placeholder (&`%s`&) for the directory to scan.
30321
30322 .next
30323 A regular expression to match against the STDOUT and STDERR output of the
30324 virus scanner. If the expression matches, a virus was found. You must make
30325 absolutely sure that this expression matches on &"virus found"&. This is called
30326 the &"trigger"& expression.
30327
30328 .next
30329 Another regular expression, containing exactly one pair of parentheses, to
30330 match the name of the virus found in the scanners output. This is called the
30331 &"name"& expression.
30332 .endlist olist
30333
30334 For example, Sophos Sweep reports a virus on a line like this:
30335 .code
30336 Virus 'W32/Magistr-B' found in file ./those.bat
30337 .endd
30338 For the trigger expression, we can match the phrase &"found in file"&. For the
30339 name expression, we want to extract the W32/Magistr-B string, so we can match
30340 for the single quotes left and right of it. Altogether, this makes the
30341 configuration setting:
30342 .code
30343 av_scanner = cmdline:\
30344              /path/to/sweep -ss -all -rec -archive %s:\
30345              found in file:'(.+)'
30346 .endd
30347 .vitem &%drweb%&
30348 .cindex "virus scanners" "DrWeb"
30349 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
30350 argument, either a full path to a UNIX socket, or an IP address and port
30351 separated by white space, as in these examples:
30352 .code
30353 av_scanner = drweb:/var/run/drwebd.sock
30354 av_scanner = drweb:192.168.2.20 31337
30355 .endd
30356 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30357 is used. Thanks to Alex Miller for contributing the code for this scanner.
30358
30359 .vitem &%fsecure%&
30360 .cindex "virus scanners" "F-Secure"
30361 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30362 argument which is the path to a UNIX socket. For example:
30363 .code
30364 av_scanner = fsecure:/path/to/.fsav
30365 .endd
30366 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30367 Thelmen for contributing the code for this scanner.
30368
30369 .vitem &%kavdaemon%&
30370 .cindex "virus scanners" "Kaspersky"
30371 This is the scanner daemon of Kaspersky Version 4. This version of the
30372 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30373 scanner type takes one option, which is the path to the daemon's UNIX socket.
30374 For example:
30375 .code
30376 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30377 .endd
30378 The default path is &_/var/run/AvpCtl_&.
30379
30380 .vitem &%mksd%&
30381 .cindex "virus scanners" "mksd"
30382 This is a daemon type scanner that is aimed mainly at Polish users, though some
30383 parts of documentation are now available in English. You can get it at
30384 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30385 the maximum number of processes used simultaneously to scan the attachments,
30386 provided that the demime facility is employed and also provided that mksd has
30387 been run with at least the same number of child processes. For example:
30388 .code
30389 av_scanner = mksd:2
30390 .endd
30391 You can safely omit this option (the default value is 1).
30392
30393 .vitem &%sock%&
30394 .cindex "virus scanners" "simple socket-connected"
30395 This is a general-purpose way of talking to simple scanner daemons
30396 running on the local machine.
30397 There are four options:
30398 an address (which may be an IP addres and port, or the path of a Unix socket),
30399 a commandline to send (may include a single %s which will be replaced with
30400 the path to the mail file to be scanned),
30401 an RE to trigger on from the returned data,
30402 an RE to extract malware_name from the returned data.
30403 For example:
30404 .code
30405 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30406 .endd
30407 Default for the socket specifier is &_/tmp/malware.sock_&.
30408 Default for the commandline is &_%s\n_&.
30409 Both regular-expressions are required.
30410
30411 .vitem &%sophie%&
30412 .cindex "virus scanners" "Sophos and Sophie"
30413 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30414 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30415 for this scanner type is the path to the UNIX socket that Sophie uses for
30416 client communication. For example:
30417 .code
30418 av_scanner = sophie:/tmp/sophie
30419 .endd
30420 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30421 the option.
30422 .endlist
30423
30424 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30425 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30426 ACL.
30427
30428 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30429 makes it possible to use different scanners. See further below for an example.
30430 The &%malware%& condition caches its results, so when you use it multiple times
30431 for the same message, the actual scanning process is only carried out once.
30432 However, using expandable items in &%av_scanner%& disables this caching, in
30433 which case each use of the &%malware%& condition causes a new scan of the
30434 message.
30435
30436 The &%malware%& condition takes a right-hand argument that is expanded before
30437 use. It can then be one of
30438
30439 .ilist
30440 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30441 The condition succeeds if a virus was found, and fail otherwise. This is the
30442 recommended usage.
30443 .next
30444 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30445 the condition fails immediately.
30446 .next
30447 A regular expression, in which case the message is scanned for viruses. The
30448 condition succeeds if a virus is found and its name matches the regular
30449 expression. This allows you to take special actions on certain types of virus.
30450 .endlist
30451
30452 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
30453 even if there is a problem with the virus scanner. Otherwise, such a problem
30454 causes the ACL to defer.
30455
30456 .vindex "&$malware_name$&"
30457 When a virus is found, the condition sets up an expansion variable called
30458 &$malware_name$& that contains the name of the virus. You can use it in a
30459 &%message%& modifier that specifies the error returned to the sender, and/or in
30460 logging data.
30461
30462 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30463 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30464 &%malware%& condition.
30465
30466 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30467 imposed by your anti-virus scanner.
30468
30469 Here is a very simple scanning example:
30470 .code
30471 deny message = This message contains malware ($malware_name)
30472      demime = *
30473      malware = *
30474 .endd
30475 The next example accepts messages when there is a problem with the scanner:
30476 .code
30477 deny message = This message contains malware ($malware_name)
30478      demime = *
30479      malware = */defer_ok
30480 .endd
30481 The next example shows how to use an ACL variable to scan with both sophie and
30482 aveserver. It assumes you have set:
30483 .code
30484 av_scanner = $acl_m0
30485 .endd
30486 in the main Exim configuration.
30487 .code
30488 deny message = This message contains malware ($malware_name)
30489      set acl_m0 = sophie
30490      malware = *
30491
30492 deny message = This message contains malware ($malware_name)
30493      set acl_m0 = aveserver
30494      malware = *
30495 .endd
30496
30497
30498 .section "Scanning with SpamAssassin" "SECTscanspamass"
30499 .cindex "content scanning" "for spam"
30500 .cindex "spam scanning"
30501 .cindex "SpamAssassin"
30502 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30503 score and a report for the message. You can get SpamAssassin at
30504 &url(http://www.spamassassin.org), or, if you have a working Perl
30505 installation, you can use CPAN by running:
30506 .code
30507 perl -MCPAN -e 'install Mail::SpamAssassin'
30508 .endd
30509 SpamAssassin has its own set of configuration files. Please review its
30510 documentation to see how you can tweak it. The default installation should work
30511 nicely, however.
30512
30513 .oindex "&%spamd_address%&"
30514 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30515 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30516 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30517 part of the Exim configuration as follows (example):
30518 .code
30519 spamd_address = 192.168.99.45 387
30520 .endd
30521 You do not need to set this option if you use the default. As of version 2.60,
30522 &%spamd%& also supports communication over UNIX sockets. If you want to use
30523 these, supply &%spamd_address%& with an absolute file name instead of a
30524 address/port pair:
30525 .code
30526 spamd_address = /var/run/spamd_socket
30527 .endd
30528 You can have multiple &%spamd%& servers to improve scalability. These can
30529 reside on other hardware reachable over the network. To specify multiple
30530 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30531 option, separated with colons:
30532 .code
30533 spamd_address = 192.168.2.10 783 : \
30534                 192.168.2.11 783 : \
30535                 192.168.2.12 783
30536 .endd
30537 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30538 fashion. When a server fails to respond to the connection attempt, all other
30539 servers are tried until one succeeds. If no server responds, the &%spam%&
30540 condition defers.
30541
30542 &*Warning*&: It is not possible to use the UNIX socket connection method with
30543 multiple &%spamd%& servers.
30544
30545 The &%spamd_address%& variable is expanded before use if it starts with
30546 a dollar sign. In this case, the expansion may return a string that is
30547 used as the list so that multiple spamd servers can be the result of an
30548 expansion.
30549
30550 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30551 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30552 .code
30553 deny message = This message was classified as SPAM
30554      spam = joe
30555 .endd
30556 The right-hand side of the &%spam%& condition specifies a name. This is
30557 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30558 to scan using a specific profile, but rather use the SpamAssassin system-wide
30559 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30560 However, you must put something on the right-hand side.
30561
30562 The name allows you to use per-domain or per-user antispam profiles in
30563 principle, but this is not straightforward in practice, because a message may
30564 have multiple recipients, not necessarily all in the same domain. Because the
30565 &%spam%& condition has to be called from a DATA ACL in order to be able to
30566 read the contents of the message, the variables &$local_part$& and &$domain$&
30567 are not set.
30568
30569 The right-hand side of the &%spam%& condition is expanded before being used, so
30570 you can put lookups or conditions there. When the right-hand side evaluates to
30571 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30572
30573
30574 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30575 large ones may cause significant performance degradation. As most spam messages
30576 are quite small, it is recommended that you do not scan the big ones. For
30577 example:
30578 .code
30579 deny message = This message was classified as SPAM
30580      condition = ${if < {$message_size}{10K}}
30581      spam = nobody
30582 .endd
30583
30584 The &%spam%& condition returns true if the threshold specified in the user's
30585 SpamAssassin profile has been matched or exceeded. If you want to use the
30586 &%spam%& condition for its side effects (see the variables below), you can make
30587 it always return &"true"& by appending &`:true`& to the username.
30588
30589 .cindex "spam scanning" "returned variables"
30590 When the &%spam%& condition is run, it sets up a number of expansion
30591 variables. These variables are saved with the received message, thus they are
30592 available for use at delivery time.
30593
30594 .vlist
30595 .vitem &$spam_score$&
30596 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30597 for inclusion in log or reject messages.
30598
30599 .vitem &$spam_score_int$&
30600 The spam score of the message, multiplied by ten, as an integer value. For
30601 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30602 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30603 The integer value is useful for numeric comparisons in conditions.
30604
30605 .vitem &$spam_bar$&
30606 A string consisting of a number of &"+"& or &"-"& characters, representing the
30607 integer part of the spam score value. A spam score of 4.4 would have a
30608 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30609 headers, since MUAs can match on such strings.
30610
30611 .vitem &$spam_report$&
30612 A multiline text table, containing the full SpamAssassin report for the
30613 message. Useful for inclusion in headers or reject messages.
30614 .endlist
30615
30616 The &%spam%& condition caches its results unless expansion in
30617 spamd_address was used. If you call it again with the same user name, it
30618 does not scan again, but rather returns the same values as before.
30619
30620 The &%spam%& condition returns DEFER if there is any error while running
30621 the message through SpamAssassin or if the expansion of spamd_address
30622 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30623 statement block), append &`/defer_ok`& to the right-hand side of the
30624 spam condition, like this:
30625 .code
30626 deny message = This message was classified as SPAM
30627      spam    = joe/defer_ok
30628 .endd
30629 This causes messages to be accepted even if there is a problem with &%spamd%&.
30630
30631 Here is a longer, commented example of the use of the &%spam%&
30632 condition:
30633 .code
30634 # put headers in all messages (no matter if spam or not)
30635 warn  spam = nobody:true
30636       add_header = X-Spam-Score: $spam_score ($spam_bar)
30637       add_header = X-Spam-Report: $spam_report
30638
30639 # add second subject line with *SPAM* marker when message
30640 # is over threshold
30641 warn  spam = nobody
30642       add_header = Subject: *SPAM* $h_Subject:
30643
30644 # reject spam at high scores (> 12)
30645 deny  message = This message scored $spam_score spam points.
30646       spam = nobody:true
30647       condition = ${if >{$spam_score_int}{120}{1}{0}}
30648 .endd
30649
30650
30651
30652 .section "Scanning MIME parts" "SECTscanmimepart"
30653 .cindex "content scanning" "MIME parts"
30654 .cindex "MIME content scanning"
30655 .oindex "&%acl_smtp_mime%&"
30656 .oindex "&%acl_not_smtp_mime%&"
30657 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30658 each MIME part of an SMTP message, including multipart types, in the sequence
30659 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30660 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30661 options may both refer to the same ACL if you want the same processing in both
30662 cases.
30663
30664 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30665 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30666 the case of a non-SMTP message. However, a MIME ACL is called only if the
30667 message contains a &'Content-Type:'& header line. When a call to a MIME
30668 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30669 result code is sent to the client. In the case of an SMTP message, the
30670 &%acl_smtp_data%& ACL is not called when this happens.
30671
30672 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30673 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30674 condition to match against the raw MIME part. You can also use the
30675 &%mime_regex%& condition to match against the decoded MIME part (see section
30676 &<<SECTscanregex>>&).
30677
30678 At the start of a MIME ACL, a number of variables are set from the header
30679 information for the relevant MIME part. These are described below. The contents
30680 of the MIME part are not by default decoded into a disk file except for MIME
30681 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30682 part into a disk file, you can use the &%decode%& condition. The general
30683 syntax is:
30684 .display
30685 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30686 .endd
30687 The right hand side is expanded before use. After expansion,
30688 the value can be:
30689
30690 .olist
30691 &"0"& or &"false"&, in which case no decoding is done.
30692 .next
30693 The string &"default"&. In that case, the file is put in the temporary
30694 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30695 a sequential file name consisting of the message id and a sequence number. The
30696 full path and name is available in &$mime_decoded_filename$& after decoding.
30697 .next
30698 A full path name starting with a slash. If the full name is an existing
30699 directory, it is used as a replacement for the default directory. The filename
30700 is then sequentially assigned. If the path does not exist, it is used as
30701 the full path and file name.
30702 .next
30703 If the string does not start with a slash, it is used as the
30704 filename, and the default path is then used.
30705 .endlist
30706 The &%decode%& condition normally succeeds. It is only false for syntax
30707 errors or unusual circumstances such as memory shortages. You can easily decode
30708 a file with its original, proposed filename using
30709 .code
30710 decode = $mime_filename
30711 .endd
30712 However, you should keep in mind that &$mime_filename$& might contain
30713 anything. If you place files outside of the default path, they are not
30714 automatically unlinked.
30715
30716 For RFC822 attachments (these are messages attached to messages, with a
30717 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30718 as for the primary message, only that the &$mime_is_rfc822$& expansion
30719 variable is set (see below). Attached messages are always decoded to disk
30720 before being checked, and the files are unlinked once the check is done.
30721
30722 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30723 used to match regular expressions against raw and decoded MIME parts,
30724 respectively. They are described in section &<<SECTscanregex>>&.
30725
30726 .cindex "MIME content scanning" "returned variables"
30727 The following list describes all expansion variables that are
30728 available in the MIME ACL:
30729
30730 .vlist
30731 .vitem &$mime_boundary$&
30732 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30733 have a boundary string, which is stored in this variable. If the current part
30734 has no boundary parameter in the &'Content-Type:'& header, this variable
30735 contains the empty string.
30736
30737 .vitem &$mime_charset$&
30738 This variable contains the character set identifier, if one was found in the
30739 &'Content-Type:'& header. Examples for charset identifiers are:
30740 .code
30741 us-ascii
30742 gb2312 (Chinese)
30743 iso-8859-1
30744 .endd
30745 Please note that this value is not normalized, so you should do matches
30746 case-insensitively.
30747
30748 .vitem &$mime_content_description$&
30749 This variable contains the normalized content of the &'Content-Description:'&
30750 header. It can contain a human-readable description of the parts content. Some
30751 implementations repeat the filename for attachments here, but they are usually
30752 only used for display purposes.
30753
30754 .vitem &$mime_content_disposition$&
30755 This variable contains the normalized content of the &'Content-Disposition:'&
30756 header. You can expect strings like &"attachment"& or &"inline"& here.
30757
30758 .vitem &$mime_content_id$&
30759 This variable contains the normalized content of the &'Content-ID:'& header.
30760 This is a unique ID that can be used to reference a part from another part.
30761
30762 .vitem &$mime_content_size$&
30763 This variable is set only after the &%decode%& modifier (see above) has been
30764 successfully run. It contains the size of the decoded part in kilobytes. The
30765 size is always rounded up to full kilobytes, so only a completely empty part
30766 has a &$mime_content_size$& of zero.
30767
30768 .vitem &$mime_content_transfer_encoding$&
30769 This variable contains the normalized content of the
30770 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30771 type. Typical values are &"base64"& and &"quoted-printable"&.
30772
30773 .vitem &$mime_content_type$&
30774 If the MIME part has a &'Content-Type:'& header, this variable contains its
30775 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30776 are some examples of popular MIME types, as they may appear in this variable:
30777 .code
30778 text/plain
30779 text/html
30780 application/octet-stream
30781 image/jpeg
30782 audio/midi
30783 .endd
30784 If the MIME part has no &'Content-Type:'& header, this variable contains the
30785 empty string.
30786
30787 .vitem &$mime_decoded_filename$&
30788 This variable is set only after the &%decode%& modifier (see above) has been
30789 successfully run. It contains the full path and file name of the file
30790 containing the decoded data.
30791 .endlist
30792
30793 .cindex "RFC 2047"
30794 .vlist
30795 .vitem &$mime_filename$&
30796 This is perhaps the most important of the MIME variables. It contains a
30797 proposed filename for an attachment, if one was found in either the
30798 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30799 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30800 found, this variable contains the empty string.
30801
30802 .vitem &$mime_is_coverletter$&
30803 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30804 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30805 content in the cover letter, while not restricting attachments at all.
30806
30807 The variable contains 1 (true) for a MIME part believed to be part of the
30808 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30809 follows:
30810
30811 .olist
30812 The outermost MIME part of a message is always a cover letter.
30813
30814 .next
30815 If a multipart/alternative or multipart/related MIME part is a cover letter,
30816 so are all MIME subparts within that multipart.
30817
30818 .next
30819 If any other multipart is a cover letter, the first subpart is a cover letter,
30820 and the rest are attachments.
30821
30822 .next
30823 All parts contained within an attachment multipart are attachments.
30824 .endlist olist
30825
30826 As an example, the following will ban &"HTML mail"& (including that sent with
30827 alternative plain text), while allowing HTML files to be attached. HTML
30828 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30829 .code
30830 deny message = HTML mail is not accepted here
30831 !condition = $mime_is_rfc822
30832 condition = $mime_is_coverletter
30833 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30834 .endd
30835 .vitem &$mime_is_multipart$&
30836 This variable has the value 1 (true) when the current part has the main type
30837 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30838 Since multipart entities only serve as containers for other parts, you may not
30839 want to carry out specific actions on them.
30840
30841 .vitem &$mime_is_rfc822$&
30842 This variable has the value 1 (true) if the current part is not a part of the
30843 checked message itself, but part of an attached message. Attached message
30844 decoding is fully recursive.
30845
30846 .vitem &$mime_part_count$&
30847 This variable is a counter that is raised for each processed MIME part. It
30848 starts at zero for the very first part (which is usually a multipart). The
30849 counter is per-message, so it is reset when processing RFC822 attachments (see
30850 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30851 complete, so you can use it in the DATA ACL to determine the number of MIME
30852 parts of a message. For non-MIME messages, this variable contains the value -1.
30853 .endlist
30854
30855
30856
30857 .section "Scanning with regular expressions" "SECTscanregex"
30858 .cindex "content scanning" "with regular expressions"
30859 .cindex "regular expressions" "content scanning with"
30860 You can specify your own custom regular expression matches on the full body of
30861 the message, or on individual MIME parts.
30862
30863 The &%regex%& condition takes one or more regular expressions as arguments and
30864 matches them against the full message (when called in the DATA ACL) or a raw
30865 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30866 linewise, with a maximum line length of 32K characters. That means you cannot
30867 have multiline matches with the &%regex%& condition.
30868
30869 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30870 to 32K of decoded content (the whole content at once, not linewise). If the
30871 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30872 is decoded automatically when &%mime_regex%& is executed (using default path
30873 and filename values). If the decoded data is larger than  32K, only the first
30874 32K characters are checked.
30875
30876 The regular expressions are passed as a colon-separated list. To include a
30877 literal colon, you must double it. Since the whole right-hand side string is
30878 expanded before being used, you must also escape dollar signs and backslashes
30879 with more backslashes, or use the &`\N`& facility to disable expansion.
30880 Here is a simple example that contains two regular expressions:
30881 .code
30882 deny message = contains blacklisted regex ($regex_match_string)
30883      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30884 .endd
30885 The conditions returns true if any one of the regular expressions matches. The
30886 &$regex_match_string$& expansion variable is then set up and contains the
30887 matching regular expression.
30888
30889 &*Warning*&: With large messages, these conditions can be fairly
30890 CPU-intensive.
30891
30892
30893
30894
30895 .section "The demime condition" "SECTdemimecond"
30896 .cindex "content scanning" "MIME checking"
30897 .cindex "MIME content scanning"
30898 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30899 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30900 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30901 ACL functionality, but provides no additional facilities. Please note that this
30902 condition is deprecated and kept only for backward compatibility. You must set
30903 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30904 use the &%demime%& condition.
30905
30906 The &%demime%& condition unpacks MIME containers in the message. It detects
30907 errors in MIME containers and can match file extensions found in the message
30908 against a list. Using this facility produces files containing the unpacked MIME
30909 parts of the message in the temporary scan directory. If you do antivirus
30910 scanning, it is recommended that you use the &%demime%& condition before the
30911 antivirus (&%malware%&) condition.
30912
30913 On the right-hand side of the &%demime%& condition you can pass a
30914 colon-separated list of file extensions that it should match against. For
30915 example:
30916 .code
30917 deny message = Found blacklisted file attachment
30918      demime  = vbs:com:bat:pif:prf:lnk
30919 .endd
30920 If one of the file extensions is found, the condition is true, otherwise it is
30921 false. If there is a temporary error while demimeing (for example, &"disk
30922 full"&), the condition defers, and the message is temporarily rejected (unless
30923 the condition is on a &%warn%& verb).
30924
30925 The right-hand side is expanded before being treated as a list, so you can have
30926 conditions and lookups there. If it expands to an empty string, &"false"&, or
30927 zero (&"0"&), no demimeing is done and the condition is false.
30928
30929 The &%demime%& condition set the following variables:
30930
30931 .vlist
30932 .vitem &$demime_errorlevel$&
30933 .vindex "&$demime_errorlevel$&"
30934 When an error is detected in a MIME container, this variable contains the
30935 severity of the error, as an integer number. The higher the value, the more
30936 severe the error (the current maximum value is 3). If this variable is unset or
30937 zero, no error occurred.
30938
30939 .vitem &$demime_reason$&
30940 .vindex "&$demime_reason$&"
30941 When &$demime_errorlevel$& is greater than zero, this variable contains a
30942 human-readable text string describing the MIME error that occurred.
30943 .endlist
30944
30945 .vlist
30946 .vitem &$found_extension$&
30947 .vindex "&$found_extension$&"
30948 When the &%demime%& condition is true, this variable contains the file
30949 extension it found.
30950 .endlist
30951
30952 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30953 the &%demime%& condition, and are not changed on subsequent calls.
30954
30955 If you do not want to check for file extensions, but rather use the &%demime%&
30956 condition for unpacking or error checking purposes, pass &"*"& as the
30957 right-hand side value. Here is a more elaborate example of how to use this
30958 facility:
30959 .code
30960 # Reject messages with serious MIME container errors
30961 deny  message = Found MIME error ($demime_reason).
30962       demime = *
30963       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30964
30965 # Reject known virus spreading file extensions.
30966 # Accepting these is pretty much braindead.
30967 deny  message = contains $found_extension file (blacklisted).
30968       demime  = com:vbs:bat:pif:scr
30969
30970 # Freeze .exe and .doc files. Postmaster can
30971 # examine them and eventually thaw them.
30972 deny  log_message = Another $found_extension file.
30973       demime = exe:doc
30974       control = freeze
30975 .endd
30976 .ecindex IIDcosca
30977
30978
30979
30980
30981 . ////////////////////////////////////////////////////////////////////////////
30982 . ////////////////////////////////////////////////////////////////////////////
30983
30984 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30985          "Local scan function"
30986 .scindex IIDlosca "&[local_scan()]& function" "description of"
30987 .cindex "customizing" "input scan using C function"
30988 .cindex "policy control" "by local scan function"
30989 In these days of email worms, viruses, and ever-increasing spam, some sites
30990 want to apply a lot of checking to messages before accepting them.
30991
30992 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30993 passing messages to external virus and spam scanning software. You can also do
30994 a certain amount in Exim itself through string expansions and the &%condition%&
30995 condition in the ACL that runs after the SMTP DATA command or the ACL for
30996 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30997
30998 To allow for further customization to a site's own requirements, there is the
30999 possibility of linking Exim with a private message scanning function, written
31000 in C. If you want to run code that is written in something other than C, you
31001 can of course use a little C stub to call it.
31002
31003 The local scan function is run once for every incoming message, at the point
31004 when Exim is just about to accept the message.
31005 It can therefore be used to control non-SMTP messages from local processes as
31006 well as messages arriving via SMTP.
31007
31008 Exim applies a timeout to calls of the local scan function, and there is an
31009 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31010 Zero means &"no timeout"&.
31011 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31012 before calling the local scan function, so that the most common types of crash
31013 are caught. If the timeout is exceeded or one of those signals is caught, the
31014 incoming message is rejected with a temporary error if it is an SMTP message.
31015 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31016 code. The incident is logged on the main and reject logs.
31017
31018
31019
31020 .section "Building Exim to use a local scan function" "SECID207"
31021 .cindex "&[local_scan()]& function" "building Exim to use"
31022 To make use of the local scan function feature, you must tell Exim where your
31023 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31024 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31025 directory, so you might set
31026 .code
31027 LOCAL_SCAN_SOURCE=Local/local_scan.c
31028 .endd
31029 for example. The function must be called &[local_scan()]&. It is called by
31030 Exim after it has received a message, when the success return code is about to
31031 be sent. This is after all the ACLs have been run. The return code from your
31032 function controls whether the message is actually accepted or not. There is a
31033 commented template function (that just accepts the message) in the file
31034 _src/local_scan.c_.
31035
31036 If you want to make use of Exim's run time configuration file to set options
31037 for your &[local_scan()]& function, you must also set
31038 .code
31039 LOCAL_SCAN_HAS_OPTIONS=yes
31040 .endd
31041 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31042
31043
31044
31045
31046 .section "API for local_scan()" "SECTapiforloc"
31047 .cindex "&[local_scan()]& function" "API description"
31048 You must include this line near the start of your code:
31049 .code
31050 #include "local_scan.h"
31051 .endd
31052 This header file defines a number of variables and other values, and the
31053 prototype for the function itself. Exim is coded to use unsigned char values
31054 almost exclusively, and one of the things this header defines is a shorthand
31055 for &`unsigned char`& called &`uschar`&.
31056 It also contains the following macro definitions, to simplify casting character
31057 strings and pointers to character strings:
31058 .code
31059 #define CS   (char *)
31060 #define CCS  (const char *)
31061 #define CSS  (char **)
31062 #define US   (unsigned char *)
31063 #define CUS  (const unsigned char *)
31064 #define USS  (unsigned char **)
31065 .endd
31066 The function prototype for &[local_scan()]& is:
31067 .code
31068 extern int local_scan(int fd, uschar **return_text);
31069 .endd
31070 The arguments are as follows:
31071
31072 .ilist
31073 &%fd%& is a file descriptor for the file that contains the body of the message
31074 (the -D file). The file is open for reading and writing, but updating it is not
31075 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31076
31077 The descriptor is positioned at character 19 of the file, which is the first
31078 character of the body itself, because the first 19 characters are the message
31079 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31080 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31081 case this changes in some future version.
31082 .next
31083 &%return_text%& is an address which you can use to return a pointer to a text
31084 string at the end of the function. The value it points to on entry is NULL.
31085 .endlist
31086
31087 The function must return an &%int%& value which is one of the following macros:
31088
31089 .vlist
31090 .vitem &`LOCAL_SCAN_ACCEPT`&
31091 .vindex "&$local_scan_data$&"
31092 The message is accepted. If you pass back a string of text, it is saved with
31093 the message, and made available in the variable &$local_scan_data$&. No
31094 newlines are permitted (if there are any, they are turned into spaces) and the
31095 maximum length of text is 1000 characters.
31096
31097 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31098 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31099 queued without immediate delivery, and is frozen.
31100
31101 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31102 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31103 queued without immediate delivery.
31104
31105 .vitem &`LOCAL_SCAN_REJECT`&
31106 The message is rejected; the returned text is used as an error message which is
31107 passed back to the sender and which is also logged. Newlines are permitted &--
31108 they cause a multiline response for SMTP rejections, but are converted to
31109 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31110 used.
31111
31112 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31113 The message is temporarily rejected; the returned text is used as an error
31114 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31115 problem"& is used.
31116
31117 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31118 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31119 message is not written to the reject log. It has the effect of unsetting the
31120 &%rejected_header%& log selector for just this rejection. If
31121 &%rejected_header%& is already unset (see the discussion of the
31122 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31123 same as LOCAL_SCAN_REJECT.
31124
31125 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31126 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31127 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31128 .endlist
31129
31130 If the message is not being received by interactive SMTP, rejections are
31131 reported by writing to &%stderr%& or by sending an email, as configured by the
31132 &%-oe%& command line options.
31133
31134
31135
31136 .section "Configuration options for local_scan()" "SECTconoptloc"
31137 .cindex "&[local_scan()]& function" "configuration options"
31138 It is possible to have option settings in the main configuration file
31139 that set values in static variables in the &[local_scan()]& module. If you
31140 want to do this, you must have the line
31141 .code
31142 LOCAL_SCAN_HAS_OPTIONS=yes
31143 .endd
31144 in your &_Local/Makefile_& when you build Exim. (This line is in
31145 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31146 file, you must define static variables to hold the option values, and a table
31147 to define them.
31148
31149 The table must be a vector called &%local_scan_options%&, of type
31150 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31151 and a pointer to the variable that holds the value. The entries must appear in
31152 alphabetical order. Following &%local_scan_options%& you must also define a
31153 variable called &%local_scan_options_count%& that contains the number of
31154 entries in the table. Here is a short example, showing two kinds of option:
31155 .code
31156 static int my_integer_option = 42;
31157 static uschar *my_string_option = US"a default string";
31158
31159 optionlist local_scan_options[] = {
31160   { "my_integer", opt_int,       &my_integer_option },
31161   { "my_string",  opt_stringptr, &my_string_option }
31162 };
31163
31164 int local_scan_options_count =
31165   sizeof(local_scan_options)/sizeof(optionlist);
31166 .endd
31167 The values of the variables can now be changed from Exim's runtime
31168 configuration file by including a local scan section as in this example:
31169 .code
31170 begin local_scan
31171 my_integer = 99
31172 my_string = some string of text...
31173 .endd
31174 The available types of option data are as follows:
31175
31176 .vlist
31177 .vitem &*opt_bool*&
31178 This specifies a boolean (true/false) option. The address should point to a
31179 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31180 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31181 whether such a variable has been set at all, you can initialize it to
31182 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31183 values.)
31184
31185 .vitem &*opt_fixed*&
31186 This specifies a fixed point number, such as is used for load averages.
31187 The address should point to a variable of type &`int`&. The value is stored
31188 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31189
31190 .vitem &*opt_int*&
31191 This specifies an integer; the address should point to a variable of type
31192 &`int`&. The value may be specified in any of the integer formats accepted by
31193 Exim.
31194
31195 .vitem &*opt_mkint*&
31196 This is the same as &%opt_int%&, except that when such a value is output in a
31197 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31198 printed with the suffix K or M.
31199
31200 .vitem &*opt_octint*&
31201 This also specifies an integer, but the value is always interpreted as an
31202 octal integer, whether or not it starts with the digit zero, and it is
31203 always output in octal.
31204
31205 .vitem &*opt_stringptr*&
31206 This specifies a string value; the address must be a pointer to a
31207 variable that points to a string (for example, of type &`uschar *`&).
31208
31209 .vitem &*opt_time*&
31210 This specifies a time interval value. The address must point to a variable of
31211 type &`int`&. The value that is placed there is a number of seconds.
31212 .endlist
31213
31214 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31215 out the values of all the &[local_scan()]& options.
31216
31217
31218
31219 .section "Available Exim variables" "SECID208"
31220 .cindex "&[local_scan()]& function" "available Exim variables"
31221 The header &_local_scan.h_& gives you access to a number of C variables. These
31222 are the only ones that are guaranteed to be maintained from release to release.
31223 Note, however, that you can obtain the value of any Exim expansion variable,
31224 including &$recipients$&, by calling &'expand_string()'&. The exported
31225 C variables are as follows:
31226
31227 .vlist
31228 .vitem &*int&~body_linecount*&
31229 This variable contains the number of lines in the message's body.
31230
31231 .vitem &*int&~body_zerocount*&
31232 This variable contains the number of binary zero bytes in the message's body.
31233
31234 .vitem &*unsigned&~int&~debug_selector*&
31235 This variable is set to zero when no debugging is taking place. Otherwise, it
31236 is a bitmap of debugging selectors. Two bits are identified for use in
31237 &[local_scan()]&; they are defined as macros:
31238
31239 .ilist
31240 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31241 testing option that is not privileged &-- any caller may set it. All the
31242 other selector bits can be set only by admin users.
31243
31244 .next
31245 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31246 by the &`+local_scan`& debug selector. It is not included in the default set
31247 of debugging bits.
31248 .endlist ilist
31249
31250 Thus, to write to the debugging output only when &`+local_scan`& has been
31251 selected, you should use code like this:
31252 .code
31253 if ((debug_selector & D_local_scan) != 0)
31254   debug_printf("xxx", ...);
31255 .endd
31256 .vitem &*uschar&~*expand_string_message*&
31257 After a failing call to &'expand_string()'& (returned value NULL), the
31258 variable &%expand_string_message%& contains the error message, zero-terminated.
31259
31260 .vitem &*header_line&~*header_list*&
31261 A pointer to a chain of header lines. The &%header_line%& structure is
31262 discussed below.
31263
31264 .vitem &*header_line&~*header_last*&
31265 A pointer to the last of the header lines.
31266
31267 .vitem &*uschar&~*headers_charset*&
31268 The value of the &%headers_charset%& configuration option.
31269
31270 .vitem &*BOOL&~host_checking*&
31271 This variable is TRUE during a host checking session that is initiated by the
31272 &%-bh%& command line option.
31273
31274 .vitem &*uschar&~*interface_address*&
31275 The IP address of the interface that received the message, as a string. This
31276 is NULL for locally submitted messages.
31277
31278 .vitem &*int&~interface_port*&
31279 The port on which this message was received. When testing with the &%-bh%&
31280 command line option, the value of this variable is -1 unless a port has been
31281 specified via the &%-oMi%& option.
31282
31283 .vitem &*uschar&~*message_id*&
31284 This variable contains Exim's message id for the incoming message (the value of
31285 &$message_exim_id$&) as a zero-terminated string.
31286
31287 .vitem &*uschar&~*received_protocol*&
31288 The name of the protocol by which the message was received.
31289
31290 .vitem &*int&~recipients_count*&
31291 The number of accepted recipients.
31292
31293 .vitem &*recipient_item&~*recipients_list*&
31294 .cindex "recipient" "adding in local scan"
31295 .cindex "recipient" "removing in local scan"
31296 The list of accepted recipients, held in a vector of length
31297 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31298 can add additional recipients by calling &'receive_add_recipient()'& (see
31299 below). You can delete recipients by removing them from the vector and
31300 adjusting the value in &%recipients_count%&. In particular, by setting
31301 &%recipients_count%& to zero you remove all recipients. If you then return the
31302 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31303 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31304 and then call &'receive_add_recipient()'& as often as needed.
31305
31306 .vitem &*uschar&~*sender_address*&
31307 The envelope sender address. For bounce messages this is the empty string.
31308
31309 .vitem &*uschar&~*sender_host_address*&
31310 The IP address of the sending host, as a string. This is NULL for
31311 locally-submitted messages.
31312
31313 .vitem &*uschar&~*sender_host_authenticated*&
31314 The name of the authentication mechanism that was used, or NULL if the message
31315 was not received over an authenticated SMTP connection.
31316
31317 .vitem &*uschar&~*sender_host_name*&
31318 The name of the sending host, if known.
31319
31320 .vitem &*int&~sender_host_port*&
31321 The port on the sending host.
31322
31323 .vitem &*BOOL&~smtp_input*&
31324 This variable is TRUE for all SMTP input, including BSMTP.
31325
31326 .vitem &*BOOL&~smtp_batched_input*&
31327 This variable is TRUE for BSMTP input.
31328
31329 .vitem &*int&~store_pool*&
31330 The contents of this variable control which pool of memory is used for new
31331 requests. See section &<<SECTmemhanloc>>& for details.
31332 .endlist
31333
31334
31335 .section "Structure of header lines" "SECID209"
31336 The &%header_line%& structure contains the members listed below.
31337 You can add additional header lines by calling the &'header_add()'& function
31338 (see below). You can cause header lines to be ignored (deleted) by setting
31339 their type to *.
31340
31341
31342 .vlist
31343 .vitem &*struct&~header_line&~*next*&
31344 A pointer to the next header line, or NULL for the last line.
31345
31346 .vitem &*int&~type*&
31347 A code identifying certain headers that Exim recognizes. The codes are printing
31348 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31349 Notice in particular that any header line whose type is * is not transmitted
31350 with the message. This flagging is used for header lines that have been
31351 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31352 lines.) Effectively, * means &"deleted"&.
31353
31354 .vitem &*int&~slen*&
31355 The number of characters in the header line, including the terminating and any
31356 internal newlines.
31357
31358 .vitem &*uschar&~*text*&
31359 A pointer to the text of the header. It always ends with a newline, followed by
31360 a zero byte. Internal newlines are preserved.
31361 .endlist
31362
31363
31364
31365 .section "Structure of recipient items" "SECID210"
31366 The &%recipient_item%& structure contains these members:
31367
31368 .vlist
31369 .vitem &*uschar&~*address*&
31370 This is a pointer to the recipient address as it was received.
31371
31372 .vitem &*int&~pno*&
31373 This is used in later Exim processing when top level addresses are created by
31374 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31375 and must always contain -1 at this stage.
31376
31377 .vitem &*uschar&~*errors_to*&
31378 If this value is not NULL, bounce messages caused by failing to deliver to the
31379 recipient are sent to the address it contains. In other words, it overrides the
31380 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31381 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31382 an unqualified address, Exim qualifies it using the domain from
31383 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31384 is NULL for all recipients.
31385 .endlist
31386
31387
31388
31389 .section "Available Exim functions" "SECID211"
31390 .cindex "&[local_scan()]& function" "available Exim functions"
31391 The header &_local_scan.h_& gives you access to a number of Exim functions.
31392 These are the only ones that are guaranteed to be maintained from release to
31393 release:
31394
31395 .vlist
31396 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31397        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31398
31399 This function creates a child process that runs the command specified by
31400 &%argv%&. The environment for the process is specified by &%envp%&, which can
31401 be NULL if no environment variables are to be passed. A new umask is supplied
31402 for the process in &%newumask%&.
31403
31404 Pipes to the standard input and output of the new process are set up
31405 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31406 standard error is cloned to the standard output. If there are any file
31407 descriptors &"in the way"& in the new process, they are closed. If the final
31408 argument is TRUE, the new process is made into a process group leader.
31409
31410 The function returns the pid of the new process, or -1 if things go wrong.
31411
31412 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31413 This function waits for a child process to terminate, or for a timeout (in
31414 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31415 return value is as follows:
31416
31417 .ilist
31418 >= 0
31419
31420 The process terminated by a normal exit and the value is the process
31421 ending status.
31422
31423 .next
31424 < 0 and > &--256
31425
31426 The process was terminated by a signal and the value is the negation of the
31427 signal number.
31428
31429 .next
31430 &--256
31431
31432 The process timed out.
31433 .next
31434 &--257
31435
31436 The was some other error in wait(); &%errno%& is still set.
31437 .endlist
31438
31439 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31440 This function provide you with a means of submitting a new message to
31441 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31442 want, but this packages it all up for you.) The function creates a pipe,
31443 forks a subprocess that is running
31444 .code
31445 exim -t -oem -oi -f <>
31446 .endd
31447 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31448 that is connected to the standard input. The yield of the function is the PID
31449 of the subprocess. You can then write a message to the file descriptor, with
31450 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31451
31452 When you have finished, call &'child_close()'& to wait for the process to
31453 finish and to collect its ending status. A timeout value of zero is usually
31454 fine in this circumstance. Unless you have made a mistake with the recipient
31455 addresses, you should get a return code of zero.
31456
31457
31458 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31459        *sender_authentication)*&
31460 This function is a more sophisticated version of &'child_open()'&. The command
31461 that it runs is:
31462 .display
31463 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31464 .endd
31465 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31466
31467
31468 .vitem &*void&~debug_printf(char&~*,&~...)*&
31469 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31470 output is written to the standard error stream. If no debugging is selected,
31471 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31472 conditional on the &`local_scan`& debug selector by coding like this:
31473 .code
31474 if ((debug_selector & D_local_scan) != 0)
31475   debug_printf("xxx", ...);
31476 .endd
31477
31478 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31479 This is an interface to Exim's string expansion code. The return value is the
31480 expanded string, or NULL if there was an expansion failure.
31481 The C variable &%expand_string_message%& contains an error message after an
31482 expansion failure. If expansion does not change the string, the return value is
31483 the pointer to the input string. Otherwise, the return value points to a new
31484 block of memory that was obtained by a call to &'store_get()'&. See section
31485 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31486
31487 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31488 This function allows you to an add additional header line at the end of the
31489 existing ones. The first argument is the type, and should normally be a space
31490 character. The second argument is a format string and any number of
31491 substitution arguments as for &[sprintf()]&. You may include internal newlines
31492 if you want, and you must ensure that the string ends with a newline.
31493
31494 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31495         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31496 This function adds a new header line at a specified point in the header
31497 chain. The header itself is specified as for &'header_add()'&.
31498
31499 If &%name%& is NULL, the new header is added at the end of the chain if
31500 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31501 NULL, the header lines are searched for the first non-deleted header that
31502 matches the name. If one is found, the new header is added before it if
31503 &%after%& is false. If &%after%& is true, the new header is added after the
31504 found header and any adjacent subsequent ones with the same name (even if
31505 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31506 option controls where the header is added. If it is true, addition is at the
31507 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31508 headers, or at the top if there are no &'Received:'& headers, you could use
31509 .code
31510 header_add_at_position(TRUE, US"Received", TRUE,
31511   ' ', "X-xxx: ...");
31512 .endd
31513 Normally, there is always at least one non-deleted &'Received:'& header, but
31514 there may not be if &%received_header_text%& expands to an empty string.
31515
31516
31517 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31518 This function removes header lines. If &%occurrence%& is zero or negative, all
31519 occurrences of the header are removed. If occurrence is greater than zero, that
31520 particular instance of the header is removed. If no header(s) can be found that
31521 match the specification, the function does nothing.
31522
31523
31524 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31525         int&~length,&~BOOL&~notdel)*&"
31526 This function tests whether the given header has the given name. It is not just
31527 a string comparison, because white space is permitted between the name and the
31528 colon. If the &%notdel%& argument is true, a false return is forced for all
31529 &"deleted"& headers; otherwise they are not treated specially. For example:
31530 .code
31531 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31532 .endd
31533 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31534 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31535 This function base64-encodes a string, which is passed by address and length.
31536 The text may contain bytes of any value, including zero. The result is passed
31537 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31538 zero-terminated.
31539
31540 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31541 This function decodes a base64-encoded string. Its arguments are a
31542 zero-terminated base64-encoded string and the address of a variable that is set
31543 to point to the result, which is in dynamic memory. The length of the decoded
31544 string is the yield of the function. If the input is invalid base64 data, the
31545 yield is -1. A zero byte is added to the end of the output string to make it
31546 easy to interpret as a C string (assuming it contains no zeros of its own). The
31547 added zero byte is not included in the returned count.
31548
31549 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31550 This function checks for a match in a domain list. Domains are always
31551 matched caselessly. The return value is one of the following:
31552 .display
31553 &`OK     `& match succeeded
31554 &`FAIL   `& match failed
31555 &`DEFER  `& match deferred
31556 .endd
31557 DEFER is usually caused by some kind of lookup defer, such as the
31558 inability to contact a database.
31559
31560 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31561         BOOL&~caseless)*&"
31562 This function checks for a match in a local part list. The third argument
31563 controls case-sensitivity. The return values are as for
31564 &'lss_match_domain()'&.
31565
31566 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31567         BOOL&~caseless)*&"
31568 This function checks for a match in an address list. The third argument
31569 controls the case-sensitivity of the local part match. The domain is always
31570 matched caselessly. The return values are as for &'lss_match_domain()'&.
31571
31572 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31573         uschar&~*list)*&"
31574 This function checks for a match in a host list. The most common usage is
31575 expected to be
31576 .code
31577 lss_match_host(sender_host_name, sender_host_address, ...)
31578 .endd
31579 .vindex "&$sender_host_address$&"
31580 An empty address field matches an empty item in the host list. If the host name
31581 is NULL, the name corresponding to &$sender_host_address$& is automatically
31582 looked up if a host name is required to match an item in the list. The return
31583 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31584 returns ERROR in the case when it had to look up a host name, but the lookup
31585 failed.
31586
31587 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31588         *format,&~...)*&"
31589 This function writes to Exim's log files. The first argument should be zero (it
31590 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31591 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31592 them. It specifies to which log or logs the message is written. The remaining
31593 arguments are a format and relevant insertion arguments. The string should not
31594 contain any newlines, not even at the end.
31595
31596
31597 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31598 This function adds an additional recipient to the message. The first argument
31599 is the recipient address. If it is unqualified (has no domain), it is qualified
31600 with the &%qualify_recipient%& domain. The second argument must always be -1.
31601
31602 This function does not allow you to specify a private &%errors_to%& address (as
31603 described with the structure of &%recipient_item%& above), because it pre-dates
31604 the addition of that field to the structure. However, it is easy to add such a
31605 value afterwards. For example:
31606 .code
31607  receive_add_recipient(US"monitor@mydom.example", -1);
31608  recipients_list[recipients_count-1].errors_to =
31609    US"postmaster@mydom.example";
31610 .endd
31611
31612 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31613 This is a convenience function to remove a named recipient from the list of
31614 recipients. It returns true if a recipient was removed, and false if no
31615 matching recipient could be found. The argument must be a complete email
31616 address.
31617 .endlist
31618
31619
31620 .cindex "RFC 2047"
31621 .vlist
31622 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31623   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31624 This function decodes strings that are encoded according to RFC 2047. Typically
31625 these are the contents of header lines. First, each &"encoded word"& is decoded
31626 from the Q or B encoding into a byte-string. Then, if provided with the name of
31627 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31628 made  to translate the result to the named character set. If this fails, the
31629 binary string is returned with an error message.
31630
31631 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31632 maximum MIME word length is enforced. The third argument is the target
31633 encoding, or NULL if no translation is wanted.
31634
31635 .cindex "binary zero" "in RFC 2047 decoding"
31636 .cindex "RFC 2047" "binary zero in"
31637 If a binary zero is encountered in the decoded string, it is replaced by the
31638 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31639 not be 0 because header lines are handled as zero-terminated strings.
31640
31641 The function returns the result of processing the string, zero-terminated; if
31642 &%lenptr%& is not NULL, the length of the result is set in the variable to
31643 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31644
31645 If an error is encountered, the function returns NULL and uses the &%error%&
31646 argument to return an error message. The variable pointed to by &%error%& is
31647 set to NULL if there is no error; it may be set non-NULL even when the function
31648 returns a non-NULL value if decoding was successful, but there was a problem
31649 with translation.
31650
31651
31652 .vitem &*int&~smtp_fflush(void)*&
31653 This function is used in conjunction with &'smtp_printf()'&, as described
31654 below.
31655
31656 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31657 The arguments of this function are like &[printf()]&; it writes to the SMTP
31658 output stream. You should use this function only when there is an SMTP output
31659 stream, that is, when the incoming message is being received via interactive
31660 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31661 is FALSE. If you want to test for an incoming message from another host (as
31662 opposed to a local process that used the &%-bs%& command line option), you can
31663 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31664 is involved.
31665
31666 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31667 output function, so it can be used for all forms of SMTP connection.
31668
31669 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31670 must start with an appropriate response code: 550 if you are going to return
31671 LOCAL_SCAN_REJECT, 451 if you are going to return
31672 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31673 initial lines of a multi-line response, the code must be followed by a hyphen
31674 to indicate that the line is not the final response line. You must also ensure
31675 that the lines you write terminate with CRLF. For example:
31676 .code
31677 smtp_printf("550-this is some extra info\r\n");
31678 return LOCAL_SCAN_REJECT;
31679 .endd
31680 Note that you can also create multi-line responses by including newlines in
31681 the data returned via the &%return_text%& argument. The added value of using
31682 &'smtp_printf()'& is that, for instance, you could introduce delays between
31683 multiple output lines.
31684
31685 The &'smtp_printf()'& function does not return any error indication, because it
31686 does not automatically flush pending output, and therefore does not test
31687 the state of the stream. (In the main code of Exim, flushing and error
31688 detection is done when Exim is ready for the next SMTP input command.) If
31689 you want to flush the output and check for an error (for example, the
31690 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31691 arguments. It flushes the output stream, and returns a non-zero value if there
31692 is an error.
31693
31694 .vitem &*void&~*store_get(int)*&
31695 This function accesses Exim's internal store (memory) manager. It gets a new
31696 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31697 runs out of memory. See the next section for a discussion of memory handling.
31698
31699 .vitem &*void&~*store_get_perm(int)*&
31700 This function is like &'store_get()'&, but it always gets memory from the
31701 permanent pool. See the next section for a discussion of memory handling.
31702
31703 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31704 See below.
31705
31706 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31707 See below.
31708
31709 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31710 These three functions create strings using Exim's dynamic memory facilities.
31711 The first makes a copy of an entire string. The second copies up to a maximum
31712 number of characters, indicated by the second argument. The third uses a format
31713 and insertion arguments to create a new string. In each case, the result is a
31714 pointer to a new string in the current memory pool. See the next section for
31715 more discussion.
31716 .endlist
31717
31718
31719
31720 .section "More about Exim's memory handling" "SECTmemhanloc"
31721 .cindex "&[local_scan()]& function" "memory handling"
31722 No function is provided for freeing memory, because that is never needed.
31723 The dynamic memory that Exim uses when receiving a message is automatically
31724 recycled if another message is received by the same process (this applies only
31725 to incoming SMTP connections &-- other input methods can supply only one
31726 message at a time). After receiving the last message, a reception process
31727 terminates.
31728
31729 Because it is recycled, the normal dynamic memory cannot be used for holding
31730 data that must be preserved over a number of incoming messages on the same SMTP
31731 connection. However, Exim in fact uses two pools of dynamic memory; the second
31732 one is not recycled, and can be used for this purpose.
31733
31734 If you want to allocate memory that remains available for subsequent messages
31735 in the same SMTP connection, you should set
31736 .code
31737 store_pool = POOL_PERM
31738 .endd
31739 before calling the function that does the allocation. There is no need to
31740 restore the value if you do not need to; however, if you do want to revert to
31741 the normal pool, you can either restore the previous value of &%store_pool%& or
31742 set it explicitly to POOL_MAIN.
31743
31744 The pool setting applies to all functions that get dynamic memory, including
31745 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31746 There is also a convenience function called &'store_get_perm()'& that gets a
31747 block of memory from the permanent pool while preserving the value of
31748 &%store_pool%&.
31749 .ecindex IIDlosca
31750
31751
31752
31753
31754 . ////////////////////////////////////////////////////////////////////////////
31755 . ////////////////////////////////////////////////////////////////////////////
31756
31757 .chapter "System-wide message filtering" "CHAPsystemfilter"
31758 .scindex IIDsysfil1 "filter" "system filter"
31759 .scindex IIDsysfil2 "filtering all mail"
31760 .scindex IIDsysfil3 "system filter"
31761 The previous chapters (on ACLs and the local scan function) describe checks
31762 that can be applied to messages before they are accepted by a host. There is
31763 also a mechanism for checking messages once they have been received, but before
31764 they are delivered. This is called the &'system filter'&.
31765
31766 The system filter operates in a similar manner to users' filter files, but it
31767 is run just once per message (however many recipients the message has).
31768 It should not normally be used as a substitute for routing, because &%deliver%&
31769 commands in a system router provide new envelope recipient addresses.
31770 The system filter must be an Exim filter. It cannot be a Sieve filter.
31771
31772 The system filter is run at the start of a delivery attempt, before any routing
31773 is done. If a message fails to be completely delivered at the first attempt,
31774 the system filter is run again at the start of every retry.
31775 If you want your filter to do something only once per message, you can make use
31776 of the &%first_delivery%& condition in an &%if%& command in the filter to
31777 prevent it happening on retries.
31778
31779 .vindex "&$domain$&"
31780 .vindex "&$local_part$&"
31781 &*Warning*&: Because the system filter runs just once, variables that are
31782 specific to individual recipient addresses, such as &$local_part$& and
31783 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31784 you want to run a centrally-specified filter for each recipient address
31785 independently, you can do so by setting up a suitable &(redirect)& router, as
31786 described in section &<<SECTperaddfil>>& below.
31787
31788
31789 .section "Specifying a system filter" "SECID212"
31790 .cindex "uid (user id)" "system filter"
31791 .cindex "gid (group id)" "system filter"
31792 The name of the file that contains the system filter must be specified by
31793 setting &%system_filter%&. If you want the filter to run under a uid and gid
31794 other than root, you must also set &%system_filter_user%& and
31795 &%system_filter_group%& as appropriate. For example:
31796 .code
31797 system_filter = /etc/mail/exim.filter
31798 system_filter_user = exim
31799 .endd
31800 If a system filter generates any deliveries directly to files or pipes (via the
31801 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31802 specified by setting &%system_filter_file_transport%& and
31803 &%system_filter_pipe_transport%&, respectively. Similarly,
31804 &%system_filter_reply_transport%& must be set to handle any messages generated
31805 by the &%reply%& command.
31806
31807
31808 .section "Testing a system filter" "SECID213"
31809 You can run simple tests of a system filter in the same way as for a user
31810 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31811 are permitted only in system filters are recognized.
31812
31813 If you want to test the combined effect of a system filter and a user filter,
31814 you can use both &%-bF%& and &%-bf%& on the same command line.
31815
31816
31817
31818 .section "Contents of a system filter" "SECID214"
31819 The language used to specify system filters is the same as for users' filter
31820 files. It is described in the separate end-user document &'Exim's interface to
31821 mail filtering'&. However, there are some additional features that are
31822 available only in system filters; these are described in subsequent sections.
31823 If they are encountered in a user's filter file or when testing with &%-bf%&,
31824 they cause errors.
31825
31826 .cindex "frozen messages" "manual thaw; testing in filter"
31827 There are two special conditions which, though available in users' filter
31828 files, are designed for use in system filters. The condition &%first_delivery%&
31829 is true only for the first attempt at delivering a message, and
31830 &%manually_thawed%& is true only if the message has been frozen, and
31831 subsequently thawed by an admin user. An explicit forced delivery counts as a
31832 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31833
31834 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31835 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31836 succeed, it will not be tried again.
31837 If you want Exim to retry an unseen delivery until it succeeds, you should
31838 arrange to set it up every time the filter runs.
31839
31840 When a system filter finishes running, the values of the variables &$n0$& &--
31841 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31842 users' filter files. Thus a system filter can, for example, set up &"scores"&
31843 to which users' filter files can refer.
31844
31845
31846
31847 .section "Additional variable for system filters" "SECID215"
31848 .vindex "&$recipients$&"
31849 The expansion variable &$recipients$&, containing a list of all the recipients
31850 of the message (separated by commas and white space), is available in system
31851 filters. It is not available in users' filters for privacy reasons.
31852
31853
31854
31855 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31856 .cindex "freezing messages"
31857 .cindex "message" "freezing"
31858 .cindex "message" "forced failure"
31859 .cindex "&%fail%&" "in system filter"
31860 .cindex "&%freeze%& in system filter"
31861 .cindex "&%defer%& in system filter"
31862 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31863 always available in system filters, but are not normally enabled in users'
31864 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31865 for the &(redirect)& router.) These commands can optionally be followed by the
31866 word &%text%& and a string containing an error message, for example:
31867 .code
31868 fail text "this message looks like spam to me"
31869 .endd
31870 The keyword &%text%& is optional if the next character is a double quote.
31871
31872 The &%defer%& command defers delivery of the original recipients of the
31873 message. The &%fail%& command causes all the original recipients to be failed,
31874 and a bounce message to be created. The &%freeze%& command suspends all
31875 delivery attempts for the original recipients. In all cases, any new deliveries
31876 that are specified by the filter are attempted as normal after the filter has
31877 run.
31878
31879 The &%freeze%& command is ignored if the message has been manually unfrozen and
31880 not manually frozen since. This means that automatic freezing by a system
31881 filter can be used as a way of checking out suspicious messages. If a message
31882 is found to be all right, manually unfreezing it allows it to be delivered.
31883
31884 .cindex "log" "&%fail%& command log line"
31885 .cindex "&%fail%&" "log line; reducing"
31886 The text given with a fail command is used as part of the bounce message as
31887 well as being written to the log. If the message is quite long, this can fill
31888 up a lot of log space when such failures are common. To reduce the size of the
31889 log message, Exim interprets the text in a special way if it starts with the
31890 two characters &`<<`& and contains &`>>`& later. The text between these two
31891 strings is written to the log, and the rest of the text is used in the bounce
31892 message. For example:
31893 .code
31894 fail "<<filter test 1>>Your message is rejected \
31895      because it contains attachments that we are \
31896      not prepared to receive."
31897 .endd
31898
31899 .cindex "loop" "caused by &%fail%&"
31900 Take great care with the &%fail%& command when basing the decision to fail on
31901 the contents of the message, because the bounce message will of course include
31902 the contents of the original message and will therefore trigger the &%fail%&
31903 command again (causing a mail loop) unless steps are taken to prevent this.
31904 Testing the &%error_message%& condition is one way to prevent this. You could
31905 use, for example
31906 .code
31907 if $message_body contains "this is spam" and not error_message
31908 then fail text "spam is not wanted here" endif
31909 .endd
31910 though of course that might let through unwanted bounce messages. The
31911 alternative is clever checking of the body and/or headers to detect bounces
31912 generated by the filter.
31913
31914 The interpretation of a system filter file ceases after a
31915 &%defer%&,
31916 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31917 set up earlier in the filter file are honoured, so you can use a sequence such
31918 as
31919 .code
31920 mail ...
31921 freeze
31922 .endd
31923 to send a specified message when the system filter is freezing (or deferring or
31924 failing) a message. The normal deliveries for the message do not, of course,
31925 take place.
31926
31927
31928
31929 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31930 .cindex "header lines" "adding; in system filter"
31931 .cindex "header lines" "removing; in system filter"
31932 .cindex "filter" "header lines; adding/removing"
31933 Two filter commands that are available only in system filters are:
31934 .code
31935 headers add <string>
31936 headers remove <string>
31937 .endd
31938 The argument for the &%headers add%& is a string that is expanded and then
31939 added to the end of the message's headers. It is the responsibility of the
31940 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31941 space is ignored, and if the string is otherwise empty, or if the expansion is
31942 forced to fail, the command has no effect.
31943
31944 You can use &"\n"& within the string, followed by white space, to specify
31945 continued header lines. More than one header may be added in one command by
31946 including &"\n"& within the string without any following white space. For
31947 example:
31948 .code
31949 headers add "X-header-1: ....\n  \
31950              continuation of X-header-1 ...\n\
31951              X-header-2: ...."
31952 .endd
31953 Note that the header line continuation white space after the first newline must
31954 be placed before the backslash that continues the input string, because white
31955 space after input continuations is ignored.
31956
31957 The argument for &%headers remove%& is a colon-separated list of header names.
31958 This command applies only to those headers that are stored with the message;
31959 those that are added at delivery time (such as &'Envelope-To:'& and
31960 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31961 header with the same name, they are all removed.
31962
31963 The &%headers%& command in a system filter makes an immediate change to the set
31964 of header lines that was received with the message (with possible additions
31965 from ACL processing). Subsequent commands in the system filter operate on the
31966 modified set, which also forms the basis for subsequent message delivery.
31967 Unless further modified during routing or transporting, this set of headers is
31968 used for all recipients of the message.
31969
31970 During routing and transporting, the variables that refer to the contents of
31971 header lines refer only to those lines that are in this set. Thus, header lines
31972 that are added by a system filter are visible to users' filter files and to all
31973 routers and transports. This contrasts with the manipulation of header lines by
31974 routers and transports, which is not immediate, but which instead is saved up
31975 until the message is actually being written (see section
31976 &<<SECTheadersaddrem>>&).
31977
31978 If the message is not delivered at the first attempt, header lines that were
31979 added by the system filter are stored with the message, and so are still
31980 present at the next delivery attempt. Header lines that were removed are still
31981 present, but marked &"deleted"& so that they are not transported with the
31982 message. For this reason, it is usual to make the &%headers%& command
31983 conditional on &%first_delivery%& so that the set of header lines is not
31984 modified more than once.
31985
31986 Because header modification in a system filter acts immediately, you have to
31987 use an indirect approach if you want to modify the contents of a header line.
31988 For example:
31989 .code
31990 headers add "Old-Subject: $h_subject:"
31991 headers remove "Subject"
31992 headers add "Subject: new subject (was: $h_old-subject:)"
31993 headers remove "Old-Subject"
31994 .endd
31995
31996
31997
31998 .section "Setting an errors address in a system filter" "SECID217"
31999 .cindex "envelope sender"
32000 In a system filter, if a &%deliver%& command is followed by
32001 .code
32002 errors_to <some address>
32003 .endd
32004 in order to change the envelope sender (and hence the error reporting) for that
32005 delivery, any address may be specified. (In a user filter, only the current
32006 user's address can be set.) For example, if some mail is being monitored, you
32007 might use
32008 .code
32009 unseen deliver monitor@spying.example errors_to root@local.example
32010 .endd
32011 to take a copy which would not be sent back to the normal error reporting
32012 address if its delivery failed.
32013
32014
32015
32016 .section "Per-address filtering" "SECTperaddfil"
32017 .vindex "&$domain$&"
32018 .vindex "&$local_part$&"
32019 In contrast to the system filter, which is run just once per message for each
32020 delivery attempt, it is also possible to set up a system-wide filtering
32021 operation that runs once for each recipient address. In this case, variables
32022 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32023 filter file could be made dependent on them. This is an example of a router
32024 which implements such a filter:
32025 .code
32026 central_filter:
32027   check_local_user
32028   driver = redirect
32029   domains = +local_domains
32030   file = /central/filters/$local_part
32031   no_verify
32032   allow_filter
32033   allow_freeze
32034 .endd
32035 The filter is run in a separate process under its own uid. Therefore, either
32036 &%check_local_user%& must be set (as above), in which case the filter is run as
32037 the local user, or the &%user%& option must be used to specify which user to
32038 use. If both are set, &%user%& overrides.
32039
32040 Care should be taken to ensure that none of the commands in the filter file
32041 specify a significant delivery if the message is to go on to be delivered to
32042 its intended recipient. The router will not then claim to have dealt with the
32043 address, so it will be passed on to subsequent routers to be delivered in the
32044 normal way.
32045 .ecindex IIDsysfil1
32046 .ecindex IIDsysfil2
32047 .ecindex IIDsysfil3
32048
32049
32050
32051
32052
32053
32054 . ////////////////////////////////////////////////////////////////////////////
32055 . ////////////////////////////////////////////////////////////////////////////
32056
32057 .chapter "Message processing" "CHAPmsgproc"
32058 .scindex IIDmesproc "message" "general processing"
32059 Exim performs various transformations on the sender and recipient addresses of
32060 all messages that it handles, and also on the messages' header lines. Some of
32061 these are optional and configurable, while others always take place. All of
32062 this processing, except rewriting as a result of routing, and the addition or
32063 removal of header lines while delivering, happens when a message is received,
32064 before it is placed on Exim's queue.
32065
32066 Some of the automatic processing takes place by default only for
32067 &"locally-originated"& messages. This adjective is used to describe messages
32068 that are not received over TCP/IP, but instead are passed to an Exim process on
32069 its standard input. This includes the interactive &"local SMTP"& case that is
32070 set up by the &%-bs%& command line option.
32071
32072 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32073 or ::1) are not considered to be locally-originated. Exim does not treat the
32074 loopback interface specially in any way.
32075
32076 If you want the loopback interface to be treated specially, you must ensure
32077 that there are appropriate entries in your ACLs.
32078
32079
32080
32081
32082 .section "Submission mode for non-local messages" "SECTsubmodnon"
32083 .cindex "message" "submission"
32084 .cindex "submission mode"
32085 Processing that happens automatically for locally-originated messages (unless
32086 &%suppress_local_fixups%& is set) can also be requested for messages that are
32087 received over TCP/IP. The term &"submission mode"& is used to describe this
32088 state. Submission mode is set by the modifier
32089 .code
32090 control = submission
32091 .endd
32092 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32093 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32094 a local submission, and is normally used when the source of the message is
32095 known to be an MUA running on a client host (as opposed to an MTA). For
32096 example, to set submission mode for messages originating on the IPv4 loopback
32097 interface, you could include the following in the MAIL ACL:
32098 .code
32099 warn  hosts = 127.0.0.1
32100       control = submission
32101 .endd
32102 .cindex "&%sender_retain%& submission option"
32103 There are some options that can be used when setting submission mode. A slash
32104 is used to separate options. For example:
32105 .code
32106 control = submission/sender_retain
32107 .endd
32108 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32109 true and &%local_from_check%& false for the current incoming message. The first
32110 of these allows an existing &'Sender:'& header in the message to remain, and
32111 the second suppresses the check to ensure that &'From:'& matches the
32112 authenticated sender. With this setting, Exim still fixes up messages by adding
32113 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32114 attempt to check sender authenticity in header lines.
32115
32116 When &%sender_retain%& is not set, a submission mode setting may specify a
32117 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32118 example:
32119 .code
32120 control = submission/domain=some.domain
32121 .endd
32122 The domain may be empty. How this value is used is described in sections
32123 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32124 that allows you to specify the user's full name for inclusion in a created
32125 &'Sender:'& or &'From:'& header line. For example:
32126 .code
32127 accept authenticated = *
32128        control = submission/domain=wonderland.example/\
32129                             name=${lookup {$authenticated_id} \
32130                                    lsearch {/etc/exim/namelist}}
32131 .endd
32132 Because the name may contain any characters, including slashes, the &%name%&
32133 option must be given last. The remainder of the string is used as the name. For
32134 the example above, if &_/etc/exim/namelist_& contains:
32135 .code
32136 bigegg:  Humpty Dumpty
32137 .endd
32138 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32139 line would be:
32140 .code
32141 Sender: Humpty Dumpty <bigegg@wonderland.example>
32142 .endd
32143 .cindex "return path" "in submission mode"
32144 By default, submission mode forces the return path to the same address as is
32145 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32146 specified, the return path is also left unchanged.
32147
32148 &*Note*&: The changes caused by submission mode take effect after the predata
32149 ACL. This means that any sender checks performed before the fix-ups use the
32150 untrusted sender address specified by the user, not the trusted sender address
32151 specified by submission mode. Although this might be slightly unexpected, it
32152 does mean that you can configure ACL checks to spot that a user is trying to
32153 spoof another's address.
32154
32155 .section "Line endings" "SECTlineendings"
32156 .cindex "line endings"
32157 .cindex "carriage return"
32158 .cindex "linefeed"
32159 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32160 linefeed) is the line ending for messages transmitted over the Internet using
32161 SMTP over TCP/IP. However, within individual operating systems, different
32162 conventions are used. For example, Unix-like systems use just LF, but others
32163 use CRLF or just CR.
32164
32165 Exim was designed for Unix-like systems, and internally, it stores messages
32166 using the system's convention of a single LF as a line terminator. When
32167 receiving a message, all line endings are translated to this standard format.
32168 Originally, it was thought that programs that passed messages directly to an
32169 MTA within an operating system would use that system's convention. Experience
32170 has shown that this is not the case; for example, there are Unix applications
32171 that use CRLF in this circumstance. For this reason, and for compatibility with
32172 other MTAs, the way Exim handles line endings for all messages is now as
32173 follows:
32174
32175 .ilist
32176 LF not preceded by CR is treated as a line ending.
32177 .next
32178 CR is treated as a line ending; if it is immediately followed by LF, the LF
32179 is ignored.
32180 .next
32181 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32182 nor a local message in the state where a line containing only a dot is a
32183 terminator.
32184 .next
32185 If a bare CR is encountered within a header line, an extra space is added after
32186 the line terminator so as not to end the header line. The reasoning behind this
32187 is that bare CRs in header lines are most likely either to be mistakes, or
32188 people trying to play silly games.
32189 .next
32190 If the first header line received in a message ends with CRLF, a subsequent
32191 bare LF in a header line is treated in the same way as a bare CR in a header
32192 line.
32193 .endlist
32194
32195
32196
32197
32198
32199 .section "Unqualified addresses" "SECID218"
32200 .cindex "unqualified addresses"
32201 .cindex "address" "qualification"
32202 By default, Exim expects every envelope address it receives from an external
32203 host to be fully qualified. Unqualified addresses cause negative responses to
32204 SMTP commands. However, because SMTP is used as a means of transporting
32205 messages from MUAs running on personal workstations, there is sometimes a
32206 requirement to accept unqualified addresses from specific hosts or IP networks.
32207
32208 Exim has two options that separately control which hosts may send unqualified
32209 sender or recipient addresses in SMTP commands, namely
32210 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32211 cases, if an unqualified address is accepted, it is qualified by adding the
32212 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32213
32214 .oindex "&%qualify_domain%&"
32215 .oindex "&%qualify_recipient%&"
32216 Unqualified addresses in header lines are automatically qualified for messages
32217 that are locally originated, unless the &%-bnq%& option is given on the command
32218 line. For messages received over SMTP, unqualified addresses in header lines
32219 are qualified only if unqualified addresses are permitted in SMTP commands. In
32220 other words, such qualification is also controlled by
32221 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32222
32223
32224
32225
32226 .section "The UUCP From line" "SECID219"
32227 .cindex "&""From""& line"
32228 .cindex "UUCP" "&""From""& line"
32229 .cindex "sender" "address"
32230 .oindex "&%uucp_from_pattern%&"
32231 .oindex "&%uucp_from_sender%&"
32232 .cindex "envelope sender"
32233 .cindex "Sendmail compatibility" "&""From""& line"
32234 Messages that have come from UUCP (and some other applications) often begin
32235 with a line containing the envelope sender and a timestamp, following the word
32236 &"From"&. Examples of two common formats are:
32237 .code
32238 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32239 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32240 .endd
32241 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32242 Exim recognizes such lines at the start of messages that are submitted to it
32243 via the command line (that is, on the standard input). It does not recognize
32244 such lines in incoming SMTP messages, unless the sending host matches
32245 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32246 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32247 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32248 default value matches the two common cases shown above and puts the address
32249 that follows &"From"& into &$1$&.
32250
32251 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32252 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32253 a trusted user, the message's sender address is constructed by expanding the
32254 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32255 then parsed as an RFC 2822 address. If there is no domain, the local part is
32256 qualified with &%qualify_domain%& unless it is the empty string. However, if
32257 the command line &%-f%& option is used, it overrides the &"From"& line.
32258
32259 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32260 sender address is not changed. This is also the case for incoming SMTP messages
32261 that are permitted to contain &"From"& lines.
32262
32263 Only one &"From"& line is recognized. If there is more than one, the second is
32264 treated as a data line that starts the body of the message, as it is not valid
32265 as a header line. This also happens if a &"From"& line is present in an
32266 incoming SMTP message from a source that is not permitted to send them.
32267
32268
32269
32270 .section "Resent- header lines" "SECID220"
32271 .cindex "&%Resent-%& header lines"
32272 RFC 2822 makes provision for sets of header lines starting with the string
32273 &`Resent-`& to be added to a message when it is resent by the original
32274 recipient to somebody else. These headers are &'Resent-Date:'&,
32275 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32276 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32277
32278 .blockquote
32279 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32280 processing of replies or other such automatic actions on messages.'&
32281 .endblockquote
32282
32283 This leaves things a bit vague as far as other processing actions such as
32284 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32285 follows:
32286
32287 .ilist
32288 A &'Resent-From:'& line that just contains the login id of the submitting user
32289 is automatically rewritten in the same way as &'From:'& (see below).
32290 .next
32291 If there's a rewriting rule for a particular header line, it is also applied to
32292 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32293 &'From:'& also rewrites &'Resent-From:'&.
32294 .next
32295 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32296 also removed.
32297 .next
32298 For a locally-submitted message,
32299 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32300 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32301 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32302 included in log lines in this case.
32303 .next
32304 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32305 &%Resent-%& header lines are present.
32306 .endlist
32307
32308
32309
32310
32311 .section "The Auto-Submitted: header line" "SECID221"
32312 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32313 includes the header line:
32314 .code
32315 Auto-Submitted: auto-replied
32316 .endd
32317
32318 .section "The Bcc: header line" "SECID222"
32319 .cindex "&'Bcc:'& header line"
32320 If Exim is called with the &%-t%& option, to take recipient addresses from a
32321 message's header, it removes any &'Bcc:'& header line that may exist (after
32322 extracting its addresses). If &%-t%& is not present on the command line, any
32323 existing &'Bcc:'& is not removed.
32324
32325
32326 .section "The Date: header line" "SECID223"
32327 .cindex "&'Date:'& header line"
32328 If a locally-generated or submission-mode message has no &'Date:'& header line,
32329 Exim adds one, using the current date and time, unless the
32330 &%suppress_local_fixups%& control has been specified.
32331
32332 .section "The Delivery-date: header line" "SECID224"
32333 .cindex "&'Delivery-date:'& header line"
32334 .oindex "&%delivery_date_remove%&"
32335 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32336 set. Exim can be configured to add them to the final delivery of messages. (See
32337 the generic &%delivery_date_add%& transport option.) They should not be present
32338 in messages in transit. If the &%delivery_date_remove%& configuration option is
32339 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32340 messages.
32341
32342
32343 .section "The Envelope-to: header line" "SECID225"
32344 .cindex "&'Envelope-to:'& header line"
32345 .oindex "&%envelope_to_remove%&"
32346 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32347 Exim can be configured to add them to the final delivery of messages. (See the
32348 generic &%envelope_to_add%& transport option.) They should not be present in
32349 messages in transit. If the &%envelope_to_remove%& configuration option is set
32350 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32351 messages.
32352
32353
32354 .section "The From: header line" "SECTthefrohea"
32355 .cindex "&'From:'& header line"
32356 .cindex "Sendmail compatibility" "&""From""& line"
32357 .cindex "message" "submission"
32358 .cindex "submission mode"
32359 If a submission-mode message does not contain a &'From:'& header line, Exim
32360 adds one if either of the following conditions is true:
32361
32362 .ilist
32363 The envelope sender address is not empty (that is, this is not a bounce
32364 message). The added header line copies the envelope sender address.
32365 .next
32366 .vindex "&$authenticated_id$&"
32367 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32368 .olist
32369 .vindex "&$qualify_domain$&"
32370 If no domain is specified by the submission control, the local part is
32371 &$authenticated_id$& and the domain is &$qualify_domain$&.
32372 .next
32373 If a non-empty domain is specified by the submission control, the local
32374 part is &$authenticated_id$&, and the domain is the specified domain.
32375 .next
32376 If an empty domain is specified by the submission control,
32377 &$authenticated_id$& is assumed to be the complete address.
32378 .endlist
32379 .endlist
32380
32381 A non-empty envelope sender takes precedence.
32382
32383 If a locally-generated incoming message does not contain a &'From:'& header
32384 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32385 containing the sender's address. The calling user's login name and full name
32386 are used to construct the address, as described in section &<<SECTconstr>>&.
32387 They are obtained from the password data by calling &[getpwuid()]& (but see the
32388 &%unknown_login%& configuration option). The address is qualified with
32389 &%qualify_domain%&.
32390
32391 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32392 &'From:'& header line containing just the unqualified login name of the calling
32393 user, this is replaced by an address containing the user's login name and full
32394 name as described in section &<<SECTconstr>>&.
32395
32396
32397 .section "The Message-ID: header line" "SECID226"
32398 .cindex "&'Message-ID:'& header line"
32399 .cindex "message" "submission"
32400 .oindex "&%message_id_header_text%&"
32401 If a locally-generated or submission-mode incoming message does not contain a
32402 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32403 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32404 to the message. If there are any &'Resent-:'& headers in the message, it
32405 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32406 message id, preceded by the letter E to ensure it starts with a letter, and
32407 followed by @ and the primary host name. Additional information can be included
32408 in this header line by setting the &%message_id_header_text%& and/or
32409 &%message_id_header_domain%& options.
32410
32411
32412 .section "The Received: header line" "SECID227"
32413 .cindex "&'Received:'& header line"
32414 A &'Received:'& header line is added at the start of every message. The
32415 contents are defined by the &%received_header_text%& configuration option, and
32416 Exim automatically adds a semicolon and a timestamp to the configured string.
32417
32418 The &'Received:'& header is generated as soon as the message's header lines
32419 have been received. At this stage, the timestamp in the &'Received:'& header
32420 line is the time that the message started to be received. This is the value
32421 that is seen by the DATA ACL and by the &[local_scan()]& function.
32422
32423 Once a message is accepted, the timestamp in the &'Received:'& header line is
32424 changed to the time of acceptance, which is (apart from a small delay while the
32425 -H spool file is written) the earliest time at which delivery could start.
32426
32427
32428 .section "The References: header line" "SECID228"
32429 .cindex "&'References:'& header line"
32430 Messages created by the &(autoreply)& transport include a &'References:'&
32431 header line. This is constructed according to the rules that are described in
32432 section 3.64 of RFC 2822 (which states that replies should contain such a
32433 header line), and section 3.14 of RFC 3834 (which states that automatic
32434 responses are not different in this respect). However, because some mail
32435 processing software does not cope well with very long header lines, no more
32436 than 12 message IDs are copied from the &'References:'& header line in the
32437 incoming message. If there are more than 12, the first one and then the final
32438 11 are copied, before adding the message ID of the incoming message.
32439
32440
32441
32442 .section "The Return-path: header line" "SECID229"
32443 .cindex "&'Return-path:'& header line"
32444 .oindex "&%return_path_remove%&"
32445 &'Return-path:'& header lines are defined as something an MTA may insert when
32446 it does the final delivery of messages. (See the generic &%return_path_add%&
32447 transport option.) Therefore, they should not be present in messages in
32448 transit. If the &%return_path_remove%& configuration option is set (the
32449 default), Exim removes &'Return-path:'& header lines from incoming messages.
32450
32451
32452
32453 .section "The Sender: header line" "SECTthesenhea"
32454 .cindex "&'Sender:'& header line"
32455 .cindex "message" "submission"
32456 For a locally-originated message from an untrusted user, Exim may remove an
32457 existing &'Sender:'& header line, and it may add a new one. You can modify
32458 these actions by setting the &%local_sender_retain%& option true, the
32459 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32460 control setting.
32461
32462 When a local message is received from an untrusted user and
32463 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32464 control has not been set, a check is made to see if the address given in the
32465 &'From:'& header line is the correct (local) sender of the message. The address
32466 that is expected has the login name as the local part and the value of
32467 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32468 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32469 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32470 line is added to the message.
32471
32472 If you set &%local_from_check%& false, this checking does not occur. However,
32473 the removal of an existing &'Sender:'& line still happens, unless you also set
32474 &%local_sender_retain%& to be true. It is not possible to set both of these
32475 options true at the same time.
32476
32477 .cindex "submission mode"
32478 By default, no processing of &'Sender:'& header lines is done for messages
32479 received over TCP/IP or for messages submitted by trusted users. However, when
32480 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32481 not specified on the submission control, the following processing takes place:
32482
32483 .vindex "&$authenticated_id$&"
32484 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32485 authenticated, and &$authenticated_id$& is not empty, a sender address is
32486 created as follows:
32487
32488 .ilist
32489 .vindex "&$qualify_domain$&"
32490 If no domain is specified by the submission control, the local part is
32491 &$authenticated_id$& and the domain is &$qualify_domain$&.
32492 .next
32493 If a non-empty domain is specified by the submission control, the local part
32494 is &$authenticated_id$&, and the domain is the specified domain.
32495 .next
32496 If an empty domain is specified by the submission control,
32497 &$authenticated_id$& is assumed to be the complete address.
32498 .endlist
32499
32500 This address is compared with the address in the &'From:'& header line. If they
32501 are different, a &'Sender:'& header line containing the created address is
32502 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32503 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32504
32505 .cindex "return path" "created from &'Sender:'&"
32506 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32507 the message (the envelope sender address) is changed to be the same address,
32508 except in the case of submission mode when &%sender_retain%& is specified.
32509
32510
32511
32512 .section "Adding and removing header lines in routers and transports" &&&
32513          "SECTheadersaddrem"
32514 .cindex "header lines" "adding; in router or transport"
32515 .cindex "header lines" "removing; in router or transport"
32516 When a message is delivered, the addition and removal of header lines can be
32517 specified in a system filter, or on any of the routers and transports that
32518 process the message. Section &<<SECTaddremheasys>>& contains details about
32519 modifying headers in a system filter. Header lines can also be added in an ACL
32520 as a message is received (see section &<<SECTaddheadacl>>&).
32521
32522 In contrast to what happens in a system filter, header modifications that are
32523 specified on routers and transports apply only to the particular recipient
32524 addresses that are being processed by those routers and transports. These
32525 changes do not actually take place until a copy of the message is being
32526 transported. Therefore, they do not affect the basic set of header lines, and
32527 they do not affect the values of the variables that refer to header lines.
32528
32529 &*Note*&: In particular, this means that any expansions in the configuration of
32530 the transport cannot refer to the modified header lines, because such
32531 expansions all occur before the message is actually transported.
32532
32533 For both routers and transports, the argument of a &%headers_add%&
32534 option must be in the form of one or more RFC 2822 header lines, separated by
32535 newlines (coded as &"\n"&). For example:
32536 .code
32537 headers_add = X-added-header: added by $primary_hostname\n\
32538               X-added-second: another added header line
32539 .endd
32540 Exim does not check the syntax of these added header lines.
32541
32542 Multiple &%headers_add%& options for a single router or transport can be
32543 specified; the values will append to a single list of header lines.
32544 Each header-line is separately expanded.
32545
32546 The argument of a &%headers_remove%& option must consist of a colon-separated
32547 list of header names. This is confusing, because header names themselves are
32548 often terminated by colons. In this case, the colons are the list separators,
32549 not part of the names. For example:
32550 .code
32551 headers_remove = return-receipt-to:acknowledge-to
32552 .endd
32553
32554 Multiple &%headers_remove%& options for a single router or transport can be
32555 specified; the arguments will append to a single header-names list.
32556 Each item is separately expanded.
32557 Note that colons in complex expansions which are used to
32558 form all or part of a &%headers_remove%& list
32559 will act as list separators.
32560
32561 When &%headers_add%& or &%headers_remove%& is specified on a router,
32562 items are expanded at routing time,
32563 and then associated with all addresses that are
32564 accepted by that router, and also with any new addresses that it generates. If
32565 an address passes through several routers as a result of aliasing or
32566 forwarding, the changes are cumulative.
32567
32568 .oindex "&%unseen%&"
32569 However, this does not apply to multiple routers that result from the use of
32570 the &%unseen%& option. Any header modifications that were specified by the
32571 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32572
32573 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32574 settings cannot be delivered together in a batch, so a transport is always
32575 dealing with a set of addresses that have the same header-processing
32576 requirements.
32577
32578 The transport starts by writing the original set of header lines that arrived
32579 with the message, possibly modified by the system filter. As it writes out
32580 these lines, it consults the list of header names that were attached to the
32581 recipient address(es) by &%headers_remove%& options in routers, and it also
32582 consults the transport's own &%headers_remove%& option. Header lines whose
32583 names are on either of these lists are not written out. If there are multiple
32584 instances of any listed header, they are all skipped.
32585
32586 After the remaining original header lines have been written, new header
32587 lines that were specified by routers' &%headers_add%& options are written, in
32588 the order in which they were attached to the address. These are followed by any
32589 header lines specified by the transport's &%headers_add%& option.
32590
32591 This way of handling header line modifications in routers and transports has
32592 the following consequences:
32593
32594 .ilist
32595 The original set of header lines, possibly modified by the system filter,
32596 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32597 to it, at all times.
32598 .next
32599 Header lines that are added by a router's
32600 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32601 expansion syntax in subsequent routers or the transport.
32602 .next
32603 Conversely, header lines that are specified for removal by &%headers_remove%&
32604 in a router remain visible to subsequent routers and the transport.
32605 .next
32606 Headers added to an address by &%headers_add%& in a router cannot be removed by
32607 a later router or by a transport.
32608 .next
32609 An added header can refer to the contents of an original header that is to be
32610 removed, even it has the same name as the added header. For example:
32611 .code
32612 headers_remove = subject
32613 headers_add = Subject: new subject (was: $h_subject:)
32614 .endd
32615 .endlist
32616
32617 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32618 for a &(redirect)& router that has the &%one_time%& option set.
32619
32620
32621
32622
32623
32624 .section "Constructed addresses" "SECTconstr"
32625 .cindex "address" "constructed"
32626 .cindex "constructed address"
32627 When Exim constructs a sender address for a locally-generated message, it uses
32628 the form
32629 .display
32630 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32631 .endd
32632 For example:
32633 .code
32634 Zaphod Beeblebrox <zaphod@end.univ.example>
32635 .endd
32636 The user name is obtained from the &%-F%& command line option if set, or
32637 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32638 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32639 ampersand character, this is replaced by the login name with the first letter
32640 upper cased, as is conventional in a number of operating systems. See the
32641 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32642 The &%unknown_username%& option can be used to specify user names in cases when
32643 there is no password file entry.
32644
32645 .cindex "RFC 2047"
32646 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32647 parts of it if necessary. In addition, if it contains any non-printing
32648 characters, it is encoded as described in RFC 2047, which defines a way of
32649 including non-ASCII characters in header lines. The value of the
32650 &%headers_charset%& option specifies the name of the encoding that is used (the
32651 characters are assumed to be in this encoding). The setting of
32652 &%print_topbitchars%& controls whether characters with the top bit set (that
32653 is, with codes greater than 127) count as printing characters or not.
32654
32655
32656
32657 .section "Case of local parts" "SECID230"
32658 .cindex "case of local parts"
32659 .cindex "local part" "case of"
32660 RFC 2822 states that the case of letters in the local parts of addresses cannot
32661 be assumed to be non-significant. Exim preserves the case of local parts of
32662 addresses, but by default it uses a lower-cased form when it is routing,
32663 because on most Unix systems, usernames are in lower case and case-insensitive
32664 routing is required. However, any particular router can be made to use the
32665 original case for local parts by setting the &%caseful_local_part%& generic
32666 router option.
32667
32668 .cindex "mixed-case login names"
32669 If you must have mixed-case user names on your system, the best way to proceed,
32670 assuming you want case-independent handling of incoming email, is to set up
32671 your first router to convert incoming local parts in your domains to the
32672 correct case by means of a file lookup. For example:
32673 .code
32674 correct_case:
32675   driver = redirect
32676   domains = +local_domains
32677   data = ${lookup{$local_part}cdb\
32678               {/etc/usercased.cdb}{$value}fail}\
32679               @$domain
32680 .endd
32681 For this router, the local part is forced to lower case by the default action
32682 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32683 up a new local part in the correct case. If you then set &%caseful_local_part%&
32684 on any subsequent routers which process your domains, they will operate on
32685 local parts with the correct case in a case-sensitive manner.
32686
32687
32688
32689 .section "Dots in local parts" "SECID231"
32690 .cindex "dot" "in local part"
32691 .cindex "local part" "dots in"
32692 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32693 part may not begin or end with a dot, nor have two consecutive dots in the
32694 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32695 empty components for compatibility.
32696
32697
32698
32699 .section "Rewriting addresses" "SECID232"
32700 .cindex "rewriting" "addresses"
32701 Rewriting of sender and recipient addresses, and addresses in headers, can
32702 happen automatically, or as the result of configuration options, as described
32703 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32704 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32705
32706 Automatic rewriting includes qualification, as mentioned above. The other case
32707 in which it can happen is when an incomplete non-local domain is given. The
32708 routing process may cause this to be expanded into the full domain name. For
32709 example, a header such as
32710 .code
32711 To: hare@teaparty
32712 .endd
32713 might get rewritten as
32714 .code
32715 To: hare@teaparty.wonderland.fict.example
32716 .endd
32717 Rewriting as a result of routing is the one kind of message processing that
32718 does not happen at input time, as it cannot be done until the address has
32719 been routed.
32720
32721 Strictly, one should not do &'any'& deliveries of a message until all its
32722 addresses have been routed, in case any of the headers get changed as a
32723 result of routing. However, doing this in practice would hold up many
32724 deliveries for unreasonable amounts of time, just because one address could not
32725 immediately be routed. Exim therefore does not delay other deliveries when
32726 routing of one or more addresses is deferred.
32727 .ecindex IIDmesproc
32728
32729
32730
32731 . ////////////////////////////////////////////////////////////////////////////
32732 . ////////////////////////////////////////////////////////////////////////////
32733
32734 .chapter "SMTP processing" "CHAPSMTP"
32735 .scindex IIDsmtpproc1 "SMTP" "processing details"
32736 .scindex IIDsmtpproc2 "LMTP" "processing details"
32737 Exim supports a number of different ways of using the SMTP protocol, and its
32738 LMTP variant, which is an interactive protocol for transferring messages into a
32739 closed mail store application. This chapter contains details of how SMTP is
32740 processed. For incoming mail, the following are available:
32741
32742 .ilist
32743 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32744 .next
32745 SMTP over the standard input and output (the &%-bs%& option);
32746 .next
32747 Batched SMTP on the standard input (the &%-bS%& option).
32748 .endlist
32749
32750 For mail delivery, the following are available:
32751
32752 .ilist
32753 SMTP over TCP/IP (the &(smtp)& transport);
32754 .next
32755 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32756 &"lmtp"&);
32757 .next
32758 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32759 transport);
32760 .next
32761 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32762 the &%use_bsmtp%& option set).
32763 .endlist
32764
32765 &'Batched SMTP'& is the name for a process in which batches of messages are
32766 stored in or read from files (or pipes), in a format in which SMTP commands are
32767 used to contain the envelope information.
32768
32769
32770
32771 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32772 .cindex "SMTP" "outgoing over TCP/IP"
32773 .cindex "outgoing SMTP over TCP/IP"
32774 .cindex "LMTP" "over TCP/IP"
32775 .cindex "outgoing LMTP over TCP/IP"
32776 .cindex "EHLO"
32777 .cindex "HELO"
32778 .cindex "SIZE option on MAIL command"
32779 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32780 The &%protocol%& option selects which protocol is to be used, but the actual
32781 processing is the same in both cases.
32782
32783 If, in response to its EHLO command, Exim is told that the SIZE
32784 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32785 command. The value of <&'n'&> is the message size plus the value of the
32786 &%size_addition%& option (default 1024) to allow for additions to the message
32787 such as per-transport header lines, or changes made in a
32788 .cindex "transport" "filter"
32789 .cindex "filter" "transport filter"
32790 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32791 suppressed.
32792
32793 If the remote server advertises support for PIPELINING, Exim uses the
32794 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32795 required for the transaction.
32796
32797 If the remote server advertises support for the STARTTLS command, and Exim
32798 was built to support TLS encryption, it tries to start a TLS session unless the
32799 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32800 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32801 is called for verification.
32802
32803 If the remote server advertises support for the AUTH command, Exim scans
32804 the authenticators configuration for any suitable client settings, as described
32805 in chapter &<<CHAPSMTPAUTH>>&.
32806
32807 .cindex "carriage return"
32808 .cindex "linefeed"
32809 Responses from the remote host are supposed to be terminated by CR followed by
32810 LF. However, there are known to be hosts that do not send CR characters, so in
32811 order to be able to interwork with such hosts, Exim treats LF on its own as a
32812 line terminator.
32813
32814 If a message contains a number of different addresses, all those with the same
32815 characteristics (for example, the same envelope sender) that resolve to the
32816 same set of hosts, in the same order, are sent in a single SMTP transaction,
32817 even if they are for different domains, unless there are more than the setting
32818 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32819 they are split into groups containing no more than &%max_rcpt%&s addresses
32820 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32821 in parallel sessions. The order of hosts with identical MX values is not
32822 significant when checking whether addresses can be batched in this way.
32823
32824 When the &(smtp)& transport suffers a temporary failure that is not
32825 message-related, Exim updates its transport-specific database, which contains
32826 records indexed by host name that remember which messages are waiting for each
32827 particular host. It also updates the retry database with new retry times.
32828
32829 .cindex "hints database" "retry keys"
32830 Exim's retry hints are based on host name plus IP address, so if one address of
32831 a multi-homed host is broken, it will soon be skipped most of the time.
32832 See the next section for more detail about error handling.
32833
32834 .cindex "SMTP" "passed connection"
32835 .cindex "SMTP" "batching over TCP/IP"
32836 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32837 looks in the hints database for the transport to see if there are any queued
32838 messages waiting for the host to which it is connected. If it finds one, it
32839 creates a new Exim process using the &%-MC%& option (which can only be used by
32840 a process running as root or the Exim user) and passes the TCP/IP socket to it
32841 so that it can deliver another message using the same socket. The new process
32842 does only those deliveries that are routed to the connected host, and may in
32843 turn pass the socket on to a third process, and so on.
32844
32845 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32846 limit the number of messages sent down a single TCP/IP connection.
32847
32848 .cindex "asterisk" "after IP address"
32849 The second and subsequent messages delivered down an existing connection are
32850 identified in the main log by the addition of an asterisk after the closing
32851 square bracket of the IP address.
32852
32853
32854
32855
32856 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32857 .cindex "error" "in outgoing SMTP"
32858 .cindex "SMTP" "errors in outgoing"
32859 .cindex "host" "error"
32860 Three different kinds of error are recognized for outgoing SMTP: host errors,
32861 message errors, and recipient errors.
32862
32863 .vlist
32864 .vitem "&*Host errors*&"
32865 A host error is not associated with a particular message or with a
32866 particular recipient of a message. The host errors are:
32867
32868 .ilist
32869 Connection refused or timed out,
32870 .next
32871 Any error response code on connection,
32872 .next
32873 Any error response code to EHLO or HELO,
32874 .next
32875 Loss of connection at any time, except after &"."&,
32876 .next
32877 I/O errors at any time,
32878 .next
32879 Timeouts during the session, other than in response to MAIL, RCPT or
32880 the &"."& at the end of the data.
32881 .endlist ilist
32882
32883 For a host error, a permanent error response on connection, or in response to
32884 EHLO, causes all addresses routed to the host to be failed. Any other host
32885 error causes all addresses to be deferred, and retry data to be created for the
32886 host. It is not tried again, for any message, until its retry time arrives. If
32887 the current set of addresses are not all delivered in this run (to some
32888 alternative host), the message is added to the list of those waiting for this
32889 host, so if it is still undelivered when a subsequent successful delivery is
32890 made to the host, it will be sent down the same SMTP connection.
32891
32892 .vitem "&*Message errors*&"
32893 .cindex "message" "error"
32894 A message error is associated with a particular message when sent to a
32895 particular host, but not with a particular recipient of the message. The
32896 message errors are:
32897
32898 .ilist
32899 Any error response code to MAIL, DATA, or the &"."& that terminates
32900 the data,
32901 .next
32902 Timeout after MAIL,
32903 .next
32904 Timeout or loss of connection after the &"."& that terminates the data. A
32905 timeout after the DATA command itself is treated as a host error, as is loss of
32906 connection at any other time.
32907 .endlist ilist
32908
32909 For a message error, a permanent error response (5&'xx'&) causes all addresses
32910 to be failed, and a delivery error report to be returned to the sender. A
32911 temporary error response (4&'xx'&), or one of the timeouts, causes all
32912 addresses to be deferred. Retry data is not created for the host, but instead,
32913 a retry record for the combination of host plus message id is created. The
32914 message is not added to the list of those waiting for this host. This ensures
32915 that the failing message will not be sent to this host again until the retry
32916 time arrives. However, other messages that are routed to the host are not
32917 affected, so if it is some property of the message that is causing the error,
32918 it will not stop the delivery of other mail.
32919
32920 If the remote host specified support for the SIZE parameter in its response
32921 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32922 over-large message will cause a message error because the error arrives as a
32923 response to MAIL.
32924
32925 .vitem "&*Recipient errors*&"
32926 .cindex "recipient" "error"
32927 A recipient error is associated with a particular recipient of a message. The
32928 recipient errors are:
32929
32930 .ilist
32931 Any error response to RCPT,
32932 .next
32933 Timeout after RCPT.
32934 .endlist
32935
32936 For a recipient error, a permanent error response (5&'xx'&) causes the
32937 recipient address to be failed, and a bounce message to be returned to the
32938 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32939 address to be deferred, and routing retry data to be created for it. This is
32940 used to delay processing of the address in subsequent queue runs, until its
32941 routing retry time arrives. This applies to all messages, but because it
32942 operates only in queue runs, one attempt will be made to deliver a new message
32943 to the failing address before the delay starts to operate. This ensures that,
32944 if the failure is really related to the message rather than the recipient
32945 (&"message too big for this recipient"& is a possible example), other messages
32946 have a chance of getting delivered. If a delivery to the address does succeed,
32947 the retry information gets cleared, so all stuck messages get tried again, and
32948 the retry clock is reset.
32949
32950 The message is not added to the list of those waiting for this host. Use of the
32951 host for other messages is unaffected, and except in the case of a timeout,
32952 other recipients are processed independently, and may be successfully delivered
32953 in the current SMTP session. After a timeout it is of course impossible to
32954 proceed with the session, so all addresses get deferred. However, those other
32955 than the one that failed do not suffer any subsequent retry delays. Therefore,
32956 if one recipient is causing trouble, the others have a chance of getting
32957 through when a subsequent delivery attempt occurs before the failing
32958 recipient's retry time.
32959 .endlist
32960
32961 In all cases, if there are other hosts (or IP addresses) available for the
32962 current set of addresses (for example, from multiple MX records), they are
32963 tried in this run for any undelivered addresses, subject of course to their
32964 own retry data. In other words, recipient error retry data does not take effect
32965 until the next delivery attempt.
32966
32967 Some hosts have been observed to give temporary error responses to every
32968 MAIL command at certain times (&"insufficient space"& has been seen). It
32969 would be nice if such circumstances could be recognized, and defer data for the
32970 host itself created, but this is not possible within the current Exim design.
32971 What actually happens is that retry data for every (host, message) combination
32972 is created.
32973
32974 The reason that timeouts after MAIL and RCPT are treated specially is that
32975 these can sometimes arise as a result of the remote host's verification
32976 procedures. Exim makes this assumption, and treats them as if a temporary error
32977 response had been received. A timeout after &"."& is treated specially because
32978 it is known that some broken implementations fail to recognize the end of the
32979 message if the last character of the last line is a binary zero. Thus, it is
32980 helpful to treat this case as a message error.
32981
32982 Timeouts at other times are treated as host errors, assuming a problem with the
32983 host, or the connection to it. If a timeout after MAIL, RCPT,
32984 or &"."& is really a connection problem, the assumption is that at the next try
32985 the timeout is likely to occur at some other point in the dialogue, causing it
32986 then to be treated as a host error.
32987
32988 There is experimental evidence that some MTAs drop the connection after the
32989 terminating &"."& if they do not like the contents of the message for some
32990 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32991 should be given. That is why Exim treats this case as a message rather than a
32992 host error, in order not to delay other messages to the same host.
32993
32994
32995
32996
32997 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32998 .cindex "SMTP" "incoming over TCP/IP"
32999 .cindex "incoming SMTP over TCP/IP"
33000 .cindex "inetd"
33001 .cindex "daemon"
33002 Incoming SMTP messages can be accepted in one of two ways: by running a
33003 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33004 &_/etc/inetd.conf_& should be like this:
33005 .code
33006 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33007 .endd
33008 Exim distinguishes between this case and the case of a locally running user
33009 agent using the &%-bs%& option by checking whether or not the standard input is
33010 a socket. When it is, either the port must be privileged (less than 1024), or
33011 the caller must be root or the Exim user. If any other user passes a socket
33012 with an unprivileged port number, Exim prints a message on the standard error
33013 stream and exits with an error code.
33014
33015 By default, Exim does not make a log entry when a remote host connects or
33016 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33017 unexpected. It can be made to write such log entries by setting the
33018 &%smtp_connection%& log selector.
33019
33020 .cindex "carriage return"
33021 .cindex "linefeed"
33022 Commands from the remote host are supposed to be terminated by CR followed by
33023 LF. However, there are known to be hosts that do not send CR characters. In
33024 order to be able to interwork with such hosts, Exim treats LF on its own as a
33025 line terminator.
33026 Furthermore, because common code is used for receiving messages from all
33027 sources, a CR on its own is also interpreted as a line terminator. However, the
33028 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33029
33030 .cindex "EHLO" "invalid data"
33031 .cindex "HELO" "invalid data"
33032 One area that sometimes gives rise to problems concerns the EHLO or
33033 HELO commands. Some clients send syntactically invalid versions of these
33034 commands, which Exim rejects by default. (This is nothing to do with verifying
33035 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33036 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33037 match the broken hosts that send invalid commands.
33038
33039 .cindex "SIZE option on MAIL command"
33040 .cindex "MAIL" "SIZE option"
33041 The amount of disk space available is checked whenever SIZE is received on
33042 a MAIL command, independently of whether &%message_size_limit%& or
33043 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33044 false. A temporary error is given if there is not enough space. If
33045 &%check_spool_space%& is set, the check is for that amount of space plus the
33046 value given with SIZE, that is, it checks that the addition of the incoming
33047 message will not reduce the space below the threshold.
33048
33049 When a message is successfully received, Exim includes the local message id in
33050 its response to the final &"."& that terminates the data. If the remote host
33051 logs this text it can help with tracing what has happened to a message.
33052
33053 The Exim daemon can limit the number of simultaneous incoming connections it is
33054 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33055 number of simultaneous incoming connections from a single remote host (see the
33056 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33057 rejected using the SMTP temporary error code 421.
33058
33059 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33060 subprocess has finished, as this can get lost at busy times. Instead, it looks
33061 for completed subprocesses every time it wakes up. Provided there are other
33062 things happening (new incoming calls, starts of queue runs), completed
33063 processes will be noticed and tidied away. On very quiet systems you may
33064 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33065 it will be noticed when the daemon next wakes up.
33066
33067 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33068 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33069 high system load &-- for details see the &%smtp_accept_reserve%&,
33070 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33071 applies in both the daemon and &'inetd'& cases.
33072
33073 Exim normally starts a delivery process for each message received, though this
33074 can be varied by means of the &%-odq%& command line option and the
33075 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33076 number of simultaneously running delivery processes started in this way from
33077 SMTP input can be limited by the &%smtp_accept_queue%& and
33078 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33079 subsequently received messages are just put on the input queue without starting
33080 a delivery process.
33081
33082 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33083 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33084 started up from the &'inetd'& daemon, because in that case each connection is
33085 handled by an entirely independent Exim process. Control by load average is,
33086 however, available with &'inetd'&.
33087
33088 Exim can be configured to verify addresses in incoming SMTP commands as they
33089 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33090 to rewrite addresses at this time &-- before any syntax checking is done. See
33091 section &<<SECTrewriteS>>&.
33092
33093 Exim can also be configured to limit the rate at which a client host submits
33094 MAIL and RCPT commands in a single SMTP session. See the
33095 &%smtp_ratelimit_hosts%& option.
33096
33097
33098
33099 .section "Unrecognized SMTP commands" "SECID234"
33100 .cindex "SMTP" "unrecognized commands"
33101 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33102 commands during a single SMTP connection, it drops the connection after sending
33103 the error response to the last command. The default value for
33104 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33105 abuse that subvert web servers into making connections to SMTP ports; in these
33106 circumstances, a number of non-SMTP lines are sent first.
33107
33108
33109 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33110 .cindex "SMTP" "syntax errors"
33111 .cindex "SMTP" "protocol errors"
33112 A syntax error is detected if an SMTP command is recognized, but there is
33113 something syntactically wrong with its data, for example, a malformed email
33114 address in a RCPT command. Protocol errors include invalid command
33115 sequencing such as RCPT before MAIL. If Exim receives more than
33116 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33117 drops the connection after sending the error response to the last command. The
33118 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33119 broken clients that loop sending bad commands (yes, it has been seen).
33120
33121
33122
33123 .section "Use of non-mail SMTP commands" "SECID236"
33124 .cindex "SMTP" "non-mail commands"
33125 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33126 DATA. Exim counts such commands, and drops the connection if there are too
33127 many of them in a single SMTP session. This action catches some
33128 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33129 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33130 defines what &"too many"& means. Its default value is 10.
33131
33132 When a new message is expected, one occurrence of RSET is not counted. This
33133 allows a client to send one RSET between messages (this is not necessary,
33134 but some clients do it). Exim also allows one uncounted occurrence of HELO
33135 or EHLO, and one occurrence of STARTTLS between messages. After
33136 starting up a TLS session, another EHLO is expected, and so it too is not
33137 counted.
33138
33139 The first occurrence of AUTH in a connection, or immediately following
33140 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33141 RCPT, DATA, and QUIT are counted.
33142
33143 You can control which hosts are subject to the limit set by
33144 &%smtp_accept_max_nonmail%& by setting
33145 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33146 the limit apply to all hosts. This option means that you can exclude any
33147 specific badly-behaved hosts that you have to live with.
33148
33149
33150
33151
33152 .section "The VRFY and EXPN commands" "SECID237"
33153 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33154 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33155 appropriate) in order to decide whether the command should be accepted or not.
33156 If no ACL is defined, the command is rejected.
33157
33158 .cindex "VRFY" "processing"
33159 When VRFY is accepted, it runs exactly the same code as when Exim is
33160 called with the &%-bv%& option.
33161
33162 .cindex "EXPN" "processing"
33163 When EXPN is accepted, a single-level expansion of the address is done.
33164 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33165 than a verification (the &%-bv%& option). If an unqualified local part is given
33166 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33167 of VRFY and EXPN commands are logged on the main and reject logs, and
33168 VRFY verification failures are logged on the main log for consistency with
33169 RCPT failures.
33170
33171
33172
33173 .section "The ETRN command" "SECTETRN"
33174 .cindex "ETRN" "processing"
33175 RFC 1985 describes an SMTP command called ETRN that is designed to
33176 overcome the security problems of the TURN command (which has fallen into
33177 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33178 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33179 should be accepted or not. If no ACL is defined, the command is rejected.
33180
33181 The ETRN command is concerned with &"releasing"& messages that are awaiting
33182 delivery to certain hosts. As Exim does not organize its message queue by host,
33183 the only form of ETRN that is supported by default is the one where the
33184 text starts with the &"#"& prefix, in which case the remainder of the text is
33185 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33186 the &%-R%& option to happen, with the remainder of the ETRN text as its
33187 argument. For example,
33188 .code
33189 ETRN #brigadoon
33190 .endd
33191 runs the command
33192 .code
33193 exim -R brigadoon
33194 .endd
33195 which causes a delivery attempt on all messages with undelivered addresses
33196 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33197 default), Exim prevents the simultaneous execution of more than one queue run
33198 for the same argument string as a result of an ETRN command. This stops
33199 a misbehaving client from starting more than one queue runner at once.
33200
33201 .cindex "hints database" "ETRN serialization"
33202 Exim implements the serialization by means of a hints database in which a
33203 record is written whenever a process is started by ETRN, and deleted when
33204 the process completes. However, Exim does not keep the SMTP session waiting for
33205 the ETRN process to complete. Once ETRN is accepted, the client is sent
33206 a &"success"& return code. Obviously there is scope for hints records to get
33207 left lying around if there is a system or program crash. To guard against this,
33208 Exim ignores any records that are more than six hours old.
33209
33210 .oindex "&%smtp_etrn_command%&"
33211 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33212 used. This specifies a command that is run whenever ETRN is received,
33213 whatever the form of its argument. For
33214 example:
33215 .code
33216 smtp_etrn_command = /etc/etrn_command $domain \
33217                     $sender_host_address
33218 .endd
33219 .vindex "&$domain$&"
33220 The string is split up into arguments which are independently expanded. The
33221 expansion variable &$domain$& is set to the argument of the ETRN command,
33222 and no syntax checking is done on the contents of this argument. Exim does not
33223 wait for the command to complete, so its status code is not checked. Exim runs
33224 under its own uid and gid when receiving incoming SMTP, so it is not possible
33225 for it to change them before running the command.
33226
33227
33228
33229 .section "Incoming local SMTP" "SECID238"
33230 .cindex "SMTP" "local incoming"
33231 Some user agents use SMTP to pass messages to their local MTA using the
33232 standard input and output, as opposed to passing the envelope on the command
33233 line and writing the message to the standard input. This is supported by the
33234 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33235 messages over TCP/IP (including the use of ACLs), except that the envelope
33236 sender given in a MAIL command is ignored unless the caller is trusted. In
33237 an ACL you can detect this form of SMTP input by testing for an empty host
33238 identification. It is common to have this as the first line in the ACL that
33239 runs for RCPT commands:
33240 .code
33241 accept hosts = :
33242 .endd
33243 This accepts SMTP messages from local processes without doing any other tests.
33244
33245
33246
33247 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33248 .cindex "SMTP" "batched outgoing"
33249 .cindex "batched SMTP output"
33250 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33251 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33252 be output in BSMTP format. No SMTP responses are possible for this form of
33253 delivery. All it is doing is using SMTP commands as a way of transmitting the
33254 envelope along with the message.
33255
33256 The message is written to the file or pipe preceded by the SMTP commands
33257 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33258 the message that start with a dot have an extra dot added. The SMTP command
33259 HELO is not normally used. If it is required, the &%message_prefix%& option
33260 can be used to specify it.
33261
33262 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33263 one recipient address at a time by default. However, you can arrange for them
33264 to handle several addresses at once by setting the &%batch_max%& option. When
33265 this is done for BSMTP, messages may contain multiple RCPT commands. See
33266 chapter &<<CHAPbatching>>& for more details.
33267
33268 .vindex "&$host$&"
33269 When one or more addresses are routed to a BSMTP transport by a router that
33270 sets up a host list, the name of the first host on the list is available to the
33271 transport in the variable &$host$&. Here is an example of such a transport and
33272 router:
33273 .code
33274 begin routers
33275 route_append:
33276   driver = manualroute
33277   transport = smtp_appendfile
33278   route_list = domain.example  batch.host.example
33279
33280 begin transports
33281 smtp_appendfile:
33282   driver = appendfile
33283   directory = /var/bsmtp/$host
33284   batch_max = 1000
33285   use_bsmtp
33286   user = exim
33287 .endd
33288 This causes messages addressed to &'domain.example'& to be written in BSMTP
33289 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33290 message (unless there are more than 1000 recipients).
33291
33292
33293
33294 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33295 .cindex "SMTP" "batched incoming"
33296 .cindex "batched SMTP input"
33297 The &%-bS%& command line option causes Exim to accept one or more messages by
33298 reading SMTP on the standard input, but to generate no responses. If the caller
33299 is trusted, the senders in the MAIL commands are believed; otherwise the
33300 sender is always the caller of Exim. Unqualified senders and receivers are not
33301 rejected (there seems little point) but instead just get qualified. HELO
33302 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33303 as NOOP; QUIT quits.
33304
33305 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33306 ACL is run in the same way as for non-SMTP local input.
33307
33308 If an error is detected while reading a message, including a missing &"."& at
33309 the end, Exim gives up immediately. It writes details of the error to the
33310 standard output in a stylized way that the calling program should be able to
33311 make some use of automatically, for example:
33312 .code
33313 554 Unexpected end of file
33314 Transaction started in line 10
33315 Error detected in line 14
33316 .endd
33317 It writes a more verbose version, for human consumption, to the standard error
33318 file, for example:
33319 .code
33320 An error was detected while processing a file of BSMTP input.
33321 The error message was:
33322
33323 501 '>' missing at end of address
33324
33325 The SMTP transaction started in line 10.
33326 The error was detected in line 12.
33327 The SMTP command at fault was:
33328
33329 rcpt to:<malformed@in.com.plete
33330
33331 1 previous message was successfully processed.
33332 The rest of the batch was abandoned.
33333 .endd
33334 The return code from Exim is zero only if there were no errors. It is 1 if some
33335 messages were accepted before an error was detected, and 2 if no messages were
33336 accepted.
33337 .ecindex IIDsmtpproc1
33338 .ecindex IIDsmtpproc2
33339
33340
33341
33342 . ////////////////////////////////////////////////////////////////////////////
33343 . ////////////////////////////////////////////////////////////////////////////
33344
33345 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33346          "Customizing messages"
33347 When a message fails to be delivered, or remains on the queue for more than a
33348 configured amount of time, Exim sends a message to the original sender, or
33349 to an alternative configured address. The text of these messages is built into
33350 the code of Exim, but it is possible to change it, either by adding a single
33351 string, or by replacing each of the paragraphs by text supplied in a file.
33352
33353 The &'From:'& and &'To:'& header lines are automatically generated; you can
33354 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33355 option. Exim also adds the line
33356 .code
33357 Auto-Submitted: auto-generated
33358 .endd
33359 to all warning and bounce messages,
33360
33361
33362 .section "Customizing bounce messages" "SECID239"
33363 .cindex "customizing" "bounce message"
33364 .cindex "bounce message" "customizing"
33365 If &%bounce_message_text%& is set, its contents are included in the default
33366 message immediately after &"This message was created automatically by mail
33367 delivery software."& The string is not expanded. It is not used if
33368 &%bounce_message_file%& is set.
33369
33370 When &%bounce_message_file%& is set, it must point to a template file for
33371 constructing error messages. The file consists of a series of text items,
33372 separated by lines consisting of exactly four asterisks. If the file cannot be
33373 opened, default text is used and a message is written to the main and panic
33374 logs. If any text item in the file is empty, default text is used for that
33375 item.
33376
33377 .vindex "&$bounce_recipient$&"
33378 .vindex "&$bounce_return_size_limit$&"
33379 Each item of text that is read from the file is expanded, and there are two
33380 expansion variables which can be of use here: &$bounce_recipient$& is set to
33381 the recipient of an error message while it is being created, and
33382 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33383 option, rounded to a whole number.
33384
33385 The items must appear in the file in the following order:
33386
33387 .ilist
33388 The first item is included in the headers, and should include at least a
33389 &'Subject:'& header. Exim does not check the syntax of these headers.
33390 .next
33391 The second item forms the start of the error message. After it, Exim lists the
33392 failing addresses with their error messages.
33393 .next
33394 The third item is used to introduce any text from pipe transports that is to be
33395 returned to the sender. It is omitted if there is no such text.
33396 .next
33397 The fourth item is used to introduce the copy of the message that is returned
33398 as part of the error report.
33399 .next
33400 The fifth item is added after the fourth one if the returned message is
33401 truncated because it is bigger than &%return_size_limit%&.
33402 .next
33403 The sixth item is added after the copy of the original message.
33404 .endlist
33405
33406 The default state (&%bounce_message_file%& unset) is equivalent to the
33407 following file, in which the sixth item is empty. The &'Subject:'& and some
33408 other lines have been split in order to fit them on the page:
33409 .code
33410 Subject: Mail delivery failed
33411   ${if eq{$sender_address}{$bounce_recipient}
33412   {: returning message to sender}}
33413 ****
33414 This message was created automatically by mail delivery software.
33415
33416 A message ${if eq{$sender_address}{$bounce_recipient}
33417   {that you sent }{sent by
33418
33419 <$sender_address>
33420
33421 }}could not be delivered to all of its recipients.
33422 This is a permanent error. The following address(es) failed:
33423 ****
33424 The following text was generated during the delivery attempt(s):
33425 ****
33426 ------ This is a copy of the message, including all the headers.
33427   ------
33428 ****
33429 ------ The body of the message is $message_size characters long;
33430   only the first
33431 ------ $bounce_return_size_limit or so are included here.
33432 ****
33433 .endd
33434 .section "Customizing warning messages" "SECTcustwarn"
33435 .cindex "customizing" "warning message"
33436 .cindex "warning of delay" "customizing the message"
33437 The option &%warn_message_file%& can be pointed at a template file for use when
33438 warnings about message delays are created. In this case there are only three
33439 text sections:
33440
33441 .ilist
33442 The first item is included in the headers, and should include at least a
33443 &'Subject:'& header. Exim does not check the syntax of these headers.
33444 .next
33445 The second item forms the start of the warning message. After it, Exim lists
33446 the delayed addresses.
33447 .next
33448 The third item then ends the message.
33449 .endlist
33450
33451 The default state is equivalent to the following file, except that some lines
33452 have been split here, in order to fit them on the page:
33453 .code
33454 Subject: Warning: message $message_exim_id delayed
33455   $warn_message_delay
33456 ****
33457 This message was created automatically by mail delivery software.
33458
33459 A message ${if eq{$sender_address}{$warn_message_recipients}
33460 {that you sent }{sent by
33461
33462 <$sender_address>
33463
33464 }}has not been delivered to all of its recipients after
33465 more than $warn_message_delay on the queue on $primary_hostname.
33466
33467 The message identifier is:     $message_exim_id
33468 The subject of the message is: $h_subject
33469 The date of the message is:    $h_date
33470
33471 The following address(es) have not yet been delivered:
33472 ****
33473 No action is required on your part. Delivery attempts will
33474 continue for some time, and this warning may be repeated at
33475 intervals if the message remains undelivered. Eventually the
33476 mail delivery software will give up, and when that happens,
33477 the message will be returned to you.
33478 .endd
33479 .vindex "&$warn_message_delay$&"
33480 .vindex "&$warn_message_recipients$&"
33481 However, in the default state the subject and date lines are omitted if no
33482 appropriate headers exist. During the expansion of this file,
33483 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33484 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33485 of recipients for the warning message. There may be more than one if there are
33486 multiple addresses with different &%errors_to%& settings on the routers that
33487 handled them.
33488
33489
33490
33491
33492 . ////////////////////////////////////////////////////////////////////////////
33493 . ////////////////////////////////////////////////////////////////////////////
33494
33495 .chapter "Some common configuration settings" "CHAPcomconreq"
33496 This chapter discusses some configuration settings that seem to be fairly
33497 common. More examples and discussion can be found in the Exim book.
33498
33499
33500
33501 .section "Sending mail to a smart host" "SECID240"
33502 .cindex "smart host" "example router"
33503 If you want to send all mail for non-local domains to a &"smart host"&, you
33504 should replace the default &(dnslookup)& router with a router which does the
33505 routing explicitly:
33506 .code
33507 send_to_smart_host:
33508   driver = manualroute
33509   route_list = !+local_domains smart.host.name
33510   transport = remote_smtp
33511 .endd
33512 You can use the smart host's IP address instead of the name if you wish.
33513 If you are using Exim only to submit messages to a smart host, and not for
33514 receiving incoming messages, you can arrange for it to do the submission
33515 synchronously by setting the &%mua_wrapper%& option (see chapter
33516 &<<CHAPnonqueueing>>&).
33517
33518
33519
33520
33521 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33522 .cindex "mailing lists"
33523 Exim can be used to run simple mailing lists, but for large and/or complicated
33524 requirements, the use of additional specialized mailing list software such as
33525 Majordomo or Mailman is recommended.
33526
33527 The &(redirect)& router can be used to handle mailing lists where each list
33528 is maintained in a separate file, which can therefore be managed by an
33529 independent manager. The &%domains%& router option can be used to run these
33530 lists in a separate domain from normal mail. For example:
33531 .code
33532 lists:
33533   driver = redirect
33534   domains = lists.example
33535   file = /usr/lists/$local_part
33536   forbid_pipe
33537   forbid_file
33538   errors_to = $local_part-request@lists.example
33539   no_more
33540 .endd
33541 This router is skipped for domains other than &'lists.example'&. For addresses
33542 in that domain, it looks for a file that matches the local part. If there is no
33543 such file, the router declines, but because &%no_more%& is set, no subsequent
33544 routers are tried, and so the whole delivery fails.
33545
33546 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33547 expanded into a file name or a pipe delivery, which is usually inappropriate in
33548 a mailing list.
33549
33550 .oindex "&%errors_to%&"
33551 The &%errors_to%& option specifies that any delivery errors caused by addresses
33552 taken from a mailing list are to be sent to the given address rather than the
33553 original sender of the message. However, before acting on this, Exim verifies
33554 the error address, and ignores it if verification fails.
33555
33556 For example, using the configuration above, mail sent to
33557 &'dicts@lists.example'& is passed on to those addresses contained in
33558 &_/usr/lists/dicts_&, with error reports directed to
33559 &'dicts-request@lists.example'&, provided that this address can be verified.
33560 There could be a file called &_/usr/lists/dicts-request_& containing
33561 the address(es) of this particular list's manager(s), but other approaches,
33562 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33563 or &%local_part_suffix%& options) to handle addresses of the form
33564 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33565
33566
33567
33568 .section "Syntax errors in mailing lists" "SECID241"
33569 .cindex "mailing lists" "syntax errors in"
33570 If an entry in redirection data contains a syntax error, Exim normally defers
33571 delivery of the original address. That means that a syntax error in a mailing
33572 list holds up all deliveries to the list. This may not be appropriate when a
33573 list is being maintained automatically from data supplied by users, and the
33574 addresses are not rigorously checked.
33575
33576 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33577 entries that fail to parse, noting the incident in the log. If in addition
33578 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33579 whenever a broken address is skipped. It is usually appropriate to set
33580 &%syntax_errors_to%& to the same address as &%errors_to%&.
33581
33582
33583
33584 .section "Re-expansion of mailing lists" "SECID242"
33585 .cindex "mailing lists" "re-expansion of"
33586 Exim remembers every individual address to which a message has been delivered,
33587 in order to avoid duplication, but it normally stores only the original
33588 recipient addresses with a message. If all the deliveries to a mailing list
33589 cannot be done at the first attempt, the mailing list is re-expanded when the
33590 delivery is next tried. This means that alterations to the list are taken into
33591 account at each delivery attempt, so addresses that have been added to
33592 the list since the message arrived will therefore receive a copy of the
33593 message, even though it pre-dates their subscription.
33594
33595 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33596 on the &(redirect)& router. If this is done, any addresses generated by the
33597 router that fail to deliver at the first attempt are added to the message as
33598 &"top level"& addresses, and the parent address that generated them is marked
33599 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33600 subsequent delivery attempts. The disadvantage of this is that if any of the
33601 failing addresses are incorrect, correcting them in the file has no effect on
33602 pre-existing messages.
33603
33604 The original top-level address is remembered with each of the generated
33605 addresses, and is output in any log messages. However, any intermediate parent
33606 addresses are not recorded. This makes a difference to the log only if the
33607 &%all_parents%& selector is set, but for mailing lists there is normally only
33608 one level of expansion anyway.
33609
33610
33611
33612 .section "Closed mailing lists" "SECID243"
33613 .cindex "mailing lists" "closed"
33614 The examples so far have assumed open mailing lists, to which anybody may
33615 send mail. It is also possible to set up closed lists, where mail is accepted
33616 from specified senders only. This is done by making use of the generic
33617 &%senders%& option to restrict the router that handles the list.
33618
33619 The following example uses the same file as a list of recipients and as a list
33620 of permitted senders. It requires three routers:
33621 .code
33622 lists_request:
33623   driver = redirect
33624   domains = lists.example
33625   local_part_suffix = -request
33626   file = /usr/lists/$local_part$local_part_suffix
33627   no_more
33628
33629 lists_post:
33630   driver = redirect
33631   domains = lists.example
33632   senders = ${if exists {/usr/lists/$local_part}\
33633              {lsearch;/usr/lists/$local_part}{*}}
33634   file = /usr/lists/$local_part
33635   forbid_pipe
33636   forbid_file
33637   errors_to = $local_part-request@lists.example
33638   no_more
33639
33640 lists_closed:
33641   driver = redirect
33642   domains = lists.example
33643   allow_fail
33644   data = :fail: $local_part@lists.example is a closed mailing list
33645 .endd
33646 All three routers have the same &%domains%& setting, so for any other domains,
33647 they are all skipped. The first router runs only if the local part ends in
33648 &%-request%&. It handles messages to the list manager(s) by means of an open
33649 mailing list.
33650
33651 The second router runs only if the &%senders%& precondition is satisfied. It
33652 checks for the existence of a list that corresponds to the local part, and then
33653 checks that the sender is on the list by means of a linear search. It is
33654 necessary to check for the existence of the file before trying to search it,
33655 because otherwise Exim thinks there is a configuration error. If the file does
33656 not exist, the expansion of &%senders%& is *, which matches all senders. This
33657 means that the router runs, but because there is no list, declines, and
33658 &%no_more%& ensures that no further routers are run. The address fails with an
33659 &"unrouteable address"& error.
33660
33661 The third router runs only if the second router is skipped, which happens when
33662 a mailing list exists, but the sender is not on it. This router forcibly fails
33663 the address, giving a suitable error message.
33664
33665
33666
33667
33668 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33669 .cindex "VERP"
33670 .cindex "Variable Envelope Return Paths"
33671 .cindex "envelope sender"
33672 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33673 are a way of helping mailing list administrators discover which subscription
33674 address is the cause of a particular delivery failure. The idea is to encode
33675 the original recipient address in the outgoing envelope sender address, so that
33676 if the message is forwarded by another host and then subsequently bounces, the
33677 original recipient can be extracted from the recipient address of the bounce.
33678
33679 .oindex &%errors_to%&
33680 .oindex &%return_path%&
33681 Envelope sender addresses can be modified by Exim using two different
33682 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33683 list examples), or the &%return_path%& option on a transport. The second of
33684 these is effective only if the message is successfully delivered to another
33685 host; it is not used for errors detected on the local host (see the description
33686 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33687 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33688 .code
33689 verp_smtp:
33690   driver = smtp
33691   max_rcpt = 1
33692   return_path = \
33693     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33694       {$1-request+$local_part=$domain@your.dom.example}fail}
33695 .endd
33696 This has the effect of rewriting the return path (envelope sender) on outgoing
33697 SMTP messages, if the local part of the original return path ends in
33698 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33699 local part and domain of the recipient into the return path. Suppose, for
33700 example, that a message whose return path has been set to
33701 &'somelist-request@your.dom.example'& is sent to
33702 &'subscriber@other.dom.example'&. In the transport, the return path is
33703 rewritten as
33704 .code
33705 somelist-request+subscriber=other.dom.example@your.dom.example
33706 .endd
33707 .vindex "&$local_part$&"
33708 For this to work, you must tell Exim to send multiple copies of messages that
33709 have more than one recipient, so that each copy has just one recipient. This is
33710 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33711 might be sent to several different recipients in the same domain, in which case
33712 &$local_part$& is not available in the transport, because it is not unique.
33713
33714 Unless your host is doing nothing but mailing list deliveries, you should
33715 probably use a separate transport for the VERP deliveries, so as not to use
33716 extra resources in making one-per-recipient copies for other deliveries. This
33717 can easily be done by expanding the &%transport%& option in the router:
33718 .code
33719 dnslookup:
33720   driver = dnslookup
33721   domains = ! +local_domains
33722   transport = \
33723     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33724       {verp_smtp}{remote_smtp}}
33725   no_more
33726 .endd
33727 If you want to change the return path using &%errors_to%& in a router instead
33728 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33729 routers that handle mailing list addresses. This will ensure that all delivery
33730 errors, including those detected on the local host, are sent to the VERP
33731 address.
33732
33733 On a host that does no local deliveries and has no manual routing, only the
33734 &(dnslookup)& router needs to be changed. A special transport is not needed for
33735 SMTP deliveries. Every mailing list recipient has its own return path value,
33736 and so Exim must hand them to the transport one at a time. Here is an example
33737 of a &(dnslookup)& router that implements VERP:
33738 .code
33739 verp_dnslookup:
33740   driver = dnslookup
33741   domains = ! +local_domains
33742   transport = remote_smtp
33743   errors_to = \
33744     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33745      {$1-request+$local_part=$domain@your.dom.example}fail}
33746   no_more
33747 .endd
33748 Before you start sending out messages with VERPed return paths, you must also
33749 configure Exim to accept the bounce messages that come back to those paths.
33750 Typically this is done by setting a &%local_part_suffix%& option for a
33751 router, and using this to route the messages to wherever you want to handle
33752 them.
33753
33754 The overhead incurred in using VERP depends very much on the size of the
33755 message, the number of recipient addresses that resolve to the same remote
33756 host, and the speed of the connection over which the message is being sent. If
33757 a lot of addresses resolve to the same host and the connection is slow, sending
33758 a separate copy of the message for each address may take substantially longer
33759 than sending a single copy with many recipients (for which VERP cannot be
33760 used).
33761
33762
33763
33764
33765
33766
33767 .section "Virtual domains" "SECTvirtualdomains"
33768 .cindex "virtual domains"
33769 .cindex "domain" "virtual"
33770 The phrase &'virtual domain'& is unfortunately used with two rather different
33771 meanings:
33772
33773 .ilist
33774 A domain for which there are no real mailboxes; all valid local parts are
33775 aliases for other email addresses. Common examples are organizational
33776 top-level domains and &"vanity"& domains.
33777 .next
33778 One of a number of independent domains that are all handled by the same host,
33779 with mailboxes on that host, but where the mailbox owners do not necessarily
33780 have login accounts on that host.
33781 .endlist
33782
33783 The first usage is probably more common, and does seem more &"virtual"& than
33784 the second. This kind of domain can be handled in Exim with a straightforward
33785 aliasing router. One approach is to create a separate alias file for each
33786 virtual domain. Exim can test for the existence of the alias file to determine
33787 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33788 to a router of this form:
33789 .code
33790 virtual:
33791   driver = redirect
33792   domains = dsearch;/etc/mail/virtual
33793   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33794   no_more
33795 .endd
33796 The &%domains%& option specifies that the router is to be skipped, unless there
33797 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33798 domain that is being processed. When the router runs, it looks up the local
33799 part in the file to find a new address (or list of addresses). The &%no_more%&
33800 setting ensures that if the lookup fails (leading to &%data%& being an empty
33801 string), Exim gives up on the address without trying any subsequent routers.
33802
33803 This one router can handle all the virtual domains because the alias file names
33804 follow a fixed pattern. Permissions can be arranged so that appropriate people
33805 can edit the different alias files. A successful aliasing operation results in
33806 a new envelope recipient address, which is then routed from scratch.
33807
33808 The other kind of &"virtual"& domain can also be handled in a straightforward
33809 way. One approach is to create a file for each domain containing a list of
33810 valid local parts, and use it in a router like this:
33811 .code
33812 my_domains:
33813   driver = accept
33814   domains = dsearch;/etc/mail/domains
33815   local_parts = lsearch;/etc/mail/domains/$domain
33816   transport = my_mailboxes
33817 .endd
33818 The address is accepted if there is a file for the domain, and the local part
33819 can be found in the file. The &%domains%& option is used to check for the
33820 file's existence because &%domains%& is tested before the &%local_parts%&
33821 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33822 because that option is tested after &%local_parts%&. The transport is as
33823 follows:
33824 .code
33825 my_mailboxes:
33826   driver = appendfile
33827   file = /var/mail/$domain/$local_part
33828   user = mail
33829 .endd
33830 This uses a directory of mailboxes for each domain. The &%user%& setting is
33831 required, to specify which uid is to be used for writing to the mailboxes.
33832
33833 The configuration shown here is just one example of how you might support this
33834 requirement. There are many other ways this kind of configuration can be set
33835 up, for example, by using a database instead of separate files to hold all the
33836 information about the domains.
33837
33838
33839
33840 .section "Multiple user mailboxes" "SECTmulbox"
33841 .cindex "multiple mailboxes"
33842 .cindex "mailbox" "multiple"
33843 .cindex "local part" "prefix"
33844 .cindex "local part" "suffix"
33845 Heavy email users often want to operate with multiple mailboxes, into which
33846 incoming mail is automatically sorted. A popular way of handling this is to
33847 allow users to use multiple sender addresses, so that replies can easily be
33848 identified. Users are permitted to add prefixes or suffixes to their local
33849 parts for this purpose. The wildcard facility of the generic router options
33850 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33851 example, consider this router:
33852 .code
33853 userforward:
33854   driver = redirect
33855   check_local_user
33856   file = $home/.forward
33857   local_part_suffix = -*
33858   local_part_suffix_optional
33859   allow_filter
33860 .endd
33861 .vindex "&$local_part_suffix$&"
33862 It runs a user's &_.forward_& file for all local parts of the form
33863 &'username-*'&. Within the filter file the user can distinguish different
33864 cases by testing the variable &$local_part_suffix$&. For example:
33865 .code
33866 if $local_part_suffix contains -special then
33867 save /home/$local_part/Mail/special
33868 endif
33869 .endd
33870 If the filter file does not exist, or does not deal with such addresses, they
33871 fall through to subsequent routers, and, assuming no subsequent use of the
33872 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33873 control over which suffixes are valid.
33874
33875 Alternatively, a suffix can be used to trigger the use of a different
33876 &_.forward_& file &-- which is the way a similar facility is implemented in
33877 another MTA:
33878 .code
33879 userforward:
33880   driver = redirect
33881   check_local_user
33882   file = $home/.forward$local_part_suffix
33883   local_part_suffix = -*
33884   local_part_suffix_optional
33885   allow_filter
33886 .endd
33887 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33888 example, &_.forward-special_& is used. Once again, if the appropriate file
33889 does not exist, or does not deal with the address, it is passed on to
33890 subsequent routers, which could, if required, look for an unqualified
33891 &_.forward_& file to use as a default.
33892
33893
33894
33895 .section "Simplified vacation processing" "SECID244"
33896 .cindex "vacation processing"
33897 The traditional way of running the &'vacation'& program is for a user to set up
33898 a pipe command in a &_.forward_& file
33899 (see section &<<SECTspecitredli>>& for syntax details).
33900 This is prone to error by inexperienced users. There are two features of Exim
33901 that can be used to make this process simpler for users:
33902
33903 .ilist
33904 A local part prefix such as &"vacation-"& can be specified on a router which
33905 can cause the message to be delivered directly to the &'vacation'& program, or
33906 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33907 &_.forward_& file are then much simpler. For example:
33908 .code
33909 spqr, vacation-spqr
33910 .endd
33911 .next
33912 The &%require_files%& generic router option can be used to trigger a
33913 vacation delivery by checking for the existence of a certain file in the
33914 user's home directory. The &%unseen%& generic option should also be used, to
33915 ensure that the original delivery also proceeds. In this case, all the user has
33916 to do is to create a file called, say, &_.vacation_&, containing a vacation
33917 message.
33918 .endlist
33919
33920 Another advantage of both these methods is that they both work even when the
33921 use of arbitrary pipes by users is locked out.
33922
33923
33924
33925 .section "Taking copies of mail" "SECID245"
33926 .cindex "message" "copying every"
33927 Some installations have policies that require archive copies of all messages to
33928 be made. A single copy of each message can easily be taken by an appropriate
33929 command in a system filter, which could, for example, use a different file for
33930 each day's messages.
33931
33932 There is also a shadow transport mechanism that can be used to take copies of
33933 messages that are successfully delivered by local transports, one copy per
33934 delivery. This could be used, &'inter alia'&, to implement automatic
33935 notification of delivery by sites that insist on doing such things.
33936
33937
33938
33939 .section "Intermittently connected hosts" "SECID246"
33940 .cindex "intermittently connected hosts"
33941 It has become quite common (because it is cheaper) for hosts to connect to the
33942 Internet periodically rather than remain connected all the time. The normal
33943 arrangement is that mail for such hosts accumulates on a system that is
33944 permanently connected.
33945
33946 Exim was designed for use on permanently connected hosts, and so it is not
33947 particularly well-suited to use in an intermittently connected environment.
33948 Nevertheless there are some features that can be used.
33949
33950
33951 .section "Exim on the upstream server host" "SECID247"
33952 It is tempting to arrange for incoming mail for the intermittently connected
33953 host to remain on Exim's queue until the client connects. However, this
33954 approach does not scale very well. Two different kinds of waiting message are
33955 being mixed up in the same queue &-- those that cannot be delivered because of
33956 some temporary problem, and those that are waiting for their destination host
33957 to connect. This makes it hard to manage the queue, as well as wasting
33958 resources, because each queue runner scans the entire queue.
33959
33960 A better approach is to separate off those messages that are waiting for an
33961 intermittently connected host. This can be done by delivering these messages
33962 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33963 format, from where they are transmitted by other software when their
33964 destination connects. This makes it easy to collect all the mail for one host
33965 in a single directory, and to apply local timeout rules on a per-message basis
33966 if required.
33967
33968 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33969 you are doing this, you should configure Exim with a long retry period for the
33970 intermittent host. For example:
33971 .code
33972 cheshire.wonderland.fict.example    *   F,5d,24h
33973 .endd
33974 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33975 which messages it has queued up for that host. Once the intermittent host comes
33976 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33977 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33978 causes all the queued up messages to be delivered, often down a single SMTP
33979 connection. While the host remains connected, any new messages get delivered
33980 immediately.
33981
33982 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33983 issued with a different IP address each time it connects, Exim's retry
33984 mechanisms on the holding host get confused, because the IP address is normally
33985 used as part of the key string for holding retry information. This can be
33986 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33987 Since this has disadvantages for permanently connected hosts, it is best to
33988 arrange a separate transport for the intermittently connected ones.
33989
33990
33991
33992 .section "Exim on the intermittently connected client host" "SECID248"
33993 The value of &%smtp_accept_queue_per_connection%& should probably be
33994 increased, or even set to zero (that is, disabled) on the intermittently
33995 connected host, so that all incoming messages down a single connection get
33996 delivered immediately.
33997
33998 .cindex "SMTP" "passed connection"
33999 .cindex "SMTP" "multiple deliveries"
34000 .cindex "multiple SMTP deliveries"
34001 Mail waiting to be sent from an intermittently connected host will probably
34002 not have been routed, because without a connection DNS lookups are not
34003 possible. This means that if a normal queue run is done at connection time,
34004 each message is likely to be sent in a separate SMTP session. This can be
34005 avoided by starting the queue run with a command line option beginning with
34006 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34007 first pass, routing is done but no deliveries take place. The second pass is a
34008 normal queue run; since all the messages have been previously routed, those
34009 destined for the same host are likely to get sent as multiple deliveries in a
34010 single SMTP connection.
34011
34012
34013
34014 . ////////////////////////////////////////////////////////////////////////////
34015 . ////////////////////////////////////////////////////////////////////////////
34016
34017 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34018          "Exim as a non-queueing client"
34019 .cindex "client, non-queueing"
34020 .cindex "smart host" "suppressing queueing"
34021 On a personal computer, it is a common requirement for all
34022 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34023 configured to operate that way, for all the popular operating systems.
34024 However, there are some MUAs for Unix-like systems that cannot be so
34025 configured: they submit messages using the command line interface of
34026 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34027 messages this way.
34028
34029 If the personal computer runs continuously, there is no problem, because it can
34030 run a conventional MTA that handles delivery to the smart host, and deal with
34031 any delays via its queueing mechanism. However, if the computer does not run
34032 continuously or runs different operating systems at different times, queueing
34033 email is not desirable.
34034
34035 There is therefore a requirement for something that can provide the
34036 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34037 any queueing or retrying facilities. Furthermore, the delivery to the smart
34038 host should be synchronous, so that if it fails, the sending MUA is immediately
34039 informed. In other words, we want something that extends an MUA that submits
34040 to a local MTA via the command line so that it behaves like one that submits
34041 to a remote smart host using TCP/SMTP.
34042
34043 There are a number of applications (for example, there is one called &'ssmtp'&)
34044 that do this job. However, people have found them to be lacking in various
34045 ways. For instance, you might want to allow aliasing and forwarding to be done
34046 before sending a message to the smart host.
34047
34048 Exim already had the necessary infrastructure for doing this job. Just a few
34049 tweaks were needed to make it behave as required, though it is somewhat of an
34050 overkill to use a fully-featured MTA for this purpose.
34051
34052 .oindex "&%mua_wrapper%&"
34053 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34054 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34055 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34056 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34057 compatible router and transport configuration. Typically there will be just one
34058 router and one transport, sending everything to a smart host.
34059
34060 When run in MUA wrapping mode, the behaviour of Exim changes in the
34061 following ways:
34062
34063 .ilist
34064 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34065 In other words, the only way to submit messages is via the command line.
34066 .next
34067 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34068 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34069 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34070 does not finish until the delivery attempt is complete. If the delivery is
34071 successful, a zero return code is given.
34072 .next
34073 Address redirection is permitted, but the final routing for all addresses must
34074 be to the same remote transport, and to the same list of hosts. Furthermore,
34075 the return address (envelope sender) must be the same for all recipients, as
34076 must any added or deleted header lines. In other words, it must be possible to
34077 deliver the message in a single SMTP transaction, however many recipients there
34078 are.
34079 .next
34080 If these conditions are not met, or if routing any address results in a
34081 failure or defer status, or if Exim is unable to deliver all the recipients
34082 successfully to one of the smart hosts, delivery of the entire message fails.
34083 .next
34084 Because no queueing is allowed, all failures are treated as permanent; there
34085 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34086 smart host. Furthermore, because only a single yes/no response can be given to
34087 the caller, it is not possible to deliver to some recipients and not others. If
34088 there is an error (temporary or permanent) for any recipient, all are failed.
34089 .next
34090 If more than one smart host is listed, Exim will try another host after a
34091 connection failure or a timeout, in the normal way. However, if this kind of
34092 failure happens for all the hosts, the delivery fails.
34093 .next
34094 When delivery fails, an error message is written to the standard error stream
34095 (as well as to Exim's log), and Exim exits to the caller with a return code
34096 value 1. The message is expunged from Exim's spool files. No bounce messages
34097 are ever generated.
34098 .next
34099 No retry data is maintained, and any retry rules are ignored.
34100 .next
34101 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34102 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34103 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34104 .endlist
34105
34106 The overall effect is that Exim makes a single synchronous attempt to deliver
34107 the message, failing if there is any kind of problem. Because no local
34108 deliveries are done and no daemon can be run, Exim does not need root
34109 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34110 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34111 the advantages and disadvantages of running without root privilege.
34112
34113
34114
34115
34116 . ////////////////////////////////////////////////////////////////////////////
34117 . ////////////////////////////////////////////////////////////////////////////
34118
34119 .chapter "Log files" "CHAPlog"
34120 .scindex IIDloggen "log" "general description"
34121 .cindex "log" "types of"
34122 Exim writes three different logs, referred to as the main log, the reject log,
34123 and the panic log:
34124
34125 .ilist
34126 .cindex "main log"
34127 The main log records the arrival of each message and each delivery in a single
34128 line in each case. The format is as compact as possible, in an attempt to keep
34129 down the size of log files. Two-character flag sequences make it easy to pick
34130 out these lines. A number of other events are recorded in the main log. Some of
34131 them are optional, in which case the &%log_selector%& option controls whether
34132 they are included or not. A Perl script called &'eximstats'&, which does simple
34133 analysis of main log files, is provided in the Exim distribution (see section
34134 &<<SECTmailstat>>&).
34135 .next
34136 .cindex "reject log"
34137 The reject log records information from messages that are rejected as a result
34138 of a configuration option (that is, for policy reasons).
34139 The first line of each rejection is a copy of the line that is also written to
34140 the main log. Then, if the message's header has been read at the time the log
34141 is written, its contents are written to this log. Only the original header
34142 lines are available; header lines added by ACLs are not logged. You can use the
34143 reject log to check that your policy controls are working correctly; on a busy
34144 host this may be easier than scanning the main log for rejection messages. You
34145 can suppress the writing of the reject log by setting &%write_rejectlog%&
34146 false.
34147 .next
34148 .cindex "panic log"
34149 .cindex "system log"
34150 When certain serious errors occur, Exim writes entries to its panic log. If the
34151 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34152 are usually written to the main log as well, but can get lost amid the mass of
34153 other entries. The panic log should be empty under normal circumstances. It is
34154 therefore a good idea to check it (or to have a &'cron'& script check it)
34155 regularly, in order to become aware of any problems. When Exim cannot open its
34156 panic log, it tries as a last resort to write to the system log (syslog). This
34157 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34158 message itself is written at priority LOG_CRIT.
34159 .endlist
34160
34161 Every log line starts with a timestamp, in the format shown in the following
34162 example. Note that many of the examples shown in this chapter are line-wrapped.
34163 In the log file, this would be all on one line:
34164 .code
34165 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34166   by QUIT
34167 .endd
34168 By default, the timestamps are in the local timezone. There are two
34169 ways of changing this:
34170
34171 .ilist
34172 You can set the &%timezone%& option to a different time zone; in particular, if
34173 you set
34174 .code
34175 timezone = UTC
34176 .endd
34177 the timestamps will be in UTC (aka GMT).
34178 .next
34179 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34180 example:
34181 .code
34182 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34183 .endd
34184 .endlist
34185
34186 .cindex "log" "process ids in"
34187 .cindex "pid (process id)" "in log lines"
34188 Exim does not include its process id in log lines by default, but you can
34189 request that it does so by specifying the &`pid`& log selector (see section
34190 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34191 brackets, immediately after the time and date.
34192
34193
34194
34195
34196 .section "Where the logs are written" "SECTwhelogwri"
34197 .cindex "log" "destination"
34198 .cindex "log" "to file"
34199 .cindex "log" "to syslog"
34200 .cindex "syslog"
34201 The logs may be written to local files, or to syslog, or both. However, it
34202 should be noted that many syslog implementations use UDP as a transport, and
34203 are therefore unreliable in the sense that messages are not guaranteed to
34204 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34205 It has also been reported that on large log files (tens of megabytes) you may
34206 need to tweak syslog to prevent it syncing the file with each write &-- on
34207 Linux this has been seen to make syslog take 90% plus of CPU time.
34208
34209 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34210 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34211 configuration. This latter string is expanded, so it can contain, for example,
34212 references to the host name:
34213 .code
34214 log_file_path = /var/log/$primary_hostname/exim_%slog
34215 .endd
34216 It is generally advisable, however, to set the string in &_Local/Makefile_&
34217 rather than at run time, because then the setting is available right from the
34218 start of Exim's execution. Otherwise, if there's something it wants to log
34219 before it has read the configuration file (for example, an error in the
34220 configuration file) it will not use the path you want, and may not be able to
34221 log at all.
34222
34223 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34224 list, currently limited to at most two items. This is one option where the
34225 facility for changing a list separator may not be used. The list must always be
34226 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34227 otherwise the item must either be an absolute path, containing &`%s`& at the
34228 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34229 implying the use of a default path.
34230
34231 When Exim encounters an empty item in the list, it searches the list defined by
34232 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34233 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34234 mean &"use the path specified at build time"&. It no such item exists, log
34235 files are written in the &_log_& subdirectory of the spool directory. This is
34236 equivalent to the setting:
34237 .code
34238 log_file_path = $spool_directory/log/%slog
34239 .endd
34240 If you do not specify anything at build time or run time, that is where the
34241 logs are written.
34242
34243 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34244 are in use &-- see section &<<SECTdatlogfil>>& below.
34245
34246 Here are some examples of possible settings:
34247 .display
34248 &`LOG_FILE_PATH=syslog                    `& syslog only
34249 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34250 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34251 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34252 .endd
34253 If there are more than two paths in the list, the first is used and a panic
34254 error is logged.
34255
34256
34257
34258 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34259 .cindex "log" "cycling local files"
34260 .cindex "cycling logs"
34261 .cindex "&'exicyclog'&"
34262 .cindex "log" "local files; writing to"
34263 Some operating systems provide centralized and standardized methods for cycling
34264 log files. For those that do not, a utility script called &'exicyclog'& is
34265 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34266 main and reject logs each time it is called. The maximum number of old logs to
34267 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34268
34269 An Exim delivery process opens the main log when it first needs to write to it,
34270 and it keeps the file open in case subsequent entries are required &-- for
34271 example, if a number of different deliveries are being done for the same
34272 message. However, remote SMTP deliveries can take a long time, and this means
34273 that the file may be kept open long after it is renamed if &'exicyclog'& or
34274 something similar is being used to rename log files on a regular basis. To
34275 ensure that a switch of log files is noticed as soon as possible, Exim calls
34276 &[stat()]& on the main log's name before reusing an open file, and if the file
34277 does not exist, or its inode has changed, the old file is closed and Exim
34278 tries to open the main log from scratch. Thus, an old log file may remain open
34279 for quite some time, but no Exim processes should write to it once it has been
34280 renamed.
34281
34282
34283
34284 .section "Datestamped log files" "SECTdatlogfil"
34285 .cindex "log" "datestamped files"
34286 Instead of cycling the main and reject log files by renaming them
34287 periodically, some sites like to use files whose names contain a datestamp,
34288 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34289 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34290 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34291 point where the datestamp is required. For example:
34292 .code
34293 log_file_path = /var/spool/exim/log/%slog-%D
34294 log_file_path = /var/log/exim-%s-%D.log
34295 log_file_path = /var/spool/exim/log/%D-%slog
34296 log_file_path = /var/log/exim/%s.%M
34297 .endd
34298 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34299 examples of names generated by the above examples:
34300 .code
34301 /var/spool/exim/log/mainlog-20021225
34302 /var/log/exim-reject-20021225.log
34303 /var/spool/exim/log/20021225-mainlog
34304 /var/log/exim/main.200212
34305 .endd
34306 When this form of log file is specified, Exim automatically switches to new
34307 files at midnight. It does not make any attempt to compress old logs; you
34308 will need to write your own script if you require this. You should not
34309 run &'exicyclog'& with this form of logging.
34310
34311 The location of the panic log is also determined by &%log_file_path%&, but it
34312 is not datestamped, because rotation of the panic log does not make sense.
34313 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34314 the string. In addition, if it immediately follows a slash, a following
34315 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34316 character is removed. Thus, the four examples above would give these panic
34317 log names:
34318 .code
34319 /var/spool/exim/log/paniclog
34320 /var/log/exim-panic.log
34321 /var/spool/exim/log/paniclog
34322 /var/log/exim/panic
34323 .endd
34324
34325
34326 .section "Logging to syslog" "SECID249"
34327 .cindex "log" "syslog; writing to"
34328 The use of syslog does not change what Exim logs or the format of its messages,
34329 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34330 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34331 that, the same strings are written to syslog as to log files. The syslog
34332 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34333 by default, but you can change these by setting the &%syslog_facility%& and
34334 &%syslog_processname%& options, respectively. If Exim was compiled with
34335 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34336 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34337 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34338 the time and host name to each line.
34339 The three log streams are mapped onto syslog priorities as follows:
34340
34341 .ilist
34342 &'mainlog'& is mapped to LOG_INFO
34343 .next
34344 &'rejectlog'& is mapped to LOG_NOTICE
34345 .next
34346 &'paniclog'& is mapped to LOG_ALERT
34347 .endlist
34348
34349 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34350 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34351 these are routed by syslog to the same place. You can suppress this duplication
34352 by setting &%syslog_duplication%& false.
34353
34354 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34355 entries contain multiple lines when headers are included. To cope with both
34356 these cases, entries written to syslog are split into separate &[syslog()]&
34357 calls at each internal newline, and also after a maximum of
34358 870 data characters. (This allows for a total syslog line length of 1024, when
34359 additions such as timestamps are added.) If you are running a syslog
34360 replacement that can handle lines longer than the 1024 characters allowed by
34361 RFC 3164, you should set
34362 .code
34363 SYSLOG_LONG_LINES=yes
34364 .endd
34365 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34366 lines, but it still splits at internal newlines in &'reject'& log entries.
34367
34368 To make it easy to re-assemble split lines later, each component of a split
34369 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34370 where <&'n'&> is the component number and <&'m'&> is the total number of
34371 components in the entry. The / delimiter is used when the line was split
34372 because it was too long; if it was split because of an internal newline, the \
34373 delimiter is used. For example, supposing the length limit to be 50 instead of
34374 870, the following would be the result of a typical rejection message to
34375 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34376 name, and pid as added by syslog:
34377 .code
34378 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34379 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34380 [3/5]  when scanning for sender: missing or malformed lo
34381 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34382 [5/5] mple>)
34383 .endd
34384 The same error might cause the following lines to be written to &"rejectlog"&
34385 (LOG_NOTICE):
34386 .code
34387 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34388 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34389 [3/18] er when scanning for sender: missing or malformed
34390 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34391 [5\18] .example>)
34392 [6\18] Recipients: ph10@some.domain.cam.example
34393 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34394 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34395 [9\18]        id 16RdAL-0006pc-00
34396 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34397 [11\18] 09:43 +0100
34398 [12\18] F From: <>
34399 [13\18]   Subject: this is a test header
34400 [18\18]   X-something: this is another header
34401 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34402 [16\18] le>
34403 [17\18] B Bcc:
34404 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34405 .endd
34406 Log lines that are neither too long nor contain newlines are written to syslog
34407 without modification.
34408
34409 If only syslog is being used, the Exim monitor is unable to provide a log tail
34410 display, unless syslog is routing &'mainlog'& to a file on the local host and
34411 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34412 where it is.
34413
34414
34415
34416 .section "Log line flags" "SECID250"
34417 One line is written to the main log for each message received, and for each
34418 successful, unsuccessful, and delayed delivery. These lines can readily be
34419 picked out by the distinctive two-character flags that immediately follow the
34420 timestamp. The flags are:
34421 .display
34422 &`<=`&     message arrival
34423 &`=>`&     normal message delivery
34424 &`->`&     additional address in same delivery
34425 &`>>`&     cutthrough message delivery
34426 &`*>`&     delivery suppressed by &%-N%&
34427 &`**`&     delivery failed; address bounced
34428 &`==`&     delivery deferred; temporary problem
34429 .endd
34430
34431
34432 .section "Logging message reception" "SECID251"
34433 .cindex "log" "reception line"
34434 The format of the single-line entry in the main log that is written for every
34435 message received is shown in the basic example below, which is split over
34436 several lines in order to fit it on the page:
34437 .code
34438 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34439   H=mailer.fict.example [192.168.123.123] U=exim
34440   P=smtp S=5678 id=<incoming message id>
34441 .endd
34442 The address immediately following &"<="& is the envelope sender address. A
34443 bounce message is shown with the sender address &"<>"&, and if it is locally
34444 generated, this is followed by an item of the form
34445 .code
34446 R=<message id>
34447 .endd
34448 which is a reference to the message that caused the bounce to be sent.
34449
34450 .cindex "HELO"
34451 .cindex "EHLO"
34452 For messages from other hosts, the H and U fields identify the remote host and
34453 record the RFC 1413 identity of the user that sent the message, if one was
34454 received. The number given in square brackets is the IP address of the sending
34455 host. If there is a single, unparenthesized  host name in the H field, as
34456 above, it has been verified to correspond to the IP address (see the
34457 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34458 by the remote host in the SMTP HELO or EHLO command, and has not been
34459 verified. If verification yields a different name to that given for HELO or
34460 EHLO, the verified name appears first, followed by the HELO or EHLO
34461 name in parentheses.
34462
34463 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34464 without brackets, in the HELO or EHLO command, leading to entries in
34465 the log containing text like these examples:
34466 .code
34467 H=(10.21.32.43) [192.168.8.34]
34468 H=([10.21.32.43]) [192.168.8.34]
34469 .endd
34470 This can be confusing. Only the final address in square brackets can be relied
34471 on.
34472
34473 For locally generated messages (that is, messages not received over TCP/IP),
34474 the H field is omitted, and the U field contains the login name of the caller
34475 of Exim.
34476
34477 .cindex "authentication" "logging"
34478 .cindex "AUTH" "logging"
34479 For all messages, the P field specifies the protocol used to receive the
34480 message. This is the value that is stored in &$received_protocol$&. In the case
34481 of incoming SMTP messages, the value indicates whether or not any SMTP
34482 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34483 session was encrypted, there is an additional X field that records the cipher
34484 suite that was used.
34485
34486 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34487 hosts that have authenticated themselves using the SMTP AUTH command. The first
34488 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34489 there is an additional item A= followed by the name of the authenticator that
34490 was used. If an authenticated identification was set up by the authenticator's
34491 &%server_set_id%& option, this is logged too, separated by a colon from the
34492 authenticator name.
34493
34494 .cindex "size" "of message"
34495 The id field records the existing message id, if present. The size of the
34496 received message is given by the S field. When the message is delivered,
34497 headers may be removed or added, so that the size of delivered copies of the
34498 message may not correspond with this value (and indeed may be different to each
34499 other).
34500
34501 The &%log_selector%& option can be used to request the logging of additional
34502 data when a message is received. See section &<<SECTlogselector>>& below.
34503
34504
34505
34506 .section "Logging deliveries" "SECID252"
34507 .cindex "log" "delivery line"
34508 The format of the single-line entry in the main log that is written for every
34509 delivery is shown in one of the examples below, for local and remote
34510 deliveries, respectively. Each example has been split into two lines in order
34511 to fit it on the page:
34512 .code
34513 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34514   <marv@hitch.fict.example> R=localuser T=local_delivery
34515 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34516   monk@holistic.fict.example R=dnslookup T=remote_smtp
34517   H=holistic.fict.example [192.168.234.234]
34518 .endd
34519 For ordinary local deliveries, the original address is given in angle brackets
34520 after the final delivery address, which might be a pipe or a file. If
34521 intermediate address(es) exist between the original and the final address, the
34522 last of these is given in parentheses after the final address. The R and T
34523 fields record the router and transport that were used to process the address.
34524
34525 If SMTP AUTH was used for the delivery there is an additional item A=
34526 followed by the name of the authenticator that was used.
34527 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34528 option, this is logged too, separated by a colon from the authenticator name.
34529
34530 If a shadow transport was run after a successful local delivery, the log line
34531 for the successful delivery has an item added on the end, of the form
34532 .display
34533 &`ST=<`&&'shadow transport name'&&`>`&
34534 .endd
34535 If the shadow transport did not succeed, the error message is put in
34536 parentheses afterwards.
34537
34538 .cindex "asterisk" "after IP address"
34539 When more than one address is included in a single delivery (for example, two
34540 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34541 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34542 down a single SMTP connection, an asterisk follows the IP address in the log
34543 lines for the second and subsequent messages.
34544
34545 .cindex "delivery" "cutthrough; logging"
34546 .cindex "cutthrough" "logging"
34547 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34548 line precedes the reception line, since cutthrough waits for a possible
34549 rejection from the destination in case it can reject the sourced item.
34550
34551 The generation of a reply message by a filter file gets logged as a
34552 &"delivery"& to the addressee, preceded by &">"&.
34553
34554 The &%log_selector%& option can be used to request the logging of additional
34555 data when a message is delivered. See section &<<SECTlogselector>>& below.
34556
34557
34558 .section "Discarded deliveries" "SECID253"
34559 .cindex "discarded messages"
34560 .cindex "message" "discarded"
34561 .cindex "delivery" "discarded; logging"
34562 When a message is discarded as a result of the command &"seen finish"& being
34563 obeyed in a filter file which generates no deliveries, a log entry of the form
34564 .code
34565 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34566   <low.club@bridge.example> R=userforward
34567 .endd
34568 is written, to record why no deliveries are logged. When a message is discarded
34569 because it is aliased to &":blackhole:"& the log line is like this:
34570 .code
34571 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34572   <hole@nowhere.example> R=blackhole_router
34573 .endd
34574
34575
34576 .section "Deferred deliveries" "SECID254"
34577 When a delivery is deferred, a line of the following form is logged:
34578 .code
34579 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34580   R=dnslookup T=smtp defer (146): Connection refused
34581 .endd
34582 In the case of remote deliveries, the error is the one that was given for the
34583 last IP address that was tried. Details of individual SMTP failures are also
34584 written to the log, so the above line would be preceded by something like
34585 .code
34586 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34587   mail1.endrest.example [192.168.239.239]: Connection refused
34588 .endd
34589 When a deferred address is skipped because its retry time has not been reached,
34590 a message is written to the log, but this can be suppressed by setting an
34591 appropriate value in &%log_selector%&.
34592
34593
34594
34595 .section "Delivery failures" "SECID255"
34596 .cindex "delivery" "failure; logging"
34597 If a delivery fails because an address cannot be routed, a line of the
34598 following form is logged:
34599 .code
34600 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34601   <jim@trek99.example>: unknown mail domain
34602 .endd
34603 If a delivery fails at transport time, the router and transport are shown, and
34604 the response from the remote host is included, as in this example:
34605 .code
34606 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34607   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34608   after pipelined RCPT TO:<ace400@pb.example>: host
34609   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34610   <ace400@pb.example>...Addressee unknown
34611 .endd
34612 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34613 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34614 disabling PIPELINING. The log lines for all forms of delivery failure are
34615 flagged with &`**`&.
34616
34617
34618
34619 .section "Fake deliveries" "SECID256"
34620 .cindex "delivery" "fake; logging"
34621 If a delivery does not actually take place because the &%-N%& option has been
34622 used to suppress it, a normal delivery line is written to the log, except that
34623 &"=>"& is replaced by &"*>"&.
34624
34625
34626
34627 .section "Completion" "SECID257"
34628 A line of the form
34629 .code
34630 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34631 .endd
34632 is written to the main log when a message is about to be removed from the spool
34633 at the end of its processing.
34634
34635
34636
34637
34638 .section "Summary of Fields in Log Lines" "SECID258"
34639 .cindex "log" "summary of fields"
34640 A summary of the field identifiers that are used in log lines is shown in
34641 the following table:
34642 .display
34643 &`A   `&        authenticator name (and optional id and sender)
34644 &`C   `&        SMTP confirmation on delivery
34645 &`    `&        command list for &"no mail in SMTP session"&
34646 &`CV  `&        certificate verification status
34647 &`D   `&        duration of &"no mail in SMTP session"&
34648 &`DN  `&        distinguished name from peer certificate
34649 &`DT  `&        on &`=>`& lines: time taken for a delivery
34650 &`F   `&        sender address (on delivery lines)
34651 &`H   `&        host name and IP address
34652 &`I   `&        local interface used
34653 &`id  `&        message id for incoming message
34654 &`P   `&        on &`<=`& lines: protocol used
34655 &`    `&        on &`=>`& and &`**`& lines: return path
34656 &`QT  `&        on &`=>`& lines: time spent on queue so far
34657 &`    `&        on &"Completed"& lines: time spent on queue
34658 &`R   `&        on &`<=`& lines: reference for local bounce
34659 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34660 &`S   `&        size of message
34661 &`SNI `&        server name indication from TLS client hello
34662 &`ST  `&        shadow transport name
34663 &`T   `&        on &`<=`& lines: message subject (topic)
34664 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34665 &`U   `&        local user or RFC 1413 identity
34666 &`X   `&        TLS cipher suite
34667 .endd
34668
34669
34670 .section "Other log entries" "SECID259"
34671 Various other types of log entry are written from time to time. Most should be
34672 self-explanatory. Among the more common are:
34673
34674 .ilist
34675 .cindex "retry" "time not reached"
34676 &'retry time not reached'&&~&~An address previously suffered a temporary error
34677 during routing or local delivery, and the time to retry has not yet arrived.
34678 This message is not written to an individual message log file unless it happens
34679 during the first delivery attempt.
34680 .next
34681 &'retry time not reached for any host'&&~&~An address previously suffered
34682 temporary errors during remote delivery, and the retry time has not yet arrived
34683 for any of the hosts to which it is routed.
34684 .next
34685 .cindex "spool directory" "file locked"
34686 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34687 some other Exim process is already working on the message. This can be quite
34688 common if queue running processes are started at frequent intervals. The
34689 &'exiwhat'& utility script can be used to find out what Exim processes are
34690 doing.
34691 .next
34692 .cindex "error" "ignored"
34693 &'error ignored'&&~&~There are several circumstances that give rise to this
34694 message:
34695 .olist
34696 Exim failed to deliver a bounce message whose age was greater than
34697 &%ignore_bounce_errors_after%&. The bounce was discarded.
34698 .next
34699 A filter file set up a delivery using the &"noerror"& option, and the delivery
34700 failed. The delivery was discarded.
34701 .next
34702 A delivery set up by a router configured with
34703 . ==== As this is a nested list, any displays it contains must be indented
34704 . ==== as otherwise they are too far to the left.
34705 .code
34706     errors_to = <>
34707 .endd
34708 failed. The delivery was discarded.
34709 .endlist olist
34710 .endlist ilist
34711
34712
34713
34714
34715
34716 .section "Reducing or increasing what is logged" "SECTlogselector"
34717 .cindex "log" "selectors"
34718 By setting the &%log_selector%& global option, you can disable some of Exim's
34719 default logging, or you can request additional logging. The value of
34720 &%log_selector%& is made up of names preceded by plus or minus characters. For
34721 example:
34722 .code
34723 log_selector = +arguments -retry_defer
34724 .endd
34725 The list of optional log items is in the following table, with the default
34726 selection marked by asterisks:
34727 .display
34728 &` 8bitmime                   `&  received 8BITMIME status
34729 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34730 &` address_rewrite            `&  address rewriting
34731 &` all_parents                `&  all parents in => lines
34732 &` arguments                  `&  command line arguments
34733 &`*connection_reject          `&  connection rejections
34734 &`*delay_delivery             `&  immediate delivery delayed
34735 &` deliver_time               `&  time taken to perform delivery
34736 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34737 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34738 &`*etrn                       `&  ETRN commands
34739 &`*host_lookup_failed         `&  as it says
34740 &` ident_timeout              `&  timeout for ident connection
34741 &` incoming_interface         `&  incoming interface on <= lines
34742 &` incoming_port              `&  incoming port on <= lines
34743 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34744 &` outgoing_port              `&  add remote port to => lines
34745 &`*queue_run                  `&  start and end queue runs
34746 &` queue_time                 `&  time on queue for one recipient
34747 &` queue_time_overall         `&  time on queue for whole message
34748 &` pid                        `&  Exim process id
34749 &` received_recipients        `&  recipients on <= lines
34750 &` received_sender            `&  sender on <= lines
34751 &`*rejected_header            `&  header contents on reject log
34752 &`*retry_defer                `&  &"retry time not reached"&
34753 &` return_path_on_delivery    `&  put return path on => and ** lines
34754 &` sender_on_delivery         `&  add sender to => lines
34755 &`*sender_verify_fail         `&  sender verification failures
34756 &`*size_reject                `&  rejection because too big
34757 &`*skip_delivery              `&  delivery skipped in a queue run
34758 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34759 &` smtp_connection            `&  SMTP connections
34760 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34761 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34762 &` smtp_no_mail               `&  session with no MAIL commands
34763 &` smtp_protocol_error        `&  SMTP protocol errors
34764 &` smtp_syntax_error          `&  SMTP syntax errors
34765 &` subject                    `&  contents of &'Subject:'& on <= lines
34766 &` tls_certificate_verified   `&  certificate verification status
34767 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34768 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34769 &` tls_sni                    `&  TLS SNI on <= lines
34770 &` unknown_in_list            `&  DNS lookup failed in list match
34771
34772 &` all                        `&  all of the above
34773 .endd
34774 More details on each of these items follows:
34775
34776 .ilist
34777 .cindex "8BITMIME"
34778 .cindex "log" "8BITMIME"
34779 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34780 which may help in tracking down interoperability issues with ancient MTAs
34781 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34782 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34783 &`7BIT`& and &`8BITMIME`& respectively.
34784 .next
34785 .cindex "&%warn%& ACL verb" "log when skipping"
34786 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34787 its conditions cannot be evaluated, a log line to this effect is written if
34788 this log selector is set.
34789 .next
34790 .cindex "log" "rewriting"
34791 .cindex "rewriting" "logging"
34792 &%address_rewrite%&: This applies both to global rewrites and per-transport
34793 rewrites, but not to rewrites in filters run as an unprivileged user (because
34794 such users cannot access the log).
34795 .next
34796 .cindex "log" "full parentage"
34797 &%all_parents%&: Normally only the original and final addresses are logged on
34798 delivery lines; with this selector, intermediate parents are given in
34799 parentheses between them.
34800 .next
34801 .cindex "log" "Exim arguments"
34802 .cindex "Exim arguments, logging"
34803 &%arguments%&: This causes Exim to write the arguments with which it was called
34804 to the main log, preceded by the current working directory. This is a debugging
34805 feature, added to make it easier to find out how certain MUAs call
34806 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34807 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34808 that are empty or that contain white space are quoted. Non-printing characters
34809 are shown as escape sequences. This facility cannot log unrecognized arguments,
34810 because the arguments are checked before the configuration file is read. The
34811 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34812 between the caller and Exim.
34813 .next
34814 .cindex "log" "connection rejections"
34815 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34816 connection is rejected, for whatever reason.
34817 .next
34818 .cindex "log" "delayed delivery"
34819 .cindex "delayed delivery, logging"
34820 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34821 started for an incoming message because the load is too high or too many
34822 messages were received on one connection. Logging does not occur if no delivery
34823 process is started because &%queue_only%& is set or &%-odq%& was used.
34824 .next
34825 .cindex "log" "delivery duration"
34826 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34827 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34828 .next
34829 .cindex "log" "message size on delivery"
34830 .cindex "size" "of message"
34831 &%delivery_size%&: For each delivery, the size of message delivered is added to
34832 the &"=>"& line, tagged with S=.
34833 .next
34834 .cindex "log" "dnslist defer"
34835 .cindex "DNS list" "logging defer"
34836 .cindex "black list (DNS)"
34837 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34838 DNS black list suffers a temporary error.
34839 .next
34840 .cindex "log" "ETRN commands"
34841 .cindex "ETRN" "logging"
34842 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34843 is run to determine whether or not it is actually accepted. An invalid ETRN
34844 command, or one received within a message transaction is not logged by this
34845 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34846 .next
34847 .cindex "log" "host lookup failure"
34848 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34849 any addresses, or when a lookup of an IP address fails to find a host name, a
34850 log line is written. This logging does not apply to direct DNS lookups when
34851 routing email addresses, but it does apply to &"byname"& lookups.
34852 .next
34853 .cindex "log" "ident timeout"
34854 .cindex "RFC 1413" "logging timeout"
34855 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34856 client's ident port times out.
34857 .next
34858 .cindex "log" "incoming interface"
34859 .cindex "interface" "logging"
34860 &%incoming_interface%&: The interface on which a message was received is added
34861 to the &"<="& line as an IP address in square brackets, tagged by I= and
34862 followed by a colon and the port number. The local interface and port are also
34863 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34864 rejection lines.
34865 .next
34866 .cindex "log" "incoming remote port"
34867 .cindex "port" "logging remote"
34868 .cindex "TCP/IP" "logging incoming remote port"
34869 .vindex "&$sender_fullhost$&"
34870 .vindex "&$sender_rcvhost$&"
34871 &%incoming_port%&: The remote port number from which a message was received is
34872 added to log entries and &'Received:'& header lines, following the IP address
34873 in square brackets, and separated from it by a colon. This is implemented by
34874 changing the value that is put in the &$sender_fullhost$& and
34875 &$sender_rcvhost$& variables. Recording the remote port number has become more
34876 important with the widening use of NAT (see RFC 2505).
34877 .next
34878 .cindex "log" "dropped connection"
34879 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34880 connection is unexpectedly dropped.
34881 .next
34882 .cindex "log" "outgoing remote port"
34883 .cindex "port" "logging outgoint remote"
34884 .cindex "TCP/IP" "logging ougtoing remote port"
34885 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34886 containing => tags) following the IP address. This option is not included in
34887 the default setting, because for most ordinary configurations, the remote port
34888 number is always 25 (the SMTP port).
34889 .next
34890 .cindex "log" "process ids in"
34891 .cindex "pid (process id)" "in log lines"
34892 &%pid%&: The current process id is added to every log line, in square brackets,
34893 immediately after the time and date.
34894 .next
34895 .cindex "log" "queue run"
34896 .cindex "queue runner" "logging"
34897 &%queue_run%&: The start and end of every queue run are logged.
34898 .next
34899 .cindex "log" "queue time"
34900 &%queue_time%&: The amount of time the message has been in the queue on the
34901 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34902 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34903 includes reception time as well as the delivery time for the current address.
34904 This means that it may be longer than the difference between the arrival and
34905 delivery log line times, because the arrival log line is not written until the
34906 message has been successfully received.
34907 .next
34908 &%queue_time_overall%&: The amount of time the message has been in the queue on
34909 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34910 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34911 message, so it includes reception time as well as the total delivery time.
34912 .next
34913 .cindex "log" "recipients"
34914 &%received_recipients%&: The recipients of a message are listed in the main log
34915 as soon as the message is received. The list appears at the end of the log line
34916 that is written when a message is received, preceded by the word &"for"&. The
34917 addresses are listed after they have been qualified, but before any rewriting
34918 has taken place.
34919 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34920 in the list.
34921 .next
34922 .cindex "log" "sender reception"
34923 &%received_sender%&: The unrewritten original sender of a message is added to
34924 the end of the log line that records the message's arrival, after the word
34925 &"from"& (before the recipients if &%received_recipients%& is also set).
34926 .next
34927 .cindex "log" "header lines for rejection"
34928 &%rejected_header%&: If a message's header has been received at the time a
34929 rejection is written to the reject log, the complete header is added to the
34930 log. Header logging can be turned off individually for messages that are
34931 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34932 .next
34933 .cindex "log" "retry defer"
34934 &%retry_defer%&: A log line is written if a delivery is deferred because a
34935 retry time has not yet been reached. However, this &"retry time not reached"&
34936 message is always omitted from individual message logs after the first delivery
34937 attempt.
34938 .next
34939 .cindex "log" "return path"
34940 &%return_path_on_delivery%&: The return path that is being transmitted with
34941 the message is included in delivery and bounce lines, using the tag P=.
34942 This is omitted if no delivery actually happens, for example, if routing fails,
34943 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34944 .next
34945 .cindex "log" "sender on delivery"
34946 &%sender_on_delivery%&: The message's sender address is added to every delivery
34947 and bounce line, tagged by F= (for &"from"&).
34948 This is the original sender that was received with the message; it is not
34949 necessarily the same as the outgoing return path.
34950 .next
34951 .cindex "log" "sender verify failure"
34952 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34953 gives details of a sender verification failure is not written. Log lines for
34954 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34955 detail is lost.
34956 .next
34957 .cindex "log" "size rejection"
34958 &%size_reject%&: A log line is written whenever a message is rejected because
34959 it is too big.
34960 .next
34961 .cindex "log" "frozen messages; skipped"
34962 .cindex "frozen messages" "logging skipping"
34963 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34964 queue run because it is frozen or because another process is already delivering
34965 it.
34966 .cindex "&""spool file is locked""&"
34967 The message that is written is &"spool file is locked"&.
34968 .next
34969 .cindex "log" "smtp confirmation"
34970 .cindex "SMTP" "logging confirmation"
34971 .cindex "LMTP" "logging confirmation"
34972 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34973 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34974 A number of MTAs (including Exim) return an identifying string in this
34975 response.
34976 .next
34977 .cindex "log" "SMTP connections"
34978 .cindex "SMTP" "logging connections"
34979 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34980 established or closed, unless the connection is from a host that matches
34981 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34982 only when the closure is unexpected.) This applies to connections from local
34983 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34984 dropped in the middle of a message, a log line is always written, whether or
34985 not this selector is set, but otherwise nothing is written at the start and end
34986 of connections unless this selector is enabled.
34987
34988 For TCP/IP connections to an Exim daemon, the current number of connections is
34989 included in the log message for each new connection, but note that the count is
34990 reset if the daemon is restarted.
34991 Also, because connections are closed (and the closure is logged) in
34992 subprocesses, the count may not include connections that have been closed but
34993 whose termination the daemon has not yet noticed. Thus, while it is possible to
34994 match up the opening and closing of connections in the log, the value of the
34995 logged counts may not be entirely accurate.
34996 .next
34997 .cindex "log" "SMTP transaction; incomplete"
34998 .cindex "SMTP" "logging incomplete transactions"
34999 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35000 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35001 and the message sender plus any accepted recipients are included in the log
35002 line. This can provide evidence of dictionary attacks.
35003 .next
35004 .cindex "log" "non-MAIL SMTP sessions"
35005 .cindex "MAIL" "logging session without"
35006 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35007 connection terminates without having issued a MAIL command. This includes both
35008 the case when the connection is dropped, and the case when QUIT is used. It
35009 does not include cases where the connection is rejected right at the start (by
35010 an ACL, or because there are too many connections, or whatever). These cases
35011 already have their own log lines.
35012
35013 The log line that is written contains the identity of the client in the usual
35014 way, followed by D= and a time, which records the duration of the connection.
35015 If the connection was authenticated, this fact is logged exactly as it is for
35016 an incoming message, with an A= item. If the connection was encrypted, CV=,
35017 DN=, and X= items may appear as they do for an incoming message, controlled by
35018 the same logging options.
35019
35020 Finally, if any SMTP commands were issued during the connection, a C= item
35021 is added to the line, listing the commands that were used. For example,
35022 .code
35023 C=EHLO,QUIT
35024 .endd
35025 shows that the client issued QUIT straight after EHLO. If there were fewer
35026 than 20 commands, they are all listed. If there were more than 20 commands,
35027 the last 20 are listed, preceded by &"..."&. However, with the default
35028 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35029 have been aborted before 20 non-mail commands are processed.
35030 .next
35031 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35032 colon-separated, is appended to the A= item for a message arrival or delivery
35033 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35034 was accepted or used.
35035 .next
35036 .cindex "log" "SMTP protocol error"
35037 .cindex "SMTP" "logging protocol error"
35038 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35039 encountered. Exim does not have perfect detection of all protocol errors
35040 because of transmission delays and the use of pipelining. If PIPELINING has
35041 been advertised to a client, an Exim server assumes that the client will use
35042 it, and therefore it does not count &"expected"& errors (for example, RCPT
35043 received after rejecting MAIL) as protocol errors.
35044 .next
35045 .cindex "SMTP" "logging syntax errors"
35046 .cindex "SMTP" "syntax errors; logging"
35047 .cindex "SMTP" "unknown command; logging"
35048 .cindex "log" "unknown SMTP command"
35049 .cindex "log" "SMTP syntax error"
35050 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35051 encountered. An unrecognized command is treated as a syntax error. For an
35052 external connection, the host identity is given; for an internal connection
35053 using &%-bs%& the sender identification (normally the calling user) is given.
35054 .next
35055 .cindex "log" "subject"
35056 .cindex "subject, logging"
35057 &%subject%&: The subject of the message is added to the arrival log line,
35058 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35059 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35060 specifies whether characters with values greater than 127 should be logged
35061 unchanged, or whether they should be rendered as escape sequences.
35062 .next
35063 .cindex "log" "certificate verification"
35064 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35065 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35066 verified, and &`CV=no`& if not.
35067 .next
35068 .cindex "log" "TLS cipher"
35069 .cindex "TLS" "logging cipher"
35070 &%tls_cipher%&: When a message is sent or received over an encrypted
35071 connection, the cipher suite used is added to the log line, preceded by X=.
35072 .next
35073 .cindex "log" "TLS peer DN"
35074 .cindex "TLS" "logging peer DN"
35075 &%tls_peerdn%&: When a message is sent or received over an encrypted
35076 connection, and a certificate is supplied by the remote host, the peer DN is
35077 added to the log line, preceded by DN=.
35078 .next
35079 .cindex "log" "TLS SNI"
35080 .cindex "TLS" "logging SNI"
35081 &%tls_sni%&: When a message is received over an encrypted connection, and
35082 the remote host provided the Server Name Indication extension, the SNI is
35083 added to the log line, preceded by SNI=.
35084 .next
35085 .cindex "log" "DNS failure in list"
35086 &%unknown_in_list%&: This setting causes a log entry to be written when the
35087 result of a list match is failure because a DNS lookup failed.
35088 .endlist
35089
35090
35091 .section "Message log" "SECID260"
35092 .cindex "message" "log file for"
35093 .cindex "log" "message log; description of"
35094 .cindex "&_msglog_& directory"
35095 .oindex "&%preserve_message_logs%&"
35096 In addition to the general log files, Exim writes a log file for each message
35097 that it handles. The names of these per-message logs are the message ids, and
35098 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35099 message log contains copies of the log lines that apply to the message. This
35100 makes it easier to inspect the status of an individual message without having
35101 to search the main log. A message log is deleted when processing of the message
35102 is complete, unless &%preserve_message_logs%& is set, but this should be used
35103 only with great care because they can fill up your disk very quickly.
35104
35105 On a heavily loaded system, it may be desirable to disable the use of
35106 per-message logs, in order to reduce disk I/O. This can be done by setting the
35107 &%message_logs%& option false.
35108 .ecindex IIDloggen
35109
35110
35111
35112
35113 . ////////////////////////////////////////////////////////////////////////////
35114 . ////////////////////////////////////////////////////////////////////////////
35115
35116 .chapter "Exim utilities" "CHAPutils"
35117 .scindex IIDutils "utilities"
35118 A number of utility scripts and programs are supplied with Exim and are
35119 described in this chapter. There is also the Exim Monitor, which is covered in
35120 the next chapter. The utilities described here are:
35121
35122 .itable none 0 0 3  7* left  15* left  40* left
35123 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35124   "list what Exim processes are doing"
35125 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35126 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35127 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35128 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35129                                                 various criteria"
35130 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35131 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35132   "extract statistics from the log"
35133 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35134   "check address acceptance from given IP"
35135 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35136 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35137 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35138 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35139 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35140 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35141 .endtable
35142
35143 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35144 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35145 &url(http://duncanthrax.net/exilog/) for details.
35146
35147
35148
35149
35150 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35151 .cindex "&'exiwhat'&"
35152 .cindex "process, querying"
35153 .cindex "SIGUSR1"
35154 On operating systems that can restart a system call after receiving a signal
35155 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35156 a line describing what it is doing to the file &_exim-process.info_& in the
35157 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35158 processes it can find, having first emptied the file. It then waits for one
35159 second to allow the Exim processes to react before displaying the results. In
35160 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35161 send the signal to the Exim processes, so it is normally run as root.
35162
35163 &*Warning*&: This is not an efficient process. It is intended for occasional
35164 use by system administrators. It is not sensible, for example, to set up a
35165 script that sends SIGUSR1 signals to Exim processes at short intervals.
35166
35167
35168 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35169 varies in different operating systems. Not only are different options used,
35170 but the format of the output is different. For this reason, there are some
35171 system configuration options that configure exactly how &'exiwhat'& works. If
35172 it doesn't seem to be working for you, check the following compile-time
35173 options:
35174 .display
35175 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35176 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35177 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35178 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35179 .endd
35180 An example of typical output from &'exiwhat'& is
35181 .code
35182 164 daemon: -q1h, listening on port 25
35183 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35184 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35185   [10.19.42.42] (editor@ref.example)
35186 10592 handling incoming call from [192.168.243.242]
35187 10628 accepting a local non-SMTP message
35188 .endd
35189 The first number in the output line is the process number. The third line has
35190 been split here, in order to fit it on the page.
35191
35192
35193
35194 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35195 .cindex "&'exiqgrep'&"
35196 .cindex "queue" "grepping"
35197 This utility is a Perl script contributed by Matt Hubbard. It runs
35198 .code
35199 exim -bpu
35200 .endd
35201 or (in case &*-a*& switch is specified)
35202 .code
35203 exim -bp
35204 .endd
35205 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35206 contain alternate exim configuration the queue management might be using.
35207
35208 to obtain a queue listing, and then greps the output to select messages 
35209 that match given criteria. The following selection options are available:
35210
35211 .vlist
35212 .vitem &*-f*&&~<&'regex'&>
35213 Match the sender address using a case-insensitive search. The field that is
35214 tested is enclosed in angle brackets, so you can test for bounce messages with
35215 .code
35216 exiqgrep -f '^<>$'
35217 .endd
35218 .vitem &*-r*&&~<&'regex'&>
35219 Match a recipient address using a case-insensitve search. The field that is
35220 tested is not enclosed in angle brackets.
35221
35222 .vitem &*-s*&&~<&'regex'&>
35223 Match against the size field.
35224
35225 .vitem &*-y*&&~<&'seconds'&>
35226 Match messages that are younger than the given time.
35227
35228 .vitem &*-o*&&~<&'seconds'&>
35229 Match messages that are older than the given time.
35230
35231 .vitem &*-z*&
35232 Match only frozen messages.
35233
35234 .vitem &*-x*&
35235 Match only non-frozen messages.
35236 .endlist
35237
35238 The following options control the format of the output:
35239
35240 .vlist
35241 .vitem &*-c*&
35242 Display only the count of matching messages.
35243
35244 .vitem &*-l*&
35245 Long format &-- display the full message information as output by Exim. This is
35246 the default.
35247
35248 .vitem &*-i*&
35249 Display message ids only.
35250
35251 .vitem &*-b*&
35252 Brief format &-- one line per message.
35253
35254 .vitem &*-R*&
35255 Display messages in reverse order.
35256
35257 .vitem &*-a*&
35258 Include delivered recipients in queue listing.
35259 .endlist
35260
35261 There is one more option, &%-h%&, which outputs a list of options.
35262
35263
35264
35265 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35266 .cindex "&'exiqsumm'&"
35267 .cindex "queue" "summary"
35268 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35269 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35270 running a command such as
35271 .code
35272 exim -bp | exiqsumm
35273 .endd
35274 The output consists of one line for each domain that has messages waiting for
35275 it, as in the following example:
35276 .code
35277 3   2322   74m   66m  msn.com.example
35278 .endd
35279 Each line lists the number of pending deliveries for a domain, their total
35280 volume, and the length of time that the oldest and the newest messages have
35281 been waiting. Note that the number of pending deliveries is greater than the
35282 number of messages when messages have more than one recipient.
35283
35284 A summary line is output at the end. By default the output is sorted on the
35285 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35286 the output to be sorted by oldest message and by count of messages,
35287 respectively. There are also three options that split the messages for each
35288 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35289 separates frozen messages, and &%-s%& separates messages according to their
35290 sender.
35291
35292 The output of &'exim -bp'& contains the original addresses in the message, so
35293 this also applies to the output from &'exiqsumm'&. No domains from addresses
35294 generated by aliasing or forwarding are included (unless the &%one_time%&
35295 option of the &(redirect)& router has been used to convert them into &"top
35296 level"& addresses).
35297
35298
35299
35300
35301 .section "Extracting specific information from the log (exigrep)" &&&
35302          "SECTextspeinf"
35303 .cindex "&'exigrep'&"
35304 .cindex "log" "extracts; grepping for"
35305 The &'exigrep'& utility is a Perl script that searches one or more main log
35306 files for entries that match a given pattern. When it finds a match, it
35307 extracts all the log entries for the relevant message, not just those that
35308 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35309 given message, or all mail for a given user, or for a given host, for example.
35310 The input files can be in Exim log format or syslog format.
35311 If a matching log line is not associated with a specific message, it is
35312 included in &'exigrep'&'s output without any additional lines. The usage is:
35313 .new
35314 .display
35315 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35316 .endd
35317 .wen
35318 If no log file names are given on the command line, the standard input is read.
35319
35320 The &%-t%& argument specifies a number of seconds. It adds an additional
35321 condition for message selection. Messages that are complete are shown only if
35322 they spent more than <&'n'&> seconds on the queue.
35323
35324 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35325 makes it case-sensitive. This may give a performance improvement when searching
35326 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35327 option; with &%-I%& they do not. In both cases it is possible to change the
35328 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35329
35330 The &%-l%& option means &"literal"&, that is, treat all characters in the
35331 pattern as standing for themselves. Otherwise the pattern must be a Perl
35332 regular expression.
35333
35334 The &%-v%& option inverts the matching condition. That is, a line is selected
35335 if it does &'not'& match the pattern.
35336
35337 .new
35338 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35339 that are generated as a result/response to a message that &'exigrep'& matched
35340 normally.
35341
35342 Example of &%-M%&:
35343 user_a sends a message to user_b, which generates a bounce back to user_b. If
35344 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35345 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35346 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35347 when searching for &"user_a"& will show both messages since the bounce is
35348 &"related"& to or a &"result"& of the first message that was found by the
35349 search term.
35350 .wen
35351
35352 If the location of a &'zcat'& command is known from the definition of
35353 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35354 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35355
35356
35357 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35358 .cindex "&'exipick'&"
35359 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35360 lists messages from the queue according to a variety of criteria. For details
35361 of &'exipick'&'s facilities, visit the web page at
35362 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35363 the &%--help%& option.
35364
35365
35366 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35367 .cindex "log" "cycling local files"
35368 .cindex "cycling logs"
35369 .cindex "&'exicyclog'&"
35370 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35371 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35372 you are using log files with datestamps in their names (see section
35373 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35374 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35375 There are two command line options for &'exicyclog'&:
35376 .ilist
35377 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35378 default that is set when Exim is built. The default default is 10.
35379 .next
35380 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35381 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35382 overriding the script's default, which is to find the setting from Exim's
35383 configuration.
35384 .endlist
35385
35386 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35387 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35388 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35389 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35390 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35391 logs are handled similarly.
35392
35393 If the limit is greater than 99, the script uses 3-digit numbers such as
35394 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35395 to one that is greater, or &'vice versa'&, you will have to fix the names of
35396 any existing log files.
35397
35398 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35399 the end are deleted. All files with numbers greater than 01 are compressed,
35400 using a compression command which is configured by the COMPRESS_COMMAND
35401 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35402 root &%crontab%& entry of the form
35403 .code
35404 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35405 .endd
35406 assuming you have used the name &"exim"& for the Exim user. You can run
35407 &'exicyclog'& as root if you wish, but there is no need.
35408
35409
35410
35411 .section "Mail statistics (eximstats)" "SECTmailstat"
35412 .cindex "statistics"
35413 .cindex "&'eximstats'&"
35414 A Perl script called &'eximstats'& is provided for extracting statistical
35415 information from log files. The output is either plain text, or HTML.
35416 Exim log files are also supported by the &'Lire'& system produced by the
35417 LogReport Foundation &url(http://www.logreport.org).
35418
35419 The &'eximstats'& script has been hacked about quite a bit over time. The
35420 latest version is the result of some extensive revision by Steve Campbell. A
35421 lot of information is given by default, but there are options for suppressing
35422 various parts of it. Following any options, the arguments to the script are a
35423 list of files, which should be main log files. For example:
35424 .code
35425 eximstats -nr /var/spool/exim/log/mainlog.01
35426 .endd
35427 By default, &'eximstats'& extracts information about the number and volume of
35428 messages received from or delivered to various hosts. The information is sorted
35429 both by message count and by volume, and the top fifty hosts in each category
35430 are listed on the standard output. Similar information, based on email
35431 addresses or domains instead of hosts can be requested by means of various
35432 options. For messages delivered and received locally, similar statistics are
35433 also produced per user.
35434
35435 The output also includes total counts and statistics about delivery errors, and
35436 histograms showing the number of messages received and deliveries made in each
35437 hour of the day. A delivery with more than one address in its envelope (for
35438 example, an SMTP transaction with more than one RCPT command) is counted
35439 as a single delivery by &'eximstats'&.
35440
35441 Though normally more deliveries than receipts are reported (as messages may
35442 have multiple recipients), it is possible for &'eximstats'& to report more
35443 messages received than delivered, even though the queue is empty at the start
35444 and end of the period in question. If an incoming message contains no valid
35445 recipients, no deliveries are recorded for it. A bounce message is handled as
35446 an entirely separate message.
35447
35448 &'eximstats'& always outputs a grand total summary giving the volume and number
35449 of messages received and deliveries made, and the number of hosts involved in
35450 each case. It also outputs the number of messages that were delayed (that is,
35451 not completely delivered at the first attempt), and the number that had at
35452 least one address that failed.
35453
35454 The remainder of the output is in sections that can be independently disabled
35455 or modified by various options. It consists of a summary of deliveries by
35456 transport, histograms of messages received and delivered per time interval
35457 (default per hour), information about the time messages spent on the queue,
35458 a list of relayed messages, lists of the top fifty sending hosts, local
35459 senders, destination hosts, and destination local users by count and by volume,
35460 and a list of delivery errors that occurred.
35461
35462 The relay information lists messages that were actually relayed, that is, they
35463 came from a remote host and were directly delivered to some other remote host,
35464 without being processed (for example, for aliasing or forwarding) locally.
35465
35466 There are quite a few options for &'eximstats'& to control exactly what it
35467 outputs. These are documented in the Perl script itself, and can be extracted
35468 by running the command &(perldoc)& on the script. For example:
35469 .code
35470 perldoc /usr/exim/bin/eximstats
35471 .endd
35472
35473 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35474 .cindex "&'exim_checkaccess'&"
35475 .cindex "policy control" "checking access"
35476 .cindex "checking access"
35477 The &%-bh%& command line argument allows you to run a fake SMTP session with
35478 debugging output, in order to check what Exim is doing when it is applying
35479 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35480 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35481 sometimes you just want to answer the question &"Does this address have
35482 access?"& without bothering with any further details.
35483
35484 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35485 two arguments, an IP address and an email address:
35486 .code
35487 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35488 .endd
35489 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35490 given email address would be accepted in a RCPT command in a TCP/IP
35491 connection from the host with the given IP address. The output of the utility
35492 is either the word &"accepted"&, or the SMTP error response, for example:
35493 .code
35494 Rejected:
35495 550 Relay not permitted
35496 .endd
35497 When running this test, the utility uses &`<>`& as the envelope sender address
35498 for the MAIL command, but you can change this by providing additional
35499 options. These are passed directly to the Exim command. For example, to specify
35500 that the test is to be run with the sender address &'himself@there.example'&
35501 you can use:
35502 .code
35503 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35504                  -f himself@there.example
35505 .endd
35506 Note that these additional Exim command line items must be given after the two
35507 mandatory arguments.
35508
35509 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35510 while running its checks. You can run checks that include callouts by using
35511 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35512
35513
35514
35515 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35516 .cindex "DBM" "building dbm files"
35517 .cindex "building DBM files"
35518 .cindex "&'exim_dbmbuild'&"
35519 .cindex "lower casing"
35520 .cindex "binary zero" "in lookup key"
35521 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35522 the format used by the &(lsearch)& lookup (see section
35523 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35524 names as keys and the remainder of the information as data. The lower-casing
35525 can be prevented by calling the program with the &%-nolc%& option.
35526
35527 A terminating zero is included as part of the key string. This is expected by
35528 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35529 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35530 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35531 files.
35532
35533 The program requires two arguments: the name of the input file (which can be a
35534 single hyphen to indicate the standard input), and the name of the output file.
35535 It creates the output under a temporary name, and then renames it if all went
35536 well.
35537
35538 .cindex "USE_DB"
35539 If the native DB interface is in use (USE_DB is set in a compile-time
35540 configuration file &-- this is common in free versions of Unix) the two file
35541 names must be different, because in this mode the Berkeley DB functions create
35542 a single output file using exactly the name given. For example,
35543 .code
35544 exim_dbmbuild /etc/aliases /etc/aliases.db
35545 .endd
35546 reads the system alias file and creates a DBM version of it in
35547 &_/etc/aliases.db_&.
35548
35549 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35550 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35551 environment, the suffixes are added to the second argument of
35552 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35553 when the Berkeley functions are used in compatibility mode (though this is not
35554 recommended), because in that case it adds a &_.db_& suffix to the file name.
35555
35556 If a duplicate key is encountered, the program outputs a warning, and when it
35557 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35558 option is used. By default, only the first of a set of duplicates is used &--
35559 this makes it compatible with &(lsearch)& lookups. There is an option
35560 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35561 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35562 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35563 return code is 2.
35564
35565
35566
35567
35568 .section "Finding individual retry times (exinext)" "SECTfinindret"
35569 .cindex "retry" "times"
35570 .cindex "&'exinext'&"
35571 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35572 fish specific information out of the retry database. Given a mail domain (or a
35573 complete address), it looks up the hosts for that domain, and outputs any retry
35574 information for the hosts or for the domain. At present, the retry information
35575 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35576 output. For example:
35577 .code
35578 $ exinext piglet@milne.fict.example
35579 kanga.milne.example:192.168.8.1 error 146: Connection refused
35580   first failed: 21-Feb-1996 14:57:34
35581   last tried:   21-Feb-1996 14:57:34
35582   next try at:  21-Feb-1996 15:02:34
35583 roo.milne.example:192.168.8.3 error 146: Connection refused
35584   first failed: 20-Jan-1996 13:12:08
35585   last tried:   21-Feb-1996 11:42:03
35586   next try at:  21-Feb-1996 19:42:03
35587   past final cutoff time
35588 .endd
35589 You can also give &'exinext'& a local part, without a domain, and it
35590 will give any retry information for that local part in your default domain.
35591 A message id can be used to obtain retry information pertaining to a specific
35592 message. This exists only when an attempt to deliver a message to a remote host
35593 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35594 &'exinext'& is not particularly efficient, but then it is not expected to be
35595 run very often.
35596
35597 The &'exinext'& utility calls Exim to find out information such as the location
35598 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35599 passed on to the &'exim'& commands. The first specifies an alternate Exim
35600 configuration file, and the second sets macros for use within the configuration
35601 file. These features are mainly to help in testing, but might also be useful in
35602 environments where more than one configuration file is in use.
35603
35604
35605
35606 .section "Hints database maintenance" "SECThindatmai"
35607 .cindex "hints database" "maintenance"
35608 .cindex "maintaining Exim's hints database"
35609 Three utility programs are provided for maintaining the DBM files that Exim
35610 uses to contain its delivery hint information. Each program requires two
35611 arguments. The first specifies the name of Exim's spool directory, and the
35612 second is the name of the database it is to operate on. These are as follows:
35613
35614 .ilist
35615 &'retry'&: the database of retry information
35616 .next
35617 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35618 for remote hosts
35619 .next
35620 &'callout'&: the callout cache
35621 .next
35622 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35623 .next
35624 &'misc'&: other hints data
35625 .endlist
35626
35627 The &'misc'& database is used for
35628
35629 .ilist
35630 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35631 .next
35632 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35633 &(smtp)& transport)
35634 .endlist
35635
35636
35637
35638 .section "exim_dumpdb" "SECID261"
35639 .cindex "&'exim_dumpdb'&"
35640 The entire contents of a database are written to the standard output by the
35641 &'exim_dumpdb'& program, which has no options or arguments other than the
35642 spool and database names. For example, to dump the retry database:
35643 .code
35644 exim_dumpdb /var/spool/exim retry
35645 .endd
35646 Two lines of output are produced for each entry:
35647 .code
35648 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35649 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35650 .endd
35651 The first item on the first line is the key of the record. It starts with one
35652 of the letters R, or T, depending on whether it refers to a routing or
35653 transport retry. For a local delivery, the next part is the local address; for
35654 a remote delivery it is the name of the remote host, followed by its failing IP
35655 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35656 transport). If the remote port is not the standard one (port 25), it is added
35657 to the IP address. Then there follows an error code, an additional error code,
35658 and a textual description of the error.
35659
35660 The three times on the second line are the time of first failure, the time of
35661 the last delivery attempt, and the computed time for the next attempt. The line
35662 ends with an asterisk if the cutoff time for the last retry rule has been
35663 exceeded.
35664
35665 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35666 consists of a host name followed by a list of ids for messages that are or were
35667 waiting to be delivered to that host. If there are a very large number for any
35668 one host, continuation records, with a sequence number added to the host name,
35669 may be seen. The data in these records is often out of date, because a message
35670 may be routed to several alternative hosts, and Exim makes no effort to keep
35671 cross-references.
35672
35673
35674
35675 .section "exim_tidydb" "SECID262"
35676 .cindex "&'exim_tidydb'&"
35677 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35678 database. If run with no options, it removes all records that are more than 30
35679 days old. The age is calculated from the date and time that the record was last
35680 updated. Note that, in the case of the retry database, it is &'not'& the time
35681 since the first delivery failure. Information about a host that has been down
35682 for more than 30 days will remain in the database, provided that the record is
35683 updated sufficiently often.
35684
35685 The cutoff date can be altered by means of the &%-t%& option, which must be
35686 followed by a time. For example, to remove all records older than a week from
35687 the retry database:
35688 .code
35689 exim_tidydb -t 7d /var/spool/exim retry
35690 .endd
35691 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35692 message ids. In the former these appear as data in records keyed by host &--
35693 they were messages that were waiting for that host &-- and in the latter they
35694 are the keys for retry information for messages that have suffered certain
35695 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35696 message ids in database records are those of messages that are still on the
35697 queue. Message ids for messages that no longer exist are removed from
35698 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35699 For the &'retry'& database, records whose keys are non-existent message ids are
35700 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35701 whenever it removes information from the database.
35702
35703 Certain records are automatically removed by Exim when they are no longer
35704 needed, but others are not. For example, if all the MX hosts for a domain are
35705 down, a retry record is created for each one. If the primary MX host comes back
35706 first, its record is removed when Exim successfully delivers to it, but the
35707 records for the others remain because Exim has not tried to use those hosts.
35708
35709 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35710 hints databases. You should do this at a quiet time of day, because it requires
35711 a database to be locked (and therefore inaccessible to Exim) while it does its
35712 work. Removing records from a DBM file does not normally make the file smaller,
35713 but all the common DBM libraries are able to re-use the space that is released.
35714 After an initial phase of increasing in size, the databases normally reach a
35715 point at which they no longer get any bigger, as long as they are regularly
35716 tidied.
35717
35718 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35719 databases is likely to keep on increasing.
35720
35721
35722
35723
35724 .section "exim_fixdb" "SECID263"
35725 .cindex "&'exim_fixdb'&"
35726 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35727 Its main use is for testing Exim, but it might also be occasionally useful for
35728 getting round problems in a live system. It has no options, and its interface
35729 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35730 key of a database record can then be entered, and the data for that record is
35731 displayed.
35732
35733 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35734 except the &'retry'& database, that is the only operation that can be carried
35735 out. For the &'retry'& database, each field is output preceded by a number, and
35736 data for individual fields can be changed by typing the field number followed
35737 by new data, for example:
35738 .code
35739 > 4 951102:1000
35740 .endd
35741 resets the time of the next delivery attempt. Time values are given as a
35742 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35743 used as optional separators.
35744
35745
35746
35747
35748 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35749 .cindex "mailbox" "maintenance"
35750 .cindex "&'exim_lock'&"
35751 .cindex "locking mailboxes"
35752 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35753 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35754 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35755 a user agent while investigating a problem. The utility requires the name of
35756 the file as its first argument. If the locking is successful, the second
35757 argument is run as a command (using C's &[system()]& function); if there is no
35758 second argument, the value of the SHELL environment variable is used; if this
35759 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35760 is unlocked and the utility ends. The following options are available:
35761
35762 .vlist
35763 .vitem &%-fcntl%&
35764 Use &[fcntl()]& locking on the open mailbox.
35765
35766 .vitem &%-flock%&
35767 Use &[flock()]& locking on the open mailbox, provided the operating system
35768 supports it.
35769
35770 .vitem &%-interval%&
35771 This must be followed by a number, which is a number of seconds; it sets the
35772 interval to sleep between retries (default 3).
35773
35774 .vitem &%-lockfile%&
35775 Create a lock file before opening the mailbox.
35776
35777 .vitem &%-mbx%&
35778 Lock the mailbox using MBX rules.
35779
35780 .vitem &%-q%&
35781 Suppress verification output.
35782
35783 .vitem &%-retries%&
35784 This must be followed by a number; it sets the number of times to try to get
35785 the lock (default 10).
35786
35787 .vitem &%-restore_time%&
35788 This option causes &%exim_lock%& to restore the modified and read times to the
35789 locked file before exiting. This allows you to access a locked mailbox (for
35790 example, to take a backup copy) without disturbing the times that the user
35791 subsequently sees.
35792
35793 .vitem &%-timeout%&
35794 This must be followed by a number, which is a number of seconds; it sets a
35795 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35796 default), a non-blocking call is used.
35797
35798 .vitem &%-v%&
35799 Generate verbose output.
35800 .endlist
35801
35802 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35803 default is to create a lock file and also to use &[fcntl()]& locking on the
35804 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35805 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35806 requires that the directory containing the file be writeable. Locking by lock
35807 file does not last for ever; Exim assumes that a lock file is expired if it is
35808 more than 30 minutes old.
35809
35810 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35811 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35812 to be taken out on the open mailbox, and an exclusive lock on the file
35813 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35814 number of the mailbox file. When the locking is released, if an exclusive lock
35815 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35816
35817 The default output contains verification of the locking that takes place. The
35818 &%-v%& option causes some additional information to be given. The &%-q%& option
35819 suppresses all output except error messages.
35820
35821 A command such as
35822 .code
35823 exim_lock /var/spool/mail/spqr
35824 .endd
35825 runs an interactive shell while the file is locked, whereas
35826 .display
35827 &`exim_lock -q /var/spool/mail/spqr <<End`&
35828 <&'some commands'&>
35829 &`End`&
35830 .endd
35831 runs a specific non-interactive sequence of commands while the file is locked,
35832 suppressing all verification output. A single command can be run by a command
35833 such as
35834 .code
35835 exim_lock -q /var/spool/mail/spqr \
35836   "cp /var/spool/mail/spqr /some/where"
35837 .endd
35838 Note that if a command is supplied, it must be entirely contained within the
35839 second argument &-- hence the quotes.
35840 .ecindex IIDutils
35841
35842
35843 . ////////////////////////////////////////////////////////////////////////////
35844 . ////////////////////////////////////////////////////////////////////////////
35845
35846 .chapter "The Exim monitor" "CHAPeximon"
35847 .scindex IIDeximon "Exim monitor" "description"
35848 .cindex "X-windows"
35849 .cindex "&'eximon'&"
35850 .cindex "Local/eximon.conf"
35851 .cindex "&_exim_monitor/EDITME_&"
35852 The Exim monitor is an application which displays in an X window information
35853 about the state of Exim's queue and what Exim is doing. An admin user can
35854 perform certain operations on messages from this GUI interface; however all
35855 such facilities are also available from the command line, and indeed, the
35856 monitor itself makes use of the command line to perform any actions requested.
35857
35858
35859
35860 .section "Running the monitor" "SECID264"
35861 The monitor is started by running the script called &'eximon'&. This is a shell
35862 script that sets up a number of environment variables, and then runs the
35863 binary called &_eximon.bin_&. The default appearance of the monitor window can
35864 be changed by editing the &_Local/eximon.conf_& file created by editing
35865 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35866 parameters are for.
35867
35868 The parameters that get built into the &'eximon'& script can be overridden for
35869 a particular invocation by setting up environment variables of the same names,
35870 preceded by &`EXIMON_`&. For example, a shell command such as
35871 .code
35872 EXIMON_LOG_DEPTH=400 eximon
35873 .endd
35874 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35875 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35876 overrides the Exim log file configuration. This makes it possible to have
35877 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35878 syslog messages are routed to a file on the local host.
35879
35880 X resources can be used to change the appearance of the window in the normal
35881 way. For example, a resource setting of the form
35882 .code
35883 Eximon*background: gray94
35884 .endd
35885 changes the colour of the background to light grey rather than white. The
35886 stripcharts are drawn with both the data lines and the reference lines in
35887 black. This means that the reference lines are not visible when on top of the
35888 data. However, their colour can be changed by setting a resource called
35889 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35890 For example, if your X server is running Unix, you could set up lighter
35891 reference lines in the stripcharts by obeying
35892 .code
35893 xrdb -merge <<End
35894 Eximon*highlight: gray
35895 End
35896 .endd
35897 .cindex "admin user"
35898 In order to see the contents of messages on the queue, and to operate on them,
35899 &'eximon'& must either be run as root or by an admin user.
35900
35901 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35902 contain X11 resource parameters interpreted by the X11 library.  In addition,
35903 if the first parameter starts with the string "gdb" then it is removed and the
35904 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35905 versioned variants of gdb can be invoked).
35906
35907 The monitor's window is divided into three parts. The first contains one or
35908 more stripcharts and two action buttons, the second contains a &"tail"& of the
35909 main log file, and the third is a display of the queue of messages awaiting
35910 delivery, with two more action buttons. The following sections describe these
35911 different parts of the display.
35912
35913
35914
35915
35916 .section "The stripcharts" "SECID265"
35917 .cindex "stripchart"
35918 The first stripchart is always a count of messages on the queue. Its name can
35919 be configured by setting QUEUE_STRIPCHART_NAME in the
35920 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35921 configuration script by regular expression matches on log file entries, making
35922 it possible to display, for example, counts of messages delivered to certain
35923 hosts or using certain transports. The supplied defaults display counts of
35924 received and delivered messages, and of local and SMTP deliveries. The default
35925 period between stripchart updates is one minute; this can be adjusted by a
35926 parameter in the &_Local/eximon.conf_& file.
35927
35928 The stripchart displays rescale themselves automatically as the value they are
35929 displaying changes. There are always 10 horizontal lines in each chart; the
35930 title string indicates the value of each division when it is greater than one.
35931 For example, &"x2"& means that each division represents a value of 2.
35932
35933 It is also possible to have a stripchart which shows the percentage fullness of
35934 a particular disk partition, which is useful when local deliveries are confined
35935 to a single partition.
35936
35937 .cindex "&%statvfs%& function"
35938 This relies on the availability of the &[statvfs()]& function or equivalent in
35939 the operating system. Most, but not all versions of Unix that support Exim have
35940 this. For this particular stripchart, the top of the chart always represents
35941 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35942 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35943 &_Local/eximon.conf_& file.
35944
35945
35946
35947
35948 .section "Main action buttons" "SECID266"
35949 .cindex "size" "of monitor window"
35950 .cindex "Exim monitor" "window size"
35951 .cindex "window size"
35952 Below the stripcharts there is an action button for quitting the monitor. Next
35953 to this is another button marked &"Size"&. They are placed here so that
35954 shrinking the window to its default minimum size leaves just the queue count
35955 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35956 the window to expand to its maximum size, unless it is already at the maximum,
35957 in which case it is reduced to its minimum.
35958
35959 When expanding to the maximum, if the window cannot be fully seen where it
35960 currently is, it is moved back to where it was the last time it was at full
35961 size. When it is expanding from its minimum size, the old position is
35962 remembered, and next time it is reduced to the minimum it is moved back there.
35963
35964 The idea is that you can keep a reduced window just showing one or two
35965 stripcharts at a convenient place on your screen, easily expand it to show
35966 the full window when required, and just as easily put it back to what it was.
35967 The idea is copied from what the &'twm'& window manager does for its
35968 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35969 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35970
35971 Normally, the monitor starts up with the window at its full size, but it can be
35972 built so that it starts up with the window at its smallest size, by setting
35973 START_SMALL=yes in &_Local/eximon.conf_&.
35974
35975
35976
35977 .section "The log display" "SECID267"
35978 .cindex "log" "tail of; in monitor"
35979 The second section of the window is an area in which a display of the tail of
35980 the main log is maintained.
35981 To save space on the screen, the timestamp on each log line is shortened by
35982 removing the date and, if &%log_timezone%& is set, the timezone.
35983 The log tail is not available when the only destination for logging data is
35984 syslog, unless the syslog lines are routed to a local file whose name is passed
35985 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35986
35987 The log sub-window has a scroll bar at its lefthand side which can be used to
35988 move back to look at earlier text, and the up and down arrow keys also have a
35989 scrolling effect. The amount of log that is kept depends on the setting of
35990 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35991 to use. When this is full, the earlier 50% of data is discarded &-- this is
35992 much more efficient than throwing it away line by line. The sub-window also has
35993 a horizontal scroll bar for accessing the ends of long log lines. This is the
35994 only means of horizontal scrolling; the right and left arrow keys are not
35995 available. Text can be cut from this part of the window using the mouse in the
35996 normal way. The size of this subwindow is controlled by parameters in the
35997 configuration file &_Local/eximon.conf_&.
35998
35999 Searches of the text in the log window can be carried out by means of the ^R
36000 and ^S keystrokes, which default to a reverse and a forward search,
36001 respectively. The search covers only the text that is displayed in the window.
36002 It cannot go further back up the log.
36003
36004 The point from which the search starts is indicated by a caret marker. This is
36005 normally at the end of the text in the window, but can be positioned explicitly
36006 by pointing and clicking with the left mouse button, and is moved automatically
36007 by a successful search. If new text arrives in the window when it is scrolled
36008 back, the caret remains where it is, but if the window is not scrolled back,
36009 the caret is moved to the end of the new text.
36010
36011 Pressing ^R or ^S pops up a window into which the search text can be typed.
36012 There are buttons for selecting forward or reverse searching, for carrying out
36013 the search, and for cancelling. If the &"Search"& button is pressed, the search
36014 happens and the window remains so that further searches can be done. If the
36015 &"Return"& key is pressed, a single search is done and the window is closed. If
36016 ^C is typed the search is cancelled.
36017
36018 The searching facility is implemented using the facilities of the Athena text
36019 widget. By default this pops up a window containing both &"search"& and
36020 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36021 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36022 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36023 provided version of &%TextPop%& when the remaining parts of the text widget
36024 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36025 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36026 on these systems, at the expense of having unwanted items in the search popup
36027 window.
36028
36029
36030
36031 .section "The queue display" "SECID268"
36032 .cindex "queue" "display in monitor"
36033 The bottom section of the monitor window contains a list of all messages that
36034 are on the queue, which includes those currently being received or delivered,
36035 as well as those awaiting delivery. The size of this subwindow is controlled by
36036 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36037 at which it is updated is controlled by another parameter in the same file &--
36038 the default is 5 minutes, since queue scans can be quite expensive. However,
36039 there is an &"Update"& action button just above the display which can be used
36040 to force an update of the queue display at any time.
36041
36042 When a host is down for some time, a lot of pending mail can build up for it,
36043 and this can make it hard to deal with other messages on the queue. To help
36044 with this situation there is a button next to &"Update"& called &"Hide"&. If
36045 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36046 type anything in here and press &"Return"&, the text is added to a chain of
36047 such texts, and if every undelivered address in a message matches at least one
36048 of the texts, the message is not displayed.
36049
36050 If there is an address that does not match any of the texts, all the addresses
36051 are displayed as normal. The matching happens on the ends of addresses so, for
36052 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36053 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36054 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36055 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36056 a hide request is automatically cancelled after one hour.
36057
36058 While the dialogue box is displayed, you can't press any buttons or do anything
36059 else to the monitor window. For this reason, if you want to cut text from the
36060 queue display to use in the dialogue box, you have to do the cutting before
36061 pressing the &"Hide"& button.
36062
36063 The queue display contains, for each unhidden queued message, the length of
36064 time it has been on the queue, the size of the message, the message id, the
36065 message sender, and the first undelivered recipient, all on one line. If it is
36066 a bounce message, the sender is shown as &"<>"&. If there is more than one
36067 recipient to which the message has not yet been delivered, subsequent ones are
36068 listed on additional lines, up to a maximum configured number, following which
36069 an ellipsis is displayed. Recipients that have already received the message are
36070 not shown.
36071
36072 .cindex "frozen messages" "display"
36073 If a message is frozen, an asterisk is displayed at the left-hand side.
36074
36075 The queue display has a vertical scroll bar, and can also be scrolled by means
36076 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36077 The text searching facilities, as described above for the log window, are also
36078 available, but the caret is always moved to the end of the text when the queue
36079 display is updated.
36080
36081
36082
36083 .section "The queue menu" "SECID269"
36084 .cindex "queue" "menu in monitor"
36085 If the &%shift%& key is held down and the left button is clicked when the mouse
36086 pointer is over the text for any message, an action menu pops up, and the first
36087 line of the queue display for the message is highlighted. This does not affect
36088 any selected text.
36089
36090 If you want to use some other event for popping up the menu, you can set the
36091 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36092 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36093 value set in this parameter is a standard X event description. For example, to
36094 run eximon using &%ctrl%& rather than &%shift%& you could use
36095 .code
36096 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36097 .endd
36098 The title of the menu is the message id, and it contains entries which act as
36099 follows:
36100
36101 .ilist
36102 &'message log'&: The contents of the message log for the message are displayed
36103 in a new text window.
36104 .next
36105 &'headers'&: Information from the spool file that contains the envelope
36106 information and headers is displayed in a new text window. See chapter
36107 &<<CHAPspool>>& for a description of the format of spool files.
36108 .next
36109 &'body'&: The contents of the spool file containing the body of the message are
36110 displayed in a new text window. There is a default limit of 20,000 bytes to the
36111 amount of data displayed. This can be changed by setting the BODY_MAX
36112 option at compile time, or the EXIMON_BODY_MAX option at run time.
36113 .next
36114 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36115 delivery of the message. This causes an automatic thaw if the message is
36116 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36117 a new text window. The delivery is run in a separate process, to avoid holding
36118 up the monitor while the delivery proceeds.
36119 .next
36120 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36121 that the message be frozen.
36122 .next
36123 .cindex "thawing messages"
36124 .cindex "unfreezing messages"
36125 .cindex "frozen messages" "thawing"
36126 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36127 that the message be thawed.
36128 .next
36129 .cindex "delivery" "forcing failure"
36130 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36131 that Exim gives up trying to deliver the message. A bounce message is generated
36132 for any remaining undelivered addresses.
36133 .next
36134 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36135 that the message be deleted from the system without generating a bounce
36136 message.
36137 .next
36138 &'add recipient'&: A dialog box is displayed into which a recipient address can
36139 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36140 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36141 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36142 causes a call to Exim to be made using the &%-Mar%& option to request that an
36143 additional recipient be added to the message, unless the entry box is empty, in
36144 which case no action is taken.
36145 .next
36146 &'mark delivered'&: A dialog box is displayed into which a recipient address
36147 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36148 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36149 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36150 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36151 recipient address as already delivered, unless the entry box is empty, in which
36152 case no action is taken.
36153 .next
36154 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36155 mark all recipient addresses as already delivered.
36156 .next
36157 &'edit sender'&: A dialog box is displayed initialized with the current
36158 sender's address. Pressing RETURN causes a call to Exim to be made using the
36159 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36160 in which case no action is taken. If you want to set an empty sender (as in
36161 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36162 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36163 the address is qualified with that domain.
36164 .endlist
36165
36166 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36167 other cases when a call to Exim is made, if there is any output from Exim (in
36168 particular, if the command fails) a window containing the command and the
36169 output is displayed. Otherwise, the results of the action are normally apparent
36170 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36171 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36172 if no output is generated.
36173
36174 The queue display is automatically updated for actions such as freezing and
36175 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36176 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36177 force an update of the display after one of these actions.
36178
36179 In any text window that is displayed as result of a menu action, the normal
36180 cut-and-paste facility is available, and searching can be carried out using ^R
36181 and ^S, as described above for the log tail window.
36182 .ecindex IIDeximon
36183
36184
36185
36186
36187
36188 . ////////////////////////////////////////////////////////////////////////////
36189 . ////////////////////////////////////////////////////////////////////////////
36190
36191 .chapter "Security considerations" "CHAPsecurity"
36192 .scindex IIDsecurcon "security" "discussion of"
36193 This chapter discusses a number of issues concerned with security, some of
36194 which are also covered in other parts of this manual.
36195
36196 For reasons that this author does not understand, some people have promoted
36197 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36198 existence of this chapter in the documentation. However, the intent of the
36199 chapter is simply to describe the way Exim works in relation to certain
36200 security concerns, not to make any specific claims about the effectiveness of
36201 its security as compared with other MTAs.
36202
36203 What follows is a description of the way Exim is supposed to be. Best efforts
36204 have been made to try to ensure that the code agrees with the theory, but an
36205 absence of bugs can never be guaranteed. Any that are reported will get fixed
36206 as soon as possible.
36207
36208
36209 .section "Building a more &""hardened""& Exim" "SECID286"
36210 .cindex "security" "build-time features"
36211 There are a number of build-time options that can be set in &_Local/Makefile_&
36212 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36213 Exim administrator who does not have the root password, or by someone who has
36214 penetrated the Exim (but not the root) account. These options are as follows:
36215
36216 .ilist
36217 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36218 start of any file names used with the &%-C%& option. When it is set, these file
36219 names are also not allowed to contain the sequence &"/../"&. (However, if the
36220 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36221 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36222 default setting for &%ALT_CONFIG_PREFIX%&.
36223
36224 If the permitted configuration files are confined to a directory to
36225 which only root has access, this guards against someone who has broken
36226 into the Exim account from running a privileged Exim with an arbitrary
36227 configuration file, and using it to break into other accounts.
36228 .next
36229
36230 If a non-trusted configuration file (i.e. not the default configuration file
36231 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36232 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36233 the next item), then root privilege is retained only if the caller of Exim is
36234 root. This locks out the possibility of testing a configuration using &%-C%&
36235 right through message reception and delivery, even if the caller is root. The
36236 reception works, but by that time, Exim is running as the Exim user, so when
36237 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36238 privilege to be lost. However, root can test reception and delivery using two
36239 separate commands.
36240
36241 .next
36242 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36243 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36244 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36245 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36246 the restrictive side.  Requiring build-time selection of safe macros is onerous
36247 but this option is intended solely as a transition mechanism to permit
36248 previously-working configurations to continue to work after release 4.73.
36249 .next
36250 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36251 is disabled.
36252 .next
36253 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36254 never to be used for any deliveries. This is like the &%never_users%& runtime
36255 option, but it cannot be overridden; the runtime option adds additional users
36256 to the list. The default setting is &"root"&; this prevents a non-root user who
36257 is permitted to modify the runtime file from using Exim as a way to get root.
36258 .endlist
36259
36260
36261
36262 .section "Root privilege" "SECID270"
36263 .cindex "setuid"
36264 .cindex "root privilege"
36265 The Exim binary is normally setuid to root, which means that it gains root
36266 privilege (runs as root) when it starts execution. In some special cases (for
36267 example, when the daemon is not in use and there are no local deliveries), it
36268 may be possible to run Exim setuid to some user other than root. This is
36269 discussed in the next section. However, in most installations, root privilege
36270 is required for two things:
36271
36272 .ilist
36273 To set up a socket connected to the standard SMTP port (25) when initialising
36274 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36275 not required.
36276 .next
36277 To be able to change uid and gid in order to read users' &_.forward_& files and
36278 perform local deliveries as the receiving user or as specified in the
36279 configuration.
36280 .endlist
36281
36282 It is not necessary to be root to do any of the other things Exim does, such as
36283 receiving messages and delivering them externally over SMTP, and it is
36284 obviously more secure if Exim does not run as root except when necessary.
36285 For this reason, a user and group for Exim to use must be defined in
36286 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36287 group"&. Their values can be changed by the run time configuration, though this
36288 is not recommended. Often a user called &'exim'& is used, but some sites use
36289 &'mail'& or another user name altogether.
36290
36291 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36292 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36293 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36294
36295 After a new Exim process has interpreted its command line options, it changes
36296 uid and gid in the following cases:
36297
36298 .ilist
36299 .oindex "&%-C%&"
36300 .oindex "&%-D%&"
36301 If the &%-C%& option is used to specify an alternate configuration file, or if
36302 the &%-D%& option is used to define macro values for the configuration, and the
36303 calling process is not running as root, the uid and gid are changed to those of
36304 the calling process.
36305 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36306 option may not be used at all.
36307 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36308 can be supplied if the calling process is running as root, the Exim run-time
36309 user or CONFIGURE_OWNER, if defined.
36310 .next
36311 .oindex "&%-be%&"
36312 .oindex "&%-bf%&"
36313 .oindex "&%-bF%&"
36314 If the expansion test option (&%-be%&) or one of the filter testing options
36315 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36316 calling process.
36317 .next
36318 If the process is not a daemon process or a queue runner process or a delivery
36319 process or a process for testing address routing (started with &%-bt%&), the
36320 uid and gid are changed to the Exim user and group. This means that Exim always
36321 runs under its own uid and gid when receiving messages. This also applies when
36322 testing address verification
36323 .oindex "&%-bv%&"
36324 .oindex "&%-bh%&"
36325 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36326 option).
36327 .next
36328 For a daemon, queue runner, delivery, or address testing process, the uid
36329 remains as root at this stage, but the gid is changed to the Exim group.
36330 .endlist
36331
36332 The processes that initially retain root privilege behave as follows:
36333
36334 .ilist
36335 A daemon process changes the gid to the Exim group and the uid to the Exim
36336 user after setting up one or more listening sockets. The &[initgroups()]&
36337 function is called, so that if the Exim user is in any additional groups, they
36338 will be used during message reception.
36339 .next
36340 A queue runner process retains root privilege throughout its execution. Its
36341 job is to fork a controlled sequence of delivery processes.
36342 .next
36343 A delivery process retains root privilege throughout most of its execution,
36344 but any actual deliveries (that is, the transports themselves) are run in
36345 subprocesses which always change to a non-root uid and gid. For local
36346 deliveries this is typically the uid and gid of the owner of the mailbox; for
36347 remote deliveries, the Exim uid and gid are used. Once all the delivery
36348 subprocesses have been run, a delivery process changes to the Exim uid and gid
36349 while doing post-delivery tidying up such as updating the retry database and
36350 generating bounce and warning messages.
36351
36352 While the recipient addresses in a message are being routed, the delivery
36353 process runs as root. However, if a user's filter file has to be processed,
36354 this is done in a subprocess that runs under the individual user's uid and
36355 gid. A system filter is run as root unless &%system_filter_user%& is set.
36356 .next
36357 A process that is testing addresses (the &%-bt%& option) runs as root so that
36358 the routing is done in the same environment as a message delivery.
36359 .endlist
36360
36361
36362
36363
36364 .section "Running Exim without privilege" "SECTrunexiwitpri"
36365 .cindex "privilege, running without"
36366 .cindex "unprivileged running"
36367 .cindex "root privilege" "running without"
36368 Some installations like to run Exim in an unprivileged state for more of its
36369 operation, for added security. Support for this mode of operation is provided
36370 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36371 gid are changed to the Exim user and group at the start of a delivery process
36372 (and also queue runner and address testing processes). This means that address
36373 routing is no longer run as root, and the deliveries themselves cannot change
36374 to any other uid.
36375
36376 .cindex SIGHUP
36377 .cindex "daemon" "restarting"
36378 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36379 that the daemon can still be started in the usual way, and it can respond
36380 correctly to SIGHUP because the re-invocation regains root privilege.
36381
36382 An alternative approach is to make Exim setuid to the Exim user and also setgid
36383 to the Exim group. If you do this, the daemon must be started from a root
36384 process. (Calling Exim from a root process makes it behave in the way it does
36385 when it is setuid root.) However, the daemon cannot restart itself after a
36386 SIGHUP signal because it cannot regain privilege.
36387
36388 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36389 stops Exim from trying to re-invoke itself to do a delivery after a message has
36390 been received. Such a re-invocation is a waste of resources because it has no
36391 effect.
36392
36393 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36394 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36395 to the Exim user seems a clean approach, but there is one complication:
36396
36397 In this style of operation, Exim is running with the real uid and gid set to
36398 those of the calling process, and the effective uid/gid set to Exim's values.
36399 Ideally, any association with the calling process' uid/gid should be dropped,
36400 that is, the real uid/gid should be reset to the effective values so as to
36401 discard any privileges that the caller may have. While some operating systems
36402 have a function that permits this action for a non-root effective uid, quite a
36403 number of them do not. Because of this lack of standardization, Exim does not
36404 address this problem at this time.
36405
36406 For this reason, the recommended approach for &"mostly unprivileged"& running
36407 is to keep the Exim binary setuid to root, and to set
36408 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36409 be used in the most straightforward way.
36410
36411 If you configure Exim not to run delivery processes as root, there are a
36412 number of restrictions on what you can do:
36413
36414 .ilist
36415 You can deliver only as the Exim user/group. You should  explicitly use the
36416 &%user%& and &%group%& options to override routers or local transports that
36417 normally deliver as the recipient. This makes sure that configurations that
36418 work in this mode function the same way in normal mode. Any implicit or
36419 explicit specification of another user causes an error.
36420 .next
36421 Use of &_.forward_& files is severely restricted, such that it is usually
36422 not worthwhile to include them in the configuration.
36423 .next
36424 Users who wish to use &_.forward_& would have to make their home directory and
36425 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36426 and their equivalents in Exim filters, cannot be used. While they could be
36427 enabled in the Exim user's name, that would be insecure and not very useful.
36428 .next
36429 Unless the local user mailboxes are all owned by the Exim user (possible in
36430 some POP3 or IMAP-only environments):
36431
36432 .olist
36433 They must be owned by the Exim group and be writeable by that group. This
36434 implies you must set &%mode%& in the appendfile configuration, as well as the
36435 mode of the mailbox files themselves.
36436 .next
36437 You must set &%no_check_owner%&, since most or all of the files will not be
36438 owned by the Exim user.
36439 .next
36440 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36441 on a newly created mailbox when unprivileged. This also implies that new
36442 mailboxes need to be created manually.
36443 .endlist olist
36444 .endlist ilist
36445
36446
36447 These restrictions severely restrict what can be done in local deliveries.
36448 However, there are no restrictions on remote deliveries. If you are running a
36449 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36450 gives more security at essentially no cost.
36451
36452 If you are using the &%mua_wrapper%& facility (see chapter
36453 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36454
36455
36456
36457
36458 .section "Delivering to local files" "SECID271"
36459 Full details of the checks applied by &(appendfile)& before it writes to a file
36460 are given in chapter &<<CHAPappendfile>>&.
36461
36462
36463
36464 .section "Running local commands" "SECTsecconslocalcmds"
36465 .cindex "security" "local commands"
36466 .cindex "security" "command injection attacks"
36467 There are a number of ways in which an administrator can configure Exim to run
36468 commands based upon received, untrustworthy, data. Further, in some
36469 configurations a user who can control a &_.forward_& file can also arrange to
36470 run commands. Configuration to check includes, but is not limited to:
36471
36472 .ilist
36473 Use of &%use_shell%& in the pipe transport: various forms of shell command
36474 injection may be possible with this option present. It is dangerous and should
36475 be used only with considerable caution. Consider constraints which whitelist
36476 allowed characters in a variable which is to be used in a pipe transport that
36477 has &%use_shell%& enabled.
36478 .next
36479 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36480 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36481 &_.forward_& files in a redirect router. If Exim is running on a central mail
36482 hub to which ordinary users do not have shell access, but home directories are
36483 NFS mounted (for instance) then administrators should review the list of these
36484 forbid options available, and should bear in mind that the options that may
36485 need forbidding can change as new features are added between releases.
36486 .next
36487 The &%${run...}%& expansion item does not use a shell by default, but
36488 administrators can configure use of &_/bin/sh_& as part of the command.
36489 Such invocations should be viewed with prejudicial suspicion.
36490 .next
36491 Administrators who use embedded Perl are advised to explore how Perl's
36492 taint checking might apply to their usage.
36493 .next
36494 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36495 administrators are well advised to view its use with suspicion, in case (for
36496 instance) it allows a local-part to contain embedded Exim directives.
36497 .next
36498 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36499 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36500 each can reference arbitrary lists and files, rather than just being a list
36501 of opaque strings.
36502 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36503 real-world security vulnerabilities caused by its use with untrustworthy data
36504 injected in, for SQL injection attacks.
36505 Consider the use of the &%inlisti%& expansion condition instead.
36506 .endlist
36507
36508
36509
36510
36511 .section "Trust in configuration data" "SECTsecconfdata"
36512 .cindex "security" "data sources"
36513 .cindex "security" "regular expressions"
36514 .cindex "regular expressions" "security"
36515 .cindex "PCRE" "security"
36516 If configuration data for Exim can come from untrustworthy sources, there
36517 are some issues to be aware of:
36518
36519 .ilist
36520 Use of &%${expand...}%& may provide a path for shell injection attacks.
36521 .next
36522 Letting untrusted data provide a regular expression is unwise.
36523 .next
36524 Using &%${match...}%& to apply a fixed regular expression against untrusted
36525 data may result in pathological behaviour within PCRE.  Be aware of what
36526 "backtracking" means and consider options for being more strict with a regular
36527 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36528 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36529 possessive quantifiers or just not using regular expressions against untrusted
36530 data.
36531 .next
36532 It can be important to correctly use &%${quote:...}%&,
36533 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36534 items to ensure that data is correctly constructed.
36535 .next
36536 Some lookups might return multiple results, even though normal usage is only
36537 expected to yield one result.
36538 .endlist
36539
36540
36541
36542
36543 .section "IPv4 source routing" "SECID272"
36544 .cindex "source routing" "in IP packets"
36545 .cindex "IP source routing"
36546 Many operating systems suppress IP source-routed packets in the kernel, but
36547 some cannot be made to do this, so Exim does its own check. It logs incoming
36548 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36549 IPv6. No special checking is currently done.
36550
36551
36552
36553 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36554 Support for these SMTP commands is disabled by default. If required, they can
36555 be enabled by defining suitable ACLs.
36556
36557
36558
36559
36560 .section "Privileged users" "SECID274"
36561 .cindex "trusted users"
36562 .cindex "admin user"
36563 .cindex "privileged user"
36564 .cindex "user" "trusted"
36565 .cindex "user" "admin"
36566 Exim recognizes two sets of users with special privileges. Trusted users are
36567 able to submit new messages to Exim locally, but supply their own sender
36568 addresses and information about a sending host. For other users submitting
36569 local messages, Exim sets up the sender address from the uid, and doesn't
36570 permit a remote host to be specified.
36571
36572 .oindex "&%-f%&"
36573 However, an untrusted user is permitted to use the &%-f%& command line option
36574 in the special form &%-f <>%& to indicate that a delivery failure for the
36575 message should not cause an error report. This affects the message's envelope,
36576 but it does not affect the &'Sender:'& header. Untrusted users may also be
36577 permitted to use specific forms of address with the &%-f%& option by setting
36578 the &%untrusted_set_sender%& option.
36579
36580 Trusted users are used to run processes that receive mail messages from some
36581 other mail domain and pass them on to Exim for delivery either locally, or over
36582 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36583 as any user listed in the &%trusted_users%& configuration option, or under any
36584 group listed in the &%trusted_groups%& option.
36585
36586 Admin users are permitted to do things to the messages on Exim's queue. They
36587 can freeze or thaw messages, cause them to be returned to their senders, remove
36588 them entirely, or modify them in various ways. In addition, admin users can run
36589 the Exim monitor and see all the information it is capable of providing, which
36590 includes the contents of files on the spool.
36591
36592 .oindex "&%-M%&"
36593 .oindex "&%-q%&"
36594 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36595 delivery of messages on its queue is restricted to admin users. This
36596 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36597 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36598 queue is also restricted to admin users. This restriction can be relaxed by
36599 setting &%no_queue_list_requires_admin%&.
36600
36601 Exim recognizes an admin user if the calling process is running as root or as
36602 the Exim user or if any of the groups associated with the calling process is
36603 the Exim group. It is not necessary actually to be running under the Exim
36604 group. However, if admin users who are not root or the Exim user are to access
36605 the contents of files on the spool via the Exim monitor (which runs
36606 unprivileged), Exim must be built to allow group read access to its spool
36607 files.
36608
36609
36610
36611 .section "Spool files" "SECID275"
36612 .cindex "spool directory" "files"
36613 Exim's spool directory and everything it contains is owned by the Exim user and
36614 set to the Exim group. The mode for spool files is defined in the
36615 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36616 any user who is a member of the Exim group can access these files.
36617
36618
36619
36620 .section "Use of argv[0]" "SECID276"
36621 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36622 of specific strings, Exim assumes certain options. For example, calling Exim
36623 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36624 to calling it with the option &%-bS%&. There are no security implications in
36625 this.
36626
36627
36628
36629 .section "Use of %f formatting" "SECID277"
36630 The only use made of &"%f"& by Exim is in formatting load average values. These
36631 are actually stored in integer variables as 1000 times the load average.
36632 Consequently, their range is limited and so therefore is the length of the
36633 converted output.
36634
36635
36636
36637 .section "Embedded Exim path" "SECID278"
36638 Exim uses its own path name, which is embedded in the code, only when it needs
36639 to re-exec in order to regain root privilege. Therefore, it is not root when it
36640 does so. If some bug allowed the path to get overwritten, it would lead to an
36641 arbitrary program's being run as exim, not as root.
36642
36643
36644
36645 .section "Dynamic module directory" "SECTdynmoddir"
36646 Any dynamically loadable modules must be installed into the directory
36647 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36648 loading it.
36649
36650
36651 .section "Use of sprintf()" "SECID279"
36652 .cindex "&[sprintf()]&"
36653 A large number of occurrences of &"sprintf"& in the code are actually calls to
36654 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36655 The intermediate formatting is done into a large fixed buffer by a function
36656 that runs through the format string itself, and checks the length of each
36657 conversion before performing it, thus preventing buffer overruns.
36658
36659 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36660 the output buffer is known to be sufficiently long to contain the converted
36661 string.
36662
36663
36664
36665 .section "Use of debug_printf() and log_write()" "SECID280"
36666 Arbitrary strings are passed to both these functions, but they do their
36667 formatting by calling the function &'string_vformat()'&, which runs through
36668 the format string itself, and checks the length of each conversion.
36669
36670
36671
36672 .section "Use of strcat() and strcpy()" "SECID281"
36673 These are used only in cases where the output buffer is known to be large
36674 enough to hold the result.
36675 .ecindex IIDsecurcon
36676
36677
36678
36679
36680 . ////////////////////////////////////////////////////////////////////////////
36681 . ////////////////////////////////////////////////////////////////////////////
36682
36683 .chapter "Format of spool files" "CHAPspool"
36684 .scindex IIDforspo1 "format" "spool files"
36685 .scindex IIDforspo2 "spool directory" "format of files"
36686 .scindex IIDforspo3 "spool files" "format of"
36687 .cindex "spool files" "editing"
36688 A message on Exim's queue consists of two files, whose names are the message id
36689 followed by -D and -H, respectively. The data portion of the message is kept in
36690 the -D file on its own. The message's envelope, status, and headers are all
36691 kept in the -H file, whose format is described in this chapter. Each of these
36692 two files contains the final component of its own name as its first line. This
36693 is insurance against disk crashes where the directory is lost but the files
36694 themselves are recoverable.
36695
36696 Some people are tempted into editing -D files in order to modify messages. You
36697 need to be extremely careful if you do this; it is not recommended and you are
36698 on your own if you do it. Here are some of the pitfalls:
36699
36700 .ilist
36701 You must ensure that Exim does not try to deliver the message while you are
36702 fiddling with it. The safest way is to take out a write lock on the -D file,
36703 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36704 place, the lock will be retained. If you write a new file and rename it, the
36705 lock will be lost at the instant of rename.
36706 .next
36707 .vindex "&$body_linecount$&"
36708 If you change the number of lines in the file, the value of
36709 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36710 present, this value is not used by Exim, but there is no guarantee that this
36711 will always be the case.
36712 .next
36713 If the message is in MIME format, you must take care not to break it.
36714 .next
36715 If the message is cryptographically signed, any change will invalidate the
36716 signature.
36717 .endlist
36718 All in all, modifying -D files is fraught with danger.
36719
36720 Files whose names end with -J may also be seen in the &_input_& directory (or
36721 its subdirectories when &%split_spool_directory%& is set). These are journal
36722 files, used to record addresses to which the message has been delivered during
36723 the course of a delivery attempt. If there are still undelivered recipients at
36724 the end, the -H file is updated, and the -J file is deleted. If, however, there
36725 is some kind of crash (for example, a power outage) before this happens, the -J
36726 file remains in existence. When Exim next processes the message, it notices the
36727 -J file and uses it to update the -H file before starting the next delivery
36728 attempt.
36729
36730 .section "Format of the -H file" "SECID282"
36731 .cindex "uid (user id)" "in spool file"
36732 .cindex "gid (group id)" "in spool file"
36733 The second line of the -H file contains the login name for the uid of the
36734 process that called Exim to read the message, followed by the numerical uid and
36735 gid. For a locally generated message, this is normally the user who sent the
36736 message. For a message received over TCP/IP via the daemon, it is
36737 normally the Exim user.
36738
36739 The third line of the file contains the address of the message's sender as
36740 transmitted in the envelope, contained in angle brackets. The sender address is
36741 empty for bounce messages. For incoming SMTP mail, the sender address is given
36742 in the MAIL command. For locally generated mail, the sender address is
36743 created by Exim from the login name of the current user and the configured
36744 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36745 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36746 &"<>"& or an address that matches &%untrusted_set_senders%&.
36747
36748 The fourth line contains two numbers. The first is the time that the message
36749 was received, in the conventional Unix form &-- the number of seconds since the
36750 start of the epoch. The second number is a count of the number of messages
36751 warning of delayed delivery that have been sent to the sender.
36752
36753 There follow a number of lines starting with a hyphen. These can appear in any
36754 order, and are omitted when not relevant:
36755
36756 .vlist
36757 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36758 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36759 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36760 recognized, to provide backward compatibility. In the old format, a line of
36761 this form is present for every ACL variable that is not empty. The number
36762 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36763 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36764 the data string for the variable. The string itself starts at the beginning of
36765 the next line, and is followed by a newline character. It may contain internal
36766 newlines.
36767
36768 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36769 A line of this form is present for every ACL connection variable that is
36770 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36771 The length is the length of the data string for the variable. The string itself
36772 starts at the beginning of the next line, and is followed by a newline
36773 character. It may contain internal newlines.
36774
36775 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36776 A line of this form is present for every ACL message variable that is defined.
36777 Note that there is a space between &%-aclm%& and the rest of the name. The
36778 length is the length of the data string for the variable. The string itself
36779 starts at the beginning of the next line, and is followed by a newline
36780 character. It may contain internal newlines.
36781
36782 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36783 This is present if, when the message was received over SMTP, the value of
36784 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36785
36786 .vitem &%-allow_unqualified_recipient%&
36787 This is present if unqualified recipient addresses are permitted in header
36788 lines (to stop such addresses from being qualified if rewriting occurs at
36789 transport time). Local messages that were input using &%-bnq%& and remote
36790 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36791
36792 .vitem &%-allow_unqualified_sender%&
36793 This is present if unqualified sender addresses are permitted in header lines
36794 (to stop such addresses from being qualified if rewriting occurs at transport
36795 time). Local messages that were input using &%-bnq%& and remote messages from
36796 hosts that match &%sender_unqualified_hosts%& set this flag.
36797
36798 .vitem "&%-auth_id%&&~<&'text'&>"
36799 The id information for a message received on an authenticated SMTP connection
36800 &-- the value of the &$authenticated_id$& variable.
36801
36802 .vitem "&%-auth_sender%&&~<&'address'&>"
36803 The address of an authenticated sender &-- the value of the
36804 &$authenticated_sender$& variable.
36805
36806 .vitem "&%-body_linecount%&&~<&'number'&>"
36807 This records the number of lines in the body of the message, and is always
36808 present.
36809
36810 .vitem "&%-body_zerocount%&&~<&'number'&>"
36811 This records the number of binary zero bytes in the body of the message, and is
36812 present if the number is greater than zero.
36813
36814 .vitem &%-deliver_firsttime%&
36815 This is written when a new message is first added to the spool. When the spool
36816 file is updated after a deferral, it is omitted.
36817
36818 .vitem "&%-frozen%&&~<&'time'&>"
36819 .cindex "frozen messages" "spool data"
36820 The message is frozen, and the freezing happened at <&'time'&>.
36821
36822 .vitem "&%-helo_name%&&~<&'text'&>"
36823 This records the host name as specified by a remote host in a HELO or EHLO
36824 command.
36825
36826 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36827 This records the IP address of the host from which the message was received and
36828 the remote port number that was used. It is omitted for locally generated
36829 messages.
36830
36831 .vitem "&%-host_auth%&&~<&'text'&>"
36832 If the message was received on an authenticated SMTP connection, this records
36833 the name of the authenticator &-- the value of the
36834 &$sender_host_authenticated$& variable.
36835
36836 .vitem &%-host_lookup_failed%&
36837 This is present if an attempt to look up the sending host's name from its IP
36838 address failed. It corresponds to the &$host_lookup_failed$& variable.
36839
36840 .vitem "&%-host_name%&&~<&'text'&>"
36841 .cindex "reverse DNS lookup"
36842 .cindex "DNS" "reverse lookup"
36843 This records the name of the remote host from which the message was received,
36844 if the host name was looked up from the IP address when the message was being
36845 received. It is not present if no reverse lookup was done.
36846
36847 .vitem "&%-ident%&&~<&'text'&>"
36848 For locally submitted messages, this records the login of the originating user,
36849 unless it was a trusted user and the &%-oMt%& option was used to specify an
36850 ident value. For messages received over TCP/IP, this records the ident string
36851 supplied by the remote host, if any.
36852
36853 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36854 This records the IP address of the local interface and the port number through
36855 which a message was received from a remote host. It is omitted for locally
36856 generated messages.
36857
36858 .vitem &%-local%&
36859 The message is from a local sender.
36860
36861 .vitem &%-localerror%&
36862 The message is a locally-generated bounce message.
36863
36864 .vitem "&%-local_scan%&&~<&'string'&>"
36865 This records the data string that was returned by the &[local_scan()]& function
36866 when the message was received &-- the value of the &$local_scan_data$&
36867 variable. It is omitted if no data was returned.
36868
36869 .vitem &%-manual_thaw%&
36870 The message was frozen but has been thawed manually, that is, by an explicit
36871 Exim command rather than via the auto-thaw process.
36872
36873 .vitem &%-N%&
36874 A testing delivery process was started using the &%-N%& option to suppress any
36875 actual deliveries, but delivery was deferred. At any further delivery attempts,
36876 &%-N%& is assumed.
36877
36878 .vitem &%-received_protocol%&
36879 This records the value of the &$received_protocol$& variable, which contains
36880 the name of the protocol by which the message was received.
36881
36882 .vitem &%-sender_set_untrusted%&
36883 The envelope sender of this message was set by an untrusted local caller (used
36884 to ensure that the caller is displayed in queue listings).
36885
36886 .vitem "&%-spam_score_int%&&~<&'number'&>"
36887 If a message was scanned by SpamAssassin, this is present. It records the value
36888 of &$spam_score_int$&.
36889
36890 .vitem &%-tls_certificate_verified%&
36891 A TLS certificate was received from the client that sent this message, and the
36892 certificate was verified by the server.
36893
36894 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36895 When the message was received over an encrypted connection, this records the
36896 name of the cipher suite that was used.
36897
36898 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36899 When the message was received over an encrypted connection, and a certificate
36900 was received from the client, this records the Distinguished Name from that
36901 certificate.
36902 .endlist
36903
36904 Following the options there is a list of those addresses to which the message
36905 is not to be delivered. This set of addresses is initialized from the command
36906 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36907 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36908 the address is added to this set. The addresses are kept internally as a
36909 balanced binary tree, and it is a representation of that tree which is written
36910 to the spool file. If an address is expanded via an alias or forward file, the
36911 original address is added to the tree when deliveries to all its child
36912 addresses are complete.
36913
36914 If the tree is empty, there is a single line in the spool file containing just
36915 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36916 Y or N, followed by an address. The address is the value for the node of the
36917 tree, and the letters indicate whether the node has a left branch and/or a
36918 right branch attached to it, respectively. If branches exist, they immediately
36919 follow. Here is an example of a three-node tree:
36920 .code
36921 YY darcy@austen.fict.example
36922 NN alice@wonderland.fict.example
36923 NN editor@thesaurus.ref.example
36924 .endd
36925 After the non-recipients tree, there is a list of the message's recipients.
36926 This is a simple list, preceded by a count. It includes all the original
36927 recipients of the message, including those to whom the message has already been
36928 delivered. In the simplest case, the list contains one address per line. For
36929 example:
36930 .code
36931 4
36932 editor@thesaurus.ref.example
36933 darcy@austen.fict.example
36934 rdo@foundation
36935 alice@wonderland.fict.example
36936 .endd
36937 However, when a child address has been added to the top-level addresses as a
36938 result of the use of the &%one_time%& option on a &(redirect)& router, each
36939 line is of the following form:
36940 .display
36941 <&'top-level address'&> <&'errors_to address'&> &&&
36942   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36943 .endd
36944 The 01 flag bit indicates the presence of the three other fields that follow
36945 the top-level address. Other bits may be used in future to support additional
36946 fields. The <&'parent number'&> is the offset in the recipients list of the
36947 original parent of the &"one time"& address. The first two fields are the
36948 envelope sender that is associated with this address and its length. If the
36949 length is zero, there is no special envelope sender (there are then two space
36950 characters in the line). A non-empty field can arise from a &(redirect)& router
36951 that has an &%errors_to%& setting.
36952
36953
36954 A blank line separates the envelope and status information from the headers
36955 which follow. A header may occupy several lines of the file, and to save effort
36956 when reading it in, each header is preceded by a number and an identifying
36957 character. The number is the number of characters in the header, including any
36958 embedded newlines and the terminating newline. The character is one of the
36959 following:
36960
36961 .table2 50pt
36962 .row <&'blank'&>         "header in which Exim has no special interest"
36963 .row &`B`&               "&'Bcc:'& header"
36964 .row &`C`&               "&'Cc:'& header"
36965 .row &`F`&               "&'From:'& header"
36966 .row &`I`&               "&'Message-id:'& header"
36967 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36968 .row &`R`&               "&'Reply-To:'& header"
36969 .row &`S`&               "&'Sender:'& header"
36970 .row &`T`&               "&'To:'& header"
36971 .row &`*`&               "replaced or deleted header"
36972 .endtable
36973
36974 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36975 purposes. They are not transmitted when the message is delivered. Here is a
36976 typical set of headers:
36977 .code
36978 111P Received: by hobbit.fict.example with local (Exim 4.00)
36979 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36980 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36981 038* X-rewrote-sender: bb@hobbit.fict.example
36982 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36983 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36984 099* To: alice@wonderland.fict.example, rdo@foundation,
36985 darcy@austen.fict.example, editor@thesaurus.ref.example
36986 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36987 darcy@austen.fict.example, editor@thesaurus.ref.example
36988 038  Date: Fri, 11 May 2001 10:28:59 +0100
36989 .endd
36990 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36991 &'To:'& header have been rewritten, the last one because routing expanded the
36992 unqualified domain &'foundation'&.
36993 .ecindex IIDforspo1
36994 .ecindex IIDforspo2
36995 .ecindex IIDforspo3
36996
36997 . ////////////////////////////////////////////////////////////////////////////
36998 . ////////////////////////////////////////////////////////////////////////////
36999
37000 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37001          "DKIM Support"
37002 .cindex "DKIM"
37003
37004 DKIM is a mechanism by which messages sent by some entity can be provably
37005 linked to a domain which that entity controls.  It permits reputation to
37006 be tracked on a per-domain basis, rather than merely upon source IP address.
37007 DKIM is documented in RFC 4871.
37008
37009 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37010 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37011
37012 Exim's DKIM implementation allows to
37013 .olist
37014 Sign outgoing messages: This function is implemented in the SMTP transport.
37015 It can co-exist with all other Exim features
37016 (including transport filters)
37017 except cutthrough delivery.
37018 .next
37019 Verify signatures in incoming messages: This is implemented by an additional
37020 ACL (acl_smtp_dkim), which can be called several times per message, with
37021 different signature contexts.
37022 .endlist
37023
37024 In typical Exim style, the verification implementation does not include any
37025 default "policy". Instead it enables you to build your own policy using
37026 Exim's standard controls.
37027
37028 Please note that verification of DKIM signatures in incoming mail is turned
37029 on by default for logging purposes. For each signature in incoming email,
37030 exim will log a line displaying the most important signature details, and the
37031 signature status. Here is an example (with line-breaks added for clarity):
37032 .code
37033 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37034     d=facebookmail.com s=q1-2009b
37035     c=relaxed/relaxed a=rsa-sha1
37036     i=@facebookmail.com t=1252484542 [verification succeeded]
37037 .endd
37038 You might want to turn off DKIM verification processing entirely for internal
37039 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37040 control modifier. This should typically be done in the RCPT ACL, at points
37041 where you accept mail from relay sources (internal hosts or authenticated
37042 senders).
37043
37044
37045 .section "Signing outgoing messages" "SECID513"
37046 .cindex "DKIM" "signing"
37047
37048 Signing is implemented by setting private options on the SMTP transport.
37049 These options take (expandable) strings as arguments.
37050
37051 .option dkim_domain smtp string&!! unset
37052 MANDATORY:
37053 The domain you want to sign with. The result of this expanded
37054 option is put into the &%$dkim_domain%& expansion variable.
37055
37056 .option dkim_selector smtp string&!! unset
37057 MANDATORY:
37058 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37059 variable to look up a matching selector. The result is put in the expansion
37060 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37061 option along with &%$dkim_domain%&.
37062
37063 .option dkim_private_key smtp string&!! unset
37064 MANDATORY:
37065 This sets the private key to use. You can use the &%$dkim_domain%& and
37066 &%$dkim_selector%& expansion variables to determine the private key to use.
37067 The result can either
37068 .ilist
37069 be a valid RSA private key in ASCII armor, including line breaks.
37070 .next
37071 start with a slash, in which case it is treated as a file that contains
37072 the private key.
37073 .next
37074 be "0", "false" or the empty string, in which case the message will not
37075 be signed. This case will not result in an error, even if &%dkim_strict%&
37076 is set.
37077 .endlist
37078
37079 .option dkim_canon smtp string&!! unset
37080 OPTIONAL:
37081 This option sets the canonicalization method used when signing a message.
37082 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37083 The option defaults to "relaxed" when unset. Note: the current implementation
37084 only supports using the same canonicalization method for both headers and body.
37085
37086 .option dkim_strict smtp string&!! unset
37087 OPTIONAL:
37088 This  option  defines  how  Exim  behaves  when  signing a message that
37089 should be signed fails for some reason.  When the expansion evaluates to
37090 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37091 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37092 variables here.
37093
37094 .option dkim_sign_headers smtp string&!! unset
37095 OPTIONAL:
37096 When set, this option must expand to (or be specified as) a colon-separated
37097 list of header names. Headers with these names will be included in the message
37098 signature. When unspecified, the header names recommended in RFC4871 will be
37099 used.
37100
37101
37102 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37103 .cindex "DKIM" "verification"
37104
37105 Verification of DKIM signatures in incoming email is implemented via the
37106 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37107 syntactically(!) correct signature in the incoming message.
37108 A missing ACL definition defaults to accept.
37109 If any ACL call does not acccept, the message is not accepted.
37110 If a cutthrough delivery was in progress for the message it is
37111 summarily dropped (having wasted the transmission effort).
37112
37113 To evaluate the signature in the ACL a large number of expansion variables
37114 containing the signature status and its details are set up during the
37115 runtime of the ACL.
37116
37117 Calling the ACL only for existing signatures is not sufficient to build
37118 more advanced policies. For that reason, the global option
37119 &%dkim_verify_signers%&, and a global expansion variable
37120 &%$dkim_signers%& exist.
37121
37122 The global option &%dkim_verify_signers%& can be set to a colon-separated
37123 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37124 called. It is expanded when the message has been received. At this point,
37125 the expansion variable &%$dkim_signers%& already contains a colon-separated
37126 list of signer domains and identities for the message. When
37127 &%dkim_verify_signers%& is not specified in the main configuration,
37128 it defaults as:
37129 .code
37130 dkim_verify_signers = $dkim_signers
37131 .endd
37132 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37133 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37134 call the ACL for known domains or identities. This would be achieved as follows:
37135 .code
37136 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37137 .endd
37138 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37139 and "ebay.com", plus all domains and identities that have signatures in the message.
37140 You can also be more creative in constructing your policy. For example:
37141 .code
37142 dkim_verify_signers = $sender_address_domain:$dkim_signers
37143 .endd
37144
37145 If a domain or identity is listed several times in the (expanded) value of
37146 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37147
37148
37149 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37150 available (from most to least important):
37151
37152
37153 .vlist
37154 .vitem &%$dkim_cur_signer%&
37155 The signer that is being evaluated in this ACL run. This can be a domain or
37156 an identity. This is one of the list items from the expanded main option
37157 &%dkim_verify_signers%& (see above).
37158 .vitem &%$dkim_verify_status%&
37159 A string describing the general status of the signature. One of
37160 .ilist
37161 &%none%&: There is no signature in the message for the current domain or
37162 identity (as reflected by &%$dkim_cur_signer%&).
37163 .next
37164 &%invalid%&: The signature could not be verified due to a processing error.
37165 More detail is available in &%$dkim_verify_reason%&.
37166 .next
37167 &%fail%&: Verification of the signature failed.  More detail is
37168 available in &%$dkim_verify_reason%&.
37169 .next
37170 &%pass%&: The signature passed verification. It is valid.
37171 .endlist
37172 .vitem &%$dkim_verify_reason%&
37173 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37174 "fail" or "invalid". One of
37175 .ilist
37176 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37177 key for the domain could not be retrieved. This may be a temporary problem.
37178 .next
37179 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37180 record for the domain is syntactically invalid.
37181 .next
37182 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37183 body hash does not match the one specified in the signature header. This
37184 means that the message body was modified in transit.
37185 .next
37186 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37187 could not be verified. This may mean that headers were modified,
37188 re-written or otherwise changed in a way which is incompatible with
37189 DKIM verification. It may of course also mean that the signature is forged.
37190 .endlist
37191 .vitem &%$dkim_domain%&
37192 The signing domain. IMPORTANT: This variable is only populated if there is
37193 an actual signature in the message for the current domain or identity (as
37194 reflected by &%$dkim_cur_signer%&).
37195 .vitem &%$dkim_identity%&
37196 The signing identity, if present. IMPORTANT: This variable is only populated
37197 if there is an actual signature in the message for the current domain or
37198 identity (as reflected by &%$dkim_cur_signer%&).
37199 .vitem &%$dkim_selector%&
37200 The key record selector string.
37201 .vitem &%$dkim_algo%&
37202 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37203 .vitem &%$dkim_canon_body%&
37204 The body canonicalization method. One of 'relaxed' or 'simple'.
37205 .vitem &%dkim_canon_headers%&
37206 The header canonicalization method. One of 'relaxed' or 'simple'.
37207 .vitem &%$dkim_copiedheaders%&
37208 A transcript of headers and their values which are included in the signature
37209 (copied from the 'z=' tag of the signature).
37210 .vitem &%$dkim_bodylength%&
37211 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37212 limit was set by the signer, "9999999999999" is returned. This makes sure
37213 that this variable always expands to an integer value.
37214 .vitem &%$dkim_created%&
37215 UNIX timestamp reflecting the date and time when the signature was created.
37216 When this was not specified by the signer, "0" is returned.
37217 .vitem &%$dkim_expires%&
37218 UNIX timestamp reflecting the date and time when the signer wants the
37219 signature to be treated as "expired". When this was not specified by the
37220 signer, "9999999999999" is returned. This makes it possible to do useful
37221 integer size comparisons against this value.
37222 .vitem &%$dkim_headernames%&
37223 A colon-separated list of names of headers included in the signature.
37224 .vitem &%$dkim_key_testing%&
37225 "1" if the key record has the "testing" flag set, "0" if not.
37226 .vitem &%$dkim_key_nosubdomains%&
37227 "1" if the key record forbids subdomaining, "0" otherwise.
37228 .vitem &%$dkim_key_srvtype%&
37229 Service type (tag s=) from the key record. Defaults to "*" if not specified
37230 in the key record.
37231 .vitem &%$dkim_key_granularity%&
37232 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37233 in the key record.
37234 .vitem &%$dkim_key_notes%&
37235 Notes from the key record (tag n=).
37236 .endlist
37237
37238 In addition, two ACL conditions are provided:
37239
37240 .vlist
37241 .vitem &%dkim_signers%&
37242 ACL condition that checks a colon-separated list of domains or identities
37243 for a match against the domain or identity that the ACL is currently verifying
37244 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37245 verb to a group of domains or identities. For example:
37246
37247 .code
37248 # Warn when Mail purportedly from GMail has no signature at all
37249 warn log_message = GMail sender without DKIM signature
37250      sender_domains = gmail.com
37251      dkim_signers = gmail.com
37252      dkim_status = none
37253 .endd
37254
37255 .vitem &%dkim_status%&
37256 ACL condition that checks a colon-separated list of possible DKIM verification
37257 results against the actual result of verification. This is typically used
37258 to restrict an ACL verb to a list of verification outcomes, for example:
37259
37260 .code
37261 deny message = Mail from Paypal with invalid/missing signature
37262      sender_domains = paypal.com:paypal.de
37263      dkim_signers = paypal.com:paypal.de
37264      dkim_status = none:invalid:fail
37265 .endd
37266
37267 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37268 see the documentation of the &%$dkim_verify_status%& expansion variable above
37269 for more information of what they mean.
37270 .endlist
37271
37272 . ////////////////////////////////////////////////////////////////////////////
37273 . ////////////////////////////////////////////////////////////////////////////
37274
37275 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37276          "Adding drivers or lookups"
37277 .cindex "adding drivers"
37278 .cindex "new drivers, adding"
37279 .cindex "drivers" "adding new"
37280 The following actions have to be taken in order to add a new router, transport,
37281 authenticator, or lookup type to Exim:
37282
37283 .olist
37284 Choose a name for the driver or lookup type that does not conflict with any
37285 existing name; I will use &"newdriver"& in what follows.
37286 .next
37287 Add to &_src/EDITME_& the line:
37288 .display
37289 <&'type'&>&`_NEWDRIVER=yes`&
37290 .endd
37291 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37292 code is not to be included in the binary by default, comment this line out. You
37293 should also add any relevant comments about the driver or lookup type.
37294 .next
37295 Add to &_src/config.h.defaults_& the line:
37296 .code
37297 #define <type>_NEWDRIVER
37298 .endd
37299 .next
37300 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37301 and create a table entry as is done for all the other drivers and lookup types.
37302 .next
37303 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37304 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37305 Add your &`NEWDRIVER`& to that list.
37306 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37307 simple form that most lookups have.
37308 .next
37309 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37310 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37311 driver or lookup type and add it to the definition of OBJ.
37312 .next
37313 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37314 &_src_&.
37315 .next
37316 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37317 as for other drivers and lookups.
37318 .endlist
37319
37320 Then all you need to do is write the code! A good way to start is to make a
37321 proforma by copying an existing module of the same type, globally changing all
37322 occurrences of the name, and cutting out most of the code. Note that any
37323 options you create must be listed in alphabetical order, because the tables are
37324 searched using a binary chop procedure.
37325
37326 There is a &_README_& file in each of the sub-directories of &_src_& describing
37327 the interface that is expected.
37328
37329
37330
37331
37332 . ////////////////////////////////////////////////////////////////////////////
37333 . ////////////////////////////////////////////////////////////////////////////
37334
37335 . /////////////////////////////////////////////////////////////////////////////
37336 . These lines are processing instructions for the Simple DocBook Processor that
37337 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37338 . PDFs than using xmlto and fop. They will be ignored by all other XML
37339 . processors.
37340 . /////////////////////////////////////////////////////////////////////////////
37341
37342 .literal xml
37343 <?sdop
37344   format="newpage"
37345   foot_right_recto="&chaptertitle;"
37346   foot_right_verso="&chaptertitle;"
37347 ?>
37348 .literal off
37349
37350 .makeindex "Options index"   "option"
37351 .makeindex "Variables index" "variable"
37352 .makeindex "Concept index"   "concept"
37353
37354
37355 . /////////////////////////////////////////////////////////////////////////////
37356 . /////////////////////////////////////////////////////////////////////////////