Expansions: add operators base32, base32d
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database" "deferred deliveries"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default is set at build time). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$message_exim_id$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file or directory
3053 (depending on the used scanner interface),
3054 using the malware scanning framework.  The option of &%av_scanner%& influences
3055 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3056 the expansion should have defaults which apply to this invocation.  ACLs are
3057 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3058 will never be populated and &%-bmalware%& will fail.
3059
3060 Exim will have changed working directory before resolving the filename, so
3061 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3062 user when it tries to open the file, rather than as the invoking user.
3063 This option requires admin privileges.
3064
3065 The &%-bmalware%& option will not be extended to be more generally useful,
3066 there are better tools for file-scanning.  This option exists to help
3067 administrators verify their Exim and AV scanner configuration.
3068
3069 .vitem &%-bnq%&
3070 .oindex "&%-bnq%&"
3071 .cindex "address qualification, suppressing"
3072 By default, Exim automatically qualifies unqualified addresses (those
3073 without domains) that appear in messages that are submitted locally (that
3074 is, not over TCP/IP). This qualification applies both to addresses in
3075 envelopes, and addresses in header lines. Sender addresses are qualified using
3076 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3077 defaults to the value of &%qualify_domain%&).
3078
3079 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3080 being used to re-submit messages that originally came from remote hosts after
3081 content scanning, you probably do not want to qualify unqualified addresses in
3082 header lines. (Such lines will be present only if you have not enabled a header
3083 syntax check in the appropriate ACL.)
3084
3085 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3086 messages that originate on the local host. When this is used, unqualified
3087 addresses in the envelope provoke errors (causing message rejection) and
3088 unqualified addresses in header lines are left alone.
3089
3090
3091 .vitem &%-bP%&
3092 .oindex "&%-bP%&"
3093 .cindex "configuration options" "extracting"
3094 .cindex "options" "configuration &-- extracting"
3095 If this option is given with no arguments, it causes the values of all Exim's
3096 main configuration options to be written to the standard output. The values
3097 of one or more specific options can be requested by giving their names as
3098 arguments, for example:
3099 .code
3100 exim -bP qualify_domain hold_domains
3101 .endd
3102 .cindex "hiding configuration option values"
3103 .cindex "configuration options" "hiding value of"
3104 .cindex "options" "hiding value of"
3105 However, any option setting that is preceded by the word &"hide"& in the
3106 configuration file is not shown in full, except to an admin user. For other
3107 users, the output is as in this example:
3108 .code
3109 mysql_servers = <value not displayable>
3110 .endd
3111 If &%config%& is given as an argument, the config is
3112 output, as it was parsed, any include file resolved, any comment removed.
3113
3114 If &%config_file%& is given as an argument, the name of the run time
3115 configuration file is output. (&%configure_file%& works too, for
3116 backward compatibility.)
3117 If a list of configuration files was supplied, the value that is output here
3118 is the name of the file that was actually used.
3119
3120 .cindex "options" "hiding name of"
3121 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3122 name will not be output.
3123
3124 .cindex "daemon" "process id (pid)"
3125 .cindex "pid (process id)" "of daemon"
3126 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3127 directories where log files and daemon pid files are written are output,
3128 respectively. If these values are unset, log files are written in a
3129 sub-directory of the spool directory called &%log%&, and the pid file is
3130 written directly into the spool directory.
3131
3132 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3133 .code
3134 exim -bP +local_domains
3135 .endd
3136 it searches for a matching named list of any type (domain, host, address, or
3137 local part) and outputs what it finds.
3138
3139 .cindex "options" "router &-- extracting"
3140 .cindex "options" "transport &-- extracting"
3141 .cindex "options" "authenticator &-- extracting"
3142 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3143 followed by the name of an appropriate driver instance, the option settings for
3144 that driver are output. For example:
3145 .code
3146 exim -bP transport local_delivery
3147 .endd
3148 The generic driver options are output first, followed by the driver's private
3149 options. A list of the names of drivers of a particular type can be obtained by
3150 using one of the words &%router_list%&, &%transport_list%&, or
3151 &%authenticator_list%&, and a complete list of all drivers with their option
3152 settings can be obtained by using &%routers%&, &%transports%&, or
3153 &%authenticators%&.
3154
3155 .cindex "environment"
3156 If &%environment%& is given as an argument, the set of environment
3157 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3158 variables.
3159
3160 .cindex "options" "macro &-- extracting"
3161 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3162 are available, similarly to the drivers.  Because macros are sometimes used
3163 for storing passwords, this option is restricted.
3164 The output format is one item per line.
3165
3166 .vitem &%-bp%&
3167 .oindex "&%-bp%&"
3168 .cindex "queue" "listing messages on"
3169 .cindex "listing" "messages on the queue"
3170 This option requests a listing of the contents of the mail queue on the
3171 standard output. If the &%-bp%& option is followed by a list of message ids,
3172 just those messages are listed. By default, this option can be used only by an
3173 admin user. However, the &%queue_list_requires_admin%& option can be set false
3174 to allow any user to see the queue.
3175
3176 Each message on the queue is displayed as in the following example:
3177 .code
3178 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3179           red.king@looking-glass.fict.example
3180           <other addresses>
3181 .endd
3182 .cindex "message" "size in queue listing"
3183 .cindex "size" "of message"
3184 The first line contains the length of time the message has been on the queue
3185 (in this case 25 minutes), the size of the message (2.9K), the unique local
3186 identifier for the message, and the message sender, as contained in the
3187 envelope. For bounce messages, the sender address is empty, and appears as
3188 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3189 the default sender address, the user's login name is shown in parentheses
3190 before the sender address.
3191
3192 .cindex "frozen messages" "in queue listing"
3193 If the message is frozen (attempts to deliver it are suspended) then the text
3194 &"*** frozen ***"& is displayed at the end of this line.
3195
3196 The recipients of the message (taken from the envelope, not the headers) are
3197 displayed on subsequent lines. Those addresses to which the message has already
3198 been delivered are marked with the letter D. If an original address gets
3199 expanded into several addresses via an alias or forward file, the original is
3200 displayed with a D only when deliveries for all of its child addresses are
3201 complete.
3202
3203
3204 .vitem &%-bpa%&
3205 .oindex "&%-bpa%&"
3206 This option operates like &%-bp%&, but in addition it shows delivered addresses
3207 that were generated from the original top level address(es) in each message by
3208 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3209 of just &"D"&.
3210
3211
3212 .vitem &%-bpc%&
3213 .oindex "&%-bpc%&"
3214 .cindex "queue" "count of messages on"
3215 This option counts the number of messages on the queue, and writes the total
3216 to the standard output. It is restricted to admin users, unless
3217 &%queue_list_requires_admin%& is set false.
3218
3219
3220 .vitem &%-bpr%&
3221 .oindex "&%-bpr%&"
3222 This option operates like &%-bp%&, but the output is not sorted into
3223 chronological order of message arrival. This can speed it up when there are
3224 lots of messages on the queue, and is particularly useful if the output is
3225 going to be post-processed in a way that doesn't need the sorting.
3226
3227 .vitem &%-bpra%&
3228 .oindex "&%-bpra%&"
3229 This option is a combination of &%-bpr%& and &%-bpa%&.
3230
3231 .vitem &%-bpru%&
3232 .oindex "&%-bpru%&"
3233 This option is a combination of &%-bpr%& and &%-bpu%&.
3234
3235
3236 .vitem &%-bpu%&
3237 .oindex "&%-bpu%&"
3238 This option operates like &%-bp%& but shows only undelivered top-level
3239 addresses for each message displayed. Addresses generated by aliasing or
3240 forwarding are not shown, unless the message was deferred after processing by a
3241 router with the &%one_time%& option set.
3242
3243
3244 .vitem &%-brt%&
3245 .oindex "&%-brt%&"
3246 .cindex "testing" "retry configuration"
3247 .cindex "retry" "configuration testing"
3248 This option is for testing retry rules, and it must be followed by up to three
3249 arguments. It causes Exim to look for a retry rule that matches the values
3250 and to write it to the standard output. For example:
3251 .code
3252 exim -brt bach.comp.mus.example
3253 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3254 .endd
3255 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3256 argument, which is required, can be a complete address in the form
3257 &'local_part@domain'&, or it can be just a domain name. If the second argument
3258 contains a dot, it is interpreted as an optional second domain name; if no
3259 retry rule is found for the first argument, the second is tried. This ties in
3260 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3261 rule is found that matches the host, one that matches the mail domain is
3262 sought. Finally, an argument that is the name of a specific delivery error, as
3263 used in setting up retry rules, can be given. For example:
3264 .code
3265 exim -brt haydn.comp.mus.example quota_3d
3266 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3267 .endd
3268
3269 .vitem &%-brw%&
3270 .oindex "&%-brw%&"
3271 .cindex "testing" "rewriting"
3272 .cindex "rewriting" "testing"
3273 This option is for testing address rewriting rules, and it must be followed by
3274 a single argument, consisting of either a local part without a domain, or a
3275 complete address with a fully qualified domain. Exim outputs how this address
3276 would be rewritten for each possible place it might appear. See chapter
3277 &<<CHAPrewrite>>& for further details.
3278
3279 .vitem &%-bS%&
3280 .oindex "&%-bS%&"
3281 .cindex "SMTP" "batched incoming"
3282 .cindex "batched SMTP input"
3283 This option is used for batched SMTP input, which is an alternative interface
3284 for non-interactive local message submission. A number of messages can be
3285 submitted in a single run. However, despite its name, this is not really SMTP
3286 input. Exim reads each message's envelope from SMTP commands on the standard
3287 input, but generates no responses. If the caller is trusted, or
3288 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3289 believed; otherwise the sender is always the caller of Exim.
3290
3291 The message itself is read from the standard input, in SMTP format (leading
3292 dots doubled), terminated by a line containing just a single dot. An error is
3293 provoked if the terminating dot is missing. A further message may then follow.
3294
3295 As for other local message submissions, the contents of incoming batch SMTP
3296 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3297 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3298 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3299
3300 Some other SMTP commands are recognized in the input. HELO and EHLO act
3301 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3302 QUIT quits, ignoring the rest of the standard input.
3303
3304 .cindex "return code" "for &%-bS%&"
3305 If any error is encountered, reports are written to the standard output and
3306 error streams, and Exim gives up immediately. The return code is 0 if no error
3307 was detected; it is 1 if one or more messages were accepted before the error
3308 was detected; otherwise it is 2.
3309
3310 More details of input using batched SMTP are given in section
3311 &<<SECTincomingbatchedSMTP>>&.
3312
3313 .vitem &%-bs%&
3314 .oindex "&%-bs%&"
3315 .cindex "SMTP" "local input"
3316 .cindex "local SMTP input"
3317 This option causes Exim to accept one or more messages by reading SMTP commands
3318 on the standard input, and producing SMTP replies on the standard output. SMTP
3319 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3320 Some user agents use this interface as a way of passing locally-generated
3321 messages to the MTA.
3322
3323 In
3324 .cindex "sender" "source of"
3325 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3326 set, the senders of messages are taken from the SMTP MAIL commands.
3327 Otherwise the content of these commands is ignored and the sender is set up as
3328 the calling user. Unqualified addresses are automatically qualified using
3329 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3330 &%-bnq%& option is used.
3331
3332 .cindex "inetd"
3333 The
3334 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3335 using a listening daemon. Exim can distinguish the two cases by checking
3336 whether the standard input is a TCP/IP socket. When Exim is called from
3337 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3338 above concerning senders and qualification do not apply. In this situation,
3339 Exim behaves in exactly the same way as it does when receiving a message via
3340 the listening daemon.
3341
3342 .vitem &%-bt%&
3343 .oindex "&%-bt%&"
3344 .cindex "testing" "addresses"
3345 .cindex "address" "testing"
3346 This option runs Exim in address testing mode, in which each argument is taken
3347 as a recipient address to be tested for deliverability. The results are
3348 written to the standard output. If a test fails, and the caller is not an admin
3349 user, no details of the failure are output, because these might contain
3350 sensitive information such as usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be tested.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'root'& and there are
3357 security issues.
3358
3359 Each address is handled as if it were the recipient address of a message
3360 (compare the &%-bv%& option). It is passed to the routers and the result is
3361 written to the standard output. However, any router that has
3362 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3363 genuine routing tests if your first router passes everything to a scanner
3364 program.
3365
3366 .cindex "return code" "for &%-bt%&"
3367 The return code is 2 if any address failed outright; it is 1 if no address
3368 failed outright but at least one could not be resolved for some reason. Return
3369 code 0 is given only when all addresses succeed.
3370
3371 .cindex "duplicate addresses"
3372 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3373 addresses after routing is complete, so that only one delivery takes place.
3374 This does not happen when testing with &%-bt%&; the full results of routing are
3375 always shown.
3376
3377 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3378 routers in the configuration makes any tests on the sender address of a
3379 message,
3380 .oindex "&%-f%&" "for address testing"
3381 you can use the &%-f%& option to set an appropriate sender when running
3382 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3383 default qualifying domain. However, if you have set up (for example) routers
3384 whose behaviour depends on the contents of an incoming message, you cannot test
3385 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3386 doing such tests.
3387
3388 .vitem &%-bV%&
3389 .oindex "&%-bV%&"
3390 .cindex "version number of Exim"
3391 This option causes Exim to write the current version number, compilation
3392 number, and compilation date of the &'exim'& binary to the standard output.
3393 It also lists the DBM library that is being used, the optional modules (such as
3394 specific lookup types), the drivers that are included in the binary, and the
3395 name of the run time configuration file that is in use.
3396
3397 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3398 configuration file. However, this is a static check only. It cannot check
3399 values that are to be expanded. For example, although a misspelt ACL verb is
3400 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3401 alone to discover (for example) all the typos in the configuration; some
3402 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3403 dynamic testing facilities.
3404
3405 .vitem &%-bv%&
3406 .oindex "&%-bv%&"
3407 .cindex "verifying address" "using &%-bv%&"
3408 .cindex "address" "verification"
3409 This option runs Exim in address verification mode, in which each argument is
3410 taken as a recipient address to be verified by the routers. (This does
3411 not involve any verification callouts). During normal operation, verification
3412 happens mostly as a consequence processing a &%verify%& condition in an ACL
3413 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3414 including callouts, see the &%-bh%& and &%-bhc%& options.
3415
3416 If verification fails, and the caller is not an admin user, no details of the
3417 failure are output, because these might contain sensitive information such as
3418 usernames and passwords for database lookups.
3419
3420 If no arguments are given, Exim runs in an interactive manner, prompting with a
3421 right angle bracket for addresses to be verified.
3422
3423 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3424 &[readline()]& function, because it is running as &'exim'& and there are
3425 security issues.
3426
3427 Verification differs from address testing (the &%-bt%& option) in that routers
3428 that have &%no_verify%& set are skipped, and if the address is accepted by a
3429 router that has &%fail_verify%& set, verification fails. The address is
3430 verified as a recipient if &%-bv%& is used; to test verification for a sender
3431 address, &%-bvs%& should be used.
3432
3433 If the &%-v%& option is not set, the output consists of a single line for each
3434 address, stating whether it was verified or not, and giving a reason in the
3435 latter case. Without &%-v%&, generating more than one address by redirection
3436 causes verification to end successfully, without considering the generated
3437 addresses. However, if just one address is generated, processing continues,
3438 and the generated address must verify successfully for the overall verification
3439 to succeed.
3440
3441 When &%-v%& is set, more details are given of how the address has been handled,
3442 and in the case of address redirection, all the generated addresses are also
3443 considered. Verification may succeed for some and fail for others.
3444
3445 The
3446 .cindex "return code" "for &%-bv%&"
3447 return code is 2 if any address failed outright; it is 1 if no address
3448 failed outright but at least one could not be resolved for some reason. Return
3449 code 0 is given only when all addresses succeed.
3450
3451 If any of the routers in the configuration makes any tests on the sender
3452 address of a message, you should use the &%-f%& option to set an appropriate
3453 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3454 calling user at the default qualifying domain.
3455
3456 .vitem &%-bvs%&
3457 .oindex "&%-bvs%&"
3458 This option acts like &%-bv%&, but verifies the address as a sender rather
3459 than a recipient address. This affects any rewriting and qualification that
3460 might happen.
3461
3462 .vitem &%-bw%&
3463 .oindex "&%-bw%&"
3464 .cindex "daemon"
3465 .cindex "inetd"
3466 .cindex "inetd" "wait mode"
3467 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3468 similarly to the &%-bd%& option.  All port specifications on the command-line
3469 and in the configuration file are ignored.  Queue-running may not be specified.
3470
3471 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3472 listening for connections.  This permits the system to start up and have
3473 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3474 each port only when the first connection is received.
3475
3476 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3477 which the daemon will exit, which should cause inetd to listen once more.
3478
3479 .vitem &%-C%&&~<&'filelist'&>
3480 .oindex "&%-C%&"
3481 .cindex "configuration file" "alternate"
3482 .cindex "CONFIGURE_FILE"
3483 .cindex "alternate configuration file"
3484 This option causes Exim to find the run time configuration file from the given
3485 list instead of from the list specified by the CONFIGURE_FILE
3486 compile-time setting. Usually, the list will consist of just a single file
3487 name, but it can be a colon-separated list of names. In this case, the first
3488 file that exists is used. Failure to open an existing file stops Exim from
3489 proceeding any further along the list, and an error is generated.
3490
3491 When this option is used by a caller other than root, and the list is different
3492 from the compiled-in list, Exim gives up its root privilege immediately, and
3493 runs with the real and effective uid and gid set to those of the caller.
3494 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3495 file contains a list of full pathnames, one per line, for configuration files
3496 which are trusted. Root privilege is retained for any configuration file so
3497 listed, as long as the caller is the Exim user (or the user specified in the
3498 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3499 not writeable by inappropriate users or groups.
3500
3501 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3502 configuration using &%-C%& right through message reception and delivery,
3503 even if the caller is root. The reception works, but by that time, Exim is
3504 running as the Exim user, so when it re-executes to regain privilege for the
3505 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3506 test reception and delivery using two separate commands (one to put a message
3507 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3508
3509 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3510 prefix string with which any file named in a &%-C%& command line option
3511 must start. In addition, the file name must not contain the sequence &`/../`&.
3512 However, if the value of the &%-C%& option is identical to the value of
3513 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3514 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3515 unset, any file name can be used with &%-C%&.
3516
3517 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3518 to a directory to which only root has access. This prevents someone who has
3519 broken into the Exim account from running a privileged Exim with an arbitrary
3520 configuration file.
3521
3522 The &%-C%& facility is useful for ensuring that configuration files are
3523 syntactically correct, but cannot be used for test deliveries, unless the
3524 caller is privileged, or unless it is an exotic configuration that does not
3525 require privilege. No check is made on the owner or group of the files
3526 specified by this option.
3527
3528
3529 .vitem &%-D%&<&'macro'&>=<&'value'&>
3530 .oindex "&%-D%&"
3531 .cindex "macro" "setting on command line"
3532 This option can be used to override macro definitions in the configuration file
3533 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3534 unprivileged caller, it causes Exim to give up its root privilege.
3535 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3536 completely disabled, and its use causes an immediate error exit.
3537
3538 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3539 colon-separated list of macros which are considered safe and, if &%-D%& only
3540 supplies macros from this list, and the values are acceptable, then Exim will
3541 not give up root privilege if the caller is root, the Exim run-time user, or
3542 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3543 to be removed in the future.  Acceptable values for the macros satisfy the
3544 regexp: &`^[A-Za-z0-9_/.-]*$`&
3545
3546 The entire option (including equals sign if present) must all be within one
3547 command line item. &%-D%& can be used to set the value of a macro to the empty
3548 string, in which case the equals sign is optional. These two commands are
3549 synonymous:
3550 .code
3551 exim -DABC  ...
3552 exim -DABC= ...
3553 .endd
3554 To include spaces in a macro definition item, quotes must be used. If you use
3555 quotes, spaces are permitted around the macro name and the equals sign. For
3556 example:
3557 .code
3558 exim '-D ABC = something' ...
3559 .endd
3560 &%-D%& may be repeated up to 10 times on a command line.
3561 Only macro names up to 22 letters long can be set.
3562
3563
3564 .vitem &%-d%&<&'debug&~options'&>
3565 .oindex "&%-d%&"
3566 .cindex "debugging" "list of selectors"
3567 .cindex "debugging" "&%-d%& option"
3568 This option causes debugging information to be written to the standard
3569 error stream. It is restricted to admin users because debugging output may show
3570 database queries that contain password information. Also, the details of users'
3571 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3572 writes an error message to the standard error stream and exits with a non-zero
3573 return code.
3574
3575 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3576 standard debugging data is output. This can be reduced, or increased to include
3577 some more rarely needed information, by directly following &%-d%& with a string
3578 made up of names preceded by plus or minus characters. These add or remove sets
3579 of debugging data, respectively. For example, &%-d+filter%& adds filter
3580 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3581 no spaces are allowed in the debug setting. The available debugging categories
3582 are:
3583 .display
3584 &`acl            `& ACL interpretation
3585 &`auth           `& authenticators
3586 &`deliver        `& general delivery logic
3587 &`dns            `& DNS lookups (see also resolver)
3588 &`dnsbl          `& DNS black list (aka RBL) code
3589 &`exec           `& arguments for &[execv()]& calls
3590 &`expand         `& detailed debugging for string expansions
3591 &`filter         `& filter handling
3592 &`hints_lookup   `& hints data lookups
3593 &`host_lookup    `& all types of name-to-IP address handling
3594 &`ident          `& ident lookup
3595 &`interface      `& lists of local interfaces
3596 &`lists          `& matching things in lists
3597 &`load           `& system load checks
3598 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3599                     &<<CHAPlocalscan>>&)
3600 &`lookup         `& general lookup code and all lookups
3601 &`memory         `& memory handling
3602 &`pid            `& add pid to debug output lines
3603 &`process_info   `& setting info for the process log
3604 &`queue_run      `& queue runs
3605 &`receive        `& general message reception logic
3606 &`resolver       `& turn on the DNS resolver's debugging output
3607 &`retry          `& retry handling
3608 &`rewrite        `& address rewriting
3609 &`route          `& address routing
3610 &`timestamp      `& add timestamp to debug output lines
3611 &`tls            `& TLS logic
3612 &`transport      `& transports
3613 &`uid            `& changes of uid/gid and looking up uid/gid
3614 &`verify         `& address verification logic
3615 &`all            `& almost all of the above (see below), and also &%-v%&
3616 .endd
3617 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3618 for &`-all`&. The reason for this is that &`+all`& is something that people
3619 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3620 is included, an awful lot of output that is very rarely of interest is
3621 generated, so it now has to be explicitly requested. However, &`-all`& does
3622 turn everything off.
3623
3624 .cindex "resolver, debugging output"
3625 .cindex "DNS resolver, debugging output"
3626 The &`resolver`& option produces output only if the DNS resolver was compiled
3627 with DEBUG enabled. This is not the case in some operating systems. Also,
3628 unfortunately, debugging output from the DNS resolver is written to stdout
3629 rather than stderr.
3630
3631 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3632 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3633 However, the &`pid`& selector is forced when debugging is turned on for a
3634 daemon, which then passes it on to any re-executed Exims. Exim also
3635 automatically adds the pid to debug lines when several remote deliveries are
3636 run in parallel.
3637
3638 The &`timestamp`& selector causes the current time to be inserted at the start
3639 of all debug output lines. This can be useful when trying to track down delays
3640 in processing.
3641
3642 If the &%debug_print%& option is set in any driver, it produces output whenever
3643 any debugging is selected, or if &%-v%& is used.
3644
3645 .vitem &%-dd%&<&'debug&~options'&>
3646 .oindex "&%-dd%&"
3647 This option behaves exactly like &%-d%& except when used on a command that
3648 starts a daemon process. In that case, debugging is turned off for the
3649 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3650 behaviour of the daemon without creating as much output as full debugging does.
3651
3652 .vitem &%-dropcr%&
3653 .oindex "&%-dropcr%&"
3654 This is an obsolete option that is now a no-op. It used to affect the way Exim
3655 handled CR and LF characters in incoming messages. What happens now is
3656 described in section &<<SECTlineendings>>&.
3657
3658 .vitem &%-E%&
3659 .oindex "&%-E%&"
3660 .cindex "bounce message" "generating"
3661 This option specifies that an incoming message is a locally-generated delivery
3662 failure report. It is used internally by Exim when handling delivery failures
3663 and is not intended for external use. Its only effect is to stop Exim
3664 generating certain messages to the postmaster, as otherwise message cascades
3665 could occur in some situations. As part of the same option, a message id may
3666 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3667 new message contains the id, following &"R="&, as a cross-reference.
3668
3669 .vitem &%-e%&&'x'&
3670 .oindex "&%-e%&&'x'&"
3671 There are a number of Sendmail options starting with &%-oe%& which seem to be
3672 called by various programs without the leading &%o%& in the option. For
3673 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3674 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3675
3676 .vitem &%-F%&&~<&'string'&>
3677 .oindex "&%-F%&"
3678 .cindex "sender" "name"
3679 .cindex "name" "of sender"
3680 This option sets the sender's full name for use when a locally-generated
3681 message is being accepted. In the absence of this option, the user's &'gecos'&
3682 entry from the password data is used. As users are generally permitted to alter
3683 their &'gecos'& entries, no security considerations are involved. White space
3684 between &%-F%& and the <&'string'&> is optional.
3685
3686 .vitem &%-f%&&~<&'address'&>
3687 .oindex "&%-f%&"
3688 .cindex "sender" "address"
3689 .cindex "address" "sender"
3690 .cindex "trusted users"
3691 .cindex "envelope sender"
3692 .cindex "user" "trusted"
3693 This option sets the address of the envelope sender of a locally-generated
3694 message (also known as the return path). The option can normally be used only
3695 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3696 users to use it.
3697
3698 Processes running as root or the Exim user are always trusted. Other
3699 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3700 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3701 of a local message is set to the caller's login name at the default qualify
3702 domain.
3703
3704 There is one exception to the restriction on the use of &%-f%&: an empty sender
3705 can be specified by any user, trusted or not, to create a message that can
3706 never provoke a bounce. An empty sender can be specified either as an empty
3707 string, or as a pair of angle brackets with nothing between them, as in these
3708 examples of shell commands:
3709 .code
3710 exim -f '<>' user@domain
3711 exim -f "" user@domain
3712 .endd
3713 In addition, the use of &%-f%& is not restricted when testing a filter file
3714 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3715 &%-bv%& options.
3716
3717 Allowing untrusted users to change the sender address does not of itself make
3718 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3719 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3720 though this can be overridden by setting &%no_local_from_check%&.
3721
3722 White
3723 .cindex "&""From""& line"
3724 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3725 given as two arguments or one combined argument). The sender of a
3726 locally-generated message can also be set (when permitted) by an initial
3727 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3728 if &%-f%& is also present, it overrides &"From&~"&.
3729
3730 .vitem &%-G%&
3731 .oindex "&%-G%&"
3732 .cindex "submission fixups, suppressing (command-line)"
3733 This option is equivalent to an ACL applying:
3734 .code
3735 control = suppress_local_fixups
3736 .endd
3737 for every message received.  Note that Sendmail will complain about such
3738 bad formatting, where Exim silently just does not fix it up.  This may change
3739 in future.
3740
3741 As this affects audit information, the caller must be a trusted user to use
3742 this option.
3743
3744 .vitem &%-h%&&~<&'number'&>
3745 .oindex "&%-h%&"
3746 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3747 This option is accepted for compatibility with Sendmail, but has no effect. (In
3748 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3749 headers.)
3750
3751 .vitem &%-i%&
3752 .oindex "&%-i%&"
3753 .cindex "Solaris" "&'mail'& command"
3754 .cindex "dot" "in incoming non-SMTP message"
3755 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3756 line by itself should not terminate an incoming, non-SMTP message. I can find
3757 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3758 command in Solaris 2.4 uses it. See also &%-ti%&.
3759
3760 .vitem &%-L%&&~<&'tag'&>
3761 .oindex "&%-L%&"
3762 .cindex "syslog" "process name; set with flag"
3763 This option is equivalent to setting &%syslog_processname%& in the config
3764 file and setting &%log_file_path%& to &`syslog`&.
3765 Its use is restricted to administrators.  The configuration file has to be
3766 read and parsed, to determine access rights, before this is set and takes
3767 effect, so early configuration file errors will not honour this flag.
3768
3769 The tag should not be longer than 32 characters.
3770
3771 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3772 .oindex "&%-M%&"
3773 .cindex "forcing delivery"
3774 .cindex "delivery" "forcing attempt"
3775 .cindex "frozen messages" "forcing delivery"
3776 This option requests Exim to run a delivery attempt on each message in turn. If
3777 any of the messages are frozen, they are automatically thawed before the
3778 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3779 and &%hold_domains%& are ignored.
3780
3781 Retry
3782 .cindex "hints database" "overriding retry hints"
3783 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3784 the normal retry time has not yet been reached. This option requires the caller
3785 to be an admin user. However, there is an option called &%prod_requires_admin%&
3786 which can be set false to relax this restriction (and also the same requirement
3787 for the &%-q%&, &%-R%&, and &%-S%& options).
3788
3789 The deliveries happen synchronously, that is, the original Exim process does
3790 not terminate until all the delivery attempts have finished. No output is
3791 produced unless there is a serious error. If you want to see what is happening,
3792 use the &%-v%& option as well, or inspect Exim's main log.
3793
3794 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3795 .oindex "&%-Mar%&"
3796 .cindex "message" "adding recipients"
3797 .cindex "recipient" "adding"
3798 This option requests Exim to add the addresses to the list of recipients of the
3799 message (&"ar"& for &"add recipients"&). The first argument must be a message
3800 id, and the remaining ones must be email addresses. However, if the message is
3801 active (in the middle of a delivery attempt), it is not altered. This option
3802 can be used only by an admin user.
3803
3804 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3805         &~<&'message&~id'&>"
3806 .oindex "&%-MC%&"
3807 .cindex "SMTP" "passed connection"
3808 .cindex "SMTP" "multiple deliveries"
3809 .cindex "multiple SMTP deliveries"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim to invoke another instance of itself to deliver a waiting message using
3812 an existing SMTP connection, which is passed as the standard input. Details are
3813 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3814 must be root or the Exim user in order to use it.
3815
3816 .vitem &%-MCA%&
3817 .oindex "&%-MCA%&"
3818 This option is not intended for use by external callers. It is used internally
3819 by Exim in conjunction with the &%-MC%& option. It signifies that the
3820 connection to the remote host has been authenticated.
3821
3822 .vitem &%-MCD%&
3823 .oindex "&%-MCD%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 remote host supports the ESMTP &_DSN_& extension.
3827
3828 .new
3829 .vitem &%-MCG%&
3830 .oindex "&%-MCG%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that an
3833 alternate queue is used, named by the following option.
3834 .wen
3835
3836 .vitem &%-MCP%&
3837 .oindex "&%-MCP%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3840 which Exim is connected supports pipelining.
3841
3842 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3843 .oindex "&%-MCQ%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option when the original delivery was
3846 started by a queue runner. It passes on the process id of the queue runner,
3847 together with the file descriptor number of an open pipe. Closure of the pipe
3848 signals the final completion of the sequence of processes that are passing
3849 messages through the same SMTP connection.
3850
3851 .vitem &%-MCS%&
3852 .oindex "&%-MCS%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3855 SMTP SIZE option should be used on messages delivered down the existing
3856 connection.
3857
3858 .vitem &%-MCT%&
3859 .oindex "&%-MCT%&"
3860 This option is not intended for use by external callers. It is used internally
3861 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3862 host to which Exim is connected supports TLS encryption.
3863
3864 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3865 .oindex "&%-Mc%&"
3866 .cindex "hints database" "not overridden by &%-Mc%&"
3867 .cindex "delivery" "manually started &-- not forced"
3868 This option requests Exim to run a delivery attempt on each message in turn,
3869 but unlike the &%-M%& option, it does check for retry hints, and respects any
3870 that are found. This option is not very useful to external callers. It is
3871 provided mainly for internal use by Exim when it needs to re-invoke itself in
3872 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3873 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3874 respects retry times and other options such as &%hold_domains%& that are
3875 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3876 If you want to run a specific delivery as if in a queue run, you should use
3877 &%-q%& with a message id argument. A distinction between queue run deliveries
3878 and other deliveries is made in one or two places.
3879
3880 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3881 .oindex "&%-Mes%&"
3882 .cindex "message" "changing sender"
3883 .cindex "sender" "changing"
3884 This option requests Exim to change the sender address in the message to the
3885 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3886 &"edit sender"&). There must be exactly two arguments. The first argument must
3887 be a message id, and the second one an email address. However, if the message
3888 is active (in the middle of a delivery attempt), its status is not altered.
3889 This option can be used only by an admin user.
3890
3891 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3892 .oindex "&%-Mf%&"
3893 .cindex "freezing messages"
3894 .cindex "message" "manually freezing"
3895 This option requests Exim to mark each listed message as &"frozen"&. This
3896 prevents any delivery attempts taking place until the message is &"thawed"&,
3897 either manually or as a result of the &%auto_thaw%& configuration option.
3898 However, if any of the messages are active (in the middle of a delivery
3899 attempt), their status is not altered. This option can be used only by an admin
3900 user.
3901
3902 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mg%&"
3904 .cindex "giving up on messages"
3905 .cindex "message" "abandoning delivery attempts"
3906 .cindex "delivery" "abandoning further attempts"
3907 This option requests Exim to give up trying to deliver the listed messages,
3908 including any that are frozen. However, if any of the messages are active,
3909 their status is not altered. For non-bounce messages, a delivery error message
3910 is sent to the sender, containing the text &"cancelled by administrator"&.
3911 Bounce messages are just discarded. This option can be used only by an admin
3912 user.
3913
3914 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3915 .oindex "&%-Mmad%&"
3916 .cindex "delivery" "cancelling all"
3917 This option requests Exim to mark all the recipient addresses in the messages
3918 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3919 message is active (in the middle of a delivery attempt), its status is not
3920 altered. This option can be used only by an admin user.
3921
3922 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3923 .oindex "&%-Mmd%&"
3924 .cindex "delivery" "cancelling by address"
3925 .cindex "recipient" "removing"
3926 .cindex "removing recipients"
3927 This option requests Exim to mark the given addresses as already delivered
3928 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3929 the remaining ones must be email addresses. These are matched to recipient
3930 addresses in the message in a case-sensitive manner. If the message is active
3931 (in the middle of a delivery attempt), its status is not altered. This option
3932 can be used only by an admin user.
3933
3934 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3935 .oindex "&%-Mrm%&"
3936 .cindex "removing messages"
3937 .cindex "abandoning mail"
3938 .cindex "message" "manually discarding"
3939 This option requests Exim to remove the given messages from the queue. No
3940 bounce messages are sent; each message is simply forgotten. However, if any of
3941 the messages are active, their status is not altered. This option can be used
3942 only by an admin user or by the user who originally caused the message to be
3943 placed on the queue.
3944
3945 .vitem &%-Mset%&&~<&'message&~id'&>
3946 .oindex "&%-Mset%&
3947 .cindex "testing" "string expansion"
3948 .cindex "expansion" "testing"
3949 This option is useful only in conjunction with &%-be%& (that is, when testing
3950 string expansions). Exim loads the given message from its spool before doing
3951 the test expansions, thus setting message-specific variables such as
3952 &$message_size$& and the header variables. The &$recipients$& variable is made
3953 available. This feature is provided to make it easier to test expansions that
3954 make use of these variables. However, this option can be used only by an admin
3955 user. See also &%-bem%&.
3956
3957 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3958 .oindex "&%-Mt%&"
3959 .cindex "thawing messages"
3960 .cindex "unfreezing messages"
3961 .cindex "frozen messages" "thawing"
3962 .cindex "message" "thawing frozen"
3963 This option requests Exim to &"thaw"& any of the listed messages that are
3964 &"frozen"&, so that delivery attempts can resume. However, if any of the
3965 messages are active, their status is not altered. This option can be used only
3966 by an admin user.
3967
3968 .vitem &%-Mvb%&&~<&'message&~id'&>
3969 .oindex "&%-Mvb%&"
3970 .cindex "listing" "message body"
3971 .cindex "message" "listing body of"
3972 This option causes the contents of the message body (-D) spool file to be
3973 written to the standard output. This option can be used only by an admin user.
3974
3975 .vitem &%-Mvc%&&~<&'message&~id'&>
3976 .oindex "&%-Mvc%&"
3977 .cindex "message" "listing in RFC 2822 format"
3978 .cindex "listing" "message in RFC 2822 format"
3979 This option causes a copy of the complete message (header lines plus body) to
3980 be written to the standard output in RFC 2822 format. This option can be used
3981 only by an admin user.
3982
3983 .vitem &%-Mvh%&&~<&'message&~id'&>
3984 .oindex "&%-Mvh%&"
3985 .cindex "listing" "message headers"
3986 .cindex "header lines" "listing"
3987 .cindex "message" "listing header lines"
3988 This option causes the contents of the message headers (-H) spool file to be
3989 written to the standard output. This option can be used only by an admin user.
3990
3991 .vitem &%-Mvl%&&~<&'message&~id'&>
3992 .oindex "&%-Mvl%&"
3993 .cindex "listing" "message log"
3994 .cindex "message" "listing message log"
3995 This option causes the contents of the message log spool file to be written to
3996 the standard output. This option can be used only by an admin user.
3997
3998 .vitem &%-m%&
3999 .oindex "&%-m%&"
4000 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4001 treats it that way too.
4002
4003 .vitem &%-N%&
4004 .oindex "&%-N%&"
4005 .cindex "debugging" "&%-N%& option"
4006 .cindex "debugging" "suppressing delivery"
4007 This is a debugging option that inhibits delivery of a message at the transport
4008 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4009 it just doesn't actually transport the message, but instead behaves as if it
4010 had successfully done so. However, it does not make any updates to the retry
4011 database, and the log entries for deliveries are flagged with &"*>"& rather
4012 than &"=>"&.
4013
4014 Because &%-N%& discards any message to which it applies, only root or the Exim
4015 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4016 words, an ordinary user can use it only when supplying an incoming message to
4017 which it will apply. Although transportation never fails when &%-N%& is set, an
4018 address may be deferred because of a configuration problem on a transport, or a
4019 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4020 the message, and applies to any subsequent delivery attempts that may happen
4021 for that message.
4022
4023 .vitem &%-n%&
4024 .oindex "&%-n%&"
4025 This option is interpreted by Sendmail to mean &"no aliasing"&.
4026 For normal modes of operation, it is ignored by Exim.
4027 When combined with &%-bP%& it makes the output more terse (suppresses
4028 option names, environment values and config pretty printing).
4029
4030 .vitem &%-O%&&~<&'data'&>
4031 .oindex "&%-O%&"
4032 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4033 Exim.
4034
4035 .vitem &%-oA%&&~<&'file&~name'&>
4036 .oindex "&%-oA%&"
4037 .cindex "Sendmail compatibility" "&%-oA%& option"
4038 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4039 alternative alias file name. Exim handles &%-bi%& differently; see the
4040 description above.
4041
4042 .vitem &%-oB%&&~<&'n'&>
4043 .oindex "&%-oB%&"
4044 .cindex "SMTP" "passed connection"
4045 .cindex "SMTP" "multiple deliveries"
4046 .cindex "multiple SMTP deliveries"
4047 This is a debugging option which limits the maximum number of messages that can
4048 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4049 transport. If <&'n'&> is omitted, the limit is set to 1.
4050
4051 .vitem &%-odb%&
4052 .oindex "&%-odb%&"
4053 .cindex "background delivery"
4054 .cindex "delivery" "in the background"
4055 This option applies to all modes in which Exim accepts incoming messages,
4056 including the listening daemon. It requests &"background"& delivery of such
4057 messages, which means that the accepting process automatically starts a
4058 delivery process for each message received, but does not wait for the delivery
4059 processes to finish.
4060
4061 When all the messages have been received, the reception process exits,
4062 leaving the delivery processes to finish in their own time. The standard output
4063 and error streams are closed at the start of each delivery process.
4064 This is the default action if none of the &%-od%& options are present.
4065
4066 If one of the queueing options in the configuration file
4067 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4068 overrides it if &%queue_only_override%& is set true, which is the default
4069 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4070
4071 .vitem &%-odf%&
4072 .oindex "&%-odf%&"
4073 .cindex "foreground delivery"
4074 .cindex "delivery" "in the foreground"
4075 This option requests &"foreground"& (synchronous) delivery when Exim has
4076 accepted a locally-generated message. (For the daemon it is exactly the same as
4077 &%-odb%&.) A delivery process is automatically started to deliver the message,
4078 and Exim waits for it to complete before proceeding.
4079
4080 The original Exim reception process does not finish until the delivery
4081 process for the final message has ended. The standard error stream is left open
4082 during deliveries.
4083
4084 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4085 false and one of the queueing options in the configuration file is in effect.
4086
4087 If there is a temporary delivery error during foreground delivery, the
4088 message is left on the queue for later delivery, and the original reception
4089 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4090 restricted configuration that never queues messages.
4091
4092
4093 .vitem &%-odi%&
4094 .oindex "&%-odi%&"
4095 This option is synonymous with &%-odf%&. It is provided for compatibility with
4096 Sendmail.
4097
4098 .vitem &%-odq%&
4099 .oindex "&%-odq%&"
4100 .cindex "non-immediate delivery"
4101 .cindex "delivery" "suppressing immediate"
4102 .cindex "queueing incoming messages"
4103 This option applies to all modes in which Exim accepts incoming messages,
4104 including the listening daemon. It specifies that the accepting process should
4105 not automatically start a delivery process for each message received. Messages
4106 are placed on the queue, and remain there until a subsequent queue runner
4107 process encounters them. There are several configuration options (such as
4108 &%queue_only%&) that can be used to queue incoming messages under certain
4109 conditions. This option overrides all of them and also &%-odqs%&. It always
4110 forces queueing.
4111
4112 .vitem &%-odqs%&
4113 .oindex "&%-odqs%&"
4114 .cindex "SMTP" "delaying delivery"
4115 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4116 However, like &%-odb%& and &%-odi%&, this option has no effect if
4117 &%queue_only_override%& is false and one of the queueing options in the
4118 configuration file is in effect.
4119
4120 When &%-odqs%& does operate, a delivery process is started for each incoming
4121 message, in the background by default, but in the foreground if &%-odi%& is
4122 also present. The recipient addresses are routed, and local deliveries are done
4123 in the normal way. However, if any SMTP deliveries are required, they are not
4124 done at this time, so the message remains on the queue until a subsequent queue
4125 runner process encounters it. Because routing was done, Exim knows which
4126 messages are waiting for which hosts, and so a number of messages for the same
4127 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4128 configuration option has the same effect for specific domains. See also the
4129 &%-qq%& option.
4130
4131 .vitem &%-oee%&
4132 .oindex "&%-oee%&"
4133 .cindex "error" "reporting"
4134 If an error is detected while a non-SMTP message is being received (for
4135 example, a malformed address), the error is reported to the sender in a mail
4136 message.
4137
4138 .cindex "return code" "for &%-oee%&"
4139 Provided
4140 this error message is successfully sent, the Exim receiving process
4141 exits with a return code of zero. If not, the return code is 2 if the problem
4142 is that the original message has no recipients, or 1 for any other error.
4143 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4144
4145 .vitem &%-oem%&
4146 .oindex "&%-oem%&"
4147 .cindex "error" "reporting"
4148 .cindex "return code" "for &%-oem%&"
4149 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4150 return code, whether or not the error message was successfully sent.
4151 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4152
4153 .vitem &%-oep%&
4154 .oindex "&%-oep%&"
4155 .cindex "error" "reporting"
4156 If an error is detected while a non-SMTP message is being received, the
4157 error is reported by writing a message to the standard error file (stderr).
4158 .cindex "return code" "for &%-oep%&"
4159 The return code is 1 for all errors.
4160
4161 .vitem &%-oeq%&
4162 .oindex "&%-oeq%&"
4163 .cindex "error" "reporting"
4164 This option is supported for compatibility with Sendmail, but has the same
4165 effect as &%-oep%&.
4166
4167 .vitem &%-oew%&
4168 .oindex "&%-oew%&"
4169 .cindex "error" "reporting"
4170 This option is supported for compatibility with Sendmail, but has the same
4171 effect as &%-oem%&.
4172
4173 .vitem &%-oi%&
4174 .oindex "&%-oi%&"
4175 .cindex "dot" "in incoming non-SMTP message"
4176 This option, which has the same effect as &%-i%&, specifies that a dot on a
4177 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4178 single dot does terminate, though Exim does no special processing for other
4179 lines that start with a dot. This option is set by default if Exim is called as
4180 &'rmail'&. See also &%-ti%&.
4181
4182 .vitem &%-oitrue%&
4183 .oindex "&%-oitrue%&"
4184 This option is treated as synonymous with &%-oi%&.
4185
4186 .vitem &%-oMa%&&~<&'host&~address'&>
4187 .oindex "&%-oMa%&"
4188 .cindex "sender" "host address, specifying for local message"
4189 A number of options starting with &%-oM%& can be used to set values associated
4190 with remote hosts on locally-submitted messages (that is, messages not received
4191 over TCP/IP). These options can be used by any caller in conjunction with the
4192 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4193 other circumstances, they are ignored unless the caller is trusted.
4194
4195 The &%-oMa%& option sets the sender host address. This may include a port
4196 number at the end, after a full stop (period). For example:
4197 .code
4198 exim -bs -oMa 10.9.8.7.1234
4199 .endd
4200 An alternative syntax is to enclose the IP address in square brackets,
4201 followed by a colon and the port number:
4202 .code
4203 exim -bs -oMa [10.9.8.7]:1234
4204 .endd
4205 The IP address is placed in the &$sender_host_address$& variable, and the
4206 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4207 are present on the command line, the sender host IP address is taken from
4208 whichever one is last.
4209
4210 .vitem &%-oMaa%&&~<&'name'&>
4211 .oindex "&%-oMaa%&"
4212 .cindex "authentication" "name, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4214 option sets the value of &$sender_host_authenticated$& (the authenticator
4215 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4216 This option can be used with &%-bh%& and &%-bs%& to set up an
4217 authenticated SMTP session without actually using the SMTP AUTH command.
4218
4219 .vitem &%-oMai%&&~<&'string'&>
4220 .oindex "&%-oMai%&"
4221 .cindex "authentication" "id, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4223 option sets the value of &$authenticated_id$& (the id that was authenticated).
4224 This overrides the default value (the caller's login id, except with &%-bh%&,
4225 where there is no default) for messages from local sources. See chapter
4226 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4227
4228 .vitem &%-oMas%&&~<&'address'&>
4229 .oindex "&%-oMas%&"
4230 .cindex "authentication" "sender, specifying for local message"
4231 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4232 option sets the authenticated sender value in &$authenticated_sender$&. It
4233 overrides the sender address that is created from the caller's login id for
4234 messages from local sources, except when &%-bh%& is used, when there is no
4235 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4236 specified on a MAIL command overrides this value. See chapter
4237 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4238
4239 .vitem &%-oMi%&&~<&'interface&~address'&>
4240 .oindex "&%-oMi%&"
4241 .cindex "interface" "address, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4243 option sets the IP interface address value. A port number may be included,
4244 using the same syntax as for &%-oMa%&. The interface address is placed in
4245 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4246
4247 .vitem &%-oMm%&&~<&'message&~reference'&>
4248 .oindex "&%-oMm%&"
4249 .cindex "message reference" "message reference, specifying for local message"
4250 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4251 option sets the message reference, e.g. message-id, and is logged during
4252 delivery. This is useful when some kind of audit trail is required to tie
4253 messages together. The format of the message reference is checked and will
4254 abort if the format is invalid. The option will only be accepted if exim is
4255 running in trusted mode, not as any regular user.
4256
4257 The best example of a message reference is when Exim sends a bounce message.
4258 The message reference is the message-id of the original message for which Exim
4259 is sending the bounce.
4260
4261 .vitem &%-oMr%&&~<&'protocol&~name'&>
4262 .oindex "&%-oMr%&"
4263 .cindex "protocol, specifying for local message"
4264 .vindex "&$received_protocol$&"
4265 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4266 option sets the received protocol value that is stored in
4267 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4268 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4269 SMTP protocol names (see the description of &$received_protocol$& in section
4270 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4271 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4272 be set by &%-oMr%&.
4273
4274 .vitem &%-oMs%&&~<&'host&~name'&>
4275 .oindex "&%-oMs%&"
4276 .cindex "sender" "host name, specifying for local message"
4277 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4278 option sets the sender host name in &$sender_host_name$&. When this option is
4279 present, Exim does not attempt to look up a host name from an IP address; it
4280 uses the name it is given.
4281
4282 .vitem &%-oMt%&&~<&'ident&~string'&>
4283 .oindex "&%-oMt%&"
4284 .cindex "sender" "ident string, specifying for local message"
4285 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4286 option sets the sender ident value in &$sender_ident$&. The default setting for
4287 local callers is the login id of the calling process, except when &%-bh%& is
4288 used, when there is no default.
4289
4290 .vitem &%-om%&
4291 .oindex "&%-om%&"
4292 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4293 In Sendmail, this option means &"me too"&, indicating that the sender of a
4294 message should receive a copy of the message if the sender appears in an alias
4295 expansion. Exim always does this, so the option does nothing.
4296
4297 .vitem &%-oo%&
4298 .oindex "&%-oo%&"
4299 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4300 This option is ignored. In Sendmail it specifies &"old style headers"&,
4301 whatever that means.
4302
4303 .vitem &%-oP%&&~<&'path'&>
4304 .oindex "&%-oP%&"
4305 .cindex "pid (process id)" "of daemon"
4306 .cindex "daemon" "process id (pid)"
4307 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4308 value. The option specifies the file to which the process id of the daemon is
4309 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4310 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4311 because in those cases, the normal pid file is not used.
4312
4313 .vitem &%-or%&&~<&'time'&>
4314 .oindex "&%-or%&"
4315 .cindex "timeout" "for non-SMTP input"
4316 This option sets a timeout value for incoming non-SMTP messages. If it is not
4317 set, Exim will wait forever for the standard input. The value can also be set
4318 by the &%receive_timeout%& option. The format used for specifying times is
4319 described in section &<<SECTtimeformat>>&.
4320
4321 .vitem &%-os%&&~<&'time'&>
4322 .oindex "&%-os%&"
4323 .cindex "timeout" "for SMTP input"
4324 .cindex "SMTP" "input timeout"
4325 This option sets a timeout value for incoming SMTP messages. The timeout
4326 applies to each SMTP command and block of data. The value can also be set by
4327 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4328 for specifying times is described in section &<<SECTtimeformat>>&.
4329
4330 .vitem &%-ov%&
4331 .oindex "&%-ov%&"
4332 This option has exactly the same effect as &%-v%&.
4333
4334 .vitem &%-oX%&&~<&'number&~or&~string'&>
4335 .oindex "&%-oX%&"
4336 .cindex "TCP/IP" "setting listening ports"
4337 .cindex "TCP/IP" "setting listening interfaces"
4338 .cindex "port" "receiving TCP/IP"
4339 This option is relevant only when the &%-bd%& (start listening daemon) option
4340 is also given. It controls which ports and interfaces the daemon uses. Details
4341 of the syntax, and how it interacts with configuration file options, are given
4342 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4343 file is written unless &%-oP%& is also present to specify a pid file name.
4344
4345 .vitem &%-pd%&
4346 .oindex "&%-pd%&"
4347 .cindex "Perl" "starting the interpreter"
4348 This option applies when an embedded Perl interpreter is linked with Exim (see
4349 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4350 option, forcing the starting of the interpreter to be delayed until it is
4351 needed.
4352
4353 .vitem &%-ps%&
4354 .oindex "&%-ps%&"
4355 .cindex "Perl" "starting the interpreter"
4356 This option applies when an embedded Perl interpreter is linked with Exim (see
4357 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4358 option, forcing the starting of the interpreter to occur as soon as Exim is
4359 started.
4360
4361 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4362 .oindex "&%-p%&"
4363 For compatibility with Sendmail, this option is equivalent to
4364 .display
4365 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4366 .endd
4367 It sets the incoming protocol and host name (for trusted callers). The
4368 host name and its colon can be omitted when only the protocol is to be set.
4369 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4370 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4371 or &`s`& using this option (but that does not seem a real limitation).
4372
4373 .vitem &%-q%&
4374 .oindex "&%-q%&"
4375 .cindex "queue runner" "starting manually"
4376 This option is normally restricted to admin users. However, there is a
4377 configuration option called &%prod_requires_admin%& which can be set false to
4378 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4379 and &%-S%& options).
4380
4381 .cindex "queue runner" "description of operation"
4382 .new
4383 If other commandline options do not specify an action,
4384 .wen
4385 the &%-q%& option starts one queue runner process. This scans the queue of
4386 waiting messages, and runs a delivery process for each one in turn. It waits
4387 for each delivery process to finish before starting the next one. A delivery
4388 process may not actually do any deliveries if the retry times for the addresses
4389 have not been reached. Use &%-qf%& (see below) if you want to override this.
4390
4391 If
4392 .cindex "SMTP" "passed connection"
4393 .cindex "SMTP" "multiple deliveries"
4394 .cindex "multiple SMTP deliveries"
4395 the delivery process spawns other processes to deliver other messages down
4396 passed SMTP connections, the queue runner waits for these to finish before
4397 proceeding.
4398
4399 When all the queued messages have been considered, the original queue runner
4400 process terminates. In other words, a single pass is made over the waiting
4401 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4402 this to be repeated periodically.
4403
4404 Exim processes the waiting messages in an unpredictable order. It isn't very
4405 random, but it is likely to be different each time, which is all that matters.
4406 If one particular message screws up a remote MTA, other messages to the same
4407 MTA have a chance of getting through if they get tried first.
4408
4409 It is possible to cause the messages to be processed in lexical message id
4410 order, which is essentially the order in which they arrived, by setting the
4411 &%queue_run_in_order%& option, but this is not recommended for normal use.
4412
4413 .vitem &%-q%&<&'qflags'&>
4414 The &%-q%& option may be followed by one or more flag letters that change its
4415 behaviour. They are all optional, but if more than one is present, they must
4416 appear in the correct order. Each flag is described in a separate item below.
4417
4418 .vitem &%-qq...%&
4419 .oindex "&%-qq%&"
4420 .cindex "queue" "double scanning"
4421 .cindex "queue" "routing"
4422 .cindex "routing" "whole queue before delivery"
4423 An option starting with &%-qq%& requests a two-stage queue run. In the first
4424 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4425 every domain. Addresses are routed, local deliveries happen, but no remote
4426 transports are run.
4427
4428 .cindex "hints database" "remembering routing"
4429 The hints database that remembers which messages are waiting for specific hosts
4430 is updated, as if delivery to those hosts had been deferred. After this is
4431 complete, a second, normal queue scan happens, with routing and delivery taking
4432 place as normal. Messages that are routed to the same host should mostly be
4433 delivered down a single SMTP
4434 .cindex "SMTP" "passed connection"
4435 .cindex "SMTP" "multiple deliveries"
4436 .cindex "multiple SMTP deliveries"
4437 connection because of the hints that were set up during the first queue scan.
4438 This option may be useful for hosts that are connected to the Internet
4439 intermittently.
4440
4441 .vitem &%-q[q]i...%&
4442 .oindex "&%-qi%&"
4443 .cindex "queue" "initial delivery"
4444 If the &'i'& flag is present, the queue runner runs delivery processes only for
4445 those messages that haven't previously been tried. (&'i'& stands for &"initial
4446 delivery"&.) This can be helpful if you are putting messages on the queue using
4447 &%-odq%& and want a queue runner just to process the new messages.
4448
4449 .vitem &%-q[q][i]f...%&
4450 .oindex "&%-qf%&"
4451 .cindex "queue" "forcing delivery"
4452 .cindex "delivery" "forcing in queue run"
4453 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4454 message, whereas without &'f'& only those non-frozen addresses that have passed
4455 their retry times are tried.
4456
4457 .vitem &%-q[q][i]ff...%&
4458 .oindex "&%-qff%&"
4459 .cindex "frozen messages" "forcing delivery"
4460 If &'ff'& is present, a delivery attempt is forced for every message, whether
4461 frozen or not.
4462
4463 .vitem &%-q[q][i][f[f]]l%&
4464 .oindex "&%-ql%&"
4465 .cindex "queue" "local deliveries only"
4466 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4467 be done. If a message requires any remote deliveries, it remains on the queue
4468 for later delivery.
4469
4470 .new
4471 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4472 .oindex "&%-qG%&"
4473 .cindex queue named
4474 .cindex "named queues"
4475 .cindex "queue" "delivering specific messages"
4476 If the &'G'& flag and a name is present, the queue runner operates on the
4477 queue with the given name rather than the default queue.
4478 The name should not contain a &'/'& character.
4479 For a periodic queue run (see below)
4480 append to the name a slash and a time value.
4481
4482 If other commandline options speicify an action, a &'-qG<name>'& option
4483 will specify a queue to operate on.
4484 For example:
4485 .code
4486 exim -bp -qGquarantine
4487 mailq -qGquarantime
4488 exim -qGoffpeak -Rf @special.domain.example
4489 .endd
4490 .wen
4491
4492 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4493 When scanning the queue, Exim can be made to skip over messages whose ids are
4494 lexically less than a given value by following the &%-q%& option with a
4495 starting message id. For example:
4496 .code
4497 exim -q 0t5C6f-0000c8-00
4498 .endd
4499 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4500 second message id is given, messages whose ids are lexically greater than it
4501 are also skipped. If the same id is given twice, for example,
4502 .code
4503 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4504 .endd
4505 just one delivery process is started, for that message. This differs from
4506 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4507 that it counts as a delivery from a queue run. Note that the selection
4508 mechanism does not affect the order in which the messages are scanned. There
4509 are also other ways of selecting specific sets of messages for delivery in a
4510 queue run &-- see &%-R%& and &%-S%&.
4511
4512 .vitem &%-q%&<&'qflags'&><&'time'&>
4513 .cindex "queue runner" "starting periodically"
4514 .cindex "periodic queue running"
4515 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4516 starting a queue runner process at intervals specified by the given time value
4517 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4518 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4519 single daemon process handles both functions. A common way of starting up a
4520 combined daemon at system boot time is to use a command such as
4521 .code
4522 /usr/exim/bin/exim -bd -q30m
4523 .endd
4524 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4525 process every 30 minutes.
4526
4527 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4528 pid file is written unless one is explicitly requested by the &%-oP%& option.
4529
4530 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4531 .oindex "&%-qR%&"
4532 This option is synonymous with &%-R%&. It is provided for Sendmail
4533 compatibility.
4534
4535 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4536 .oindex "&%-qS%&"
4537 This option is synonymous with &%-S%&.
4538
4539 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4540 .oindex "&%-R%&"
4541 .cindex "queue runner" "for specific recipients"
4542 .cindex "delivery" "to given domain"
4543 .cindex "domain" "delivery to"
4544 The <&'rsflags'&> may be empty, in which case the white space before the string
4545 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4546 which are the possible values for <&'rsflags'&>. White space is required if
4547 <&'rsflags'&> is not empty.
4548
4549 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4550 perform a single queue run, except that, when scanning the messages on the
4551 queue, Exim processes only those that have at least one undelivered recipient
4552 address containing the given string, which is checked in a case-independent
4553 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4554 regular expression; otherwise it is a literal string.
4555
4556 If you want to do periodic queue runs for messages with specific recipients,
4557 you can combine &%-R%& with &%-q%& and a time value. For example:
4558 .code
4559 exim -q25m -R @special.domain.example
4560 .endd
4561 This example does a queue run for messages with recipients in the given domain
4562 every 25 minutes. Any additional flags that are specified with &%-q%& are
4563 applied to each queue run.
4564
4565 Once a message is selected for delivery by this mechanism, all its addresses
4566 are processed. For the first selected message, Exim overrides any retry
4567 information and forces a delivery attempt for each undelivered address. This
4568 means that if delivery of any address in the first message is successful, any
4569 existing retry information is deleted, and so delivery attempts for that
4570 address in subsequently selected messages (which are processed without forcing)
4571 will run. However, if delivery of any address does not succeed, the retry
4572 information is updated, and in subsequently selected messages, the failing
4573 address will be skipped.
4574
4575 .cindex "frozen messages" "forcing delivery"
4576 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4577 all selected messages, not just the first; frozen messages are included when
4578 &'ff'& is present.
4579
4580 The &%-R%& option makes it straightforward to initiate delivery of all messages
4581 to a given domain after a host has been down for some time. When the SMTP
4582 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4583 effect is to run Exim with the &%-R%& option, but it can be configured to run
4584 an arbitrary command instead.
4585
4586 .vitem &%-r%&
4587 .oindex "&%-r%&"
4588 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4589
4590 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4591 .oindex "&%-S%&"
4592 .cindex "delivery" "from given sender"
4593 .cindex "queue runner" "for specific senders"
4594 This option acts like &%-R%& except that it checks the string against each
4595 message's sender instead of against the recipients. If &%-R%& is also set, both
4596 conditions must be met for a message to be selected. If either of the options
4597 has &'f'& or &'ff'& in its flags, the associated action is taken.
4598
4599 .vitem &%-Tqt%&&~<&'times'&>
4600 .oindex "&%-Tqt%&"
4601 This is an option that is exclusively for use by the Exim testing suite. It is not
4602 recognized when Exim is run normally. It allows for the setting up of explicit
4603 &"queue times"& so that various warning/retry features can be tested.
4604
4605 .vitem &%-t%&
4606 .oindex "&%-t%&"
4607 .cindex "recipient" "extracting from header lines"
4608 .cindex "&'Bcc:'& header line"
4609 .cindex "&'Cc:'& header line"
4610 .cindex "&'To:'& header line"
4611 When Exim is receiving a locally-generated, non-SMTP message on its standard
4612 input, the &%-t%& option causes the recipients of the message to be obtained
4613 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4614 from the command arguments. The addresses are extracted before any rewriting
4615 takes place and the &'Bcc:'& header line, if present, is then removed.
4616
4617 .cindex "Sendmail compatibility" "&%-t%& option"
4618 If the command has any arguments, they specify addresses to which the message
4619 is &'not'& to be delivered. That is, the argument addresses are removed from
4620 the recipients list obtained from the headers. This is compatible with Smail 3
4621 and in accordance with the documented behaviour of several versions of
4622 Sendmail, as described in man pages on a number of operating systems (e.g.
4623 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4624 argument addresses to those obtained from the headers, and the O'Reilly
4625 Sendmail book documents it that way. Exim can be made to add argument addresses
4626 instead of subtracting them by setting the option
4627 &%extract_addresses_remove_arguments%& false.
4628
4629 .cindex "&%Resent-%& header lines" "with &%-t%&"
4630 If there are any &%Resent-%& header lines in the message, Exim extracts
4631 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4632 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4633 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4634 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4635
4636 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4637 message is resent several times). The RFC also specifies that they should be
4638 added at the front of the message, and separated by &'Received:'& lines. It is
4639 not at all clear how &%-t%& should operate in the present of multiple sets,
4640 nor indeed exactly what constitutes a &"set"&.
4641 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4642 are often added at the end of the header, and if a message is resent more than
4643 once, it is common for the original set of &%Resent-%& headers to be renamed as
4644 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4645
4646 .vitem &%-ti%&
4647 .oindex "&%-ti%&"
4648 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4649 compatibility with Sendmail.
4650
4651 .vitem &%-tls-on-connect%&
4652 .oindex "&%-tls-on-connect%&"
4653 .cindex "TLS" "use without STARTTLS"
4654 .cindex "TLS" "automatic start"
4655 This option is available when Exim is compiled with TLS support. It forces all
4656 incoming SMTP connections to behave as if the incoming port is listed in the
4657 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4658 &<<CHAPTLS>>& for further details.
4659
4660
4661 .vitem &%-U%&
4662 .oindex "&%-U%&"
4663 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4664 Sendmail uses this option for &"initial message submission"&, and its
4665 documentation states that in future releases, it may complain about
4666 syntactically invalid messages rather than fixing them when this flag is not
4667 set. Exim ignores this option.
4668
4669 .vitem &%-v%&
4670 .oindex "&%-v%&"
4671 This option causes Exim to write information to the standard error stream,
4672 describing what it is doing. In particular, it shows the log lines for
4673 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4674 dialogue is shown. Some of the log lines shown may not actually be written to
4675 the log if the setting of &%log_selector%& discards them. Any relevant
4676 selectors are shown with each log line. If none are shown, the logging is
4677 unconditional.
4678
4679 .vitem &%-x%&
4680 .oindex "&%-x%&"
4681 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4682 National Language Support extended characters in the body of the mail item"&).
4683 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4684 this option.
4685
4686 .vitem &%-X%&&~<&'logfile'&>
4687 .oindex "&%-X%&"
4688 This option is interpreted by Sendmail to cause debug information to be sent
4689 to the named file.  It is ignored by Exim.
4690
4691 .vitem &%-z%&&~<&'log-line'&>
4692 .oindex "&%-z%&"
4693 This option writes its argument to Exim's logfile.
4694 Use is restricted to administrators; the intent is for operational notes.
4695 Quotes should be used to maintain a multi-word item as a single argument,
4696 under most shells.
4697 .endlist
4698
4699 .ecindex IIDclo1
4700 .ecindex IIDclo2
4701
4702
4703 . ////////////////////////////////////////////////////////////////////////////
4704 . Insert a stylized DocBook comment here, to identify the end of the command
4705 . line options. This is for the benefit of the Perl script that automatically
4706 . creates a man page for the options.
4707 . ////////////////////////////////////////////////////////////////////////////
4708
4709 .literal xml
4710 <!-- === End of command line options === -->
4711 .literal off
4712
4713
4714
4715
4716
4717 . ////////////////////////////////////////////////////////////////////////////
4718 . ////////////////////////////////////////////////////////////////////////////
4719
4720
4721 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4722          "The runtime configuration file"
4723
4724 .cindex "run time configuration"
4725 .cindex "configuration file" "general description"
4726 .cindex "CONFIGURE_FILE"
4727 .cindex "configuration file" "errors in"
4728 .cindex "error" "in configuration file"
4729 .cindex "return code" "for bad configuration"
4730 Exim uses a single run time configuration file that is read whenever an Exim
4731 binary is executed. Note that in normal operation, this happens frequently,
4732 because Exim is designed to operate in a distributed manner, without central
4733 control.
4734
4735 If a syntax error is detected while reading the configuration file, Exim
4736 writes a message on the standard error, and exits with a non-zero return code.
4737 The message is also written to the panic log. &*Note*&: Only simple syntax
4738 errors can be detected at this time. The values of any expanded options are
4739 not checked until the expansion happens, even when the expansion does not
4740 actually alter the string.
4741
4742 The name of the configuration file is compiled into the binary for security
4743 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4744 most configurations, this specifies a single file. However, it is permitted to
4745 give a colon-separated list of file names, in which case Exim uses the first
4746 existing file in the list.
4747
4748 .cindex "EXIM_USER"
4749 .cindex "EXIM_GROUP"
4750 .cindex "CONFIGURE_OWNER"
4751 .cindex "CONFIGURE_GROUP"
4752 .cindex "configuration file" "ownership"
4753 .cindex "ownership" "configuration file"
4754 The run time configuration file must be owned by root or by the user that is
4755 specified at compile time by the CONFIGURE_OWNER option (if set). The
4756 configuration file must not be world-writeable, or group-writeable unless its
4757 group is the root group or the one specified at compile time by the
4758 CONFIGURE_GROUP option.
4759
4760 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4761 to root, anybody who is able to edit the run time configuration file has an
4762 easy way to run commands as root. If you specify a user or group in the
4763 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4764 who are members of that group will trivially be able to obtain root privileges.
4765
4766 Up to Exim version 4.72, the run time configuration file was also permitted to
4767 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4768 since it offered a simple privilege escalation for any attacker who managed to
4769 compromise the Exim user account.
4770
4771 A default configuration file, which will work correctly in simple situations,
4772 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4773 defines just one file name, the installation process copies the default
4774 configuration to a new file of that name if it did not previously exist. If
4775 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4776 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4777 configuration.
4778
4779
4780
4781 .section "Using a different configuration file" "SECID40"
4782 .cindex "configuration file" "alternate"
4783 A one-off alternate configuration can be specified by the &%-C%& command line
4784 option, which may specify a single file or a list of files. However, when
4785 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4786 unless the argument for &%-C%& is identical to the built-in value from
4787 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4788 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4789 is useful mainly for checking the syntax of configuration files before
4790 installing them. No owner or group checks are done on a configuration file
4791 specified by &%-C%&, if root privilege has been dropped.
4792
4793 Even the Exim user is not trusted to specify an arbitrary configuration file
4794 with the &%-C%& option to be used with root privileges, unless that file is
4795 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4796 testing a configuration using &%-C%& right through message reception and
4797 delivery, even if the caller is root. The reception works, but by that time,
4798 Exim is running as the Exim user, so when it re-execs to regain privilege for
4799 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4800 can test reception and delivery using two separate commands (one to put a
4801 message on the queue, using &%-odq%&, and another to do the delivery, using
4802 &%-M%&).
4803
4804 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4805 prefix string with which any file named in a &%-C%& command line option must
4806 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4807 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4808 name can be used with &%-C%&.
4809
4810 One-off changes to a configuration can be specified by the &%-D%& command line
4811 option, which defines and overrides values for macros used inside the
4812 configuration file. However, like &%-C%&, the use of this option by a
4813 non-privileged user causes Exim to discard its root privilege.
4814 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4815 completely disabled, and its use causes an immediate error exit.
4816
4817 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4818 to declare certain macro names trusted, such that root privilege will not
4819 necessarily be discarded.
4820 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4821 considered safe and, if &%-D%& only supplies macros from this list, and the
4822 values are acceptable, then Exim will not give up root privilege if the caller
4823 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4824 transition mechanism and is expected to be removed in the future.  Acceptable
4825 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4826
4827 Some sites may wish to use the same Exim binary on different machines that
4828 share a file system, but to use different configuration files on each machine.
4829 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4830 looks for a file whose name is the configuration file name followed by a dot
4831 and the machine's node name, as obtained from the &[uname()]& function. If this
4832 file does not exist, the standard name is tried. This processing occurs for
4833 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4834
4835 In some esoteric situations different versions of Exim may be run under
4836 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4837 help with this. See the comments in &_src/EDITME_& for details.
4838
4839
4840
4841 .section "Configuration file format" "SECTconffilfor"
4842 .cindex "configuration file" "format of"
4843 .cindex "format" "configuration file"
4844 Exim's configuration file is divided into a number of different parts. General
4845 option settings must always appear at the start of the file. The other parts
4846 are all optional, and may appear in any order. Each part other than the first
4847 is introduced by the word &"begin"& followed by at least one literal
4848 space, and the name of the part. The optional parts are:
4849
4850 .ilist
4851 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4852 &<<CHAPACL>>&).
4853 .next
4854 .cindex "AUTH" "configuration"
4855 &'authenticators'&: Configuration settings for the authenticator drivers. These
4856 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4857 .next
4858 &'routers'&: Configuration settings for the router drivers. Routers process
4859 addresses and determine how the message is to be delivered (see chapters
4860 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4861 .next
4862 &'transports'&: Configuration settings for the transport drivers. Transports
4863 define mechanisms for copying messages to destinations (see chapters
4864 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4865 .next
4866 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4867 If there is no retry section, or if it is empty (that is, no retry rules are
4868 defined), Exim will not retry deliveries. In this situation, temporary errors
4869 are treated the same as permanent errors. Retry rules are discussed in chapter
4870 &<<CHAPretry>>&.
4871 .next
4872 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4873 when new addresses are generated during delivery. Rewriting is discussed in
4874 chapter &<<CHAPrewrite>>&.
4875 .next
4876 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4877 want to use this feature, you must set
4878 .code
4879 LOCAL_SCAN_HAS_OPTIONS=yes
4880 .endd
4881 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4882 facility are given in chapter &<<CHAPlocalscan>>&.
4883 .endlist
4884
4885 .cindex "configuration file" "leading white space in"
4886 .cindex "configuration file" "trailing white space in"
4887 .cindex "white space" "in configuration file"
4888 Leading and trailing white space in configuration lines is always ignored.
4889
4890 Blank lines in the file, and lines starting with a # character (ignoring
4891 leading white space) are treated as comments and are ignored. &*Note*&: A
4892 # character other than at the beginning of a line is not treated specially,
4893 and does not introduce a comment.
4894
4895 Any non-comment line can be continued by ending it with a backslash. Note that
4896 the general rule for white space means that trailing white space after the
4897 backslash and leading white space at the start of continuation
4898 lines is ignored. Comment lines beginning with # (but not empty lines) may
4899 appear in the middle of a sequence of continuation lines.
4900
4901 A convenient way to create a configuration file is to start from the
4902 default, which is supplied in &_src/configure.default_&, and add, delete, or
4903 change settings as required.
4904
4905 The ACLs, retry rules, and rewriting rules have their own syntax which is
4906 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4907 respectively. The other parts of the configuration file have some syntactic
4908 items in common, and these are described below, from section &<<SECTcos>>&
4909 onwards. Before that, the inclusion, macro, and conditional facilities are
4910 described.
4911
4912
4913
4914 .section "File inclusions in the configuration file" "SECID41"
4915 .cindex "inclusions in configuration file"
4916 .cindex "configuration file" "including other files"
4917 .cindex "&`.include`& in configuration file"
4918 .cindex "&`.include_if_exists`& in configuration file"
4919 You can include other files inside Exim's run time configuration file by
4920 using this syntax:
4921 .display
4922 &`.include`& <&'file name'&>
4923 &`.include_if_exists`& <&'file name'&>
4924 .endd
4925 on a line by itself. Double quotes round the file name are optional. If you use
4926 the first form, a configuration error occurs if the file does not exist; the
4927 second form does nothing for non-existent files. In all cases, an absolute file
4928 name is required.
4929
4930 Includes may be nested to any depth, but remember that Exim reads its
4931 configuration file often, so it is a good idea to keep them to a minimum.
4932 If you change the contents of an included file, you must HUP the daemon,
4933 because an included file is read only when the configuration itself is read.
4934
4935 The processing of inclusions happens early, at a physical line level, so, like
4936 comment lines, an inclusion can be used in the middle of an option setting,
4937 for example:
4938 .code
4939 hosts_lookup = a.b.c \
4940                .include /some/file
4941 .endd
4942 Include processing happens after macro processing (see below). Its effect is to
4943 process the lines of the included file as if they occurred inline where the
4944 inclusion appears.
4945
4946
4947
4948 .section "Macros in the configuration file" "SECTmacrodefs"
4949 .cindex "macro" "description of"
4950 .cindex "configuration file" "macros"
4951 If a line in the main part of the configuration (that is, before the first
4952 &"begin"& line) begins with an upper case letter, it is taken as a macro
4953 definition, and must be of the form
4954 .display
4955 <&'name'&> = <&'rest of line'&>
4956 .endd
4957 The name must consist of letters, digits, and underscores, and need not all be
4958 in upper case, though that is recommended. The rest of the line, including any
4959 continuations, is the replacement text, and has leading and trailing white
4960 space removed. Quotes are not removed. The replacement text can never end with
4961 a backslash character, but this doesn't seem to be a serious limitation.
4962
4963 Macros may also be defined between router, transport, authenticator, or ACL
4964 definitions. They may not, however, be defined within an individual driver or
4965 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4966
4967 .section "Macro substitution" "SECID42"
4968 Once a macro is defined, all subsequent lines in the file (and any included
4969 files) are scanned for the macro name; if there are several macros, the line is
4970 scanned for each in turn, in the order in which the macros are defined. The
4971 replacement text is not re-scanned for the current macro, though it is scanned
4972 for subsequently defined macros. For this reason, a macro name may not contain
4973 the name of a previously defined macro as a substring. You could, for example,
4974 define
4975 .display
4976 &`ABCD_XYZ = `&<&'something'&>
4977 &`ABCD = `&<&'something else'&>
4978 .endd
4979 but putting the definitions in the opposite order would provoke a configuration
4980 error. Macro expansion is applied to individual physical lines from the file,
4981 before checking for line continuation or file inclusion (see above). If a line
4982 consists solely of a macro name, and the expansion of the macro is empty, the
4983 line is ignored. A macro at the start of a line may turn the line into a
4984 comment line or a &`.include`& line.
4985
4986
4987 .section "Redefining macros" "SECID43"
4988 Once defined, the value of a macro can be redefined later in the configuration
4989 (or in an included file). Redefinition is specified by using &'=='& instead of
4990 &'='&. For example:
4991 .code
4992 MAC =  initial value
4993 ...
4994 MAC == updated value
4995 .endd
4996 Redefinition does not alter the order in which the macros are applied to the
4997 subsequent lines of the configuration file. It is still the same order in which
4998 the macros were originally defined. All that changes is the macro's value.
4999 Redefinition makes it possible to accumulate values. For example:
5000 .code
5001 MAC =  initial value
5002 ...
5003 MAC == MAC and something added
5004 .endd
5005 This can be helpful in situations where the configuration file is built
5006 from a number of other files.
5007
5008 .section "Overriding macro values" "SECID44"
5009 The values set for macros in the configuration file can be overridden by the
5010 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5011 used, unless called by root or the Exim user. A definition on the command line
5012 using the &%-D%& option causes all definitions and redefinitions within the
5013 file to be ignored.
5014
5015
5016
5017 .section "Example of macro usage" "SECID45"
5018 As an example of macro usage, consider a configuration where aliases are looked
5019 up in a MySQL database. It helps to keep the file less cluttered if long
5020 strings such as SQL statements are defined separately as macros, for example:
5021 .code
5022 ALIAS_QUERY = select mailbox from user where \
5023               login='${quote_mysql:$local_part}';
5024 .endd
5025 This can then be used in a &(redirect)& router setting like this:
5026 .code
5027 data = ${lookup mysql{ALIAS_QUERY}}
5028 .endd
5029 In earlier versions of Exim macros were sometimes used for domain, host, or
5030 address lists. In Exim 4 these are handled better by named lists &-- see
5031 section &<<SECTnamedlists>>&.
5032
5033
5034 .section "Conditional skips in the configuration file" "SECID46"
5035 .cindex "configuration file" "conditional skips"
5036 .cindex "&`.ifdef`&"
5037 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5038 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5039 portions of the configuration file. The processing happens whenever the file is
5040 read (that is, when an Exim binary starts to run).
5041
5042 The implementation is very simple. Instances of the first four directives must
5043 be followed by text that includes the names of one or macros. The condition
5044 that is tested is whether or not any macro substitution has taken place in the
5045 line. Thus:
5046 .code
5047 .ifdef AAA
5048 message_size_limit = 50M
5049 .else
5050 message_size_limit = 100M
5051 .endif
5052 .endd
5053 sets a message size limit of 50M if the macro &`AAA`& is defined
5054 (or &`A`& or &`AA`&), and 100M
5055 otherwise. If there is more than one macro named on the line, the condition
5056 is true if any of them are defined. That is, it is an &"or"& condition. To
5057 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5058
5059 Although you can use a macro expansion to generate one of these directives,
5060 it is not very useful, because the condition &"there was a macro substitution
5061 in this line"& will always be true.
5062
5063 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5064 to clarify complicated nestings.
5065
5066
5067
5068 .section "Common option syntax" "SECTcos"
5069 .cindex "common option syntax"
5070 .cindex "syntax of common options"
5071 .cindex "configuration file" "common option syntax"
5072 For the main set of options, driver options, and &[local_scan()]& options,
5073 each setting is on a line by itself, and starts with a name consisting of
5074 lower-case letters and underscores. Many options require a data value, and in
5075 these cases the name must be followed by an equals sign (with optional white
5076 space) and then the value. For example:
5077 .code
5078 qualify_domain = mydomain.example.com
5079 .endd
5080 .cindex "hiding configuration option values"
5081 .cindex "configuration options" "hiding value of"
5082 .cindex "options" "hiding value of"
5083 Some option settings may contain sensitive data, for example, passwords for
5084 accessing databases. To stop non-admin users from using the &%-bP%& command
5085 line option to read these values, you can precede the option settings with the
5086 word &"hide"&. For example:
5087 .code
5088 hide mysql_servers = localhost/users/admin/secret-password
5089 .endd
5090 For non-admin users, such options are displayed like this:
5091 .code
5092 mysql_servers = <value not displayable>
5093 .endd
5094 If &"hide"& is used on a driver option, it hides the value of that option on
5095 all instances of the same driver.
5096
5097 The following sections describe the syntax used for the different data types
5098 that are found in option settings.
5099
5100
5101 .section "Boolean options" "SECID47"
5102 .cindex "format" "boolean"
5103 .cindex "boolean configuration values"
5104 .oindex "&%no_%&&'xxx'&"
5105 .oindex "&%not_%&&'xxx'&"
5106 Options whose type is given as boolean are on/off switches. There are two
5107 different ways of specifying such options: with and without a data value. If
5108 the option name is specified on its own without data, the switch is turned on;
5109 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5110 boolean options may be followed by an equals sign and one of the words
5111 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5112 the following two settings have exactly the same effect:
5113 .code
5114 queue_only
5115 queue_only = true
5116 .endd
5117 The following two lines also have the same (opposite) effect:
5118 .code
5119 no_queue_only
5120 queue_only = false
5121 .endd
5122 You can use whichever syntax you prefer.
5123
5124
5125
5126
5127 .section "Integer values" "SECID48"
5128 .cindex "integer configuration values"
5129 .cindex "format" "integer"
5130 If an option's type is given as &"integer"&, the value can be given in decimal,
5131 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5132 number is assumed. Otherwise, it is treated as an octal number unless it starts
5133 with the characters &"0x"&, in which case the remainder is interpreted as a
5134 hexadecimal number.
5135
5136 If an integer value is followed by the letter K, it is multiplied by 1024; if
5137 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5138 of integer option settings are output, values which are an exact multiple of
5139 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5140 and M. The printing style is independent of the actual input format that was
5141 used.
5142
5143
5144 .section "Octal integer values" "SECID49"
5145 .cindex "integer format"
5146 .cindex "format" "octal integer"
5147 If an option's type is given as &"octal integer"&, its value is always
5148 interpreted as an octal number, whether or not it starts with the digit zero.
5149 Such options are always output in octal.
5150
5151
5152 .section "Fixed point numbers" "SECID50"
5153 .cindex "fixed point configuration values"
5154 .cindex "format" "fixed point"
5155 If an option's type is given as &"fixed-point"&, its value must be a decimal
5156 integer, optionally followed by a decimal point and up to three further digits.
5157
5158
5159
5160 .section "Time intervals" "SECTtimeformat"
5161 .cindex "time interval" "specifying in configuration"
5162 .cindex "format" "time interval"
5163 A time interval is specified as a sequence of numbers, each followed by one of
5164 the following letters, with no intervening white space:
5165
5166 .table2 30pt
5167 .irow &%s%& seconds
5168 .irow &%m%& minutes
5169 .irow &%h%& hours
5170 .irow &%d%& days
5171 .irow &%w%& weeks
5172 .endtable
5173
5174 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5175 intervals are output in the same format. Exim does not restrict the values; it
5176 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5177
5178
5179
5180 .section "String values" "SECTstrings"
5181 .cindex "string" "format of configuration values"
5182 .cindex "format" "string"
5183 If an option's type is specified as &"string"&, the value can be specified with
5184 or without double-quotes. If it does not start with a double-quote, the value
5185 consists of the remainder of the line plus any continuation lines, starting at
5186 the first character after any leading white space, with trailing white space
5187 removed, and with no interpretation of the characters in the string. Because
5188 Exim removes comment lines (those beginning with #) at an early stage, they can
5189 appear in the middle of a multi-line string. The following two settings are
5190 therefore equivalent:
5191 .code
5192 trusted_users = uucp:mail
5193 trusted_users = uucp:\
5194                 # This comment line is ignored
5195                 mail
5196 .endd
5197 .cindex "string" "quoted"
5198 .cindex "escape characters in quoted strings"
5199 If a string does start with a double-quote, it must end with a closing
5200 double-quote, and any backslash characters other than those used for line
5201 continuation are interpreted as escape characters, as follows:
5202
5203 .table2 100pt
5204 .irow &`\\`&                     "single backslash"
5205 .irow &`\n`&                     "newline"
5206 .irow &`\r`&                     "carriage return"
5207 .irow &`\t`&                     "tab"
5208 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5209 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5210                                    character"
5211 .endtable
5212
5213 If a backslash is followed by some other character, including a double-quote
5214 character, that character replaces the pair.
5215
5216 Quoting is necessary only if you want to make use of the backslash escapes to
5217 insert special characters, or if you need to specify a value with leading or
5218 trailing spaces. These cases are rare, so quoting is almost never needed in
5219 current versions of Exim. In versions of Exim before 3.14, quoting was required
5220 in order to continue lines, so you may come across older configuration files
5221 and examples that apparently quote unnecessarily.
5222
5223
5224 .section "Expanded strings" "SECID51"
5225 .cindex "expansion" "definition of"
5226 Some strings in the configuration file are subjected to &'string expansion'&,
5227 by which means various parts of the string may be changed according to the
5228 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5229 is as just described; in particular, the handling of backslashes in quoted
5230 strings is done as part of the input process, before expansion takes place.
5231 However, backslash is also an escape character for the expander, so any
5232 backslashes that are required for that reason must be doubled if they are
5233 within a quoted configuration string.
5234
5235
5236 .section "User and group names" "SECID52"
5237 .cindex "user name" "format of"
5238 .cindex "format" "user name"
5239 .cindex "groups" "name format"
5240 .cindex "format" "group name"
5241 User and group names are specified as strings, using the syntax described
5242 above, but the strings are interpreted specially. A user or group name must
5243 either consist entirely of digits, or be a name that can be looked up using the
5244 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5245
5246
5247 .section "List construction" "SECTlistconstruct"
5248 .cindex "list" "syntax of in configuration"
5249 .cindex "format" "list item in configuration"
5250 .cindex "string" "list, definition of"
5251 The data for some configuration options is a list of items, with colon as the
5252 default separator. Many of these options are shown with type &"string list"& in
5253 the descriptions later in this document. Others are listed as &"domain list"&,
5254 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5255 are all the same; however, those other than &"string list"& are subject to
5256 particular kinds of interpretation, as described in chapter
5257 &<<CHAPdomhosaddlists>>&.
5258
5259 In all these cases, the entire list is treated as a single string as far as the
5260 input syntax is concerned. The &%trusted_users%& setting in section
5261 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5262 in a list, it must be entered as two colons. Leading and trailing white space
5263 on each item in a list is ignored. This makes it possible to include items that
5264 start with a colon, and in particular, certain forms of IPv6 address. For
5265 example, the list
5266 .code
5267 local_interfaces = 127.0.0.1 : ::::1
5268 .endd
5269 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5270
5271 &*Note*&: Although leading and trailing white space is ignored in individual
5272 list items, it is not ignored when parsing the list. The space after the first
5273 colon in the example above is necessary. If it were not there, the list would
5274 be interpreted as the two items 127.0.0.1:: and 1.
5275
5276 .section "Changing list separators" "SECTlistsepchange"
5277 .cindex "list separator" "changing"
5278 .cindex "IPv6" "addresses in lists"
5279 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5280 introduced to allow the separator character to be changed. If a list begins
5281 with a left angle bracket, followed by any punctuation character, that
5282 character is used instead of colon as the list separator. For example, the list
5283 above can be rewritten to use a semicolon separator like this:
5284 .code
5285 local_interfaces = <; 127.0.0.1 ; ::1
5286 .endd
5287 This facility applies to all lists, with the exception of the list in
5288 &%log_file_path%&. It is recommended that the use of non-colon separators be
5289 confined to circumstances where they really are needed.
5290
5291 .cindex "list separator" "newline as"
5292 .cindex "newline" "as list separator"
5293 It is also possible to use newline and other control characters (those with
5294 code values less than 32, plus DEL) as separators in lists. Such separators
5295 must be provided literally at the time the list is processed. For options that
5296 are string-expanded, you can write the separator using a normal escape
5297 sequence. This will be processed by the expander before the string is
5298 interpreted as a list. For example, if a newline-separated list of domains is
5299 generated by a lookup, you can process it directly by a line such as this:
5300 .code
5301 domains = <\n ${lookup mysql{.....}}
5302 .endd
5303 This avoids having to change the list separator in such data. You are unlikely
5304 to want to use a control character as a separator in an option that is not
5305 expanded, because the value is literal text. However, it can be done by giving
5306 the value in quotes. For example:
5307 .code
5308 local_interfaces = "<\n 127.0.0.1 \n ::1"
5309 .endd
5310 Unlike printing character separators, which can be included in list items by
5311 doubling, it is not possible to include a control character as data when it is
5312 set as the separator. Two such characters in succession are interpreted as
5313 enclosing an empty list item.
5314
5315
5316
5317 .section "Empty items in lists" "SECTempitelis"
5318 .cindex "list" "empty item in"
5319 An empty item at the end of a list is always ignored. In other words, trailing
5320 separator characters are ignored. Thus, the list in
5321 .code
5322 senders = user@domain :
5323 .endd
5324 contains only a single item. If you want to include an empty string as one item
5325 in a list, it must not be the last item. For example, this list contains three
5326 items, the second of which is empty:
5327 .code
5328 senders = user1@domain : : user2@domain
5329 .endd
5330 &*Note*&: There must be white space between the two colons, as otherwise they
5331 are interpreted as representing a single colon data character (and the list
5332 would then contain just one item). If you want to specify a list that contains
5333 just one, empty item, you can do it as in this example:
5334 .code
5335 senders = :
5336 .endd
5337 In this case, the first item is empty, and the second is discarded because it
5338 is at the end of the list.
5339
5340
5341
5342
5343 .section "Format of driver configurations" "SECTfordricon"
5344 .cindex "drivers" "configuration format"
5345 There are separate parts in the configuration for defining routers, transports,
5346 and authenticators. In each part, you are defining a number of driver
5347 instances, each with its own set of options. Each driver instance is defined by
5348 a sequence of lines like this:
5349 .display
5350 <&'instance name'&>:
5351   <&'option'&>
5352   ...
5353   <&'option'&>
5354 .endd
5355 In the following example, the instance name is &(localuser)&, and it is
5356 followed by three options settings:
5357 .code
5358 localuser:
5359   driver = accept
5360   check_local_user
5361   transport = local_delivery
5362 .endd
5363 For each driver instance, you specify which Exim code module it uses &-- by the
5364 setting of the &%driver%& option &-- and (optionally) some configuration
5365 settings. For example, in the case of transports, if you want a transport to
5366 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5367 a local file you would use the &(appendfile)& driver. Each of the drivers is
5368 described in detail in its own separate chapter later in this manual.
5369
5370 You can have several routers, transports, or authenticators that are based on
5371 the same underlying driver (each must have a different instance name).
5372
5373 The order in which routers are defined is important, because addresses are
5374 passed to individual routers one by one, in order. The order in which
5375 transports are defined does not matter at all. The order in which
5376 authenticators are defined is used only when Exim, as a client, is searching
5377 them to find one that matches an authentication mechanism offered by the
5378 server.
5379
5380 .cindex "generic options"
5381 .cindex "options" "generic &-- definition of"
5382 Within a driver instance definition, there are two kinds of option: &'generic'&
5383 and &'private'&. The generic options are those that apply to all drivers of the
5384 same type (that is, all routers, all transports or all authenticators). The
5385 &%driver%& option is a generic option that must appear in every definition.
5386 .cindex "private options"
5387 The private options are special for each driver, and none need appear, because
5388 they all have default values.
5389
5390 The options may appear in any order, except that the &%driver%& option must
5391 precede any private options, since these depend on the particular driver. For
5392 this reason, it is recommended that &%driver%& always be the first option.
5393
5394 Driver instance names, which are used for reference in log entries and
5395 elsewhere, can be any sequence of letters, digits, and underscores (starting
5396 with a letter) and must be unique among drivers of the same type. A router and
5397 a transport (for example) can each have the same name, but no two router
5398 instances can have the same name. The name of a driver instance should not be
5399 confused with the name of the underlying driver module. For example, the
5400 configuration lines:
5401 .code
5402 remote_smtp:
5403   driver = smtp
5404 .endd
5405 create an instance of the &(smtp)& transport driver whose name is
5406 &(remote_smtp)&. The same driver code can be used more than once, with
5407 different instance names and different option settings each time. A second
5408 instance of the &(smtp)& transport, with different options, might be defined
5409 thus:
5410 .code
5411 special_smtp:
5412   driver = smtp
5413   port = 1234
5414   command_timeout = 10s
5415 .endd
5416 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5417 these transport instances from routers, and these names would appear in log
5418 lines.
5419
5420 Comment lines may be present in the middle of driver specifications. The full
5421 list of option settings for any particular driver instance, including all the
5422 defaulted values, can be extracted by making use of the &%-bP%& command line
5423 option.
5424
5425
5426
5427
5428
5429
5430 . ////////////////////////////////////////////////////////////////////////////
5431 . ////////////////////////////////////////////////////////////////////////////
5432
5433 .chapter "The default configuration file" "CHAPdefconfil"
5434 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5435 .cindex "default" "configuration file &""walk through""&"
5436 The default configuration file supplied with Exim as &_src/configure.default_&
5437 is sufficient for a host with simple mail requirements. As an introduction to
5438 the way Exim is configured, this chapter &"walks through"& the default
5439 configuration, giving brief explanations of the settings. Detailed descriptions
5440 of the options are given in subsequent chapters. The default configuration file
5441 itself contains extensive comments about ways you might want to modify the
5442 initial settings. However, note that there are many options that are not
5443 mentioned at all in the default configuration.
5444
5445
5446
5447 .section "Main configuration settings" "SECTdefconfmain"
5448 The main (global) configuration option settings must always come first in the
5449 file. The first thing you'll see in the file, after some initial comments, is
5450 the line
5451 .code
5452 # primary_hostname =
5453 .endd
5454 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5455 to know the official, fully qualified name of your host, and this is where you
5456 can specify it. However, in most cases you do not need to set this option. When
5457 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5458
5459 The first three non-comment configuration lines are as follows:
5460 .code
5461 domainlist local_domains    = @
5462 domainlist relay_to_domains =
5463 hostlist   relay_from_hosts = 127.0.0.1
5464 .endd
5465 These are not, in fact, option settings. They are definitions of two named
5466 domain lists and one named host list. Exim allows you to give names to lists of
5467 domains, hosts, and email addresses, in order to make it easier to manage the
5468 configuration file (see section &<<SECTnamedlists>>&).
5469
5470 The first line defines a domain list called &'local_domains'&; this is used
5471 later in the configuration to identify domains that are to be delivered
5472 on the local host.
5473
5474 .cindex "@ in a domain list"
5475 There is just one item in this list, the string &"@"&. This is a special form
5476 of entry which means &"the name of the local host"&. Thus, if the local host is
5477 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5478 be delivered locally. Because the local host's name is referenced indirectly,
5479 the same configuration file can be used on different hosts.
5480
5481 The second line defines a domain list called &'relay_to_domains'&, but the
5482 list itself is empty. Later in the configuration we will come to the part that
5483 controls mail relaying through the local host; it allows relaying to any
5484 domains in this list. By default, therefore, no relaying on the basis of a mail
5485 domain is permitted.
5486
5487 The third line defines a host list called &'relay_from_hosts'&. This list is
5488 used later in the configuration to permit relaying from any host or IP address
5489 that matches the list. The default contains just the IP address of the IPv4
5490 loopback interface, which means that processes on the local host are able to
5491 submit mail for relaying by sending it over TCP/IP to that interface. No other
5492 hosts are permitted to submit messages for relaying.
5493
5494 Just to be sure there's no misunderstanding: at this point in the configuration
5495 we aren't actually setting up any controls. We are just defining some domains
5496 and hosts that will be used in the controls that are specified later.
5497
5498 The next two configuration lines are genuine option settings:
5499 .code
5500 acl_smtp_rcpt = acl_check_rcpt
5501 acl_smtp_data = acl_check_data
5502 .endd
5503 These options specify &'Access Control Lists'& (ACLs) that are to be used
5504 during an incoming SMTP session for every recipient of a message (every RCPT
5505 command), and after the contents of the message have been received,
5506 respectively. The names of the lists are &'acl_check_rcpt'& and
5507 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5508 section of the configuration. The RCPT ACL controls which recipients are
5509 accepted for an incoming message &-- if a configuration does not provide an ACL
5510 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5511 contents of a message to be checked.
5512
5513 Two commented-out option settings are next:
5514 .code
5515 # av_scanner = clamd:/tmp/clamd
5516 # spamd_address = 127.0.0.1 783
5517 .endd
5518 These are example settings that can be used when Exim is compiled with the
5519 content-scanning extension. The first specifies the interface to the virus
5520 scanner, and the second specifies the interface to SpamAssassin. Further
5521 details are given in chapter &<<CHAPexiscan>>&.
5522
5523 Three more commented-out option settings follow:
5524 .code
5525 # tls_advertise_hosts = *
5526 # tls_certificate = /etc/ssl/exim.crt
5527 # tls_privatekey = /etc/ssl/exim.pem
5528 .endd
5529 These are example settings that can be used when Exim is compiled with
5530 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5531 first one specifies the list of clients that are allowed to use TLS when
5532 connecting to this server; in this case the wildcard means all clients. The
5533 other options specify where Exim should find its TLS certificate and private
5534 key, which together prove the server's identity to any clients that connect.
5535 More details are given in chapter &<<CHAPTLS>>&.
5536
5537 Another two commented-out option settings follow:
5538 .code
5539 # daemon_smtp_ports = 25 : 465 : 587
5540 # tls_on_connect_ports = 465
5541 .endd
5542 .cindex "port" "465 and 587"
5543 .cindex "port" "for message submission"
5544 .cindex "message" "submission, ports for"
5545 .cindex "ssmtp protocol"
5546 .cindex "smtps protocol"
5547 .cindex "SMTP" "ssmtp protocol"
5548 .cindex "SMTP" "smtps protocol"
5549 These options provide better support for roaming users who wish to use this
5550 server for message submission. They are not much use unless you have turned on
5551 TLS (as described in the previous paragraph) and authentication (about which
5552 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5553 on end-user networks, so RFC 4409 specifies that message submission should use
5554 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5555 configured to use port 587 correctly, so these settings also enable the
5556 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5557 &<<SECTsupobssmt>>&).
5558
5559 Two more commented-out options settings follow:
5560 .code
5561 # qualify_domain =
5562 # qualify_recipient =
5563 .endd
5564 The first of these specifies a domain that Exim uses when it constructs a
5565 complete email address from a local login name. This is often needed when Exim
5566 receives a message from a local process. If you do not set &%qualify_domain%&,
5567 the value of &%primary_hostname%& is used. If you set both of these options,
5568 you can have different qualification domains for sender and recipient
5569 addresses. If you set only the first one, its value is used in both cases.
5570
5571 .cindex "domain literal" "recognizing format"
5572 The following line must be uncommented if you want Exim to recognize
5573 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5574 (an IP address within square brackets) instead of a named domain.
5575 .code
5576 # allow_domain_literals
5577 .endd
5578 The RFCs still require this form, but many people think that in the modern
5579 Internet it makes little sense to permit mail to be sent to specific hosts by
5580 quoting their IP addresses. This ancient format has been used by people who
5581 try to abuse hosts by using them for unwanted relaying. However, some
5582 people believe there are circumstances (for example, messages addressed to
5583 &'postmaster'&) where domain literals are still useful.
5584
5585 The next configuration line is a kind of trigger guard:
5586 .code
5587 never_users = root
5588 .endd
5589 It specifies that no delivery must ever be run as the root user. The normal
5590 convention is to set up &'root'& as an alias for the system administrator. This
5591 setting is a guard against slips in the configuration.
5592 The list of users specified by &%never_users%& is not, however, the complete
5593 list; the build-time configuration in &_Local/Makefile_& has an option called
5594 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5595 contents of &%never_users%& are added to this list. By default
5596 FIXED_NEVER_USERS also specifies root.
5597
5598 When a remote host connects to Exim in order to send mail, the only information
5599 Exim has about the host's identity is its IP address. The next configuration
5600 line,
5601 .code
5602 host_lookup = *
5603 .endd
5604 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5605 in order to get a host name. This improves the quality of the logging
5606 information, but if you feel it is too expensive, you can remove it entirely,
5607 or restrict the lookup to hosts on &"nearby"& networks.
5608 Note that it is not always possible to find a host name from an IP address,
5609 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5610 unreachable.
5611
5612 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5613 1413 (hence their names):
5614 .code
5615 rfc1413_hosts = *
5616 rfc1413_query_timeout = 0s
5617 .endd
5618 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5619 Few hosts offer RFC1413 service these days; calls have to be
5620 terminated by a timeout and this needlessly delays the startup
5621 of an incoming SMTP connection.
5622 If you have hosts for which you trust RFC1413 and need this
5623 information, you can change this.
5624
5625 This line enables an efficiency SMTP option.  It is negotiated by clients
5626 and not expected to cause problems but can be disabled if needed.
5627 .code
5628 prdr_enable = true
5629 .endd
5630
5631 When Exim receives messages over SMTP connections, it expects all addresses to
5632 be fully qualified with a domain, as required by the SMTP definition. However,
5633 if you are running a server to which simple clients submit messages, you may
5634 find that they send unqualified addresses. The two commented-out options:
5635 .code
5636 # sender_unqualified_hosts =
5637 # recipient_unqualified_hosts =
5638 .endd
5639 show how you can specify hosts that are permitted to send unqualified sender
5640 and recipient addresses, respectively.
5641
5642 The &%log_selector%& option is used to increase the detail of logging
5643 over the default:
5644 .code
5645 log_selector = +smtp_protocol_error +smtp_syntax_error \
5646                +tls_certificate_verified
5647 .endd
5648
5649 The &%percent_hack_domains%& option is also commented out:
5650 .code
5651 # percent_hack_domains =
5652 .endd
5653 It provides a list of domains for which the &"percent hack"& is to operate.
5654 This is an almost obsolete form of explicit email routing. If you do not know
5655 anything about it, you can safely ignore this topic.
5656
5657 The next two settings in the main part of the default configuration are
5658 concerned with messages that have been &"frozen"& on Exim's queue. When a
5659 message is frozen, Exim no longer continues to try to deliver it. Freezing
5660 occurs when a bounce message encounters a permanent failure because the sender
5661 address of the original message that caused the bounce is invalid, so the
5662 bounce cannot be delivered. This is probably the most common case, but there
5663 are also other conditions that cause freezing, and frozen messages are not
5664 always bounce messages.
5665 .code
5666 ignore_bounce_errors_after = 2d
5667 timeout_frozen_after = 7d
5668 .endd
5669 The first of these options specifies that failing bounce messages are to be
5670 discarded after 2 days on the queue. The second specifies that any frozen
5671 message (whether a bounce message or not) is to be timed out (and discarded)
5672 after a week. In this configuration, the first setting ensures that no failing
5673 bounce message ever lasts a week.
5674
5675 Exim queues it's messages in a spool directory. If you expect to have
5676 large queues, you may consider using this option. It splits the spool
5677 directory into subdirectories to avoid file system degradation from
5678 many files in a single directory, resulting in better performance.
5679 Manual manipulation of queued messages becomes more complex (though fortunately
5680 not often needed).
5681 .code
5682 # split_spool_directory = true
5683 .endd
5684
5685 In an ideal world everybody follows the standards. For non-ASCII
5686 messages RFC 2047 is a standard, allowing a maximum line length of 76
5687 characters. Exim adheres that standard and won't process messages which
5688 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5689 In particular, the Exim maintainers have had multiple reports of
5690 problems from Russian administrators of issues until they disable this
5691 check, because of some popular, yet buggy, mail composition software.
5692 .code
5693 # check_rfc2047_length = false
5694 .endd
5695
5696 If you need to be strictly RFC compliant you may wish to disable the
5697 8BITMIME advertisement. Use this, if you exchange mails with systems
5698 that are not 8-bit clean.
5699 .code
5700 # accept_8bitmime = false
5701 .endd
5702
5703 Libraries you use may depend on specific environment settings.  This
5704 imposes a security risk (e.g. PATH). There are two lists:
5705 &%keep_environment%& for the variables to import as they are, and
5706 &%add_environment%& for variables we want to set to a fixed value.
5707 Note that TZ is handled separately, by the $%timezone%$ runtime
5708 option and by the TIMEZONE_DEFAULT buildtime option.
5709 .code
5710 # keep_environment = ^LDAP
5711 # add_environment = PATH=/usr/bin::/bin
5712 .endd
5713
5714
5715 .section "ACL configuration" "SECID54"
5716 .cindex "default" "ACLs"
5717 .cindex "&ACL;" "default configuration"
5718 In the default configuration, the ACL section follows the main configuration.
5719 It starts with the line
5720 .code
5721 begin acl
5722 .endd
5723 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5724 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5725 and &%acl_smtp_data%& above.
5726
5727 .cindex "RCPT" "ACL for"
5728 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5729 RCPT command specifies one of the message's recipients. The ACL statements
5730 are considered in order, until the recipient address is either accepted or
5731 rejected. The RCPT command is then accepted or rejected, according to the
5732 result of the ACL processing.
5733 .code
5734 acl_check_rcpt:
5735 .endd
5736 This line, consisting of a name terminated by a colon, marks the start of the
5737 ACL, and names it.
5738 .code
5739 accept  hosts = :
5740 .endd
5741 This ACL statement accepts the recipient if the sending host matches the list.
5742 But what does that strange list mean? It doesn't actually contain any host
5743 names or IP addresses. The presence of the colon puts an empty item in the
5744 list; Exim matches this only if the incoming message did not come from a remote
5745 host, because in that case, the remote hostname is empty. The colon is
5746 important. Without it, the list itself is empty, and can never match anything.
5747
5748 What this statement is doing is to accept unconditionally all recipients in
5749 messages that are submitted by SMTP from local processes using the standard
5750 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5751 manner.
5752 .code
5753 deny    message       = Restricted characters in address
5754         domains       = +local_domains
5755         local_parts   = ^[.] : ^.*[@%!/|]
5756
5757 deny    message       = Restricted characters in address
5758         domains       = !+local_domains
5759         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5760 .endd
5761 These statements are concerned with local parts that contain any of the
5762 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5763 Although these characters are entirely legal in local parts (in the case of
5764 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5765 in Internet mail addresses.
5766
5767 The first three have in the past been associated with explicitly routed
5768 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5769 option). Addresses containing these characters are regularly tried by spammers
5770 in an attempt to bypass relaying restrictions, and also by open relay testing
5771 programs. Unless you really need them it is safest to reject these characters
5772 at this early stage. This configuration is heavy-handed in rejecting these
5773 characters for all messages it accepts from remote hosts. This is a deliberate
5774 policy of being as safe as possible.
5775
5776 The first rule above is stricter, and is applied to messages that are addressed
5777 to one of the local domains handled by this host. This is implemented by the
5778 first condition, which restricts it to domains that are listed in the
5779 &'local_domains'& domain list. The &"+"& character is used to indicate a
5780 reference to a named list. In this configuration, there is just one domain in
5781 &'local_domains'&, but in general there may be many.
5782
5783 The second condition on the first statement uses two regular expressions to
5784 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5785 or &"|"&. If you have local accounts that include these characters, you will
5786 have to modify this rule.
5787
5788 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5789 allows them because they have been encountered in practice. (Consider the
5790 common convention of local parts constructed as
5791 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5792 the author of Exim, who has no second initial.) However, a local part starting
5793 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5794 file name (for example, for a mailing list). This is also true for local parts
5795 that contain slashes. A pipe symbol can also be troublesome if the local part
5796 is incorporated unthinkingly into a shell command line.
5797
5798 The second rule above applies to all other domains, and is less strict. This
5799 allows your own users to send outgoing messages to sites that use slashes
5800 and vertical bars in their local parts. It blocks local parts that begin
5801 with a dot, slash, or vertical bar, but allows these characters within the
5802 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5803 and &"!"& is blocked, as before. The motivation here is to prevent your users
5804 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5805 .code
5806 accept  local_parts   = postmaster
5807         domains       = +local_domains
5808 .endd
5809 This statement, which has two conditions, accepts an incoming address if the
5810 local part is &'postmaster'& and the domain is one of those listed in the
5811 &'local_domains'& domain list. The &"+"& character is used to indicate a
5812 reference to a named list. In this configuration, there is just one domain in
5813 &'local_domains'&, but in general there may be many.
5814
5815 The presence of this statement means that mail to postmaster is never blocked
5816 by any of the subsequent tests. This can be helpful while sorting out problems
5817 in cases where the subsequent tests are incorrectly denying access.
5818 .code
5819 require verify        = sender
5820 .endd
5821 This statement requires the sender address to be verified before any subsequent
5822 ACL statement can be used. If verification fails, the incoming recipient
5823 address is refused. Verification consists of trying to route the address, to
5824 see if a bounce message could be delivered to it. In the case of remote
5825 addresses, basic verification checks only the domain, but &'callouts'& can be
5826 used for more verification if required. Section &<<SECTaddressverification>>&
5827 discusses the details of address verification.
5828 .code
5829 accept  hosts         = +relay_from_hosts
5830         control       = submission
5831 .endd
5832 This statement accepts the address if the message is coming from one of the
5833 hosts that are defined as being allowed to relay through this host. Recipient
5834 verification is omitted here, because in many cases the clients are dumb MUAs
5835 that do not cope well with SMTP error responses. For the same reason, the
5836 second line specifies &"submission mode"& for messages that are accepted. This
5837 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5838 messages that are deficient in some way, for example, because they lack a
5839 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5840 probably add recipient verification here, and disable submission mode.
5841 .code
5842 accept  authenticated = *
5843         control       = submission
5844 .endd
5845 This statement accepts the address if the client host has authenticated itself.
5846 Submission mode is again specified, on the grounds that such messages are most
5847 likely to come from MUAs. The default configuration does not define any
5848 authenticators, though it does include some nearly complete commented-out
5849 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5850 fact authenticate until you complete the authenticator definitions.
5851 .code
5852 require message = relay not permitted
5853         domains = +local_domains : +relay_to_domains
5854 .endd
5855 This statement rejects the address if its domain is neither a local domain nor
5856 one of the domains for which this host is a relay.
5857 .code
5858 require verify = recipient
5859 .endd
5860 This statement requires the recipient address to be verified; if verification
5861 fails, the address is rejected.
5862 .code
5863 # deny    message     = rejected because $sender_host_address \
5864 #                       is in a black list at $dnslist_domain\n\
5865 #                       $dnslist_text
5866 #         dnslists    = black.list.example
5867 #
5868 # warn    dnslists    = black.list.example
5869 #         add_header  = X-Warning: $sender_host_address is in \
5870 #                       a black list at $dnslist_domain
5871 #         log_message = found in $dnslist_domain
5872 .endd
5873 These commented-out lines are examples of how you could configure Exim to check
5874 sending hosts against a DNS black list. The first statement rejects messages
5875 from blacklisted hosts, whereas the second just inserts a warning header
5876 line.
5877 .code
5878 # require verify = csa
5879 .endd
5880 This commented-out line is an example of how you could turn on client SMTP
5881 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5882 records.
5883 .code
5884 accept
5885 .endd
5886 The final statement in the first ACL unconditionally accepts any recipient
5887 address that has successfully passed all the previous tests.
5888 .code
5889 acl_check_data:
5890 .endd
5891 This line marks the start of the second ACL, and names it. Most of the contents
5892 of this ACL are commented out:
5893 .code
5894 # deny    malware   = *
5895 #         message   = This message contains a virus \
5896 #                     ($malware_name).
5897 .endd
5898 These lines are examples of how to arrange for messages to be scanned for
5899 viruses when Exim has been compiled with the content-scanning extension, and a
5900 suitable virus scanner is installed. If the message is found to contain a
5901 virus, it is rejected with the given custom error message.
5902 .code
5903 # warn    spam      = nobody
5904 #         message   = X-Spam_score: $spam_score\n\
5905 #                     X-Spam_score_int: $spam_score_int\n\
5906 #                     X-Spam_bar: $spam_bar\n\
5907 #                     X-Spam_report: $spam_report
5908 .endd
5909 These lines are an example of how to arrange for messages to be scanned by
5910 SpamAssassin when Exim has been compiled with the content-scanning extension,
5911 and SpamAssassin has been installed. The SpamAssassin check is run with
5912 &`nobody`& as its user parameter, and the results are added to the message as a
5913 series of extra header line. In this case, the message is not rejected,
5914 whatever the spam score.
5915 .code
5916 accept
5917 .endd
5918 This final line in the DATA ACL accepts the message unconditionally.
5919
5920
5921 .section "Router configuration" "SECID55"
5922 .cindex "default" "routers"
5923 .cindex "routers" "default"
5924 The router configuration comes next in the default configuration, introduced
5925 by the line
5926 .code
5927 begin routers
5928 .endd
5929 Routers are the modules in Exim that make decisions about where to send
5930 messages. An address is passed to each router in turn, until it is either
5931 accepted, or failed. This means that the order in which you define the routers
5932 matters. Each router is fully described in its own chapter later in this
5933 manual. Here we give only brief overviews.
5934 .code
5935 # domain_literal:
5936 #   driver = ipliteral
5937 #   domains = !+local_domains
5938 #   transport = remote_smtp
5939 .endd
5940 .cindex "domain literal" "default router"
5941 This router is commented out because the majority of sites do not want to
5942 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5943 you uncomment this router, you also need to uncomment the setting of
5944 &%allow_domain_literals%& in the main part of the configuration.
5945 .code
5946 dnslookup:
5947   driver = dnslookup
5948   domains = ! +local_domains
5949   transport = remote_smtp
5950   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5951   no_more
5952 .endd
5953 The first uncommented router handles addresses that do not involve any local
5954 domains. This is specified by the line
5955 .code
5956 domains = ! +local_domains
5957 .endd
5958 The &%domains%& option lists the domains to which this router applies, but the
5959 exclamation mark is a negation sign, so the router is used only for domains
5960 that are not in the domain list called &'local_domains'& (which was defined at
5961 the start of the configuration). The plus sign before &'local_domains'&
5962 indicates that it is referring to a named list. Addresses in other domains are
5963 passed on to the following routers.
5964
5965 The name of the router driver is &(dnslookup)&,
5966 and is specified by the &%driver%& option. Do not be confused by the fact that
5967 the name of this router instance is the same as the name of the driver. The
5968 instance name is arbitrary, but the name set in the &%driver%& option must be
5969 one of the driver modules that is in the Exim binary.
5970
5971 The &(dnslookup)& router routes addresses by looking up their domains in the
5972 DNS in order to obtain a list of hosts to which the address is routed. If the
5973 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5974 specified by the &%transport%& option. If the router does not find the domain
5975 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5976 the address fails and is bounced.
5977
5978 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5979 be entirely ignored. This option is present because a number of cases have been
5980 encountered where MX records in the DNS point to host names
5981 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5982 Completely ignoring these IP addresses causes Exim to fail to route the
5983 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5984 continue to try to deliver the message periodically until the address timed
5985 out.
5986 .code
5987 system_aliases:
5988   driver = redirect
5989   allow_fail
5990   allow_defer
5991   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5992 # user = exim
5993   file_transport = address_file
5994   pipe_transport = address_pipe
5995 .endd
5996 Control reaches this and subsequent routers only for addresses in the local
5997 domains. This router checks to see whether the local part is defined as an
5998 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5999 data that it looks up from that file. If no data is found for the local part,
6000 the value of the &%data%& option is empty, causing the address to be passed to
6001 the next router.
6002
6003 &_/etc/aliases_& is a conventional name for the system aliases file that is
6004 often used. That is why it is referenced by from the default configuration
6005 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6006 &_Local/Makefile_& before building Exim.
6007 .code
6008 userforward:
6009   driver = redirect
6010   check_local_user
6011 # local_part_suffix = +* : -*
6012 # local_part_suffix_optional
6013   file = $home/.forward
6014 # allow_filter
6015   no_verify
6016   no_expn
6017   check_ancestor
6018   file_transport = address_file
6019   pipe_transport = address_pipe
6020   reply_transport = address_reply
6021 .endd
6022 This is the most complicated router in the default configuration. It is another
6023 redirection router, but this time it is looking for forwarding data set up by
6024 individual users. The &%check_local_user%& setting specifies a check that the
6025 local part of the address is the login name of a local user. If it is not, the
6026 router is skipped. The two commented options that follow &%check_local_user%&,
6027 namely:
6028 .code
6029 # local_part_suffix = +* : -*
6030 # local_part_suffix_optional
6031 .endd
6032 .vindex "&$local_part_suffix$&"
6033 show how you can specify the recognition of local part suffixes. If the first
6034 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6035 by any sequence of characters, is removed from the local part and placed in the
6036 variable &$local_part_suffix$&. The second suffix option specifies that the
6037 presence of a suffix in the local part is optional. When a suffix is present,
6038 the check for a local login uses the local part with the suffix removed.
6039
6040 When a local user account is found, the file called &_.forward_& in the user's
6041 home directory is consulted. If it does not exist, or is empty, the router
6042 declines. Otherwise, the contents of &_.forward_& are interpreted as
6043 redirection data (see chapter &<<CHAPredirect>>& for more details).
6044
6045 .cindex "Sieve filter" "enabling in default router"
6046 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6047 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6048 is commented out by default), the contents of the file are interpreted as a set
6049 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6050 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6051 separate document entitled &'Exim's interfaces to mail filtering'&.
6052
6053 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6054 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6055 There are two reasons for doing this:
6056
6057 .olist
6058 Whether or not a local user has a &_.forward_& file is not really relevant when
6059 checking an address for validity; it makes sense not to waste resources doing
6060 unnecessary work.
6061 .next
6062 More importantly, when Exim is verifying addresses or handling an EXPN
6063 command during an SMTP session, it is running as the Exim user, not as root.
6064 The group is the Exim group, and no additional groups are set up.
6065 It may therefore not be possible for Exim to read users' &_.forward_& files at
6066 this time.
6067 .endlist
6068
6069 The setting of &%check_ancestor%& prevents the router from generating a new
6070 address that is the same as any previous address that was redirected. (This
6071 works round a problem concerning a bad interaction between aliasing and
6072 forwarding &-- see section &<<SECTredlocmai>>&).
6073
6074 The final three option settings specify the transports that are to be used when
6075 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6076 auto-reply, respectively. For example, if a &_.forward_& file contains
6077 .code
6078 a.nother@elsewhere.example, /home/spqr/archive
6079 .endd
6080 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6081 transport.
6082 .code
6083 localuser:
6084   driver = accept
6085   check_local_user
6086 # local_part_suffix = +* : -*
6087 # local_part_suffix_optional
6088   transport = local_delivery
6089 .endd
6090 The final router sets up delivery into local mailboxes, provided that the local
6091 part is the name of a local login, by accepting the address and assigning it to
6092 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6093 routers, so the address is bounced. The commented suffix settings fulfil the
6094 same purpose as they do for the &(userforward)& router.
6095
6096
6097 .section "Transport configuration" "SECID56"
6098 .cindex "default" "transports"
6099 .cindex "transports" "default"
6100 Transports define mechanisms for actually delivering messages. They operate
6101 only when referenced from routers, so the order in which they are defined does
6102 not matter. The transports section of the configuration starts with
6103 .code
6104 begin transports
6105 .endd
6106 One remote transport and four local transports are defined.
6107 .code
6108 remote_smtp:
6109   driver = smtp
6110   hosts_try_prdr = *
6111 .endd
6112 This transport is used for delivering messages over SMTP connections.
6113 The list of remote hosts comes from the router.
6114 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6115 It is negotiated between client and server
6116 and not expected to cause problems but can be disabled if needed.
6117 All other options are defaulted.
6118 .code
6119 local_delivery:
6120   driver = appendfile
6121   file = /var/mail/$local_part
6122   delivery_date_add
6123   envelope_to_add
6124   return_path_add
6125 # group = mail
6126 # mode = 0660
6127 .endd
6128 This &(appendfile)& transport is used for local delivery to user mailboxes in
6129 traditional BSD mailbox format. By default it runs under the uid and gid of the
6130 local user, which requires the sticky bit to be set on the &_/var/mail_&
6131 directory. Some systems use the alternative approach of running mail deliveries
6132 under a particular group instead of using the sticky bit. The commented options
6133 show how this can be done.
6134
6135 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6136 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6137 similarly-named options above.
6138 .code
6139 address_pipe:
6140   driver = pipe
6141   return_output
6142 .endd
6143 This transport is used for handling deliveries to pipes that are generated by
6144 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6145 option specifies that any output on stdout or stderr generated by the pipe is to
6146 be returned to the sender.
6147 .code
6148 address_file:
6149   driver = appendfile
6150   delivery_date_add
6151   envelope_to_add
6152   return_path_add
6153 .endd
6154 This transport is used for handling deliveries to files that are generated by
6155 redirection. The name of the file is not specified in this instance of
6156 &(appendfile)&, because it comes from the &(redirect)& router.
6157 .code
6158 address_reply:
6159   driver = autoreply
6160 .endd
6161 This transport is used for handling automatic replies generated by users'
6162 filter files.
6163
6164
6165
6166 .section "Default retry rule" "SECID57"
6167 .cindex "retry" "default rule"
6168 .cindex "default" "retry rule"
6169 The retry section of the configuration file contains rules which affect the way
6170 Exim retries deliveries that cannot be completed at the first attempt. It is
6171 introduced by the line
6172 .code
6173 begin retry
6174 .endd
6175 In the default configuration, there is just one rule, which applies to all
6176 errors:
6177 .code
6178 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6179 .endd
6180 This causes any temporarily failing address to be retried every 15 minutes for
6181 2 hours, then at intervals starting at one hour and increasing by a factor of
6182 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6183 is not delivered after 4 days of temporary failure, it is bounced. The time is
6184 measured from first failure, not from the time the message was received.
6185
6186 If the retry section is removed from the configuration, or is empty (that is,
6187 if no retry rules are defined), Exim will not retry deliveries. This turns
6188 temporary errors into permanent errors.
6189
6190
6191 .section "Rewriting configuration" "SECID58"
6192 The rewriting section of the configuration, introduced by
6193 .code
6194 begin rewrite
6195 .endd
6196 contains rules for rewriting addresses in messages as they arrive. There are no
6197 rewriting rules in the default configuration file.
6198
6199
6200
6201 .section "Authenticators configuration" "SECTdefconfauth"
6202 .cindex "AUTH" "configuration"
6203 The authenticators section of the configuration, introduced by
6204 .code
6205 begin authenticators
6206 .endd
6207 defines mechanisms for the use of the SMTP AUTH command. The default
6208 configuration file contains two commented-out example authenticators
6209 which support plaintext username/password authentication using the
6210 standard PLAIN mechanism and the traditional but non-standard LOGIN
6211 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6212 to support most MUA software.
6213
6214 The example PLAIN authenticator looks like this:
6215 .code
6216 #PLAIN:
6217 #  driver                  = plaintext
6218 #  server_set_id           = $auth2
6219 #  server_prompts          = :
6220 #  server_condition        = Authentication is not yet configured
6221 #  server_advertise_condition = ${if def:tls_in_cipher }
6222 .endd
6223 And the example LOGIN authenticator looks like this:
6224 .code
6225 #LOGIN:
6226 #  driver                  = plaintext
6227 #  server_set_id           = $auth1
6228 #  server_prompts          = <| Username: | Password:
6229 #  server_condition        = Authentication is not yet configured
6230 #  server_advertise_condition = ${if def:tls_in_cipher }
6231 .endd
6232
6233 The &%server_set_id%& option makes Exim remember the authenticated username
6234 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6235 &%server_prompts%& option configures the &(plaintext)& authenticator so
6236 that it implements the details of the specific authentication mechanism,
6237 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6238 when Exim offers authentication to clients; in the examples, this is only
6239 when TLS or SSL has been started, so to enable the authenticators you also
6240 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6241
6242 The &%server_condition%& setting defines how to verify that the username and
6243 password are correct. In the examples it just produces an error message.
6244 To make the authenticators work, you can use a string expansion
6245 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6246
6247 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6248 usercode and password are in different positions.
6249 Chapter &<<CHAPplaintext>>& covers both.
6250
6251 .ecindex IIDconfiwal
6252
6253
6254
6255 . ////////////////////////////////////////////////////////////////////////////
6256 . ////////////////////////////////////////////////////////////////////////////
6257
6258 .chapter "Regular expressions" "CHAPregexp"
6259
6260 .cindex "regular expressions" "library"
6261 .cindex "PCRE"
6262 Exim supports the use of regular expressions in many of its options. It
6263 uses the PCRE regular expression library; this provides regular expression
6264 matching that is compatible with Perl 5. The syntax and semantics of
6265 regular expressions is discussed in many Perl reference books, and also in
6266 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6267 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6268
6269 The documentation for the syntax and semantics of the regular expressions that
6270 are supported by PCRE is included in the PCRE distribution, and no further
6271 description is included here. The PCRE functions are called from Exim using
6272 the default option settings (that is, with no PCRE options set), except that
6273 the PCRE_CASELESS option is set when the matching is required to be
6274 case-insensitive.
6275
6276 In most cases, when a regular expression is required in an Exim configuration,
6277 it has to start with a circumflex, in order to distinguish it from plain text
6278 or an &"ends with"& wildcard. In this example of a configuration setting, the
6279 second item in the colon-separated list is a regular expression.
6280 .code
6281 domains = a.b.c : ^\\d{3} : *.y.z : ...
6282 .endd
6283 The doubling of the backslash is required because of string expansion that
6284 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6285 of this issue, and a way of avoiding the need for doubling backslashes. The
6286 regular expression that is eventually used in this example contains just one
6287 backslash. The circumflex is included in the regular expression, and has the
6288 normal effect of &"anchoring"& it to the start of the string that is being
6289 matched.
6290
6291 There are, however, two cases where a circumflex is not required for the
6292 recognition of a regular expression: these are the &%match%& condition in a
6293 string expansion, and the &%matches%& condition in an Exim filter file. In
6294 these cases, the relevant string is always treated as a regular expression; if
6295 it does not start with a circumflex, the expression is not anchored, and can
6296 match anywhere in the subject string.
6297
6298 In all cases, if you want a regular expression to match at the end of a string,
6299 you must code the $ metacharacter to indicate this. For example:
6300 .code
6301 domains = ^\\d{3}\\.example
6302 .endd
6303 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6304 You need to use:
6305 .code
6306 domains = ^\\d{3}\\.example\$
6307 .endd
6308 if you want &'example'& to be the top-level domain. The backslash before the
6309 $ is needed because string expansion also interprets dollar characters.
6310
6311
6312
6313 . ////////////////////////////////////////////////////////////////////////////
6314 . ////////////////////////////////////////////////////////////////////////////
6315
6316 .chapter "File and database lookups" "CHAPfdlookup"
6317 .scindex IIDfidalo1 "file" "lookups"
6318 .scindex IIDfidalo2 "database" "lookups"
6319 .cindex "lookup" "description of"
6320 Exim can be configured to look up data in files or databases as it processes
6321 messages. Two different kinds of syntax are used:
6322
6323 .olist
6324 A string that is to be expanded may contain explicit lookup requests. These
6325 cause parts of the string to be replaced by data that is obtained from the
6326 lookup. Lookups of this type are conditional expansion items. Different results
6327 can be defined for the cases of lookup success and failure. See chapter
6328 &<<CHAPexpand>>&, where string expansions are described in detail.
6329 The key for the lookup is specified as part of the string expansion.
6330 .next
6331 Lists of domains, hosts, and email addresses can contain lookup requests as a
6332 way of avoiding excessively long linear lists. In this case, the data that is
6333 returned by the lookup is often (but not always) discarded; whether the lookup
6334 succeeds or fails is what really counts. These kinds of list are described in
6335 chapter &<<CHAPdomhosaddlists>>&.
6336 The key for the lookup is given by the context in which the list is expanded.
6337 .endlist
6338
6339 String expansions, lists, and lookups interact with each other in such a way
6340 that there is no order in which to describe any one of them that does not
6341 involve references to the others. Each of these three chapters makes more sense
6342 if you have read the other two first. If you are reading this for the first
6343 time, be aware that some of it will make a lot more sense after you have read
6344 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6345
6346 .section "Examples of different lookup syntax" "SECID60"
6347 It is easy to confuse the two different kinds of lookup, especially as the
6348 lists that may contain the second kind are always expanded before being
6349 processed as lists. Therefore, they may also contain lookups of the first kind.
6350 Be careful to distinguish between the following two examples:
6351 .code
6352 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6353 domains = lsearch;/some/file
6354 .endd
6355 The first uses a string expansion, the result of which must be a domain list.
6356 No strings have been specified for a successful or a failing lookup; the
6357 defaults in this case are the looked-up data and an empty string, respectively.
6358 The expansion takes place before the string is processed as a list, and the
6359 file that is searched could contain lines like this:
6360 .code
6361 192.168.3.4: domain1:domain2:...
6362 192.168.1.9: domain3:domain4:...
6363 .endd
6364 When the lookup succeeds, the result of the expansion is a list of domains (and
6365 possibly other types of item that are allowed in domain lists).
6366
6367 In the second example, the lookup is a single item in a domain list. It causes
6368 Exim to use a lookup to see if the domain that is being processed can be found
6369 in the file. The file could contains lines like this:
6370 .code
6371 domain1:
6372 domain2:
6373 .endd
6374 Any data that follows the keys is not relevant when checking that the domain
6375 matches the list item.
6376
6377 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6378 Consider a file containing lines like this:
6379 .code
6380 192.168.5.6: lsearch;/another/file
6381 .endd
6382 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6383 first &%domains%& setting above generates the second setting, which therefore
6384 causes a second lookup to occur.
6385
6386 The rest of this chapter describes the different lookup types that are
6387 available. Any of them can be used in any part of the configuration where a
6388 lookup is permitted.
6389
6390
6391 .section "Lookup types" "SECID61"
6392 .cindex "lookup" "types of"
6393 .cindex "single-key lookup" "definition of"
6394 Two different types of data lookup are implemented:
6395
6396 .ilist
6397 The &'single-key'& type requires the specification of a file in which to look,
6398 and a single key to search for. The key must be a non-empty string for the
6399 lookup to succeed. The lookup type determines how the file is searched.
6400 .next
6401 .cindex "query-style lookup" "definition of"
6402 The &'query-style'& type accepts a generalized database query. No particular
6403 key value is assumed by Exim for query-style lookups. You can use whichever
6404 Exim variables you need to construct the database query.
6405 .endlist
6406
6407 The code for each lookup type is in a separate source file that is included in
6408 the binary of Exim only if the corresponding compile-time option is set. The
6409 default settings in &_src/EDITME_& are:
6410 .code
6411 LOOKUP_DBM=yes
6412 LOOKUP_LSEARCH=yes
6413 .endd
6414 which means that only linear searching and DBM lookups are included by default.
6415 For some types of lookup (e.g. SQL databases), you need to install appropriate
6416 libraries and header files before building Exim.
6417
6418
6419
6420
6421 .section "Single-key lookup types" "SECTsinglekeylookups"
6422 .cindex "lookup" "single-key types"
6423 .cindex "single-key lookup" "list of types"
6424 The following single-key lookup types are implemented:
6425
6426 .ilist
6427 .cindex "cdb" "description of"
6428 .cindex "lookup" "cdb"
6429 .cindex "binary zero" "in lookup key"
6430 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6431 string without a terminating binary zero. The cdb format is designed for
6432 indexed files that are read frequently and never updated, except by total
6433 re-creation. As such, it is particularly suitable for large files containing
6434 aliases or other indexed data referenced by an MTA. Information about cdb can
6435 be found in several places:
6436 .display
6437 &url(http://www.pobox.com/~djb/cdb.html)
6438 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6439 &url(http://packages.debian.org/stable/utils/freecdb.html)
6440 .endd
6441 A cdb distribution is not needed in order to build Exim with cdb support,
6442 because the code for reading cdb files is included directly in Exim itself.
6443 However, no means of building or testing cdb files is provided with Exim, so
6444 you need to obtain a cdb distribution in order to do this.
6445 .next
6446 .cindex "DBM" "lookup type"
6447 .cindex "lookup" "dbm"
6448 .cindex "binary zero" "in lookup key"
6449 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6450 DBM file by looking up the record with the given key. A terminating binary
6451 zero is included in the key that is passed to the DBM library. See section
6452 &<<SECTdb>>& for a discussion of DBM libraries.
6453
6454 .cindex "Berkeley DB library" "file format"
6455 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6456 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6457 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6458 the DB_UNKNOWN option. This enables it to handle any of the types of database
6459 that the library supports, and can be useful for accessing DBM files created by
6460 other applications. (For earlier DB versions, DB_HASH is always used.)
6461 .next
6462 .cindex "lookup" "dbmjz"
6463 .cindex "lookup" "dbm &-- embedded NULs"
6464 .cindex "sasldb2"
6465 .cindex "dbmjz lookup type"
6466 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6467 interpreted as an Exim list; the elements of the list are joined together with
6468 ASCII NUL characters to form the lookup key.  An example usage would be to
6469 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6470 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6471 &(cram_md5)& authenticator.
6472 .next
6473 .cindex "lookup" "dbmnz"
6474 .cindex "lookup" "dbm &-- terminating zero"
6475 .cindex "binary zero" "in lookup key"
6476 .cindex "Courier"
6477 .cindex "&_/etc/userdbshadow.dat_&"
6478 .cindex "dbmnz lookup type"
6479 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6480 is not included in the key that is passed to the DBM library. You may need this
6481 if you want to look up data in files that are created by or shared with some
6482 other application that does not use terminating zeros. For example, you need to
6483 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6484 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6485 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6486 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6487 .next
6488 .cindex "lookup" "dsearch"
6489 .cindex "dsearch lookup type"
6490 &(dsearch)&: The given file must be a directory; this is searched for an entry
6491 whose name is the key by calling the &[lstat()]& function. The key may not
6492 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6493 the lookup is the name of the entry, which may be a file, directory,
6494 symbolic link, or any other kind of directory entry. An example of how this
6495 lookup can be used to support virtual domains is given in section
6496 &<<SECTvirtualdomains>>&.
6497 .next
6498 .cindex "lookup" "iplsearch"
6499 .cindex "iplsearch lookup type"
6500 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6501 terminated by a colon or white space or the end of the line. The keys in the
6502 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6503 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6504 being interpreted as a key terminator. For example:
6505 .code
6506 1.2.3.4:           data for 1.2.3.4
6507 192.168.0.0/16:    data for 192.168.0.0/16
6508 "abcd::cdab":      data for abcd::cdab
6509 "abcd:abcd::/32"   data for abcd:abcd::/32
6510 .endd
6511 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6512 file is searched linearly, using the CIDR masks where present, until a matching
6513 key is found. The first key that matches is used; there is no attempt to find a
6514 &"best"& match. Apart from the way the keys are matched, the processing for
6515 &(iplsearch)& is the same as for &(lsearch)&.
6516
6517 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6518 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6519 lookup types support only literal keys.
6520
6521 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6522 the implicit key is the host's IP address rather than its name (see section
6523 &<<SECThoslispatsikey>>&).
6524 .next
6525 .cindex "linear search"
6526 .cindex "lookup" "lsearch"
6527 .cindex "lsearch lookup type"
6528 .cindex "case sensitivity" "in lsearch lookup"
6529 &(lsearch)&: The given file is a text file that is searched linearly for a
6530 line beginning with the search key, terminated by a colon or white space or the
6531 end of the line. The search is case-insensitive; that is, upper and lower case
6532 letters are treated as the same. The first occurrence of the key that is found
6533 in the file is used.
6534
6535 White space between the key and the colon is permitted. The remainder of the
6536 line, with leading and trailing white space removed, is the data. This can be
6537 continued onto subsequent lines by starting them with any amount of white
6538 space, but only a single space character is included in the data at such a
6539 junction. If the data begins with a colon, the key must be terminated by a
6540 colon, for example:
6541 .code
6542 baduser:  :fail:
6543 .endd
6544 Empty lines and lines beginning with # are ignored, even if they occur in the
6545 middle of an item. This is the traditional textual format of alias files. Note
6546 that the keys in an &(lsearch)& file are literal strings. There is no
6547 wildcarding of any kind.
6548
6549 .cindex "lookup" "lsearch &-- colons in keys"
6550 .cindex "white space" "in lsearch key"
6551 In most &(lsearch)& files, keys are not required to contain colons or #
6552 characters, or white space. However, if you need this feature, it is available.
6553 If a key begins with a doublequote character, it is terminated only by a
6554 matching quote (or end of line), and the normal escaping rules apply to its
6555 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6556 quoted keys (exactly as for unquoted keys). There is no special handling of
6557 quotes for the data part of an &(lsearch)& line.
6558
6559 .next
6560 .cindex "NIS lookup type"
6561 .cindex "lookup" "NIS"
6562 .cindex "binary zero" "in lookup key"
6563 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6564 the given key, without a terminating binary zero. There is a variant called
6565 &(nis0)& which does include the terminating binary zero in the key. This is
6566 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6567 aliases; the full map names must be used.
6568
6569 .next
6570 .cindex "wildlsearch lookup type"
6571 .cindex "lookup" "wildlsearch"
6572 .cindex "nwildlsearch lookup type"
6573 .cindex "lookup" "nwildlsearch"
6574 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6575 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6576 the file may be wildcarded. The difference between these two lookup types is
6577 that for &(wildlsearch)&, each key in the file is string-expanded before being
6578 used, whereas for &(nwildlsearch)&, no expansion takes place.
6579
6580 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6581 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6582 file that are regular expressions can be made case-sensitive by the use of
6583 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6584
6585 . ==== As this is a nested list, any displays it contains must be indented
6586 . ==== as otherwise they are too far to the left.
6587
6588 .olist
6589 The string may begin with an asterisk to mean &"ends with"&. For example:
6590 .code
6591     *.a.b.c       data for anything.a.b.c
6592     *fish         data for anythingfish
6593 .endd
6594 .next
6595 The string may begin with a circumflex to indicate a regular expression. For
6596 example, for &(wildlsearch)&:
6597 .code
6598     ^\N\d+\.a\.b\N    data for <digits>.a.b
6599 .endd
6600 Note the use of &`\N`& to disable expansion of the contents of the regular
6601 expression. If you are using &(nwildlsearch)&, where the keys are not
6602 string-expanded, the equivalent entry is:
6603 .code
6604     ^\d+\.a\.b        data for <digits>.a.b
6605 .endd
6606 The case-insensitive flag is set at the start of compiling the regular
6607 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6608 For example, to make the entire pattern case-sensitive:
6609 .code
6610     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6611 .endd
6612
6613 If the regular expression contains white space or colon characters, you must
6614 either quote it (see &(lsearch)& above), or represent these characters in other
6615 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6616 colon. This may be easier than quoting, because if you quote, you have to
6617 escape all the backslashes inside the quotes.
6618
6619 &*Note*&: It is not possible to capture substrings in a regular expression
6620 match for later use, because the results of all lookups are cached. If a lookup
6621 is repeated, the result is taken from the cache, and no actual pattern matching
6622 takes place. The values of all the numeric variables are unset after a
6623 &((n)wildlsearch)& match.
6624
6625 .next
6626 Although I cannot see it being of much use, the general matching function that
6627 is used to implement &((n)wildlsearch)& means that the string may begin with a
6628 lookup name terminated by a semicolon, and followed by lookup data. For
6629 example:
6630 .code
6631     cdb;/some/file  data for keys that match the file
6632 .endd
6633 The data that is obtained from the nested lookup is discarded.
6634 .endlist olist
6635
6636 Keys that do not match any of these patterns are interpreted literally. The
6637 continuation rules for the data are the same as for &(lsearch)&, and keys may
6638 be followed by optional colons.
6639
6640 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6641 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6642 lookup types support only literal keys.
6643 .endlist ilist
6644
6645
6646 .section "Query-style lookup types" "SECTquerystylelookups"
6647 .cindex "lookup" "query-style types"
6648 .cindex "query-style lookup" "list of types"
6649 The supported query-style lookup types are listed below. Further details about
6650 many of them are given in later sections.
6651
6652 .ilist
6653 .cindex "DNS" "as a lookup type"
6654 .cindex "lookup" "DNS"
6655 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6656 are given in the supplied query. The resulting data is the contents of the
6657 records. See section &<<SECTdnsdb>>&.
6658 .next
6659 .cindex "InterBase lookup type"
6660 .cindex "lookup" "InterBase"
6661 &(ibase)&: This does a lookup in an InterBase database.
6662 .next
6663 .cindex "LDAP" "lookup type"
6664 .cindex "lookup" "LDAP"
6665 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6666 returns attributes from a single entry. There is a variant called &(ldapm)&
6667 that permits values from multiple entries to be returned. A third variant
6668 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6669 any attribute values. See section &<<SECTldap>>&.
6670 .next
6671 .cindex "MySQL" "lookup type"
6672 .cindex "lookup" "MySQL"
6673 &(mysql)&: The format of the query is an SQL statement that is passed to a
6674 MySQL database. See section &<<SECTsql>>&.
6675 .next
6676 .cindex "NIS+ lookup type"
6677 .cindex "lookup" "NIS+"
6678 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6679 the field to be returned. See section &<<SECTnisplus>>&.
6680 .next
6681 .cindex "Oracle" "lookup type"
6682 .cindex "lookup" "Oracle"
6683 &(oracle)&: The format of the query is an SQL statement that is passed to an
6684 Oracle database. See section &<<SECTsql>>&.
6685 .next
6686 .cindex "lookup" "passwd"
6687 .cindex "passwd lookup type"
6688 .cindex "&_/etc/passwd_&"
6689 &(passwd)& is a query-style lookup with queries that are just user names. The
6690 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6691 success, the result string is the same as you would get from an &(lsearch)&
6692 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6693 password value. For example:
6694 .code
6695 *:42:42:King Rat:/home/kr:/bin/bash
6696 .endd
6697 .next
6698 .cindex "PostgreSQL lookup type"
6699 .cindex "lookup" "PostgreSQL"
6700 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6701 PostgreSQL database. See section &<<SECTsql>>&.
6702
6703 .next
6704 .cindex "Redis lookup type"
6705 .cindex lookup Redis
6706 &(redis)&: The format of the query is an SQL statement that is passed to a
6707 Redis database. See section &<<SECTsql>>&.
6708
6709 .next
6710 .cindex "sqlite lookup type"
6711 .cindex "lookup" "sqlite"
6712 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6713 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6714
6715 .next
6716 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6717 not likely to be useful in normal operation.
6718 .next
6719 .cindex "whoson lookup type"
6720 .cindex "lookup" "whoson"
6721 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6722 allows a server to check whether a particular (dynamically allocated) IP
6723 address is currently allocated to a known (trusted) user and, optionally, to
6724 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6725 at one time for &"POP before SMTP"& authentication, but that approach has been
6726 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6727 &"POP before SMTP"& checking using ACL statements such as
6728 .code
6729 require condition = \
6730   ${lookup whoson {$sender_host_address}{yes}{no}}
6731 .endd
6732 The query consists of a single IP address. The value returned is the name of
6733 the authenticated user, which is stored in the variable &$value$&. However, in
6734 this example, the data in &$value$& is not used; the result of the lookup is
6735 one of the fixed strings &"yes"& or &"no"&.
6736 .endlist
6737
6738
6739
6740 .section "Temporary errors in lookups" "SECID63"
6741 .cindex "lookup" "temporary error in"
6742 Lookup functions can return temporary error codes if the lookup cannot be
6743 completed. For example, an SQL or LDAP database might be unavailable. For this
6744 reason, it is not advisable to use a lookup that might do this for critical
6745 options such as a list of local domains.
6746
6747 When a lookup cannot be completed in a router or transport, delivery
6748 of the message (to the relevant address) is deferred, as for any other
6749 temporary error. In other circumstances Exim may assume the lookup has failed,
6750 or may give up altogether.
6751
6752
6753
6754 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6755 .cindex "wildcard lookups"
6756 .cindex "lookup" "default values"
6757 .cindex "lookup" "wildcard"
6758 .cindex "lookup" "* added to type"
6759 .cindex "default" "in single-key lookups"
6760 In this context, a &"default value"& is a value specified by the administrator
6761 that is to be used if a lookup fails.
6762
6763 &*Note:*& This section applies only to single-key lookups. For query-style
6764 lookups, the facilities of the query language must be used. An attempt to
6765 specify a default for a query-style lookup provokes an error.
6766
6767 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6768 and the initial lookup fails, the key &"*"& is looked up in the file to
6769 provide a default value. See also the section on partial matching below.
6770
6771 .cindex "*@ with single-key lookup"
6772 .cindex "lookup" "*@ added to type"
6773 .cindex "alias file" "per-domain default"
6774 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6775 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6776 character, a second lookup is done with everything before the last @ replaced
6777 by *. This makes it possible to provide per-domain defaults in alias files
6778 that include the domains in the keys. If the second lookup fails (or doesn't
6779 take place because there is no @ in the key), &"*"& is looked up.
6780 For example, a &(redirect)& router might contain:
6781 .code
6782 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6783 .endd
6784 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6785 looks up these keys, in this order:
6786 .code
6787 jane@eyre.example
6788 *@eyre.example
6789 *
6790 .endd
6791 The data is taken from whichever key it finds first. &*Note*&: In an
6792 &(lsearch)& file, this does not mean the first of these keys in the file. A
6793 complete scan is done for each key, and only if it is not found at all does
6794 Exim move on to try the next key.
6795
6796
6797
6798 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6799 .cindex "partial matching"
6800 .cindex "wildcard lookups"
6801 .cindex "lookup" "partial matching"
6802 .cindex "lookup" "wildcard"
6803 .cindex "asterisk" "in search type"
6804 The normal operation of a single-key lookup is to search the file for an exact
6805 match with the given key. However, in a number of situations where domains are
6806 being looked up, it is useful to be able to do partial matching. In this case,
6807 information in the file that has a key starting with &"*."& is matched by any
6808 domain that ends with the components that follow the full stop. For example, if
6809 a key in a DBM file is
6810 .code
6811 *.dates.fict.example
6812 .endd
6813 then when partial matching is enabled this is matched by (amongst others)
6814 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6815 by &'dates.fict.example'&, if that does not appear as a separate key in the
6816 file.
6817
6818 &*Note*&: Partial matching is not available for query-style lookups. It is
6819 also not available for any lookup items in address lists (see section
6820 &<<SECTaddresslist>>&).
6821
6822 Partial matching is implemented by doing a series of separate lookups using
6823 keys constructed by modifying the original subject key. This means that it can
6824 be used with any of the single-key lookup types, provided that
6825 partial matching keys
6826 beginning with a special prefix (default &"*."&) are included in the data file.
6827 Keys in the file that do not begin with the prefix are matched only by
6828 unmodified subject keys when partial matching is in use.
6829
6830 Partial matching is requested by adding the string &"partial-"& to the front of
6831 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6832 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6833 is added at the start of the subject key, and it is looked up again. If that
6834 fails, further lookups are tried with dot-separated components removed from the
6835 start of the subject key, one-by-one, and &"*."& added on the front of what
6836 remains.
6837
6838 A minimum number of two non-* components are required. This can be adjusted
6839 by including a number before the hyphen in the search type. For example,
6840 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6841 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6842 subject key is &'2250.dates.fict.example'& then the following keys are looked
6843 up when the minimum number of non-* components is two:
6844 .code
6845 2250.dates.fict.example
6846 *.2250.dates.fict.example
6847 *.dates.fict.example
6848 *.fict.example
6849 .endd
6850 As soon as one key in the sequence is successfully looked up, the lookup
6851 finishes.
6852
6853 .cindex "lookup" "partial matching &-- changing prefix"
6854 .cindex "prefix" "for partial matching"
6855 The use of &"*."& as the partial matching prefix is a default that can be
6856 changed. The motivation for this feature is to allow Exim to operate with file
6857 formats that are used by other MTAs. A different prefix can be supplied in
6858 parentheses instead of the hyphen after &"partial"&. For example:
6859 .code
6860 domains = partial(.)lsearch;/some/file
6861 .endd
6862 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6863 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6864 components is unchanged). The prefix may consist of any punctuation characters
6865 other than a closing parenthesis. It may be empty, for example:
6866 .code
6867 domains = partial1()cdb;/some/file
6868 .endd
6869 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6870 &`a.b.c`&, &`b.c`&, and &`c`&.
6871
6872 If &"partial0"& is specified, what happens at the end (when the lookup with
6873 just one non-wild component has failed, and the original key is shortened right
6874 down to the null string) depends on the prefix:
6875
6876 .ilist
6877 If the prefix has zero length, the whole lookup fails.
6878 .next
6879 If the prefix has length 1, a lookup for just the prefix is done. For
6880 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6881 .next
6882 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6883 remainder is looked up. With the default prefix, therefore, the final lookup is
6884 for &"*"& on its own.
6885 .next
6886 Otherwise, the whole prefix is looked up.
6887 .endlist
6888
6889
6890 If the search type ends in &"*"& or &"*@"& (see section
6891 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6892 this implies happens after all partial lookups have failed. If &"partial0"& is
6893 specified, adding &"*"& to the search type has no effect with the default
6894 prefix, because the &"*"& key is already included in the sequence of partial
6895 lookups. However, there might be a use for lookup types such as
6896 &"partial0(.)lsearch*"&.
6897
6898 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6899 in domain lists and the like. Partial matching works only in terms of
6900 dot-separated components; a key such as &`*fict.example`&
6901 in a database file is useless, because the asterisk in a partial matching
6902 subject key is always followed by a dot.
6903
6904
6905
6906
6907 .section "Lookup caching" "SECID64"
6908 .cindex "lookup" "caching"
6909 .cindex "caching" "lookup data"
6910 Exim caches all lookup results in order to avoid needless repetition of
6911 lookups. However, because (apart from the daemon) Exim operates as a collection
6912 of independent, short-lived processes, this caching applies only within a
6913 single Exim process. There is no inter-process lookup caching facility.
6914
6915 For single-key lookups, Exim keeps the relevant files open in case there is
6916 another lookup that needs them. In some types of configuration this can lead to
6917 many files being kept open for messages with many recipients. To avoid hitting
6918 the operating system limit on the number of simultaneously open files, Exim
6919 closes the least recently used file when it needs to open more files than its
6920 own internal limit, which can be changed via the &%lookup_open_max%& option.
6921
6922 The single-key lookup files are closed and the lookup caches are flushed at
6923 strategic points during delivery &-- for example, after all routing is
6924 complete.
6925
6926
6927
6928
6929 .section "Quoting lookup data" "SECID65"
6930 .cindex "lookup" "quoting"
6931 .cindex "quoting" "in lookups"
6932 When data from an incoming message is included in a query-style lookup, there
6933 is the possibility of special characters in the data messing up the syntax of
6934 the query. For example, a NIS+ query that contains
6935 .code
6936 [name=$local_part]
6937 .endd
6938 will be broken if the local part happens to contain a closing square bracket.
6939 For NIS+, data can be enclosed in double quotes like this:
6940 .code
6941 [name="$local_part"]
6942 .endd
6943 but this still leaves the problem of a double quote in the data. The rule for
6944 NIS+ is that double quotes must be doubled. Other lookup types have different
6945 rules, and to cope with the differing requirements, an expansion operator
6946 of the following form is provided:
6947 .code
6948 ${quote_<lookup-type>:<string>}
6949 .endd
6950 For example, the safest way to write the NIS+ query is
6951 .code
6952 [name="${quote_nisplus:$local_part}"]
6953 .endd
6954 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6955 operator can be used for all lookup types, but has no effect for single-key
6956 lookups, since no quoting is ever needed in their key strings.
6957
6958
6959
6960
6961 .section "More about dnsdb" "SECTdnsdb"
6962 .cindex "dnsdb lookup"
6963 .cindex "lookup" "dnsdb"
6964 .cindex "DNS" "as a lookup type"
6965 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6966 of a record type and a domain name, separated by an equals sign. For example,
6967 an expansion string could contain:
6968 .code
6969 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6970 .endd
6971 If the lookup succeeds, the result is placed in &$value$&, which in this case
6972 is used on its own as the result. If the lookup does not succeed, the
6973 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6974 &<<SECTforexpfai>>& for an explanation of what this means.
6975
6976 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6977 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6978 If no type is given, TXT is assumed.
6979
6980 For any record type, if multiple records are found, the data is returned as a
6981 concatenation, with newline as the default separator. The order, of course,
6982 depends on the DNS resolver. You can specify a different separator character
6983 between multiple records by putting a right angle-bracket followed immediately
6984 by the new separator at the start of the query. For example:
6985 .code
6986 ${lookup dnsdb{>: a=host1.example}}
6987 .endd
6988 It is permitted to specify a space as the separator character. Further
6989 white space is ignored.
6990 For lookup types that return multiple fields per record,
6991 an alternate field separator can be specified using a comma after the main
6992 separator character, followed immediately by the field separator.
6993
6994 .cindex "PTR record" "in &(dnsdb)& lookup"
6995 When the type is PTR,
6996 the data can be an IP address, written as normal; inversion and the addition of
6997 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6998 .code
6999 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7000 .endd
7001 If the data for a PTR record is not a syntactically valid IP address, it is not
7002 altered and nothing is added.
7003
7004 .cindex "MX record" "in &(dnsdb)& lookup"
7005 .cindex "SRV record" "in &(dnsdb)& lookup"
7006 For an MX lookup, both the preference value and the host name are returned for
7007 each record, separated by a space. For an SRV lookup, the priority, weight,
7008 port, and host name are returned for each record, separated by spaces.
7009 The field separator can be modified as above.
7010
7011 .cindex "TXT record" "in &(dnsdb)& lookup"
7012 .cindex "SPF record" "in &(dnsdb)& lookup"
7013 For TXT records with multiple items of data, only the first item is returned,
7014 unless a field separator is specified.
7015 To concatenate items without a separator, use a semicolon instead.
7016 For SPF records the
7017 default behaviour is to concatenate multiple items without using a separator.
7018 .code
7019 ${lookup dnsdb{>\n,: txt=a.b.example}}
7020 ${lookup dnsdb{>\n; txt=a.b.example}}
7021 ${lookup dnsdb{spf=example.org}}
7022 .endd
7023 It is permitted to specify a space as the separator character. Further
7024 white space is ignored.
7025
7026 .cindex "SOA record" "in &(dnsdb)& lookup"
7027 For an SOA lookup, while no result is obtained the lookup is redone with
7028 successively more leading components dropped from the given domain.
7029 Only the primary-nameserver field is returned unless a field separator is
7030 specified.
7031 .code
7032 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7033 .endd
7034
7035 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7036 .cindex "dnsdb modifiers"
7037 .cindex "modifiers" "dnsdb"
7038 .cindex "options" "dnsdb"
7039 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7040 each followed by a comma,
7041 that may appear before the record type.
7042
7043 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7044 temporary DNS error for any of them, the behaviour is controlled by
7045 a defer-option modifier.
7046 The possible keywords are
7047 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7048 With &"strict"& behaviour, any temporary DNS error causes the
7049 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7050 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7051 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7052 error causes the whole lookup to defer only if none of the other lookups
7053 succeed. The default is &"lax"&, so the following lookups are equivalent:
7054 .code
7055 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7056 ${lookup dnsdb{a=one.host.com:two.host.com}}
7057 .endd
7058 Thus, in the default case, as long as at least one of the DNS lookups
7059 yields some data, the lookup succeeds.
7060
7061 .cindex "DNSSEC" "dns lookup"
7062 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7063 The possible keywords are
7064 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7065 With &"strict"& or &"lax"& DNSSEC information is requested
7066 with the lookup.
7067 With &"strict"& a response from the DNS resolver that
7068 is not labelled as authenticated data
7069 is treated as equivalent to a temporary DNS error.
7070 The default is &"never"&.
7071
7072 See also the &$lookup_dnssec_authenticated$& variable.
7073
7074 .cindex timeout "dns lookup"
7075 .cindex "DNS" timeout
7076 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7077 The form is &"retrans_VAL"& where VAL is an Exim time specification
7078 (e.g. &"5s"&).
7079 The default value is set by the main configuration option &%dns_retrans%&.
7080
7081 Retries for the dnsdb lookup can be controlled by a retry modifier.
7082 The form if &"retry_VAL"& where VAL is an integer.
7083 The default count is set by the main configuration option &%dns_retry%&.
7084
7085 .cindex cacheing "of dns lookup"
7086 .cindex TTL "of dns lookup"
7087 .cindex DNS TTL
7088 Dnsdb lookup results are cached within a single process (and its children).
7089 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7090 value of the set of returned DNS records.
7091
7092
7093 .section "Pseudo dnsdb record types" "SECID66"
7094 .cindex "MX record" "in &(dnsdb)& lookup"
7095 By default, both the preference value and the host name are returned for
7096 each MX record, separated by a space. If you want only host names, you can use
7097 the pseudo-type MXH:
7098 .code
7099 ${lookup dnsdb{mxh=a.b.example}}
7100 .endd
7101 In this case, the preference values are omitted, and just the host names are
7102 returned.
7103
7104 .cindex "name server for enclosing domain"
7105 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7106 records on the given domain, but if none are found, it removes the first
7107 component of the domain name, and tries again. This process continues until NS
7108 records are found or there are no more components left (or there is a DNS
7109 error). In other words, it may return the name servers for a top-level domain,
7110 but it never returns the root name servers. If there are no NS records for the
7111 top-level domain, the lookup fails. Consider these examples:
7112 .code
7113 ${lookup dnsdb{zns=xxx.quercite.com}}
7114 ${lookup dnsdb{zns=xxx.edu}}
7115 .endd
7116 Assuming that in each case there are no NS records for the full domain name,
7117 the first returns the name servers for &%quercite.com%&, and the second returns
7118 the name servers for &%edu%&.
7119
7120 You should be careful about how you use this lookup because, unless the
7121 top-level domain does not exist, the lookup always returns some host names. The
7122 sort of use to which this might be put is for seeing if the name servers for a
7123 given domain are on a blacklist. You can probably assume that the name servers
7124 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7125 such a list.
7126
7127 .cindex "CSA" "in &(dnsdb)& lookup"
7128 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7129 records according to the CSA rules, which are described in section
7130 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7131 not sufficient because of the extra parent domain search behaviour of CSA. The
7132 result of a successful lookup such as:
7133 .code
7134 ${lookup dnsdb {csa=$sender_helo_name}}
7135 .endd
7136 has two space-separated fields: an authorization code and a target host name.
7137 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7138 authorization required but absent, or &"?"& for unknown.
7139
7140 .cindex "A+" "in &(dnsdb)& lookup"
7141 The pseudo-type A+ performs an AAAA
7142 and then an A lookup.  All results are returned; defer processing
7143 (see below) is handled separately for each lookup.  Example:
7144 .code
7145 ${lookup dnsdb {>; a+=$sender_helo_name}}
7146 .endd
7147
7148
7149 .section "Multiple dnsdb lookups" "SECID67"
7150 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7151 However, you can specify a list of domains or IP addresses in a single
7152 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7153 the default separator, but with the ability to change this. For example:
7154 .code
7155 ${lookup dnsdb{one.domain.com:two.domain.com}}
7156 ${lookup dnsdb{a=one.host.com:two.host.com}}
7157 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7158 .endd
7159 In order to retain backwards compatibility, there is one special case: if
7160 the lookup type is PTR and no change of separator is specified, Exim looks
7161 to see if the rest of the string is precisely one IPv6 address. In this
7162 case, it does not treat it as a list.
7163
7164 The data from each lookup is concatenated, with newline separators by default,
7165 in the same way that multiple DNS records for a single item are handled. A
7166 different separator can be specified, as described above.
7167
7168
7169
7170
7171 .section "More about LDAP" "SECTldap"
7172 .cindex "LDAP" "lookup, more about"
7173 .cindex "lookup" "LDAP"
7174 .cindex "Solaris" "LDAP"
7175 The original LDAP implementation came from the University of Michigan; this has
7176 become &"Open LDAP"&, and there are now two different releases. Another
7177 implementation comes from Netscape, and Solaris 7 and subsequent releases
7178 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7179 the lookup function level, their error handling is different. For this reason
7180 it is necessary to set a compile-time variable when building Exim with LDAP, to
7181 indicate which LDAP library is in use. One of the following should appear in
7182 your &_Local/Makefile_&:
7183 .code
7184 LDAP_LIB_TYPE=UMICHIGAN
7185 LDAP_LIB_TYPE=OPENLDAP1
7186 LDAP_LIB_TYPE=OPENLDAP2
7187 LDAP_LIB_TYPE=NETSCAPE
7188 LDAP_LIB_TYPE=SOLARIS
7189 .endd
7190 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7191 same interface as the University of Michigan version.
7192
7193 There are three LDAP lookup types in Exim. These behave slightly differently in
7194 the way they handle the results of a query:
7195
7196 .ilist
7197 &(ldap)& requires the result to contain just one entry; if there are more, it
7198 gives an error.
7199 .next
7200 &(ldapdn)& also requires the result to contain just one entry, but it is the
7201 Distinguished Name that is returned rather than any attribute values.
7202 .next
7203 &(ldapm)& permits the result to contain more than one entry; the attributes
7204 from all of them are returned.
7205 .endlist
7206
7207
7208 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7209 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7210 the data returned by a successful lookup is described in the next section.
7211 First we explain how LDAP queries are coded.
7212
7213
7214 .section "Format of LDAP queries" "SECTforldaque"
7215 .cindex "LDAP" "query format"
7216 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7217 the configuration of a &(redirect)& router one might have this setting:
7218 .code
7219 data = ${lookup ldap \
7220   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7221   c=UK?mailbox?base?}}
7222 .endd
7223 .cindex "LDAP" "with TLS"
7224 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7225 secure (encrypted) LDAP connections. The second of these ensures that an
7226 encrypted TLS connection is used.
7227
7228 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7229 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7230 See the &%ldap_start_tls%& option.
7231
7232 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7233 controlled. Every part of the TLS configuration can be configured by settings in
7234 &_exim.conf_&. Depending on the version of the client libraries installed on
7235 your system, some of the initialization may have required setting options in
7236 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7237 certificates. This revealed a nuance where the current UID that exim was
7238 running as could affect which config files it read. With Exim 4.83, these
7239 methods become optional, only taking effect if not specifically set in
7240 &_exim.conf_&.
7241
7242
7243 .section "LDAP quoting" "SECID68"
7244 .cindex "LDAP" "quoting"
7245 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7246 and the second because the LDAP query is represented as a URL. Furthermore,
7247 within an LDAP query, two different kinds of quoting are required. For this
7248 reason, there are two different LDAP-specific quoting operators.
7249
7250 The &%quote_ldap%& operator is designed for use on strings that are part of
7251 filter specifications. Conceptually, it first does the following conversions on
7252 the string:
7253 .code
7254 *   =>   \2A
7255 (   =>   \28
7256 )   =>   \29
7257 \   =>   \5C
7258 .endd
7259 in accordance with RFC 2254. The resulting string is then quoted according
7260 to the rules for URLs, that is, all non-alphanumeric characters except
7261 .code
7262 ! $ ' - . _ ( ) * +
7263 .endd
7264 are converted to their hex values, preceded by a percent sign. For example:
7265 .code
7266 ${quote_ldap: a(bc)*, a<yz>; }
7267 .endd
7268 yields
7269 .code
7270 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7271 .endd
7272 Removing the URL quoting, this is (with a leading and a trailing space):
7273 .code
7274 a\28bc\29\2A, a<yz>;
7275 .endd
7276 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7277 base DN specifications in queries. Conceptually, it first converts the string
7278 by inserting a backslash in front of any of the following characters:
7279 .code
7280 , + " \ < > ;
7281 .endd
7282 It also inserts a backslash before any leading spaces or # characters, and
7283 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7284 is then quoted according to the rules for URLs. For example:
7285 .code
7286 ${quote_ldap_dn: a(bc)*, a<yz>; }
7287 .endd
7288 yields
7289 .code
7290 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7291 .endd
7292 Removing the URL quoting, this is (with a trailing space):
7293 .code
7294 \ a(bc)*\, a\<yz\>\;\
7295 .endd
7296 There are some further comments about quoting in the section on LDAP
7297 authentication below.
7298
7299
7300 .section "LDAP connections" "SECID69"
7301 .cindex "LDAP" "connections"
7302 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7303 is in use, via a Unix domain socket. The example given above does not specify
7304 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7305 by starting it with
7306 .code
7307 ldap://<hostname>:<port>/...
7308 .endd
7309 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7310 used. When no server is specified in a query, a list of default servers is
7311 taken from the &%ldap_default_servers%& configuration option. This supplies a
7312 colon-separated list of servers which are tried in turn until one successfully
7313 handles a query, or there is a serious error. Successful handling either
7314 returns the requested data, or indicates that it does not exist. Serious errors
7315 are syntactical, or multiple values when only a single value is expected.
7316 Errors which cause the next server to be tried are connection failures, bind
7317 failures, and timeouts.
7318
7319 For each server name in the list, a port number can be given. The standard way
7320 of specifying a host and port is to use a colon separator (RFC 1738). Because
7321 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7322 doubled. For example
7323 .code
7324 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7325 .endd
7326 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7327 to the LDAP library with no server name, and the library's default (normally
7328 the local host) is used.
7329
7330 If you are using the OpenLDAP library, you can connect to an LDAP server using
7331 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7332 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7333 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7334 not available.
7335
7336 For this type of connection, instead of a host name for the server, a pathname
7337 for the socket is required, and the port number is not relevant. The pathname
7338 can be specified either as an item in &%ldap_default_servers%&, or inline in
7339 the query. In the former case, you can have settings such as
7340 .code
7341 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7342 .endd
7343 When the pathname is given in the query, you have to escape the slashes as
7344 &`%2F`& to fit in with the LDAP URL syntax. For example:
7345 .code
7346 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7347 .endd
7348 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7349 a pathname, it uses the Unix domain socket code, even if the query actually
7350 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7351 socket connection. This behaviour means that you can use a setting of
7352 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7353 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7354 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7355 backup host.
7356
7357 If an explicit &`ldapi`& type is given in a query when a host name is
7358 specified, an error is diagnosed. However, if there are more items in
7359 &%ldap_default_servers%&, they are tried. In other words:
7360
7361 .ilist
7362 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7363 interface.
7364 .next
7365 Using &`ldapi`& with a host name causes an error.
7366 .endlist
7367
7368
7369 Using &`ldapi`& with no host or path in the query, and no setting of
7370 &%ldap_default_servers%&, does whatever the library does by default.
7371
7372
7373
7374 .section "LDAP authentication and control information" "SECID70"
7375 .cindex "LDAP" "authentication"
7376 The LDAP URL syntax provides no way of passing authentication and other control
7377 information to the server. To make this possible, the URL in an LDAP query may
7378 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7379 spaces. If a value contains spaces it must be enclosed in double quotes, and
7380 when double quotes are used, backslash is interpreted in the usual way inside
7381 them. The following names are recognized:
7382 .display
7383 &`DEREFERENCE`&  set the dereferencing parameter
7384 &`NETTIME    `&  set a timeout for a network operation
7385 &`USER       `&  set the DN, for authenticating the LDAP bind
7386 &`PASS       `&  set the password, likewise
7387 &`REFERRALS  `&  set the referrals parameter
7388 &`SERVERS    `&  set alternate server list for this query only
7389 &`SIZE       `&  set the limit for the number of entries returned
7390 &`TIME       `&  set the maximum waiting time for a query
7391 .endd
7392 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7393 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7394 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7395 library from trying to follow referrals issued by the LDAP server.
7396
7397 .cindex LDAP timeout
7398 .cindex timeout "LDAP lookup"
7399 The name CONNECT is an obsolete name for NETTIME, retained for
7400 backwards compatibility. This timeout (specified as a number of seconds) is
7401 enforced from the client end for operations that can be carried out over a
7402 network. Specifically, it applies to network connections and calls to the
7403 &'ldap_result()'& function. If the value is greater than zero, it is used if
7404 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7405 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7406 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7407 Netscape SDK; for OpenLDAP no action is taken.
7408
7409 The TIME parameter (also a number of seconds) is passed to the server to
7410 set a server-side limit on the time taken to complete a search.
7411
7412 The SERVERS parameter allows you to specify an alternate list of ldap servers
7413 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7414 default list of ldap servers, and a single lookup can specify a single ldap
7415 server to use.  But when you need to do a lookup with a list of servers that is
7416 different than the default list (maybe different order, maybe a completely
7417 different set of servers), the SERVERS parameter allows you to specify this
7418 alternate list (colon-separated).
7419
7420 Here is an example of an LDAP query in an Exim lookup that uses some of these
7421 values. This is a single line, folded to fit on the page:
7422 .code
7423 ${lookup ldap
7424   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7425   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7426   {$value}fail}
7427 .endd
7428 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7429 any of the auxiliary data. Exim configuration settings that include lookups
7430 which contain password information should be preceded by &"hide"& to prevent
7431 non-admin users from using the &%-bP%& option to see their values.
7432
7433 The auxiliary data items may be given in any order. The default is no
7434 connection timeout (the system timeout is used), no user or password, no limit
7435 on the number of entries returned, and no time limit on queries.
7436
7437 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7438 removes any URL quoting that it may contain before passing it LDAP. Apparently
7439 some libraries do this for themselves, but some do not. Removing the URL
7440 quoting has two advantages:
7441
7442 .ilist
7443 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7444 DNs as with DNs inside actual queries.
7445 .next
7446 It permits spaces inside USER= DNs.
7447 .endlist
7448
7449 For example, a setting such as
7450 .code
7451 USER=cn=${quote_ldap_dn:$1}
7452 .endd
7453 should work even if &$1$& contains spaces.
7454
7455 Expanded data for the PASS= value should be quoted using the &%quote%&
7456 expansion operator, rather than the LDAP quote operators. The only reason this
7457 field needs quoting is to ensure that it conforms to the Exim syntax, which
7458 does not allow unquoted spaces. For example:
7459 .code
7460 PASS=${quote:$3}
7461 .endd
7462 The LDAP authentication mechanism can be used to check passwords as part of
7463 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7464 &<<CHAPexpand>>&.
7465
7466
7467
7468 .section "Format of data returned by LDAP" "SECID71"
7469 .cindex "LDAP" "returned data formats"
7470 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7471 as a sequence of values, for example
7472 .code
7473 cn=manager,o=University of Cambridge,c=UK
7474 .endd
7475 The &(ldap)& lookup type generates an error if more than one entry matches the
7476 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7477 the result between the data from different entries. It is possible for multiple
7478 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7479 you know that whatever values are returned all came from a single entry in the
7480 directory.
7481
7482 In the common case where you specify a single attribute in your LDAP query, the
7483 result is not quoted, and does not contain the attribute name. If the attribute
7484 has multiple values, they are separated by commas. Any comma that is
7485 part of an attribute's value is doubled.
7486
7487 If you specify multiple attributes, the result contains space-separated, quoted
7488 strings, each preceded by the attribute name and an equals sign. Within the
7489 quotes, the quote character, backslash, and newline are escaped with
7490 backslashes, and commas are used to separate multiple values for the attribute.
7491 Any commas in attribute values are doubled
7492 (permitting treatment of the values as a comma-separated list).
7493 Apart from the escaping, the string within quotes takes the same form as the
7494 output when a single attribute is requested. Specifying no attributes is the
7495 same as specifying all of an entry's attributes.
7496
7497 Here are some examples of the output format. The first line of each pair is an
7498 LDAP query, and the second is the data that is returned. The attribute called
7499 &%attr1%& has two values, one of them with an embedded comma, whereas
7500 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7501 (they have SUP &%attr%& in their schema definitions).
7502
7503 .code
7504 ldap:///o=base?attr1?sub?(uid=fred)
7505 value1.1,value1,,2
7506
7507 ldap:///o=base?attr2?sub?(uid=fred)
7508 value two
7509
7510 ldap:///o=base?attr?sub?(uid=fred)
7511 value1.1,value1,,2,value two
7512
7513 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7514 attr1="value1.1,value1,,2" attr2="value two"
7515
7516 ldap:///o=base??sub?(uid=fred)
7517 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7518 .endd
7519 You can
7520 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7521 results of LDAP lookups.
7522 The &%extract%& operator in string expansions can be used to pick out
7523 individual fields from data that consists of &'key'&=&'value'& pairs.
7524 The &%listextract%& operator should be used to pick out individual values
7525 of attributes, even when only a single value is expected.
7526 The doubling of embedded commas allows you to use the returned data as a
7527 comma separated list (using the "<," syntax for changing the input list separator).
7528
7529
7530
7531
7532 .section "More about NIS+" "SECTnisplus"
7533 .cindex "NIS+ lookup type"
7534 .cindex "lookup" "NIS+"
7535 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7536 and field name. If this is given, the result of a successful query is the
7537 contents of the named field; otherwise the result consists of a concatenation
7538 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7539 values containing spaces are quoted. For example, the query
7540 .code
7541 [name=mg1456],passwd.org_dir
7542 .endd
7543 might return the string
7544 .code
7545 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7546 home=/home/mg1456 shell=/bin/bash shadow=""
7547 .endd
7548 (split over two lines here to fit on the page), whereas
7549 .code
7550 [name=mg1456],passwd.org_dir:gcos
7551 .endd
7552 would just return
7553 .code
7554 Martin Guerre
7555 .endd
7556 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7557 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7558 operator is to double any quote characters within the text.
7559
7560
7561
7562 .section "SQL lookups" "SECTsql"
7563 .cindex "SQL lookup types"
7564 .cindex "MySQL" "lookup type"
7565 .cindex "PostgreSQL lookup type"
7566 .cindex "lookup" "MySQL"
7567 .cindex "lookup" "PostgreSQL"
7568 .cindex "Oracle" "lookup type"
7569 .cindex "lookup" "Oracle"
7570 .cindex "InterBase lookup type"
7571 .cindex "lookup" "InterBase"
7572 .cindex "Redis lookup type"
7573 .cindex lookup Redis
7574 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7575 and SQLite
7576 databases. Queries for these databases contain SQL statements, so an example
7577 might be
7578 .code
7579 ${lookup mysql{select mailbox from users where id='userx'}\
7580   {$value}fail}
7581 .endd
7582 If the result of the query contains more than one field, the data for each
7583 field in the row is returned, preceded by its name, so the result of
7584 .code
7585 ${lookup pgsql{select home,name from users where id='userx'}\
7586   {$value}}
7587 .endd
7588 might be
7589 .code
7590 home=/home/userx name="Mister X"
7591 .endd
7592 Empty values and values containing spaces are double quoted, with embedded
7593 quotes escaped by a backslash. If the result of the query contains just one
7594 field, the value is passed back verbatim, without a field name, for example:
7595 .code
7596 Mister X
7597 .endd
7598 If the result of the query yields more than one row, it is all concatenated,
7599 with a newline between the data for each row.
7600
7601
7602 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7603 .cindex "MySQL" "lookup type"
7604 .cindex "PostgreSQL lookup type"
7605 .cindex "lookup" "MySQL"
7606 .cindex "lookup" "PostgreSQL"
7607 .cindex "Oracle" "lookup type"
7608 .cindex "lookup" "Oracle"
7609 .cindex "InterBase lookup type"
7610 .cindex "lookup" "InterBase"
7611 .cindex "Redis lookup type"
7612 .cindex lookup Redis
7613 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7614 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7615 or &%redis_servers%&
7616 option (as appropriate) must be set to a colon-separated list of server
7617 information.
7618 (For MySQL and PostgreSQL, the global option need not be set if all
7619 queries contain their own server information &-- see section
7620 &<<SECTspeserque>>&.)
7621 For all but Redis
7622 each item in the list is a slash-separated list of four
7623 items: host name, database name, user name, and password. In the case of
7624 Oracle, the host name field is used for the &"service name"&, and the database
7625 name field is not used and should be empty. For example:
7626 .code
7627 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7628 .endd
7629 Because password data is sensitive, you should always precede the setting with
7630 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7631 option. Here is an example where two MySQL servers are listed:
7632 .code
7633 hide mysql_servers = localhost/users/root/secret:\
7634                      otherhost/users/root/othersecret
7635 .endd
7636 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7637 because this is a colon-separated list, the colon has to be doubled. For each
7638 query, these parameter groups are tried in order until a connection is made and
7639 a query is successfully processed. The result of a query may be that no data is
7640 found, but that is still a successful query. In other words, the list of
7641 servers provides a backup facility, not a list of different places to look.
7642
7643 For Redis the global option need not be specified if all queries contain their
7644 own server information &-- see section &<<SECTspeserque>>&.
7645 If specified, the option must be set to a colon-separated list of server
7646 information.
7647 Each item in the list is a slash-separated list of three items:
7648 host, database number, and password.
7649 .olist
7650 The host is required and may be either an IPv4 address and optional
7651 port number (separated by a colon, which needs doubling due to the
7652 higher-level list), or a Unix socket pathname enclosed in parentheses
7653 .next
7654 The database number is optional; if present that number is selected in the backend
7655 .next
7656 The password is optional; if present it is used to authenticate to the backend
7657 .endlist
7658
7659 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7660 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7661 respectively, and the characters single-quote, double-quote, and backslash
7662 itself are escaped with backslashes.
7663
7664 The &%quote_redis%& expansion operator
7665 escapes whitespace and backslash characters with a backslash.
7666
7667 .section "Specifying the server in the query" "SECTspeserque"
7668 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7669 it is possible to specify a list of servers with an individual query. This is
7670 done by starting the query with
7671 .display
7672 &`servers=`&&'server1:server2:server3:...'&&`;`&
7673 .endd
7674 Each item in the list may take one of two forms:
7675 .olist
7676 If it contains no slashes it is assumed to be just a host name. The appropriate
7677 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7678 of the same name, and the remaining parameters (database, user, password) are
7679 taken from there.
7680 .next
7681 If it contains any slashes, it is taken as a complete parameter set.
7682 .endlist
7683 The list of servers is used in exactly the same way as the global list.
7684 Once a connection to a server has happened and a query has been
7685 successfully executed, processing of the lookup ceases.
7686
7687 This feature is intended for use in master/slave situations where updates
7688 are occurring and you want to update the master rather than a slave. If the
7689 master is in the list as a backup for reading, you might have a global setting
7690 like this:
7691 .code
7692 mysql_servers = slave1/db/name/pw:\
7693                 slave2/db/name/pw:\
7694                 master/db/name/pw
7695 .endd
7696 In an updating lookup, you could then write:
7697 .code
7698 ${lookup mysql{servers=master; UPDATE ...} }
7699 .endd
7700 That query would then be sent only to the master server. If, on the other hand,
7701 the master is not to be used for reading, and so is not present in the global
7702 option, you can still update it by a query of this form:
7703 .code
7704 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7705 .endd
7706
7707
7708 .section "Special MySQL features" "SECID73"
7709 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7710 causes a connection to the server on the local host by means of a Unix domain
7711 socket. An alternate socket can be specified in parentheses.
7712 An option group name for MySQL option files can be specified in square brackets;
7713 the default value is &"exim"&.
7714 The full syntax of each item in &%mysql_servers%& is:
7715 .display
7716 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7717   <&'database'&>/<&'user'&>/<&'password'&>
7718 .endd
7719 Any of the four sub-parts of the first field can be omitted. For normal use on
7720 the local host it can be left blank or set to just &"localhost"&.
7721
7722 No database need be supplied &-- but if it is absent here, it must be given in
7723 the queries.
7724
7725 If a MySQL query is issued that does not request any data (an insert, update,
7726 or delete command), the result of the lookup is the number of rows affected.
7727
7728 &*Warning*&: This can be misleading. If an update does not actually change
7729 anything (for example, setting a field to the value it already has), the result
7730 is zero because no rows are affected.
7731
7732
7733 .section "Special PostgreSQL features" "SECID74"
7734 PostgreSQL lookups can also use Unix domain socket connections to the database.
7735 This is usually faster and costs less CPU time than a TCP/IP connection.
7736 However it can be used only if the mail server runs on the same machine as the
7737 database server. A configuration line for PostgreSQL via Unix domain sockets
7738 looks like this:
7739 .code
7740 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7741 .endd
7742 In other words, instead of supplying a host name, a path to the socket is
7743 given. The path name is enclosed in parentheses so that its slashes aren't
7744 visually confused with the delimiters for the other server parameters.
7745
7746 If a PostgreSQL query is issued that does not request any data (an insert,
7747 update, or delete command), the result of the lookup is the number of rows
7748 affected.
7749
7750 .section "More about SQLite" "SECTsqlite"
7751 .cindex "lookup" "SQLite"
7752 .cindex "sqlite lookup type"
7753 SQLite is different to the other SQL lookups because a file name is required in
7754 addition to the SQL query. An SQLite database is a single file, and there is no
7755 daemon as in the other SQL databases. The interface to Exim requires the name
7756 of the file, as an absolute path, to be given at the start of the query. It is
7757 separated from the query by white space. This means that the path name cannot
7758 contain white space. Here is a lookup expansion example:
7759 .code
7760 ${lookup sqlite {/some/thing/sqlitedb \
7761   select name from aliases where id='userx';}}
7762 .endd
7763 In a list, the syntax is similar. For example:
7764 .code
7765 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7766    select * from relays where ip='$sender_host_address';
7767 .endd
7768 The only character affected by the &%quote_sqlite%& operator is a single
7769 quote, which it doubles.
7770
7771 .cindex timeout SQLite
7772 .cindex sqlite "lookup timeout"
7773 The SQLite library handles multiple simultaneous accesses to the database
7774 internally. Multiple readers are permitted, but only one process can
7775 update at once. Attempts to access the database while it is being updated
7776 are rejected after a timeout period, during which the SQLite library
7777 waits for the lock to be released. In Exim, the default timeout is set
7778 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7779 option.
7780 .ecindex IIDfidalo1
7781 .ecindex IIDfidalo2
7782
7783
7784 . ////////////////////////////////////////////////////////////////////////////
7785 . ////////////////////////////////////////////////////////////////////////////
7786
7787 .chapter "Domain, host, address, and local part lists" &&&
7788          "CHAPdomhosaddlists" &&&
7789          "Domain, host, and address lists"
7790 .scindex IIDdohoadli "lists of domains; hosts; etc."
7791 A number of Exim configuration options contain lists of domains, hosts,
7792 email addresses, or local parts. For example, the &%hold_domains%& option
7793 contains a list of domains whose delivery is currently suspended. These lists
7794 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7795 arguments to expansion conditions such as &%match_domain%&.
7796
7797 Each item in one of these lists is a pattern to be matched against a domain,
7798 host, email address, or local part, respectively. In the sections below, the
7799 different types of pattern for each case are described, but first we cover some
7800 general facilities that apply to all four kinds of list.
7801
7802 Note that other parts of Exim use a &'string list'& which does not
7803 support all the complexity available in
7804 domain, host, address and local part lists.
7805
7806
7807
7808 .section "Expansion of lists" "SECTlistexpand"
7809 .cindex "expansion" "of lists"
7810 Each list is expanded as a single string before it is used.
7811
7812 .new
7813 &'Exception: the router headers_remove option, where list-item
7814 splitting is done before string-expansion.'&
7815 .wen
7816
7817 The result of
7818 expansion must be a list, possibly containing empty items, which is split up
7819 into separate items for matching. By default, colon is the separator character,
7820 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7821 &<<SECTempitelis>>& for details of the list syntax; the second of these
7822 discusses the way to specify empty list items.
7823
7824
7825 If the string expansion is forced to fail, Exim behaves as if the item it is
7826 testing (domain, host, address, or local part) is not in the list. Other
7827 expansion failures cause temporary errors.
7828
7829 If an item in a list is a regular expression, backslashes, dollars and possibly
7830 other special characters in the expression must be protected against
7831 misinterpretation by the string expander. The easiest way to do this is to use
7832 the &`\N`& expansion feature to indicate that the contents of the regular
7833 expression should not be expanded. For example, in an ACL you might have:
7834 .code
7835 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7836                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7837 .endd
7838 The first item is a regular expression that is protected from expansion by
7839 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7840 senders based on the receiving domain.
7841
7842
7843
7844
7845 .section "Negated items in lists" "SECID76"
7846 .cindex "list" "negation"
7847 .cindex "negation" "in lists"
7848 Items in a list may be positive or negative. Negative items are indicated by a
7849 leading exclamation mark, which may be followed by optional white space. A list
7850 defines a set of items (domains, etc). When Exim processes one of these lists,
7851 it is trying to find out whether a domain, host, address, or local part
7852 (respectively) is in the set that is defined by the list. It works like this:
7853
7854 The list is scanned from left to right. If a positive item is matched, the
7855 subject that is being checked is in the set; if a negative item is matched, the
7856 subject is not in the set. If the end of the list is reached without the
7857 subject having matched any of the patterns, it is in the set if the last item
7858 was a negative one, but not if it was a positive one. For example, the list in
7859 .code
7860 domainlist relay_to_domains = !a.b.c : *.b.c
7861 .endd
7862 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7863 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7864 list is positive. However, if the setting were
7865 .code
7866 domainlist relay_to_domains = !a.b.c
7867 .endd
7868 then all domains other than &'a.b.c'& would match because the last item in the
7869 list is negative. In other words, a list that ends with a negative item behaves
7870 as if it had an extra item &`:*`& on the end.
7871
7872 Another way of thinking about positive and negative items in lists is to read
7873 the connector as &"or"& after a positive item and as &"and"& after a negative
7874 item.
7875
7876
7877
7878 .section "File names in lists" "SECTfilnamlis"
7879 .cindex "list" "file name in"
7880 If an item in a domain, host, address, or local part list is an absolute file
7881 name (beginning with a slash character), each line of the file is read and
7882 processed as if it were an independent item in the list, except that further
7883 file names are not allowed,
7884 and no expansion of the data from the file takes place.
7885 Empty lines in the file are ignored, and the file may also contain comment
7886 lines:
7887
7888 .ilist
7889 For domain and host lists, if a # character appears anywhere in a line of the
7890 file, it and all following characters are ignored.
7891 .next
7892 Because local parts may legitimately contain # characters, a comment in an
7893 address list or local part list file is recognized only if # is preceded by
7894 white space or the start of the line. For example:
7895 .code
7896 not#comment@x.y.z   # but this is a comment
7897 .endd
7898 .endlist
7899
7900 Putting a file name in a list has the same effect as inserting each line of the
7901 file as an item in the list (blank lines and comments excepted). However, there
7902 is one important difference: the file is read each time the list is processed,
7903 so if its contents vary over time, Exim's behaviour changes.
7904
7905 If a file name is preceded by an exclamation mark, the sense of any match
7906 within the file is inverted. For example, if
7907 .code
7908 hold_domains = !/etc/nohold-domains
7909 .endd
7910 and the file contains the lines
7911 .code
7912 !a.b.c
7913 *.b.c
7914 .endd
7915 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7916 any domain matching &`*.b.c`& is not.
7917
7918
7919
7920 .section "An lsearch file is not an out-of-line list" "SECID77"
7921 As will be described in the sections that follow, lookups can be used in lists
7922 to provide indexed methods of checking list membership. There has been some
7923 confusion about the way &(lsearch)& lookups work in lists. Because
7924 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7925 sometimes thought that it is allowed to contain wild cards and other kinds of
7926 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7927 always fixed strings, just as for any other single-key lookup type.
7928
7929 If you want to use a file to contain wild-card patterns that form part of a
7930 list, just give the file name on its own, without a search type, as described
7931 in the previous section. You could also use the &(wildlsearch)& or
7932 &(nwildlsearch)&, but there is no advantage in doing this.
7933
7934
7935
7936
7937 .section "Named lists" "SECTnamedlists"
7938 .cindex "named lists"
7939 .cindex "list" "named"
7940 A list of domains, hosts, email addresses, or local parts can be given a name
7941 which is then used to refer to the list elsewhere in the configuration. This is
7942 particularly convenient if the same list is required in several different
7943 places. It also allows lists to be given meaningful names, which can improve
7944 the readability of the configuration. For example, it is conventional to define
7945 a domain list called &'local_domains'& for all the domains that are handled
7946 locally on a host, using a configuration line such as
7947 .code
7948 domainlist local_domains = localhost:my.dom.example
7949 .endd
7950 Named lists are referenced by giving their name preceded by a plus sign, so,
7951 for example, a router that is intended to handle local domains would be
7952 configured with the line
7953 .code
7954 domains = +local_domains
7955 .endd
7956 The first router in a configuration is often one that handles all domains
7957 except the local ones, using a configuration with a negated item like this:
7958 .code
7959 dnslookup:
7960   driver = dnslookup
7961   domains = ! +local_domains
7962   transport = remote_smtp
7963   no_more
7964 .endd
7965 The four kinds of named list are created by configuration lines starting with
7966 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7967 respectively. Then there follows the name that you are defining, followed by an
7968 equals sign and the list itself. For example:
7969 .code
7970 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7971 addresslist bad_senders = cdb;/etc/badsenders
7972 .endd
7973 A named list may refer to other named lists:
7974 .code
7975 domainlist  dom1 = first.example : second.example
7976 domainlist  dom2 = +dom1 : third.example
7977 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7978 .endd
7979 &*Warning*&: If the last item in a referenced list is a negative one, the
7980 effect may not be what you intended, because the negation does not propagate
7981 out to the higher level. For example, consider:
7982 .code
7983 domainlist  dom1 = !a.b
7984 domainlist  dom2 = +dom1 : *.b
7985 .endd
7986 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7987 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7988 means it matches the second list as well. The effect is not the same as
7989 .code
7990 domainlist  dom2 = !a.b : *.b
7991 .endd
7992 where &'x.y'& does not match. It's best to avoid negation altogether in
7993 referenced lists if you can.
7994
7995 Named lists may have a performance advantage. When Exim is routing an
7996 address or checking an incoming message, it caches the result of tests on named
7997 lists. So, if you have a setting such as
7998 .code
7999 domains = +local_domains
8000 .endd
8001 on several of your routers
8002 or in several ACL statements,
8003 the actual test is done only for the first one. However, the caching works only
8004 if there are no expansions within the list itself or any sublists that it
8005 references. In other words, caching happens only for lists that are known to be
8006 the same each time they are referenced.
8007
8008 By default, there may be up to 16 named lists of each type. This limit can be
8009 extended by changing a compile-time variable. The use of domain and host lists
8010 is recommended for concepts such as local domains, relay domains, and relay
8011 hosts. The default configuration is set up like this.
8012
8013
8014
8015 .section "Named lists compared with macros" "SECID78"
8016 .cindex "list" "named compared with macro"
8017 .cindex "macro" "compared with named list"
8018 At first sight, named lists might seem to be no different from macros in the
8019 configuration file. However, macros are just textual substitutions. If you
8020 write
8021 .code
8022 ALIST = host1 : host2
8023 auth_advertise_hosts = !ALIST
8024 .endd
8025 it probably won't do what you want, because that is exactly the same as
8026 .code
8027 auth_advertise_hosts = !host1 : host2
8028 .endd
8029 Notice that the second host name is not negated. However, if you use a host
8030 list, and write
8031 .code
8032 hostlist alist = host1 : host2
8033 auth_advertise_hosts = ! +alist
8034 .endd
8035 the negation applies to the whole list, and so that is equivalent to
8036 .code
8037 auth_advertise_hosts = !host1 : !host2
8038 .endd
8039
8040
8041 .section "Named list caching" "SECID79"
8042 .cindex "list" "caching of named"
8043 .cindex "caching" "named lists"
8044 While processing a message, Exim caches the result of checking a named list if
8045 it is sure that the list is the same each time. In practice, this means that
8046 the cache operates only if the list contains no $ characters, which guarantees
8047 that it will not change when it is expanded. Sometimes, however, you may have
8048 an expanded list that you know will be the same each time within a given
8049 message. For example:
8050 .code
8051 domainlist special_domains = \
8052            ${lookup{$sender_host_address}cdb{/some/file}}
8053 .endd
8054 This provides a list of domains that depends only on the sending host's IP
8055 address. If this domain list is referenced a number of times (for example,
8056 in several ACL lines, or in several routers) the result of the check is not
8057 cached by default, because Exim does not know that it is going to be the
8058 same list each time.
8059
8060 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8061 cache the result anyway. For example:
8062 .code
8063 domainlist_cache special_domains = ${lookup{...
8064 .endd
8065 If you do this, you should be absolutely sure that caching is going to do
8066 the right thing in all cases. When in doubt, leave it out.
8067
8068
8069
8070 .section "Domain lists" "SECTdomainlist"
8071 .cindex "domain list" "patterns for"
8072 .cindex "list" "domain list"
8073 Domain lists contain patterns that are to be matched against a mail domain.
8074 The following types of item may appear in domain lists:
8075
8076 .ilist
8077 .cindex "primary host name"
8078 .cindex "host name" "matched in domain list"
8079 .oindex "&%primary_hostname%&"
8080 .cindex "domain list" "matching primary host name"
8081 .cindex "@ in a domain list"
8082 If a pattern consists of a single @ character, it matches the local host name,
8083 as set by the &%primary_hostname%& option (or defaulted). This makes it
8084 possible to use the same configuration file on several different hosts that
8085 differ only in their names.
8086 .next
8087 .cindex "@[] in a domain list"
8088 .cindex "domain list" "matching local IP interfaces"
8089 .cindex "domain literal"
8090 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8091 in square brackets (as in an email address that contains a domain literal), but
8092 only if that IP address is recognized as local for email routing purposes. The
8093 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8094 control which of a host's several IP addresses are treated as local.
8095 In today's Internet, the use of domain literals is controversial.
8096 .next
8097 .cindex "@mx_any"
8098 .cindex "@mx_primary"
8099 .cindex "@mx_secondary"
8100 .cindex "domain list" "matching MX pointers to local host"
8101 If a pattern consists of the string &`@mx_any`& it matches any domain that
8102 has an MX record pointing to the local host or to any host that is listed in
8103 .oindex "&%hosts_treat_as_local%&"
8104 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8105 are similar, except that the first matches only when a primary MX target is the
8106 local host, and the second only when no primary MX target is the local host,
8107 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8108 preference value &-- there may of course be more than one of them.
8109
8110 The MX lookup that takes place when matching a pattern of this type is
8111 performed with the resolver options for widening names turned off. Thus, for
8112 example, a single-component domain will &'not'& be expanded by adding the
8113 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8114 options of the &(dnslookup)& router for a discussion of domain widening.
8115
8116 Sometimes you may want to ignore certain IP addresses when using one of these
8117 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8118 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8119 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8120 on a router). For example:
8121 .code
8122 domains = @mx_any/ignore=127.0.0.1
8123 .endd
8124 This example matches any domain that has an MX record pointing to one of
8125 the local host's IP addresses other than 127.0.0.1.
8126
8127 The list of IP addresses is in fact processed by the same code that processes
8128 host lists, so it may contain CIDR-coded network specifications and it may also
8129 contain negative items.
8130
8131 Because the list of IP addresses is a sublist within a domain list, you have to
8132 be careful about delimiters if there is more than one address. Like any other
8133 list, the default delimiter can be changed. Thus, you might have:
8134 .code
8135 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8136           an.other.domain : ...
8137 .endd
8138 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8139 involved, it is easiest to change the delimiter for the main list as well:
8140 .code
8141 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8142           an.other.domain ? ...
8143 .endd
8144 .next
8145 .cindex "asterisk" "in domain list"
8146 .cindex "domain list" "asterisk in"
8147 .cindex "domain list" "matching &""ends with""&"
8148 If a pattern starts with an asterisk, the remaining characters of the pattern
8149 are compared with the terminating characters of the domain. The use of &"*"& in
8150 domain lists differs from its use in partial matching lookups. In a domain
8151 list, the character following the asterisk need not be a dot, whereas partial
8152 matching works only in terms of dot-separated components. For example, a domain
8153 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8154 &'cipher.key.ex'&.
8155
8156 .next
8157 .cindex "regular expressions" "in domain list"
8158 .cindex "domain list" "matching regular expression"
8159 If a pattern starts with a circumflex character, it is treated as a regular
8160 expression, and matched against the domain using a regular expression matching
8161 function. The circumflex is treated as part of the regular expression.
8162 Email domains are case-independent, so this regular expression match is by
8163 default case-independent, but you can make it case-dependent by starting it
8164 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8165 are given in chapter &<<CHAPregexp>>&.
8166
8167 &*Warning*&: Because domain lists are expanded before being processed, you
8168 must escape any backslash and dollar characters in the regular expression, or
8169 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8170 it is not to be expanded (unless you really do want to build a regular
8171 expression by expansion, of course).
8172 .next
8173 .cindex "lookup" "in domain list"
8174 .cindex "domain list" "matching by lookup"
8175 If a pattern starts with the name of a single-key lookup type followed by a
8176 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8177 must be a file name in a suitable format for the lookup type. For example, for
8178 &"cdb;"& it must be an absolute path:
8179 .code
8180 domains = cdb;/etc/mail/local_domains.cdb
8181 .endd
8182 The appropriate type of lookup is done on the file using the domain name as the
8183 key. In most cases, the data that is looked up is not used; Exim is interested
8184 only in whether or not the key is present in the file. However, when a lookup
8185 is used for the &%domains%& option on a router
8186 or a &%domains%& condition in an ACL statement, the data is preserved in the
8187 &$domain_data$& variable and can be referred to in other router options or
8188 other statements in the same ACL.
8189
8190 .next
8191 Any of the single-key lookup type names may be preceded by
8192 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8193 .code
8194 domains = partial-dbm;/partial/domains
8195 .endd
8196 This causes partial matching logic to be invoked; a description of how this
8197 works is given in section &<<SECTpartiallookup>>&.
8198
8199 .next
8200 .cindex "asterisk" "in lookup type"
8201 Any of the single-key lookup types may be followed by an asterisk. This causes
8202 a default lookup for a key consisting of a single asterisk to be done if the
8203 original lookup fails. This is not a useful feature when using a domain list to
8204 select particular domains (because any domain would match), but it might have
8205 value if the result of the lookup is being used via the &$domain_data$&
8206 expansion variable.
8207 .next
8208 If the pattern starts with the name of a query-style lookup type followed by a
8209 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8210 pattern must be an appropriate query for the lookup type, as described in
8211 chapter &<<CHAPfdlookup>>&. For example:
8212 .code
8213 hold_domains = mysql;select domain from holdlist \
8214   where domain = '${quote_mysql:$domain}';
8215 .endd
8216 In most cases, the data that is looked up is not used (so for an SQL query, for
8217 example, it doesn't matter what field you select). Exim is interested only in
8218 whether or not the query succeeds. However, when a lookup is used for the
8219 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8220 variable and can be referred to in other options.
8221 .next
8222 .cindex "domain list" "matching literal domain name"
8223 If none of the above cases apply, a caseless textual comparison is made
8224 between the pattern and the domain.
8225 .endlist
8226
8227 Here is an example that uses several different kinds of pattern:
8228 .code
8229 domainlist funny_domains = \
8230   @ : \
8231   lib.unseen.edu : \
8232   *.foundation.fict.example : \
8233   \N^[1-2]\d{3}\.fict\.example$\N : \
8234   partial-dbm;/opt/data/penguin/book : \
8235   nis;domains.byname : \
8236   nisplus;[name=$domain,status=local],domains.org_dir
8237 .endd
8238 There are obvious processing trade-offs among the various matching modes. Using
8239 an asterisk is faster than a regular expression, and listing a few names
8240 explicitly probably is too. The use of a file or database lookup is expensive,
8241 but may be the only option if hundreds of names are required. Because the
8242 patterns are tested in order, it makes sense to put the most commonly matched
8243 patterns earlier.
8244
8245
8246
8247 .section "Host lists" "SECThostlist"
8248 .cindex "host list" "patterns in"
8249 .cindex "list" "host list"
8250 Host lists are used to control what remote hosts are allowed to do. For
8251 example, some hosts may be allowed to use the local host as a relay, and some
8252 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8253 two different ways, by name or by IP address. In a host list, some types of
8254 pattern are matched to a host name, and some are matched to an IP address.
8255 You need to be particularly careful with this when single-key lookups are
8256 involved, to ensure that the right value is being used as the key.
8257
8258
8259 .section "Special host list patterns" "SECID80"
8260 .cindex "empty item in hosts list"
8261 .cindex "host list" "empty string in"
8262 If a host list item is the empty string, it matches only when no remote host is
8263 involved. This is the case when a message is being received from a local
8264 process using SMTP on the standard input, that is, when a TCP/IP connection is
8265 not used.
8266
8267 .cindex "asterisk" "in host list"
8268 The special pattern &"*"& in a host list matches any host or no host. Neither
8269 the IP address nor the name is actually inspected.
8270
8271
8272
8273 .section "Host list patterns that match by IP address" "SECThoslispatip"
8274 .cindex "host list" "matching IP addresses"
8275 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8276 the incoming address actually appears in the IPv6 host as
8277 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8278 list, it is converted into a traditional IPv4 address first. (Not all operating
8279 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8280 concerns.)
8281
8282 The following types of pattern in a host list check the remote host by
8283 inspecting its IP address:
8284
8285 .ilist
8286 If the pattern is a plain domain name (not a regular expression, not starting
8287 with *, not a lookup of any kind), Exim calls the operating system function
8288 to find the associated IP address(es). Exim uses the newer
8289 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8290 This typically causes a forward DNS lookup of the name. The result is compared
8291 with the IP address of the subject host.
8292
8293 If there is a temporary problem (such as a DNS timeout) with the host name
8294 lookup, a temporary error occurs. For example, if the list is being used in an
8295 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8296 temporary SMTP error code. If no IP address can be found for the host name,
8297 what happens is described in section &<<SECTbehipnot>>& below.
8298
8299 .next
8300 .cindex "@ in a host list"
8301 If the pattern is &"@"&, the primary host name is substituted and used as a
8302 domain name, as just described.
8303
8304 .next
8305 If the pattern is an IP address, it is matched against the IP address of the
8306 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8307 IPv6 addresses can be given in colon-separated format, but the colons have to
8308 be doubled so as not to be taken as item separators when the default list
8309 separator is used. IPv6 addresses are recognized even when Exim is compiled
8310 without IPv6 support. This means that if they appear in a host list on an
8311 IPv4-only host, Exim will not treat them as host names. They are just addresses
8312 that can never match a client host.
8313
8314 .next
8315 .cindex "@[] in a host list"
8316 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8317 the local host. For example, if the local host is an IPv4 host with one
8318 interface address 10.45.23.56, these two ACL statements have the same effect:
8319 .code
8320 accept hosts = 127.0.0.1 : 10.45.23.56
8321 accept hosts = @[]
8322 .endd
8323 .next
8324 .cindex "CIDR notation"
8325 If the pattern is an IP address followed by a slash and a mask length (for
8326 example 10.11.42.0/24), it is matched against the IP address of the subject
8327 host under the given mask. This allows, an entire network of hosts to be
8328 included (or excluded) by a single item. The mask uses CIDR notation; it
8329 specifies the number of address bits that must match, starting from the most
8330 significant end of the address.
8331
8332 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8333 of a range of addresses. It is the number of bits in the network portion of the
8334 address. The above example specifies a 24-bit netmask, so it matches all 256
8335 addresses in the 10.11.42.0 network. An item such as
8336 .code
8337 192.168.23.236/31
8338 .endd
8339 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8340 32 for an IPv4 address is the same as no mask at all; just a single address
8341 matches.
8342
8343 Here is another example which shows an IPv4 and an IPv6 network:
8344 .code
8345 recipient_unqualified_hosts = 192.168.0.0/16: \
8346                               3ffe::ffff::836f::::/48
8347 .endd
8348 The doubling of list separator characters applies only when these items
8349 appear inline in a host list. It is not required when indirecting via a file.
8350 For example:
8351 .code
8352 recipient_unqualified_hosts = /opt/exim/unqualnets
8353 .endd
8354 could make use of a file containing
8355 .code
8356 172.16.0.0/12
8357 3ffe:ffff:836f::/48
8358 .endd
8359 to have exactly the same effect as the previous example. When listing IPv6
8360 addresses inline, it is usually more convenient to use the facility for
8361 changing separator characters. This list contains the same two networks:
8362 .code
8363 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8364                                  3ffe:ffff:836f::/48
8365 .endd
8366 The separator is changed to semicolon by the leading &"<;"& at the start of the
8367 list.
8368 .endlist
8369
8370
8371
8372 .section "Host list patterns for single-key lookups by host address" &&&
8373          "SECThoslispatsikey"
8374 .cindex "host list" "lookup of IP address"
8375 When a host is to be identified by a single-key lookup of its complete IP
8376 address, the pattern takes this form:
8377 .display
8378 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8379 .endd
8380 For example:
8381 .code
8382 hosts_lookup = net-cdb;/hosts-by-ip.db
8383 .endd
8384 The text form of the IP address of the subject host is used as the lookup key.
8385 IPv6 addresses are converted to an unabbreviated form, using lower case
8386 letters, with dots as separators because colon is the key terminator in
8387 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8388 quoting the keys, but this is a facility that was added later.] The data
8389 returned by the lookup is not used.
8390
8391 .cindex "IP address" "masking"
8392 .cindex "host list" "masked IP address"
8393 Single-key lookups can also be performed using masked IP addresses, using
8394 patterns of this form:
8395 .display
8396 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8397 .endd
8398 For example:
8399 .code
8400 net24-dbm;/networks.db
8401 .endd
8402 The IP address of the subject host is masked using <&'number'&> as the mask
8403 length. A textual string is constructed from the masked value, followed by the
8404 mask, and this is used as the lookup key. For example, if the host's IP address
8405 is 192.168.34.6, the key that is looked up for the above example is
8406 &"192.168.34.0/24"&.
8407
8408 When an IPv6 address is converted to a string, dots are normally used instead
8409 of colons, so that keys in &(lsearch)& files need not contain colons (which
8410 terminate &(lsearch)& keys). This was implemented some time before the ability
8411 to quote keys was made available in &(lsearch)& files. However, the more
8412 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8413 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8414 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8415 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8416 addresses are always used.
8417
8418 Ideally, it would be nice to tidy up this anomalous situation by changing to
8419 colons in all cases, given that quoting is now available for &(lsearch)&.
8420 However, this would be an incompatible change that might break some existing
8421 configurations.
8422
8423 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8424 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8425 the former case the key strings include the mask value, whereas in the latter
8426 case the IP address is used on its own.
8427
8428
8429
8430 .section "Host list patterns that match by host name" "SECThoslispatnam"
8431 .cindex "host" "lookup failures"
8432 .cindex "unknown host name"
8433 .cindex "host list" "matching host name"
8434 There are several types of pattern that require Exim to know the name of the
8435 remote host. These are either wildcard patterns or lookups by name. (If a
8436 complete hostname is given without any wildcarding, it is used to find an IP
8437 address to match against, as described in section &<<SECThoslispatip>>&
8438 above.)
8439
8440 If the remote host name is not already known when Exim encounters one of these
8441 patterns, it has to be found from the IP address.
8442 Although many sites on the Internet are conscientious about maintaining reverse
8443 DNS data for their hosts, there are also many that do not do this.
8444 Consequently, a name cannot always be found, and this may lead to unwanted
8445 effects. Take care when configuring host lists with wildcarded name patterns.
8446 Consider what will happen if a name cannot be found.
8447
8448 Because of the problems of determining host names from IP addresses, matching
8449 against host names is not as common as matching against IP addresses.
8450
8451 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8452 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8453 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8454 are done can be changed by setting the &%host_lookup_order%& option. For
8455 security, once Exim has found one or more names, it looks up the IP addresses
8456 for these names and compares them with the IP address that it started with.
8457 Only those names whose IP addresses match are accepted. Any other names are
8458 discarded. If no names are left, Exim behaves as if the host name cannot be
8459 found. In the most common case there is only one name and one IP address.
8460
8461 There are some options that control what happens if a host name cannot be
8462 found. These are described in section &<<SECTbehipnot>>& below.
8463
8464 .cindex "host" "alias for"
8465 .cindex "alias for host"
8466 As a result of aliasing, hosts may have more than one name. When processing any
8467 of the following types of pattern, all the host's names are checked:
8468
8469 .ilist
8470 .cindex "asterisk" "in host list"
8471 If a pattern starts with &"*"& the remainder of the item must match the end of
8472 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8473 &'.b.c'&. This special simple form is provided because this is a very common
8474 requirement. Other kinds of wildcarding require the use of a regular
8475 expression.
8476 .next
8477 .cindex "regular expressions" "in host list"
8478 .cindex "host list" "regular expression in"
8479 If the item starts with &"^"& it is taken to be a regular expression which is
8480 matched against the host name. Host names are case-independent, so this regular
8481 expression match is by default case-independent, but you can make it
8482 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8483 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8484 example,
8485 .code
8486 ^(a|b)\.c\.d$
8487 .endd
8488 is a regular expression that matches either of the two hosts &'a.c.d'& or
8489 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8490 that backslash and dollar characters are not misinterpreted as part of the
8491 string expansion. The simplest way to do this is to use &`\N`& to mark that
8492 part of the string as non-expandable. For example:
8493 .code
8494 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8495 .endd
8496 &*Warning*&: If you want to match a complete host name, you must include the
8497 &`$`& terminating metacharacter in the regular expression, as in the above
8498 example. Without it, a match at the start of the host name is all that is
8499 required.
8500 .endlist
8501
8502
8503
8504
8505 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8506 .cindex "host" "lookup failures, permanent"
8507 While processing a host list, Exim may need to look up an IP address from a
8508 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8509 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8510 behaviour when it fails to find the information it is seeking is the same.
8511
8512 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8513 apply to temporary DNS errors, whose handling is described in the next section.
8514
8515 .cindex "&`+include_unknown`&"
8516 .cindex "&`+ignore_unknown`&"
8517 Exim parses a host list from left to right. If it encounters a permanent
8518 lookup failure in any item in the host list before it has found a match,
8519 Exim treats it as a failure and the default behavior is as if the host
8520 does not match the list. This may not always be what you want to happen.
8521 To change Exim's behaviour, the special items &`+include_unknown`& or
8522 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8523 not recognized in an indirected file).
8524
8525 .ilist
8526 If any item that follows &`+include_unknown`& requires information that
8527 cannot found, Exim behaves as if the host does match the list. For example,
8528 .code
8529 host_reject_connection = +include_unknown:*.enemy.ex
8530 .endd
8531 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8532 any hosts whose name it cannot find.
8533
8534 .next
8535 If any item that follows &`+ignore_unknown`& requires information that cannot
8536 be found, Exim ignores that item and proceeds to the rest of the list. For
8537 example:
8538 .code
8539 accept hosts = +ignore_unknown : friend.example : \
8540                192.168.4.5
8541 .endd
8542 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8543 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8544 name can be found for 192.168.4.5, it is rejected.
8545 .endlist
8546
8547 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8548 list. The effect of each one lasts until the next, or until the end of the
8549 list.
8550
8551 .section "Mixing wildcarded host names and addresses in host lists" &&&
8552          "SECTmixwilhos"
8553 .cindex "host list" "mixing names and addresses in"
8554
8555 This section explains the host/ip processing logic with the same concepts
8556 as the previous section, but specifically addresses what happens when a
8557 wildcarded hostname is one of the items in the hostlist.
8558
8559 .ilist
8560 If you have name lookups or wildcarded host names and
8561 IP addresses in the same host list, you should normally put the IP
8562 addresses first. For example, in an ACL you could have:
8563 .code
8564 accept hosts = 10.9.8.7 : *.friend.example
8565 .endd
8566 The reason you normally would order it this way lies in the
8567 left-to-right way that Exim processes lists.  It can test IP addresses
8568 without doing any DNS lookups, but when it reaches an item that requires
8569 a host name, it fails if it cannot find a host name to compare with the
8570 pattern. If the above list is given in the opposite order, the
8571 &%accept%& statement fails for a host whose name cannot be found, even
8572 if its IP address is 10.9.8.7.
8573
8574 .next
8575 If you really do want to do the name check first, and still recognize the IP
8576 address, you can rewrite the ACL like this:
8577 .code
8578 accept hosts = *.friend.example
8579 accept hosts = 10.9.8.7
8580 .endd
8581 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8582 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8583 &`+ignore_unknown`&, which was discussed in depth in the first example in
8584 this section.
8585 .endlist
8586
8587
8588 .section "Temporary DNS errors when looking up host information" &&&
8589          "SECTtemdnserr"
8590 .cindex "host" "lookup failures, temporary"
8591 .cindex "&`+include_defer`&"
8592 .cindex "&`+ignore_defer`&"
8593 A temporary DNS lookup failure normally causes a defer action (except when
8594 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8595 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8596 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8597 section. These options should be used with care, probably only in non-critical
8598 host lists such as whitelists.
8599
8600
8601
8602 .section "Host list patterns for single-key lookups by host name" &&&
8603          "SECThoslispatnamsk"
8604 .cindex "unknown host name"
8605 .cindex "host list" "matching host name"
8606 If a pattern is of the form
8607 .display
8608 <&'single-key-search-type'&>;<&'search-data'&>
8609 .endd
8610 for example
8611 .code
8612 dbm;/host/accept/list
8613 .endd
8614 a single-key lookup is performed, using the host name as its key. If the
8615 lookup succeeds, the host matches the item. The actual data that is looked up
8616 is not used.
8617
8618 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8619 keys in the file, not IP addresses. If you want to do lookups based on IP
8620 addresses, you must precede the search type with &"net-"& (see section
8621 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8622 two items in the same list, one doing an address lookup and one doing a name
8623 lookup, both using the same file.
8624
8625
8626
8627 .section "Host list patterns for query-style lookups" "SECID81"
8628 If a pattern is of the form
8629 .display
8630 <&'query-style-search-type'&>;<&'query'&>
8631 .endd
8632 the query is obeyed, and if it succeeds, the host matches the item. The actual
8633 data that is looked up is not used. The variables &$sender_host_address$& and
8634 &$sender_host_name$& can be used in the query. For example:
8635 .code
8636 hosts_lookup = pgsql;\
8637   select ip from hostlist where ip='$sender_host_address'
8638 .endd
8639 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8640 can use the &%sg%& expansion item to change this if you need to. If you want to
8641 use masked IP addresses in database queries, you can use the &%mask%& expansion
8642 operator.
8643
8644 If the query contains a reference to &$sender_host_name$&, Exim automatically
8645 looks up the host name if it has not already done so. (See section
8646 &<<SECThoslispatnam>>& for comments on finding host names.)
8647
8648 Historical note: prior to release 4.30, Exim would always attempt to find a
8649 host name before running the query, unless the search type was preceded by
8650 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8651 still recognized for query-style lookups, but its presence or absence has no
8652 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8653 See section &<<SECThoslispatsikey>>&.)
8654
8655
8656
8657
8658
8659 .section "Address lists" "SECTaddresslist"
8660 .cindex "list" "address list"
8661 .cindex "address list" "empty item"
8662 .cindex "address list" "patterns"
8663 Address lists contain patterns that are matched against mail addresses. There
8664 is one special case to be considered: the sender address of a bounce message is
8665 always empty. You can test for this by providing an empty item in an address
8666 list. For example, you can set up a router to process bounce messages by
8667 using this option setting:
8668 .code
8669 senders = :
8670 .endd
8671 The presence of the colon creates an empty item. If you do not provide any
8672 data, the list is empty and matches nothing. The empty sender can also be
8673 detected by a regular expression that matches an empty string,
8674 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8675
8676 Non-empty items in an address list can be straightforward email addresses. For
8677 example:
8678 .code
8679 senders = jbc@askone.example : hs@anacreon.example
8680 .endd
8681 A certain amount of wildcarding is permitted. If a pattern contains an @
8682 character, but is not a regular expression and does not begin with a
8683 semicolon-terminated lookup type (described below), the local part of the
8684 subject address is compared with the local part of the pattern, which may start
8685 with an asterisk. If the local parts match, the domain is checked in exactly
8686 the same way as for a pattern in a domain list. For example, the domain can be
8687 wildcarded, refer to a named list, or be a lookup:
8688 .code
8689 deny senders = *@*.spamming.site:\
8690                *@+hostile_domains:\
8691                bozo@partial-lsearch;/list/of/dodgy/sites:\
8692                *@dbm;/bad/domains.db
8693 .endd
8694 .cindex "local part" "starting with !"
8695 .cindex "address list" "local part starting with !"
8696 If a local part that begins with an exclamation mark is required, it has to be
8697 specified using a regular expression, because otherwise the exclamation mark is
8698 treated as a sign of negation, as is standard in lists.
8699
8700 If a non-empty pattern that is not a regular expression or a lookup does not
8701 contain an @ character, it is matched against the domain part of the subject
8702 address. The only two formats that are recognized this way are a literal
8703 domain, or a domain pattern that starts with *. In both these cases, the effect
8704 is the same as if &`*@`& preceded the pattern. For example:
8705 .code
8706 deny senders = enemy.domain : *.enemy.domain
8707 .endd
8708
8709 The following kinds of more complicated address list pattern can match any
8710 address, including the empty address that is characteristic of bounce message
8711 senders:
8712
8713 .ilist
8714 .cindex "regular expressions" "in address list"
8715 .cindex "address list" "regular expression in"
8716 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8717 done against the complete address, with the pattern as the regular expression.
8718 You must take care that backslash and dollar characters are not misinterpreted
8719 as part of the string expansion. The simplest way to do this is to use &`\N`&
8720 to mark that part of the string as non-expandable. For example:
8721 .code
8722 deny senders = \N^.*this.*@example\.com$\N : \
8723                \N^\d{8}.+@spamhaus.example$\N : ...
8724 .endd
8725 The &`\N`& sequences are removed by the expansion, so these items do indeed
8726 start with &"^"& by the time they are being interpreted as address patterns.
8727
8728 .next
8729 .cindex "address list" "lookup for complete address"
8730 Complete addresses can be looked up by using a pattern that starts with a
8731 lookup type terminated by a semicolon, followed by the data for the lookup. For
8732 example:
8733 .code
8734 deny senders = cdb;/etc/blocked.senders : \
8735   mysql;select address from blocked where \
8736   address='${quote_mysql:$sender_address}'
8737 .endd
8738 Both query-style and single-key lookup types can be used. For a single-key
8739 lookup type, Exim uses the complete address as the key. However, empty keys are
8740 not supported for single-key lookups, so a match against the empty address
8741 always fails. This restriction does not apply to query-style lookups.
8742
8743 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8744 cannot be used, and is ignored if specified, with an entry being written to the
8745 panic log.
8746 .cindex "*@ with single-key lookup"
8747 However, you can configure lookup defaults, as described in section
8748 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8749 default. For example, with this lookup:
8750 .code
8751 accept senders = lsearch*@;/some/file
8752 .endd
8753 the file could contains lines like this:
8754 .code
8755 user1@domain1.example
8756 *@domain2.example
8757 .endd
8758 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8759 that are tried is:
8760 .code
8761 nimrod@jaeger.example
8762 *@jaeger.example
8763 *
8764 .endd
8765 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8766 would mean that every address matches, thus rendering the test useless.
8767
8768 &*Warning 2*&: Do not confuse these two kinds of item:
8769 .code
8770 deny recipients = dbm*@;/some/file
8771 deny recipients = *@dbm;/some/file
8772 .endd
8773 The first does a whole address lookup, with defaulting, as just described,
8774 because it starts with a lookup type. The second matches the local part and
8775 domain independently, as described in a bullet point below.
8776 .endlist
8777
8778
8779 The following kinds of address list pattern can match only non-empty addresses.
8780 If the subject address is empty, a match against any of these pattern types
8781 always fails.
8782
8783
8784 .ilist
8785 .cindex "@@ with single-key lookup"
8786 .cindex "address list" "@@ lookup type"
8787 .cindex "address list" "split local part and domain"
8788 If a pattern starts with &"@@"& followed by a single-key lookup item
8789 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8790 split into a local part and a domain. The domain is looked up in the file. If
8791 it is not found, there is no match. If it is found, the data that is looked up
8792 from the file is treated as a colon-separated list of local part patterns, each
8793 of which is matched against the subject local part in turn.
8794
8795 .cindex "asterisk" "in address list"
8796 The lookup may be a partial one, and/or one involving a search for a default
8797 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8798 patterns that are looked up can be regular expressions or begin with &"*"&, or
8799 even be further lookups. They may also be independently negated. For example,
8800 with
8801 .code
8802 deny senders = @@dbm;/etc/reject-by-domain
8803 .endd
8804 the data from which the DBM file is built could contain lines like
8805 .code
8806 baddomain.com:  !postmaster : *
8807 .endd
8808 to reject all senders except &%postmaster%& from that domain.
8809
8810 .cindex "local part" "starting with !"
8811 If a local part that actually begins with an exclamation mark is required, it
8812 has to be specified using a regular expression. In &(lsearch)& files, an entry
8813 may be split over several lines by indenting the second and subsequent lines,
8814 but the separating colon must still be included at line breaks. White space
8815 surrounding the colons is ignored. For example:
8816 .code
8817 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8818   spammer3 : spammer4
8819 .endd
8820 As in all colon-separated lists in Exim, a colon can be included in an item by
8821 doubling.
8822
8823 If the last item in the list starts with a right angle-bracket, the remainder
8824 of the item is taken as a new key to look up in order to obtain a continuation
8825 list of local parts. The new key can be any sequence of characters. Thus one
8826 might have entries like
8827 .code
8828 aol.com: spammer1 : spammer 2 : >*
8829 xyz.com: spammer3 : >*
8830 *:       ^\d{8}$
8831 .endd
8832 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8833 local parts for all domains, in addition to the specific local parts listed for
8834 each domain. Of course, using this feature costs another lookup each time a
8835 chain is followed, but the effort needed to maintain the data is reduced.
8836
8837 .cindex "loop" "in lookups"
8838 It is possible to construct loops using this facility, and in order to catch
8839 them, the chains may be no more than fifty items long.
8840
8841 .next
8842 The @@<&'lookup'&> style of item can also be used with a query-style
8843 lookup, but in this case, the chaining facility is not available. The lookup
8844 can only return a single list of local parts.
8845 .endlist
8846
8847 &*Warning*&: There is an important difference between the address list items
8848 in these two examples:
8849 .code
8850 senders = +my_list
8851 senders = *@+my_list
8852 .endd
8853 In the first one, &`my_list`& is a named address list, whereas in the second
8854 example it is a named domain list.
8855
8856
8857
8858
8859 .section "Case of letters in address lists" "SECTcasletadd"
8860 .cindex "case of local parts"
8861 .cindex "address list" "case forcing"
8862 .cindex "case forcing in address lists"
8863 Domains in email addresses are always handled caselessly, but for local parts
8864 case may be significant on some systems (see &%caseful_local_part%& for how
8865 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8866 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8867 blocking lists should be done in a case-independent manner. Since most address
8868 lists in Exim are used for this kind of control, Exim attempts to do this by
8869 default.
8870
8871 The domain portion of an address is always lowercased before matching it to an
8872 address list. The local part is lowercased by default, and any string
8873 comparisons that take place are done caselessly. This means that the data in
8874 the address list itself, in files included as plain file names, and in any file
8875 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8876 keys in files that are looked up by a search type other than &(lsearch)& (which
8877 works caselessly) must be in lower case, because these lookups are not
8878 case-independent.
8879
8880 .cindex "&`+caseful`&"
8881 To allow for the possibility of caseful address list matching, if an item in
8882 an address list is the string &"+caseful"&, the original case of the local
8883 part is restored for any comparisons that follow, and string comparisons are no
8884 longer case-independent. This does not affect the domain, which remains in
8885 lower case. However, although independent matches on the domain alone are still
8886 performed caselessly, regular expressions that match against an entire address
8887 become case-sensitive after &"+caseful"& has been seen.
8888
8889
8890
8891 .section "Local part lists" "SECTlocparlis"
8892 .cindex "list" "local part list"
8893 .cindex "local part" "list"
8894 Case-sensitivity in local part lists is handled in the same way as for address
8895 lists, as just described. The &"+caseful"& item can be used if required. In a
8896 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8897 set false, the subject is lowercased and the matching is initially
8898 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8899 matching in the local part list, but not elsewhere in the router. If
8900 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8901 option is case-sensitive from the start.
8902
8903 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8904 comments are handled in the same way as address lists &-- they are recognized
8905 only if the # is preceded by white space or the start of the line.
8906 Otherwise, local part lists are matched in the same way as domain lists, except
8907 that the special items that refer to the local host (&`@`&, &`@[]`&,
8908 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8909 Refer to section &<<SECTdomainlist>>& for details of the other available item
8910 types.
8911 .ecindex IIDdohoadli
8912
8913
8914
8915
8916 . ////////////////////////////////////////////////////////////////////////////
8917 . ////////////////////////////////////////////////////////////////////////////
8918
8919 .chapter "String expansions" "CHAPexpand"
8920 .scindex IIDstrexp "expansion" "of strings"
8921 Many strings in Exim's run time configuration are expanded before use. Some of
8922 them are expanded every time they are used; others are expanded only once.
8923
8924 When a string is being expanded it is copied verbatim from left to right except
8925 when a dollar or backslash character is encountered. A dollar specifies the
8926 start of a portion of the string that is interpreted and replaced as described
8927 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8928 escape character, as described in the following section.
8929
8930 Whether a string is expanded depends upon the context.  Usually this is solely
8931 dependent upon the option for which a value is sought; in this documentation,
8932 options for which string expansion is performed are marked with &dagger; after
8933 the data type.  ACL rules always expand strings.  A couple of expansion
8934 conditions do not expand some of the brace-delimited branches, for security
8935 reasons.
8936
8937
8938
8939 .section "Literal text in expanded strings" "SECTlittext"
8940 .cindex "expansion" "including literal text"
8941 An uninterpreted dollar can be included in an expanded string by putting a
8942 backslash in front of it. A backslash can be used to prevent any special
8943 character being treated specially in an expansion, including backslash itself.
8944 If the string appears in quotes in the configuration file, two backslashes are
8945 required because the quotes themselves cause interpretation of backslashes when
8946 the string is read in (see section &<<SECTstrings>>&).
8947
8948 .cindex "expansion" "non-expandable substrings"
8949 A portion of the string can specified as non-expandable by placing it between
8950 two occurrences of &`\N`&. This is particularly useful for protecting regular
8951 expressions, which often contain backslashes and dollar signs. For example:
8952 .code
8953 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8954 .endd
8955 On encountering the first &`\N`&, the expander copies subsequent characters
8956 without interpretation until it reaches the next &`\N`& or the end of the
8957 string.
8958
8959
8960
8961 .section "Character escape sequences in expanded strings" "SECID82"
8962 .cindex "expansion" "escape sequences"
8963 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8964 expanded string is recognized as an escape sequence for the character newline,
8965 carriage return, or tab, respectively. A backslash followed by up to three
8966 octal digits is recognized as an octal encoding for a single character, and a
8967 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8968 encoding.
8969
8970 These escape sequences are also recognized in quoted strings when they are read
8971 in. Their interpretation in expansions as well is useful for unquoted strings,
8972 and for other cases such as looked-up strings that are then expanded.
8973
8974
8975 .section "Testing string expansions" "SECID83"
8976 .cindex "expansion" "testing"
8977 .cindex "testing" "string expansion"
8978 .oindex "&%-be%&"
8979 Many expansions can be tested by calling Exim with the &%-be%& option. This
8980 takes the command arguments, or lines from the standard input if there are no
8981 arguments, runs them through the string expansion code, and writes the results
8982 to the standard output. Variables based on configuration values are set up, but
8983 since no message is being processed, variables such as &$local_part$& have no
8984 value. Nevertheless the &%-be%& option can be useful for checking out file and
8985 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8986 and &%nhash%&.
8987
8988 Exim gives up its root privilege when it is called with the &%-be%& option, and
8989 instead runs under the uid and gid it was called with, to prevent users from
8990 using &%-be%& for reading files to which they do not have access.
8991
8992 .oindex "&%-bem%&"
8993 If you want to test expansions that include variables whose values are taken
8994 from a message, there are two other options that can be used. The &%-bem%&
8995 option is like &%-be%& except that it is followed by a file name. The file is
8996 read as a message before doing the test expansions. For example:
8997 .code
8998 exim -bem /tmp/test.message '$h_subject:'
8999 .endd
9000 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9001 Exim message identifier. For example:
9002 .code
9003 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9004 .endd
9005 This loads the message from Exim's spool before doing the test expansions, and
9006 is therefore restricted to admin users.
9007
9008
9009 .section "Forced expansion failure" "SECTforexpfai"
9010 .cindex "expansion" "forced failure"
9011 A number of expansions that are described in the following section have
9012 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9013 (which are sometimes called &"curly brackets"&). Which of the two strings is
9014 used depends on some condition that is evaluated as part of the expansion. If,
9015 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9016 the entire string expansion fails in a way that can be detected by the code
9017 that requested the expansion. This is called &"forced expansion failure"&, and
9018 its consequences depend on the circumstances. In some cases it is no different
9019 from any other expansion failure, but in others a different action may be
9020 taken. Such variations are mentioned in the documentation of the option that is
9021 being expanded.
9022
9023
9024
9025
9026 .section "Expansion items" "SECTexpansionitems"
9027 The following items are recognized in expanded strings. White space may be used
9028 between sub-items that are keywords or substrings enclosed in braces inside an
9029 outer set of braces, to improve readability. &*Warning*&: Within braces,
9030 white space is significant.
9031
9032 .vlist
9033 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9034 .cindex "expansion" "variables"
9035 Substitute the contents of the named variable, for example:
9036 .code
9037 $local_part
9038 ${domain}
9039 .endd
9040 The second form can be used to separate the name from subsequent alphanumeric
9041 characters. This form (using braces) is available only for variables; it does
9042 &'not'& apply to message headers. The names of the variables are given in
9043 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9044 given, the expansion fails.
9045
9046 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9047 .cindex "expansion" "operators"
9048 The string is first itself expanded, and then the operation specified by
9049 <&'op'&> is applied to it. For example:
9050 .code
9051 ${lc:$local_part}
9052 .endd
9053 The string starts with the first character after the colon, which may be
9054 leading white space. A list of operators is given in section &<<SECTexpop>>&
9055 below. The operator notation is used for simple expansion items that have just
9056 one argument, because it reduces the number of braces and therefore makes the
9057 string easier to understand.
9058
9059 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9060 This item inserts &"basic"& header lines. It is described with the &%header%&
9061 expansion item below.
9062
9063
9064 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9065 .cindex "expansion" "calling an acl"
9066 .cindex "&%acl%&" "call from expansion"
9067 The name and zero to nine argument strings are first expanded separately.  The expanded
9068 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9069 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9070 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9071 and may use the variables; if another acl expansion is used the values
9072 are restored after it returns.  If the ACL sets
9073 a value using a "message =" modifier and returns accept or deny, the value becomes
9074 the result of the expansion.
9075 If no message is set and the ACL returns accept or deny
9076 the expansion result is an empty string.
9077 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9078
9079
9080 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9081        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9082 .cindex "expansion" "extracting cerificate fields"
9083 .cindex "&%certextract%&" "certificate fields"
9084 .cindex "certificate" "extracting fields"
9085 The <&'certificate'&> must be a variable of type certificate.
9086 The field name is expanded and used to retrieve the relevant field from
9087 the certificate.  Supported fields are:
9088 .display
9089 &`version        `&
9090 &`serial_number  `&
9091 &`subject        `& RFC4514 DN
9092 &`issuer         `& RFC4514 DN
9093 &`notbefore      `& time
9094 &`notafter       `& time
9095 &`sig_algorithm  `&
9096 &`signature      `&
9097 &`subj_altname   `& tagged list
9098 &`ocsp_uri       `& list
9099 &`crl_uri        `& list
9100 .endd
9101 If the field is found,
9102 <&'string2'&> is expanded, and replaces the whole item;
9103 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9104 variable &$value$& contains the value that has been extracted. Afterwards, it
9105 is restored to any previous value it might have had.
9106
9107 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9108 key is not found. If {<&'string2'&>} is also omitted, the value that was
9109 extracted is used.
9110
9111 Some field names take optional modifiers, appended and separated by commas.
9112
9113 The field selectors marked as "RFC4514" above
9114 output a Distinguished Name string which is
9115 not quite
9116 parseable by Exim as a comma-separated tagged list
9117 (the exceptions being elements containing commas).
9118 RDN elements of a single type may be selected by
9119 a modifier of the type label; if so the expansion
9120 result is a list (newline-separated by default).
9121 The separator may be changed by another modifier of
9122 a right angle-bracket followed immediately by the new separator.
9123 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9124
9125 The field selectors marked as "time" above
9126 take an optional modifier of "int"
9127 for which the result is the number of seconds since epoch.
9128 Otherwise the result is a human-readable string
9129 in the timezone selected by the main "timezone" option.
9130
9131 The field selectors marked as "list" above return a list,
9132 newline-separated by default,
9133 (embedded separator characters in elements are doubled).
9134 The separator may be changed by a modifier of
9135 a right angle-bracket followed immediately by the new separator.
9136
9137 The field selectors marked as "tagged" above
9138 prefix each list element with a type string and an equals sign.
9139 Elements of only one type may be selected by a modifier
9140 which is one of "dns", "uri" or "mail";
9141 if so the element tags are omitted.
9142
9143 If not otherwise noted field values are presented in human-readable form.
9144
9145 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9146        {*&<&'arg'&>&*}...}*&"
9147 .cindex &%dlfunc%&
9148 This expansion dynamically loads and then calls a locally-written C function.
9149 This functionality is available only if Exim is compiled with
9150 .code
9151 EXPAND_DLFUNC=yes
9152 .endd
9153 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9154 object so that it doesn't reload the same object file in the same Exim process
9155 (but of course Exim does start new processes frequently).
9156
9157 There may be from zero to eight arguments to the function. When compiling
9158 a local function that is to be called in this way, &_local_scan.h_& should be
9159 included. The Exim variables and functions that are defined by that API
9160 are also available for dynamically loaded functions. The function itself
9161 must have the following type:
9162 .code
9163 int dlfunction(uschar **yield, int argc, uschar *argv[])
9164 .endd
9165 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9166 function should return one of the following values:
9167
9168 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9169 into the expanded string that is being built.
9170
9171 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9172 from &'yield'&, if it is set.
9173
9174 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9175 taken from &'yield'& if it is set.
9176
9177 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9178
9179 When compiling a function that is to be used in this way with gcc,
9180 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9181 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9182
9183
9184 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9185 .cindex "expansion" "extracting value from environment"
9186 .cindex "environment" "values from"
9187 The key is first expanded separately, and leading and trailing white space
9188 removed.
9189 This is then searched for as a name in the environment.
9190 If a variable is found then its value is placed in &$value$&
9191 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9192
9193 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9194 appear, for example:
9195 .code
9196 ${env{USER}{$value} fail }
9197 .endd
9198 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9199 {<&'string1'&>} must be present for &"fail"& to be recognized.
9200
9201 If {<&'string2'&>} is omitted an empty string is substituted on
9202 search failure.
9203 If {<&'string1'&>} is omitted the search result is substituted on
9204 search success.
9205
9206 The environment is adjusted by the &%keep_environment%& and
9207 &%add_environment%& main section options.
9208
9209
9210 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9211        {*&<&'string3'&>&*}}*&"
9212 .cindex "expansion" "extracting substrings by key"
9213 .cindex "&%extract%&" "substrings by key"
9214 The key and <&'string1'&> are first expanded separately. Leading and trailing
9215 white space is removed from the key (but not from any of the strings). The key
9216 must not be empty and must not consist entirely of digits.
9217 The expanded <&'string1'&> must be of the form:
9218 .display
9219 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9220 .endd
9221 .vindex "&$value$&"
9222 where the equals signs and spaces (but not both) are optional. If any of the
9223 values contain white space, they must be enclosed in double quotes, and any
9224 values that are enclosed in double quotes are subject to escape processing as
9225 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9226 for the value that corresponds to the key. The search is case-insensitive. If
9227 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9228 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9229 variable &$value$& contains the value that has been extracted. Afterwards, it
9230 is restored to any previous value it might have had.
9231
9232 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9233 key is not found. If {<&'string2'&>} is also omitted, the value that was
9234 extracted is used. Thus, for example, these two expansions are identical, and
9235 yield &"2001"&:
9236 .code
9237 ${extract{gid}{uid=1984 gid=2001}}
9238 ${extract{gid}{uid=1984 gid=2001}{$value}}
9239 .endd
9240 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9241 appear, for example:
9242 .code
9243 ${extract{Z}{A=... B=...}{$value} fail }
9244 .endd
9245 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9246 {<&'string2'&>} must be present for &"fail"& to be recognized.
9247
9248
9249 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9250         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9251 .cindex "expansion" "extracting substrings by number"
9252 .cindex "&%extract%&" "substrings by number"
9253 The <&'number'&> argument must consist entirely of decimal digits,
9254 apart from leading and trailing white space, which is ignored.
9255 This is what distinguishes this form of &%extract%& from the previous kind. It
9256 behaves in the same way, except that, instead of extracting a named field, it
9257 extracts from <&'string1'&> the field whose number is given as the first
9258 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9259 <&'string3'&> as before.
9260
9261 The fields in the string are separated by any one of the characters in the
9262 separator string. These may include space or tab characters.
9263 The first field is numbered one. If the number is negative, the fields are
9264 counted from the end of the string, with the rightmost one numbered -1. If the
9265 number given is zero, the entire string is returned. If the modulus of the
9266 number is greater than the number of fields in the string, the result is the
9267 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9268 provided. For example:
9269 .code
9270 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9271 .endd
9272 yields &"42"&, and
9273 .code
9274 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9275 .endd
9276 yields &"99"&. Two successive separators mean that the field between them is
9277 empty (for example, the fifth field above).
9278
9279
9280 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9281 .cindex "list" "selecting by condition"
9282 .cindex "expansion" "selecting from list by condition"
9283 .vindex "&$item$&"
9284 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9285 default, but the separator can be changed in the usual way. For each item
9286 in this list, its value is place in &$item$&, and then the condition is
9287 evaluated. If the condition is true, &$item$& is added to the output as an
9288 item in a new list; if the condition is false, the item is discarded. The
9289 separator used for the output list is the same as the one used for the
9290 input, but a separator setting is not included in the output. For example:
9291 .code
9292 ${filter{a:b:c}{!eq{$item}{b}}
9293 .endd
9294 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9295 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9296
9297
9298 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9299 .cindex "hash function" "textual"
9300 .cindex "expansion" "textual hash"
9301 This is a textual hashing function, and was the first to be implemented in
9302 early versions of Exim. In current releases, there are other hashing functions
9303 (numeric, MD5, and SHA-1), which are described below.
9304
9305 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9306 <&'n'&>. If you are using fixed values for these numbers, that is, if
9307 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9308 use the simpler operator notation that avoids some of the braces:
9309 .code
9310 ${hash_<n>_<m>:<string>}
9311 .endd
9312 The second number is optional (in both notations). If <&'n'&> is greater than
9313 or equal to the length of the string, the expansion item returns the string.
9314 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9315 function to the string. The new string consists of characters taken from the
9316 first <&'m'&> characters of the string
9317 .code
9318 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9319 .endd
9320 If <&'m'&> is not present the value 26 is used, so that only lower case
9321 letters appear. For example:
9322 .display
9323 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9324 &`$hash{5}{monty}}           `&   yields  &`monty`&
9325 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9326 .endd
9327
9328 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9329         &*$h_*&<&'header&~name'&>&*:*&" &&&
9330        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9331         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9332        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9333         &*$rh_*&<&'header&~name'&>&*:*&"
9334 .cindex "expansion" "header insertion"
9335 .vindex "&$header_$&"
9336 .vindex "&$bheader_$&"
9337 .vindex "&$rheader_$&"
9338 .cindex "header lines" "in expansion strings"
9339 .cindex "header lines" "character sets"
9340 .cindex "header lines" "decoding"
9341 Substitute the contents of the named message header line, for example
9342 .code
9343 $header_reply-to:
9344 .endd
9345 The newline that terminates a header line is not included in the expansion, but
9346 internal newlines (caused by splitting the header line over several physical
9347 lines) may be present.
9348
9349 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9350 the data in the header line is interpreted.
9351
9352 .ilist
9353 .cindex "white space" "in header lines"
9354 &%rheader%& gives the original &"raw"& content of the header line, with no
9355 processing at all, and without the removal of leading and trailing white space.
9356
9357 .next
9358 .cindex "base64 encoding" "in header lines"
9359 &%bheader%& removes leading and trailing white space, and then decodes base64
9360 or quoted-printable MIME &"words"& within the header text, but does no
9361 character set translation. If decoding of what looks superficially like a MIME
9362 &"word"& fails, the raw string is returned. If decoding
9363 .cindex "binary zero" "in header line"
9364 produces a binary zero character, it is replaced by a question mark &-- this is
9365 what Exim does for binary zeros that are actually received in header lines.
9366
9367 .next
9368 &%header%& tries to translate the string as decoded by &%bheader%& to a
9369 standard character set. This is an attempt to produce the same string as would
9370 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9371 returned. Translation is attempted only on operating systems that support the
9372 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9373 a system Makefile or in &_Local/Makefile_&.
9374 .endlist ilist
9375
9376 In a filter file, the target character set for &%header%& can be specified by a
9377 command of the following form:
9378 .code
9379 headers charset "UTF-8"
9380 .endd
9381 This command affects all references to &$h_$& (or &$header_$&) expansions in
9382 subsequently obeyed filter commands. In the absence of this command, the target
9383 character set in a filter is taken from the setting of the &%headers_charset%&
9384 option in the runtime configuration. The value of this option defaults to the
9385 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9386 ISO-8859-1.
9387
9388 Header names follow the syntax of RFC 2822, which states that they may contain
9389 any printing characters except space and colon. Consequently, curly brackets
9390 &'do not'& terminate header names, and should not be used to enclose them as
9391 if they were variables. Attempting to do so causes a syntax error.
9392
9393 Only header lines that are common to all copies of a message are visible to
9394 this mechanism. These are the original header lines that are received with the
9395 message, and any that are added by an ACL statement or by a system
9396 filter. Header lines that are added to a particular copy of a message by a
9397 router or transport are not accessible.
9398
9399 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9400 before the DATA ACL, because the header structure is not set up until the
9401 message is received. Header lines that are added in a RCPT ACL (for example)
9402 are saved until the message's incoming header lines are available, at which
9403 point they are added. When a DATA ACL is running, however, header lines added
9404 by earlier ACLs are visible.
9405
9406 Upper case and lower case letters are synonymous in header names. If the
9407 following character is white space, the terminating colon may be omitted, but
9408 this is not recommended, because you may then forget it when it is needed. When
9409 white space terminates the header name, this white space is included in the
9410 expanded string.  If the message does not contain the given header, the
9411 expansion item is replaced by an empty string. (See the &%def%& condition in
9412 section &<<SECTexpcond>>& for a means of testing for the existence of a
9413 header.)
9414
9415 If there is more than one header with the same name, they are all concatenated
9416 to form the substitution string, up to a maximum length of 64K. Unless
9417 &%rheader%& is being used, leading and trailing white space is removed from
9418 each header before concatenation, and a completely empty header is ignored. A
9419 newline character is then inserted between non-empty headers, but there is no
9420 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9421 those headers that contain lists of addresses, a comma is also inserted at the
9422 junctions between headers. This does not happen for the &%rheader%& expansion.
9423
9424
9425 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9426 .cindex "expansion" "hmac hashing"
9427 .cindex &%hmac%&
9428 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9429 shared secret and some text into a message authentication code, as specified in
9430 RFC 2104. This differs from &`${md5:secret_text...}`& or
9431 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9432 cryptographic hash, allowing for authentication that is not possible with MD5
9433 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9434 present. For example:
9435 .code
9436 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9437 .endd
9438 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9439 produces:
9440 .code
9441 dd97e3ba5d1a61b5006108f8c8252953
9442 .endd
9443 As an example of how this might be used, you might put in the main part of
9444 an Exim configuration:
9445 .code
9446 SPAMSCAN_SECRET=cohgheeLei2thahw
9447 .endd
9448 In a router or a transport you could then have:
9449 .code
9450 headers_add = \
9451   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9452   ${hmac{md5}{SPAMSCAN_SECRET}\
9453   {${primary_hostname},${message_exim_id},$h_message-id:}}
9454 .endd
9455 Then given a message, you can check where it was scanned by looking at the
9456 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9457 this header line is authentic by recomputing the authentication code from the
9458 host name, message ID and the &'Message-id:'& header line. This can be done
9459 using Exim's &%-be%& option, or by other means, for example by using the
9460 &'hmac_md5_hex()'& function in Perl.
9461
9462
9463 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9464 .cindex "expansion" "conditional"
9465 .cindex "&%if%&, expansion item"
9466 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9467 item; otherwise <&'string2'&> is used. The available conditions are described
9468 in section &<<SECTexpcond>>& below. For example:
9469 .code
9470 ${if eq {$local_part}{postmaster} {yes}{no} }
9471 .endd
9472 The second string need not be present; if it is not and the condition is not
9473 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9474 be present instead of the second string (without any curly brackets). In this
9475 case, the expansion is forced to fail if the condition is not true (see section
9476 &<<SECTforexpfai>>&).
9477
9478 If both strings are omitted, the result is the string &`true`& if the condition
9479 is true, and the empty string if the condition is false. This makes it less
9480 cumbersome to write custom ACL and router conditions. For example, instead of
9481 .code
9482 condition = ${if >{$acl_m4}{3}{true}{false}}
9483 .endd
9484 you can use
9485 .code
9486 condition = ${if >{$acl_m4}{3}}
9487 .endd
9488
9489
9490
9491 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9492 .cindex expansion "imap folder"
9493 .cindex "&%imapfolder%& expansion item"
9494 This item converts a (possibly multilevel, or with non-ASCII characters)
9495 folder specification to a Maildir name for filesystem use.
9496 For information on internationalisation support see &<<SECTi18nMDA>>&.
9497
9498
9499
9500 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9501 .cindex "expansion" "string truncation"
9502 .cindex "&%length%& expansion item"
9503 The &%length%& item is used to extract the initial portion of a string. Both
9504 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9505 you are using a fixed value for the number, that is, if <&'string1'&> does not
9506 change when expanded, you can use the simpler operator notation that avoids
9507 some of the braces:
9508 .code
9509 ${length_<n>:<string>}
9510 .endd
9511 The result of this item is either the first <&'n'&> characters or the whole
9512 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9513 &%strlen%&, which gives the length of a string.
9514
9515
9516 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9517         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9518 .cindex "expansion" "extracting list elements by number"
9519 .cindex "&%listextract%&" "extract list elements by number"
9520 .cindex "list" "extracting elements by number"
9521 The <&'number'&> argument must consist entirely of decimal digits,
9522 apart from an optional leading minus,
9523 and leading and trailing white space (which is ignored).
9524
9525 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9526 default, but the separator can be changed in the usual way.
9527
9528 The first field of the list is numbered one.
9529 If the number is negative, the fields are
9530 counted from the end of the list, with the rightmost one numbered -1.
9531 The numbered element of the list is extracted and placed in &$value$&,
9532 then <&'string2'&> is expanded as the result.
9533
9534 If the modulus of the
9535 number is zero or greater than the number of fields in the string,
9536 the result is the expansion of <&'string3'&>.
9537
9538 For example:
9539 .code
9540 ${listextract{2}{x:42:99}}
9541 .endd
9542 yields &"42"&, and
9543 .code
9544 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9545 .endd
9546 yields &"result: 42"&.
9547
9548 If {<&'string3'&>} is omitted, an empty string is used for string3.
9549 If {<&'string2'&>} is also omitted, the value that was
9550 extracted is used.
9551 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9552
9553
9554 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9555         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9556 This is the first of one of two different types of lookup item, which are both
9557 described in the next item.
9558
9559 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9560         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9561 .cindex "expansion" "lookup in"
9562 .cindex "file" "lookups"
9563 .cindex "lookup" "in expanded string"
9564 The two forms of lookup item specify data lookups in files and databases, as
9565 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9566 lookups, and the second is used for query-style lookups. The <&'key'&>,
9567 <&'file'&>, and <&'query'&> strings are expanded before use.
9568
9569 If there is any white space in a lookup item which is part of a filter command,
9570 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9571 other place where white space is significant, the lookup item must be enclosed
9572 in double quotes. The use of data lookups in users' filter files may be locked
9573 out by the system administrator.
9574
9575 .vindex "&$value$&"
9576 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9577 During its expansion, the variable &$value$& contains the data returned by the
9578 lookup. Afterwards it reverts to the value it had previously (at the outer
9579 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9580 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9581 string on failure. If <&'string2'&> is provided, it can itself be a nested
9582 lookup, thus providing a mechanism for looking up a default value when the
9583 original lookup fails.
9584
9585 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9586 data for the outer lookup while the parameters of the second lookup are
9587 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9588 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9589 appear, and in this case, if the lookup fails, the entire expansion is forced
9590 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9591 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9592 successful lookup, and nothing in the case of failure.
9593
9594 For single-key lookups, the string &"partial"& is permitted to precede the
9595 search type in order to do partial matching, and * or *@ may follow a search
9596 type to request default lookups if the key does not match (see sections
9597 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9598
9599 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9600 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9601 and non-wild parts of the key during the expansion of the replacement text.
9602 They return to their previous values at the end of the lookup item.
9603
9604 This example looks up the postmaster alias in the conventional alias file:
9605 .code
9606 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9607 .endd
9608 This example uses NIS+ to look up the full name of the user corresponding to
9609 the local part of an address, forcing the expansion to fail if it is not found:
9610 .code
9611 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9612   {$value}fail}
9613 .endd
9614
9615
9616 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9617 .cindex "expansion" "list creation"
9618 .vindex "&$item$&"
9619 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9620 default, but the separator can be changed in the usual way. For each item
9621 in this list, its value is place in &$item$&, and then <&'string2'&> is
9622 expanded and added to the output as an item in a new list. The separator used
9623 for the output list is the same as the one used for the input, but a separator
9624 setting is not included in the output. For example:
9625 .code
9626 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9627 .endd
9628 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9629 value of &$item$& is restored to what it was before. See also the &*filter*&
9630 and &*reduce*& expansion items.
9631
9632 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9633 .cindex "expansion" "numeric hash"
9634 .cindex "hash function" "numeric"
9635 The three strings are expanded; the first two must yield numbers. Call them
9636 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9637 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9638 can use the simpler operator notation that avoids some of the braces:
9639 .code
9640 ${nhash_<n>_<m>:<string>}
9641 .endd
9642 The second number is optional (in both notations). If there is only one number,
9643 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9644 processed by a div/mod hash function that returns two numbers, separated by a
9645 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9646 example,
9647 .code
9648 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9649 .endd
9650 returns the string &"6/33"&.
9651
9652
9653
9654 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9655 .cindex "Perl" "use in expanded string"
9656 .cindex "expansion" "calling Perl from"
9657 This item is available only if Exim has been built to include an embedded Perl
9658 interpreter. The subroutine name and the arguments are first separately
9659 expanded, and then the Perl subroutine is called with those arguments. No
9660 additional arguments need be given; the maximum number permitted, including the
9661 name of the subroutine, is nine.
9662
9663 The return value of the subroutine is inserted into the expanded string, unless
9664 the return value is &%undef%&. In that case, the expansion fails in the same
9665 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9666 Whatever you return is evaluated in a scalar context. For example, if you
9667 return the name of a Perl vector, the return value is the size of the vector,
9668 not its contents.
9669
9670 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9671 with the error message that was passed to &%die%&. More details of the embedded
9672 Perl facility are given in chapter &<<CHAPperl>>&.
9673
9674 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9675 out the use of this expansion item in filter files.
9676
9677
9678 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9679 .cindex "&%prvs%& expansion item"
9680 The first argument is a complete email address and the second is secret
9681 keystring. The third argument, specifying a key number, is optional. If absent,
9682 it defaults to 0. The result of the expansion is a prvs-signed email address,
9683 to be typically used with the &%return_path%& option on an &(smtp)& transport
9684 as part of a bounce address tag validation (BATV) scheme. For more discussion
9685 and an example, see section &<<SECTverifyPRVS>>&.
9686
9687 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9688         {*&<&'string'&>&*}}*&"
9689 .cindex "&%prvscheck%& expansion item"
9690 This expansion item is the complement of the &%prvs%& item. It is used for
9691 checking prvs-signed addresses. If the expansion of the first argument does not
9692 yield a syntactically valid prvs-signed address, the whole item expands to the
9693 empty string. When the first argument does expand to a syntactically valid
9694 prvs-signed address, the second argument is expanded, with the prvs-decoded
9695 version of the address and the key number extracted from the address in the
9696 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9697
9698 These two variables can be used in the expansion of the second argument to
9699 retrieve the secret. The validity of the prvs-signed address is then checked
9700 against the secret. The result is stored in the variable &$prvscheck_result$&,
9701 which is empty for failure or &"1"& for success.
9702
9703 The third argument is optional; if it is missing, it defaults to an empty
9704 string. This argument is now expanded. If the result is an empty string, the
9705 result of the expansion is the decoded version of the address. This is the case
9706 whether or not the signature was valid. Otherwise, the result of the expansion
9707 is the expansion of the third argument.
9708
9709 All three variables can be used in the expansion of the third argument.
9710 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9711 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9712
9713 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9714 .cindex "expansion" "inserting an entire file"
9715 .cindex "file" "inserting into expansion"
9716 .cindex "&%readfile%& expansion item"
9717 The file name and end-of-line string are first expanded separately. The file is
9718 then read, and its contents replace the entire item. All newline characters in
9719 the file are replaced by the end-of-line string if it is present. Otherwise,
9720 newlines are left in the string.
9721 String expansion is not applied to the contents of the file. If you want this,
9722 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9723 the string expansion fails.
9724
9725 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9726 locks out the use of this expansion item in filter files.
9727
9728
9729
9730 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9731         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9732 .cindex "expansion" "inserting from a socket"
9733 .cindex "socket, use of in expansion"
9734 .cindex "&%readsocket%& expansion item"
9735 This item inserts data from a Unix domain or TCP socket into the expanded
9736 string. The minimal way of using it uses just two arguments, as in these
9737 examples:
9738 .code
9739 ${readsocket{/socket/name}{request string}}
9740 ${readsocket{inet:some.host:1234}{request string}}
9741 .endd
9742 For a Unix domain socket, the first substring must be the path to the socket.
9743 For an Internet socket, the first substring must contain &`inet:`& followed by
9744 a host name or IP address, followed by a colon and a port, which can be a
9745 number or the name of a TCP port in &_/etc/services_&. An IP address may
9746 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9747 example:
9748 .code
9749 ${readsocket{inet:[::1]:1234}{request string}}
9750 .endd
9751 Only a single host name may be given, but if looking it up yields more than
9752 one IP address, they are each tried in turn until a connection is made. For
9753 both kinds of socket, Exim makes a connection, writes the request string
9754 unless it is an empty string; and no terminating NUL is ever sent)
9755 and reads from the socket until an end-of-file
9756 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9757 extend what can be done. Firstly, you can vary the timeout. For example:
9758 .code
9759 ${readsocket{/socket/name}{request string}{3s}}
9760 .endd
9761 A fourth argument allows you to change any newlines that are in the data
9762 that is read, in the same way as for &%readfile%& (see above). This example
9763 turns them into spaces:
9764 .code
9765 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9766 .endd
9767 As with all expansions, the substrings are expanded before the processing
9768 happens. Errors in these sub-expansions cause the expansion to fail. In
9769 addition, the following errors can occur:
9770
9771 .ilist
9772 Failure to create a socket file descriptor;
9773 .next
9774 Failure to connect the socket;
9775 .next
9776 Failure to write the request string;
9777 .next
9778 Timeout on reading from the socket.
9779 .endlist
9780
9781 By default, any of these errors causes the expansion to fail. However, if
9782 you supply a fifth substring, it is expanded and used when any of the above
9783 errors occurs. For example:
9784 .code
9785 ${readsocket{/socket/name}{request string}{3s}{\n}\
9786   {socket failure}}
9787 .endd
9788 You can test for the existence of a Unix domain socket by wrapping this
9789 expansion in &`${if exists`&, but there is a race condition between that test
9790 and the actual opening of the socket, so it is safer to use the fifth argument
9791 if you want to be absolutely sure of avoiding an expansion error for a
9792 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9793
9794 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9795 locks out the use of this expansion item in filter files.
9796
9797
9798 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9799 .cindex "expansion" "reducing a list to a scalar"
9800 .cindex "list" "reducing to a scalar"
9801 .vindex "&$value$&"
9802 .vindex "&$item$&"
9803 This operation reduces a list to a single, scalar string. After expansion,
9804 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9805 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9806 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9807 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9808 them. The result of that expansion is assigned to &$value$& before the next
9809 iteration. When the end of the list is reached, the final value of &$value$& is
9810 added to the expansion output. The &*reduce*& expansion item can be used in a
9811 number of ways. For example, to add up a list of numbers:
9812 .code
9813 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9814 .endd
9815 The result of that expansion would be &`6`&. The maximum of a list of numbers
9816 can be found:
9817 .code
9818 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9819 .endd
9820 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9821 restored to what they were before. See also the &*filter*& and &*map*&
9822 expansion items.
9823
9824 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9825 This item inserts &"raw"& header lines. It is described with the &%header%&
9826 expansion item above.
9827
9828 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9829         {*&<&'string2'&>&*}}*&"
9830 .cindex "expansion" "running a command"
9831 .cindex "&%run%& expansion item"
9832 The command and its arguments are first expanded as one string. The string is
9833 split apart into individual arguments by spaces, and then the command is run
9834 in a separate process, but under the same uid and gid.  As in other command
9835 executions from Exim, a shell is not used by default. If the command requires
9836 a shell, you must explicitly code it.
9837
9838 Since the arguments are split by spaces, when there is a variable expansion
9839 which has an empty result, it will cause the situation that the argument will
9840 simply be omitted when the program is actually executed by Exim. If the
9841 script/program requires a specific number of arguments and the expanded
9842 variable could possibly result in this empty expansion, the variable must be
9843 quoted. This is more difficult if the expanded variable itself could result
9844 in a string containing quotes, because it would interfere with the quotes
9845 around the command arguments. A possible guard against this is to wrap the
9846 variable in the &%sg%& operator to change any quote marks to some other
9847 character.
9848
9849 The standard input for the command exists, but is empty. The standard output
9850 and standard error are set to the same file descriptor.
9851 .cindex "return code" "from &%run%& expansion"
9852 .vindex "&$value$&"
9853 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9854 and replaces the entire item; during this expansion, the standard output/error
9855 from the command is in the variable &$value$&. If the command fails,
9856 <&'string2'&>, if present, is expanded and used. Once again, during the
9857 expansion, the standard output/error from the command is in the variable
9858 &$value$&.
9859
9860 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9861 can be the word &"fail"& (not in braces) to force expansion failure if the
9862 command does not succeed. If both strings are omitted, the result is contents
9863 of the standard output/error on success, and nothing on failure.
9864
9865 .vindex "&$run_in_acl$&"
9866 The standard output/error of the command is put in the variable &$value$&.
9867 In this ACL example, the output of a command is logged for the admin to
9868 troubleshoot:
9869 .code
9870 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9871       log_message  = Output of id: $value
9872 .endd
9873 If the command requires shell idioms, such as the > redirect operator, the
9874 shell must be invoked directly, such as with:
9875 .code
9876 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9877 .endd
9878
9879 .vindex "&$runrc$&"
9880 The return code from the command is put in the variable &$runrc$&, and this
9881 remains set afterwards, so in a filter file you can do things like this:
9882 .code
9883 if "${run{x y z}{}}$runrc" is 1 then ...
9884   elif $runrc is 2 then ...
9885   ...
9886 endif
9887 .endd
9888 If execution of the command fails (for example, the command does not exist),
9889 the return code is 127 &-- the same code that shells use for non-existent
9890 commands.
9891
9892 &*Warning*&: In a router or transport, you cannot assume the order in which
9893 option values are expanded, except for those preconditions whose order of
9894 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9895 by the expansion of one option, and use it in another.
9896
9897 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9898 out the use of this expansion item in filter files.
9899
9900
9901 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9902 .cindex "expansion" "string substitution"
9903 .cindex "&%sg%& expansion item"
9904 This item works like Perl's substitution operator (s) with the global (/g)
9905 option; hence its name. However, unlike the Perl equivalent, Exim does not
9906 modify the subject string; instead it returns the modified string for insertion
9907 into the overall expansion. The item takes three arguments: the subject string,
9908 a regular expression, and a substitution string. For example:
9909 .code
9910 ${sg{abcdefabcdef}{abc}{xyz}}
9911 .endd
9912 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9913 if any $ or \ characters are required in the regular expression or in the
9914 substitution string, they have to be escaped. For example:
9915 .code
9916 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9917 .endd
9918 yields &"defabc"&, and
9919 .code
9920 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9921 .endd
9922 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9923 the regular expression from string expansion.
9924
9925
9926
9927 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9928 .cindex sorting "a list"
9929 .cindex list sorting
9930 .cindex expansion "list sorting"
9931 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9932 default, but the separator can be changed in the usual way.
9933 The <&'comparator'&> argument is interpreted as the operator
9934 of a two-argument expansion condition.
9935 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9936 The comparison should return true when applied to two values
9937 if the first value should sort before the second value.
9938 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9939 the element being placed in &$item$&,
9940 to give values for comparison.
9941
9942 The item result is a sorted list,
9943 with the original list separator,
9944 of the list elements (in full) of the original.
9945
9946 Examples:
9947 .code
9948 ${sort{3:2:1:4}{<}{$item}}
9949 .endd
9950 sorts a list of numbers, and
9951 .code
9952 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9953 .endd
9954 will sort an MX lookup into priority order.
9955
9956
9957 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9958 .cindex "&%substr%& expansion item"
9959 .cindex "substring extraction"
9960 .cindex "expansion" "substring extraction"
9961 The three strings are expanded; the first two must yield numbers. Call them
9962 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9963 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9964 can use the simpler operator notation that avoids some of the braces:
9965 .code
9966 ${substr_<n>_<m>:<string>}
9967 .endd
9968 The second number is optional (in both notations).
9969 If it is absent in the simpler format, the preceding underscore must also be
9970 omitted.
9971
9972 The &%substr%& item can be used to extract more general substrings than
9973 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9974 length required. For example
9975 .code
9976 ${substr{3}{2}{$local_part}}
9977 .endd
9978 If the starting offset is greater than the string length the result is the
9979 null string; if the length plus starting offset is greater than the string
9980 length, the result is the right-hand part of the string, starting from the
9981 given offset. The first character in the string has offset zero.
9982
9983 The &%substr%& expansion item can take negative offset values to count
9984 from the right-hand end of its operand. The last character is offset -1, the
9985 second-last is offset -2, and so on. Thus, for example,
9986 .code
9987 ${substr{-5}{2}{1234567}}
9988 .endd
9989 yields &"34"&. If the absolute value of a negative offset is greater than the
9990 length of the string, the substring starts at the beginning of the string, and
9991 the length is reduced by the amount of overshoot. Thus, for example,
9992 .code
9993 ${substr{-5}{2}{12}}
9994 .endd
9995 yields an empty string, but
9996 .code
9997 ${substr{-3}{2}{12}}
9998 .endd
9999 yields &"1"&.
10000
10001 When the second number is omitted from &%substr%&, the remainder of the string
10002 is taken if the offset is positive. If it is negative, all characters in the
10003 string preceding the offset point are taken. For example, an offset of -1 and
10004 no length, as in these semantically identical examples:
10005 .code
10006 ${substr_-1:abcde}
10007 ${substr{-1}{abcde}}
10008 .endd
10009 yields all but the last character of the string, that is, &"abcd"&.
10010
10011
10012
10013 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10014         {*&<&'replacements'&>&*}}*&"
10015 .cindex "expansion" "character translation"
10016 .cindex "&%tr%& expansion item"
10017 This item does single-character translation on its subject string. The second
10018 argument is a list of characters to be translated in the subject string. Each
10019 matching character is replaced by the corresponding character from the
10020 replacement list. For example
10021 .code
10022 ${tr{abcdea}{ac}{13}}
10023 .endd
10024 yields &`1b3de1`&. If there are duplicates in the second character string, the
10025 last occurrence is used. If the third string is shorter than the second, its
10026 last character is replicated. However, if it is empty, no translation takes
10027 place.
10028 .endlist
10029
10030
10031
10032 .section "Expansion operators" "SECTexpop"
10033 .cindex "expansion" "operators"
10034 For expansion items that perform transformations on a single argument string,
10035 the &"operator"& notation is used because it is simpler and uses fewer braces.
10036 The substring is first expanded before the operation is applied to it. The
10037 following operations can be performed:
10038
10039 .vlist
10040 .vitem &*${address:*&<&'string'&>&*}*&
10041 .cindex "expansion" "RFC 2822 address handling"
10042 .cindex "&%address%& expansion item"
10043 The string is interpreted as an RFC 2822 address, as it might appear in a
10044 header line, and the effective address is extracted from it. If the string does
10045 not parse successfully, the result is empty.
10046
10047
10048 .vitem &*${addresses:*&<&'string'&>&*}*&
10049 .cindex "expansion" "RFC 2822 address handling"
10050 .cindex "&%addresses%& expansion item"
10051 The string (after expansion) is interpreted as a list of addresses in RFC
10052 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10053 operative address (&'local-part@domain'&) is extracted from each item, and the
10054 result of the expansion is a colon-separated list, with appropriate
10055 doubling of colons should any happen to be present in the email addresses.
10056 Syntactically invalid RFC2822 address items are omitted from the output.
10057
10058 It is possible to specify a character other than colon for the output
10059 separator by starting the string with > followed by the new separator
10060 character. For example:
10061 .code
10062 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10063 .endd
10064 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10065 expansion item, which extracts the working address from a single RFC2822
10066 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10067 processing lists.
10068
10069 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10070 a strict interpretation of header line formatting.  Exim parses the bare,
10071 unquoted portion of an email address and if it finds a comma, treats it as an
10072 email address separator. For the example header line:
10073 .code
10074 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10075 .endd
10076 The first example below demonstrates that Q-encoded email addresses are parsed
10077 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10078 It does not see the comma because it's still encoded as "=2C".  The second
10079 example below is passed the contents of &`$header_from:`&, meaning it gets
10080 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10081 The third example shows that the presence of a comma is skipped when it is
10082 quoted.
10083 .code
10084 # exim -be '${addresses:From: \
10085 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10086 user@example.com
10087 # exim -be '${addresses:From: Last, First <user@example.com>}'
10088 Last:user@example.com
10089 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10090 user@example.com
10091 .endd
10092
10093 .new
10094 .vitem &*${base32:*&<&'digits'&>&*}*&
10095 .cindex "&%base32%& expansion item"
10096 .cindex "expansion" "conversion to base 32"
10097 The string must consist entirely of decimal digits. The number is converted to
10098 base 32 and output as a (empty, for zero) string of characters.
10099 Only lowercase letters are used.
10100
10101 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10102 .cindex "&%base32d%& expansion item"
10103 .cindex "expansion" "conversion to base 32"
10104 The string must consist entirely of base-32 digits.
10105 The number is converted to decimal and output as a string.
10106 .wen
10107
10108 .vitem &*${base62:*&<&'digits'&>&*}*&
10109 .cindex "&%base62%& expansion item"
10110 .cindex "expansion" "conversion to base 62"
10111 The string must consist entirely of decimal digits. The number is converted to
10112 base 62 and output as a string of six characters, including leading zeros. In
10113 the few operating environments where Exim uses base 36 instead of base 62 for
10114 its message identifiers (because those systems do not have case-sensitive file
10115 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10116 be absolutely clear: this is &'not'& base64 encoding.
10117
10118 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10119 .cindex "&%base62d%& expansion item"
10120 .cindex "expansion" "conversion to base 62"
10121 The string must consist entirely of base-62 digits, or, in operating
10122 environments where Exim uses base 36 instead of base 62 for its message
10123 identifiers, base-36 digits. The number is converted to decimal and output as a
10124 string.
10125
10126 .vitem &*${base64:*&<&'string'&>&*}*&
10127 .cindex "expansion" "base64 encoding"
10128 .cindex "base64 encoding" "in string expansion"
10129 .cindex "&%base64%& expansion item"
10130 .cindex certificate "base64 of DER"
10131 This operator converts a string into one that is base64 encoded.
10132
10133 If the string is a single variable of type certificate,
10134 returns the base64 encoding of the DER form of the certificate.
10135
10136
10137 .vitem &*${base64d:*&<&'string'&>&*}*&
10138 .cindex "expansion" "base64 decoding"
10139 .cindex "base64 decoding" "in string expansion"
10140 .cindex "&%base64d%& expansion item"
10141 This operator converts a base64-encoded string into the un-coded form.
10142
10143
10144 .vitem &*${domain:*&<&'string'&>&*}*&
10145 .cindex "domain" "extraction"
10146 .cindex "expansion" "domain extraction"
10147 The string is interpreted as an RFC 2822 address and the domain is extracted
10148 from it. If the string does not parse successfully, the result is empty.
10149
10150
10151 .vitem &*${escape:*&<&'string'&>&*}*&
10152 .cindex "expansion" "escaping non-printing characters"
10153 .cindex "&%escape%& expansion item"
10154 If the string contains any non-printing characters, they are converted to
10155 escape sequences starting with a backslash. Whether characters with the most
10156 significant bit set (so-called &"8-bit characters"&) count as printing or not
10157 is controlled by the &%print_topbitchars%& option.
10158
10159
10160 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10161 .cindex "expansion" "expression evaluation"
10162 .cindex "expansion" "arithmetic expression"
10163 .cindex "&%eval%& expansion item"
10164 These items supports simple arithmetic and bitwise logical operations in
10165 expansion strings. The string (after expansion) must be a conventional
10166 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10167 logical operators, and parentheses. All operations are carried out using
10168 integer arithmetic. The operator priorities are as follows (the same as in the
10169 C programming language):
10170 .table2 70pt 300pt
10171 .irow &'highest:'& "not (~), negate (-)"
10172 .irow ""   "multiply (*), divide (/), remainder (%)"
10173 .irow ""   "plus (+), minus (-)"
10174 .irow ""   "shift-left (<<), shift-right (>>)"
10175 .irow ""   "and (&&)"
10176 .irow ""   "xor (^)"
10177 .irow &'lowest:'&  "or (|)"
10178 .endtable
10179 Binary operators with the same priority are evaluated from left to right. White
10180 space is permitted before or after operators.
10181
10182 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10183 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10184 decimal, even if they start with a leading zero; hexadecimal numbers are not
10185 permitted. This can be useful when processing numbers extracted from dates or
10186 times, which often do have leading zeros.
10187
10188 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10189 or 1024*1024*1024,
10190 respectively. Negative numbers are supported. The result of the computation is
10191 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10192
10193 .display
10194 &`${eval:1+1}            `&  yields 2
10195 &`${eval:1+2*3}          `&  yields 7
10196 &`${eval:(1+2)*3}        `&  yields 9
10197 &`${eval:2+42%5}         `&  yields 4
10198 &`${eval:0xc&amp;5}          `&  yields 4
10199 &`${eval:0xc|5}          `&  yields 13
10200 &`${eval:0xc^5}          `&  yields 9
10201 &`${eval:0xc>>1}         `&  yields 6
10202 &`${eval:0xc<<1}         `&  yields 24
10203 &`${eval:~255&amp;0x1234}    `&  yields 4608
10204 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10205 .endd
10206
10207 As a more realistic example, in an ACL you might have
10208 .code
10209 deny   message = Too many bad recipients
10210        condition =                    \
10211          ${if and {                   \
10212            {>{$rcpt_count}{10}}       \
10213            {                          \
10214            <                          \
10215              {$recipients_count}      \
10216              {${eval:$rcpt_count/2}}  \
10217            }                          \
10218          }{yes}{no}}
10219 .endd
10220 The condition is true if there have been more than 10 RCPT commands and
10221 fewer than half of them have resulted in a valid recipient.
10222
10223
10224 .vitem &*${expand:*&<&'string'&>&*}*&
10225 .cindex "expansion" "re-expansion of substring"
10226 The &%expand%& operator causes a string to be expanded for a second time. For
10227 example,
10228 .code
10229 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10230 .endd
10231 first looks up a string in a file while expanding the operand for &%expand%&,
10232 and then re-expands what it has found.
10233
10234
10235 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10236 .cindex "Unicode"
10237 .cindex "UTF-8" "conversion from"
10238 .cindex "expansion" "UTF-8 conversion"
10239 .cindex "&%from_utf8%& expansion item"
10240 The world is slowly moving towards Unicode, although there are no standards for
10241 email yet. However, other applications (including some databases) are starting
10242 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10243 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10244 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10245 the result is an undefined sequence of bytes.
10246
10247 Unicode code points with values less than 256 are compatible with ASCII and
10248 ISO-8859-1 (also known as Latin-1).
10249 For example, character 169 is the copyright symbol in both cases, though the
10250 way it is encoded is different. In UTF-8, more than one byte is needed for
10251 characters with code values greater than 127, whereas ISO-8859-1 is a
10252 single-byte encoding (but thereby limited to 256 characters). This makes
10253 translation from UTF-8 to ISO-8859-1 straightforward.
10254
10255
10256 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10257 .cindex "hash function" "textual"
10258 .cindex "expansion" "textual hash"
10259 The &%hash%& operator is a simpler interface to the hashing function that can
10260 be used when the two parameters are fixed numbers (as opposed to strings that
10261 change when expanded). The effect is the same as
10262 .code
10263 ${hash{<n>}{<m>}{<string>}}
10264 .endd
10265 See the description of the general &%hash%& item above for details. The
10266 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10267
10268
10269
10270 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10271 .cindex "base64 encoding" "conversion from hex"
10272 .cindex "expansion" "hex to base64"
10273 .cindex "&%hex2b64%& expansion item"
10274 This operator converts a hex string into one that is base64 encoded. This can
10275 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10276
10277
10278
10279 .vitem &*${hexquote:*&<&'string'&>&*}*&
10280 .cindex "quoting" "hex-encoded unprintable characters"
10281 .cindex "&%hexquote%& expansion item"
10282 This operator converts non-printable characters in a string into a hex
10283 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10284 as is, and other byte values are converted to &`\xNN`&, for example a
10285 byte value 127 is converted to &`\x7f`&.
10286
10287
10288 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10289 .cindex "&%ipv6denorm%& expansion item"
10290 .cindex "IP address" normalisation
10291 This expands an IPv6 address to a full eight-element colon-separated set
10292 of hex digits including leading zeroes.
10293 A trailing ipv4-style dotted-decimal set is converted to hex.
10294 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10295
10296 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10297 .cindex "&%ipv6norm%& expansion item"
10298 .cindex "IP address" normalisation
10299 .cindex "IP address" "canonical form"
10300 This converts an IPv6 address to canonical form.
10301 Leading zeroes of groups are omitted, and the longest
10302 set of zero-valued groups is replaced with a double colon.
10303 A trailing ipv4-style dotted-decimal set is converted to hex.
10304 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10305
10306
10307 .vitem &*${lc:*&<&'string'&>&*}*&
10308 .cindex "case forcing in strings"
10309 .cindex "string" "case forcing"
10310 .cindex "lower casing"
10311 .cindex "expansion" "case forcing"
10312 .cindex "&%lc%& expansion item"
10313 This forces the letters in the string into lower-case, for example:
10314 .code
10315 ${lc:$local_part}
10316 .endd
10317
10318 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10319 .cindex "expansion" "string truncation"
10320 .cindex "&%length%& expansion item"
10321 The &%length%& operator is a simpler interface to the &%length%& function that
10322 can be used when the parameter is a fixed number (as opposed to a string that
10323 changes when expanded). The effect is the same as
10324 .code
10325 ${length{<number>}{<string>}}
10326 .endd
10327 See the description of the general &%length%& item above for details. Note that
10328 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10329 when &%length%& is used as an operator.
10330
10331
10332 .vitem &*${listcount:*&<&'string'&>&*}*&
10333 .cindex "expansion" "list item count"
10334 .cindex "list" "item count"
10335 .cindex "list" "count of items"
10336 .cindex "&%listcount%& expansion item"
10337 The string is interpreted as a list and the number of items is returned.
10338
10339
10340 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10341 .cindex "expansion" "named list"
10342 .cindex "&%listnamed%& expansion item"
10343 The name is interpreted as a named list and the content of the list is returned,
10344 expanding any referenced lists, re-quoting as needed for colon-separation.
10345 If the optional type is given it must be one of "a", "d", "h" or "l"
10346 and selects address-, domain-, host- or localpart- lists to search among respectively.
10347 Otherwise all types are searched in an undefined order and the first
10348 matching list is returned.
10349
10350
10351 .vitem &*${local_part:*&<&'string'&>&*}*&
10352 .cindex "expansion" "local part extraction"
10353 .cindex "&%local_part%& expansion item"
10354 The string is interpreted as an RFC 2822 address and the local part is
10355 extracted from it. If the string does not parse successfully, the result is
10356 empty.
10357
10358
10359 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10360 .cindex "masked IP address"
10361 .cindex "IP address" "masking"
10362 .cindex "CIDR notation"
10363 .cindex "expansion" "IP address masking"
10364 .cindex "&%mask%& expansion item"
10365 If the form of the string to be operated on is not an IP address followed by a
10366 slash and an integer (that is, a network address in CIDR notation), the
10367 expansion fails. Otherwise, this operator converts the IP address to binary,
10368 masks off the least significant bits according to the bit count, and converts
10369 the result back to text, with mask appended. For example,
10370 .code
10371 ${mask:10.111.131.206/28}
10372 .endd
10373 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10374 be mostly used for looking up masked addresses in files, the result for an IPv6
10375 address uses dots to separate components instead of colons, because colon
10376 terminates a key string in lsearch files. So, for example,
10377 .code
10378 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10379 .endd
10380 returns the string
10381 .code
10382 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10383 .endd
10384 Letters in IPv6 addresses are always output in lower case.
10385
10386
10387 .vitem &*${md5:*&<&'string'&>&*}*&
10388 .cindex "MD5 hash"
10389 .cindex "expansion" "MD5 hash"
10390 .cindex certificate fingerprint
10391 .cindex "&%md5%& expansion item"
10392 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10393 as a 32-digit hexadecimal number, in which any letters are in lower case.
10394
10395 If the string is a single variable of type certificate,
10396 returns the MD5 hash fingerprint of the certificate.
10397
10398
10399 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10400 .cindex "expansion" "numeric hash"
10401 .cindex "hash function" "numeric"
10402 The &%nhash%& operator is a simpler interface to the numeric hashing function
10403 that can be used when the two parameters are fixed numbers (as opposed to
10404 strings that change when expanded). The effect is the same as
10405 .code
10406 ${nhash{<n>}{<m>}{<string>}}
10407 .endd
10408 See the description of the general &%nhash%& item above for details.
10409
10410
10411 .vitem &*${quote:*&<&'string'&>&*}*&
10412 .cindex "quoting" "in string expansions"
10413 .cindex "expansion" "quoting"
10414 .cindex "&%quote%& expansion item"
10415 The &%quote%& operator puts its argument into double quotes if it
10416 is an empty string or
10417 contains anything other than letters, digits, underscores, dots, and hyphens.
10418 Any occurrences of double quotes and backslashes are escaped with a backslash.
10419 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10420 respectively For example,
10421 .code
10422 ${quote:ab"*"cd}
10423 .endd
10424 becomes
10425 .code
10426 "ab\"*\"cd"
10427 .endd
10428 The place where this is useful is when the argument is a substitution from a
10429 variable or a message header.
10430
10431 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10432 .cindex "&%quote_local_part%& expansion item"
10433 This operator is like &%quote%&, except that it quotes the string only if
10434 required to do so by the rules of RFC 2822 for quoting local parts. For
10435 example, a plus sign would not cause quoting (but it would for &%quote%&).
10436 If you are creating a new email address from the contents of &$local_part$&
10437 (or any other unknown data), you should always use this operator.
10438
10439
10440 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10441 .cindex "quoting" "lookup-specific"
10442 This operator applies lookup-specific quoting rules to the string. Each
10443 query-style lookup type has its own quoting rules which are described with
10444 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10445 .code
10446 ${quote_ldap:two * two}
10447 .endd
10448 returns
10449 .code
10450 two%20%5C2A%20two
10451 .endd
10452 For single-key lookup types, no quoting is ever necessary and this operator
10453 yields an unchanged string.
10454
10455
10456 .vitem &*${randint:*&<&'n'&>&*}*&
10457 .cindex "random number"
10458 This operator returns a somewhat random number which is less than the
10459 supplied number and is at least 0.  The quality of this randomness depends
10460 on how Exim was built; the values are not suitable for keying material.
10461 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10462 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10463 for versions of GnuTLS with that function.
10464 Otherwise, the implementation may be arc4random(), random() seeded by
10465 srandomdev() or srandom(), or a custom implementation even weaker than
10466 random().
10467
10468
10469 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10470 .cindex "expansion" "IP address"
10471 This operator reverses an IP address; for IPv4 addresses, the result is in
10472 dotted-quad decimal form, while for IPv6 addresses the result is in
10473 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10474 for DNS.  For example,
10475 .code
10476 ${reverse_ip:192.0.2.4}
10477 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10478 .endd
10479 returns
10480 .code
10481 4.2.0.192
10482 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
10483 .endd
10484
10485
10486 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10487 .cindex "expansion" "RFC 2047"
10488 .cindex "RFC 2047" "expansion operator"
10489 .cindex "&%rfc2047%& expansion item"
10490 This operator encodes text according to the rules of RFC 2047. This is an
10491 encoding that is used in header lines to encode non-ASCII characters. It is
10492 assumed that the input string is in the encoding specified by the
10493 &%headers_charset%& option, which gets its default at build time. If the string
10494 contains only characters in the range 33&--126, and no instances of the
10495 characters
10496 .code
10497 ? = ( ) < > @ , ; : \ " . [ ] _
10498 .endd
10499 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10500 string, using as many &"encoded words"& as necessary to encode all the
10501 characters.
10502
10503
10504 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10505 .cindex "expansion" "RFC 2047"
10506 .cindex "RFC 2047" "decoding"
10507 .cindex "&%rfc2047d%& expansion item"
10508 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10509 bytes are replaced by question marks. Characters are converted into the
10510 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10511 not recognized unless &%check_rfc2047_length%& is set false.
10512
10513 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10514 access a header line, RFC 2047 decoding is done automatically. You do not need
10515 to use this operator as well.
10516
10517
10518
10519 .vitem &*${rxquote:*&<&'string'&>&*}*&
10520 .cindex "quoting" "in regular expressions"
10521 .cindex "regular expressions" "quoting"
10522 .cindex "&%rxquote%& expansion item"
10523 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10524 characters in its argument. This is useful when substituting the values of
10525 variables or headers inside regular expressions.
10526
10527
10528 .vitem &*${sha1:*&<&'string'&>&*}*&
10529 .cindex "SHA-1 hash"
10530 .cindex "expansion" "SHA-1 hashing"
10531 .cindex certificate fingerprint
10532 .cindex "&%sha1%& expansion item"
10533 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10534 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10535
10536 If the string is a single variable of type certificate,
10537 returns the SHA-1 hash fingerprint of the certificate.
10538
10539
10540 .vitem &*${sha256:*&<&'string'&>&*}*&
10541 .cindex "SHA-256 hash"
10542 .cindex certificate fingerprint
10543 .cindex "expansion" "SHA-256 hashing"
10544 .cindex "&%sha256%& expansion item"
10545 .new
10546 The &%sha256%& operator computes the SHA-256 hash value of the string
10547 and returns
10548 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10549 .wen
10550
10551 If the string is a single variable of type certificate,
10552 returns the SHA-256 hash fingerprint of the certificate.
10553
10554
10555 .new
10556 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10557        &*${sha3_<n>:*&<&'string'&>&*}*&
10558 .cindex "SHA3 hash"
10559 .cindex "expansion" "SHA3 hashing"
10560 .cindex "&%sha3%& expansion item"
10561 The &%sha3%& operator computes the SHA3-256 hash value of the string
10562 and returns
10563 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10564
10565 If a number is appended, separated by an underbar, it specifies
10566 the output length.  Values of 224, 256, 384 and 512 are accepted;
10567 with 256 being the default.
10568
10569 The &%sha3%& expansion item is only supported if Exim has been
10570 compiled with GnuTLS 3.5.0 or later.
10571 .wen
10572
10573
10574 .vitem &*${stat:*&<&'string'&>&*}*&
10575 .cindex "expansion" "statting a file"
10576 .cindex "file" "extracting characteristics"
10577 .cindex "&%stat%& expansion item"
10578 The string, after expansion, must be a file path. A call to the &[stat()]&
10579 function is made for this path. If &[stat()]& fails, an error occurs and the
10580 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10581 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10582 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10583 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10584 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10585 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10586 can extract individual fields using the &%extract%& expansion item.
10587
10588 The use of the &%stat%& expansion in users' filter files can be locked out by
10589 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10590 systems for files larger than 2GB.
10591
10592 .vitem &*${str2b64:*&<&'string'&>&*}*&
10593 .cindex "&%str2b64%& expansion item"
10594 Now deprecated, a synonym for the &%base64%& expansion operator.
10595
10596
10597
10598 .vitem &*${strlen:*&<&'string'&>&*}*&
10599 .cindex "expansion" "string length"
10600 .cindex "string" "length in expansion"
10601 .cindex "&%strlen%& expansion item"
10602 The item is replace by the length of the expanded string, expressed as a
10603 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10604
10605
10606 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10607 .cindex "&%substr%& expansion item"
10608 .cindex "substring extraction"
10609 .cindex "expansion" "substring expansion"
10610 The &%substr%& operator is a simpler interface to the &%substr%& function that
10611 can be used when the two parameters are fixed numbers (as opposed to strings
10612 that change when expanded). The effect is the same as
10613 .code
10614 ${substr{<start>}{<length>}{<string>}}
10615 .endd
10616 See the description of the general &%substr%& item above for details. The
10617 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10618
10619 .vitem &*${time_eval:*&<&'string'&>&*}*&
10620 .cindex "&%time_eval%& expansion item"
10621 .cindex "time interval" "decoding"
10622 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10623 seconds.
10624
10625 .vitem &*${time_interval:*&<&'string'&>&*}*&
10626 .cindex "&%time_interval%& expansion item"
10627 .cindex "time interval" "formatting"
10628 The argument (after sub-expansion) must be a sequence of decimal digits that
10629 represents an interval of time as a number of seconds. It is converted into a
10630 number of larger units and output in Exim's normal time format, for example,
10631 &`1w3d4h2m6s`&.
10632
10633 .vitem &*${uc:*&<&'string'&>&*}*&
10634 .cindex "case forcing in strings"
10635 .cindex "string" "case forcing"
10636 .cindex "upper casing"
10637 .cindex "expansion" "case forcing"
10638 .cindex "&%uc%& expansion item"
10639 This forces the letters in the string into upper-case.
10640
10641 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10642 .cindex "correction of invalid utf-8 sequences in strings"
10643 .cindex "utf-8" "utf-8 sequences"
10644 .cindex "incorrect utf-8"
10645 .cindex "expansion" "utf-8 forcing"
10646 .cindex "&%utf8clean%& expansion item"
10647 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10648
10649 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10650        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10651        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10652        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10653 .cindex expansion UTF-8
10654 .cindex UTF-8 expansion
10655 .cindex EAI
10656 .cindex internationalisation
10657 .cindex "&%utf8_domain_to_alabel%& expansion item"
10658 .cindex "&%utf8_domain_from_alabel%& expansion item"
10659 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10660 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10661 These convert EAI mail name components between UTF-8 and a-label forms.
10662 For information on internationalisation support see &<<SECTi18nMTA>>&.
10663 .endlist
10664
10665
10666
10667
10668
10669
10670 .section "Expansion conditions" "SECTexpcond"
10671 .scindex IIDexpcond "expansion" "conditions"
10672 The following conditions are available for testing by the &%${if%& construct
10673 while expanding strings:
10674
10675 .vlist
10676 .vitem &*!*&<&'condition'&>
10677 .cindex "expansion" "negating a condition"
10678 .cindex "negation" "in expansion condition"
10679 Preceding any condition with an exclamation mark negates the result of the
10680 condition.
10681
10682 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10683 .cindex "numeric comparison"
10684 .cindex "expansion" "numeric comparison"
10685 There are a number of symbolic operators for doing numeric comparisons. They
10686 are:
10687 .display
10688 &`=   `&   equal
10689 &`==  `&   equal
10690 &`>   `&   greater
10691 &`>=  `&   greater or equal
10692 &`<   `&   less
10693 &`<=  `&   less or equal
10694 .endd
10695 For example:
10696 .code
10697 ${if >{$message_size}{10M} ...
10698 .endd
10699 Note that the general negation operator provides for inequality testing. The
10700 two strings must take the form of optionally signed decimal integers,
10701 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10702 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10703 As a special case, the numerical value of an empty string is taken as
10704 zero.
10705
10706 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10707 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10708 10M, not if 10M is larger than &$message_size$&.
10709
10710
10711 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10712         {*&<&'arg2'&>&*}...}*&
10713 .cindex "expansion" "calling an acl"
10714 .cindex "&%acl%&" "expansion condition"
10715 The name and zero to nine argument strings are first expanded separately.  The expanded
10716 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10717 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10718 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10719 and may use the variables; if another acl expansion is used the values
10720 are restored after it returns.  If the ACL sets
10721 a value using a "message =" modifier the variable $value becomes
10722 the result of the expansion, otherwise it is empty.
10723 If the ACL returns accept the condition is true; if deny, false.
10724 If the ACL returns defer the result is a forced-fail.
10725
10726 .vitem &*bool&~{*&<&'string'&>&*}*&
10727 .cindex "expansion" "boolean parsing"
10728 .cindex "&%bool%& expansion condition"
10729 This condition turns a string holding a true or false representation into
10730 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10731 (case-insensitively); also integer numbers map to true if non-zero,
10732 false if zero.
10733 An empty string is treated as false.
10734 Leading and trailing whitespace is ignored;
10735 thus a string consisting only of whitespace is false.
10736 All other string values will result in expansion failure.
10737
10738 When combined with ACL variables, this expansion condition will let you
10739 make decisions in one place and act on those decisions in another place.
10740 For example:
10741 .code
10742 ${if bool{$acl_m_privileged_sender} ...
10743 .endd
10744
10745
10746 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10747 .cindex "expansion" "boolean parsing"
10748 .cindex "&%bool_lax%& expansion condition"
10749 Like &%bool%&, this condition turns a string into a boolean state.  But
10750 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10751 loose definition that the Router &%condition%& option uses.  The empty string
10752 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10753 true.  Leading and trailing whitespace is ignored.
10754
10755 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10756
10757 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10758 .cindex "expansion" "encrypted comparison"
10759 .cindex "encrypted strings, comparing"
10760 .cindex "&%crypteq%& expansion condition"
10761 This condition is included in the Exim binary if it is built to support any
10762 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10763 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10764 included in the binary.
10765
10766 The &%crypteq%& condition has two arguments. The first is encrypted and
10767 compared against the second, which is already encrypted. The second string may
10768 be in the LDAP form for storing encrypted strings, which starts with the
10769 encryption type in curly brackets, followed by the data. If the second string
10770 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10771 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10772 Typically this will be a field from a password file. An example of an encrypted
10773 string in LDAP form is:
10774 .code
10775 {md5}CY9rzUYh03PK3k6DJie09g==
10776 .endd
10777 If such a string appears directly in an expansion, the curly brackets have to
10778 be quoted, because they are part of the expansion syntax. For example:
10779 .code
10780 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10781 .endd
10782 The following encryption types (whose names are matched case-independently) are
10783 supported:
10784
10785 .ilist
10786 .cindex "MD5 hash"
10787 .cindex "base64 encoding" "in encrypted password"
10788 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10789 printable characters to compare with the remainder of the second string. If the
10790 length of the comparison string is 24, Exim assumes that it is base64 encoded
10791 (as in the above example). If the length is 32, Exim assumes that it is a
10792 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10793 comparison fails.
10794
10795 .next
10796 .cindex "SHA-1 hash"
10797 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10798 printable characters to compare with the remainder of the second string. If the
10799 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10800 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10801 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10802
10803 .next
10804 .cindex "&[crypt()]&"
10805 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10806 only the first eight characters of the password. However, in modern operating
10807 systems this is no longer true, and in many cases the entire password is used,
10808 whatever its length.
10809
10810 .next
10811 .cindex "&[crypt16()]&"
10812 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10813 use up to 16 characters of the password in some operating systems. Again, in
10814 modern operating systems, more characters may be used.
10815 .endlist
10816 Exim has its own version of &[crypt16()]&, which is just a double call to
10817 &[crypt()]&. For operating systems that have their own version, setting
10818 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10819 operating system version instead of its own. This option is set by default in
10820 the OS-dependent &_Makefile_& for those operating systems that are known to
10821 support &[crypt16()]&.
10822
10823 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10824 it was not using the same algorithm as some operating systems' versions. It
10825 turns out that as well as &[crypt16()]& there is a function called
10826 &[bigcrypt()]& in some operating systems. This may or may not use the same
10827 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10828
10829 However, since there is now a move away from the traditional &[crypt()]&
10830 functions towards using SHA1 and other algorithms, tidying up this area of
10831 Exim is seen as very low priority.
10832
10833 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10834 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10835 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10836 default is &`{crypt}`&. Whatever the default, you can always use either
10837 function by specifying it explicitly in curly brackets.
10838
10839 .vitem &*def:*&<&'variable&~name'&>
10840 .cindex "expansion" "checking for empty variable"
10841 .cindex "&%def%& expansion condition"
10842 The &%def%& condition must be followed by the name of one of the expansion
10843 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10844 variable does not contain the empty string. For example:
10845 .code
10846 ${if def:sender_ident {from $sender_ident}}
10847 .endd
10848 Note that the variable name is given without a leading &%$%& character. If the
10849 variable does not exist, the expansion fails.
10850
10851 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10852         &~&*def:h_*&<&'header&~name'&>&*:*&"
10853 .cindex "expansion" "checking header line existence"
10854 This condition is true if a message is being processed and the named header
10855 exists in the message. For example,
10856 .code
10857 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10858 .endd
10859 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10860 the header name must be terminated by a colon if white space does not follow.
10861
10862 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10863        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10864 .cindex "string" "comparison"
10865 .cindex "expansion" "string comparison"
10866 .cindex "&%eq%& expansion condition"
10867 .cindex "&%eqi%& expansion condition"
10868 The two substrings are first expanded. The condition is true if the two
10869 resulting strings are identical. For &%eq%& the comparison includes the case of
10870 letters, whereas for &%eqi%& the comparison is case-independent.
10871
10872 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10873 .cindex "expansion" "file existence test"
10874 .cindex "file" "existence test"
10875 .cindex "&%exists%&, expansion condition"
10876 The substring is first expanded and then interpreted as an absolute path. The
10877 condition is true if the named file (or directory) exists. The existence test
10878 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10879 users' filter files may be locked out by the system administrator.
10880
10881 .vitem &*first_delivery*&
10882 .cindex "delivery" "first"
10883 .cindex "first delivery"
10884 .cindex "expansion" "first delivery test"
10885 .cindex "&%first_delivery%& expansion condition"
10886 This condition, which has no data, is true during a message's first delivery
10887 attempt. It is false during any subsequent delivery attempts.
10888
10889
10890 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10891        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10892 .cindex "list" "iterative conditions"
10893 .cindex "expansion" "&*forall*& condition"
10894 .cindex "expansion" "&*forany*& condition"
10895 .vindex "&$item$&"
10896 These conditions iterate over a list. The first argument is expanded to form
10897 the list. By default, the list separator is a colon, but it can be changed by
10898 the normal method. The second argument is interpreted as a condition that is to
10899 be applied to each item in the list in turn. During the interpretation of the
10900 condition, the current list item is placed in a variable called &$item$&.
10901 .ilist
10902 For &*forany*&, interpretation stops if the condition is true for any item, and
10903 the result of the whole condition is true. If the condition is false for all
10904 items in the list, the overall condition is false.
10905 .next
10906 For &*forall*&, interpretation stops if the condition is false for any item,
10907 and the result of the whole condition is false. If the condition is true for
10908 all items in the list, the overall condition is true.
10909 .endlist
10910 Note that negation of &*forany*& means that the condition must be false for all
10911 items for the overall condition to succeed, and negation of &*forall*& means
10912 that the condition must be false for at least one item. In this example, the
10913 list separator is changed to a comma:
10914 .code
10915 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10916 .endd
10917 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10918 being processed, to enable these expansion items to be nested.
10919
10920 To scan a named list, expand it with the &*listnamed*& operator.
10921
10922
10923 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10924        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10925 .cindex "string" "comparison"
10926 .cindex "expansion" "string comparison"
10927 .cindex "&%ge%& expansion condition"
10928 .cindex "&%gei%& expansion condition"
10929 The two substrings are first expanded. The condition is true if the first
10930 string is lexically greater than or equal to the second string. For &%ge%& the
10931 comparison includes the case of letters, whereas for &%gei%& the comparison is
10932 case-independent.
10933
10934 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10935        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10936 .cindex "string" "comparison"
10937 .cindex "expansion" "string comparison"
10938 .cindex "&%gt%& expansion condition"
10939 .cindex "&%gti%& expansion condition"
10940 The two substrings are first expanded. The condition is true if the first
10941 string is lexically greater than the second string. For &%gt%& the comparison
10942 includes the case of letters, whereas for &%gti%& the comparison is
10943 case-independent.
10944
10945 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10946        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10947 .cindex "string" "comparison"
10948 .cindex "list" "iterative conditions"
10949 Both strings are expanded; the second string is treated as a list of simple
10950 strings; if the first string is a member of the second, then the condition
10951 is true.
10952
10953 These are simpler to use versions of the more powerful &*forany*& condition.
10954 Examples, and the &*forany*& equivalents:
10955 .code
10956 ${if inlist{needle}{foo:needle:bar}}
10957   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10958 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10959   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10960 .endd
10961
10962 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10963        &*isip4&~{*&<&'string'&>&*}*& &&&
10964        &*isip6&~{*&<&'string'&>&*}*&
10965 .cindex "IP address" "testing string format"
10966 .cindex "string" "testing for IP address"
10967 .cindex "&%isip%& expansion condition"
10968 .cindex "&%isip4%& expansion condition"
10969 .cindex "&%isip6%& expansion condition"
10970 The substring is first expanded, and then tested to see if it has the form of
10971 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10972 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10973
10974 For an IPv4 address, the test is for four dot-separated components, each of
10975 which consists of from one to three digits. For an IPv6 address, up to eight
10976 colon-separated components are permitted, each containing from one to four
10977 hexadecimal digits. There may be fewer than eight components if an empty
10978 component (adjacent colons) is present. Only one empty component is permitted.
10979
10980 &*Note*&: The checks are just on the form of the address; actual numerical
10981 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10982 check. The main use of these tests is to distinguish between IP addresses and
10983 host names, or between IPv4 and IPv6 addresses. For example, you could use
10984 .code
10985 ${if isip4{$sender_host_address}...
10986 .endd
10987 to test which IP version an incoming SMTP connection is using.
10988
10989 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10990 .cindex "LDAP" "use for authentication"
10991 .cindex "expansion" "LDAP authentication test"
10992 .cindex "&%ldapauth%& expansion condition"
10993 This condition supports user authentication using LDAP. See section
10994 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10995 queries. For this use, the query must contain a user name and password. The
10996 query itself is not used, and can be empty. The condition is true if the
10997 password is not empty, and the user name and password are accepted by the LDAP
10998 server. An empty password is rejected without calling LDAP because LDAP binds
10999 with an empty password are considered anonymous regardless of the username, and
11000 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11001 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11002 this can be used.
11003
11004
11005 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11006        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11007 .cindex "string" "comparison"
11008 .cindex "expansion" "string comparison"
11009 .cindex "&%le%& expansion condition"
11010 .cindex "&%lei%& expansion condition"
11011 The two substrings are first expanded. The condition is true if the first
11012 string is lexically less than or equal to the second string. For &%le%& the
11013 comparison includes the case of letters, whereas for &%lei%& the comparison is
11014 case-independent.
11015
11016 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11017        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11018 .cindex "string" "comparison"
11019 .cindex "expansion" "string comparison"
11020 .cindex "&%lt%& expansion condition"
11021 .cindex "&%lti%& expansion condition"
11022 The two substrings are first expanded. The condition is true if the first
11023 string is lexically less than the second string. For &%lt%& the comparison
11024 includes the case of letters, whereas for &%lti%& the comparison is
11025 case-independent.
11026
11027
11028 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11029 .cindex "expansion" "regular expression comparison"
11030 .cindex "regular expressions" "match in expanded string"
11031 .cindex "&%match%& expansion condition"
11032 The two substrings are first expanded. The second is then treated as a regular
11033 expression and applied to the first. Because of the pre-expansion, if the
11034 regular expression contains dollar, or backslash characters, they must be
11035 escaped. Care must also be taken if the regular expression contains braces
11036 (curly brackets). A closing brace must be escaped so that it is not taken as a
11037 premature termination of <&'string2'&>. The easiest approach is to use the
11038 &`\N`& feature to disable expansion of the regular expression.
11039 For example,
11040 .code
11041 ${if match {$local_part}{\N^\d{3}\N} ...
11042 .endd
11043 If the whole expansion string is in double quotes, further escaping of
11044 backslashes is also required.
11045
11046 The condition is true if the regular expression match succeeds.
11047 The regular expression is not required to begin with a circumflex
11048 metacharacter, but if there is no circumflex, the expression is not anchored,
11049 and it may match anywhere in the subject, not just at the start. If you want
11050 the pattern to match at the end of the subject, you must include the &`$`&
11051 metacharacter at an appropriate point.
11052
11053 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11054 At the start of an &%if%& expansion the values of the numeric variable
11055 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11056 succeeds causes them to be reset to the substrings of that condition and they
11057 will have these values during the expansion of the success string. At the end
11058 of the &%if%& expansion, the previous values are restored. After testing a
11059 combination of conditions using &%or%&, the subsequent values of the numeric
11060 variables are those of the condition that succeeded.
11061
11062 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11063 .cindex "&%match_address%& expansion condition"
11064 See &*match_local_part*&.
11065
11066 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11067 .cindex "&%match_domain%& expansion condition"
11068 See &*match_local_part*&.
11069
11070 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11071 .cindex "&%match_ip%& expansion condition"
11072 This condition matches an IP address to a list of IP address patterns. It must
11073 be followed by two argument strings. The first (after expansion) must be an IP
11074 address or an empty string. The second (not expanded) is a restricted host
11075 list that can match only an IP address, not a host name. For example:
11076 .code
11077 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11078 .endd
11079 The specific types of host list item that are permitted in the list are:
11080
11081 .ilist
11082 An IP address, optionally with a CIDR mask.
11083 .next
11084 A single asterisk, which matches any IP address.
11085 .next
11086 An empty item, which matches only if the IP address is empty. This could be
11087 useful for testing for a locally submitted message or one from specific hosts
11088 in a single test such as
11089 . ==== As this is a nested list, any displays it contains must be indented
11090 . ==== as otherwise they are too far to the left. This comment applies to
11091 . ==== the use of xmlto plus fop. There's no problem when formatting with
11092 . ==== sdop, with or without the extra indent.
11093 .code
11094   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11095 .endd
11096 where the first item in the list is the empty string.
11097 .next
11098 The item @[] matches any of the local host's interface addresses.
11099 .next
11100 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11101 even if &`net-`& is not specified. There is never any attempt to turn the IP
11102 address into a host name. The most common type of linear search for
11103 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11104 masks. For example:
11105 .code
11106   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11107 .endd
11108 It is of course possible to use other kinds of lookup, and in such a case, you
11109 do need to specify the &`net-`& prefix if you want to specify a specific
11110 address mask, for example:
11111 .code
11112   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11113 .endd
11114 However, unless you are combining a &%match_ip%& condition with others, it is
11115 just as easy to use the fact that a lookup is itself a condition, and write:
11116 .code
11117   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11118 .endd
11119 .endlist ilist
11120
11121 Note that <&'string2'&> is not itself subject to string expansion, unless
11122 Exim was built with the EXPAND_LISTMATCH_RHS option.
11123
11124 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11125
11126 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11127 .cindex "domain list" "in expansion condition"
11128 .cindex "address list" "in expansion condition"
11129 .cindex "local part" "list, in expansion condition"
11130 .cindex "&%match_local_part%& expansion condition"
11131 This condition, together with &%match_address%& and &%match_domain%&, make it
11132 possible to test domain, address, and local part lists within expansions. Each
11133 condition requires two arguments: an item and a list to match. A trivial
11134 example is:
11135 .code
11136 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11137 .endd
11138 In each case, the second argument may contain any of the allowable items for a
11139 list of the appropriate type. Also, because the second argument (after
11140 expansion) is a standard form of list, it is possible to refer to a named list.
11141 Thus, you can use conditions like this:
11142 .code
11143 ${if match_domain{$domain}{+local_domains}{...
11144 .endd
11145 .cindex "&`+caseful`&"
11146 For address lists, the matching starts off caselessly, but the &`+caseful`&
11147 item can be used, as in all address lists, to cause subsequent items to
11148 have their local parts matched casefully. Domains are always matched
11149 caselessly.
11150
11151 Note that <&'string2'&> is not itself subject to string expansion, unless
11152 Exim was built with the EXPAND_LISTMATCH_RHS option.
11153
11154 &*Note*&: Host lists are &'not'& supported in this way. This is because
11155 hosts have two identities: a name and an IP address, and it is not clear
11156 how to specify cleanly how such a test would work. However, IP addresses can be
11157 matched using &%match_ip%&.
11158
11159 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11160 .cindex "PAM authentication"
11161 .cindex "AUTH" "with PAM"
11162 .cindex "Solaris" "PAM support"
11163 .cindex "expansion" "PAM authentication test"
11164 .cindex "&%pam%& expansion condition"
11165 &'Pluggable Authentication Modules'&
11166 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11167 available in the latest releases of Solaris and in some GNU/Linux
11168 distributions. The Exim support, which is intended for use in conjunction with
11169 the SMTP AUTH command, is available only if Exim is compiled with
11170 .code
11171 SUPPORT_PAM=yes
11172 .endd
11173 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11174 in some releases of GNU/Linux &%-ldl%& is also needed.
11175
11176 The argument string is first expanded, and the result must be a
11177 colon-separated list of strings. Leading and trailing white space is ignored.
11178 The PAM module is initialized with the service name &"exim"& and the user name
11179 taken from the first item in the colon-separated data string (<&'string1'&>).
11180 The remaining items in the data string are passed over in response to requests
11181 from the authentication function. In the simple case there will only be one
11182 request, for a password, so the data consists of just two strings.
11183
11184 There can be problems if any of the strings are permitted to contain colon
11185 characters. In the usual way, these have to be doubled to avoid being taken as
11186 separators. If the data is being inserted from a variable, the &%sg%& expansion
11187 item can be used to double any existing colons. For example, the configuration
11188 of a LOGIN authenticator might contain this setting:
11189 .code
11190 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11191 .endd
11192 For a PLAIN authenticator you could use:
11193 .code
11194 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11195 .endd
11196 In some operating systems, PAM authentication can be done only from a process
11197 running as root. Since Exim is running as the Exim user when receiving
11198 messages, this means that PAM cannot be used directly in those systems.
11199 A patched version of the &'pam_unix'& module that comes with the
11200 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11201 The patched module allows one special uid/gid combination, in addition to root,
11202 to authenticate. If you build the patched module to allow the Exim user and
11203 group, PAM can then be used from an Exim authenticator.
11204
11205
11206 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11207 .cindex "&'pwcheck'& daemon"
11208 .cindex "Cyrus"
11209 .cindex "expansion" "&'pwcheck'& authentication test"
11210 .cindex "&%pwcheck%& expansion condition"
11211 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11212 This is one way of making it possible for passwords to be checked by a process
11213 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11214 deprecated. Its replacement is &'saslauthd'& (see below).
11215
11216 The pwcheck support is not included in Exim by default. You need to specify
11217 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11218 building Exim. For example:
11219 .code
11220 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11221 .endd
11222 You do not need to install the full Cyrus software suite in order to use
11223 the pwcheck daemon. You can compile and install just the daemon alone
11224 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11225 access to the &_/var/pwcheck_& directory.
11226
11227 The &%pwcheck%& condition takes one argument, which must be the user name and
11228 password, separated by a colon. For example, in a LOGIN authenticator
11229 configuration, you might have this:
11230 .code
11231 server_condition = ${if pwcheck{$auth1:$auth2}}
11232 .endd
11233 Again, for a PLAIN authenticator configuration, this would be:
11234 .code
11235 server_condition = ${if pwcheck{$auth2:$auth3}}
11236 .endd
11237 .vitem &*queue_running*&
11238 .cindex "queue runner" "detecting when delivering from"
11239 .cindex "expansion" "queue runner test"
11240 .cindex "&%queue_running%& expansion condition"
11241 This condition, which has no data, is true during delivery attempts that are
11242 initiated by queue runner processes, and false otherwise.
11243
11244
11245 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11246 .cindex "Radius"
11247 .cindex "expansion" "Radius authentication"
11248 .cindex "&%radius%& expansion condition"
11249 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11250 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11251 the Radius client configuration file in order to build Exim with Radius
11252 support.
11253
11254 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11255 library, using the original API. If you are using release 0.4.0 or later of
11256 this library, you need to set
11257 .code
11258 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11259 .endd
11260 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11261 &%libradius%& library that comes with FreeBSD. To do this, set
11262 .code
11263 RADIUS_LIB_TYPE=RADLIB
11264 .endd
11265 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11266 You may also have to supply a suitable setting in EXTRALIBS so that the
11267 Radius library can be found when Exim is linked.
11268
11269 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11270 Radius client library, which calls the Radius server. The condition is true if
11271 the authentication is successful. For example:
11272 .code
11273 server_condition = ${if radius{<arguments>}}
11274 .endd
11275
11276
11277 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11278         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11279 .cindex "&'saslauthd'& daemon"
11280 .cindex "Cyrus"
11281 .cindex "expansion" "&'saslauthd'& authentication test"
11282 .cindex "&%saslauthd%& expansion condition"
11283 This condition supports user authentication using the Cyrus &'saslauthd'&
11284 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11285 Using this daemon is one way of making it possible for passwords to be checked
11286 by a process that is not running as root.
11287
11288 The saslauthd support is not included in Exim by default. You need to specify
11289 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11290 building Exim. For example:
11291 .code
11292 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11293 .endd
11294 You do not need to install the full Cyrus software suite in order to use
11295 the saslauthd daemon. You can compile and install just the daemon alone
11296 from the Cyrus SASL library.
11297
11298 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11299 two are mandatory. For example:
11300 .code
11301 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11302 .endd
11303 The service and the realm are optional (which is why the arguments are enclosed
11304 in their own set of braces). For details of the meaning of the service and
11305 realm, and how to run the daemon, consult the Cyrus documentation.
11306 .endlist vlist
11307
11308
11309
11310 .section "Combining expansion conditions" "SECID84"
11311 .cindex "expansion" "combining conditions"
11312 Several conditions can be tested at once by combining them using the &%and%&
11313 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11314 conditions on their own, and precede their lists of sub-conditions. Each
11315 sub-condition must be enclosed in braces within the overall braces that contain
11316 the list. No repetition of &%if%& is used.
11317
11318
11319 .vlist
11320 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11321 .cindex "&""or""& expansion condition"
11322 .cindex "expansion" "&""or""& of conditions"
11323 The sub-conditions are evaluated from left to right. The condition is true if
11324 any one of the sub-conditions is true.
11325 For example,
11326 .code
11327 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11328 .endd
11329 When a true sub-condition is found, the following ones are parsed but not
11330 evaluated. If there are several &"match"& sub-conditions the values of the
11331 numeric variables afterwards are taken from the first one that succeeds.
11332
11333 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11334 .cindex "&""and""& expansion condition"
11335 .cindex "expansion" "&""and""& of conditions"
11336 The sub-conditions are evaluated from left to right. The condition is true if
11337 all of the sub-conditions are true. If there are several &"match"&
11338 sub-conditions, the values of the numeric variables afterwards are taken from
11339 the last one. When a false sub-condition is found, the following ones are
11340 parsed but not evaluated.
11341 .endlist
11342 .ecindex IIDexpcond
11343
11344
11345
11346
11347 .section "Expansion variables" "SECTexpvar"
11348 .cindex "expansion" "variables, list of"
11349 This section contains an alphabetical list of all the expansion variables. Some
11350 of them are available only when Exim is compiled with specific options such as
11351 support for TLS or the content scanning extension.
11352
11353 .vlist
11354 .vitem "&$0$&, &$1$&, etc"
11355 .cindex "numerical variables (&$1$& &$2$& etc)"
11356 When a &%match%& expansion condition succeeds, these variables contain the
11357 captured substrings identified by the regular expression during subsequent
11358 processing of the success string of the containing &%if%& expansion item.
11359 In the expansion condition case
11360 they do not retain their values afterwards; in fact, their previous
11361 values are restored at the end of processing an &%if%& item. The numerical
11362 variables may also be set externally by some other matching process which
11363 precedes the expansion of the string. For example, the commands available in
11364 Exim filter files include an &%if%& command with its own regular expression
11365 matching condition.
11366
11367 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11368 Within an acl condition, expansion condition or expansion item
11369 any arguments are copied to these variables,
11370 any unused variables being made empty.
11371
11372 .vitem "&$acl_c...$&"
11373 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11374 can be given any name that starts with &$acl_c$& and is at least six characters
11375 long, but the sixth character must be either a digit or an underscore. For
11376 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11377 variables persist throughout the lifetime of an SMTP connection. They can be
11378 used to pass information between ACLs and between different invocations of the
11379 same ACL. When a message is received, the values of these variables are saved
11380 with the message, and can be accessed by filters, routers, and transports
11381 during subsequent delivery.
11382
11383 .vitem "&$acl_m...$&"
11384 These variables are like the &$acl_c...$& variables, except that their values
11385 are reset after a message has been received. Thus, if several messages are
11386 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11387 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11388 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11389 message is received, the values of these variables are saved with the message,
11390 and can be accessed by filters, routers, and transports during subsequent
11391 delivery.
11392
11393 .vitem &$acl_narg$&
11394 Within an acl condition, expansion condition or expansion item
11395 this variable has the number of arguments.
11396
11397 .vitem &$acl_verify_message$&
11398 .vindex "&$acl_verify_message$&"
11399 After an address verification has failed, this variable contains the failure
11400 message. It retains its value for use in subsequent modifiers. The message can
11401 be preserved by coding like this:
11402 .code
11403 warn !verify = sender
11404      set acl_m0 = $acl_verify_message
11405 .endd
11406 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11407 &%log_message%& modifiers, to include information about the verification
11408 failure.
11409
11410 .vitem &$address_data$&
11411 .vindex "&$address_data$&"
11412 This variable is set by means of the &%address_data%& option in routers. The
11413 value then remains with the address while it is processed by subsequent routers
11414 and eventually a transport. If the transport is handling multiple addresses,
11415 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11416 for more details. &*Note*&: The contents of &$address_data$& are visible in
11417 user filter files.
11418
11419 If &$address_data$& is set when the routers are called from an ACL to verify
11420 a recipient address, the final value is still in the variable for subsequent
11421 conditions and modifiers of the ACL statement. If routing the address caused it
11422 to be redirected to just one address, the child address is also routed as part
11423 of the verification, and in this case the final value of &$address_data$& is
11424 from the child's routing.
11425
11426 If &$address_data$& is set when the routers are called from an ACL to verify a
11427 sender address, the final value is also preserved, but this time in
11428 &$sender_address_data$&, to distinguish it from data from a recipient
11429 address.
11430
11431 In both cases (recipient and sender verification), the value does not persist
11432 after the end of the current ACL statement. If you want to preserve
11433 these values for longer, you can save them in ACL variables.
11434
11435 .vitem &$address_file$&
11436 .vindex "&$address_file$&"
11437 When, as a result of aliasing, forwarding, or filtering, a message is directed
11438 to a specific file, this variable holds the name of the file when the transport
11439 is running. At other times, the variable is empty. For example, using the
11440 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11441 .code
11442 /home/r2d2/savemail
11443 .endd
11444 then when the &(address_file)& transport is running, &$address_file$&
11445 contains the text string &`/home/r2d2/savemail`&.
11446 .cindex "Sieve filter" "value of &$address_file$&"
11447 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11448 then up to the transport configuration to generate an appropriate absolute path
11449 to the relevant file.
11450
11451 .vitem &$address_pipe$&
11452 .vindex "&$address_pipe$&"
11453 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11454 this variable holds the pipe command when the transport is running.
11455
11456 .vitem "&$auth1$& &-- &$auth3$&"
11457 .vindex "&$auth1$&, &$auth2$&, etc"
11458 These variables are used in SMTP authenticators (see chapters
11459 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11460
11461 .vitem &$authenticated_id$&
11462 .cindex "authentication" "id"
11463 .vindex "&$authenticated_id$&"
11464 When a server successfully authenticates a client it may be configured to
11465 preserve some of the authentication information in the variable
11466 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11467 user/password authenticator configuration might preserve the user name for use
11468 in the routers. Note that this is not the same information that is saved in
11469 &$sender_host_authenticated$&.
11470 When a message is submitted locally (that is, not over a TCP connection)
11471 the value of &$authenticated_id$& is normally the login name of the calling
11472 process. However, a trusted user can override this by means of the &%-oMai%&
11473 command line option.
11474
11475 .vitem &$authenticated_fail_id$&
11476 .cindex "authentication" "fail" "id"
11477 .vindex "&$authenticated_fail_id$&"
11478 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11479 will contain the failed authentication id. If more than one authentication
11480 id is attempted, it will contain only the last one. The variable is
11481 available for processing in the ACL's, generally the quit or notquit ACL.
11482 A message to a local recipient could still be accepted without requiring
11483 authentication, which means this variable could also be visible in all of
11484 the ACL's as well.
11485
11486
11487 .vitem &$authenticated_sender$&
11488 .cindex "sender" "authenticated"
11489 .cindex "authentication" "sender"
11490 .cindex "AUTH" "on MAIL command"
11491 .vindex "&$authenticated_sender$&"
11492 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11493 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11494 described in section &<<SECTauthparamail>>&. Unless the data is the string
11495 &"<>"&, it is set as the authenticated sender of the message, and the value is
11496 available during delivery in the &$authenticated_sender$& variable. If the
11497 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11498
11499 .vindex "&$qualify_domain$&"
11500 When a message is submitted locally (that is, not over a TCP connection), the
11501 value of &$authenticated_sender$& is an address constructed from the login
11502 name of the calling process and &$qualify_domain$&, except that a trusted user
11503 can override this by means of the &%-oMas%& command line option.
11504
11505
11506 .vitem &$authentication_failed$&
11507 .cindex "authentication" "failure"
11508 .vindex "&$authentication_failed$&"
11509 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11510 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11511 possible to distinguish between &"did not try to authenticate"&
11512 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11513 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11514 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11515 negative response to an AUTH command, including (for example) an attempt to use
11516 an undefined mechanism.
11517
11518 .vitem &$av_failed$&
11519 .cindex "content scanning" "AV scanner failure"
11520 This variable is available when Exim is compiled with the content-scanning
11521 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11522 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11523 the ACL malware condition.
11524
11525 .vitem &$body_linecount$&
11526 .cindex "message body" "line count"
11527 .cindex "body of message" "line count"
11528 .vindex "&$body_linecount$&"
11529 When a message is being received or delivered, this variable contains the
11530 number of lines in the message's body. See also &$message_linecount$&.
11531
11532 .vitem &$body_zerocount$&
11533 .cindex "message body" "binary zero count"
11534 .cindex "body of message" "binary zero count"
11535 .cindex "binary zero" "in message body"
11536 .vindex "&$body_zerocount$&"
11537 When a message is being received or delivered, this variable contains the
11538 number of binary zero bytes (ASCII NULs) in the message's body.
11539
11540 .vitem &$bounce_recipient$&
11541 .vindex "&$bounce_recipient$&"
11542 This is set to the recipient address of a bounce message while Exim is creating
11543 it. It is useful if a customized bounce message text file is in use (see
11544 chapter &<<CHAPemsgcust>>&).
11545
11546 .vitem &$bounce_return_size_limit$&
11547 .vindex "&$bounce_return_size_limit$&"
11548 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11549 up to a multiple of 1000. It is useful when a customized error message text
11550 file is in use (see chapter &<<CHAPemsgcust>>&).
11551
11552 .vitem &$caller_gid$&
11553 .cindex "gid (group id)" "caller"
11554 .vindex "&$caller_gid$&"
11555 The real group id under which the process that called Exim was running. This is
11556 not the same as the group id of the originator of a message (see
11557 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11558 incarnation normally contains the Exim gid.
11559
11560 .vitem &$caller_uid$&
11561 .cindex "uid (user id)" "caller"
11562 .vindex "&$caller_uid$&"
11563 The real user id under which the process that called Exim was running. This is
11564 not the same as the user id of the originator of a message (see
11565 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11566 incarnation normally contains the Exim uid.
11567
11568 .vitem &$callout_address$&
11569 .vindex "&$callout_address$&"
11570 After a callout for verification, spamd or malware daemon service, the
11571 address that was connected to.
11572
11573 .vitem &$compile_number$&
11574 .vindex "&$compile_number$&"
11575 The building process for Exim keeps a count of the number
11576 of times it has been compiled. This serves to distinguish different
11577 compilations of the same version of the program.
11578
11579 .vitem &$config_dir$&
11580 .vindex "&$config_dir$&"
11581 The directory name of the main configuration file. That is, the content of
11582 &$config_file$& with the last component stripped. The value does not
11583 contain the trailing slash. If &$config_file$& does not contain a slash,
11584 &$config_dir$& is ".".
11585
11586 .vitem &$config_file$&
11587 .vindex "&$config_file$&"
11588 The name of the main configuration file Exim is using.
11589
11590 .vitem &$dkim_cur_signer$& &&&
11591        &$dkim_verify_status$& &&&
11592        &$dkim_verify_reason$& &&&
11593        &$dkim_domain$& &&&
11594        &$dkim_identity$& &&&
11595        &$dkim_selector$& &&&
11596        &$dkim_algo$& &&&
11597        &$dkim_canon_body$& &&&
11598        &$dkim_canon_headers$& &&&
11599        &$dkim_copiedheaders$& &&&
11600        &$dkim_bodylength$& &&&
11601        &$dkim_created$& &&&
11602        &$dkim_expires$& &&&
11603        &$dkim_headernames$& &&&
11604        &$dkim_key_testing$& &&&
11605        &$dkim_key_nosubdomains$& &&&
11606        &$dkim_key_srvtype$& &&&
11607        &$dkim_key_granularity$& &&&
11608        &$dkim_key_notes$& &&&
11609        &$dkim_key_length$&
11610 These variables are only available within the DKIM ACL.
11611 For details see chapter &<<CHAPdkim>>&.
11612
11613 .vitem &$dkim_signers$&
11614 .vindex &$dkim_signers$&
11615 When a message has been received this variable contains
11616 a colon-separated list of signer domains and identities for the message.
11617 For details see chapter &<<CHAPdkim>>&.
11618
11619 .vitem &$dnslist_domain$& &&&
11620        &$dnslist_matched$& &&&
11621        &$dnslist_text$& &&&
11622        &$dnslist_value$&
11623 .vindex "&$dnslist_domain$&"
11624 .vindex "&$dnslist_matched$&"
11625 .vindex "&$dnslist_text$&"
11626 .vindex "&$dnslist_value$&"
11627 .cindex "black list (DNS)"
11628 When a DNS (black) list lookup succeeds, these variables are set to contain
11629 the following data from the lookup: the list's domain name, the key that was
11630 looked up, the contents of any associated TXT record, and the value from the
11631 main A record. See section &<<SECID204>>& for more details.
11632
11633 .vitem &$domain$&
11634 .vindex "&$domain$&"
11635 When an address is being routed, or delivered on its own, this variable
11636 contains the domain. Uppercase letters in the domain are converted into lower
11637 case for &$domain$&.
11638
11639 Global address rewriting happens when a message is received, so the value of
11640 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11641 is set during user filtering, but not during system filtering, because a
11642 message may have many recipients and the system filter is called just once.
11643
11644 When more than one address is being delivered at once (for example, several
11645 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11646 have the same domain. Transports can be restricted to handling only one domain
11647 at a time if the value of &$domain$& is required at transport time &-- this is
11648 the default for local transports. For further details of the environment in
11649 which local transports are run, see chapter &<<CHAPenvironment>>&.
11650
11651 .oindex "&%delay_warning_condition%&"
11652 At the end of a delivery, if all deferred addresses have the same domain, it is
11653 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11654
11655 The &$domain$& variable is also used in some other circumstances:
11656
11657 .ilist
11658 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11659 the recipient address. The domain of the &'sender'& address is in
11660 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11661 normally set during the running of the MAIL ACL. However, if the sender address
11662 is verified with a callout during the MAIL ACL, the sender domain is placed in
11663 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11664 the &(smtp)& transport.
11665
11666 .next
11667 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11668 &$domain$& contains the domain portion of the address that is being rewritten;
11669 it can be used in the expansion of the replacement address, for example, to
11670 rewrite domains by file lookup.
11671
11672 .next
11673 With one important exception, whenever a domain list is being scanned,
11674 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11675 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11676 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11677 that, in a RCPT ACL, the sender domain list can be dependent on the
11678 recipient domain (which is what is in &$domain$& at this time).
11679
11680 .next
11681 .cindex "ETRN" "value of &$domain$&"
11682 .oindex "&%smtp_etrn_command%&"
11683 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11684 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11685 .endlist
11686
11687
11688 .vitem &$domain_data$&
11689 .vindex "&$domain_data$&"
11690 When the &%domains%& option on a router matches a domain by
11691 means of a lookup, the data read by the lookup is available during the running
11692 of the router as &$domain_data$&. In addition, if the driver routes the
11693 address to a transport, the value is available in that transport. If the
11694 transport is handling multiple addresses, the value from the first address is
11695 used.
11696
11697 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11698 domain by means of a lookup. The data read by the lookup is available during
11699 the rest of the ACL statement. In all other situations, this variable expands
11700 to nothing.
11701
11702 .vitem &$exim_gid$&
11703 .vindex "&$exim_gid$&"
11704 This variable contains the numerical value of the Exim group id.
11705
11706 .vitem &$exim_path$&
11707 .vindex "&$exim_path$&"
11708 This variable contains the path to the Exim binary.
11709
11710 .vitem &$exim_uid$&
11711 .vindex "&$exim_uid$&"
11712 This variable contains the numerical value of the Exim user id.
11713
11714 .vitem &$exim_version$&
11715 .vindex "&$exim_version$&"
11716 This variable contains the version string of the Exim build.
11717 The first character is a major version number, currently 4.
11718 Then after a dot, the next group of digits is a minor version number.
11719 There may be other characters following the minor version.
11720
11721 .vitem &$header_$&<&'name'&>
11722 This is not strictly an expansion variable. It is expansion syntax for
11723 inserting the message header line with the given name. Note that the name must
11724 be terminated by colon or white space, because it may contain a wide variety of
11725 characters. Note also that braces must &'not'& be used.
11726
11727 .vitem &$headers_added$&
11728 .vindex "&$headers_added$&"
11729 Within an ACL this variable contains the headers added so far by
11730 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11731 The headers are a newline-separated list.
11732
11733 .vitem &$home$&
11734 .vindex "&$home$&"
11735 When the &%check_local_user%& option is set for a router, the user's home
11736 directory is placed in &$home$& when the check succeeds. In particular, this
11737 means it is set during the running of users' filter files. A router may also
11738 explicitly set a home directory for use by a transport; this can be overridden
11739 by a setting on the transport itself.
11740
11741 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11742 of the environment variable HOME, which is subject to the
11743 &%keep_environment%& and &%add_environment%& main config options.
11744
11745 .vitem &$host$&
11746 .vindex "&$host$&"
11747 If a router assigns an address to a transport (any transport), and passes a
11748 list of hosts with the address, the value of &$host$& when the transport starts
11749 to run is the name of the first host on the list. Note that this applies both
11750 to local and remote transports.
11751
11752 .cindex "transport" "filter"
11753 .cindex "filter" "transport filter"
11754 For the &(smtp)& transport, if there is more than one host, the value of
11755 &$host$& changes as the transport works its way through the list. In
11756 particular, when the &(smtp)& transport is expanding its options for encryption
11757 using TLS, or for specifying a transport filter (see chapter
11758 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11759 is connected.
11760
11761 When used in the client part of an authenticator configuration (see chapter
11762 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11763 client is connected.
11764
11765
11766 .vitem &$host_address$&
11767 .vindex "&$host_address$&"
11768 This variable is set to the remote host's IP address whenever &$host$& is set
11769 for a remote connection. It is also set to the IP address that is being checked
11770 when the &%ignore_target_hosts%& option is being processed.
11771
11772 .vitem &$host_data$&
11773 .vindex "&$host_data$&"
11774 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11775 result of the lookup is made available in the &$host_data$& variable. This
11776 allows you, for example, to do things like this:
11777 .code
11778 deny  hosts = net-lsearch;/some/file
11779 message = $host_data
11780 .endd
11781 .vitem &$host_lookup_deferred$&
11782 .cindex "host name" "lookup, failure of"
11783 .vindex "&$host_lookup_deferred$&"
11784 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11785 message comes from a remote host and there is an attempt to look up the host's
11786 name from its IP address, and the attempt is not successful, one of these
11787 variables is set to &"1"&.
11788
11789 .ilist
11790 If the lookup receives a definite negative response (for example, a DNS lookup
11791 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11792
11793 .next
11794 If there is any kind of problem during the lookup, such that Exim cannot
11795 tell whether or not the host name is defined (for example, a timeout for a DNS
11796 lookup), &$host_lookup_deferred$& is set to &"1"&.
11797 .endlist ilist
11798
11799 Looking up a host's name from its IP address consists of more than just a
11800 single reverse lookup. Exim checks that a forward lookup of at least one of the
11801 names it receives from a reverse lookup yields the original IP address. If this
11802 is not the case, Exim does not accept the looked up name(s), and
11803 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11804 IP address (for example, the existence of a PTR record in the DNS) is not
11805 sufficient on its own for the success of a host name lookup. If the reverse
11806 lookup succeeds, but there is a lookup problem such as a timeout when checking
11807 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11808 &"1"&. See also &$sender_host_name$&.
11809
11810 .vitem &$host_lookup_failed$&
11811 .vindex "&$host_lookup_failed$&"
11812 See &$host_lookup_deferred$&.
11813
11814 .vitem &$host_port$&
11815 .vindex "&$host_port$&"
11816 This variable is set to the remote host's TCP port whenever &$host$& is set
11817 for an outbound connection.
11818
11819 .vitem &$initial_cwd$&
11820 .vindex "&$initial_cwd$&
11821 This variable contains the full path name of the initial working
11822 directory of the current Exim process. This may differ from the current
11823 working directory, as Exim changes this to "/" during early startup, and
11824 to &$spool_directory$& later.
11825
11826 .vitem &$inode$&
11827 .vindex "&$inode$&"
11828 The only time this variable is set is while expanding the &%directory_file%&
11829 option in the &(appendfile)& transport. The variable contains the inode number
11830 of the temporary file which is about to be renamed. It can be used to construct
11831 a unique name for the file.
11832
11833 .vitem &$interface_address$&
11834 .vindex "&$interface_address$&"
11835 This is an obsolete name for &$received_ip_address$&.
11836
11837 .vitem &$interface_port$&
11838 .vindex "&$interface_port$&"
11839 This is an obsolete name for &$received_port$&.
11840
11841 .vitem &$item$&
11842 .vindex "&$item$&"
11843 This variable is used during the expansion of &*forall*& and &*forany*&
11844 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11845 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11846 empty.
11847
11848 .vitem &$ldap_dn$&
11849 .vindex "&$ldap_dn$&"
11850 This variable, which is available only when Exim is compiled with LDAP support,
11851 contains the DN from the last entry in the most recently successful LDAP
11852 lookup.
11853
11854 .vitem &$load_average$&
11855 .vindex "&$load_average$&"
11856 This variable contains the system load average, multiplied by 1000 so that it
11857 is an integer. For example, if the load average is 0.21, the value of the
11858 variable is 210. The value is recomputed every time the variable is referenced.
11859
11860 .vitem &$local_part$&
11861 .vindex "&$local_part$&"
11862 When an address is being routed, or delivered on its own, this
11863 variable contains the local part. When a number of addresses are being
11864 delivered together (for example, multiple RCPT commands in an SMTP
11865 session), &$local_part$& is not set.
11866
11867 Global address rewriting happens when a message is received, so the value of
11868 &$local_part$& during routing and delivery is the value after rewriting.
11869 &$local_part$& is set during user filtering, but not during system filtering,
11870 because a message may have many recipients and the system filter is called just
11871 once.
11872
11873 .vindex "&$local_part_prefix$&"
11874 .vindex "&$local_part_suffix$&"
11875 If a local part prefix or suffix has been recognized, it is not included in the
11876 value of &$local_part$& during routing and subsequent delivery. The values of
11877 any prefix or suffix are in &$local_part_prefix$& and
11878 &$local_part_suffix$&, respectively.
11879
11880 When a message is being delivered to a file, pipe, or autoreply transport as a
11881 result of aliasing or forwarding, &$local_part$& is set to the local part of
11882 the parent address, not to the file name or command (see &$address_file$& and
11883 &$address_pipe$&).
11884
11885 When an ACL is running for a RCPT command, &$local_part$& contains the
11886 local part of the recipient address.
11887
11888 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11889 &$local_part$& contains the local part of the address that is being rewritten;
11890 it can be used in the expansion of the replacement address, for example.
11891
11892 In all cases, all quoting is removed from the local part. For example, for both
11893 the addresses
11894 .code
11895 "abc:xyz"@test.example
11896 abc\:xyz@test.example
11897 .endd
11898 the value of &$local_part$& is
11899 .code
11900 abc:xyz
11901 .endd
11902 If you use &$local_part$& to create another address, you should always wrap it
11903 inside a quoting operator. For example, in a &(redirect)& router you could
11904 have:
11905 .code
11906 data = ${quote_local_part:$local_part}@new.domain.example
11907 .endd
11908 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11909 to process local parts in a case-dependent manner in a router, you can set the
11910 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11911
11912 .vitem &$local_part_data$&
11913 .vindex "&$local_part_data$&"
11914 When the &%local_parts%& option on a router matches a local part by means of a
11915 lookup, the data read by the lookup is available during the running of the
11916 router as &$local_part_data$&. In addition, if the driver routes the address
11917 to a transport, the value is available in that transport. If the transport is
11918 handling multiple addresses, the value from the first address is used.
11919
11920 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11921 matches a local part by means of a lookup. The data read by the lookup is
11922 available during the rest of the ACL statement. In all other situations, this
11923 variable expands to nothing.
11924
11925 .vitem &$local_part_prefix$&
11926 .vindex "&$local_part_prefix$&"
11927 When an address is being routed or delivered, and a
11928 specific prefix for the local part was recognized, it is available in this
11929 variable, having been removed from &$local_part$&.
11930
11931 .vitem &$local_part_suffix$&
11932 .vindex "&$local_part_suffix$&"
11933 When an address is being routed or delivered, and a
11934 specific suffix for the local part was recognized, it is available in this
11935 variable, having been removed from &$local_part$&.
11936
11937 .vitem &$local_scan_data$&
11938 .vindex "&$local_scan_data$&"
11939 This variable contains the text returned by the &[local_scan()]& function when
11940 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11941
11942 .vitem &$local_user_gid$&
11943 .vindex "&$local_user_gid$&"
11944 See &$local_user_uid$&.
11945
11946 .vitem &$local_user_uid$&
11947 .vindex "&$local_user_uid$&"
11948 This variable and &$local_user_gid$& are set to the uid and gid after the
11949 &%check_local_user%& router precondition succeeds. This means that their values
11950 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11951 and &%condition%&), for the &%address_data%& expansion, and for any
11952 router-specific expansions. At all other times, the values in these variables
11953 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11954
11955 .vitem &$localhost_number$&
11956 .vindex "&$localhost_number$&"
11957 This contains the expanded value of the
11958 &%localhost_number%& option. The expansion happens after the main options have
11959 been read.
11960
11961 .vitem &$log_inodes$&
11962 .vindex "&$log_inodes$&"
11963 The number of free inodes in the disk partition where Exim's
11964 log files are being written. The value is recalculated whenever the variable is
11965 referenced. If the relevant file system does not have the concept of inodes,
11966 the value of is -1. See also the &%check_log_inodes%& option.
11967
11968 .vitem &$log_space$&
11969 .vindex "&$log_space$&"
11970 The amount of free space (as a number of kilobytes) in the disk
11971 partition where Exim's log files are being written. The value is recalculated
11972 whenever the variable is referenced. If the operating system does not have the
11973 ability to find the amount of free space (only true for experimental systems),
11974 the space value is -1. See also the &%check_log_space%& option.
11975
11976
11977 .vitem &$lookup_dnssec_authenticated$&
11978 .vindex "&$lookup_dnssec_authenticated$&"
11979 This variable is set after a DNS lookup done by
11980 a dnsdb lookup expansion, dnslookup router or smtp transport.
11981 .cindex "DNS" "DNSSEC"
11982 It will be empty if &(DNSSEC)& was not requested,
11983 &"no"& if the result was not labelled as authenticated data
11984 and &"yes"& if it was.
11985 Results that are labelled as authoritative answer that match
11986 the &%dns_trust_aa%& configuration variable count also
11987 as authenticated data.
11988
11989 .vitem &$mailstore_basename$&
11990 .vindex "&$mailstore_basename$&"
11991 This variable is set only when doing deliveries in &"mailstore"& format in the
11992 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11993 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11994 contains the basename of the files that are being written, that is, the name
11995 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11996 variable is empty.
11997
11998 .vitem &$malware_name$&
11999 .vindex "&$malware_name$&"
12000 This variable is available when Exim is compiled with the
12001 content-scanning extension. It is set to the name of the virus that was found
12002 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12003
12004 .vitem &$max_received_linelength$&
12005 .vindex "&$max_received_linelength$&"
12006 .cindex "maximum" "line length"
12007 .cindex "line length" "maximum"
12008 This variable contains the number of bytes in the longest line that was
12009 received as part of the message, not counting the line termination
12010 character(s).
12011
12012 .vitem &$message_age$&
12013 .cindex "message" "age of"
12014 .vindex "&$message_age$&"
12015 This variable is set at the start of a delivery attempt to contain the number
12016 of seconds since the message was received. It does not change during a single
12017 delivery attempt.
12018
12019 .vitem &$message_body$&
12020 .cindex "body of message" "expansion variable"
12021 .cindex "message body" "in expansion"
12022 .cindex "binary zero" "in message body"
12023 .vindex "&$message_body$&"
12024 .oindex "&%message_body_visible%&"
12025 This variable contains the initial portion of a message's body while it is
12026 being delivered, and is intended mainly for use in filter files. The maximum
12027 number of characters of the body that are put into the variable is set by the
12028 &%message_body_visible%& configuration option; the default is 500.
12029
12030 .oindex "&%message_body_newlines%&"
12031 By default, newlines are converted into spaces in &$message_body$&, to make it
12032 easier to search for phrases that might be split over a line break. However,
12033 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12034 zeros are always converted into spaces.
12035
12036 .vitem &$message_body_end$&
12037 .cindex "body of message" "expansion variable"
12038 .cindex "message body" "in expansion"
12039 .vindex "&$message_body_end$&"
12040 This variable contains the final portion of a message's
12041 body while it is being delivered. The format and maximum size are as for
12042 &$message_body$&.
12043
12044 .vitem &$message_body_size$&
12045 .cindex "body of message" "size"
12046 .cindex "message body" "size"
12047 .vindex "&$message_body_size$&"
12048 When a message is being delivered, this variable contains the size of the body
12049 in bytes. The count starts from the character after the blank line that
12050 separates the body from the header. Newlines are included in the count. See
12051 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12052
12053 .vitem &$message_exim_id$&
12054 .vindex "&$message_exim_id$&"
12055 When a message is being received or delivered, this variable contains the
12056 unique message id that is generated and used by Exim to identify the message.
12057 An id is not created for a message until after its header has been successfully
12058 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12059 line; it is the local id that Exim assigns to the message, for example:
12060 &`1BXTIK-0001yO-VA`&.
12061
12062 .vitem &$message_headers$&
12063 .vindex &$message_headers$&
12064 This variable contains a concatenation of all the header lines when a message
12065 is being processed, except for lines added by routers or transports. The header
12066 lines are separated by newline characters. Their contents are decoded in the
12067 same way as a header line that is inserted by &%bheader%&.
12068
12069 .vitem &$message_headers_raw$&
12070 .vindex &$message_headers_raw$&
12071 This variable is like &$message_headers$& except that no processing of the
12072 contents of header lines is done.
12073
12074 .vitem &$message_id$&
12075 This is an old name for &$message_exim_id$&. It is now deprecated.
12076
12077 .vitem &$message_linecount$&
12078 .vindex "&$message_linecount$&"
12079 This variable contains the total number of lines in the header and body of the
12080 message. Compare &$body_linecount$&, which is the count for the body only.
12081 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12082 number of lines received. Before delivery happens (that is, before filters,
12083 routers, and transports run) the count is increased to include the
12084 &'Received:'& header line that Exim standardly adds, and also any other header
12085 lines that are added by ACLs. The blank line that separates the message header
12086 from the body is not counted.
12087
12088 As with the special case of &$message_size$&, during the expansion of the
12089 appendfile transport's maildir_tag option in maildir format, the value of
12090 &$message_linecount$& is the precise size of the number of newlines in the
12091 file that has been written (minus one for the blank line between the
12092 header and the body).
12093
12094 Here is an example of the use of this variable in a DATA ACL:
12095 .code
12096 deny message   = Too many lines in message header
12097      condition = \
12098       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12099 .endd
12100 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12101 message has not yet been received.
12102
12103 .vitem &$message_size$&
12104 .cindex "size" "of message"
12105 .cindex "message" "size"
12106 .vindex "&$message_size$&"
12107 When a message is being processed, this variable contains its size in bytes. In
12108 most cases, the size includes those headers that were received with the
12109 message, but not those (such as &'Envelope-to:'&) that are added to individual
12110 deliveries as they are written. However, there is one special case: during the
12111 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12112 doing a delivery in maildir format, the value of &$message_size$& is the
12113 precise size of the file that has been written. See also
12114 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12115
12116 .cindex "RCPT" "value of &$message_size$&"
12117 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12118 contains the size supplied on the MAIL command, or -1 if no size was given. The
12119 value may not, of course, be truthful.
12120
12121 .vitem &$mime_$&&'xxx'&
12122 A number of variables whose names start with &$mime$& are
12123 available when Exim is compiled with the content-scanning extension. For
12124 details, see section &<<SECTscanmimepart>>&.
12125
12126 .vitem "&$n0$& &-- &$n9$&"
12127 These variables are counters that can be incremented by means
12128 of the &%add%& command in filter files.
12129
12130 .vitem &$original_domain$&
12131 .vindex "&$domain$&"
12132 .vindex "&$original_domain$&"
12133 When a top-level address is being processed for delivery, this contains the
12134 same value as &$domain$&. However, if a &"child"& address (for example,
12135 generated by an alias, forward, or filter file) is being processed, this
12136 variable contains the domain of the original address (lower cased). This
12137 differs from &$parent_domain$& only when there is more than one level of
12138 aliasing or forwarding. When more than one address is being delivered in a
12139 single transport run, &$original_domain$& is not set.
12140
12141 If a new address is created by means of a &%deliver%& command in a system
12142 filter, it is set up with an artificial &"parent"& address. This has the local
12143 part &'system-filter'& and the default qualify domain.
12144
12145 .vitem &$original_local_part$&
12146 .vindex "&$local_part$&"
12147 .vindex "&$original_local_part$&"
12148 When a top-level address is being processed for delivery, this contains the
12149 same value as &$local_part$&, unless a prefix or suffix was removed from the
12150 local part, because &$original_local_part$& always contains the full local
12151 part. When a &"child"& address (for example, generated by an alias, forward, or
12152 filter file) is being processed, this variable contains the full local part of
12153 the original address.
12154
12155 If the router that did the redirection processed the local part
12156 case-insensitively, the value in &$original_local_part$& is in lower case.
12157 This variable differs from &$parent_local_part$& only when there is more than
12158 one level of aliasing or forwarding. When more than one address is being
12159 delivered in a single transport run, &$original_local_part$& is not set.
12160
12161 If a new address is created by means of a &%deliver%& command in a system
12162 filter, it is set up with an artificial &"parent"& address. This has the local
12163 part &'system-filter'& and the default qualify domain.
12164
12165 .vitem &$originator_gid$&
12166 .cindex "gid (group id)" "of originating user"
12167 .cindex "sender" "gid"
12168 .vindex "&$caller_gid$&"
12169 .vindex "&$originator_gid$&"
12170 This variable contains the value of &$caller_gid$& that was set when the
12171 message was received. For messages received via the command line, this is the
12172 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12173 normally the gid of the Exim user.
12174
12175 .vitem &$originator_uid$&
12176 .cindex "uid (user id)" "of originating user"
12177 .cindex "sender" "uid"
12178 .vindex "&$caller_uid$&"
12179 .vindex "&$originaltor_uid$&"
12180 The value of &$caller_uid$& that was set when the message was received. For
12181 messages received via the command line, this is the uid of the sending user.
12182 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12183 user.
12184
12185 .vitem &$parent_domain$&
12186 .vindex "&$parent_domain$&"
12187 This variable is similar to &$original_domain$& (see
12188 above), except that it refers to the immediately preceding parent address.
12189
12190 .vitem &$parent_local_part$&
12191 .vindex "&$parent_local_part$&"
12192 This variable is similar to &$original_local_part$&
12193 (see above), except that it refers to the immediately preceding parent address.
12194
12195 .vitem &$pid$&
12196 .cindex "pid (process id)" "of current process"
12197 .vindex "&$pid$&"
12198 This variable contains the current process id.
12199
12200 .vitem &$pipe_addresses$&
12201 .cindex "filter" "transport filter"
12202 .cindex "transport" "filter"
12203 .vindex "&$pipe_addresses$&"
12204 This is not an expansion variable, but is mentioned here because the string
12205 &`$pipe_addresses`& is handled specially in the command specification for the
12206 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12207 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12208 It cannot be used in general expansion strings, and provokes an &"unknown
12209 variable"& error if encountered.
12210
12211 .vitem &$primary_hostname$&
12212 .vindex "&$primary_hostname$&"
12213 This variable contains the value set by &%primary_hostname%& in the
12214 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12215 a single-component name, Exim calls &[gethostbyname()]& (or
12216 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12217 qualified host name. See also &$smtp_active_hostname$&.
12218
12219
12220 .new
12221 .vitem &$proxy_external_address$& &&&
12222        &$proxy_external_port$& &&&
12223        &$proxy_local_address$& &&&
12224        &$proxy_local_port$& &&&
12225        &$proxy_session$&
12226 These variables are only available when built with Proxy Protocol
12227 or Socks5 support
12228 For details see chapter &<<SECTproxyInbound>>&.
12229 .wen
12230
12231 .vitem &$prdr_requested$&
12232 .cindex "PRDR" "variable for"
12233 This variable is set to &"yes"& if PRDR was requested by the client for the
12234 current message, otherwise &"no"&.
12235
12236 .vitem &$prvscheck_address$&
12237 This variable is used in conjunction with the &%prvscheck%& expansion item,
12238 which is described in sections &<<SECTexpansionitems>>& and
12239 &<<SECTverifyPRVS>>&.
12240
12241 .vitem &$prvscheck_keynum$&
12242 This variable is used in conjunction with the &%prvscheck%& expansion item,
12243 which is described in sections &<<SECTexpansionitems>>& and
12244 &<<SECTverifyPRVS>>&.
12245
12246 .vitem &$prvscheck_result$&
12247 This variable is used in conjunction with the &%prvscheck%& expansion item,
12248 which is described in sections &<<SECTexpansionitems>>& and
12249 &<<SECTverifyPRVS>>&.
12250
12251 .vitem &$qualify_domain$&
12252 .vindex "&$qualify_domain$&"
12253 The value set for the &%qualify_domain%& option in the configuration file.
12254
12255 .vitem &$qualify_recipient$&
12256 .vindex "&$qualify_recipient$&"
12257 The value set for the &%qualify_recipient%& option in the configuration file,
12258 or if not set, the value of &$qualify_domain$&.
12259
12260 .new
12261 .vitem &$queue_name$&
12262 .vindex &$queue_name$&
12263 .cindex "named queues"
12264 .cindex queues named
12265 The name of the spool queue in use; empty for the default queue.
12266 .wen
12267
12268 .vitem &$rcpt_count$&
12269 .vindex "&$rcpt_count$&"
12270 When a message is being received by SMTP, this variable contains the number of
12271 RCPT commands received for the current message. If this variable is used in a
12272 RCPT ACL, its value includes the current command.
12273
12274 .vitem &$rcpt_defer_count$&
12275 .vindex "&$rcpt_defer_count$&"
12276 .cindex "4&'xx'& responses" "count of"
12277 When a message is being received by SMTP, this variable contains the number of
12278 RCPT commands in the current message that have previously been rejected with a
12279 temporary (4&'xx'&) response.
12280
12281 .vitem &$rcpt_fail_count$&
12282 .vindex "&$rcpt_fail_count$&"
12283 When a message is being received by SMTP, this variable contains the number of
12284 RCPT commands in the current message that have previously been rejected with a
12285 permanent (5&'xx'&) response.
12286
12287 .vitem &$received_count$&
12288 .vindex "&$received_count$&"
12289 This variable contains the number of &'Received:'& header lines in the message,
12290 including the one added by Exim (so its value is always greater than zero). It
12291 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12292 delivering.
12293
12294 .vitem &$received_for$&
12295 .vindex "&$received_for$&"
12296 If there is only a single recipient address in an incoming message, this
12297 variable contains that address when the &'Received:'& header line is being
12298 built. The value is copied after recipient rewriting has happened, but before
12299 the &[local_scan()]& function is run.
12300
12301 .vitem &$received_ip_address$&
12302 .vindex "&$received_ip_address$&"
12303 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12304 variable is set to the address of the local IP interface, and &$received_port$&
12305 is set to the local port number. (The remote IP address and port are in
12306 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12307 the port value is -1 unless it has been set using the &%-oMi%& command line
12308 option.
12309
12310 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12311 could be used, for example, to make the file name for a TLS certificate depend
12312 on which interface and/or port is being used for the incoming connection. The
12313 values of &$received_ip_address$& and &$received_port$& are saved with any
12314 messages that are received, thus making these variables available at delivery
12315 time.
12316 For outbound connections see &$sending_ip_address$&.
12317
12318 .vitem &$received_port$&
12319 .vindex "&$received_port$&"
12320 See &$received_ip_address$&.
12321
12322 .vitem &$received_protocol$&
12323 .vindex "&$received_protocol$&"
12324 When a message is being processed, this variable contains the name of the
12325 protocol by which it was received. Most of the names used by Exim are defined
12326 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12327 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12328 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12329 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12330 connection and the client was successfully authenticated.
12331
12332 Exim uses the protocol name &"smtps"& for the case when encryption is
12333 automatically set up on connection without the use of STARTTLS (see
12334 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12335 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12336 where the client initially uses EHLO, sets up an encrypted connection using
12337 STARTTLS, and then uses HELO afterwards.
12338
12339 The &%-oMr%& option provides a way of specifying a custom protocol name for
12340 messages that are injected locally by trusted callers. This is commonly used to
12341 identify messages that are being re-injected after some kind of scanning.
12342
12343 .vitem &$received_time$&
12344 .vindex "&$received_time$&"
12345 This variable contains the date and time when the current message was received,
12346 as a number of seconds since the start of the Unix epoch.
12347
12348 .vitem &$recipient_data$&
12349 .vindex "&$recipient_data$&"
12350 This variable is set after an indexing lookup success in an ACL &%recipients%&
12351 condition. It contains the data from the lookup, and the value remains set
12352 until the next &%recipients%& test. Thus, you can do things like this:
12353 .display
12354 &`require recipients  = cdb*@;/some/file`&
12355 &`deny    `&&'some further test involving'& &`$recipient_data`&
12356 .endd
12357 &*Warning*&: This variable is set only when a lookup is used as an indexing
12358 method in the address list, using the semicolon syntax as in the example above.
12359 The variable is not set for a lookup that is used as part of the string
12360 expansion that all such lists undergo before being interpreted.
12361
12362 .vitem &$recipient_verify_failure$&
12363 .vindex "&$recipient_verify_failure$&"
12364 In an ACL, when a recipient verification fails, this variable contains
12365 information about the failure. It is set to one of the following words:
12366
12367 .ilist
12368 &"qualify"&: The address was unqualified (no domain), and the message
12369 was neither local nor came from an exempted host.
12370
12371 .next
12372 &"route"&: Routing failed.
12373
12374 .next
12375 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12376 or before the MAIL command (that is, on initial connection, HELO, or
12377 MAIL).
12378
12379 .next
12380 &"recipient"&: The RCPT command in a callout was rejected.
12381 .next
12382
12383 &"postmaster"&: The postmaster check in a callout was rejected.
12384 .endlist
12385
12386 The main use of this variable is expected to be to distinguish between
12387 rejections of MAIL and rejections of RCPT.
12388
12389 .vitem &$recipients$&
12390 .vindex "&$recipients$&"
12391 This variable contains a list of envelope recipients for a message. A comma and
12392 a space separate the addresses in the replacement text. However, the variable
12393 is not generally available, to prevent exposure of Bcc recipients in
12394 unprivileged users' filter files. You can use &$recipients$& only in these
12395 cases:
12396
12397 .olist
12398 In a system filter file.
12399 .next
12400 In the ACLs associated with the DATA command and with non-SMTP messages, that
12401 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12402 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12403 &%acl_not_smtp_mime%&.
12404 .next
12405 From within a &[local_scan()]& function.
12406 .endlist
12407
12408
12409 .vitem &$recipients_count$&
12410 .vindex "&$recipients_count$&"
12411 When a message is being processed, this variable contains the number of
12412 envelope recipients that came with the message. Duplicates are not excluded
12413 from the count. While a message is being received over SMTP, the number
12414 increases for each accepted recipient. It can be referenced in an ACL.
12415
12416
12417 .vitem &$regex_match_string$&
12418 .vindex "&$regex_match_string$&"
12419 This variable is set to contain the matching regular expression after a
12420 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12421
12422 .vitem "&$regex1$&, &$regex2$&, etc"
12423 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12424 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12425 these variables contain the
12426 captured substrings identified by the regular expression.
12427
12428
12429 .vitem &$reply_address$&
12430 .vindex "&$reply_address$&"
12431 When a message is being processed, this variable contains the contents of the
12432 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12433 contents of the &'From:'& header line. Apart from the removal of leading
12434 white space, the value is not processed in any way. In particular, no RFC 2047
12435 decoding or character code translation takes place.
12436
12437 .vitem &$return_path$&
12438 .vindex "&$return_path$&"
12439 When a message is being delivered, this variable contains the return path &--
12440 the sender field that will be sent as part of the envelope. It is not enclosed
12441 in <> characters. At the start of routing an address, &$return_path$& has the
12442 same value as &$sender_address$&, but if, for example, an incoming message to a
12443 mailing list has been expanded by a router which specifies a different address
12444 for bounce messages, &$return_path$& subsequently contains the new bounce
12445 address, whereas &$sender_address$& always contains the original sender address
12446 that was received with the message. In other words, &$sender_address$& contains
12447 the incoming envelope sender, and &$return_path$& contains the outgoing
12448 envelope sender.
12449
12450 .vitem &$return_size_limit$&
12451 .vindex "&$return_size_limit$&"
12452 This is an obsolete name for &$bounce_return_size_limit$&.
12453
12454 .vitem &$router_name$&
12455 .cindex "router" "name"
12456 .cindex "name" "of router"
12457 .vindex "&$router_name$&"
12458 During the running of a router this variable contains its name.
12459
12460 .vitem &$runrc$&
12461 .cindex "return code" "from &%run%& expansion"
12462 .vindex "&$runrc$&"
12463 This variable contains the return code from a command that is run by the
12464 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12465 assume the order in which option values are expanded, except for those
12466 preconditions whose order of testing is documented. Therefore, you cannot
12467 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12468 another.
12469
12470 .vitem &$self_hostname$&
12471 .oindex "&%self%&" "value of host name"
12472 .vindex "&$self_hostname$&"
12473 When an address is routed to a supposedly remote host that turns out to be the
12474 local host, what happens is controlled by the &%self%& generic router option.
12475 One of its values causes the address to be passed to another router. When this
12476 happens, &$self_hostname$& is set to the name of the local host that the
12477 original router encountered. In other circumstances its contents are null.
12478
12479 .vitem &$sender_address$&
12480 .vindex "&$sender_address$&"
12481 When a message is being processed, this variable contains the sender's address
12482 that was received in the message's envelope. The case of letters in the address
12483 is retained, in both the local part and the domain. For bounce messages, the
12484 value of this variable is the empty string. See also &$return_path$&.
12485
12486 .vitem &$sender_address_data$&
12487 .vindex "&$address_data$&"
12488 .vindex "&$sender_address_data$&"
12489 If &$address_data$& is set when the routers are called from an ACL to verify a
12490 sender address, the final value is preserved in &$sender_address_data$&, to
12491 distinguish it from data from a recipient address. The value does not persist
12492 after the end of the current ACL statement. If you want to preserve it for
12493 longer, you can save it in an ACL variable.
12494
12495 .vitem &$sender_address_domain$&
12496 .vindex "&$sender_address_domain$&"
12497 The domain portion of &$sender_address$&.
12498
12499 .vitem &$sender_address_local_part$&
12500 .vindex "&$sender_address_local_part$&"
12501 The local part portion of &$sender_address$&.
12502
12503 .vitem &$sender_data$&
12504 .vindex "&$sender_data$&"
12505 This variable is set after a lookup success in an ACL &%senders%& condition or
12506 in a router &%senders%& option. It contains the data from the lookup, and the
12507 value remains set until the next &%senders%& test. Thus, you can do things like
12508 this:
12509 .display
12510 &`require senders      = cdb*@;/some/file`&
12511 &`deny    `&&'some further test involving'& &`$sender_data`&
12512 .endd
12513 &*Warning*&: This variable is set only when a lookup is used as an indexing
12514 method in the address list, using the semicolon syntax as in the example above.
12515 The variable is not set for a lookup that is used as part of the string
12516 expansion that all such lists undergo before being interpreted.
12517
12518 .vitem &$sender_fullhost$&
12519 .vindex "&$sender_fullhost$&"
12520 When a message is received from a remote host, this variable contains the host
12521 name and IP address in a single string. It ends with the IP address in square
12522 brackets, followed by a colon and a port number if the logging of ports is
12523 enabled. The format of the rest of the string depends on whether the host
12524 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12525 looking up its IP address. (Looking up the IP address can be forced by the
12526 &%host_lookup%& option, independent of verification.) A plain host name at the
12527 start of the string is a verified host name; if this is not present,
12528 verification either failed or was not requested. A host name in parentheses is
12529 the argument of a HELO or EHLO command. This is omitted if it is identical to
12530 the verified host name or to the host's IP address in square brackets.
12531
12532 .vitem &$sender_helo_dnssec$&
12533 .vindex "&$sender_helo_dnssec$&"
12534 This boolean variable is true if a successful HELO verification was
12535 .cindex "DNS" "DNSSEC"
12536 done using DNS information the resolver library stated was authenticated data.
12537
12538 .vitem &$sender_helo_name$&
12539 .vindex "&$sender_helo_name$&"
12540 When a message is received from a remote host that has issued a HELO or EHLO
12541 command, the argument of that command is placed in this variable. It is also
12542 set if HELO or EHLO is used when a message is received using SMTP locally via
12543 the &%-bs%& or &%-bS%& options.
12544
12545 .vitem &$sender_host_address$&
12546 .vindex "&$sender_host_address$&"
12547 When a message is received from a remote host using SMTP,
12548 this variable contains that
12549 host's IP address. For locally non-SMTP submitted messages, it is empty.
12550
12551 .vitem &$sender_host_authenticated$&
12552 .vindex "&$sender_host_authenticated$&"
12553 This variable contains the name (not the public name) of the authenticator
12554 driver that successfully authenticated the client from which the message was
12555 received. It is empty if there was no successful authentication. See also
12556 &$authenticated_id$&.
12557
12558 .vitem &$sender_host_dnssec$&
12559 .vindex "&$sender_host_dnssec$&"
12560 If an attempt to populate &$sender_host_name$& has been made
12561 (by reference, &%hosts_lookup%& or
12562 otherwise) then this boolean will have been set true if, and only if, the
12563 resolver library states that both
12564 the reverse and forward DNS were authenticated data.  At all
12565 other times, this variable is false.
12566
12567 .cindex "DNS" "DNSSEC"
12568 It is likely that you will need to coerce DNSSEC support on in the resolver
12569 library, by setting:
12570 .code
12571 dns_dnssec_ok = 1
12572 .endd
12573
12574 Exim does not perform DNSSEC validation itself, instead leaving that to a
12575 validating resolver (e.g. unbound, or bind with suitable configuration).
12576
12577 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12578 mechanism in the list, then this variable will be false.
12579
12580
12581 .vitem &$sender_host_name$&
12582 .vindex "&$sender_host_name$&"
12583 When a message is received from a remote host, this variable contains the
12584 host's name as obtained by looking up its IP address. For messages received by
12585 other means, this variable is empty.
12586
12587 .vindex "&$host_lookup_failed$&"
12588 If the host name has not previously been looked up, a reference to
12589 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12590 A looked up name is accepted only if it leads back to the original IP address
12591 via a forward lookup. If either the reverse or the forward lookup fails to find
12592 any data, or if the forward lookup does not yield the original IP address,
12593 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12594
12595 .vindex "&$host_lookup_deferred$&"
12596 However, if either of the lookups cannot be completed (for example, there is a
12597 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12598 &$host_lookup_failed$& remains set to &"0"&.
12599
12600 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12601 host name again if there is a subsequent reference to &$sender_host_name$&
12602 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12603 is set to &"1"&.
12604
12605 Exim does not automatically look up every calling host's name. If you want
12606 maximum efficiency, you should arrange your configuration so that it avoids
12607 these lookups altogether. The lookup happens only if one or more of the
12608 following are true:
12609
12610 .ilist
12611 A string containing &$sender_host_name$& is expanded.
12612 .next
12613 The calling host matches the list in &%host_lookup%&. In the default
12614 configuration, this option is set to *, so it must be changed if lookups are
12615 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12616 .next
12617 Exim needs the host name in order to test an item in a host list. The items
12618 that require this are described in sections &<<SECThoslispatnam>>& and
12619 &<<SECThoslispatnamsk>>&.
12620 .next
12621 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12622 In this case, the host name is required to compare with the name quoted in any
12623 EHLO or HELO commands that the client issues.
12624 .next
12625 The remote host issues a EHLO or HELO command that quotes one of the
12626 domains in &%helo_lookup_domains%&. The default value of this option is
12627 . ==== As this is a nested list, any displays it contains must be indented
12628 . ==== as otherwise they are too far to the left.
12629 .code
12630   helo_lookup_domains = @ : @[]
12631 .endd
12632 which causes a lookup if a remote host (incorrectly) gives the server's name or
12633 IP address in an EHLO or HELO command.
12634 .endlist
12635
12636
12637 .vitem &$sender_host_port$&
12638 .vindex "&$sender_host_port$&"
12639 When a message is received from a remote host, this variable contains the port
12640 number that was used on the remote host.
12641
12642 .vitem &$sender_ident$&
12643 .vindex "&$sender_ident$&"
12644 When a message is received from a remote host, this variable contains the
12645 identification received in response to an RFC 1413 request. When a message has
12646 been received locally, this variable contains the login name of the user that
12647 called Exim.
12648
12649 .vitem &$sender_rate_$&&'xxx'&
12650 A number of variables whose names begin &$sender_rate_$& are set as part of the
12651 &%ratelimit%& ACL condition. Details are given in section
12652 &<<SECTratelimiting>>&.
12653
12654 .vitem &$sender_rcvhost$&
12655 .cindex "DNS" "reverse lookup"
12656 .cindex "reverse DNS lookup"
12657 .vindex "&$sender_rcvhost$&"
12658 This is provided specifically for use in &'Received:'& headers. It starts with
12659 either the verified host name (as obtained from a reverse DNS lookup) or, if
12660 there is no verified host name, the IP address in square brackets. After that
12661 there may be text in parentheses. When the first item is a verified host name,
12662 the first thing in the parentheses is the IP address in square brackets,
12663 followed by a colon and a port number if port logging is enabled. When the
12664 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12665 the parentheses.
12666
12667 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12668 was used and its argument was not identical to the real host name or IP
12669 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12670 all three items are present in the parentheses, a newline and tab are inserted
12671 into the string, to improve the formatting of the &'Received:'& header.
12672
12673 .vitem &$sender_verify_failure$&
12674 .vindex "&$sender_verify_failure$&"
12675 In an ACL, when a sender verification fails, this variable contains information
12676 about the failure. The details are the same as for
12677 &$recipient_verify_failure$&.
12678
12679 .vitem &$sending_ip_address$&
12680 .vindex "&$sending_ip_address$&"
12681 This variable is set whenever an outgoing SMTP connection to another host has
12682 been set up. It contains the IP address of the local interface that is being
12683 used. This is useful if a host that has more than one IP address wants to take
12684 on different personalities depending on which one is being used. For incoming
12685 connections, see &$received_ip_address$&.
12686
12687 .vitem &$sending_port$&
12688 .vindex "&$sending_port$&"
12689 This variable is set whenever an outgoing SMTP connection to another host has
12690 been set up. It contains the local port that is being used. For incoming
12691 connections, see &$received_port$&.
12692
12693 .vitem &$smtp_active_hostname$&
12694 .vindex "&$smtp_active_hostname$&"
12695 During an incoming SMTP session, this variable contains the value of the active
12696 host name, as specified by the &%smtp_active_hostname%& option. The value of
12697 &$smtp_active_hostname$& is saved with any message that is received, so its
12698 value can be consulted during routing and delivery.
12699
12700 .vitem &$smtp_command$&
12701 .vindex "&$smtp_command$&"
12702 During the processing of an incoming SMTP command, this variable contains the
12703 entire command. This makes it possible to distinguish between HELO and EHLO in
12704 the HELO ACL, and also to distinguish between commands such as these:
12705 .code
12706 MAIL FROM:<>
12707 MAIL FROM: <>
12708 .endd
12709 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12710 command, the address in &$smtp_command$& is the original address before any
12711 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12712 the address after SMTP-time rewriting.
12713
12714 .vitem &$smtp_command_argument$&
12715 .cindex "SMTP" "command, argument for"
12716 .vindex "&$smtp_command_argument$&"
12717 While an ACL is running to check an SMTP command, this variable contains the
12718 argument, that is, the text that follows the command name, with leading white
12719 space removed. Following the introduction of &$smtp_command$&, this variable is
12720 somewhat redundant, but is retained for backwards compatibility.
12721
12722 .vitem &$smtp_count_at_connection_start$&
12723 .vindex "&$smtp_count_at_connection_start$&"
12724 This variable is set greater than zero only in processes spawned by the Exim
12725 daemon for handling incoming SMTP connections. The name is deliberately long,
12726 in order to emphasize what the contents are. When the daemon accepts a new
12727 connection, it increments this variable. A copy of the variable is passed to
12728 the child process that handles the connection, but its value is fixed, and
12729 never changes. It is only an approximation of how many incoming connections
12730 there actually are, because many other connections may come and go while a
12731 single connection is being processed. When a child process terminates, the
12732 daemon decrements its copy of the variable.
12733
12734 .vitem "&$sn0$& &-- &$sn9$&"
12735 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12736 that were current at the end of the system filter file. This allows a system
12737 filter file to set values that can be tested in users' filter files. For
12738 example, a system filter could set a value indicating how likely it is that a
12739 message is junk mail.
12740
12741 .vitem &$spam_$&&'xxx'&
12742 A number of variables whose names start with &$spam$& are available when Exim
12743 is compiled with the content-scanning extension. For details, see section
12744 &<<SECTscanspamass>>&.
12745
12746
12747 .vitem &$spool_directory$&
12748 .vindex "&$spool_directory$&"
12749 The name of Exim's spool directory.
12750
12751 .vitem &$spool_inodes$&
12752 .vindex "&$spool_inodes$&"
12753 The number of free inodes in the disk partition where Exim's spool files are
12754 being written. The value is recalculated whenever the variable is referenced.
12755 If the relevant file system does not have the concept of inodes, the value of
12756 is -1. See also the &%check_spool_inodes%& option.
12757
12758 .vitem &$spool_space$&
12759 .vindex "&$spool_space$&"
12760 The amount of free space (as a number of kilobytes) in the disk partition where
12761 Exim's spool files are being written. The value is recalculated whenever the
12762 variable is referenced. If the operating system does not have the ability to
12763 find the amount of free space (only true for experimental systems), the space
12764 value is -1. For example, to check in an ACL that there is at least 50
12765 megabytes free on the spool, you could write:
12766 .code
12767 condition = ${if > {$spool_space}{50000}}
12768 .endd
12769 See also the &%check_spool_space%& option.
12770
12771
12772 .vitem &$thisaddress$&
12773 .vindex "&$thisaddress$&"
12774 This variable is set only during the processing of the &%foranyaddress%&
12775 command in a filter file. Its use is explained in the description of that
12776 command, which can be found in the separate document entitled &'Exim's
12777 interfaces to mail filtering'&.
12778
12779 .vitem &$tls_in_bits$&
12780 .vindex "&$tls_in_bits$&"
12781 Contains an approximation of the TLS cipher's bit-strength
12782 on the inbound connection; the meaning of
12783 this depends upon the TLS implementation used.
12784 If TLS has not been negotiated, the value will be 0.
12785 The value of this is automatically fed into the Cyrus SASL authenticator
12786 when acting as a server, to specify the "external SSF" (a SASL term).
12787
12788 The deprecated &$tls_bits$& variable refers to the inbound side
12789 except when used in the context of an outbound SMTP delivery, when it refers to
12790 the outbound.
12791
12792 .vitem &$tls_out_bits$&
12793 .vindex "&$tls_out_bits$&"
12794 Contains an approximation of the TLS cipher's bit-strength
12795 on an outbound SMTP connection; the meaning of
12796 this depends upon the TLS implementation used.
12797 If TLS has not been negotiated, the value will be 0.
12798
12799 .vitem &$tls_in_ourcert$&
12800 .vindex "&$tls_in_ourcert$&"
12801 .cindex certificate veriables
12802 This variable refers to the certificate presented to the peer of an
12803 inbound connection when the message was received.
12804 It is only useful as the argument of a
12805 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12806 or a &%def%& condition.
12807
12808 .vitem &$tls_in_peercert$&
12809 .vindex "&$tls_in_peercert$&"
12810 This variable refers to the certificate presented by the peer of an
12811 inbound connection when the message was received.
12812 It is only useful as the argument of a
12813 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12814 or a &%def%& condition.
12815 If certificate verification fails it may refer to a failing chain element
12816 which is not the leaf.
12817
12818 .vitem &$tls_out_ourcert$&
12819 .vindex "&$tls_out_ourcert$&"
12820 This variable refers to the certificate presented to the peer of an
12821 outbound connection.  It is only useful as the argument of a
12822 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12823 or a &%def%& condition.
12824
12825 .vitem &$tls_out_peercert$&
12826 .vindex "&$tls_out_peercert$&"
12827 This variable refers to the certificate presented by the peer of an
12828 outbound connection.  It is only useful as the argument of a
12829 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12830 or a &%def%& condition.
12831 If certificate verification fails it may refer to a failing chain element
12832 which is not the leaf.
12833
12834 .vitem &$tls_in_certificate_verified$&
12835 .vindex "&$tls_in_certificate_verified$&"
12836 This variable is set to &"1"& if a TLS certificate was verified when the
12837 message was received, and &"0"& otherwise.
12838
12839 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12840 except when used in the context of an outbound SMTP delivery, when it refers to
12841 the outbound.
12842
12843 .vitem &$tls_out_certificate_verified$&
12844 .vindex "&$tls_out_certificate_verified$&"
12845 This variable is set to &"1"& if a TLS certificate was verified when an
12846 outbound SMTP connection was made,
12847 and &"0"& otherwise.
12848
12849 .vitem &$tls_in_cipher$&
12850 .vindex "&$tls_in_cipher$&"
12851 .vindex "&$tls_cipher$&"
12852 When a message is received from a remote host over an encrypted SMTP
12853 connection, this variable is set to the cipher suite that was negotiated, for
12854 example DES-CBC3-SHA. In other circumstances, in particular, for message
12855 received over unencrypted connections, the variable is empty. Testing
12856 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12857 non-encrypted connections during ACL processing.
12858
12859 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12860 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12861 becomes the same as &$tls_out_cipher$&.
12862
12863 .vitem &$tls_out_cipher$&
12864 .vindex "&$tls_out_cipher$&"
12865 This variable is
12866 cleared before any outgoing SMTP connection is made,
12867 and then set to the outgoing cipher suite if one is negotiated. See chapter
12868 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12869 details of the &(smtp)& transport.
12870
12871 .vitem &$tls_in_ocsp$&
12872 .vindex "&$tls_in_ocsp$&"
12873 When a message is received from a remote client connection
12874 the result of any OCSP request from the client is encoded in this variable:
12875 .code
12876 0 OCSP proof was not requested (default value)
12877 1 No response to request
12878 2 Response not verified
12879 3 Verification failed
12880 4 Verification succeeded
12881 .endd
12882
12883 .vitem &$tls_out_ocsp$&
12884 .vindex "&$tls_out_ocsp$&"
12885 When a message is sent to a remote host connection
12886 the result of any OCSP request made is encoded in this variable.
12887 See &$tls_in_ocsp$& for values.
12888
12889 .vitem &$tls_in_peerdn$&
12890 .vindex "&$tls_in_peerdn$&"
12891 .vindex "&$tls_peerdn$&"
12892 .cindex certificate "extracting fields"
12893 When a message is received from a remote host over an encrypted SMTP
12894 connection, and Exim is configured to request a certificate from the client,
12895 the value of the Distinguished Name of the certificate is made available in the
12896 &$tls_in_peerdn$& during subsequent processing.
12897 If certificate verification fails it may refer to a failing chain element
12898 which is not the leaf.
12899
12900 The deprecated &$tls_peerdn$& variable refers to the inbound side
12901 except when used in the context of an outbound SMTP delivery, when it refers to
12902 the outbound.
12903
12904 .vitem &$tls_out_peerdn$&
12905 .vindex "&$tls_out_peerdn$&"
12906 When a message is being delivered to a remote host over an encrypted SMTP
12907 connection, and Exim is configured to request a certificate from the server,
12908 the value of the Distinguished Name of the certificate is made available in the
12909 &$tls_out_peerdn$& during subsequent processing.
12910 If certificate verification fails it may refer to a failing chain element
12911 which is not the leaf.
12912
12913 .vitem &$tls_in_sni$&
12914 .vindex "&$tls_in_sni$&"
12915 .vindex "&$tls_sni$&"
12916 .cindex "TLS" "Server Name Indication"
12917 When a TLS session is being established, if the client sends the Server
12918 Name Indication extension, the value will be placed in this variable.
12919 If the variable appears in &%tls_certificate%& then this option and
12920 some others, described in &<<SECTtlssni>>&,
12921 will be re-expanded early in the TLS session, to permit
12922 a different certificate to be presented (and optionally a different key to be
12923 used) to the client, based upon the value of the SNI extension.
12924
12925 The deprecated &$tls_sni$& variable refers to the inbound side
12926 except when used in the context of an outbound SMTP delivery, when it refers to
12927 the outbound.
12928
12929 .vitem &$tls_out_sni$&
12930 .vindex "&$tls_out_sni$&"
12931 .cindex "TLS" "Server Name Indication"
12932 During outbound
12933 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12934 the transport.
12935
12936 .vitem &$tod_bsdinbox$&
12937 .vindex "&$tod_bsdinbox$&"
12938 The time of day and the date, in the format required for BSD-style mailbox
12939 files, for example: Thu Oct 17 17:14:09 1995.
12940
12941 .vitem &$tod_epoch$&
12942 .vindex "&$tod_epoch$&"
12943 The time and date as a number of seconds since the start of the Unix epoch.
12944
12945 .vitem &$tod_epoch_l$&
12946 .vindex "&$tod_epoch_l$&"
12947 The time and date as a number of microseconds since the start of the Unix epoch.
12948
12949 .vitem &$tod_full$&
12950 .vindex "&$tod_full$&"
12951 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12952 +0100. The timezone is always given as a numerical offset from UTC, with
12953 positive values used for timezones that are ahead (east) of UTC, and negative
12954 values for those that are behind (west).
12955
12956 .vitem &$tod_log$&
12957 .vindex "&$tod_log$&"
12958 The time and date in the format used for writing Exim's log files, for example:
12959 1995-10-12 15:32:29, but without a timezone.
12960
12961 .vitem &$tod_logfile$&
12962 .vindex "&$tod_logfile$&"
12963 This variable contains the date in the format yyyymmdd. This is the format that
12964 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12965 flag.
12966
12967 .vitem &$tod_zone$&
12968 .vindex "&$tod_zone$&"
12969 This variable contains the numerical value of the local timezone, for example:
12970 -0500.
12971
12972 .vitem &$tod_zulu$&
12973 .vindex "&$tod_zulu$&"
12974 This variable contains the UTC date and time in &"Zulu"& format, as specified
12975 by ISO 8601, for example: 20030221154023Z.
12976
12977 .vitem &$transport_name$&
12978 .cindex "transport" "name"
12979 .cindex "name" "of transport"
12980 .vindex "&$transport_name$&"
12981 During the running of a transport, this variable contains its name.
12982
12983 .vitem &$value$&
12984 .vindex "&$value$&"
12985 This variable contains the result of an expansion lookup, extraction operation,
12986 or external command, as described above. It is also used during a
12987 &*reduce*& expansion.
12988
12989 .vitem &$verify_mode$&
12990 .vindex "&$verify_mode$&"
12991 While a router or transport is being run in verify mode
12992 or for cutthrough delivery,
12993 contains "S" for sender-verification or "R" for recipient-verification.
12994 Otherwise, empty.
12995
12996 .vitem &$version_number$&
12997 .vindex "&$version_number$&"
12998 The version number of Exim.
12999
13000 .vitem &$warn_message_delay$&
13001 .vindex "&$warn_message_delay$&"
13002 This variable is set only during the creation of a message warning about a
13003 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13004
13005 .vitem &$warn_message_recipients$&
13006 .vindex "&$warn_message_recipients$&"
13007 This variable is set only during the creation of a message warning about a
13008 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13009 .endlist
13010 .ecindex IIDstrexp
13011
13012
13013
13014 . ////////////////////////////////////////////////////////////////////////////
13015 . ////////////////////////////////////////////////////////////////////////////
13016
13017 .chapter "Embedded Perl" "CHAPperl"
13018 .scindex IIDperl "Perl" "calling from Exim"
13019 Exim can be built to include an embedded Perl interpreter. When this is done,
13020 Perl subroutines can be called as part of the string expansion process. To make
13021 use of the Perl support, you need version 5.004 or later of Perl installed on
13022 your system. To include the embedded interpreter in the Exim binary, include
13023 the line
13024 .code
13025 EXIM_PERL = perl.o
13026 .endd
13027 in your &_Local/Makefile_& and then build Exim in the normal way.
13028
13029
13030 .section "Setting up so Perl can be used" "SECID85"
13031 .oindex "&%perl_startup%&"
13032 Access to Perl subroutines is via a global configuration option called
13033 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13034 no &%perl_startup%& option in the Exim configuration file then no Perl
13035 interpreter is started and there is almost no overhead for Exim (since none of
13036 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13037 option then the associated value is taken to be Perl code which is executed in
13038 a newly created Perl interpreter.
13039
13040 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13041 need backslashes before any characters to escape special meanings. The option
13042 should usually be something like
13043 .code
13044 perl_startup = do '/etc/exim.pl'
13045 .endd
13046 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13047 use from Exim. Exim can be configured either to start up a Perl interpreter as
13048 soon as it is entered, or to wait until the first time it is needed. Starting
13049 the interpreter at the beginning ensures that it is done while Exim still has
13050 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13051 fact used in a particular run. Also, note that this does not mean that Exim is
13052 necessarily running as root when Perl is called at a later time. By default,
13053 the interpreter is started only when it is needed, but this can be changed in
13054 two ways:
13055
13056 .ilist
13057 .oindex "&%perl_at_start%&"
13058 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13059 a startup when Exim is entered.
13060 .next
13061 The command line option &%-ps%& also requests a startup when Exim is entered,
13062 overriding the setting of &%perl_at_start%&.
13063 .endlist
13064
13065 There is also a command line option &%-pd%& (for delay) which suppresses the
13066 initial startup, even if &%perl_at_start%& is set.
13067
13068 .new
13069 .ilist
13070 .oindex "&%perl_taintmode%&"
13071 .cindex "Perl" "taintmode"
13072 To provide more security executing Perl code via the embedded Perl
13073 interpeter, the &%perl_taintmode%& option can be set. This enables the
13074 taint mode of the Perl interpreter. You are encouraged to set this
13075 option to a true value. To avoid breaking existing installations, it
13076 defaults to false.
13077 .wen
13078
13079
13080 .section "Calling Perl subroutines" "SECID86"
13081 When the configuration file includes a &%perl_startup%& option you can make use
13082 of the string expansion item to call the Perl subroutines that are defined
13083 by the &%perl_startup%& code. The operator is used in any of the following
13084 forms:
13085 .code
13086 ${perl{foo}}
13087 ${perl{foo}{argument}}
13088 ${perl{foo}{argument1}{argument2} ... }
13089 .endd
13090 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13091 arguments may be passed. Passing more than this results in an expansion failure
13092 with an error message of the form
13093 .code
13094 Too many arguments passed to Perl subroutine "foo" (max is 8)
13095 .endd
13096 The return value of the Perl subroutine is evaluated in a scalar context before
13097 it is passed back to Exim to be inserted into the expanded string. If the
13098 return value is &'undef'&, the expansion is forced to fail in the same way as
13099 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13100 by obeying Perl's &%die%& function, the expansion fails with the error message
13101 that was passed to &%die%&.
13102
13103
13104 .section "Calling Exim functions from Perl" "SECID87"
13105 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13106 is available to call back into Exim's string expansion function. For example,
13107 the Perl code
13108 .code
13109 my $lp = Exim::expand_string('$local_part');
13110 .endd
13111 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13112 Note those are single quotes and not double quotes to protect against
13113 &$local_part$& being interpolated as a Perl variable.
13114
13115 If the string expansion is forced to fail by a &"fail"& item, the result of
13116 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13117 expansion string, the Perl call from the original expansion string fails with
13118 an appropriate error message, in the same way as if &%die%& were used.
13119
13120 .cindex "debugging" "from embedded Perl"
13121 .cindex "log" "writing from embedded Perl"
13122 Two other Exim functions are available for use from within Perl code.
13123 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13124 debugging is enabled. If you want a newline at the end, you must supply it.
13125 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13126 timestamp. In this case, you should not supply a terminating newline.
13127
13128
13129 .section "Use of standard output and error by Perl" "SECID88"
13130 .cindex "Perl" "standard output and error"
13131 You should not write to the standard error or output streams from within your
13132 Perl code, as it is not defined how these are set up. In versions of Exim
13133 before 4.50, it is possible for the standard output or error to refer to the
13134 SMTP connection during message reception via the daemon. Writing to this stream
13135 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13136 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13137 avoided, but the output is lost.
13138
13139 .cindex "Perl" "use of &%warn%&"
13140 The Perl &%warn%& statement writes to the standard error stream by default.
13141 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13142 you have no control. When Exim starts up the Perl interpreter, it arranges for
13143 output from the &%warn%& statement to be written to the Exim main log. You can
13144 change this by including appropriate Perl magic somewhere in your Perl code.
13145 For example, to discard &%warn%& output completely, you need this:
13146 .code
13147 $SIG{__WARN__} = sub { };
13148 .endd
13149 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13150 example, the code for the subroutine is empty, so it does nothing, but you can
13151 include any Perl code that you like. The text of the &%warn%& message is passed
13152 as the first subroutine argument.
13153 .ecindex IIDperl
13154
13155
13156 . ////////////////////////////////////////////////////////////////////////////
13157 . ////////////////////////////////////////////////////////////////////////////
13158
13159 .chapter "Starting the daemon and the use of network interfaces" &&&
13160          "CHAPinterfaces" &&&
13161          "Starting the daemon"
13162 .cindex "daemon" "starting"
13163 .cindex "interface" "listening"
13164 .cindex "network interface"
13165 .cindex "interface" "network"
13166 .cindex "IP address" "for listening"
13167 .cindex "daemon" "listening IP addresses"
13168 .cindex "TCP/IP" "setting listening interfaces"
13169 .cindex "TCP/IP" "setting listening ports"
13170 A host that is connected to a TCP/IP network may have one or more physical
13171 hardware network interfaces. Each of these interfaces may be configured as one
13172 or more &"logical"& interfaces, which are the entities that a program actually
13173 works with. Each of these logical interfaces is associated with an IP address.
13174 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13175 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13176 knowledge about the host's interfaces for use in three different circumstances:
13177
13178 .olist
13179 When a listening daemon is started, Exim needs to know which interfaces
13180 and ports to listen on.
13181 .next
13182 When Exim is routing an address, it needs to know which IP addresses
13183 are associated with local interfaces. This is required for the correct
13184 processing of MX lists by removing the local host and others with the
13185 same or higher priority values. Also, Exim needs to detect cases
13186 when an address is routed to an IP address that in fact belongs to the
13187 local host. Unless the &%self%& router option or the &%allow_localhost%&
13188 option of the smtp transport is set (as appropriate), this is treated
13189 as an error situation.
13190 .next
13191 When Exim connects to a remote host, it may need to know which interface to use
13192 for the outgoing connection.
13193 .endlist
13194
13195
13196 Exim's default behaviour is likely to be appropriate in the vast majority
13197 of cases. If your host has only one interface, and you want all its IP
13198 addresses to be treated in the same way, and you are using only the
13199 standard SMTP port, you should not need to take any special action. The
13200 rest of this chapter does not apply to you.
13201
13202 In a more complicated situation you may want to listen only on certain
13203 interfaces, or on different ports, and for this reason there are a number of
13204 options that can be used to influence Exim's behaviour. The rest of this
13205 chapter describes how they operate.
13206
13207 When a message is received over TCP/IP, the interface and port that were
13208 actually used are set in &$received_ip_address$& and &$received_port$&.
13209
13210
13211
13212 .section "Starting a listening daemon" "SECID89"
13213 When a listening daemon is started (by means of the &%-bd%& command line
13214 option), the interfaces and ports on which it listens are controlled by the
13215 following options:
13216
13217 .ilist
13218 &%daemon_smtp_ports%& contains a list of default ports
13219 or service names.
13220 (For backward compatibility, this option can also be specified in the singular.)
13221 .next
13222 &%local_interfaces%& contains list of interface IP addresses on which to
13223 listen. Each item may optionally also specify a port.
13224 .endlist
13225
13226 The default list separator in both cases is a colon, but this can be changed as
13227 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13228 it is usually best to change the separator to avoid having to double all the
13229 colons. For example:
13230 .code
13231 local_interfaces = <; 127.0.0.1 ; \
13232                       192.168.23.65 ; \
13233                       ::1 ; \
13234                       3ffe:ffff:836f::fe86:a061
13235 .endd
13236 There are two different formats for specifying a port along with an IP address
13237 in &%local_interfaces%&:
13238
13239 .olist
13240 The port is added onto the address with a dot separator. For example, to listen
13241 on port 1234 on two different IP addresses:
13242 .code
13243 local_interfaces = <; 192.168.23.65.1234 ; \
13244                       3ffe:ffff:836f::fe86:a061.1234
13245 .endd
13246 .next
13247 The IP address is enclosed in square brackets, and the port is added
13248 with a colon separator, for example:
13249 .code
13250 local_interfaces = <; [192.168.23.65]:1234 ; \
13251                       [3ffe:ffff:836f::fe86:a061]:1234
13252 .endd
13253 .endlist
13254
13255 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13256 default setting contains just one port:
13257 .code
13258 daemon_smtp_ports = smtp
13259 .endd
13260 If more than one port is listed, each interface that does not have its own port
13261 specified listens on all of them. Ports that are listed in
13262 &%daemon_smtp_ports%& can be identified either by name (defined in
13263 &_/etc/services_&) or by number. However, when ports are given with individual
13264 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13265
13266
13267
13268 .section "Special IP listening addresses" "SECID90"
13269 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13270 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13271 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13272 instead of setting up separate listening sockets for each interface. The
13273 default value of &%local_interfaces%& is
13274 .code
13275 local_interfaces = 0.0.0.0
13276 .endd
13277 when Exim is built without IPv6 support; otherwise it is:
13278 .code
13279 local_interfaces = <; ::0 ; 0.0.0.0
13280 .endd
13281 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13282
13283
13284
13285 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13286 The &%-oX%& command line option can be used to override the values of
13287 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13288 instance. Another way of doing this would be to use macros and the &%-D%&
13289 option. However, &%-oX%& can be used by any admin user, whereas modification of
13290 the runtime configuration by &%-D%& is allowed only when the caller is root or
13291 exim.
13292
13293 The value of &%-oX%& is a list of items. The default colon separator can be
13294 changed in the usual way if required. If there are any items that do not
13295 contain dots or colons (that is, are not IP addresses), the value of
13296 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13297 items that do contain dots or colons, the value of &%local_interfaces%& is
13298 replaced by those items. Thus, for example,
13299 .code
13300 -oX 1225
13301 .endd
13302 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13303 whereas
13304 .code
13305 -oX 192.168.34.5.1125
13306 .endd
13307 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13308 (However, since &%local_interfaces%& now contains no items without ports, the
13309 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13310
13311
13312
13313 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13314 .cindex "ssmtp protocol"
13315 .cindex "smtps protocol"
13316 .cindex "SMTP" "ssmtp protocol"
13317 .cindex "SMTP" "smtps protocol"
13318 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13319 before the STARTTLS command was standardized for SMTP. Some legacy clients
13320 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13321 list of port numbers or service names,
13322 connections to those ports must use SSMTP. The most
13323 common use of this option is expected to be
13324 .code
13325 tls_on_connect_ports = 465
13326 .endd
13327 because 465 is the usual port number used by the legacy clients. There is also
13328 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13329 this way when a daemon is started.
13330
13331 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13332 daemon to listen on those ports. You must still specify them in
13333 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13334 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13335 connections via the daemon.)
13336
13337
13338
13339
13340 .section "IPv6 address scopes" "SECID92"
13341 .cindex "IPv6" "address scopes"
13342 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13343 can, in principle, have the same link-local IPv6 address on different
13344 interfaces. Thus, additional information is needed, over and above the IP
13345 address, to distinguish individual interfaces. A convention of using a
13346 percent sign followed by something (often the interface name) has been
13347 adopted in some cases, leading to addresses like this:
13348 .code
13349 fe80::202:b3ff:fe03:45c1%eth0
13350 .endd
13351 To accommodate this usage, a percent sign followed by an arbitrary string is
13352 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13353 to convert a textual IPv6 address for actual use. This function recognizes the
13354 percent convention in operating systems that support it, and it processes the
13355 address appropriately. Unfortunately, some older libraries have problems with
13356 &[getaddrinfo()]&. If
13357 .code
13358 IPV6_USE_INET_PTON=yes
13359 .endd
13360 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13361 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13362 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13363 function.) Of course, this means that the additional functionality of
13364 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13365
13366 .section "Disabling IPv6" "SECID93"
13367 .cindex "IPv6" "disabling"
13368 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13369 run on a host whose kernel does not support IPv6. The binary will fall back to
13370 using IPv4, but it may waste resources looking up AAAA records, and trying to
13371 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13372 .oindex "&%disable_ipv6%&"
13373 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13374 activities take place. AAAA records are never looked up, and any IPv6 addresses
13375 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13376 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13377 to handle IPv6 literal addresses.
13378
13379 On the other hand, when IPv6 is in use, there may be times when you want to
13380 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13381 option to globally suppress the lookup of AAAA records for specified domains,
13382 and you can use the &%ignore_target_hosts%& generic router option to ignore
13383 IPv6 addresses in an individual router.
13384
13385
13386
13387 .section "Examples of starting a listening daemon" "SECID94"
13388 The default case in an IPv6 environment is
13389 .code
13390 daemon_smtp_ports = smtp
13391 local_interfaces = <; ::0 ; 0.0.0.0
13392 .endd
13393 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13394 Either one or two sockets may be used, depending on the characteristics of
13395 the TCP/IP stack. (This is complicated and messy; for more information,
13396 read the comments in the &_daemon.c_& source file.)
13397
13398 To specify listening on ports 25 and 26 on all interfaces:
13399 .code
13400 daemon_smtp_ports = 25 : 26
13401 .endd
13402 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13403 .code
13404 local_interfaces = <; ::0.25     ; ::0.26 \
13405                       0.0.0.0.25 ; 0.0.0.0.26
13406 .endd
13407 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13408 IPv4 loopback address only:
13409 .code
13410 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13411 .endd
13412 To specify listening on the default port on specific interfaces only:
13413 .code
13414 local_interfaces = 10.0.0.67 : 192.168.34.67
13415 .endd
13416 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13417
13418
13419
13420 .section "Recognizing the local host" "SECTreclocipadd"
13421 The &%local_interfaces%& option is also used when Exim needs to determine
13422 whether or not an IP address refers to the local host. That is, the IP
13423 addresses of all the interfaces on which a daemon is listening are always
13424 treated as local.
13425
13426 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13427 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13428 available interfaces from the operating system, and extracts the relevant
13429 (that is, IPv4 or IPv6) addresses to use for checking.
13430
13431 Some systems set up large numbers of virtual interfaces in order to provide
13432 many virtual web servers. In this situation, you may want to listen for
13433 email on only a few of the available interfaces, but nevertheless treat all
13434 interfaces as local when routing. You can do this by setting
13435 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13436 &"all"& wildcard values. These addresses are recognized as local, but are not
13437 used for listening. Consider this example:
13438 .code
13439 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13440                       192.168.53.235 ; \
13441                       3ffe:2101:12:1:a00:20ff:fe86:a061
13442
13443 extra_local_interfaces = <; ::0 ; 0.0.0.0
13444 .endd
13445 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13446 address, but all available interface addresses are treated as local when
13447 Exim is routing.
13448
13449 In some environments the local host name may be in an MX list, but with an IP
13450 address that is not assigned to any local interface. In other cases it may be
13451 desirable to treat other host names as if they referred to the local host. Both
13452 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13453 This contains host names rather than IP addresses. When a host is referenced
13454 during routing, either via an MX record or directly, it is treated as the local
13455 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13456 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13457
13458
13459
13460 .section "Delivering to a remote host" "SECID95"
13461 Delivery to a remote host is handled by the smtp transport. By default, it
13462 allows the system's TCP/IP functions to choose which interface to use (if
13463 there is more than one) when connecting to a remote host. However, the
13464 &%interface%& option can be set to specify which interface is used. See the
13465 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13466 details.
13467
13468
13469
13470
13471 . ////////////////////////////////////////////////////////////////////////////
13472 . ////////////////////////////////////////////////////////////////////////////
13473
13474 .chapter "Main configuration" "CHAPmainconfig"
13475 .scindex IIDconfima "configuration file" "main section"
13476 .scindex IIDmaiconf "main configuration"
13477 The first part of the run time configuration file contains three types of item:
13478
13479 .ilist
13480 Macro definitions: These lines start with an upper case letter. See section
13481 &<<SECTmacrodefs>>& for details of macro processing.
13482 .next
13483 Named list definitions: These lines start with one of the words &"domainlist"&,
13484 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13485 section &<<SECTnamedlists>>&.
13486 .next
13487 Main configuration settings: Each setting occupies one line of the file
13488 (with possible continuations). If any setting is preceded by the word
13489 &"hide"&, the &%-bP%& command line option displays its value to admin users
13490 only. See section &<<SECTcos>>& for a description of the syntax of these option
13491 settings.
13492 .endlist
13493
13494 This chapter specifies all the main configuration options, along with their
13495 types and default values. For ease of finding a particular option, they appear
13496 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13497 are now so many options, they are first listed briefly in functional groups, as
13498 an aid to finding the name of the option you are looking for. Some options are
13499 listed in more than one group.
13500
13501 .section "Miscellaneous" "SECID96"
13502 .table2
13503 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13504 .row &%disable_ipv6%&                "do no IPv6 processing"
13505 .row &%keep_malformed%&              "for broken files &-- should not happen"
13506 .row &%localhost_number%&            "for unique message ids in clusters"
13507 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13508 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13509 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13510 .row &%print_topbitchars%&           "top-bit characters are printing"
13511 .row &%timezone%&                    "force time zone"
13512 .endtable
13513
13514
13515 .section "Exim parameters" "SECID97"
13516 .table2
13517 .row &%exim_group%&                  "override compiled-in value"
13518 .row &%exim_path%&                   "override compiled-in value"
13519 .row &%exim_user%&                   "override compiled-in value"
13520 .row &%primary_hostname%&            "default from &[uname()]&"
13521 .row &%split_spool_directory%&       "use multiple directories"
13522 .row &%spool_directory%&             "override compiled-in value"
13523 .endtable
13524
13525
13526
13527 .section "Privilege controls" "SECID98"
13528 .table2
13529 .row &%admin_groups%&                "groups that are Exim admin users"
13530 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13531 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13532 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13533 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13534 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13535 .row &%never_users%&                 "do not run deliveries as these"
13536 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13537 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13538 .row &%trusted_groups%&              "groups that are trusted"
13539 .row &%trusted_users%&               "users that are trusted"
13540 .endtable
13541
13542
13543
13544 .section "Logging" "SECID99"
13545 .table2
13546 .row &%event_action%&                "custom logging"
13547 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13548 .row &%log_file_path%&               "override compiled-in value"
13549 .row &%log_selector%&                "set/unset optional logging"
13550 .row &%log_timezone%&                "add timezone to log lines"
13551 .row &%message_logs%&                "create per-message logs"
13552 .row &%preserve_message_logs%&       "after message completion"
13553 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13554 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13555 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13556 .row &%syslog_facility%&             "set syslog &""facility""& field"
13557 .row &%syslog_processname%&          "set syslog &""ident""& field"
13558 .row &%syslog_timestamp%&            "timestamp syslog lines"
13559 .row &%write_rejectlog%&             "control use of message log"
13560 .endtable
13561
13562
13563
13564 .section "Frozen messages" "SECID100"
13565 .table2
13566 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13567 .row &%freeze_tell%&                 "send message when freezing"
13568 .row &%move_frozen_messages%&        "to another directory"
13569 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13570 .endtable
13571
13572
13573
13574 .section "Data lookups" "SECID101"
13575 .table2
13576 .row &%ibase_servers%&               "InterBase servers"
13577 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13578 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13579 .row &%ldap_cert_file%&              "client cert file for LDAP"
13580 .row &%ldap_cert_key%&               "client key file for LDAP"
13581 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13582 .row &%ldap_default_servers%&        "used if no server in query"
13583 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13584 .row &%ldap_start_tls%&              "require TLS within LDAP"
13585 .row &%ldap_version%&                "set protocol version"
13586 .row &%lookup_open_max%&             "lookup files held open"
13587 .row &%mysql_servers%&               "default MySQL servers"
13588 .row &%oracle_servers%&              "Oracle servers"
13589 .row &%pgsql_servers%&               "default PostgreSQL servers"
13590 .row &%sqlite_lock_timeout%&         "as it says"
13591 .endtable
13592
13593
13594
13595 .section "Message ids" "SECID102"
13596 .table2
13597 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13598 .row &%message_id_header_text%&      "ditto"
13599 .endtable
13600
13601
13602
13603 .section "Embedded Perl Startup" "SECID103"
13604 .table2
13605 .row &%perl_at_start%&               "always start the interpreter"
13606 .row &%perl_startup%&                "code to obey when starting Perl"
13607 .row &%perl_taintmode%&              "enable taint mode in Perl"
13608 .endtable
13609
13610
13611
13612 .section "Daemon" "SECID104"
13613 .table2
13614 .row &%daemon_smtp_ports%&           "default ports"
13615 .row &%daemon_startup_retries%&      "number of times to retry"
13616 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13617 .row &%extra_local_interfaces%&      "not necessarily listened on"
13618 .row &%local_interfaces%&            "on which to listen, with optional ports"
13619 .row &%pid_file_path%&               "override compiled-in value"
13620 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13621 .endtable
13622
13623
13624
13625 .section "Resource control" "SECID105"
13626 .table2
13627 .row &%check_log_inodes%&            "before accepting a message"
13628 .row &%check_log_space%&             "before accepting a message"
13629 .row &%check_spool_inodes%&          "before accepting a message"
13630 .row &%check_spool_space%&           "before accepting a message"
13631 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13632 .row &%queue_only_load%&             "queue incoming if load high"
13633 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13634 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13635 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13636 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13637 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13638 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13639 .row &%smtp_accept_max_per_connection%& "messages per connection"
13640 .row &%smtp_accept_max_per_host%&    "connections from one host"
13641 .row &%smtp_accept_queue%&           "queue mail if more connections"
13642 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13643                                            connection"
13644 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13645 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13646 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13647 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13648 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13649 .endtable
13650
13651
13652
13653 .section "Policy controls" "SECID106"
13654 .table2
13655 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13656 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13657 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13658 .row &%acl_smtp_auth%&               "ACL for AUTH"
13659 .row &%acl_smtp_connect%&            "ACL for connection"
13660 .row &%acl_smtp_data%&               "ACL for DATA"
13661 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13662 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13663 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13664 .row &%acl_smtp_expn%&               "ACL for EXPN"
13665 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13666 .row &%acl_smtp_mail%&               "ACL for MAIL"
13667 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13668 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13669 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13670 .row &%acl_smtp_predata%&            "ACL for start of data"
13671 .row &%acl_smtp_quit%&               "ACL for QUIT"
13672 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13673 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13674 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13675 .row &%av_scanner%&                  "specify virus scanner"
13676 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13677                                       words""&"
13678 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13679 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13680 .row &%header_maxsize%&              "total size of message header"
13681 .row &%header_line_maxsize%&         "individual header line limit"
13682 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13683 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13684 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13685 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13686 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13687 .row &%host_lookup%&                 "host name looked up for these hosts"
13688 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13689 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13690 .row &%host_reject_connection%&      "reject connection from these hosts"
13691 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13692 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13693 .row &%message_size_limit%&          "for all messages"
13694 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13695 .row &%spamd_address%&               "set interface to SpamAssassin"
13696 .row &%strict_acl_vars%&             "object to unset ACL variables"
13697 .endtable
13698
13699
13700
13701 .section "Callout cache" "SECID107"
13702 .table2
13703 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13704                                          item"
13705 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13706                                          item"
13707 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13708 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13709 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13710 .endtable
13711
13712
13713
13714 .section "TLS" "SECID108"
13715 .table2
13716 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13717 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13718 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13719 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13720 .row &%tls_certificate%&             "location of server certificate"
13721 .row &%tls_crl%&                     "certificate revocation list"
13722 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13723 .row &%tls_dhparam%&                 "DH parameters for server"
13724 .row &%tls_eccurve%&                 "EC curve selection for server"
13725 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13726 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13727 .row &%tls_privatekey%&              "location of server private key"
13728 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13729 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13730 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13731 .row &%tls_verify_certificates%&     "expected client certificates"
13732 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13733 .endtable
13734
13735
13736
13737 .section "Local user handling" "SECID109"
13738 .table2
13739 .row &%finduser_retries%&            "useful in NIS environments"
13740 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13741 .row &%gecos_pattern%&               "ditto"
13742 .row &%max_username_length%&         "for systems that truncate"
13743 .row &%unknown_login%&               "used when no login name found"
13744 .row &%unknown_username%&            "ditto"
13745 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13746 .row &%uucp_from_sender%&            "ditto"
13747 .endtable
13748
13749
13750
13751 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13752 .table2
13753 .row &%header_maxsize%&              "total size of message header"
13754 .row &%header_line_maxsize%&         "individual header line limit"
13755 .row &%message_size_limit%&          "applies to all messages"
13756 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13757 .row &%received_header_text%&        "expanded to make &'Received:'&"
13758 .row &%received_headers_max%&        "for mail loop detection"
13759 .row &%recipients_max%&              "limit per message"
13760 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13761 .endtable
13762
13763
13764
13765
13766 .section "Non-SMTP incoming messages" "SECID111"
13767 .table2
13768 .row &%receive_timeout%&             "for non-SMTP messages"
13769 .endtable
13770
13771
13772
13773
13774
13775 .section "Incoming SMTP messages" "SECID112"
13776 See also the &'Policy controls'& section above.
13777
13778 .table2
13779 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13780 .row &%host_lookup%&                 "host name looked up for these hosts"
13781 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13782 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13783 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13784 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13785 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13786 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13787 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13788 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13789 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13790 .row &%smtp_accept_max_per_connection%& "messages per connection"
13791 .row &%smtp_accept_max_per_host%&    "connections from one host"
13792 .row &%smtp_accept_queue%&           "queue mail if more connections"
13793 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13794                                            connection"
13795 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13796 .row &%smtp_active_hostname%&        "host name to use in messages"
13797 .row &%smtp_banner%&                 "text for welcome banner"
13798 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13799 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13800 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13801 .row &%smtp_etrn_command%&           "what to run for ETRN"
13802 .row &%smtp_etrn_serialize%&         "only one at once"
13803 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13804 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13805 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13806 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13807 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13808 .row &%smtp_receive_timeout%&        "per command or data line"
13809 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13810 .row &%smtp_return_error_details%&   "give detail on rejections"
13811 .endtable
13812
13813
13814
13815 .section "SMTP extensions" "SECID113"
13816 .table2
13817 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13818 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13819 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13820 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13821 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13822 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13823 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13824 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13825 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13826 .endtable
13827
13828
13829
13830 .section "Processing messages" "SECID114"
13831 .table2
13832 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13833 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13834 .row &%allow_utf8_domains%&          "in addresses"
13835 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13836                                       words""&"
13837 .row &%delivery_date_remove%&        "from incoming messages"
13838 .row &%envelope_to_remove%&          "from incoming messages"
13839 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13840 .row &%headers_charset%&             "default for translations"
13841 .row &%qualify_domain%&              "default for senders"
13842 .row &%qualify_recipient%&           "default for recipients"
13843 .row &%return_path_remove%&          "from incoming messages"
13844 .row &%strip_excess_angle_brackets%& "in addresses"
13845 .row &%strip_trailing_dot%&          "at end of addresses"
13846 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13847 .endtable
13848
13849
13850
13851 .section "System filter" "SECID115"
13852 .table2
13853 .row &%system_filter%&               "locate system filter"
13854 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13855                                             directory"
13856 .row &%system_filter_file_transport%& "transport for delivery to a file"
13857 .row &%system_filter_group%&         "group for filter running"
13858 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13859 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13860 .row &%system_filter_user%&          "user for filter running"
13861 .endtable
13862
13863
13864
13865 .section "Routing and delivery" "SECID116"
13866 .table2
13867 .row &%disable_ipv6%&                "do no IPv6 processing"
13868 .row &%dns_again_means_nonexist%&    "for broken domains"
13869 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13870 .row &%dns_dnssec_ok%&               "parameter for resolver"
13871 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13872 .row &%dns_retrans%&                 "parameter for resolver"
13873 .row &%dns_retry%&                   "parameter for resolver"
13874 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13875 .row &%dns_use_edns0%&               "parameter for resolver"
13876 .row &%hold_domains%&                "hold delivery for these domains"
13877 .row &%local_interfaces%&            "for routing checks"
13878 .row &%queue_domains%&               "no immediate delivery for these"
13879 .row &%queue_only%&                  "no immediate delivery at all"
13880 .row &%queue_only_file%&             "no immediate delivery if file exists"
13881 .row &%queue_only_load%&             "no immediate delivery if load is high"
13882 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13883 .row &%queue_only_override%&         "allow command line to override"
13884 .row &%queue_run_in_order%&          "order of arrival"
13885 .row &%queue_run_max%&               "of simultaneous queue runners"
13886 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13887 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13888 .row &%remote_sort_domains%&         "order of remote deliveries"
13889 .row &%retry_data_expire%&           "timeout for retry data"
13890 .row &%retry_interval_max%&          "safety net for retry rules"
13891 .endtable
13892
13893
13894
13895 .section "Bounce and warning messages" "SECID117"
13896 .table2
13897 .row &%bounce_message_file%&         "content of bounce"
13898 .row &%bounce_message_text%&         "content of bounce"
13899 .row &%bounce_return_body%&          "include body if returning message"
13900 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13901 .row &%bounce_return_message%&       "include original message in bounce"
13902 .row &%bounce_return_size_limit%&    "limit on returned message"
13903 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13904 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13905 .row &%errors_copy%&                 "copy bounce messages"
13906 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13907 .row &%delay_warning%&               "time schedule"
13908 .row &%delay_warning_condition%&     "condition for warning messages"
13909 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13910 .row &%smtp_return_error_details%&   "give detail on rejections"
13911 .row &%warn_message_file%&           "content of warning message"
13912 .endtable
13913
13914
13915
13916 .section "Alphabetical list of main options" "SECTalomo"
13917 Those options that undergo string expansion before use are marked with
13918 &dagger;.
13919
13920 .option accept_8bitmime main boolean true
13921 .cindex "8BITMIME"
13922 .cindex "8-bit characters"
13923 .cindex "log" "selectors"
13924 .cindex "log" "8BITMIME"
13925 This option causes Exim to send 8BITMIME in its response to an SMTP
13926 EHLO command, and to accept the BODY= parameter on MAIL commands.
13927 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13928 takes no steps to do anything special with messages received by this route.
13929
13930 Historically Exim kept this option off by default, but the maintainers
13931 feel that in today's Internet, this causes more problems than it solves.
13932 It now defaults to true.
13933 A more detailed analysis of the issues is provided by Dan Bernstein:
13934 .display
13935 &url(http://cr.yp.to/smtp/8bitmime.html)
13936 .endd
13937
13938 To log received 8BITMIME status use
13939 .code
13940 log_selector = +8bitmime
13941 .endd
13942
13943 .option acl_not_smtp main string&!! unset
13944 .cindex "&ACL;" "for non-SMTP messages"
13945 .cindex "non-SMTP messages" "ACLs for"
13946 This option defines the ACL that is run when a non-SMTP message has been
13947 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13948 further details.
13949
13950 .option acl_not_smtp_mime main string&!! unset
13951 This option defines the ACL that is run for individual MIME parts of non-SMTP
13952 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13953 SMTP messages.
13954
13955 .option acl_not_smtp_start main string&!! unset
13956 .cindex "&ACL;" "at start of non-SMTP message"
13957 .cindex "non-SMTP messages" "ACLs for"
13958 This option defines the ACL that is run before Exim starts reading a
13959 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13960
13961 .option acl_smtp_auth main string&!! unset
13962 .cindex "&ACL;" "setting up for SMTP commands"
13963 .cindex "AUTH" "ACL for"
13964 This option defines the ACL that is run when an SMTP AUTH command is
13965 received. See chapter &<<CHAPACL>>& for further details.
13966
13967 .option acl_smtp_connect main string&!! unset
13968 .cindex "&ACL;" "on SMTP connection"
13969 This option defines the ACL that is run when an SMTP connection is received.
13970 See chapter &<<CHAPACL>>& for further details.
13971
13972 .option acl_smtp_data main string&!! unset
13973 .cindex "DATA" "ACL for"
13974 This option defines the ACL that is run after an SMTP DATA command has been
13975 processed and the message itself has been received, but before the final
13976 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13977
13978 .option acl_smtp_data_prdr main string&!! accept
13979 .cindex "PRDR" "ACL for"
13980 .cindex "DATA" "PRDR ACL for"
13981 .cindex "&ACL;" "PRDR-related"
13982 .cindex "&ACL;" "per-user data processing"
13983 This option defines the ACL that,
13984 if the PRDR feature has been negotiated,
13985 is run for each recipient after an SMTP DATA command has been
13986 processed and the message itself has been received, but before the
13987 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13988
13989 .option acl_smtp_dkim main string&!! unset
13990 .cindex DKIM "ACL for"
13991 This option defines the ACL that is run for each DKIM signature
13992 of a received message.
13993 See chapter &<<CHAPdkim>>& for further details.
13994
13995 .option acl_smtp_etrn main string&!! unset
13996 .cindex "ETRN" "ACL for"
13997 This option defines the ACL that is run when an SMTP ETRN command is
13998 received. See chapter &<<CHAPACL>>& for further details.
13999
14000 .option acl_smtp_expn main string&!! unset
14001 .cindex "EXPN" "ACL for"
14002 This option defines the ACL that is run when an SMTP EXPN command is
14003 received. See chapter &<<CHAPACL>>& for further details.
14004
14005 .option acl_smtp_helo main string&!! unset
14006 .cindex "EHLO" "ACL for"
14007 .cindex "HELO" "ACL for"
14008 This option defines the ACL that is run when an SMTP EHLO or HELO
14009 command is received. See chapter &<<CHAPACL>>& for further details.
14010
14011
14012 .option acl_smtp_mail main string&!! unset
14013 .cindex "MAIL" "ACL for"
14014 This option defines the ACL that is run when an SMTP MAIL command is
14015 received. See chapter &<<CHAPACL>>& for further details.
14016
14017 .option acl_smtp_mailauth main string&!! unset
14018 .cindex "AUTH" "on MAIL command"
14019 This option defines the ACL that is run when there is an AUTH parameter on
14020 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14021 &<<CHAPSMTPAUTH>>& for details of authentication.
14022
14023 .option acl_smtp_mime main string&!! unset
14024 .cindex "MIME content scanning" "ACL for"
14025 This option is available when Exim is built with the content-scanning
14026 extension. It defines the ACL that is run for each MIME part in a message. See
14027 section &<<SECTscanmimepart>>& for details.
14028
14029 .option acl_smtp_notquit main string&!! unset
14030 .cindex "not-QUIT, ACL for"
14031 This option defines the ACL that is run when an SMTP session
14032 ends without a QUIT command being received.
14033 See chapter &<<CHAPACL>>& for further details.
14034
14035 .option acl_smtp_predata main string&!! unset
14036 This option defines the ACL that is run when an SMTP DATA command is
14037 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14038 further details.
14039
14040 .option acl_smtp_quit main string&!! unset
14041 .cindex "QUIT, ACL for"
14042 This option defines the ACL that is run when an SMTP QUIT command is
14043 received. See chapter &<<CHAPACL>>& for further details.
14044
14045 .option acl_smtp_rcpt main string&!! unset
14046 .cindex "RCPT" "ACL for"
14047 This option defines the ACL that is run when an SMTP RCPT command is
14048 received. See chapter &<<CHAPACL>>& for further details.
14049
14050 .option acl_smtp_starttls main string&!! unset
14051 .cindex "STARTTLS, ACL for"
14052 This option defines the ACL that is run when an SMTP STARTTLS command is
14053 received. See chapter &<<CHAPACL>>& for further details.
14054
14055 .option acl_smtp_vrfy main string&!! unset
14056 .cindex "VRFY" "ACL for"
14057 This option defines the ACL that is run when an SMTP VRFY command is
14058 received. See chapter &<<CHAPACL>>& for further details.
14059
14060 .option add_environment main "string list" empty
14061 .cindex "environment" "set values"
14062 This option allows to set individual environment variables that the
14063 currently linked libraries and programs in child processes use.
14064 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14065
14066 .option admin_groups main "string list&!!" unset
14067 .cindex "admin user"
14068 This option is expanded just once, at the start of Exim's processing. If the
14069 current group or any of the supplementary groups of an Exim caller is in this
14070 colon-separated list, the caller has admin privileges. If all your system
14071 programmers are in a specific group, for example, you can give them all Exim
14072 admin privileges by putting that group in &%admin_groups%&. However, this does
14073 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14074 To permit this, you have to add individuals to the Exim group.
14075
14076 .option allow_domain_literals main boolean false
14077 .cindex "domain literal"
14078 If this option is set, the RFC 2822 domain literal format is permitted in
14079 email addresses. The option is not set by default, because the domain literal
14080 format is not normally required these days, and few people know about it. It
14081 has, however, been exploited by mail abusers.
14082
14083 Unfortunately, it seems that some DNS black list maintainers are using this
14084 format to report black listing to postmasters. If you want to accept messages
14085 addressed to your hosts by IP address, you need to set
14086 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14087 domains (defined in the named domain list &%local_domains%& in the default
14088 configuration). This &"magic string"& matches the domain literal form of all
14089 the local host's IP addresses.
14090
14091
14092 .option allow_mx_to_ip main boolean false
14093 .cindex "MX record" "pointing to IP address"
14094 It appears that more and more DNS zone administrators are breaking the rules
14095 and putting domain names that look like IP addresses on the right hand side of
14096 MX records. Exim follows the rules and rejects this, giving an error message
14097 that explains the misconfiguration. However, some other MTAs support this
14098 practice, so to avoid &"Why can't Exim do this?"& complaints,
14099 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14100 recommended, except when you have no other choice.
14101
14102 .option allow_utf8_domains main boolean false
14103 .cindex "domain" "UTF-8 characters in"
14104 .cindex "UTF-8" "in domain name"
14105 Lots of discussion is going on about internationalized domain names. One
14106 camp is strongly in favour of just using UTF-8 characters, and it seems
14107 that at least two other MTAs permit this. This option allows Exim users to
14108 experiment if they wish.
14109
14110 If it is set true, Exim's domain parsing function allows valid
14111 UTF-8 multicharacters to appear in domain name components, in addition to
14112 letters, digits, and hyphens. However, just setting this option is not
14113 enough; if you want to look up these domain names in the DNS, you must also
14114 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14115 suitable setting is:
14116 .code
14117 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14118   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14119 .endd
14120 Alternatively, you can just disable this feature by setting
14121 .code
14122 dns_check_names_pattern =
14123 .endd
14124 That is, set the option to an empty string so that no check is done.
14125
14126
14127 .option auth_advertise_hosts main "host list&!!" *
14128 .cindex "authentication" "advertising"
14129 .cindex "AUTH" "advertising"
14130 If any server authentication mechanisms are configured, Exim advertises them in
14131 response to an EHLO command only if the calling host matches this list.
14132 Otherwise, Exim does not advertise AUTH.
14133 Exim does not accept AUTH commands from clients to which it has not
14134 advertised the availability of AUTH. The advertising of individual
14135 authentication mechanisms can be controlled by the use of the
14136 &%server_advertise_condition%& generic authenticator option on the individual
14137 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14138
14139 Certain mail clients (for example, Netscape) require the user to provide a name
14140 and password for authentication if AUTH is advertised, even though it may
14141 not be needed (the host may accept messages from hosts on its local LAN without
14142 authentication, for example). The &%auth_advertise_hosts%& option can be used
14143 to make these clients more friendly by excluding them from the set of hosts to
14144 which Exim advertises AUTH.
14145
14146 .cindex "AUTH" "advertising when encrypted"
14147 If you want to advertise the availability of AUTH only when the connection
14148 is encrypted using TLS, you can make use of the fact that the value of this
14149 option is expanded, with a setting like this:
14150 .code
14151 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14152 .endd
14153 .vindex "&$tls_in_cipher$&"
14154 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14155 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14156 expansion is *, which matches all hosts.
14157
14158
14159 .option auto_thaw main time 0s
14160 .cindex "thawing messages"
14161 .cindex "unfreezing messages"
14162 If this option is set to a time greater than zero, a queue runner will try a
14163 new delivery attempt on any frozen message, other than a bounce message, if
14164 this much time has passed since it was frozen. This may result in the message
14165 being re-frozen if nothing has changed since the last attempt. It is a way of
14166 saying &"keep on trying, even though there are big problems"&.
14167
14168 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14169 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14170 thought to be very useful any more, and its use should probably be avoided.
14171
14172
14173 .option av_scanner main string "see below"
14174 This option is available if Exim is built with the content-scanning extension.
14175 It specifies which anti-virus scanner to use. The default value is:
14176 .code
14177 sophie:/var/run/sophie
14178 .endd
14179 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14180 before use. See section &<<SECTscanvirus>>& for further details.
14181
14182
14183 .option bi_command main string unset
14184 .oindex "&%-bi%&"
14185 This option supplies the name of a command that is run when Exim is called with
14186 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14187 just the command name, it is not a complete command line. If an argument is
14188 required, it must come from the &%-oA%& command line option.
14189
14190
14191 .option bounce_message_file main string unset
14192 .cindex "bounce message" "customizing"
14193 .cindex "customizing" "bounce message"
14194 This option defines a template file containing paragraphs of text to be used
14195 for constructing bounce messages.  Details of the file's contents are given in
14196 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14197
14198
14199 .option bounce_message_text main string unset
14200 When this option is set, its contents are included in the default bounce
14201 message immediately after &"This message was created automatically by mail
14202 delivery software."& It is not used if &%bounce_message_file%& is set.
14203
14204 .option bounce_return_body main boolean true
14205 .cindex "bounce message" "including body"
14206 This option controls whether the body of an incoming message is included in a
14207 bounce message when &%bounce_return_message%& is true. The default setting
14208 causes the entire message, both header and body, to be returned (subject to the
14209 value of &%bounce_return_size_limit%&). If this option is false, only the
14210 message header is included. In the case of a non-SMTP message containing an
14211 error that is detected during reception, only those header lines preceding the
14212 point at which the error was detected are returned.
14213 .cindex "bounce message" "including original"
14214
14215 .option bounce_return_linesize_limit main integer 998
14216 .cindex "size" "of bounce lines, limit"
14217 .cindex "bounce message" "line length limit"
14218 .cindex "limit" "bounce message line length"
14219 This option sets a limit in bytes on the line length of messages
14220 that are returned to senders due to delivery problems,
14221 when &%bounce_return_message%& is true.
14222 The default value corresponds to RFC limits.
14223 If the message being returned has lines longer than this value it is
14224 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14225
14226 The option also applies to bounces returned when an error is detected
14227 during reception of a message.
14228 In this case lines from the original are truncated.
14229
14230 The option does not apply to messages generated by an &(autoreply)& transport.
14231
14232
14233 .option bounce_return_message main boolean true
14234 If this option is set false, none of the original message is included in
14235 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14236 &%bounce_return_body%&.
14237
14238
14239 .option bounce_return_size_limit main integer 100K
14240 .cindex "size" "of bounce, limit"
14241 .cindex "bounce message" "size limit"
14242 .cindex "limit" "bounce message size"
14243 This option sets a limit in bytes on the size of messages that are returned to
14244 senders as part of bounce messages when &%bounce_return_message%& is true. The
14245 limit should be less than the value of the global &%message_size_limit%& and of
14246 any &%message_size_limit%& settings on transports, to allow for the bounce text
14247 that Exim generates. If this option is set to zero there is no limit.
14248
14249 When the body of any message that is to be included in a bounce message is
14250 greater than the limit, it is truncated, and a comment pointing this out is
14251 added at the top. The actual cutoff may be greater than the value given, owing
14252 to the use of buffering for transferring the message in chunks (typically 8K in
14253 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14254 messages.
14255
14256 .option bounce_sender_authentication main string unset
14257 .cindex "bounce message" "sender authentication"
14258 .cindex "authentication" "bounce message"
14259 .cindex "AUTH" "on bounce message"
14260 This option provides an authenticated sender address that is sent with any
14261 bounce messages generated by Exim that are sent over an authenticated SMTP
14262 connection. A typical setting might be:
14263 .code
14264 bounce_sender_authentication = mailer-daemon@my.domain.example
14265 .endd
14266 which would cause bounce messages to be sent using the SMTP command:
14267 .code
14268 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14269 .endd
14270 The value of &%bounce_sender_authentication%& must always be a complete email
14271 address.
14272
14273 .option callout_domain_negative_expire main time 3h
14274 .cindex "caching" "callout timeouts"
14275 .cindex "callout" "caching timeouts"
14276 This option specifies the expiry time for negative callout cache data for a
14277 domain. See section &<<SECTcallver>>& for details of callout verification, and
14278 section &<<SECTcallvercache>>& for details of the caching.
14279
14280
14281 .option callout_domain_positive_expire main time 7d
14282 This option specifies the expiry time for positive callout cache data for a
14283 domain. See section &<<SECTcallver>>& for details of callout verification, and
14284 section &<<SECTcallvercache>>& for details of the caching.
14285
14286
14287 .option callout_negative_expire main time 2h
14288 This option specifies the expiry time for negative callout cache data for an
14289 address. See section &<<SECTcallver>>& for details of callout verification, and
14290 section &<<SECTcallvercache>>& for details of the caching.
14291
14292
14293 .option callout_positive_expire main time 24h
14294 This option specifies the expiry time for positive callout cache data for an
14295 address. See section &<<SECTcallver>>& for details of callout verification, and
14296 section &<<SECTcallvercache>>& for details of the caching.
14297
14298
14299 .option callout_random_local_part main string&!! "see below"
14300 This option defines the &"random"& local part that can be used as part of
14301 callout verification. The default value is
14302 .code
14303 $primary_hostname-$tod_epoch-testing
14304 .endd
14305 See section &<<CALLaddparcall>>& for details of how this value is used.
14306
14307
14308 .option check_log_inodes main integer 0
14309 See &%check_spool_space%& below.
14310
14311
14312 .option check_log_space main integer 0
14313 See &%check_spool_space%& below.
14314
14315 .oindex "&%check_rfc2047_length%&"
14316 .cindex "RFC 2047" "disabling length check"
14317 .option check_rfc2047_length main boolean true
14318 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14319 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14320 word; strings to be encoded that exceed this length are supposed to use
14321 multiple encoded words. By default, Exim does not recognize encoded words that
14322 exceed the maximum length. However, it seems that some software, in violation
14323 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14324 set false, Exim recognizes encoded words of any length.
14325
14326
14327 .option check_spool_inodes main integer 0
14328 See &%check_spool_space%& below.
14329
14330
14331 .option check_spool_space main integer 0
14332 .cindex "checking disk space"
14333 .cindex "disk space, checking"
14334 .cindex "spool directory" "checking space"
14335 The four &%check_...%& options allow for checking of disk resources before a
14336 message is accepted.
14337
14338 .vindex "&$log_inodes$&"
14339 .vindex "&$log_space$&"
14340 .vindex "&$spool_inodes$&"
14341 .vindex "&$spool_space$&"
14342 When any of these options are set, they apply to all incoming messages. If you
14343 want to apply different checks to different kinds of message, you can do so by
14344 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14345 &$spool_space$& in an ACL with appropriate additional conditions.
14346
14347
14348 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14349 either value is greater than zero, for example:
14350 .code
14351 check_spool_space = 10M
14352 check_spool_inodes = 100
14353 .endd
14354 The spool partition is the one that contains the directory defined by
14355 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14356 transit.
14357
14358 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14359 files are written if either is greater than zero. These should be set only if
14360 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14361
14362 If there is less space or fewer inodes than requested, Exim refuses to accept
14363 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14364 error response to the MAIL command. If ESMTP is in use and there was a
14365 SIZE parameter on the MAIL command, its value is added to the
14366 &%check_spool_space%& value, and the check is performed even if
14367 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14368
14369 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14370 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14371
14372 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14373 failure a message is written to stderr and Exim exits with a non-zero code, as
14374 it obviously cannot send an error message of any kind.
14375
14376 .option daemon_smtp_ports main string &`smtp`&
14377 .cindex "port" "for daemon"
14378 .cindex "TCP/IP" "setting listening ports"
14379 This option specifies one or more default SMTP ports on which the Exim daemon
14380 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14381 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14382
14383 .option daemon_startup_retries main integer 9
14384 .cindex "daemon startup, retrying"
14385 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14386 the daemon at startup when it cannot immediately bind a listening socket
14387 (typically because the socket is already in use): &%daemon_startup_retries%&
14388 defines the number of retries after the first failure, and
14389 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14390
14391 .option daemon_startup_sleep main time 30s
14392 See &%daemon_startup_retries%&.
14393
14394 .option delay_warning main "time list" 24h
14395 .cindex "warning of delay"
14396 .cindex "delay warning, specifying"
14397 When a message is delayed, Exim sends a warning message to the sender at
14398 intervals specified by this option. The data is a colon-separated list of times
14399 after which to send warning messages. If the value of the option is an empty
14400 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14401 message has been on the queue for longer than the last time, the last interval
14402 between the times is used to compute subsequent warning times. For example,
14403 with
14404 .code
14405 delay_warning = 4h:8h:24h
14406 .endd
14407 the first message is sent after 4 hours, the second after 8 hours, and
14408 the third one after 24 hours. After that, messages are sent every 16 hours,
14409 because that is the interval between the last two times on the list. If you set
14410 just one time, it specifies the repeat interval. For example, with:
14411 .code
14412 delay_warning = 6h
14413 .endd
14414 messages are repeated every six hours. To stop warnings after a given time, set
14415 a very large time at the end of the list. For example:
14416 .code
14417 delay_warning = 2h:12h:99d
14418 .endd
14419 Note that the option is only evaluated at the time a delivery attempt fails,
14420 which depends on retry and queue-runner configuration.
14421 Typically retries will be configured more frequently than warning messages.
14422
14423 .option delay_warning_condition main string&!! "see below"
14424 .vindex "&$domain$&"
14425 The string is expanded at the time a warning message might be sent. If all the
14426 deferred addresses have the same domain, it is set in &$domain$& during the
14427 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14428 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14429 &"false"& (the comparison being done caselessly) then the warning message is
14430 not sent. The default is:
14431 .code
14432 delay_warning_condition = ${if or {\
14433   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14434   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14435   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14436   } {no}{yes}}
14437 .endd
14438 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14439 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14440 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14441 &"auto-replied"& in an &'Auto-Submitted:'& header.
14442
14443 .option deliver_drop_privilege main boolean false
14444 .cindex "unprivileged delivery"
14445 .cindex "delivery" "unprivileged"
14446 If this option is set true, Exim drops its root privilege at the start of a
14447 delivery process, and runs as the Exim user throughout. This severely restricts
14448 the kinds of local delivery that are possible, but is viable in certain types
14449 of configuration. There is a discussion about the use of root privilege in
14450 chapter &<<CHAPsecurity>>&.
14451
14452 .option deliver_queue_load_max main fixed-point unset
14453 .cindex "load average"
14454 .cindex "queue runner" "abandoning"
14455 When this option is set, a queue run is abandoned if the system load average
14456 becomes greater than the value of the option. The option has no effect on
14457 ancient operating systems on which Exim cannot determine the load average.
14458 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14459
14460
14461 .option delivery_date_remove main boolean true
14462 .cindex "&'Delivery-date:'& header line"
14463 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14464 message when it is delivered, in exactly the same way as &'Return-path:'& is
14465 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14466 should not be present in incoming messages, and this option causes them to be
14467 removed at the time the message is received, to avoid any problems that might
14468 occur when a delivered message is subsequently sent on to some other recipient.
14469
14470 .option disable_fsync main boolean false
14471 .cindex "&[fsync()]&, disabling"
14472 This option is available only if Exim was built with the compile-time option
14473 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14474 a runtime configuration generates an &"unknown option"& error. You should not
14475 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14476 really, really, really understand what you are doing. &'No pre-compiled
14477 distributions of Exim should ever make this option available.'&
14478
14479 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14480 updated files' data to be written to disc before continuing. Unexpected events
14481 such as crashes and power outages may cause data to be lost or scrambled.
14482 Here be Dragons. &*Beware.*&
14483
14484
14485 .option disable_ipv6 main boolean false
14486 .cindex "IPv6" "disabling"
14487 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14488 activities take place. AAAA records are never looked up, and any IPv6 addresses
14489 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14490 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14491 to handle IPv6 literal addresses.
14492
14493
14494 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14495 .cindex DKIM "controlling calls to the ACL"
14496 This option gives a list of DKIM domains for which the DKIM ACL is run.
14497 It is expanded after the message is received; by default it runs
14498 the ACL once for each signature in the message.
14499 See chapter &<<CHAPdkim>>&.
14500
14501
14502 .option dns_again_means_nonexist main "domain list&!!" unset
14503 .cindex "DNS" "&""try again""& response; overriding"
14504 DNS lookups give a &"try again"& response for the DNS errors
14505 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14506 keep trying to deliver a message, or to give repeated temporary errors to
14507 incoming mail. Sometimes the effect is caused by a badly set up name server and
14508 may persist for a long time. If a domain which exhibits this problem matches
14509 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14510 This option should be used with care. You can make it apply to reverse lookups
14511 by a setting such as this:
14512 .code
14513 dns_again_means_nonexist = *.in-addr.arpa
14514 .endd
14515 This option applies to all DNS lookups that Exim does. It also applies when the
14516 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14517 since these are most likely to be caused by DNS lookup problems. The
14518 &(dnslookup)& router has some options of its own for controlling what happens
14519 when lookups for MX or SRV records give temporary errors. These more specific
14520 options are applied after this global option.
14521
14522 .option dns_check_names_pattern main string "see below"
14523 .cindex "DNS" "pre-check of name syntax"
14524 When this option is set to a non-empty string, it causes Exim to check domain
14525 names for characters that are not allowed in host names before handing them to
14526 the DNS resolver, because some resolvers give temporary errors for names that
14527 contain unusual characters. If a domain name contains any unwanted characters,
14528 a &"not found"& result is forced, and the resolver is not called. The check is
14529 done by matching the domain name against a regular expression, which is the
14530 value of this option. The default pattern is
14531 .code
14532 dns_check_names_pattern = \
14533   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14534 .endd
14535 which permits only letters, digits, slashes, and hyphens in components, but
14536 they must start and end with a letter or digit. Slashes are not, in fact,
14537 permitted in host names, but they are found in certain NS records (which can be
14538 accessed in Exim by using a &%dnsdb%& lookup). If you set
14539 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14540 empty string.
14541
14542 .option dns_csa_search_limit main integer 5
14543 This option controls the depth of parental searching for CSA SRV records in the
14544 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14545
14546 .option dns_csa_use_reverse main boolean true
14547 This option controls whether or not an IP address, given as a CSA domain, is
14548 reversed and looked up in the reverse DNS, as described in more detail in
14549 section &<<SECTverifyCSA>>&.
14550
14551
14552 .option dns_dnssec_ok main integer -1
14553 .cindex "DNS" "resolver options"
14554 .cindex "DNS" "DNSSEC"
14555 If this option is set to a non-negative number then Exim will initialise the
14556 DNS resolver library to either use or not use DNSSEC, overriding the system
14557 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14558
14559 If the resolver library does not support DNSSEC then this option has no effect.
14560
14561
14562 .option dns_ipv4_lookup main "domain list&!!" unset
14563 .cindex "IPv6" "DNS lookup for AAAA records"
14564 .cindex "DNS" "IPv6 lookup for AAAA records"
14565 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14566 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14567 (A records) when trying to find IP addresses for hosts, unless the host's
14568 domain matches this list.
14569
14570 This is a fudge to help with name servers that give big delays or otherwise do
14571 not work for the AAAA record type. In due course, when the world's name
14572 servers have all been upgraded, there should be no need for this option.
14573
14574
14575 .option dns_retrans main time 0s
14576 .cindex "DNS" "resolver options"
14577 .cindex timeout "dns lookup"
14578 .cindex "DNS" timeout
14579 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14580 retransmission and retry parameters for DNS lookups. Values of zero (the
14581 defaults) leave the system default settings unchanged. The first value is the
14582 time between retries, and the second is the number of retries. It isn't
14583 totally clear exactly how these settings affect the total time a DNS lookup may
14584 take. I haven't found any documentation about timeouts on DNS lookups; these
14585 parameter values are available in the external resolver interface structure,
14586 but nowhere does it seem to describe how they are used or what you might want
14587 to set in them.
14588 See also the &%slow_lookup_log%& option.
14589
14590
14591 .option dns_retry main integer 0
14592 See &%dns_retrans%& above.
14593
14594
14595 .option dns_trust_aa main "domain list&!!" unset
14596 .cindex "DNS" "resolver options"
14597 .cindex "DNS" "DNSSEC"
14598 If this option is set then lookup results marked with the AA bit
14599 (Authoritative Answer) are trusted the same way as if they were
14600 DNSSEC-verified. The authority section's name of the answer must
14601 match with this expanded domain list.
14602
14603 Use this option only if you talk directly to a resolver that is
14604 authoritative for some zones and does not set the AD (Authentic Data)
14605 bit in the answer. Some DNS servers may have an configuration option to
14606 mark the answers from their own zones as verified (they set the AD bit).
14607 Others do not have this option. It is considered as poor practice using
14608 a resolver that is an authoritative server for some zones.
14609
14610 Use this option only if you really have to (e.g. if you want
14611 to use DANE for remote delivery to a server that is listed in the DNS
14612 zones that your resolver is authoritative for).
14613
14614 If the DNS answer packet has the AA bit set and contains resource record
14615 in the answer section, the name of the first NS record appearing in the
14616 authority section is compared against the list. If the answer packet is
14617 authoritative but the answer section is empty, the name of the first SOA
14618 record in the authoritative section is used instead.
14619
14620 .cindex "DNS" "resolver options"
14621 .option dns_use_edns0 main integer -1
14622 .cindex "DNS" "resolver options"
14623 .cindex "DNS" "EDNS0"
14624 If this option is set to a non-negative number then Exim will initialise the
14625 DNS resolver library to either use or not use EDNS0 extensions, overriding
14626 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14627 on.
14628
14629 If the resolver library does not support EDNS0 then this option has no effect.
14630
14631
14632 .option drop_cr main boolean false
14633 This is an obsolete option that is now a no-op. It used to affect the way Exim
14634 handled CR and LF characters in incoming messages. What happens now is
14635 described in section &<<SECTlineendings>>&.
14636
14637 .option dsn_advertise_hosts main "host list&!!" unset
14638 .cindex "bounce messages" "success"
14639 .cindex "DSN" "success"
14640 .cindex "Delivery Status Notification" "success"
14641 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14642 and accepted from, these hosts.
14643 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14644 and RET and ORCPT options on MAIL FROM commands.
14645 A NOTIFY=SUCCESS option requests success-DSN messages.
14646 A NOTIFY= option with no argument requests that no delay or failure DSNs
14647 are sent.
14648
14649 .option dsn_from main "string&!!" "see below"
14650 .cindex "&'From:'& header line" "in bounces"
14651 .cindex "bounce messages" "&'From:'& line, specifying"
14652 This option can be used to vary the contents of &'From:'& header lines in
14653 bounces and other automatically generated messages (&"Delivery Status
14654 Notifications"& &-- hence the name of the option). The default setting is:
14655 .code
14656 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14657 .endd
14658 The value is expanded every time it is needed. If the expansion fails, a
14659 panic is logged, and the default value is used.
14660
14661 .option envelope_to_remove main boolean true
14662 .cindex "&'Envelope-to:'& header line"
14663 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14664 message when it is delivered, in exactly the same way as &'Return-path:'& is
14665 handled. &'Envelope-to:'& records the original recipient address from the
14666 message's envelope that caused the delivery to happen. Such headers should not
14667 be present in incoming messages, and this option causes them to be removed at
14668 the time the message is received, to avoid any problems that might occur when a
14669 delivered message is subsequently sent on to some other recipient.
14670
14671
14672 .option errors_copy main "string list&!!" unset
14673 .cindex "bounce message" "copy to other address"
14674 .cindex "copy of bounce message"
14675 Setting this option causes Exim to send bcc copies of bounce messages that it
14676 generates to other addresses. &*Note*&: This does not apply to bounce messages
14677 coming from elsewhere. The value of the option is a colon-separated list of
14678 items. Each item consists of a pattern, terminated by white space, followed by
14679 a comma-separated list of email addresses. If a pattern contains spaces, it
14680 must be enclosed in double quotes.
14681
14682 Each pattern is processed in the same way as a single item in an address list
14683 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14684 the bounce message, the message is copied to the addresses on the list. The
14685 items are scanned in order, and once a matching one is found, no further items
14686 are examined. For example:
14687 .code
14688 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14689               rqps@mydomain   hostmaster@mydomain.example,\
14690                               postmaster@mydomain.example
14691 .endd
14692 .vindex "&$domain$&"
14693 .vindex "&$local_part$&"
14694 The address list is expanded before use. The expansion variables &$local_part$&
14695 and &$domain$& are set from the original recipient of the error message, and if
14696 there was any wildcard matching in the pattern, the expansion
14697 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14698 variables &$0$&, &$1$&, etc. are set in the normal way.
14699
14700
14701 .option errors_reply_to main string unset
14702 .cindex "bounce message" "&'Reply-to:'& in"
14703 By default, Exim's bounce and delivery warning messages contain the header line
14704 .display
14705 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14706 .endd
14707 .oindex &%quota_warn_message%&
14708 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14709 A warning message that is generated by the &%quota_warn_message%& option in an
14710 &(appendfile)& transport may contain its own &'From:'& header line that
14711 overrides the default.
14712
14713 Experience shows that people reply to bounce messages. If the
14714 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14715 and warning messages. For example:
14716 .code
14717 errors_reply_to = postmaster@my.domain.example
14718 .endd
14719 The value of the option is not expanded. It must specify a valid RFC 2822
14720 address. However, if a warning message that is generated by the
14721 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14722 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14723 not used.
14724
14725
14726 .option event_action main string&!! unset
14727 .cindex events
14728 This option declares a string to be expanded for Exim's events mechanism.
14729 For details see &<<CHAPevents>>&.
14730
14731
14732 .option exim_group main string "compile-time configured"
14733 .cindex "gid (group id)" "Exim's own"
14734 .cindex "Exim group"
14735 This option changes the gid under which Exim runs when it gives up root
14736 privilege. The default value is compiled into the binary. The value of this
14737 option is used only when &%exim_user%& is also set. Unless it consists entirely
14738 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14739 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14740 security issues.
14741
14742
14743 .option exim_path main string "see below"
14744 .cindex "Exim binary, path name"
14745 This option specifies the path name of the Exim binary, which is used when Exim
14746 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14747 the directory configured at compile time by the BIN_DIRECTORY setting. It
14748 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14749 other place.
14750 &*Warning*&: Do not use a macro to define the value of this option, because
14751 you will break those Exim utilities that scan the configuration file to find
14752 where the binary is. (They then use the &%-bP%& option to extract option
14753 settings such as the value of &%spool_directory%&.)
14754
14755
14756 .option exim_user main string "compile-time configured"
14757 .cindex "uid (user id)" "Exim's own"
14758 .cindex "Exim user"
14759 This option changes the uid under which Exim runs when it gives up root
14760 privilege. The default value is compiled into the binary. Ownership of the run
14761 time configuration file and the use of the &%-C%& and &%-D%& command line
14762 options is checked against the values in the binary, not what is set here.
14763
14764 Unless it consists entirely of digits, the string is looked up using
14765 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14766 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14767 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14768
14769
14770 .option extra_local_interfaces main "string list" unset
14771 This option defines network interfaces that are to be considered local when
14772 routing, but which are not used for listening by the daemon. See section
14773 &<<SECTreclocipadd>>& for details.
14774
14775
14776 . Allow this long option name to split; give it unsplit as a fifth argument
14777 . for the automatic .oindex that is generated by .option.
14778
14779 .option "extract_addresses_remove_arguments" main boolean true &&&
14780          extract_addresses_remove_arguments
14781 .oindex "&%-t%&"
14782 .cindex "command line" "addresses with &%-t%&"
14783 .cindex "Sendmail compatibility" "&%-t%& option"
14784 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14785 are present on the command line when the &%-t%& option is used to build an
14786 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14787 line addresses are removed from the recipients list. This is also how Smail
14788 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14789 command line addresses are added to those obtained from the header lines. When
14790 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14791 argument headers. If it is set false, Exim adds rather than removes argument
14792 addresses.
14793
14794
14795 .option finduser_retries main integer 0
14796 .cindex "NIS, retrying user lookups"
14797 On systems running NIS or other schemes in which user and group information is
14798 distributed from a remote system, there can be times when &[getpwnam()]& and
14799 related functions fail, even when given valid data, because things time out.
14800 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14801 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14802 many extra times to find a user or a group, waiting for one second between
14803 retries.
14804
14805 .cindex "&_/etc/passwd_&" "multiple reading of"
14806 You should not set this option greater than zero if your user information is in
14807 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14808 search the file multiple times for non-existent users, and also cause delay.
14809
14810
14811
14812 .option freeze_tell main "string list, comma separated" unset
14813 .cindex "freezing messages" "sending a message when freezing"
14814 On encountering certain errors, or when configured to do so in a system filter,
14815 ACL, or special router, Exim freezes a message. This means that no further
14816 delivery attempts take place until an administrator thaws the message, or the
14817 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14818 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14819 warning message whenever it freezes something, unless the message it is
14820 freezing is a locally-generated bounce message. (Without this exception there
14821 is the possibility of looping.) The warning message is sent to the addresses
14822 supplied as the comma-separated value of this option. If several of the
14823 message's addresses cause freezing, only a single message is sent. If the
14824 freezing was automatic, the reason(s) for freezing can be found in the message
14825 log. If you configure freezing in a filter or ACL, you must arrange for any
14826 logging that you require.
14827
14828
14829 .option gecos_name main string&!! unset
14830 .cindex "HP-UX"
14831 .cindex "&""gecos""& field, parsing"
14832 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14833 password file to hold other information in addition to users' real names. Exim
14834 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14835 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14836 of the field are used unchanged, except that, if an ampersand is encountered,
14837 it is replaced by the user's login name with the first character forced to
14838 upper case, since this is a convention that is observed on many systems.
14839
14840 When these options are set, &%gecos_pattern%& is treated as a regular
14841 expression that is to be applied to the field (again with && replaced by the
14842 login name), and if it matches, &%gecos_name%& is expanded and used as the
14843 user's name.
14844
14845 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14846 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14847 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14848 name terminates at the first comma, the following can be used:
14849 .code
14850 gecos_pattern = ([^,]*)
14851 gecos_name = $1
14852 .endd
14853
14854 .option gecos_pattern main string unset
14855 See &%gecos_name%& above.
14856
14857
14858 .option gnutls_compat_mode main boolean unset
14859 This option controls whether GnuTLS is used in compatibility mode in an Exim
14860 server. This reduces security slightly, but improves interworking with older
14861 implementations of TLS.
14862
14863
14864 option gnutls_allow_auto_pkcs11 main boolean unset
14865 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14866 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14867
14868 See
14869 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14870 for documentation.
14871
14872
14873
14874 .option headers_charset main string "see below"
14875 This option sets a default character set for translating from encoded MIME
14876 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14877 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14878 ultimate default is ISO-8859-1. For more details see the description of header
14879 insertions in section &<<SECTexpansionitems>>&.
14880
14881
14882
14883 .option header_maxsize main integer "see below"
14884 .cindex "header section" "maximum size of"
14885 .cindex "limit" "size of message header section"
14886 This option controls the overall maximum size of a message's header
14887 section. The default is the value of HEADER_MAXSIZE in
14888 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14889 sections are rejected.
14890
14891
14892 .option header_line_maxsize main integer 0
14893 .cindex "header lines" "maximum size of"
14894 .cindex "limit" "size of one header line"
14895 This option limits the length of any individual header line in a message, after
14896 all the continuations have been joined together. Messages with individual
14897 header lines that are longer than the limit are rejected. The default value of
14898 zero means &"no limit"&.
14899
14900
14901
14902
14903 .option helo_accept_junk_hosts main "host list&!!" unset
14904 .cindex "HELO" "accepting junk data"
14905 .cindex "EHLO" "accepting junk data"
14906 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14907 mail, and gives an error response for invalid data. Unfortunately, there are
14908 some SMTP clients that send syntactic junk. They can be accommodated by setting
14909 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14910 if you want to do semantic checking.
14911 See also &%helo_allow_chars%& for a way of extending the permitted character
14912 set.
14913
14914
14915 .option helo_allow_chars main string unset
14916 .cindex "HELO" "underscores in"
14917 .cindex "EHLO" "underscores in"
14918 .cindex "underscore in EHLO/HELO"
14919 This option can be set to a string of rogue characters that are permitted in
14920 all EHLO and HELO names in addition to the standard letters, digits,
14921 hyphens, and dots. If you really must allow underscores, you can set
14922 .code
14923 helo_allow_chars = _
14924 .endd
14925 Note that the value is one string, not a list.
14926
14927
14928 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14929 .cindex "HELO" "forcing reverse lookup"
14930 .cindex "EHLO" "forcing reverse lookup"
14931 If the domain given by a client in a HELO or EHLO command matches this
14932 list, a reverse lookup is done in order to establish the host's true name. The
14933 default forces a lookup if the client host gives the server's name or any of
14934 its IP addresses (in brackets), something that broken clients have been seen to
14935 do.
14936
14937
14938 .option helo_try_verify_hosts main "host list&!!" unset
14939 .cindex "HELO verifying" "optional"
14940 .cindex "EHLO" "verifying, optional"
14941 By default, Exim just checks the syntax of HELO and EHLO commands (see
14942 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14943 to do more extensive checking of the data supplied by these commands. The ACL
14944 condition &`verify = helo`& is provided to make this possible.
14945 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14946 to force the check to occur. From release 4.53 onwards, this is no longer
14947 necessary. If the check has not been done before &`verify = helo`& is
14948 encountered, it is done at that time. Consequently, this option is obsolete.
14949 Its specification is retained here for backwards compatibility.
14950
14951 When an EHLO or HELO command is received, if the calling host matches
14952 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14953 EHLO command either:
14954
14955 .ilist
14956 is an IP literal matching the calling address of the host, or
14957 .next
14958 .cindex "DNS" "reverse lookup"
14959 .cindex "reverse DNS lookup"
14960 matches the host name that Exim obtains by doing a reverse lookup of the
14961 calling host address, or
14962 .next
14963 when looked up in DNS yields the calling host address.
14964 .endlist
14965
14966 However, the EHLO or HELO command is not rejected if any of the checks
14967 fail. Processing continues, but the result of the check is remembered, and can
14968 be detected later in an ACL by the &`verify = helo`& condition.
14969
14970 If DNS was used for successful verification, the variable
14971 .cindex "DNS" "DNSSEC"
14972 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14973
14974 .option helo_verify_hosts main "host list&!!" unset
14975 .cindex "HELO verifying" "mandatory"
14976 .cindex "EHLO" "verifying, mandatory"
14977 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14978 backwards compatibility. For hosts that match this option, Exim checks the host
14979 name given in the HELO or EHLO in the same way as for
14980 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14981 rejected with a 550 error, and entries are written to the main and reject logs.
14982 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14983 error.
14984
14985 .option hold_domains main "domain list&!!" unset
14986 .cindex "domain" "delaying delivery"
14987 .cindex "delivery" "delaying certain domains"
14988 This option allows mail for particular domains to be held on the queue
14989 manually. The option is overridden if a message delivery is forced with the
14990 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14991 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14992 item in &%hold_domains%&, no routing or delivery for that address is done, and
14993 it is deferred every time the message is looked at.
14994
14995 This option is intended as a temporary operational measure for delaying the
14996 delivery of mail while some problem is being sorted out, or some new
14997 configuration tested. If you just want to delay the processing of some
14998 domains until a queue run occurs, you should use &%queue_domains%& or
14999 &%queue_smtp_domains%&, not &%hold_domains%&.
15000
15001 A setting of &%hold_domains%& does not override Exim's code for removing
15002 messages from the queue if they have been there longer than the longest retry
15003 time in any retry rule. If you want to hold messages for longer than the normal
15004 retry times, insert a dummy retry rule with a long retry time.
15005
15006
15007 .option host_lookup main "host list&!!" unset
15008 .cindex "host name" "lookup, forcing"
15009 Exim does not look up the name of a calling host from its IP address unless it
15010 is required to compare against some host list, or the host matches
15011 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15012 option (which normally contains IP addresses rather than host names). The
15013 default configuration file contains
15014 .code
15015 host_lookup = *
15016 .endd
15017 which causes a lookup to happen for all hosts. If the expense of these lookups
15018 is felt to be too great, the setting can be changed or removed.
15019
15020 After a successful reverse lookup, Exim does a forward lookup on the name it
15021 has obtained, to verify that it yields the IP address that it started with. If
15022 this check fails, Exim behaves as if the name lookup failed.
15023
15024 .vindex "&$host_lookup_failed$&"
15025 .vindex "&$sender_host_name$&"
15026 After any kind of failure, the host name (in &$sender_host_name$&) remains
15027 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15028 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15029 &`verify = reverse_host_lookup`& in ACLs.
15030
15031
15032 .option host_lookup_order main "string list" &`bydns:byaddr`&
15033 This option specifies the order of different lookup methods when Exim is trying
15034 to find a host name from an IP address. The default is to do a DNS lookup
15035 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15036 if that fails. You can change the order of these lookups, or omit one entirely,
15037 if you want.
15038
15039 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15040 multiple PTR records in the DNS and the IP address is not listed in
15041 &_/etc/hosts_&. Different operating systems give different results in this
15042 case. That is why the default tries a DNS lookup first.
15043
15044
15045
15046 .option host_reject_connection main "host list&!!" unset
15047 .cindex "host" "rejecting connections from"
15048 If this option is set, incoming SMTP calls from the hosts listed are rejected
15049 as soon as the connection is made.
15050 This option is obsolete, and retained only for backward compatibility, because
15051 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15052 connections immediately.
15053
15054 The ability to give an immediate rejection (either by this option or using an
15055 ACL) is provided for use in unusual cases. Many hosts will just try again,
15056 sometimes without much delay. Normally, it is better to use an ACL to reject
15057 incoming messages at a later stage, such as after RCPT commands. See
15058 chapter &<<CHAPACL>>&.
15059
15060
15061 .option hosts_connection_nolog main "host list&!!" unset
15062 .cindex "host" "not logging connections from"
15063 This option defines a list of hosts for which connection logging does not
15064 happen, even though the &%smtp_connection%& log selector is set. For example,
15065 you might want not to log SMTP connections from local processes, or from
15066 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15067 the daemon; you should therefore strive to restrict its value to a short inline
15068 list of IP addresses and networks. To disable logging SMTP connections from
15069 local processes, you must create a host list with an empty item. For example:
15070 .code
15071 hosts_connection_nolog = :
15072 .endd
15073 If the &%smtp_connection%& log selector is not set, this option has no effect.
15074
15075
15076
15077 .option hosts_proxy main "host list&!!" unset
15078 .cindex proxy "proxy protocol"
15079 This option enables use of Proxy Protocol proxies for incoming
15080 connections.  For details see &<<SECTproxyInbound>>&.
15081
15082
15083 .option hosts_treat_as_local main "domain list&!!" unset
15084 .cindex "local host" "domains treated as"
15085 .cindex "host" "treated as local"
15086 If this option is set, any host names that match the domain list are treated as
15087 if they were the local host when Exim is scanning host lists obtained from MX
15088 records
15089 or other sources. Note that the value of this option is a domain list, not a
15090 host list, because it is always used to check host names, not IP addresses.
15091
15092 This option also applies when Exim is matching the special items
15093 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15094 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15095 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15096 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15097 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15098 interfaces and recognizing the local host.
15099
15100
15101 .option ibase_servers main "string list" unset
15102 .cindex "InterBase" "server list"
15103 This option provides a list of InterBase servers and associated connection data,
15104 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15105 The option is available only if Exim has been built with InterBase support.
15106
15107
15108
15109 .option ignore_bounce_errors_after main time 10w
15110 .cindex "bounce message" "discarding"
15111 .cindex "discarding bounce message"
15112 This option affects the processing of bounce messages that cannot be delivered,
15113 that is, those that suffer a permanent delivery failure. (Bounce messages that
15114 suffer temporary delivery failures are of course retried in the usual way.)
15115
15116 After a permanent delivery failure, bounce messages are frozen,
15117 because there is no sender to whom they can be returned. When a frozen bounce
15118 message has been on the queue for more than the given time, it is unfrozen at
15119 the next queue run, and a further delivery is attempted. If delivery fails
15120 again, the bounce message is discarded. This makes it possible to keep failed
15121 bounce messages around for a shorter time than the normal maximum retry time
15122 for frozen messages. For example,
15123 .code
15124 ignore_bounce_errors_after = 12h
15125 .endd
15126 retries failed bounce message deliveries after 12 hours, discarding any further
15127 failures. If the value of this option is set to a zero time period, bounce
15128 failures are discarded immediately. Setting a very long time (as in the default
15129 value) has the effect of disabling this option. For ways of automatically
15130 dealing with other kinds of frozen message, see &%auto_thaw%& and
15131 &%timeout_frozen_after%&.
15132
15133
15134 .option ignore_fromline_hosts main "host list&!!" unset
15135 .cindex "&""From""& line"
15136 .cindex "UUCP" "&""From""& line"
15137 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15138 the headers of a message. By default this is treated as the start of the
15139 message's body, which means that any following headers are not recognized as
15140 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15141 match those hosts that insist on sending it. If the sender is actually a local
15142 process rather than a remote host, and is using &%-bs%& to inject the messages,
15143 &%ignore_fromline_local%& must be set to achieve this effect.
15144
15145
15146 .option ignore_fromline_local main boolean false
15147 See &%ignore_fromline_hosts%& above.
15148
15149 .option keep_environment main "string list" unset
15150 .cindex "environment" "values from"
15151 This option contains a string list of environment variables to keep.
15152 You have to trust these variables or you have to be sure that
15153 these variables do not impose any security risk. Keep in mind that
15154 during the startup phase Exim is running with an effective UID 0 in most
15155 installations. As the default value is an empty list, the default
15156 environment for using libraries, running embedded Perl code, or running
15157 external binaries is empty, and does not not even contain PATH or HOME.
15158
15159 Actually the list is interpreted as a list of patterns
15160 (&<<SECTlistexpand>>&), except that it is not expanded first.
15161
15162 WARNING: Macro substitution is still done first, so having a macro
15163 FOO and having FOO_HOME in your &%keep_environment%& option may have
15164 unexpected results. You may work around this using a regular expression
15165 that does not match the macro name: ^[F]OO_HOME$.
15166
15167 Current versions of Exim issue a warning during startup if you do not mention
15168 &%keep_environment%& in your runtime configuration file and if your
15169 current environment is not empty. Future versions may not issue that warning
15170 anymore.
15171
15172 See the &%add_environment%& main config option for a way to set
15173 environment variables to a fixed value.  The environment for &(pipe)&
15174 transports is handled separately, see section &<<SECTpipeenv>>& for
15175 details.
15176
15177
15178 .option keep_malformed main time 4d
15179 This option specifies the length of time to keep messages whose spool files
15180 have been corrupted in some way. This should, of course, never happen. At the
15181 next attempt to deliver such a message, it gets removed. The incident is
15182 logged.
15183
15184
15185 .option ldap_ca_cert_dir main string unset
15186 .cindex "LDAP", "TLS CA certificate directory"
15187 .cindex certificate "directory for LDAP"
15188 This option indicates which directory contains CA certificates for verifying
15189 a TLS certificate presented by an LDAP server.
15190 While Exim does not provide a default value, your SSL library may.
15191 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15192 and constrained to be a directory.
15193
15194
15195 .option ldap_ca_cert_file main string unset
15196 .cindex "LDAP", "TLS CA certificate file"
15197 .cindex certificate "file for LDAP"
15198 This option indicates which file contains CA certificates for verifying
15199 a TLS certificate presented by an LDAP server.
15200 While Exim does not provide a default value, your SSL library may.
15201 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15202 and constrained to be a file.
15203
15204
15205 .option ldap_cert_file main string unset
15206 .cindex "LDAP" "TLS client certificate file"
15207 .cindex certificate "file for LDAP"
15208 This option indicates which file contains an TLS client certificate which
15209 Exim should present to the LDAP server during TLS negotiation.
15210 Should be used together with &%ldap_cert_key%&.
15211
15212
15213 .option ldap_cert_key main string unset
15214 .cindex "LDAP" "TLS client key file"
15215 .cindex certificate "key for LDAP"
15216 This option indicates which file contains the secret/private key to use
15217 to prove identity to the LDAP server during TLS negotiation.
15218 Should be used together with &%ldap_cert_file%&, which contains the
15219 identity to be proven.
15220
15221
15222 .option ldap_cipher_suite main string unset
15223 .cindex "LDAP" "TLS cipher suite"
15224 This controls the TLS cipher-suite negotiation during TLS negotiation with
15225 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15226 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15227
15228
15229 .option ldap_default_servers main "string list" unset
15230 .cindex "LDAP" "default servers"
15231 This option provides a list of LDAP servers which are tried in turn when an
15232 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15233 details of LDAP queries. This option is available only when Exim has been built
15234 with LDAP support.
15235
15236
15237 .option ldap_require_cert main string unset.
15238 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15239 This should be one of the values "hard", "demand", "allow", "try" or "never".
15240 A value other than one of these is interpreted as "never".
15241 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15242 Although Exim does not set a default, the LDAP library probably defaults
15243 to hard/demand.
15244
15245
15246 .option ldap_start_tls main boolean false
15247 .cindex "LDAP" "whether or not to negotiate TLS"
15248 If set, Exim will attempt to negotiate TLS with the LDAP server when
15249 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15250 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15251 of SSL-on-connect.
15252 In the event of failure to negotiate TLS, the action taken is controlled
15253 by &%ldap_require_cert%&.
15254
15255
15256 .option ldap_version main integer unset
15257 .cindex "LDAP" "protocol version, forcing"
15258 This option can be used to force Exim to set a specific protocol version for
15259 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15260 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15261 the LDAP headers; otherwise it is 2. This option is available only when Exim
15262 has been built with LDAP support.
15263
15264
15265
15266 .option local_from_check main boolean true
15267 .cindex "&'Sender:'& header line" "disabling addition of"
15268 .cindex "&'From:'& header line" "disabling checking of"
15269 When a message is submitted locally (that is, not over a TCP/IP connection) by
15270 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15271 checks that the &'From:'& header line matches the login of the calling user and
15272 the domain specified by &%qualify_domain%&.
15273
15274 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15275 locally submitted message is automatically qualified by Exim, unless the
15276 &%-bnq%& command line option is used.
15277
15278 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15279 on the local part. If the &'From:'& header line does not match, Exim adds a
15280 &'Sender:'& header with an address constructed from the calling user's login
15281 and the default qualify domain.
15282
15283 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15284 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15285 &'Sender:'& header lines supplied by untrusted users, you must also set
15286 &%local_sender_retain%& to be true.
15287
15288 .cindex "envelope sender"
15289 These options affect only the header lines in the message. The envelope sender
15290 is still forced to be the login id at the qualify domain unless
15291 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15292
15293 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15294 request similar header line checking. See section &<<SECTthesenhea>>&, which
15295 has more details about &'Sender:'& processing.
15296
15297
15298
15299
15300 .option local_from_prefix main string unset
15301 When Exim checks the &'From:'& header line of locally submitted messages for
15302 matching the login id (see &%local_from_check%& above), it can be configured to
15303 ignore certain prefixes and suffixes in the local part of the address. This is
15304 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15305 appropriate lists, in the same form as the &%local_part_prefix%& and
15306 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15307 example, if
15308 .code
15309 local_from_prefix = *-
15310 .endd
15311 is set, a &'From:'& line containing
15312 .code
15313 From: anything-user@your.domain.example
15314 .endd
15315 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15316 matches the actual sender address that is constructed from the login name and
15317 qualify domain.
15318
15319
15320 .option local_from_suffix main string unset
15321 See &%local_from_prefix%& above.
15322
15323
15324 .option local_interfaces main "string list" "see below"
15325 This option controls which network interfaces are used by the daemon for
15326 listening; they are also used to identify the local host when routing. Chapter
15327 &<<CHAPinterfaces>>& contains a full description of this option and the related
15328 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15329 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15330 &%local_interfaces%& is
15331 .code
15332 local_interfaces = 0.0.0.0
15333 .endd
15334 when Exim is built without IPv6 support; otherwise it is
15335 .code
15336 local_interfaces = <; ::0 ; 0.0.0.0
15337 .endd
15338
15339 .option local_scan_timeout main time 5m
15340 .cindex "timeout" "for &[local_scan()]& function"
15341 .cindex "&[local_scan()]& function" "timeout"
15342 This timeout applies to the &[local_scan()]& function (see chapter
15343 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15344 the incoming message is rejected with a temporary error if it is an SMTP
15345 message. For a non-SMTP message, the message is dropped and Exim ends with a
15346 non-zero code. The incident is logged on the main and reject logs.
15347
15348
15349
15350 .option local_sender_retain main boolean false
15351 .cindex "&'Sender:'& header line" "retaining from local submission"
15352 When a message is submitted locally (that is, not over a TCP/IP connection) by
15353 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15354 do not want this to happen, you must set &%local_sender_retain%&, and you must
15355 also set &%local_from_check%& to be false (Exim will complain if you do not).
15356 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15357 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15358
15359
15360
15361
15362 .option localhost_number main string&!! unset
15363 .cindex "host" "locally unique number for"
15364 .cindex "message ids" "with multiple hosts"
15365 .vindex "&$localhost_number$&"
15366 Exim's message ids are normally unique only within the local host. If
15367 uniqueness among a set of hosts is required, each host must set a different
15368 value for the &%localhost_number%& option. The string is expanded immediately
15369 after reading the configuration file (so that a number can be computed from the
15370 host name, for example) and the result of the expansion must be a number in the
15371 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15372 systems). This is available in subsequent string expansions via the variable
15373 &$localhost_number$&. When &%localhost_number is set%&, the final two
15374 characters of the message id, instead of just being a fractional part of the
15375 time, are computed from the time and the local host number as described in
15376 section &<<SECTmessiden>>&.
15377
15378
15379
15380 .option log_file_path main "string list&!!" "set at compile time"
15381 .cindex "log" "file path for"
15382 This option sets the path which is used to determine the names of Exim's log
15383 files, or indicates that logging is to be to syslog, or both. It is expanded
15384 when Exim is entered, so it can, for example, contain a reference to the host
15385 name. If no specific path is set for the log files at compile or run time,
15386 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15387 they are written in a sub-directory called &_log_& in Exim's spool directory.
15388 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15389 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15390 used. If this string is fixed at your installation (contains no expansion
15391 variables) it is recommended that you do not set this option in the
15392 configuration file, but instead supply the path using LOG_FILE_PATH in
15393 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15394 early on &-- in particular, failure to read the configuration file.
15395
15396
15397 .option log_selector main string unset
15398 .cindex "log" "selectors"
15399 This option can be used to reduce or increase the number of things that Exim
15400 writes to its log files. Its argument is made up of names preceded by plus or
15401 minus characters. For example:
15402 .code
15403 log_selector = +arguments -retry_defer
15404 .endd
15405 A list of possible names and what they control is given in the chapter on
15406 logging, in section &<<SECTlogselector>>&.
15407
15408
15409 .option log_timezone main boolean false
15410 .cindex "log" "timezone for entries"
15411 .vindex "&$tod_log$&"
15412 .vindex "&$tod_zone$&"
15413 By default, the timestamps on log lines are in local time without the
15414 timezone. This means that if your timezone changes twice a year, the timestamps
15415 in log lines are ambiguous for an hour when the clocks go back. One way of
15416 avoiding this problem is to set the timezone to UTC. An alternative is to set
15417 &%log_timezone%& true. This turns on the addition of the timezone offset to
15418 timestamps in log lines. Turning on this option can add quite a lot to the size
15419 of log files because each line is extended by 6 characters. Note that the
15420 &$tod_log$& variable contains the log timestamp without the zone, but there is
15421 another variable called &$tod_zone$& that contains just the timezone offset.
15422
15423
15424 .option lookup_open_max main integer 25
15425 .cindex "too many open files"
15426 .cindex "open files, too many"
15427 .cindex "file" "too many open"
15428 .cindex "lookup" "maximum open files"
15429 .cindex "limit" "open files for lookups"
15430 This option limits the number of simultaneously open files for single-key
15431 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15432 Exim normally keeps these files open during routing, because often the same
15433 file is required several times. If the limit is reached, Exim closes the least
15434 recently used file. Note that if you are using the &'ndbm'& library, it
15435 actually opens two files for each logical DBM database, though it still counts
15436 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15437 open files"& errors with NDBM, you need to reduce the value of
15438 &%lookup_open_max%&.
15439
15440
15441 .option max_username_length main integer 0
15442 .cindex "length of login name"
15443 .cindex "user name" "maximum length"
15444 .cindex "limit" "user name length"
15445 Some operating systems are broken in that they truncate long arguments to
15446 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15447 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15448 an argument that is longer behaves as if &[getpwnam()]& failed.
15449
15450
15451 .option message_body_newlines main bool false
15452 .cindex "message body" "newlines in variables"
15453 .cindex "newline" "in message body variables"
15454 .vindex "&$message_body$&"
15455 .vindex "&$message_body_end$&"
15456 By default, newlines in the message body are replaced by spaces when setting
15457 the &$message_body$& and &$message_body_end$& expansion variables. If this
15458 option is set true, this no longer happens.
15459
15460
15461 .option message_body_visible main integer 500
15462 .cindex "body of message" "visible size"
15463 .cindex "message body" "visible size"
15464 .vindex "&$message_body$&"
15465 .vindex "&$message_body_end$&"
15466 This option specifies how much of a message's body is to be included in the
15467 &$message_body$& and &$message_body_end$& expansion variables.
15468
15469
15470 .option message_id_header_domain main string&!! unset
15471 .cindex "&'Message-ID:'& header line"
15472 If this option is set, the string is expanded and used as the right hand side
15473 (domain) of the &'Message-ID:'& header that Exim creates if a
15474 locally-originated incoming message does not have one. &"Locally-originated"&
15475 means &"not received over TCP/IP."&
15476 Otherwise, the primary host name is used.
15477 Only letters, digits, dot and hyphen are accepted; any other characters are
15478 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15479 empty string, the option is ignored.
15480
15481
15482 .option message_id_header_text main string&!! unset
15483 If this variable is set, the string is expanded and used to augment the text of
15484 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15485 message does not have one. The text of this header is required by RFC 2822 to
15486 take the form of an address. By default, Exim uses its internal message id as
15487 the local part, and the primary host name as the domain. If this option is set,
15488 it is expanded, and provided the expansion is not forced to fail, and does not
15489 yield an empty string, the result is inserted into the header immediately
15490 before the @, separated from the internal message id by a dot. Any characters
15491 that are illegal in an address are automatically converted into hyphens. This
15492 means that variables such as &$tod_log$& can be used, because the spaces and
15493 colons will become hyphens.
15494
15495
15496 .option message_logs main boolean true
15497 .cindex "message logs" "disabling"
15498 .cindex "log" "message log; disabling"
15499 If this option is turned off, per-message log files are not created in the
15500 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15501 Exim, by reducing the number of files involved in handling a message from a
15502 minimum of four (header spool file, body spool file, delivery journal, and
15503 per-message log) to three. The other major I/O activity is Exim's main log,
15504 which is not affected by this option.
15505
15506
15507 .option message_size_limit main string&!! 50M
15508 .cindex "message" "size limit"
15509 .cindex "limit" "message size"
15510 .cindex "size" "of message, limit"
15511 This option limits the maximum size of message that Exim will process. The
15512 value is expanded for each incoming connection so, for example, it can be made
15513 to depend on the IP address of the remote host for messages arriving via
15514 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15515 optionally followed by K or M.
15516
15517 &*Note*&: This limit cannot be made to depend on a message's sender or any
15518 other properties of an individual message, because it has to be advertised in
15519 the server's response to EHLO. String expansion failure causes a temporary
15520 error. A value of zero means no limit, but its use is not recommended. See also
15521 &%bounce_return_size_limit%&.
15522
15523 Incoming SMTP messages are failed with a 552 error if the limit is
15524 exceeded; locally-generated messages either get a stderr message or a delivery
15525 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15526 an oversized message is logged in both the main and the reject logs. See also
15527 the generic transport option &%message_size_limit%&, which limits the size of
15528 message that an individual transport can process.
15529
15530 If you use a virus-scanner and set this option to to a value larger than the
15531 maximum size that your virus-scanner is configured to support, you may get
15532 failures triggered by large mails.  The right size to configure for the
15533 virus-scanner depends upon what data is passed and the options in use but it's
15534 probably safest to just set it to a little larger than this value.  E.g., with a
15535 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15536 some problems may result.
15537
15538 A value of 0 will disable size limit checking; Exim will still advertise the
15539 SIZE extension in an EHLO response, but without a limit, so as to permit
15540 SMTP clients to still indicate the message size along with the MAIL verb.
15541
15542
15543 .option move_frozen_messages main boolean false
15544 .cindex "frozen messages" "moving"
15545 This option, which is available only if Exim has been built with the setting
15546 .code
15547 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15548 .endd
15549 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15550 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15551 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15552 standard utilities for handling such moved messages, and they do not show up in
15553 lists generated by &%-bp%& or by the Exim monitor.
15554
15555
15556 .option mua_wrapper main boolean false
15557 Setting this option true causes Exim to run in a very restrictive mode in which
15558 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15559 contains a full description of this facility.
15560
15561
15562
15563 .option mysql_servers main "string list" unset
15564 .cindex "MySQL" "server list"
15565 This option provides a list of MySQL servers and associated connection data, to
15566 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15567 option is available only if Exim has been built with MySQL support.
15568
15569
15570 .option never_users main "string list&!!" unset
15571 This option is expanded just once, at the start of Exim's processing. Local
15572 message deliveries are normally run in processes that are setuid to the
15573 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15574 It is usually desirable to prevent any deliveries from running as root, as a
15575 safety precaution.
15576
15577 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15578 list of users that must not be used for local deliveries. This list is fixed in
15579 the binary and cannot be overridden by the configuration file. By default, it
15580 contains just the single user name &"root"&. The &%never_users%& runtime option
15581 can be used to add more users to the fixed list.
15582
15583 If a message is to be delivered as one of the users on the fixed list or the
15584 &%never_users%& list, an error occurs, and delivery is deferred. A common
15585 example is
15586 .code
15587 never_users = root:daemon:bin
15588 .endd
15589 Including root is redundant if it is also on the fixed list, but it does no
15590 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15591 transport driver.
15592
15593
15594 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15595 .cindex "OpenSSL "compatibility options"
15596 This option allows an administrator to adjust the SSL options applied
15597 by OpenSSL to connections.  It is given as a space-separated list of items,
15598 each one to be +added or -subtracted from the current value.
15599
15600 This option is only available if Exim is built against OpenSSL.  The values
15601 available for this option vary according to the age of your OpenSSL install.
15602 The &"all"& value controls a subset of flags which are available, typically
15603 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15604 list the values known on your system and Exim should support all the
15605 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15606 names lose the leading &"SSL_OP_"& and are lower-cased.
15607
15608 Note that adjusting the options can have severe impact upon the security of
15609 SSL as used by Exim.  It is possible to disable safety checks and shoot
15610 yourself in the foot in various unpleasant ways.  This option should not be
15611 adjusted lightly.  An unrecognised item will be detected at startup, by
15612 invoking Exim with the &%-bV%& flag.
15613
15614 The option affects Exim operating both as a server and as a client.
15615
15616 Historical note: prior to release 4.80, Exim defaulted this value to
15617 "+dont_insert_empty_fragments", which may still be needed for compatibility
15618 with some clients, but which lowers security by increasing exposure to
15619 some now infamous attacks.
15620
15621 Examples:
15622 .code
15623 # Make both old MS and old Eudora happy:
15624 openssl_options = -all +microsoft_big_sslv3_buffer \
15625                        +dont_insert_empty_fragments
15626
15627 # Disable older protocol versions:
15628 openssl_options = +no_sslv2 +no_sslv3
15629 .endd
15630
15631 Possible options may include:
15632 .ilist
15633 &`all`&
15634 .next
15635 &`allow_unsafe_legacy_renegotiation`&
15636 .next
15637 &`cipher_server_preference`&
15638 .next
15639 &`dont_insert_empty_fragments`&
15640 .next
15641 &`ephemeral_rsa`&
15642 .next
15643 &`legacy_server_connect`&
15644 .next
15645 &`microsoft_big_sslv3_buffer`&
15646 .next
15647 &`microsoft_sess_id_bug`&
15648 .next
15649 &`msie_sslv2_rsa_padding`&
15650 .next
15651 &`netscape_challenge_bug`&
15652 .next
15653 &`netscape_reuse_cipher_change_bug`&
15654 .next
15655 &`no_compression`&
15656 .next
15657 &`no_session_resumption_on_renegotiation`&
15658 .next
15659 &`no_sslv2`&
15660 .next
15661 &`no_sslv3`&
15662 .next
15663 &`no_ticket`&
15664 .next
15665 &`no_tlsv1`&
15666 .next
15667 &`no_tlsv1_1`&
15668 .next
15669 &`no_tlsv1_2`&
15670 .next
15671 &`safari_ecdhe_ecdsa_bug`&
15672 .next
15673 &`single_dh_use`&
15674 .next
15675 &`single_ecdh_use`&
15676 .next
15677 &`ssleay_080_client_dh_bug`&
15678 .next
15679 &`sslref2_reuse_cert_type_bug`&
15680 .next
15681 &`tls_block_padding_bug`&
15682 .next
15683 &`tls_d5_bug`&
15684 .next
15685 &`tls_rollback_bug`&
15686 .endlist
15687
15688 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15689 all clients connecting using the MacOS SecureTransport TLS facility prior
15690 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15691 to negotiate TLS then this option value might help, provided that your OpenSSL
15692 release is new enough to contain this work-around.  This may be a situation
15693 where you have to upgrade OpenSSL to get buggy clients working.
15694
15695
15696 .option oracle_servers main "string list" unset
15697 .cindex "Oracle" "server list"
15698 This option provides a list of Oracle servers and associated connection data,
15699 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15700 The option is available only if Exim has been built with Oracle support.
15701
15702
15703 .option percent_hack_domains main "domain list&!!" unset
15704 .cindex "&""percent hack""&"
15705 .cindex "source routing" "in email address"
15706 .cindex "address" "source-routed"
15707 The &"percent hack"& is the convention whereby a local part containing a
15708 percent sign is re-interpreted as a new email address, with the percent
15709 replaced by @. This is sometimes called &"source routing"&, though that term is
15710 also applied to RFC 2822 addresses that begin with an @ character. If this
15711 option is set, Exim implements the percent facility for those domains listed,
15712 but no others. This happens before an incoming SMTP address is tested against
15713 an ACL.
15714
15715 &*Warning*&: The &"percent hack"& has often been abused by people who are
15716 trying to get round relaying restrictions. For this reason, it is best avoided
15717 if at all possible. Unfortunately, a number of less security-conscious MTAs
15718 implement it unconditionally. If you are running Exim on a gateway host, and
15719 routing mail through to internal MTAs without processing the local parts, it is
15720 a good idea to reject recipient addresses with percent characters in their
15721 local parts. Exim's default configuration does this.
15722
15723
15724 .option perl_at_start main boolean false
15725 .cindex "Perl"
15726 This option is available only when Exim is built with an embedded Perl
15727 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15728
15729
15730 .option perl_startup main string unset
15731 .cindex "Perl"
15732 This option is available only when Exim is built with an embedded Perl
15733 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15734
15735 .option perl_startup main boolean false
15736 .cindex "Perl"
15737 This Option enables the taint mode of the embedded Perl interpreter.
15738
15739
15740 .option pgsql_servers main "string list" unset
15741 .cindex "PostgreSQL lookup type" "server list"
15742 This option provides a list of PostgreSQL servers and associated connection
15743 data, to be used in conjunction with &(pgsql)& lookups (see section
15744 &<<SECID72>>&). The option is available only if Exim has been built with
15745 PostgreSQL support.
15746
15747
15748 .option pid_file_path main string&!! "set at compile time"
15749 .cindex "daemon" "pid file path"
15750 .cindex "pid file, path for"
15751 This option sets the name of the file to which the Exim daemon writes its
15752 process id. The string is expanded, so it can contain, for example, references
15753 to the host name:
15754 .code
15755 pid_file_path = /var/log/$primary_hostname/exim.pid
15756 .endd
15757 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15758 spool directory.
15759 The value set by the option can be overridden by the &%-oP%& command line
15760 option. A pid file is not written if a &"non-standard"& daemon is run by means
15761 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15762
15763
15764 .option pipelining_advertise_hosts main "host list&!!" *
15765 .cindex "PIPELINING" "suppressing advertising"
15766 This option can be used to suppress the advertisement of the SMTP
15767 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15768 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15769 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15770 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15771 that clients will use it; &"out of order"& commands that are &"expected"& do
15772 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15773
15774
15775 .option prdr_enable main boolean false
15776 .cindex "PRDR" "enabling on server"
15777 This option can be used to enable the Per-Recipient Data Response extension
15778 to SMTP, defined by Eric Hall.
15779 If the option is set, PRDR is advertised by Exim when operating as a server.
15780 If the client requests PRDR, and more than one recipient, for a message
15781 an additional ACL is called for each recipient after the message content
15782 is received.  See section &<<SECTPRDRACL>>&.
15783
15784 .option preserve_message_logs main boolean false
15785 .cindex "message logs" "preserving"
15786 If this option is set, message log files are not deleted when messages are
15787 completed. Instead, they are moved to a sub-directory of the spool directory
15788 called &_msglog.OLD_&, where they remain available for statistical or debugging
15789 purposes. This is a dangerous option to set on systems with any appreciable
15790 volume of mail. Use with care!
15791
15792
15793 .option primary_hostname main string "see below"
15794 .cindex "name" "of local host"
15795 .cindex "host" "name of local"
15796 .cindex "local host" "name of"
15797 .vindex "&$primary_hostname$&"
15798 This specifies the name of the current host. It is used in the default EHLO or
15799 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15800 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15801 The value is also used by default in some SMTP response messages from an Exim
15802 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15803
15804 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15805 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15806 contains only one component, Exim passes it to &[gethostbyname()]& (or
15807 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15808 version. The variable &$primary_hostname$& contains the host name, whether set
15809 explicitly by this option, or defaulted.
15810
15811
15812 .option print_topbitchars main boolean false
15813 .cindex "printing characters"
15814 .cindex "8-bit characters"
15815 By default, Exim considers only those characters whose codes lie in the range
15816 32&--126 to be printing characters. In a number of circumstances (for example,
15817 when writing log entries) non-printing characters are converted into escape
15818 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15819 is set, code values of 128 and above are also considered to be printing
15820 characters.
15821
15822 This option also affects the header syntax checks performed by the
15823 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15824 the user's full name when constructing From: and Sender: addresses (as
15825 described in section &<<SECTconstr>>&). Setting this option can cause
15826 Exim to generate eight bit message headers that do not conform to the
15827 standards.
15828
15829
15830 .option process_log_path main string unset
15831 .cindex "process log path"
15832 .cindex "log" "process log"
15833 .cindex "&'exiwhat'&"
15834 This option sets the name of the file to which an Exim process writes its
15835 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15836 utility script. If this option is unset, the file called &_exim-process.info_&
15837 in Exim's spool directory is used. The ability to specify the name explicitly
15838 can be useful in environments where two different Exims are running, using
15839 different spool directories.
15840
15841
15842 .option prod_requires_admin main boolean true
15843 .oindex "&%-M%&"
15844 .oindex "&%-R%&"
15845 .oindex "&%-q%&"
15846 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15847 admin user unless &%prod_requires_admin%& is set false. See also
15848 &%queue_list_requires_admin%&.
15849
15850
15851 .option qualify_domain main string "see below"
15852 .cindex "domain" "for qualifying addresses"
15853 .cindex "address" "qualification"
15854 This option specifies the domain name that is added to any envelope sender
15855 addresses that do not have a domain qualification. It also applies to
15856 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15857 are accepted by default only for locally-generated messages. Qualification is
15858 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15859 locally-generated messages, unless the &%-bnq%& command line option is used.
15860
15861 Messages from external sources must always contain fully qualified addresses,
15862 unless the sending host matches &%sender_unqualified_hosts%& or
15863 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15864 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15865 necessary. Internally, Exim always works with fully qualified envelope
15866 addresses. If &%qualify_domain%& is not set, it defaults to the
15867 &%primary_hostname%& value.
15868
15869
15870 .option qualify_recipient main string "see below"
15871 This option allows you to specify a different domain for qualifying recipient
15872 addresses to the one that is used for senders. See &%qualify_domain%& above.
15873
15874
15875
15876 .option queue_domains main "domain list&!!" unset
15877 .cindex "domain" "specifying non-immediate delivery"
15878 .cindex "queueing incoming messages"
15879 .cindex "message" "queueing certain domains"
15880 This option lists domains for which immediate delivery is not required.
15881 A delivery process is started whenever a message is received, but only those
15882 domains that do not match are processed. All other deliveries wait until the
15883 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15884
15885
15886 .option queue_list_requires_admin main boolean true
15887 .oindex "&%-bp%&"
15888 The &%-bp%& command-line option, which lists the messages that are on the
15889 queue, requires the caller to be an admin user unless
15890 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15891
15892
15893 .option queue_only main boolean false
15894 .cindex "queueing incoming messages"
15895 .cindex "message" "queueing unconditionally"
15896 If &%queue_only%& is set, a delivery process is not automatically started
15897 whenever a message is received. Instead, the message waits on the queue for the
15898 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15899 delivered immediately when certain conditions (such as heavy load) occur.
15900
15901 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15902 and &%-odi%& command line options override &%queue_only%& unless
15903 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15904 &%queue_only_load%&, and &%smtp_accept_queue%&.
15905
15906
15907 .option queue_only_file main string unset
15908 .cindex "queueing incoming messages"
15909 .cindex "message" "queueing by file existence"
15910 This option can be set to a colon-separated list of absolute path names, each
15911 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15912 it tests for the existence of each listed path using a call to &[stat()]&. For
15913 each path that exists, the corresponding queueing option is set.
15914 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15915 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15916 .code
15917 queue_only_file = smtp/some/file
15918 .endd
15919 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15920 &_/some/file_& exists.
15921
15922
15923 .option queue_only_load main fixed-point unset
15924 .cindex "load average"
15925 .cindex "queueing incoming messages"
15926 .cindex "message" "queueing by load"
15927 If the system load average is higher than this value, incoming messages from
15928 all sources are queued, and no automatic deliveries are started. If this
15929 happens during local or remote SMTP input, all subsequent messages received on
15930 the same SMTP connection are queued by default, whatever happens to the load in
15931 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15932 false.
15933
15934 Deliveries will subsequently be performed by queue runner processes. This
15935 option has no effect on ancient operating systems on which Exim cannot
15936 determine the load average. See also &%deliver_queue_load_max%& and
15937 &%smtp_load_reserve%&.
15938
15939
15940 .option queue_only_load_latch main boolean true
15941 .cindex "load average" "re-evaluating per message"
15942 When this option is true (the default), once one message has been queued
15943 because the load average is higher than the value set by &%queue_only_load%&,
15944 all subsequent messages received on the same SMTP connection are also queued.
15945 This is a deliberate choice; even though the load average may fall below the
15946 threshold, it doesn't seem right to deliver later messages on the same
15947 connection when not delivering earlier ones. However, there are special
15948 circumstances such as very long-lived connections from scanning appliances
15949 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15950 should be set false. This causes the value of the load average to be
15951 re-evaluated for each message.
15952
15953
15954 .option queue_only_override main boolean true
15955 .cindex "queueing incoming messages"
15956 When this option is true, the &%-od%&&'x'& command line options override the
15957 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15958 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15959 to override; they are accepted, but ignored.
15960
15961
15962 .option queue_run_in_order main boolean false
15963 .cindex "queue runner" "processing messages in order"
15964 If this option is set, queue runs happen in order of message arrival instead of
15965 in an arbitrary order. For this to happen, a complete list of the entire queue
15966 must be set up before the deliveries start. When the queue is all held in a
15967 single directory (the default), a single list is created for both the ordered
15968 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15969 single list is not created when &%queue_run_in_order%& is false. In this case,
15970 the sub-directories are processed one at a time (in a random order), and this
15971 avoids setting up one huge list for the whole queue. Thus, setting
15972 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15973 when the queue is large, because of the extra work in setting up the single,
15974 large list. In most situations, &%queue_run_in_order%& should not be set.
15975
15976
15977
15978 .option queue_run_max main integer&!! 5
15979 .cindex "queue runner" "maximum number of"
15980 This controls the maximum number of queue runner processes that an Exim daemon
15981 can run simultaneously. This does not mean that it starts them all at once,
15982 but rather that if the maximum number are still running when the time comes to
15983 start another one, it refrains from starting another one. This can happen with
15984 very large queues and/or very sluggish deliveries. This option does not,
15985 however, interlock with other processes, so additional queue runners can be
15986 started by other means, or by killing and restarting the daemon.
15987
15988 Setting this option to zero does not suppress queue runs; rather, it disables
15989 the limit, allowing any number of simultaneous queue runner processes to be
15990 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15991 the daemon's command line.
15992
15993 .new
15994 .cindex queues named
15995 .cindex "named queues"
15996 To set limits for different named queues use
15997 an expansion depending on the &$queue_name$& variable.
15998 .wen
15999
16000 .option queue_smtp_domains main "domain list&!!" unset
16001 .cindex "queueing incoming messages"
16002 .cindex "message" "queueing remote deliveries"
16003 When this option is set, a delivery process is started whenever a message is
16004 received, routing is performed, and local deliveries take place.
16005 However, if any SMTP deliveries are required for domains that match
16006 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16007 message waits on the queue for the next queue run. Since routing of the message
16008 has taken place, Exim knows to which remote hosts it must be delivered, and so
16009 when the queue run happens, multiple messages for the same host are delivered
16010 over a single SMTP connection. The &%-odqs%& command line option causes all
16011 SMTP deliveries to be queued in this way, and is equivalent to setting
16012 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16013 &%queue_domains%&.
16014
16015
16016 .option receive_timeout main time 0s
16017 .cindex "timeout" "for non-SMTP input"
16018 This option sets the timeout for accepting a non-SMTP message, that is, the
16019 maximum time that Exim waits when reading a message on the standard input. If
16020 the value is zero, it will wait for ever. This setting is overridden by the
16021 &%-or%& command line option. The timeout for incoming SMTP messages is
16022 controlled by &%smtp_receive_timeout%&.
16023
16024 .option received_header_text main string&!! "see below"
16025 .cindex "customizing" "&'Received:'& header"
16026 .cindex "&'Received:'& header line" "customizing"
16027 This string defines the contents of the &'Received:'& message header that is
16028 added to each message, except for the timestamp, which is automatically added
16029 on at the end (preceded by a semicolon). The string is expanded each time it is
16030 used. If the expansion yields an empty string, no &'Received:'& header line is
16031 added to the message. Otherwise, the string should start with the text
16032 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16033 header lines. The default setting is:
16034
16035 .code
16036 received_header_text = Received: \
16037   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16038   {${if def:sender_ident \
16039   {from ${quote_local_part:$sender_ident} }}\
16040   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16041   by $primary_hostname \
16042   ${if def:received_protocol {with $received_protocol}} \
16043   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16044   (Exim $version_number)\n\t\
16045   ${if def:sender_address \
16046   {(envelope-from <$sender_address>)\n\t}}\
16047   id $message_exim_id\
16048   ${if def:received_for {\n\tfor $received_for}}
16049 .endd
16050
16051 The reference to the TLS cipher is omitted when Exim is built without TLS
16052 support. The use of conditional expansions ensures that this works for both
16053 locally generated messages and messages received from remote hosts, giving
16054 header lines such as the following:
16055 .code
16056 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16057 by marley.carol.example with esmtp (Exim 4.00)
16058 (envelope-from <bob@carol.example>)
16059 id 16IOWa-00019l-00
16060 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16061 Received: by scrooge.carol.example with local (Exim 4.00)
16062 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16063 .endd
16064 Until the body of the message has been received, the timestamp is the time when
16065 the message started to be received. Once the body has arrived, and all policy
16066 checks have taken place, the timestamp is updated to the time at which the
16067 message was accepted.
16068
16069
16070 .option received_headers_max main integer 30
16071 .cindex "loop" "prevention"
16072 .cindex "mail loop prevention"
16073 .cindex "&'Received:'& header line" "counting"
16074 When a message is to be delivered, the number of &'Received:'& headers is
16075 counted, and if it is greater than this parameter, a mail loop is assumed to
16076 have occurred, the delivery is abandoned, and an error message is generated.
16077 This applies to both local and remote deliveries.
16078
16079
16080 .option recipient_unqualified_hosts main "host list&!!" unset
16081 .cindex "unqualified addresses"
16082 .cindex "host" "unqualified addresses from"
16083 This option lists those hosts from which Exim is prepared to accept unqualified
16084 recipient addresses in message envelopes. The addresses are made fully
16085 qualified by the addition of the &%qualify_recipient%& value. This option also
16086 affects message header lines. Exim does not reject unqualified recipient
16087 addresses in headers, but it qualifies them only if the message came from a
16088 host that matches &%recipient_unqualified_hosts%&,
16089 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16090 option was not set.
16091
16092
16093 .option recipients_max main integer 0
16094 .cindex "limit" "number of recipients"
16095 .cindex "recipient" "maximum number"
16096 If this option is set greater than zero, it specifies the maximum number of
16097 original recipients for any message. Additional recipients that are generated
16098 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16099 all recipients over the limit; earlier recipients are delivered as normal.
16100 Non-SMTP messages with too many recipients are failed, and no deliveries are
16101 done.
16102
16103 .cindex "RCPT" "maximum number of incoming"
16104 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16105 RCPT commands in a single message.
16106
16107
16108 .option recipients_max_reject main boolean false
16109 If this option is set true, Exim rejects SMTP messages containing too many
16110 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16111 error to the eventual DATA command. Otherwise (the default) it gives a 452
16112 error to the surplus RCPT commands and accepts the message on behalf of the
16113 initial set of recipients. The remote server should then re-send the message
16114 for the remaining recipients at a later time.
16115
16116
16117 .option remote_max_parallel main integer 2
16118 .cindex "delivery" "parallelism for remote"
16119 This option controls parallel delivery of one message to a number of remote
16120 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16121 does all the remote deliveries for a message one by one. Otherwise, if a single
16122 message has to be delivered to more than one remote host, or if several copies
16123 have to be sent to the same remote host, up to &%remote_max_parallel%&
16124 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16125 deliveries are required, the maximum number of processes are started, and as
16126 each one finishes, another is begun. The order of starting processes is the
16127 same as if sequential delivery were being done, and can be controlled by the
16128 &%remote_sort_domains%& option. If parallel delivery takes place while running
16129 with debugging turned on, the debugging output from each delivery process is
16130 tagged with its process id.
16131
16132 This option controls only the maximum number of parallel deliveries for one
16133 message in one Exim delivery process. Because Exim has no central queue
16134 manager, there is no way of controlling the total number of simultaneous
16135 deliveries if the configuration allows a delivery attempt as soon as a message
16136 is received.
16137
16138 .cindex "number of deliveries"
16139 .cindex "delivery" "maximum number of"
16140 If you want to control the total number of deliveries on the system, you
16141 need to set the &%queue_only%& option. This ensures that all incoming messages
16142 are added to the queue without starting a delivery process. Then set up an Exim
16143 daemon to start queue runner processes at appropriate intervals (probably
16144 fairly often, for example, every minute), and limit the total number of queue
16145 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16146 delivers only one message at a time, the maximum number of deliveries that can
16147 then take place at once is &%queue_run_max%& multiplied by
16148 &%remote_max_parallel%&.
16149
16150 If it is purely remote deliveries you want to control, use
16151 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16152 doing the SMTP routing before queueing, so that several messages for the same
16153 host will eventually get delivered down the same connection.
16154
16155
16156 .option remote_sort_domains main "domain list&!!" unset
16157 .cindex "sorting remote deliveries"
16158 .cindex "delivery" "sorting remote"
16159 When there are a number of remote deliveries for a message, they are sorted by
16160 domain into the order given by this list. For example,
16161 .code
16162 remote_sort_domains = *.cam.ac.uk:*.uk
16163 .endd
16164 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16165 then to those in the &%uk%& domain, then to any others.
16166
16167
16168 .option retry_data_expire main time 7d
16169 .cindex "hints database" "data expiry"
16170 This option sets a &"use before"& time on retry information in Exim's hints
16171 database. Any older retry data is ignored. This means that, for example, once a
16172 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16173 past failures.
16174
16175
16176 .option retry_interval_max main time 24h
16177 .cindex "retry" "limit on interval"
16178 .cindex "limit" "on retry interval"
16179 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16180 intervals between delivery attempts for messages that cannot be delivered
16181 straight away. This option sets an overall limit to the length of time between
16182 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16183 the default value.
16184
16185
16186 .option return_path_remove main boolean true
16187 .cindex "&'Return-path:'& header line" "removing"
16188 RFC 2821, section 4.4, states that an SMTP server must insert a
16189 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16190 The &'Return-path:'& header preserves the sender address as received in the
16191 MAIL command. This description implies that this header should not be present
16192 in an incoming message. If &%return_path_remove%& is true, any existing
16193 &'Return-path:'& headers are removed from messages at the time they are
16194 received. Exim's transports have options for adding &'Return-path:'& headers at
16195 the time of delivery. They are normally used only for final local deliveries.
16196
16197
16198 .option return_size_limit main integer 100K
16199 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16200
16201
16202 .option rfc1413_hosts main "host list&!!" @[]
16203 .cindex "RFC 1413"
16204 .cindex "host" "for RFC 1413 calls"
16205 RFC 1413 identification calls are made to any client host which matches
16206 an item in the list.
16207 The default value specifies just this host, being any local interface
16208 for the system.
16209
16210 .option rfc1413_query_timeout main time 0s
16211 .cindex "RFC 1413" "query timeout"
16212 .cindex "timeout" "for RFC 1413 call"
16213 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16214 no RFC 1413 calls are ever made.
16215
16216
16217 .option sender_unqualified_hosts main "host list&!!" unset
16218 .cindex "unqualified addresses"
16219 .cindex "host" "unqualified addresses from"
16220 This option lists those hosts from which Exim is prepared to accept unqualified
16221 sender addresses. The addresses are made fully qualified by the addition of
16222 &%qualify_domain%&. This option also affects message header lines. Exim does
16223 not reject unqualified addresses in headers that contain sender addresses, but
16224 it qualifies them only if the message came from a host that matches
16225 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16226 using TCP/IP), and the &%-bnq%& option was not set.
16227
16228 .option set_environment main "string list" empty
16229 .cindex "environment"
16230 This option allows to set individual environment variables that the
16231 currently linked libraries and programs in child processes use. The
16232 default list is empty,
16233
16234
16235 .option slow_lookup_log main integer 0
16236 .cindex "logging" "slow lookups"
16237 .cindex "dns" "logging slow lookups"
16238 This option controls logging of slow lookups.
16239 If the value is nonzero it is taken as a number of milliseconds
16240 and lookups taking longer than this are logged.
16241 Currently this applies only to DNS lookups.
16242
16243
16244
16245 .option smtp_accept_keepalive main boolean true
16246 .cindex "keepalive" "on incoming connection"
16247 This option controls the setting of the SO_KEEPALIVE option on incoming
16248 TCP/IP socket connections. When set, it causes the kernel to probe idle
16249 connections periodically, by sending packets with &"old"& sequence numbers. The
16250 other end of the connection should send an acknowledgment if the connection is
16251 still okay or a reset if the connection has been aborted. The reason for doing
16252 this is that it has the beneficial effect of freeing up certain types of
16253 connection that can get stuck when the remote host is disconnected without
16254 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16255 hours to detect unreachable hosts.
16256
16257
16258
16259 .option smtp_accept_max main integer 20
16260 .cindex "limit" "incoming SMTP connections"
16261 .cindex "SMTP" "incoming connection count"
16262 .cindex "inetd"
16263 This option specifies the maximum number of simultaneous incoming SMTP calls
16264 that Exim will accept. It applies only to the listening daemon; there is no
16265 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16266 value is set to zero, no limit is applied. However, it is required to be
16267 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16268 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16269
16270 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16271 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16272 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16273 and &%smtp_load_reserve%& are then checked before accepting the connection.
16274
16275
16276 .option smtp_accept_max_nonmail main integer 10
16277 .cindex "limit" "non-mail SMTP commands"
16278 .cindex "SMTP" "limiting non-mail commands"
16279 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16280 the connection if there are too many. This option defines &"too many"&. The
16281 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16282 client looping sending EHLO, for example. The check is applied only if the
16283 client host matches &%smtp_accept_max_nonmail_hosts%&.
16284
16285 When a new message is expected, one occurrence of RSET is not counted. This
16286 allows a client to send one RSET between messages (this is not necessary,
16287 but some clients do it). Exim also allows one uncounted occurrence of HELO
16288 or EHLO, and one occurrence of STARTTLS between messages. After
16289 starting up a TLS session, another EHLO is expected, and so it too is not
16290 counted. The first occurrence of AUTH in a connection, or immediately
16291 following STARTTLS is not counted. Otherwise, all commands other than
16292 MAIL, RCPT, DATA, and QUIT are counted.
16293
16294
16295 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16296 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16297 check by setting this option. The default value makes it apply to all hosts. By
16298 changing the value, you can exclude any badly-behaved hosts that you have to
16299 live with.
16300
16301
16302 . Allow this long option name to split; give it unsplit as a fifth argument
16303 . for the automatic .oindex that is generated by .option.
16304 . We insert " &~&~" which is both pretty nasty visually and results in
16305 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16306 . zero-width-space, which would be nicer visually and results in (at least)
16307 . html that Firefox will split on when it's forced to reflow (rather than
16308 . inserting a horizontal scrollbar).  However, the text is still not
16309 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16310 . the option name to split.
16311
16312 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16313          smtp_accept_max_per_connection
16314 .cindex "SMTP" "limiting incoming message count"
16315 .cindex "limit" "messages per SMTP connection"
16316 The value of this option limits the number of MAIL commands that Exim is
16317 prepared to accept over a single SMTP connection, whether or not each command
16318 results in the transfer of a message. After the limit is reached, a 421
16319 response is given to subsequent MAIL commands. This limit is a safety
16320 precaution against a client that goes mad (incidents of this type have been
16321 seen).
16322
16323
16324 .option smtp_accept_max_per_host main string&!! unset
16325 .cindex "limit" "SMTP connections from one host"
16326 .cindex "host" "limiting SMTP connections from"
16327 This option restricts the number of simultaneous IP connections from a single
16328 host (strictly, from a single IP address) to the Exim daemon. The option is
16329 expanded, to enable different limits to be applied to different hosts by
16330 reference to &$sender_host_address$&. Once the limit is reached, additional
16331 connection attempts from the same host are rejected with error code 421. This
16332 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16333 of zero imposes no limit. If this option is set greater than zero, it is
16334 required that &%smtp_accept_max%& be non-zero.
16335
16336 &*Warning*&: When setting this option you should not use any expansion
16337 constructions that take an appreciable amount of time. The expansion and test
16338 happen in the main daemon loop, in order to reject additional connections
16339 without forking additional processes (otherwise a denial-of-service attack
16340 could cause a vast number or processes to be created). While the daemon is
16341 doing this processing, it cannot accept any other incoming connections.
16342
16343
16344
16345 .option smtp_accept_queue main integer 0
16346 .cindex "SMTP" "incoming connection count"
16347 .cindex "queueing incoming messages"
16348 .cindex "message" "queueing by SMTP connection count"
16349 If the number of simultaneous incoming SMTP connections being handled via the
16350 listening daemon exceeds this value, messages received by SMTP are just placed
16351 on the queue; no delivery processes are started automatically. The count is
16352 fixed at the start of an SMTP connection. It cannot be updated in the
16353 subprocess that receives messages, and so the queueing or not queueing applies
16354 to all messages received in the same connection.
16355
16356 A value of zero implies no limit, and clearly any non-zero value is useful only
16357 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16358 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16359 various &%-od%&&'x'& command line options.
16360
16361
16362 . See the comment on smtp_accept_max_per_connection
16363
16364 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16365          smtp_accept_queue_per_connection
16366 .cindex "queueing incoming messages"
16367 .cindex "message" "queueing by message count"
16368 This option limits the number of delivery processes that Exim starts
16369 automatically when receiving messages via SMTP, whether via the daemon or by
16370 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16371 and the number of messages received in a single SMTP session exceeds this
16372 number, subsequent messages are placed on the queue, but no delivery processes
16373 are started. This helps to limit the number of Exim processes when a server
16374 restarts after downtime and there is a lot of mail waiting for it on other
16375 systems. On large systems, the default should probably be increased, and on
16376 dial-in client systems it should probably be set to zero (that is, disabled).
16377
16378
16379 .option smtp_accept_reserve main integer 0
16380 .cindex "SMTP" "incoming call count"
16381 .cindex "host" "reserved"
16382 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16383 number of SMTP connections that are reserved for connections from the hosts
16384 that are specified in &%smtp_reserve_hosts%&. The value set in
16385 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16386 restricted to this number of connections; the option specifies a minimum number
16387 of connection slots for them, not a maximum. It is a guarantee that this group
16388 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16389 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16390 individual host.
16391
16392 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16393 set to 5, once there are 45 active connections (from any hosts), new
16394 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16395 provided the other criteria for acceptance are met.
16396
16397
16398 .option smtp_active_hostname main string&!! unset
16399 .cindex "host" "name in SMTP responses"
16400 .cindex "SMTP" "host name in responses"
16401 .vindex "&$primary_hostname$&"
16402 This option is provided for multi-homed servers that want to masquerade as
16403 several different hosts. At the start of an incoming SMTP connection, its value
16404 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16405 responses. For example, it is used as domain name in the response to an
16406 incoming HELO or EHLO command.
16407
16408 .vindex "&$smtp_active_hostname$&"
16409 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16410 is saved with any messages that are received. It is therefore available for use
16411 in routers and transports when the message is later delivered.
16412
16413 If this option is unset, or if its expansion is forced to fail, or if the
16414 expansion results in an empty string, the value of &$primary_hostname$& is
16415 used. Other expansion failures cause a message to be written to the main and
16416 panic logs, and the SMTP command receives a temporary error. Typically, the
16417 value of &%smtp_active_hostname%& depends on the incoming interface address.
16418 For example:
16419 .code
16420 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16421   {cox.mydomain}{box.mydomain}}
16422 .endd
16423
16424 Although &$smtp_active_hostname$& is primarily concerned with incoming
16425 messages, it is also used as the default for HELO commands in callout
16426 verification if there is no remote transport from which to obtain a
16427 &%helo_data%& value.
16428
16429 .option smtp_banner main string&!! "see below"
16430 .cindex "SMTP" "welcome banner"
16431 .cindex "banner for SMTP"
16432 .cindex "welcome banner for SMTP"
16433 .cindex "customizing" "SMTP banner"
16434 This string, which is expanded every time it is used, is output as the initial
16435 positive response to an SMTP connection. The default setting is:
16436 .code
16437 smtp_banner = $smtp_active_hostname ESMTP Exim \
16438   $version_number $tod_full
16439 .endd
16440 Failure to expand the string causes a panic error. If you want to create a
16441 multiline response to the initial SMTP connection, use &"\n"& in the string at
16442 appropriate points, but not at the end. Note that the 220 code is not included
16443 in this string. Exim adds it automatically (several times in the case of a
16444 multiline response).
16445
16446
16447 .option smtp_check_spool_space main boolean true
16448 .cindex "checking disk space"
16449 .cindex "disk space, checking"
16450 .cindex "spool directory" "checking space"
16451 When this option is set, if an incoming SMTP session encounters the SIZE
16452 option on a MAIL command, it checks that there is enough space in the
16453 spool directory's partition to accept a message of that size, while still
16454 leaving free the amount specified by &%check_spool_space%& (even if that value
16455 is zero). If there isn't enough space, a temporary error code is returned.
16456
16457
16458 .option smtp_connect_backlog main integer 20
16459 .cindex "connection backlog"
16460 .cindex "SMTP" "connection backlog"
16461 .cindex "backlog of connections"
16462 This option specifies a maximum number of waiting SMTP connections. Exim passes
16463 this value to the TCP/IP system when it sets up its listener. Once this number
16464 of connections are waiting for the daemon's attention, subsequent connection
16465 attempts are refused at the TCP/IP level. At least, that is what the manuals
16466 say; in some circumstances such connection attempts have been observed to time
16467 out instead. For large systems it is probably a good idea to increase the
16468 value (to 50, say). It also gives some protection against denial-of-service
16469 attacks by SYN flooding.
16470
16471
16472 .option smtp_enforce_sync main boolean true
16473 .cindex "SMTP" "synchronization checking"
16474 .cindex "synchronization checking in SMTP"
16475 The SMTP protocol specification requires the client to wait for a response from
16476 the server at certain points in the dialogue. Without PIPELINING these
16477 synchronization points are after every command; with PIPELINING they are
16478 fewer, but they still exist.
16479
16480 Some spamming sites send out a complete set of SMTP commands without waiting
16481 for any response. Exim protects against this by rejecting a message if the
16482 client has sent further input when it should not have. The error response &"554
16483 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16484 for this error cannot be perfect because of transmission delays (unexpected
16485 input may be on its way but not yet received when Exim checks). However, it
16486 does detect many instances.
16487
16488 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16489 If you want to disable the check selectively (for example, only for certain
16490 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16491 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16492
16493
16494
16495 .option smtp_etrn_command main string&!! unset
16496 .cindex "ETRN" "command to be run"
16497 .vindex "&$domain$&"
16498 If this option is set, the given command is run whenever an SMTP ETRN
16499 command is received from a host that is permitted to issue such commands (see
16500 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16501 are independently expanded. The expansion variable &$domain$& is set to the
16502 argument of the ETRN command, and no syntax checking is done on it. For
16503 example:
16504 .code
16505 smtp_etrn_command = /etc/etrn_command $domain \
16506                     $sender_host_address
16507 .endd
16508 A new process is created to run the command, but Exim does not wait for it to
16509 complete. Consequently, its status cannot be checked. If the command cannot be
16510 run, a line is written to the panic log, but the ETRN caller still receives
16511 a 250 success response. Exim is normally running under its own uid when
16512 receiving SMTP, so it is not possible for it to change the uid before running
16513 the command.
16514
16515
16516 .option smtp_etrn_serialize main boolean true
16517 .cindex "ETRN" "serializing"
16518 When this option is set, it prevents the simultaneous execution of more than
16519 one identical command as a result of ETRN in an SMTP connection. See
16520 section &<<SECTETRN>>& for details.
16521
16522
16523 .option smtp_load_reserve main fixed-point unset
16524 .cindex "load average"
16525 If the system load average ever gets higher than this, incoming SMTP calls are
16526 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16527 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16528 the load is over the limit. The option has no effect on ancient operating
16529 systems on which Exim cannot determine the load average. See also
16530 &%deliver_queue_load_max%& and &%queue_only_load%&.
16531
16532
16533
16534 .option smtp_max_synprot_errors main integer 3
16535 .cindex "SMTP" "limiting syntax and protocol errors"
16536 .cindex "limit" "SMTP syntax and protocol errors"
16537 Exim rejects SMTP commands that contain syntax or protocol errors. In
16538 particular, a syntactically invalid email address, as in this command:
16539 .code
16540 RCPT TO:<abc xyz@a.b.c>
16541 .endd
16542 causes immediate rejection of the command, before any other tests are done.
16543 (The ACL cannot be run if there is no valid address to set up for it.) An
16544 example of a protocol error is receiving RCPT before MAIL. If there are
16545 too many syntax or protocol errors in one SMTP session, the connection is
16546 dropped. The limit is set by this option.
16547
16548 .cindex "PIPELINING" "expected errors"
16549 When the PIPELINING extension to SMTP is in use, some protocol errors are
16550 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16551 Exim assumes that PIPELINING will be used if it advertises it (see
16552 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16553 not count towards the limit.
16554
16555
16556
16557 .option smtp_max_unknown_commands main integer 3
16558 .cindex "SMTP" "limiting unknown commands"
16559 .cindex "limit" "unknown SMTP commands"
16560 If there are too many unrecognized commands in an incoming SMTP session, an
16561 Exim server drops the connection. This is a defence against some kinds of abuse
16562 that subvert web
16563 clients
16564 into making connections to SMTP ports; in these circumstances, a number of
16565 non-SMTP command lines are sent first.
16566
16567
16568
16569 .option smtp_ratelimit_hosts main "host list&!!" unset
16570 .cindex "SMTP" "rate limiting"
16571 .cindex "limit" "rate of message arrival"
16572 .cindex "RCPT" "rate limiting"
16573 Some sites find it helpful to be able to limit the rate at which certain hosts
16574 can send them messages, and the rate at which an individual message can specify
16575 recipients.
16576
16577 Exim has two rate-limiting facilities. This section describes the older
16578 facility, which can limit rates within a single connection. The newer
16579 &%ratelimit%& ACL condition can limit rates across all connections. See section
16580 &<<SECTratelimiting>>& for details of the newer facility.
16581
16582 When a host matches &%smtp_ratelimit_hosts%&, the values of
16583 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16584 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16585 respectively. Each option, if set, must contain a set of four comma-separated
16586 values:
16587
16588 .ilist
16589 A threshold, before which there is no rate limiting.
16590 .next
16591 An initial time delay. Unlike other times in Exim, numbers with decimal
16592 fractional parts are allowed here.
16593 .next
16594 A factor by which to increase the delay each time.
16595 .next
16596 A maximum value for the delay. This should normally be less than 5 minutes,
16597 because after that time, the client is liable to timeout the SMTP command.
16598 .endlist
16599
16600 For example, these settings have been used successfully at the site which
16601 first suggested this feature, for controlling mail from their customers:
16602 .code
16603 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16604 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16605 .endd
16606 The first setting specifies delays that are applied to MAIL commands after
16607 two have been received over a single connection. The initial delay is 0.5
16608 seconds, increasing by a factor of 1.05 each time. The second setting applies
16609 delays to RCPT commands when more than four occur in a single message.
16610
16611
16612 .option smtp_ratelimit_mail main string unset
16613 See &%smtp_ratelimit_hosts%& above.
16614
16615
16616 .option smtp_ratelimit_rcpt main string unset
16617 See &%smtp_ratelimit_hosts%& above.
16618
16619
16620 .option smtp_receive_timeout main time&!! 5m
16621 .cindex "timeout" "for SMTP input"
16622 .cindex "SMTP" "input timeout"
16623 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16624 input, including batch SMTP. If a line of input (either an SMTP command or a
16625 data line) is not received within this time, the SMTP connection is dropped and
16626 the message is abandoned.
16627 A line is written to the log containing one of the following messages:
16628 .code
16629 SMTP command timeout on connection from...
16630 SMTP data timeout on connection from...
16631 .endd
16632 The former means that Exim was expecting to read an SMTP command; the latter
16633 means that it was in the DATA phase, reading the contents of a message.
16634
16635 If the first character of the option is a &"$"& the option is
16636 expanded before use and may depend on
16637 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16638
16639
16640 .oindex "&%-os%&"
16641 The value set by this option can be overridden by the
16642 &%-os%& command-line option. A setting of zero time disables the timeout, but
16643 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16644 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16645 timeout is controlled by &%receive_timeout%& and &%-or%&.
16646
16647
16648 .option smtp_reserve_hosts main "host list&!!" unset
16649 This option defines hosts for which SMTP connections are reserved; see
16650 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16651
16652
16653 .option smtp_return_error_details main boolean false
16654 .cindex "SMTP" "details policy failures"
16655 .cindex "policy control" "rejection, returning details"
16656 In the default state, Exim uses bland messages such as
16657 &"Administrative prohibition"& when it rejects SMTP commands for policy
16658 reasons. Many sysadmins like this because it gives away little information
16659 to spammers. However, some other sysadmins who are applying strict checking
16660 policies want to give out much fuller information about failures. Setting
16661 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16662 example, instead of &"Administrative prohibition"&, it might give:
16663 .code
16664 550-Rejected after DATA: '>' missing at end of address:
16665 550 failing address in "From" header is: <user@dom.ain
16666 .endd
16667
16668
16669 .option smtputf8_advertise_hosts main "host list&!!" *
16670 .cindex "SMTPUTF8" "advertising"
16671 When Exim is built with support for internationalised mail names,
16672 the availability therof is advertised in
16673 response to EHLO only to those client hosts that match this option. See
16674 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16675
16676
16677 .option spamd_address main string "see below"
16678 This option is available when Exim is compiled with the content-scanning
16679 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16680 The default value is
16681 .code
16682 127.0.0.1 783
16683 .endd
16684 See section &<<SECTscanspamass>>& for more details.
16685
16686
16687
16688 .option split_spool_directory main boolean false
16689 .cindex "multiple spool directories"
16690 .cindex "spool directory" "split"
16691 .cindex "directories, multiple"
16692 If this option is set, it causes Exim to split its input directory into 62
16693 subdirectories, each with a single alphanumeric character as its name. The
16694 sixth character of the message id is used to allocate messages to
16695 subdirectories; this is the least significant base-62 digit of the time of
16696 arrival of the message.
16697
16698 Splitting up the spool in this way may provide better performance on systems
16699 where there are long mail queues, by reducing the number of files in any one
16700 directory. The msglog directory is also split up in a similar way to the input
16701 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16702 are still placed in the single directory &_msglog.OLD_&.
16703
16704 It is not necessary to take any special action for existing messages when
16705 changing &%split_spool_directory%&. Exim notices messages that are in the
16706 &"wrong"& place, and continues to process them. If the option is turned off
16707 after a period of being on, the subdirectories will eventually empty and be
16708 automatically deleted.
16709
16710 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16711 changes. Instead of creating a list of all messages in the queue, and then
16712 trying to deliver each one in turn, it constructs a list of those in one
16713 sub-directory and tries to deliver them, before moving on to the next
16714 sub-directory. The sub-directories are processed in a random order. This
16715 spreads out the scanning of the input directories, and uses less memory. It is
16716 particularly beneficial when there are lots of messages on the queue. However,
16717 if &%queue_run_in_order%& is set, none of this new processing happens. The
16718 entire queue has to be scanned and sorted before any deliveries can start.
16719
16720
16721 .option spool_directory main string&!! "set at compile time"
16722 .cindex "spool directory" "path to"
16723 This defines the directory in which Exim keeps its spool, that is, the messages
16724 it is waiting to deliver. The default value is taken from the compile-time
16725 configuration setting, if there is one. If not, this option must be set. The
16726 string is expanded, so it can contain, for example, a reference to
16727 &$primary_hostname$&.
16728
16729 If the spool directory name is fixed on your installation, it is recommended
16730 that you set it at build time rather than from this option, particularly if the
16731 log files are being written to the spool directory (see &%log_file_path%&).
16732 Otherwise log files cannot be used for errors that are detected early on, such
16733 as failures in the configuration file.
16734
16735 By using this option to override the compiled-in path, it is possible to run
16736 tests of Exim without using the standard spool.
16737
16738 .option sqlite_lock_timeout main time 5s
16739 .cindex "sqlite lookup type" "lock timeout"
16740 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16741 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16742
16743 .option strict_acl_vars main boolean false
16744 .cindex "&ACL;" "variables, handling unset"
16745 This option controls what happens if a syntactically valid but undefined ACL
16746 variable is referenced. If it is false (the default), an empty string
16747 is substituted; if it is true, an error is generated. See section
16748 &<<SECTaclvariables>>& for details of ACL variables.
16749
16750 .option strip_excess_angle_brackets main boolean false
16751 .cindex "angle brackets, excess"
16752 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16753 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16754 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16755 passed on to another MTA, the excess angle brackets are not passed on. If this
16756 option is not set, multiple pairs of angle brackets cause a syntax error.
16757
16758
16759 .option strip_trailing_dot main boolean false
16760 .cindex "trailing dot on domain"
16761 .cindex "dot" "trailing on domain"
16762 If this option is set, a trailing dot at the end of a domain in an address is
16763 ignored. If this is in the envelope and the message is passed on to another
16764 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16765 domain causes a syntax error.
16766 However, addresses in header lines are checked only when an ACL requests header
16767 syntax checking.
16768
16769
16770 .option syslog_duplication main boolean true
16771 .cindex "syslog" "duplicate log lines; suppressing"
16772 When Exim is logging to syslog, it writes the log lines for its three
16773 separate logs at different syslog priorities so that they can in principle
16774 be separated on the logging hosts. Some installations do not require this
16775 separation, and in those cases, the duplication of certain log lines is a
16776 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16777 particular log line is written to syslog. For lines that normally go to
16778 both the main log and the reject log, the reject log version (possibly
16779 containing message header lines) is written, at LOG_NOTICE priority.
16780 Lines that normally go to both the main and the panic log are written at
16781 the LOG_ALERT priority.
16782
16783
16784 .option syslog_facility main string unset
16785 .cindex "syslog" "facility; setting"
16786 This option sets the syslog &"facility"& name, used when Exim is logging to
16787 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16788 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16789 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16790 details of Exim's logging.
16791
16792
16793
16794 .option syslog_processname main string &`exim`&
16795 .cindex "syslog" "process name; setting"
16796 This option sets the syslog &"ident"& name, used when Exim is logging to
16797 syslog. The value must be no longer than 32 characters. See chapter
16798 &<<CHAPlog>>& for details of Exim's logging.
16799
16800
16801
16802 .option syslog_timestamp main boolean true
16803 .cindex "syslog" "timestamps"
16804 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16805 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16806 details of Exim's logging.
16807
16808
16809 .option system_filter main string&!! unset
16810 .cindex "filter" "system filter"
16811 .cindex "system filter" "specifying"
16812 .cindex "Sieve filter" "not available for system filter"
16813 This option specifies an Exim filter file that is applied to all messages at
16814 the start of each delivery attempt, before any routing is done. System filters
16815 must be Exim filters; they cannot be Sieve filters. If the system filter
16816 generates any deliveries to files or pipes, or any new mail messages, the
16817 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16818 which transports are to be used. Details of this facility are given in chapter
16819 &<<CHAPsystemfilter>>&.
16820
16821
16822 .option system_filter_directory_transport main string&!! unset
16823 .vindex "&$address_file$&"
16824 This sets the name of the transport driver that is to be used when the
16825 &%save%& command in a system message filter specifies a path ending in &"/"&,
16826 implying delivery of each message into a separate file in some directory.
16827 During the delivery, the variable &$address_file$& contains the path name.
16828
16829
16830 .option system_filter_file_transport main string&!! unset
16831 .cindex "file" "transport for system filter"
16832 This sets the name of the transport driver that is to be used when the &%save%&
16833 command in a system message filter specifies a path not ending in &"/"&. During
16834 the delivery, the variable &$address_file$& contains the path name.
16835
16836 .option system_filter_group main string unset
16837 .cindex "gid (group id)" "system filter"
16838 This option is used only when &%system_filter_user%& is also set. It sets the
16839 gid under which the system filter is run, overriding any gid that is associated
16840 with the user. The value may be numerical or symbolic.
16841
16842 .option system_filter_pipe_transport main string&!! unset
16843 .cindex "&(pipe)& transport" "for system filter"
16844 .vindex "&$address_pipe$&"
16845 This specifies the transport driver that is to be used when a &%pipe%& command
16846 is used in a system filter. During the delivery, the variable &$address_pipe$&
16847 contains the pipe command.
16848
16849
16850 .option system_filter_reply_transport main string&!! unset
16851 .cindex "&(autoreply)& transport" "for system filter"
16852 This specifies the transport driver that is to be used when a &%mail%& command
16853 is used in a system filter.
16854
16855
16856 .option system_filter_user main string unset
16857 .cindex "uid (user id)" "system filter"
16858 If this option is set to root, the system filter is run in the main Exim
16859 delivery process, as root.  Otherwise, the system filter runs in a separate
16860 process, as the given user, defaulting to the Exim run-time user.
16861 Unless the string consists entirely of digits, it
16862 is looked up in the password data. Failure to find the named user causes a
16863 configuration error. The gid is either taken from the password data, or
16864 specified by &%system_filter_group%&. When the uid is specified numerically,
16865 &%system_filter_group%& is required to be set.
16866
16867 If the system filter generates any pipe, file, or reply deliveries, the uid
16868 under which the filter is run is used when transporting them, unless a
16869 transport option overrides.
16870
16871
16872 .option tcp_nodelay main boolean true
16873 .cindex "daemon" "TCP_NODELAY on sockets"
16874 .cindex "Nagle algorithm"
16875 .cindex "TCP_NODELAY on listening sockets"
16876 If this option is set false, it stops the Exim daemon setting the
16877 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16878 turns off the &"Nagle algorithm"&, which is a way of improving network
16879 performance in interactive (character-by-character) situations. Turning it off
16880 should improve Exim's performance a bit, so that is what happens by default.
16881 However, it appears that some broken clients cannot cope, and time out. Hence
16882 this option. It affects only those sockets that are set up for listening by the
16883 daemon. Sockets created by the smtp transport for delivering mail always set
16884 TCP_NODELAY.
16885
16886
16887 .option timeout_frozen_after main time 0s
16888 .cindex "frozen messages" "timing out"
16889 .cindex "timeout" "frozen messages"
16890 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16891 message of any kind that has been on the queue for longer than the given time
16892 is automatically cancelled at the next queue run. If the frozen message is a
16893 bounce message, it is just discarded; otherwise, a bounce is sent to the
16894 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16895 If you want to timeout frozen bounce messages earlier than other kinds of
16896 frozen message, see &%ignore_bounce_errors_after%&.
16897
16898 &*Note:*& the default value of zero means no timeouts; with this setting,
16899 frozen messages remain on the queue forever (except for any frozen bounce
16900 messages that are released by &%ignore_bounce_errors_after%&).
16901
16902
16903 .option timezone main string unset
16904 .cindex "timezone, setting"
16905 .cindex "environment" "values from"
16906 The value of &%timezone%& is used to set the environment variable TZ while
16907 running Exim (if it is different on entry). This ensures that all timestamps
16908 created by Exim are in the required timezone. If you want all your timestamps
16909 to be in UTC (aka GMT) you should set
16910 .code
16911 timezone = UTC
16912 .endd
16913 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16914 or, if that is not set, from the value of the TZ environment variable when Exim
16915 is built. If &%timezone%& is set to the empty string, either at build or run
16916 time, any existing TZ variable is removed from the environment when Exim
16917 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16918 unfortunately not all, operating systems.
16919
16920
16921 .option tls_advertise_hosts main "host list&!!" *
16922 .cindex "TLS" "advertising"
16923 .cindex "encryption" "on SMTP connection"
16924 .cindex "SMTP" "encrypted connection"
16925 When Exim is built with support for TLS encrypted connections, the availability
16926 of the STARTTLS command to set up an encrypted session is advertised in
16927 response to EHLO only to those client hosts that match this option. See
16928 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16929 Note that the default value requires that a certificate be supplied
16930 using the &%tls_certificate%& option.  If TLS support for incoming connections
16931 is not required the &%tls_advertise_hosts%& option should be set empty.
16932
16933
16934 .option tls_certificate main string&!! unset
16935 .cindex "TLS" "server certificate; location of"
16936 .cindex "certificate" "server, location of"
16937 The value of this option is expanded, and must then be the absolute path to a
16938 file which contains the server's certificates. The server's private key is also
16939 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16940 &<<CHAPTLS>>& for further details.
16941
16942 &*Note*&: The certificates defined by this option are used only when Exim is
16943 receiving incoming messages as a server. If you want to supply certificates for
16944 use when sending messages as a client, you must set the &%tls_certificate%&
16945 option in the relevant &(smtp)& transport.
16946
16947 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16948 if the OpenSSL build supports TLS extensions and the TLS client sends the
16949 Server Name Indication extension, then this option and others documented in
16950 &<<SECTtlssni>>& will be re-expanded.
16951
16952 .new
16953 If this option is unset or empty a fresh self-signed certificate will be
16954 generated for every connection.
16955 .wen
16956
16957 .option tls_crl main string&!! unset
16958 .cindex "TLS" "server certificate revocation list"
16959 .cindex "certificate" "revocation list for server"
16960 This option specifies a certificate revocation list. The expanded value must
16961 be the name of a file that contains a CRL in PEM format.
16962
16963 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16964
16965
16966 .option tls_dh_max_bits main integer 2236
16967 .cindex "TLS" "D-H bit count"
16968 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16969 the chosen TLS library.  That value might prove to be too high for
16970 interoperability.  This option provides a maximum clamp on the value
16971 suggested, trading off security for interoperability.
16972
16973 The value must be at least 1024.
16974
16975 The value 2236 was chosen because, at time of adding the option, it was the
16976 hard-coded maximum value supported by the NSS cryptographic library, as used
16977 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16978
16979 If you prefer more security and are willing to break some clients, raise this
16980 number.
16981
16982 Note that the value passed to GnuTLS for *generating* a new prime may be a
16983 little less than this figure, because GnuTLS is inexact and may produce a
16984 larger prime than requested.
16985
16986
16987 .option tls_dhparam main string&!! unset
16988 .cindex "TLS" "D-H parameters for server"
16989 The value of this option is expanded and indicates the source of DH parameters
16990 to be used by Exim.
16991
16992 If it is a filename starting with a &`/`&, then it names a file from which DH
16993 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16994 PKCS#3 representation of the DH prime.  If the file does not exist, for
16995 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16996 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16997 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16998 and treated as though the &%tls_dhparam%& were set to "none".
16999
17000 If this option expands to the string "none", then no DH parameters will be
17001 loaded by Exim.
17002
17003 If this option expands to the string "historic" and Exim is using GnuTLS, then
17004 Exim will attempt to load a file from inside the spool directory.  If the file
17005 does not exist, Exim will attempt to create it.
17006 See section &<<SECTgnutlsparam>>& for further details.
17007
17008 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17009 a default DH prime; the default is the 2048 bit prime described in section
17010 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17011 in IKE is assigned number 23.
17012
17013 Otherwise, the option must expand to the name used by Exim for any of a number
17014 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
17015 "ike" followed by the number used by IKE, or "default" which corresponds to
17016 "ike23".
17017
17018 The available primes are:
17019 &`ike1`&, &`ike2`&, &`ike5`&,
17020 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17021 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
17022
17023 Some of these will be too small to be accepted by clients.
17024 Some may be too large to be accepted by clients.
17025
17026 The TLS protocol does not negotiate an acceptable size for this; clients tend
17027 to hard-drop connections if what is offered by the server is unacceptable,
17028 whether too large or too small, and there's no provision for the client to
17029 tell the server what these constraints are.  Thus, as a server operator, you
17030 need to make an educated guess as to what is most likely to work for your
17031 userbase.
17032
17033 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17034 is most likely to maximise interoperability.  The upper bound comes from
17035 applications using the Mozilla Network Security Services (NSS) library, which
17036 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17037 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17038 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17039 acceptable bound from 1024 to 2048.
17040
17041
17042 .option tls_eccurve main string&!! prime256v1
17043 .cindex TLS "EC cryptography"
17044 If built with a recent-enough version of OpenSSL,
17045 this option selects a EC curve for use by Exim.
17046
17047 Curve names of the form &'prime256v1'& are accepted.
17048 For even more-recent library versions, names of the form &'P-512'&
17049 are also accepted, plus the special value &'auto'&
17050 which tells the library to choose.
17051
17052 If the option is set to an empty string, no EC curves will be enabled.
17053
17054
17055 .option tls_ocsp_file main string&!! unset
17056 .cindex TLS "certificate status"
17057 .cindex TLS "OCSP proof file"
17058 This option
17059 must if set expand to the absolute path to a file which contains a current
17060 status proof for the server's certificate, as obtained from the
17061 Certificate Authority.
17062
17063 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17064
17065
17066 .option tls_on_connect_ports main "string list" unset
17067 .cindex SSMTP
17068 .cindex SMTPS
17069 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17070 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17071 set up without waiting for the client to issue a STARTTLS command. For
17072 further details, see section &<<SECTsupobssmt>>&.
17073
17074
17075
17076 .option tls_privatekey main string&!! unset
17077 .cindex "TLS" "server private key; location of"
17078 The value of this option is expanded, and must then be the absolute path to a
17079 file which contains the server's private key. If this option is unset, or if
17080 the expansion is forced to fail, or the result is an empty string, the private
17081 key is assumed to be in the same file as the server's certificates. See chapter
17082 &<<CHAPTLS>>& for further details.
17083
17084 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17085
17086
17087 .option tls_remember_esmtp main boolean false
17088 .cindex "TLS" "esmtp state; remembering"
17089 .cindex "TLS" "broken clients"
17090 If this option is set true, Exim violates the RFCs by remembering that it is in
17091 &"esmtp"& state after successfully negotiating a TLS session. This provides
17092 support for broken clients that fail to send a new EHLO after starting a
17093 TLS session.
17094
17095
17096 .option tls_require_ciphers main string&!! unset
17097 .cindex "TLS" "requiring specific ciphers"
17098 .cindex "cipher" "requiring specific"
17099 This option controls which ciphers can be used for incoming TLS connections.
17100 The &(smtp)& transport has an option of the same name for controlling outgoing
17101 connections. This option is expanded for each connection, so can be varied for
17102 different clients if required. The value of this option must be a list of
17103 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17104 in somewhat different ways. If GnuTLS is being used, the client controls the
17105 preference order of the available ciphers. Details are given in sections
17106 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17107
17108
17109 .option tls_try_verify_hosts main "host list&!!" unset
17110 .cindex "TLS" "client certificate verification"
17111 .cindex "certificate" "verification of client"
17112 See &%tls_verify_hosts%& below.
17113
17114
17115 .option tls_verify_certificates main string&!! system
17116 .cindex "TLS" "client certificate verification"
17117 .cindex "certificate" "verification of client"
17118 The value of this option is expanded, and must then be either the
17119 word "system"
17120 or the absolute path to
17121 a file or directory containing permitted certificates for clients that
17122 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17123
17124 The "system" value for the option will use a
17125 system default location compiled into the SSL library.
17126 This is not available for GnuTLS versions preceding 3.0.20,
17127 and will be taken as empty; an explicit location
17128 must be specified.
17129
17130 The use of a directory for the option value is not available for GnuTLS versions
17131 preceding 3.3.6 and a single file must be used.
17132
17133 With OpenSSL the certificates specified
17134 explicitly
17135 either by file or directory
17136 are added to those given by the system default location.
17137
17138 These certificates should be for the certificate authorities trusted, rather
17139 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17140 the value is a file then the certificates are sent by Exim as a server to
17141 connecting clients, defining the list of accepted certificate authorities.
17142 Thus the values defined should be considered public data.  To avoid this,
17143 use the explicit directory version.
17144
17145 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17146
17147 A forced expansion failure or setting to an empty string is equivalent to
17148 being unset.
17149
17150
17151 .option tls_verify_hosts main "host list&!!" unset
17152 .cindex "TLS" "client certificate verification"
17153 .cindex "certificate" "verification of client"
17154 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17155 certificates from clients. The expected certificates are defined by
17156 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17157 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17158 &%tls_verify_certificates%& is not set.
17159
17160 Any client that matches &%tls_verify_hosts%& is constrained by
17161 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17162 present one of the listed certificates. If it does not, the connection is
17163 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17164 the host to use TLS. It can still send SMTP commands through unencrypted
17165 connections. Forcing a client to use TLS has to be done separately using an
17166 ACL to reject inappropriate commands when the connection is not encrypted.
17167
17168 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17169 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17170 certificate and checks it against &%tls_verify_certificates%&, but does not
17171 abort the connection if there is no certificate or if it does not match. This
17172 state can be detected in an ACL, which makes it possible to implement policies
17173 such as &"accept for relay only if a verified certificate has been received,
17174 but accept for local delivery if encrypted, even without a verified
17175 certificate"&.
17176
17177 Client hosts that match neither of these lists are not asked to present
17178 certificates.
17179
17180
17181 .option trusted_groups main "string list&!!" unset
17182 .cindex "trusted groups"
17183 .cindex "groups" "trusted"
17184 This option is expanded just once, at the start of Exim's processing. If this
17185 option is set, any process that is running in one of the listed groups, or
17186 which has one of them as a supplementary group, is trusted. The groups can be
17187 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17188 details of what trusted callers are permitted to do. If neither
17189 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17190 are trusted.
17191
17192 .option trusted_users main "string list&!!" unset
17193 .cindex "trusted users"
17194 .cindex "user" "trusted"
17195 This option is expanded just once, at the start of Exim's processing. If this
17196 option is set, any process that is running as one of the listed users is
17197 trusted. The users can be specified numerically or by name. See section
17198 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17199 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17200 Exim user are trusted.
17201
17202 .option unknown_login main string&!! unset
17203 .cindex "uid (user id)" "unknown caller"
17204 .vindex "&$caller_uid$&"
17205 This is a specialized feature for use in unusual configurations. By default, if
17206 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17207 gives up. The &%unknown_login%& option can be used to set a login name to be
17208 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17209 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17210 is used for the user's real name (gecos field), unless this has been set by the
17211 &%-F%& option.
17212
17213 .option unknown_username main string unset
17214 See &%unknown_login%&.
17215
17216 .option untrusted_set_sender main "address list&!!" unset
17217 .cindex "trusted users"
17218 .cindex "sender" "setting by untrusted user"
17219 .cindex "untrusted user setting sender"
17220 .cindex "user" "untrusted setting sender"
17221 .cindex "envelope sender"
17222 When an untrusted user submits a message to Exim using the standard input, Exim
17223 normally creates an envelope sender address from the user's login and the
17224 default qualification domain. Data from the &%-f%& option (for setting envelope
17225 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17226 is used) is ignored.
17227
17228 However, untrusted users are permitted to set an empty envelope sender address,
17229 to declare that a message should never generate any bounces. For example:
17230 .code
17231 exim -f '<>' user@domain.example
17232 .endd
17233 .vindex "&$sender_ident$&"
17234 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17235 other envelope sender addresses in a controlled way. When it is set, untrusted
17236 users are allowed to set envelope sender addresses that match any of the
17237 patterns in the list. Like all address lists, the string is expanded. The
17238 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17239 users to setting senders that start with their login ids
17240 followed by a hyphen
17241 by a setting like this:
17242 .code
17243 untrusted_set_sender = ^$sender_ident-
17244 .endd
17245 If you want to allow untrusted users to set envelope sender addresses without
17246 restriction, you can use
17247 .code
17248 untrusted_set_sender = *
17249 .endd
17250 The &%untrusted_set_sender%& option applies to all forms of local input, but
17251 only to the setting of the envelope sender. It does not permit untrusted users
17252 to use the other options which trusted user can use to override message
17253 parameters. Furthermore, it does not stop Exim from removing an existing
17254 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17255 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17256 overriding these actions. The handling of the &'Sender:'& header is also
17257 described in section &<<SECTthesenhea>>&.
17258
17259 The log line for a message's arrival shows the envelope sender following
17260 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17261 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17262 envelope sender address, the user's login is shown in parentheses after the
17263 sender address.
17264
17265
17266 .option uucp_from_pattern main string "see below"
17267 .cindex "&""From""& line"
17268 .cindex "UUCP" "&""From""& line"
17269 Some applications that pass messages to an MTA via a command line interface use
17270 an initial line starting with &"From&~"& to pass the envelope sender. In
17271 particular, this is used by UUCP software. Exim recognizes such a line by means
17272 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17273 matches, the sender address is constructed by expanding the contents of
17274 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17275 default pattern recognizes lines in the following two forms:
17276 .code
17277 From ph10 Fri Jan  5 12:35 GMT 1996
17278 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17279 .endd
17280 The pattern can be seen by running
17281 .code
17282 exim -bP uucp_from_pattern
17283 .endd
17284 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17285 year in the second case. The first word after &"From&~"& is matched in the
17286 regular expression by a parenthesized subpattern. The default value for
17287 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17288 (&"ph10"& in the example above) as the message's sender. See also
17289 &%ignore_fromline_hosts%&.
17290
17291
17292 .option uucp_from_sender main string&!! &`$1`&
17293 See &%uucp_from_pattern%& above.
17294
17295
17296 .option warn_message_file main string unset
17297 .cindex "warning of delay" "customizing the message"
17298 .cindex "customizing" "warning message"
17299 This option defines a template file containing paragraphs of text to be used
17300 for constructing the warning message which is sent by Exim when a message has
17301 been on the queue for a specified amount of time, as specified by
17302 &%delay_warning%&. Details of the file's contents are given in chapter
17303 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17304
17305
17306 .option write_rejectlog main boolean true
17307 .cindex "reject log" "disabling"
17308 If this option is set false, Exim no longer writes anything to the reject log.
17309 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17310 .ecindex IIDconfima
17311 .ecindex IIDmaiconf
17312
17313
17314
17315
17316 . ////////////////////////////////////////////////////////////////////////////
17317 . ////////////////////////////////////////////////////////////////////////////
17318
17319 .chapter "Generic options for routers" "CHAProutergeneric"
17320 .scindex IIDgenoprou1 "options" "generic; for routers"
17321 .scindex IIDgenoprou2 "generic options" "router"
17322 This chapter describes the generic options that apply to all routers.
17323 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17324
17325 For a general description of how a router operates, see sections
17326 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17327 which the preconditions are tested. The order of expansion of the options that
17328 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17329 &%headers_remove%&, &%transport%&.
17330
17331
17332
17333 .option address_data routers string&!! unset
17334 .cindex "router" "data attached to address"
17335 The string is expanded just before the router is run, that is, after all the
17336 precondition tests have succeeded. If the expansion is forced to fail, the
17337 router declines, the value of &%address_data%& remains unchanged, and the
17338 &%more%& option controls what happens next. Other expansion failures cause
17339 delivery of the address to be deferred.
17340
17341 .vindex "&$address_data$&"
17342 When the expansion succeeds, the value is retained with the address, and can be
17343 accessed using the variable &$address_data$& in the current router, subsequent
17344 routers, and the eventual transport.
17345
17346 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17347 that runs a user's filter file, the contents of &$address_data$& are accessible
17348 in the filter. This is not normally a problem, because such data is usually
17349 either not confidential or it &"belongs"& to the current user, but if you do
17350 put confidential data into &$address_data$& you need to remember this point.
17351
17352 Even if the router declines or passes, the value of &$address_data$& remains
17353 with the address, though it can be changed by another &%address_data%& setting
17354 on a subsequent router. If a router generates child addresses, the value of
17355 &$address_data$& propagates to them. This also applies to the special kind of
17356 &"child"& that is generated by a router with the &%unseen%& option.
17357
17358 The idea of &%address_data%& is that you can use it to look up a lot of data
17359 for the address once, and then pick out parts of the data later. For example,
17360 you could use a single LDAP lookup to return a string of the form
17361 .code
17362 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17363 .endd
17364 In the transport you could pick out the mailbox by a setting such as
17365 .code
17366 file = ${extract{mailbox}{$address_data}}
17367 .endd
17368 This makes the configuration file less messy, and also reduces the number of
17369 lookups (though Exim does cache lookups).
17370
17371 .vindex "&$sender_address_data$&"
17372 .vindex "&$address_data$&"
17373 The &%address_data%& facility is also useful as a means of passing information
17374 from one router to another, and from a router to a transport. In addition, if
17375 &$address_data$& is set by a router when verifying a recipient address from an
17376 ACL, it remains available for use in the rest of the ACL statement. After
17377 verifying a sender, the value is transferred to &$sender_address_data$&.
17378
17379
17380
17381 .option address_test routers&!? boolean true
17382 .oindex "&%-bt%&"
17383 .cindex "router" "skipping when address testing"
17384 If this option is set false, the router is skipped when routing is being tested
17385 by means of the &%-bt%& command line option. This can be a convenience when
17386 your first router sends messages to an external scanner, because it saves you
17387 having to set the &"already scanned"& indicator when testing real address
17388 routing.
17389
17390
17391
17392 .option cannot_route_message routers string&!! unset
17393 .cindex "router" "customizing &""cannot route""& message"
17394 .cindex "customizing" "&""cannot route""& message"
17395 This option specifies a text message that is used when an address cannot be
17396 routed because Exim has run out of routers. The default message is
17397 &"Unrouteable address"&. This option is useful only on routers that have
17398 &%more%& set false, or on the very last router in a configuration, because the
17399 value that is used is taken from the last router that is considered. This
17400 includes a router that is skipped because its preconditions are not met, as
17401 well as a router that declines. For example, using the default configuration,
17402 you could put:
17403 .code
17404 cannot_route_message = Remote domain not found in DNS
17405 .endd
17406 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17407 and
17408 .code
17409 cannot_route_message = Unknown local user
17410 .endd
17411 on the final router that checks for local users. If string expansion fails for
17412 this option, the default message is used. Unless the expansion failure was
17413 explicitly forced, a message about the failure is written to the main and panic
17414 logs, in addition to the normal message about the routing failure.
17415
17416
17417 .option caseful_local_part routers boolean false
17418 .cindex "case of local parts"
17419 .cindex "router" "case of local parts"
17420 By default, routers handle the local parts of addresses in a case-insensitive
17421 manner, though the actual case is preserved for transmission with the message.
17422 If you want the case of letters to be significant in a router, you must set
17423 this option true. For individual router options that contain address or local
17424 part lists (for example, &%local_parts%&), case-sensitive matching can be
17425 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17426 more details.
17427
17428 .vindex "&$local_part$&"
17429 .vindex "&$original_local_part$&"
17430 .vindex "&$parent_local_part$&"
17431 The value of the &$local_part$& variable is forced to lower case while a
17432 router is running unless &%caseful_local_part%& is set. When a router assigns
17433 an address to a transport, the value of &$local_part$& when the transport runs
17434 is the same as it was in the router. Similarly, when a router generates child
17435 addresses by aliasing or forwarding, the values of &$original_local_part$&
17436 and &$parent_local_part$& are those that were used by the redirecting router.
17437
17438 This option applies to the processing of an address by a router. When a
17439 recipient address is being processed in an ACL, there is a separate &%control%&
17440 modifier that can be used to specify case-sensitive processing within the ACL
17441 (see section &<<SECTcontrols>>&).
17442
17443
17444
17445 .option check_local_user routers&!? boolean false
17446 .cindex "local user, checking in router"
17447 .cindex "router" "checking for local user"
17448 .cindex "&_/etc/passwd_&"
17449 .vindex "&$home$&"
17450 When this option is true, Exim checks that the local part of the recipient
17451 address (with affixes removed if relevant) is the name of an account on the
17452 local system. The check is done by calling the &[getpwnam()]& function rather
17453 than trying to read &_/etc/passwd_& directly. This means that other methods of
17454 holding password data (such as NIS) are supported. If the local part is a local
17455 user, &$home$& is set from the password data, and can be tested in other
17456 preconditions that are evaluated after this one (the order of evaluation is
17457 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17458 overridden by &%router_home_directory%&. If the local part is not a local user,
17459 the router is skipped.
17460
17461 If you want to check that the local part is either the name of a local user
17462 or matches something else, you cannot combine &%check_local_user%& with a
17463 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17464 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17465 setting to achieve this. For example:
17466 .code
17467 local_parts = passwd;$local_part : lsearch;/etc/other/users
17468 .endd
17469 Note, however, that the side effects of &%check_local_user%& (such as setting
17470 up a home directory) do not occur when a &(passwd)& lookup is used in a
17471 &%local_parts%& (or any other) precondition.
17472
17473
17474
17475 .option condition routers&!? string&!! unset
17476 .cindex "router" "customized precondition"
17477 This option specifies a general precondition test that has to succeed for the
17478 router to be called. The &%condition%& option is the last precondition to be
17479 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17480 result is a forced failure, or an empty string, or one of the strings &"0"& or
17481 &"no"& or &"false"& (checked without regard to the case of the letters), the
17482 router is skipped, and the address is offered to the next one.
17483
17484 If the result is any other value, the router is run (as this is the last
17485 precondition to be evaluated, all the other preconditions must be true).
17486
17487 This option is unusual in that multiple &%condition%& options may be present.
17488 All &%condition%& options must succeed.
17489
17490 The &%condition%& option provides a means of applying custom conditions to the
17491 running of routers. Note that in the case of a simple conditional expansion,
17492 the default expansion values are exactly what is wanted. For example:
17493 .code
17494 condition = ${if >{$message_age}{600}}
17495 .endd
17496 Because of the default behaviour of the string expansion, this is equivalent to
17497 .code
17498 condition = ${if >{$message_age}{600}{true}{}}
17499 .endd
17500
17501 A multiple condition example, which succeeds:
17502 .code
17503 condition = ${if >{$message_age}{600}}
17504 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17505 condition = foobar
17506 .endd
17507
17508 If the expansion fails (other than forced failure) delivery is deferred. Some
17509 of the other precondition options are common special cases that could in fact
17510 be specified using &%condition%&.
17511
17512 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17513 are far older, and use one set of semantics.  ACLs are newer and when
17514 they were created, the ACL &%condition%& process was given far stricter
17515 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17516 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17517 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17518 Router rules processing behavior.
17519
17520 This is best illustrated in an example:
17521 .code
17522 # If used in an ACL condition will fail with a syntax error, but
17523 # in a router condition any extra characters are treated as a string
17524
17525 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17526 true {yes} {no}}
17527
17528 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17529  {yes} {no}}
17530 .endd
17531 In each example above, the &%if%& statement actually ends after
17532 &"{google.com}}"&.  Since no true or false braces were defined, the
17533 default &%if%& behavior is to return a boolean true or a null answer
17534 (which evaluates to false). The rest of the line is then treated as a
17535 string. So the first example resulted in the boolean answer &"true"&
17536 with the string &" {yes} {no}}"& appended to it. The second example
17537 resulted in the null output (indicating false) with the string
17538 &" {yes} {no}}"& appended to it.
17539
17540 In fact you can put excess forward braces in too.  In the router
17541 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17542 mean something, like after a &"$"& or when required as part of a
17543 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17544 string characters.
17545
17546 Thus, in a Router, the above expansion strings will both always evaluate
17547 true, as the result of expansion is a non-empty string which doesn't
17548 match an explicit false value.  This can be tricky to debug.  By
17549 contrast, in an ACL either of those strings will always result in an
17550 expansion error because the result doesn't look sufficiently boolean.
17551
17552
17553 .option debug_print routers string&!! unset
17554 .cindex "testing" "variables in drivers"
17555 If this option is set and debugging is enabled (see the &%-d%& command line
17556 option) or in address-testing mode (see the &%-bt%& command line option),
17557 the string is expanded and included in the debugging output.
17558 If expansion of the string fails, the error message is written to the debugging
17559 output, and Exim carries on processing.
17560 This option is provided to help with checking out the values of variables and
17561 so on when debugging router configurations. For example, if a &%condition%&
17562 option appears not to be working, &%debug_print%& can be used to output the
17563 variables it references. The output happens after checks for &%domains%&,
17564 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17565 are tested. A newline is added to the text if it does not end with one.
17566 The variable &$router_name$& contains the name of the router.
17567
17568
17569
17570 .option disable_logging routers boolean false
17571 If this option is set true, nothing is logged for any routing errors
17572 or for any deliveries caused by this router. You should not set this option
17573 unless you really, really know what you are doing. See also the generic
17574 transport option of the same name.
17575
17576 .option dnssec_request_domains routers "domain list&!!" unset
17577 .cindex "MX record" "security"
17578 .cindex "DNSSEC" "MX lookup"
17579 .cindex "security" "MX lookup"
17580 .cindex "DNS" "DNSSEC"
17581 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17582 the dnssec request bit set.
17583 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17584
17585 .option dnssec_require_domains routers "domain list&!!" unset
17586 .cindex "MX record" "security"
17587 .cindex "DNSSEC" "MX lookup"
17588 .cindex "security" "MX lookup"
17589 .cindex "DNS" "DNSSEC"
17590 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17591 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17592 (AD bit) set will be ignored and logged as a host-lookup failure.
17593 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17594
17595
17596 .option domains routers&!? "domain list&!!" unset
17597 .cindex "router" "restricting to specific domains"
17598 .vindex "&$domain_data$&"
17599 If this option is set, the router is skipped unless the current domain matches
17600 the list. If the match is achieved by means of a file lookup, the data that the
17601 lookup returned for the domain is placed in &$domain_data$& for use in string
17602 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17603 a list of the order in which preconditions are evaluated.
17604
17605
17606
17607 .option driver routers string unset
17608 This option must always be set. It specifies which of the available routers is
17609 to be used.
17610
17611
17612 .option dsn_lasthop routers boolean false
17613 .cindex "DSN" "success"
17614 .cindex "Delivery Status Notification" "success"
17615 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17616 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17617 instead send a success DSN as if the next hop does not support DSN.
17618 Not effective on redirect routers.
17619
17620
17621
17622 .option errors_to routers string&!! unset
17623 .cindex "envelope sender"
17624 .cindex "router" "changing address for errors"
17625 If a router successfully handles an address, it may assign the address to a
17626 transport for delivery or it may generate child addresses. In both cases, if
17627 there is a delivery problem during later processing, the resulting bounce
17628 message is sent to the address that results from expanding this string,
17629 provided that the address verifies successfully. The &%errors_to%& option is
17630 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17631
17632 The &%errors_to%& setting associated with an address can be overridden if it
17633 subsequently passes through other routers that have their own &%errors_to%&
17634 settings, or if the message is delivered by a transport with a &%return_path%&
17635 setting.
17636
17637 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17638 the expansion fails to verify, the errors address associated with the incoming
17639 address is used. At top level, this is the envelope sender. A non-forced
17640 expansion failure causes delivery to be deferred.
17641
17642 If an address for which &%errors_to%& has been set ends up being delivered over
17643 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17644 any bounces that are generated by other MTAs on the delivery route are also
17645 sent there. You can set &%errors_to%& to the empty string by either of these
17646 settings:
17647 .code
17648 errors_to =
17649 errors_to = ""
17650 .endd
17651 An expansion item that yields an empty string has the same effect. If you do
17652 this, a locally detected delivery error for addresses processed by this router
17653 no longer gives rise to a bounce message; the error is discarded. If the
17654 address is delivered to a remote host, the return path is set to &`<>`&, unless
17655 overridden by the &%return_path%& option on the transport.
17656
17657 .vindex "&$address_data$&"
17658 If for some reason you want to discard local errors, but use a non-empty
17659 MAIL command for remote delivery, you can preserve the original return
17660 path in &$address_data$& in the router, and reinstate it in the transport by
17661 setting &%return_path%&.
17662
17663 The most common use of &%errors_to%& is to direct mailing list bounces to the
17664 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17665 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17666
17667
17668
17669 .option expn routers&!? boolean true
17670 .cindex "address" "testing"
17671 .cindex "testing" "addresses"
17672 .cindex "EXPN" "router skipping"
17673 .cindex "router" "skipping for EXPN"
17674 If this option is turned off, the router is skipped when testing an address
17675 as a result of processing an SMTP EXPN command. You might, for example,
17676 want to turn it off on a router for users' &_.forward_& files, while leaving it
17677 on for the system alias file.
17678 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17679 are evaluated.
17680
17681 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17682 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17683 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17684
17685
17686
17687 .option fail_verify routers boolean false
17688 .cindex "router" "forcing verification failure"
17689 Setting this option has the effect of setting both &%fail_verify_sender%& and
17690 &%fail_verify_recipient%& to the same value.
17691
17692
17693
17694 .option fail_verify_recipient routers boolean false
17695 If this option is true and an address is accepted by this router when
17696 verifying a recipient, verification fails.
17697
17698
17699
17700 .option fail_verify_sender routers boolean false
17701 If this option is true and an address is accepted by this router when
17702 verifying a sender, verification fails.
17703
17704
17705
17706 .option fallback_hosts routers "string list" unset
17707 .cindex "router" "fallback hosts"
17708 .cindex "fallback" "hosts specified on router"
17709 String expansion is not applied to this option. The argument must be a
17710 colon-separated list of host names or IP addresses. The list separator can be
17711 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17712 each name or address. In fact, the format of each item is exactly the same as
17713 defined for the list of hosts in a &(manualroute)& router (see section
17714 &<<SECTformatonehostitem>>&).
17715
17716 If a router queues an address for a remote transport, this host list is
17717 associated with the address, and used instead of the transport's fallback host
17718 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17719 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17720 transport for further details.
17721
17722
17723 .option group routers string&!! "see below"
17724 .cindex "gid (group id)" "local delivery"
17725 .cindex "local transports" "uid and gid"
17726 .cindex "transport" "local"
17727 .cindex "router" "setting group"
17728 When a router queues an address for a transport, and the transport does not
17729 specify a group, the group given here is used when running the delivery
17730 process.
17731 The group may be specified numerically or by name. If expansion fails, the
17732 error is logged and delivery is deferred.
17733 The default is unset, unless &%check_local_user%& is set, when the default
17734 is taken from the password information. See also &%initgroups%& and &%user%&
17735 and the discussion in chapter &<<CHAPenvironment>>&.
17736
17737
17738
17739 .option headers_add routers list&!! unset
17740 .cindex "header lines" "adding"
17741 .cindex "router" "adding header lines"
17742 This option specifies a list of text headers,
17743 newline-separated (by default, changeable in the usual way),
17744 that is associated with any addresses that are accepted by the router.
17745 Each item is separately expanded, at routing time.  However, this
17746 option has no effect when an address is just being verified. The way in which
17747 the text is used to add header lines at transport time is described in section
17748 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17749 message is in the process of being transported. This means that references to
17750 header lines in string expansions in the transport's configuration do not
17751 &"see"& the added header lines.
17752
17753 The &%headers_add%& option is expanded after &%errors_to%&, but before
17754 &%headers_remove%& and &%transport%&. If an item is empty, or if
17755 an item expansion is forced to fail, the item has no effect. Other expansion
17756 failures are treated as configuration errors.
17757
17758 Unlike most options, &%headers_add%& can be specified multiple times
17759 for a router; all listed headers are added.
17760
17761 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17762 router that has the &%one_time%& option set.
17763
17764 .cindex "duplicate addresses"
17765 .oindex "&%unseen%&"
17766 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17767 additions are deleted when the address is passed on to subsequent routers.
17768 For a &%redirect%& router, if a generated address is the same as the incoming
17769 address, this can lead to duplicate addresses with different header
17770 modifications. Exim does not do duplicate deliveries (except, in certain
17771 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17772 which of the duplicates is discarded, so this ambiguous situation should be
17773 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17774
17775
17776
17777 .option headers_remove routers list&!! unset
17778 .cindex "header lines" "removing"
17779 .cindex "router" "removing header lines"
17780 This option specifies a list of text headers,
17781 colon-separated (by default, changeable in the usual way),
17782 that is associated with any addresses that are accepted by the router.
17783 Each item is separately expanded, at routing time.  However, this
17784 option has no effect when an address is just being verified. The way in which
17785 the text is used to remove header lines at transport time is described in
17786 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17787 the message is in the process of being transported. This means that references
17788 to header lines in string expansions in the transport's configuration still
17789 &"see"& the original header lines.
17790
17791 The &%headers_remove%& option is expanded after &%errors_to%& and
17792 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17793 the item has no effect. Other expansion failures are treated as configuration
17794 errors.
17795
17796 Unlike most options, &%headers_remove%& can be specified multiple times
17797 for a router; all listed headers are removed.
17798
17799 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17800 router that has the &%one_time%& option set.
17801
17802 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17803 removal requests are deleted when the address is passed on to subsequent
17804 routers, and this can lead to problems with duplicates -- see the similar
17805 warning for &%headers_add%& above.
17806
17807 &*Warning 3*&: Because of the separate expansion of the list items,
17808 items that contain a list separator must have it doubled.
17809 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17810
17811
17812
17813 .option ignore_target_hosts routers "host list&!!" unset
17814 .cindex "IP address" "discarding"
17815 .cindex "router" "discarding IP addresses"
17816 Although this option is a host list, it should normally contain IP address
17817 entries rather than names. If any host that is looked up by the router has an
17818 IP address that matches an item in this list, Exim behaves as if that IP
17819 address did not exist. This option allows you to cope with rogue DNS entries
17820 like
17821 .code
17822 remote.domain.example.  A  127.0.0.1
17823 .endd
17824 by setting
17825 .code
17826 ignore_target_hosts = 127.0.0.1
17827 .endd
17828 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17829 discarded in this way, the router declines. In a conventional configuration, an
17830 attempt to mail to such a domain would normally provoke the &"unrouteable
17831 domain"& error, and an attempt to verify an address in the domain would fail.
17832 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17833 router declines if presented with one of the listed addresses.
17834
17835 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17836 means of the first or the second of the following settings, respectively:
17837 .code
17838 ignore_target_hosts = 0.0.0.0/0
17839 ignore_target_hosts = <; 0::0/0
17840 .endd
17841 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17842 in the second line matches all IPv6 addresses.
17843
17844 This option may also be useful for ignoring link-local and site-local IPv6
17845 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17846 is expanded before use as a list, it is possible to make it dependent on the
17847 domain that is being routed.
17848
17849 .vindex "&$host_address$&"
17850 During its expansion, &$host_address$& is set to the IP address that is being
17851 checked.
17852
17853 .option initgroups routers boolean false
17854 .cindex "additional groups"
17855 .cindex "groups" "additional"
17856 .cindex "local transports" "uid and gid"
17857 .cindex "transport" "local"
17858 If the router queues an address for a transport, and this option is true, and
17859 the uid supplied by the router is not overridden by the transport, the
17860 &[initgroups()]& function is called when running the transport to ensure that
17861 any additional groups associated with the uid are set up. See also &%group%&
17862 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17863
17864
17865
17866 .option local_part_prefix routers&!? "string list" unset
17867 .cindex "router" "prefix for local part"
17868 .cindex "prefix" "for local part, used in router"
17869 If this option is set, the router is skipped unless the local part starts with
17870 one of the given strings, or &%local_part_prefix_optional%& is true. See
17871 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17872 evaluated.
17873
17874 The list is scanned from left to right, and the first prefix that matches is
17875 used. A limited form of wildcard is available; if the prefix begins with an
17876 asterisk, it matches the longest possible sequence of arbitrary characters at
17877 the start of the local part. An asterisk should therefore always be followed by
17878 some character that does not occur in normal local parts.
17879 .cindex "multiple mailboxes"
17880 .cindex "mailbox" "multiple"
17881 Wildcarding can be used to set up multiple user mailboxes, as described in
17882 section &<<SECTmulbox>>&.
17883
17884 .vindex "&$local_part$&"
17885 .vindex "&$local_part_prefix$&"
17886 During the testing of the &%local_parts%& option, and while the router is
17887 running, the prefix is removed from the local part, and is available in the
17888 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17889 the router accepts the address, this remains true during subsequent delivery by
17890 a transport. In particular, the local part that is transmitted in the RCPT
17891 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17892 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17893 the relevant transport.
17894
17895 When an address is being verified, &%local_part_prefix%& affects only the
17896 behaviour of the router. If the callout feature of verification is in use, this
17897 means that the full address, including the prefix, will be used during the
17898 callout.
17899
17900 The prefix facility is commonly used to handle local parts of the form
17901 &%owner-something%&. Another common use is to support local parts of the form
17902 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17903 to tell a user their forwarding is broken &-- by placing a router like this one
17904 immediately before the router that handles &_.forward_& files:
17905 .code
17906 real_localuser:
17907   driver = accept
17908   local_part_prefix = real-
17909   check_local_user
17910   transport = local_delivery
17911 .endd
17912 For security, it would probably be a good idea to restrict the use of this
17913 router to locally-generated messages, using a condition such as this:
17914 .code
17915   condition = ${if match {$sender_host_address}\
17916                          {\N^(|127\.0\.0\.1)$\N}}
17917 .endd
17918
17919 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17920 both conditions must be met if not optional. Care must be taken if wildcards
17921 are used in both a prefix and a suffix on the same router. Different
17922 separator characters must be used to avoid ambiguity.
17923
17924
17925 .option local_part_prefix_optional routers boolean false
17926 See &%local_part_prefix%& above.
17927
17928
17929
17930 .option local_part_suffix routers&!? "string list" unset
17931 .cindex "router" "suffix for local part"
17932 .cindex "suffix for local part" "used in router"
17933 This option operates in the same way as &%local_part_prefix%&, except that the
17934 local part must end (rather than start) with the given string, the
17935 &%local_part_suffix_optional%& option determines whether the suffix is
17936 mandatory, and the wildcard * character, if present, must be the last
17937 character of the suffix. This option facility is commonly used to handle local
17938 parts of the form &%something-request%& and multiple user mailboxes of the form
17939 &%username-foo%&.
17940
17941
17942 .option local_part_suffix_optional routers boolean false
17943 See &%local_part_suffix%& above.
17944
17945
17946
17947 .option local_parts routers&!? "local part list&!!" unset
17948 .cindex "router" "restricting to specific local parts"
17949 .cindex "local part" "checking in router"
17950 The router is run only if the local part of the address matches the list.
17951 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17952 are evaluated, and
17953 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17954 string is expanded, it is possible to make it depend on the domain, for
17955 example:
17956 .code
17957 local_parts = dbm;/usr/local/specials/$domain
17958 .endd
17959 .vindex "&$local_part_data$&"
17960 If the match is achieved by a lookup, the data that the lookup returned
17961 for the local part is placed in the variable &$local_part_data$& for use in
17962 expansions of the router's private options. You might use this option, for
17963 example, if you have a large number of local virtual domains, and you want to
17964 send all postmaster mail to the same place without having to set up an alias in
17965 each virtual domain:
17966 .code
17967 postmaster:
17968   driver = redirect
17969   local_parts = postmaster
17970   data = postmaster@real.domain.example
17971 .endd
17972
17973
17974 .option log_as_local routers boolean "see below"
17975 .cindex "log" "delivery line"
17976 .cindex "delivery" "log line format"
17977 Exim has two logging styles for delivery, the idea being to make local
17978 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17979 recipient address is given just as the local part, without a domain. The use of
17980 this style is controlled by this option. It defaults to true for the &(accept)&
17981 router, and false for all the others. This option applies only when a
17982 router assigns an address to a transport. It has no effect on routers that
17983 redirect addresses.
17984
17985
17986
17987 .option more routers boolean&!! true
17988 The result of string expansion for this option must be a valid boolean value,
17989 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17990 result causes an error, and delivery is deferred. If the expansion is forced to
17991 fail, the default value for the option (true) is used. Other failures cause
17992 delivery to be deferred.
17993
17994 If this option is set false, and the router declines to handle the address, no
17995 further routers are tried, routing fails, and the address is bounced.
17996 .oindex "&%self%&"
17997 However, if the router explicitly passes an address to the following router by
17998 means of the setting
17999 .code
18000 self = pass
18001 .endd
18002 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18003 does not affect the behaviour if one of the precondition tests fails. In that
18004 case, the address is always passed to the next router.
18005
18006 Note that &%address_data%& is not considered to be a precondition. If its
18007 expansion is forced to fail, the router declines, and the value of &%more%&
18008 controls what happens next.
18009
18010
18011 .option pass_on_timeout routers boolean false
18012 .cindex "timeout" "of router"
18013 .cindex "router" "timeout"
18014 If a router times out during a host lookup, it normally causes deferral of the
18015 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18016 router, overriding &%no_more%&. This may be helpful for systems that are
18017 intermittently connected to the Internet, or those that want to pass to a smart
18018 host any messages that cannot immediately be delivered.
18019
18020 There are occasional other temporary errors that can occur while doing DNS
18021 lookups. They are treated in the same way as a timeout, and this option
18022 applies to all of them.
18023
18024
18025
18026 .option pass_router routers string unset
18027 .cindex "router" "go to after &""pass""&"
18028 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18029 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18030 routing to continue, and overriding a false setting of &%more%&. When one of
18031 these routers returns &"pass"&, the address is normally handed on to the next
18032 router in sequence. This can be changed by setting &%pass_router%& to the name
18033 of another router. However (unlike &%redirect_router%&) the named router must
18034 be below the current router, to avoid loops. Note that this option applies only
18035 to the special case of &"pass"&. It does not apply when a router returns
18036 &"decline"& because it cannot handle an address.
18037
18038
18039
18040 .option redirect_router routers string unset
18041 .cindex "router" "start at after redirection"
18042 Sometimes an administrator knows that it is pointless to reprocess addresses
18043 generated from alias or forward files with the same router again. For
18044 example, if an alias file translates real names into login ids there is no
18045 point searching the alias file a second time, especially if it is a large file.
18046
18047 The &%redirect_router%& option can be set to the name of any router instance.
18048 It causes the routing of any generated addresses to start at the named router
18049 instead of at the first router. This option has no effect if the router in
18050 which it is set does not generate new addresses.
18051
18052
18053
18054 .option require_files routers&!? "string list&!!" unset
18055 .cindex "file" "requiring for router"
18056 .cindex "router" "requiring file existence"
18057 This option provides a general mechanism for predicating the running of a
18058 router on the existence or non-existence of certain files or directories.
18059 Before running a router, as one of its precondition tests, Exim works its way
18060 through the &%require_files%& list, expanding each item separately.
18061
18062 Because the list is split before expansion, any colons in expansion items must
18063 be doubled, or the facility for using a different list separator must be used.
18064 If any expansion is forced to fail, the item is ignored. Other expansion
18065 failures cause routing of the address to be deferred.
18066
18067 If any expanded string is empty, it is ignored. Otherwise, except as described
18068 below, each string must be a fully qualified file path, optionally preceded by
18069 &"!"&. The paths are passed to the &[stat()]& function to test for the
18070 existence of the files or directories. The router is skipped if any paths not
18071 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18072
18073 .cindex "NFS"
18074 If &[stat()]& cannot determine whether a file exists or not, delivery of
18075 the message is deferred. This can happen when NFS-mounted filesystems are
18076 unavailable.
18077
18078 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18079 options, so you cannot use it to check for the existence of a file in which to
18080 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18081 full list of the order in which preconditions are evaluated.) However, as
18082 these options are all expanded, you can use the &%exists%& expansion condition
18083 to make such tests. The &%require_files%& option is intended for checking files
18084 that the router may be going to use internally, or which are needed by a
18085 transport (for example &_.procmailrc_&).
18086
18087 During delivery, the &[stat()]& function is run as root, but there is a
18088 facility for some checking of the accessibility of a file by another user.
18089 This is not a proper permissions check, but just a &"rough"& check that
18090 operates as follows:
18091
18092 If an item in a &%require_files%& list does not contain any forward slash
18093 characters, it is taken to be the user (and optional group, separated by a
18094 comma) to be checked for subsequent files in the list. If no group is specified
18095 but the user is specified symbolically, the gid associated with the uid is
18096 used. For example:
18097 .code
18098 require_files = mail:/some/file
18099 require_files = $local_part:$home/.procmailrc
18100 .endd
18101 If a user or group name in a &%require_files%& list does not exist, the
18102 &%require_files%& condition fails.
18103
18104 Exim performs the check by scanning along the components of the file path, and
18105 checking the access for the given uid and gid. It checks for &"x"& access on
18106 directories, and &"r"& access on the final file. Note that this means that file
18107 access control lists, if the operating system has them, are ignored.
18108
18109 &*Warning 1*&: When the router is being run to verify addresses for an
18110 incoming SMTP message, Exim is not running as root, but under its own uid. This
18111 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18112 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18113 user is not permitted to read one of the directories on the file's path.
18114
18115 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18116 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18117 without root access. In this case, if a check for access by a particular user
18118 is requested, Exim creates a subprocess that runs as that user, and tries the
18119 check again in that process.
18120
18121 The default action for handling an unresolved EACCES is to consider it to
18122 be caused by a configuration error, and routing is deferred because the
18123 existence or non-existence of the file cannot be determined. However, in some
18124 circumstances it may be desirable to treat this condition as if the file did
18125 not exist. If the file name (or the exclamation mark that precedes the file
18126 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18127 as if the file did not exist. For example:
18128 .code
18129 require_files = +/some/file
18130 .endd
18131 If the router is not an essential part of verification (for example, it
18132 handles users' &_.forward_& files), another solution is to set the &%verify%&
18133 option false so that the router is skipped when verifying.
18134
18135
18136
18137 .option retry_use_local_part routers boolean "see below"
18138 .cindex "hints database" "retry keys"
18139 .cindex "local part" "in retry keys"
18140 When a delivery suffers a temporary routing failure, a retry record is created
18141 in Exim's hints database. For addresses whose routing depends only on the
18142 domain, the key for the retry record should not involve the local part, but for
18143 other addresses, both the domain and the local part should be included.
18144 Usually, remote routing is of the former kind, and local routing is of the
18145 latter kind.
18146
18147 This option controls whether the local part is used to form the key for retry
18148 hints for addresses that suffer temporary errors while being handled by this
18149 router. The default value is true for any router that has &%check_local_user%&
18150 set, and false otherwise. Note that this option does not apply to hints keys
18151 for transport delays; they are controlled by a generic transport option of the
18152 same name.
18153
18154 The setting of &%retry_use_local_part%& applies only to the router on which it
18155 appears. If the router generates child addresses, they are routed
18156 independently; this setting does not become attached to them.
18157
18158
18159
18160 .option router_home_directory routers string&!! unset
18161 .cindex "router" "home directory for"
18162 .cindex "home directory" "for router"
18163 .vindex "&$home$&"
18164 This option sets a home directory for use while the router is running. (Compare
18165 &%transport_home_directory%&, which sets a home directory for later
18166 transporting.) In particular, if used on a &(redirect)& router, this option
18167 sets a value for &$home$& while a filter is running. The value is expanded;
18168 forced expansion failure causes the option to be ignored &-- other failures
18169 cause the router to defer.
18170
18171 Expansion of &%router_home_directory%& happens immediately after the
18172 &%check_local_user%& test (if configured), before any further expansions take
18173 place.
18174 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18175 are evaluated.)
18176 While the router is running, &%router_home_directory%& overrides the value of
18177 &$home$& that came from &%check_local_user%&.
18178
18179 When a router accepts an address and assigns it to a local transport (including
18180 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18181 delivery), the home directory setting for the transport is taken from the first
18182 of these values that is set:
18183
18184 .ilist
18185 The &%home_directory%& option on the transport;
18186 .next
18187 The &%transport_home_directory%& option on the router;
18188 .next
18189 The password data if &%check_local_user%& is set on the router;
18190 .next
18191 The &%router_home_directory%& option on the router.
18192 .endlist
18193
18194 In other words, &%router_home_directory%& overrides the password data for the
18195 router, but not for the transport.
18196
18197
18198
18199 .option self routers string freeze
18200 .cindex "MX record" "pointing to local host"
18201 .cindex "local host" "MX pointing to"
18202 This option applies to those routers that use a recipient address to find a
18203 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18204 and &(manualroute)& routers.
18205 Certain configurations of the &(queryprogram)& router can also specify a list
18206 of remote hosts.
18207 Usually such routers are configured to send the message to a remote host via an
18208 &(smtp)& transport. The &%self%& option specifies what happens when the first
18209 host on the list turns out to be the local host.
18210 The way in which Exim checks for the local host is described in section
18211 &<<SECTreclocipadd>>&.
18212
18213 Normally this situation indicates either an error in Exim's configuration (for
18214 example, the router should be configured not to process this domain), or an
18215 error in the DNS (for example, the MX should not point to this host). For this
18216 reason, the default action is to log the incident, defer the address, and
18217 freeze the message. The following alternatives are provided for use in special
18218 cases:
18219
18220 .vlist
18221 .vitem &%defer%&
18222 Delivery of the message is tried again later, but the message is not frozen.
18223
18224 .vitem "&%reroute%&: <&'domain'&>"
18225 The domain is changed to the given domain, and the address is passed back to
18226 be reprocessed by the routers. No rewriting of headers takes place. This
18227 behaviour is essentially a redirection.
18228
18229 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18230 The domain is changed to the given domain, and the address is passed back to be
18231 reprocessed by the routers. Any headers that contain the original domain are
18232 rewritten.
18233
18234 .vitem &%pass%&
18235 .oindex "&%more%&"
18236 .vindex "&$self_hostname$&"
18237 The router passes the address to the next router, or to the router named in the
18238 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18239 subsequent routing and delivery, the variable &$self_hostname$& contains the
18240 name of the local host that the router encountered. This can be used to
18241 distinguish between different cases for hosts with multiple names. The
18242 combination
18243 .code
18244 self = pass
18245 no_more
18246 .endd
18247 ensures that only those addresses that routed to the local host are passed on.
18248 Without &%no_more%&, addresses that were declined for other reasons would also
18249 be passed to the next router.
18250
18251 .vitem &%fail%&
18252 Delivery fails and an error report is generated.
18253
18254 .vitem &%send%&
18255 .cindex "local host" "sending to"
18256 The anomaly is ignored and the address is queued for the transport. This
18257 setting should be used with extreme caution. For an &(smtp)& transport, it
18258 makes sense only in cases where the program that is listening on the SMTP port
18259 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18260 different configuration file that handles the domain in another way.
18261 .endlist
18262
18263
18264
18265 .option senders routers&!? "address list&!!" unset
18266 .cindex "router" "checking senders"
18267 If this option is set, the router is skipped unless the message's sender
18268 address matches something on the list.
18269 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18270 are evaluated.
18271
18272 There are issues concerning verification when the running of routers is
18273 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18274 setting, it sets the sender to the null string. When using the &%-bt%& option
18275 to check a configuration file, it is necessary also to use the &%-f%& option to
18276 set an appropriate sender. For incoming mail, the sender is unset when
18277 verifying the sender, but is available when verifying any recipients. If the
18278 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18279 matters.
18280
18281
18282 .option translate_ip_address routers string&!! unset
18283 .cindex "IP address" "translating"
18284 .cindex "packet radio"
18285 .cindex "router" "IP address translation"
18286 There exist some rare networking situations (for example, packet radio) where
18287 it is helpful to be able to translate IP addresses generated by normal routing
18288 mechanisms into other IP addresses, thus performing a kind of manual IP
18289 routing. This should be done only if the normal IP routing of the TCP/IP stack
18290 is inadequate or broken. Because this is an extremely uncommon requirement, the
18291 code to support this option is not included in the Exim binary unless
18292 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18293
18294 .vindex "&$host_address$&"
18295 The &%translate_ip_address%& string is expanded for every IP address generated
18296 by the router, with the generated address set in &$host_address$&. If the
18297 expansion is forced to fail, no action is taken.
18298 For any other expansion error, delivery of the message is deferred.
18299 If the result of the expansion is an IP address, that replaces the original
18300 address; otherwise the result is assumed to be a host name &-- this is looked
18301 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18302 produce one or more replacement IP addresses. For example, to subvert all IP
18303 addresses in some specific networks, this could be added to a router:
18304 .code
18305 translate_ip_address = \
18306   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18307     {$value}fail}}
18308 .endd
18309 The file would contain lines like
18310 .code
18311 10.2.3.128/26    some.host
18312 10.8.4.34/26     10.44.8.15
18313 .endd
18314 You should not make use of this facility unless you really understand what you
18315 are doing.
18316
18317
18318
18319 .option transport routers string&!! unset
18320 This option specifies the transport to be used when a router accepts an address
18321 and sets it up for delivery. A transport is never needed if a router is used
18322 only for verification. The value of the option is expanded at routing time,
18323 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18324 and result must be the name of one of the configured transports. If it is not,
18325 delivery is deferred.
18326
18327 The &%transport%& option is not used by the &(redirect)& router, but it does
18328 have some private options that set up transports for pipe and file deliveries
18329 (see chapter &<<CHAPredirect>>&).
18330
18331
18332
18333 .option transport_current_directory routers string&!! unset
18334 .cindex "current directory for local transport"
18335 This option associates a current directory with any address that is routed
18336 to a local transport. This can happen either because a transport is
18337 explicitly configured for the router, or because it generates a delivery to a
18338 file or a pipe. During the delivery process (that is, at transport time), this
18339 option string is expanded and is set as the current directory, unless
18340 overridden by a setting on the transport.
18341 If the expansion fails for any reason, including forced failure, an error is
18342 logged, and delivery is deferred.
18343 See chapter &<<CHAPenvironment>>& for details of the local delivery
18344 environment.
18345
18346
18347
18348
18349 .option transport_home_directory routers string&!! "see below"
18350 .cindex "home directory" "for local transport"
18351 This option associates a home directory with any address that is routed to a
18352 local transport. This can happen either because a transport is explicitly
18353 configured for the router, or because it generates a delivery to a file or a
18354 pipe. During the delivery process (that is, at transport time), the option
18355 string is expanded and is set as the home directory, unless overridden by a
18356 setting of &%home_directory%& on the transport.
18357 If the expansion fails for any reason, including forced failure, an error is
18358 logged, and delivery is deferred.
18359
18360 If the transport does not specify a home directory, and
18361 &%transport_home_directory%& is not set for the router, the home directory for
18362 the transport is taken from the password data if &%check_local_user%& is set for
18363 the router. Otherwise it is taken from &%router_home_directory%& if that option
18364 is set; if not, no home directory is set for the transport.
18365
18366 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18367 environment.
18368
18369
18370
18371
18372 .option unseen routers boolean&!! false
18373 .cindex "router" "carrying on after success"
18374 The result of string expansion for this option must be a valid boolean value,
18375 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18376 result causes an error, and delivery is deferred. If the expansion is forced to
18377 fail, the default value for the option (false) is used. Other failures cause
18378 delivery to be deferred.
18379
18380 When this option is set true, routing does not cease if the router accepts the
18381 address. Instead, a copy of the incoming address is passed to the next router,
18382 overriding a false setting of &%more%&. There is little point in setting
18383 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18384 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18385 sometimes true and sometimes false).
18386
18387 .cindex "copy of message (&%unseen%& option)"
18388 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18389 qualifier in filter files. It can be used to cause copies of messages to be
18390 delivered to some other destination, while also carrying out a normal delivery.
18391 In effect, the current address is made into a &"parent"& that has two children
18392 &-- one that is delivered as specified by this router, and a clone that goes on
18393 to be routed further. For this reason, &%unseen%& may not be combined with the
18394 &%one_time%& option in a &(redirect)& router.
18395
18396 &*Warning*&: Header lines added to the address (or specified for removal) by
18397 this router or by previous routers affect the &"unseen"& copy of the message
18398 only. The clone that continues to be processed by further routers starts with
18399 no added headers and none specified for removal. For a &%redirect%& router, if
18400 a generated address is the same as the incoming address, this can lead to
18401 duplicate addresses with different header modifications. Exim does not do
18402 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18403 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18404 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18405 &%redirect%& router may be of help.
18406
18407 Unlike the handling of header modifications, any data that was set by the
18408 &%address_data%& option in the current or previous routers &'is'& passed on to
18409 subsequent routers.
18410
18411
18412 .option user routers string&!! "see below"
18413 .cindex "uid (user id)" "local delivery"
18414 .cindex "local transports" "uid and gid"
18415 .cindex "transport" "local"
18416 .cindex "router" "user for filter processing"
18417 .cindex "filter" "user for processing"
18418 When a router queues an address for a transport, and the transport does not
18419 specify a user, the user given here is used when running the delivery process.
18420 The user may be specified numerically or by name. If expansion fails, the
18421 error is logged and delivery is deferred.
18422 This user is also used by the &(redirect)& router when running a filter file.
18423 The default is unset, except when &%check_local_user%& is set. In this case,
18424 the default is taken from the password information. If the user is specified as
18425 a name, and &%group%& is not set, the group associated with the user is used.
18426 See also &%initgroups%& and &%group%& and the discussion in chapter
18427 &<<CHAPenvironment>>&.
18428
18429
18430
18431 .option verify routers&!? boolean true
18432 Setting this option has the effect of setting &%verify_sender%& and
18433 &%verify_recipient%& to the same value.
18434
18435
18436 .option verify_only routers&!? boolean false
18437 .cindex "EXPN" "with &%verify_only%&"
18438 .oindex "&%-bv%&"
18439 .cindex "router" "used only when verifying"
18440 If this option is set, the router is used only when verifying an address,
18441 delivering in cutthrough mode or
18442 testing with the &%-bv%& option, not when actually doing a delivery, testing
18443 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18444 restricted to verifying only senders or recipients by means of
18445 &%verify_sender%& and &%verify_recipient%&.
18446
18447 &*Warning*&: When the router is being run to verify addresses for an incoming
18448 SMTP message, Exim is not running as root, but under its own uid. If the router
18449 accesses any files, you need to make sure that they are accessible to the Exim
18450 user or group.
18451
18452
18453 .option verify_recipient routers&!? boolean true
18454 If this option is false, the router is skipped when verifying recipient
18455 addresses,
18456 delivering in cutthrough mode
18457 or testing recipient verification using &%-bv%&.
18458 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18459 are evaluated.
18460 See also the &$verify_mode$& variable.
18461
18462
18463 .option verify_sender routers&!? boolean true
18464 If this option is false, the router is skipped when verifying sender addresses
18465 or testing sender verification using &%-bvs%&.
18466 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18467 are evaluated.
18468 See also the &$verify_mode$& variable.
18469 .ecindex IIDgenoprou1
18470 .ecindex IIDgenoprou2
18471
18472
18473
18474
18475
18476
18477 . ////////////////////////////////////////////////////////////////////////////
18478 . ////////////////////////////////////////////////////////////////////////////
18479
18480 .chapter "The accept router" "CHID4"
18481 .cindex "&(accept)& router"
18482 .cindex "routers" "&(accept)&"
18483 The &(accept)& router has no private options of its own. Unless it is being
18484 used purely for verification (see &%verify_only%&) a transport is required to
18485 be defined by the generic &%transport%& option. If the preconditions that are
18486 specified by generic options are met, the router accepts the address and queues
18487 it for the given transport. The most common use of this router is for setting
18488 up deliveries to local mailboxes. For example:
18489 .code
18490 localusers:
18491   driver = accept
18492   domains = mydomain.example
18493   check_local_user
18494   transport = local_delivery
18495 .endd
18496 The &%domains%& condition in this example checks the domain of the address, and
18497 &%check_local_user%& checks that the local part is the login of a local user.
18498 When both preconditions are met, the &(accept)& router runs, and queues the
18499 address for the &(local_delivery)& transport.
18500
18501
18502
18503
18504
18505
18506 . ////////////////////////////////////////////////////////////////////////////
18507 . ////////////////////////////////////////////////////////////////////////////
18508
18509 .chapter "The dnslookup router" "CHAPdnslookup"
18510 .scindex IIDdnsrou1 "&(dnslookup)& router"
18511 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18512 The &(dnslookup)& router looks up the hosts that handle mail for the
18513 recipient's domain in the DNS. A transport must always be set for this router,
18514 unless &%verify_only%& is set.
18515
18516 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18517 SRV records. If none are found, or if SRV support is not configured,
18518 MX records are looked up. If no MX records exist, address records are sought.
18519 However, &%mx_domains%& can be set to disable the direct use of address
18520 records.
18521
18522 MX records of equal priority are sorted by Exim into a random order. Exim then
18523 looks for address records for the host names obtained from MX or SRV records.
18524 When a host has more than one IP address, they are sorted into a random order,
18525 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18526 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18527 generic option, the router declines.
18528
18529 Unless they have the highest priority (lowest MX value), MX records that point
18530 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18531 are discarded, together with any other MX records of equal or lower priority.
18532
18533 .cindex "MX record" "pointing to local host"
18534 .cindex "local host" "MX pointing to"
18535 .oindex "&%self%&" "in &(dnslookup)& router"
18536 If the host pointed to by the highest priority MX record, or looked up as an
18537 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18538 happens is controlled by the generic &%self%& option.
18539
18540
18541 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18542 There have been problems with DNS servers when SRV records are looked up.
18543 Some misbehaving servers return a DNS error or timeout when a non-existent
18544 SRV record is sought. Similar problems have in the past been reported for
18545 MX records. The global &%dns_again_means_nonexist%& option can help with this
18546 problem, but it is heavy-handed because it is a global option.
18547
18548 For this reason, there are two options, &%srv_fail_domains%& and
18549 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18550 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18551 an attempt to look up an SRV or MX record causes one of these results, and the
18552 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18553 such record"&. In the case of an SRV lookup, this means that the router
18554 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18555 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18556 case routing fails.
18557
18558
18559 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18560 .cindex "&(dnslookup)& router" "declines"
18561 There are a few cases where a &(dnslookup)& router will decline to accept
18562 an address; if such a router is expected to handle "all remaining non-local
18563 domains", then it is important to set &%no_more%&.
18564
18565 The router will defer rather than decline if the domain
18566 is found in the &%fail_defer_domains%& router option.
18567
18568 Reasons for a &(dnslookup)& router to decline currently include:
18569 .ilist
18570 The domain does not exist in DNS
18571 .next
18572 The domain exists but the MX record's host part is just "."; this is a common
18573 convention (borrowed from SRV) used to indicate that there is no such service
18574 for this domain and to not fall back to trying A/AAAA records.
18575 .next
18576 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18577 .next
18578 MX record points to a non-existent host.
18579 .next
18580 MX record points to an IP address and the main section option
18581 &%allow_mx_to_ip%& is not set.
18582 .next
18583 MX records exist and point to valid hosts, but all hosts resolve only to
18584 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18585 .next
18586 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18587 &%dns_check_names_pattern%& for handling one variant of this)
18588 .next
18589 &%check_secondary_mx%& is set on this router but the local host can
18590 not be found in the MX records (see below)
18591 .endlist
18592
18593
18594
18595
18596 .section "Private options for dnslookup" "SECID118"
18597 .cindex "options" "&(dnslookup)& router"
18598 The private options for the &(dnslookup)& router are as follows:
18599
18600 .option check_secondary_mx dnslookup boolean false
18601 .cindex "MX record" "checking for secondary"
18602 If this option is set, the router declines unless the local host is found in
18603 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18604 process domains for which the local host is a secondary mail exchanger
18605 differently to other domains. The way in which Exim decides whether a host is
18606 the local host is described in section &<<SECTreclocipadd>>&.
18607
18608
18609 .option check_srv dnslookup string&!! unset
18610 .cindex "SRV record" "enabling use of"
18611 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18612 addition to MX and address records. The support is disabled by default. To
18613 enable SRV support, set the &%check_srv%& option to the name of the service
18614 required. For example,
18615 .code
18616 check_srv = smtp
18617 .endd
18618 looks for SRV records that refer to the normal smtp service. The option is
18619 expanded, so the service name can vary from message to message or address
18620 to address. This might be helpful if SRV records are being used for a
18621 submission service. If the expansion is forced to fail, the &%check_srv%&
18622 option is ignored, and the router proceeds to look for MX records in the
18623 normal way.
18624
18625 When the expansion succeeds, the router searches first for SRV records for
18626 the given service (it assumes TCP protocol). A single SRV record with a
18627 host name that consists of just a single dot indicates &"no such service for
18628 this domain"&; if this is encountered, the router declines. If other kinds of
18629 SRV record are found, they are used to construct a host list for delivery
18630 according to the rules of RFC 2782. MX records are not sought in this case.
18631
18632 When no SRV records are found, MX records (and address records) are sought in
18633 the traditional way. In other words, SRV records take precedence over MX
18634 records, just as MX records take precedence over address records. Note that
18635 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18636 defined it. It is apparently believed that MX records are sufficient for email
18637 and that SRV records should not be used for this purpose. However, SRV records
18638 have an additional &"weight"& feature which some people might find useful when
18639 trying to split an SMTP load between hosts of different power.
18640
18641 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18642 when there is a DNS lookup error.
18643
18644
18645
18646
18647 .option fail_defer_domains dnslookup "domain list&!!" unset
18648 .cindex "MX record" "not found"
18649 DNS lookups for domains matching &%fail_defer_domains%&
18650 which find no matching record will cause the router to defer
18651 rather than the default behaviour of decline.
18652 This maybe be useful for queueing messages for a newly created
18653 domain while the DNS configuration is not ready.
18654 However, it will result in any message with mistyped domains
18655 also being queued.
18656
18657
18658 .option mx_domains dnslookup "domain list&!!" unset
18659 .cindex "MX record" "required to exist"
18660 .cindex "SRV record" "required to exist"
18661 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18662 record in order to be recognized. (The name of this option could be improved.)
18663 For example, if all the mail hosts in &'fict.example'& are known to have MX
18664 records, except for those in &'discworld.fict.example'&, you could use this
18665 setting:
18666 .code
18667 mx_domains = ! *.discworld.fict.example : *.fict.example
18668 .endd
18669 This specifies that messages addressed to a domain that matches the list but
18670 has no MX record should be bounced immediately instead of being routed using
18671 the address record.
18672
18673
18674 .option mx_fail_domains dnslookup "domain list&!!" unset
18675 If the DNS lookup for MX records for one of the domains in this list causes a
18676 DNS lookup error, Exim behaves as if no MX records were found. See section
18677 &<<SECTprowitdnsloo>>& for more discussion.
18678
18679
18680
18681
18682 .option qualify_single dnslookup boolean true
18683 .cindex "DNS" "resolver options"
18684 .cindex "DNS" "qualifying single-component names"
18685 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18686 lookups. Typically, but not standardly, this causes the resolver to qualify
18687 single-component names with the default domain. For example, on a machine
18688 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18689 &'thesaurus.ref.example'& inside the resolver. For details of what your
18690 resolver actually does, consult your man pages for &'resolver'& and
18691 &'resolv.conf'&.
18692
18693
18694
18695 .option rewrite_headers dnslookup boolean true
18696 .cindex "rewriting" "header lines"
18697 .cindex "header lines" "rewriting"
18698 If the domain name in the address that is being processed is not fully
18699 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18700 an address is specified as &'dormouse@teaparty'&, the domain might be
18701 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18702 occur as a result of setting the &%widen_domains%& option. If
18703 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18704 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18705 header lines of the message are rewritten with the full domain name.
18706
18707 This option should be turned off only when it is known that no message is
18708 ever going to be sent outside an environment where the abbreviation makes
18709 sense.
18710
18711 When an MX record is looked up in the DNS and matches a wildcard record, name
18712 servers normally return a record containing the name that has been looked up,
18713 making it impossible to detect whether a wildcard was present or not. However,
18714 some name servers have recently been seen to return the wildcard entry. If the
18715 name returned by a DNS lookup begins with an asterisk, it is not used for
18716 header rewriting.
18717
18718
18719 .option same_domain_copy_routing dnslookup boolean false
18720 .cindex "address" "copying routing"
18721 Addresses with the same domain are normally routed by the &(dnslookup)& router
18722 to the same list of hosts. However, this cannot be presumed, because the router
18723 options and preconditions may refer to the local part of the address. By
18724 default, therefore, Exim routes each address in a message independently. DNS
18725 servers run caches, so repeated DNS lookups are not normally expensive, and in
18726 any case, personal messages rarely have more than a few recipients.
18727
18728 If you are running mailing lists with large numbers of subscribers at the same
18729 domain, and you are using a &(dnslookup)& router which is independent of the
18730 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18731 lookups for identical domains in one message. In this case, when &(dnslookup)&
18732 routes an address to a remote transport, any other unrouted addresses in the
18733 message that have the same domain are automatically given the same routing
18734 without processing them independently,
18735 provided the following conditions are met:
18736
18737 .ilist
18738 No router that processed the address specified &%headers_add%& or
18739 &%headers_remove%&.
18740 .next
18741 The router did not change the address in any way, for example, by &"widening"&
18742 the domain.
18743 .endlist
18744
18745
18746
18747
18748 .option search_parents dnslookup boolean false
18749 .cindex "DNS" "resolver options"
18750 When this option is true, the resolver option RES_DNSRCH is set for DNS
18751 lookups. This is different from the &%qualify_single%& option in that it
18752 applies to domains containing dots. Typically, but not standardly, it causes
18753 the resolver to search for the name in the current domain and in parent
18754 domains. For example, on a machine in the &'fict.example'& domain, if looking
18755 up &'teaparty.wonderland'& failed, the resolver would try
18756 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18757 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18758
18759 Setting this option true can cause problems in domains that have a wildcard MX
18760 record, because any domain that does not have its own MX record matches the
18761 local wildcard.
18762
18763
18764
18765 .option srv_fail_domains dnslookup "domain list&!!" unset
18766 If the DNS lookup for SRV records for one of the domains in this list causes a
18767 DNS lookup error, Exim behaves as if no SRV records were found. See section
18768 &<<SECTprowitdnsloo>>& for more discussion.
18769
18770
18771
18772
18773 .option widen_domains dnslookup "string list" unset
18774 .cindex "domain" "partial; widening"
18775 If a DNS lookup fails and this option is set, each of its strings in turn is
18776 added onto the end of the domain, and the lookup is tried again. For example,
18777 if
18778 .code
18779 widen_domains = fict.example:ref.example
18780 .endd
18781 is set and a lookup of &'klingon.dictionary'& fails,
18782 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18783 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18784 and &%search_parents%& options can cause some widening to be undertaken inside
18785 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18786 when verifying, unless &%rewrite_headers%& is false (not the default).
18787
18788
18789 .section "Effect of qualify_single and search_parents" "SECID119"
18790 When a domain from an envelope recipient is changed by the resolver as a result
18791 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18792 corresponding address in the message's header lines unless &%rewrite_headers%&
18793 is set false. Exim then re-routes the address, using the full domain.
18794
18795 These two options affect only the DNS lookup that takes place inside the router
18796 for the domain of the address that is being routed. They do not affect lookups
18797 such as that implied by
18798 .code
18799 domains = @mx_any
18800 .endd
18801 that may happen while processing a router precondition before the router is
18802 entered. No widening ever takes place for these lookups.
18803 .ecindex IIDdnsrou1
18804 .ecindex IIDdnsrou2
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814 . ////////////////////////////////////////////////////////////////////////////
18815 . ////////////////////////////////////////////////////////////////////////////
18816
18817 .chapter "The ipliteral router" "CHID5"
18818 .cindex "&(ipliteral)& router"
18819 .cindex "domain literal" "routing"
18820 .cindex "routers" "&(ipliteral)&"
18821 This router has no private options. Unless it is being used purely for
18822 verification (see &%verify_only%&) a transport is required to be defined by the
18823 generic &%transport%& option. The router accepts the address if its domain part
18824 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18825 router handles the address
18826 .code
18827 root@[192.168.1.1]
18828 .endd
18829 by setting up delivery to the host with that IP address. IPv4 domain literals
18830 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18831 are similar, but the address is preceded by &`ipv6:`&. For example:
18832 .code
18833 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18834 .endd
18835 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18836 grounds that sooner or later somebody will try it.
18837
18838 .oindex "&%self%&" "in &(ipliteral)& router"
18839 If the IP address matches something in &%ignore_target_hosts%&, the router
18840 declines. If an IP literal turns out to refer to the local host, the generic
18841 &%self%& option determines what happens.
18842
18843 The RFCs require support for domain literals; however, their use is
18844 controversial in today's Internet. If you want to use this router, you must
18845 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18846 Exim will not recognize the domain literal syntax in addresses.
18847
18848
18849
18850 . ////////////////////////////////////////////////////////////////////////////
18851 . ////////////////////////////////////////////////////////////////////////////
18852
18853 .chapter "The iplookup router" "CHID6"
18854 .cindex "&(iplookup)& router"
18855 .cindex "routers" "&(iplookup)&"
18856 The &(iplookup)& router was written to fulfil a specific requirement in
18857 Cambridge University (which in fact no longer exists). For this reason, it is
18858 not included in the binary of Exim by default. If you want to include it, you
18859 must set
18860 .code
18861 ROUTER_IPLOOKUP=yes
18862 .endd
18863 in your &_Local/Makefile_& configuration file.
18864
18865 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18866 connection to one or more specific hosts. The host can then return the same or
18867 a different address &-- in effect rewriting the recipient address in the
18868 message's envelope. The new address is then passed on to subsequent routers. If
18869 this process fails, the address can be passed on to other routers, or delivery
18870 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18871 must not be specified for it.
18872
18873 .cindex "options" "&(iplookup)& router"
18874 .option hosts iplookup string unset
18875 This option must be supplied. Its value is a colon-separated list of host
18876 names. The hosts are looked up using &[gethostbyname()]&
18877 (or &[getipnodebyname()]& when available)
18878 and are tried in order until one responds to the query. If none respond, what
18879 happens is controlled by &%optional%&.
18880
18881
18882 .option optional iplookup boolean false
18883 If &%optional%& is true, if no response is obtained from any host, the address
18884 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18885 delivery to the address is deferred.
18886
18887
18888 .option port iplookup integer 0
18889 .cindex "port" "&(iplookup)& router"
18890 This option must be supplied. It specifies the port number for the TCP or UDP
18891 call.
18892
18893
18894 .option protocol iplookup string udp
18895 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18896 protocols is to be used.
18897
18898
18899 .option query iplookup string&!! "see below"
18900 This defines the content of the query that is sent to the remote hosts. The
18901 default value is:
18902 .code
18903 $local_part@$domain $local_part@$domain
18904 .endd
18905 The repetition serves as a way of checking that a response is to the correct
18906 query in the default case (see &%response_pattern%& below).
18907
18908
18909 .option reroute iplookup string&!! unset
18910 If this option is not set, the rerouted address is precisely the byte string
18911 returned by the remote host, up to the first white space, if any. If set, the
18912 string is expanded to form the rerouted address. It can include parts matched
18913 in the response by &%response_pattern%& by means of numeric variables such as
18914 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18915 whether or not a pattern is in use. In all cases, the rerouted address must end
18916 up in the form &'local_part@domain'&.
18917
18918
18919 .option response_pattern iplookup string unset
18920 This option can be set to a regular expression that is applied to the string
18921 returned from the remote host. If the pattern does not match the response, the
18922 router declines. If &%response_pattern%& is not set, no checking of the
18923 response is done, unless the query was defaulted, in which case there is a
18924 check that the text returned after the first white space is the original
18925 address. This checks that the answer that has been received is in response to
18926 the correct question. For example, if the response is just a new domain, the
18927 following could be used:
18928 .code
18929 response_pattern = ^([^@]+)$
18930 reroute = $local_part@$1
18931 .endd
18932
18933 .option timeout iplookup time 5s
18934 This specifies the amount of time to wait for a response from the remote
18935 machine. The same timeout is used for the &[connect()]& function for a TCP
18936 call. It does not apply to UDP.
18937
18938
18939
18940
18941 . ////////////////////////////////////////////////////////////////////////////
18942 . ////////////////////////////////////////////////////////////////////////////
18943
18944 .chapter "The manualroute router" "CHID7"
18945 .scindex IIDmanrou1 "&(manualroute)& router"
18946 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18947 .cindex "domain" "manually routing"
18948 The &(manualroute)& router is so-called because it provides a way of manually
18949 routing an address according to its domain. It is mainly used when you want to
18950 route addresses to remote hosts according to your own rules, bypassing the
18951 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18952 route to local transports, a facility that may be useful if you want to save
18953 messages for dial-in hosts in local files.
18954
18955 The &(manualroute)& router compares a list of domain patterns with the domain
18956 it is trying to route. If there is no match, the router declines. Each pattern
18957 has associated with it a list of hosts and some other optional data, which may
18958 include a transport. The combination of a pattern and its data is called a
18959 &"routing rule"&. For patterns that do not have an associated transport, the
18960 generic &%transport%& option must specify a transport, unless the router is
18961 being used purely for verification (see &%verify_only%&).
18962
18963 .vindex "&$host$&"
18964 In the case of verification, matching the domain pattern is sufficient for the
18965 router to accept the address. When actually routing an address for delivery,
18966 an address that matches a domain pattern is queued for the associated
18967 transport. If the transport is not a local one, a host list must be associated
18968 with the pattern; IP addresses are looked up for the hosts, and these are
18969 passed to the transport along with the mail address. For local transports, a
18970 host list is optional. If it is present, it is passed in &$host$& as a single
18971 text string.
18972
18973 The list of routing rules can be provided as an inline string in
18974 &%route_list%&, or the data can be obtained by looking up the domain in a file
18975 or database by setting &%route_data%&. Only one of these settings may appear in
18976 any one instance of &(manualroute)&. The format of routing rules is described
18977 below, following the list of private options.
18978
18979
18980 .section "Private options for manualroute" "SECTprioptman"
18981
18982 .cindex "options" "&(manualroute)& router"
18983 The private options for the &(manualroute)& router are as follows:
18984
18985 .option host_all_ignored manualroute string defer
18986 See &%host_find_failed%&.
18987
18988 .option host_find_failed manualroute string freeze
18989 This option controls what happens when &(manualroute)& tries to find an IP
18990 address for a host, and the host does not exist. The option can be set to one
18991 of the following values:
18992 .code
18993 decline
18994 defer
18995 fail
18996 freeze
18997 ignore
18998 pass
18999 .endd
19000 The default (&"freeze"&) assumes that this state is a serious configuration
19001 error. The difference between &"pass"& and &"decline"& is that the former
19002 forces the address to be passed to the next router (or the router defined by
19003 &%pass_router%&),
19004 .oindex "&%more%&"
19005 overriding &%no_more%&, whereas the latter passes the address to the next
19006 router only if &%more%& is true.
19007
19008 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19009 cannot be found. If all the hosts in the list are ignored, the behaviour is
19010 controlled by the &%host_all_ignored%& option. This takes the same values
19011 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19012
19013 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19014 state; if a host lookup gets a temporary error, delivery is deferred unless the
19015 generic &%pass_on_timeout%& option is set.
19016
19017
19018 .option hosts_randomize manualroute boolean false
19019 .cindex "randomized host list"
19020 .cindex "host" "list of; randomized"
19021 If this option is set, the order of the items in a host list in a routing rule
19022 is randomized each time the list is used, unless an option in the routing rule
19023 overrides (see below). Randomizing the order of a host list can be used to do
19024 crude load sharing. However, if more than one mail address is routed by the
19025 same router to the same host list, the host lists are considered to be the same
19026 (even though they may be randomized into different orders) for the purpose of
19027 deciding whether to batch the deliveries into a single SMTP transaction.
19028
19029 When &%hosts_randomize%& is true, a host list may be split
19030 into groups whose order is separately randomized. This makes it possible to
19031 set up MX-like behaviour. The boundaries between groups are indicated by an
19032 item that is just &`+`& in the host list. For example:
19033 .code
19034 route_list = * host1:host2:host3:+:host4:host5
19035 .endd
19036 The order of the first three hosts and the order of the last two hosts is
19037 randomized for each use, but the first three always end up before the last two.
19038 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19039 randomized host list is passed to an &(smtp)& transport that also has
19040 &%hosts_randomize set%&, the list is not re-randomized.
19041
19042
19043 .option route_data manualroute string&!! unset
19044 If this option is set, it must expand to yield the data part of a routing rule.
19045 Typically, the expansion string includes a lookup based on the domain. For
19046 example:
19047 .code
19048 route_data = ${lookup{$domain}dbm{/etc/routes}}
19049 .endd
19050 If the expansion is forced to fail, or the result is an empty string, the
19051 router declines. Other kinds of expansion failure cause delivery to be
19052 deferred.
19053
19054
19055 .option route_list manualroute "string list" unset
19056 This string is a list of routing rules, in the form defined below. Note that,
19057 unlike most string lists, the items are separated by semicolons. This is so
19058 that they may contain colon-separated host lists.
19059
19060
19061 .option same_domain_copy_routing manualroute boolean false
19062 .cindex "address" "copying routing"
19063 Addresses with the same domain are normally routed by the &(manualroute)&
19064 router to the same list of hosts. However, this cannot be presumed, because the
19065 router options and preconditions may refer to the local part of the address. By
19066 default, therefore, Exim routes each address in a message independently. DNS
19067 servers run caches, so repeated DNS lookups are not normally expensive, and in
19068 any case, personal messages rarely have more than a few recipients.
19069
19070 If you are running mailing lists with large numbers of subscribers at the same
19071 domain, and you are using a &(manualroute)& router which is independent of the
19072 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19073 lookups for identical domains in one message. In this case, when
19074 &(manualroute)& routes an address to a remote transport, any other unrouted
19075 addresses in the message that have the same domain are automatically given the
19076 same routing without processing them independently. However, this is only done
19077 if &%headers_add%& and &%headers_remove%& are unset.
19078
19079
19080
19081
19082 .section "Routing rules in route_list" "SECID120"
19083 The value of &%route_list%& is a string consisting of a sequence of routing
19084 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19085 entered as two semicolons. Alternatively, the list separator can be changed as
19086 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19087 Empty rules are ignored. The format of each rule is
19088 .display
19089 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19090 .endd
19091 The following example contains two rules, each with a simple domain pattern and
19092 no options:
19093 .code
19094 route_list = \
19095   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19096   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19097 .endd
19098 The three parts of a rule are separated by white space. The pattern and the
19099 list of hosts can be enclosed in quotes if necessary, and if they are, the
19100 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19101 single domain pattern, which is the only mandatory item in the rule. The
19102 pattern is in the same format as one item in a domain list (see section
19103 &<<SECTdomainlist>>&),
19104 except that it may not be the name of an interpolated file.
19105 That is, it may be wildcarded, or a regular expression, or a file or database
19106 lookup (with semicolons doubled, because of the use of semicolon as a separator
19107 in a &%route_list%&).
19108
19109 The rules in &%route_list%& are searched in order until one of the patterns
19110 matches the domain that is being routed. The list of hosts and then options are
19111 then used as described below. If there is no match, the router declines. When
19112 &%route_list%& is set, &%route_data%& must not be set.
19113
19114
19115
19116 .section "Routing rules in route_data" "SECID121"
19117 The use of &%route_list%& is convenient when there are only a small number of
19118 routing rules. For larger numbers, it is easier to use a file or database to
19119 hold the routing information, and use the &%route_data%& option instead.
19120 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19121 Most commonly, &%route_data%& is set as a string that contains an
19122 expansion lookup. For example, suppose we place two routing rules in a file
19123 like this:
19124 .code
19125 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19126 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19127 .endd
19128 This data can be accessed by setting
19129 .code
19130 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19131 .endd
19132 Failure of the lookup results in an empty string, causing the router to
19133 decline. However, you do not have to use a lookup in &%route_data%&. The only
19134 requirement is that the result of expanding the string is a list of hosts,
19135 possibly followed by options, separated by white space. The list of hosts must
19136 be enclosed in quotes if it contains white space.
19137
19138
19139
19140
19141 .section "Format of the list of hosts" "SECID122"
19142 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19143 always separately expanded before use. If the expansion fails, the router
19144 declines. The result of the expansion must be a colon-separated list of names
19145 and/or IP addresses, optionally also including ports. The format of each item
19146 in the list is described in the next section. The list separator can be changed
19147 as described in section &<<SECTlistconstruct>>&.
19148
19149 If the list of hosts was obtained from a &%route_list%& item, the following
19150 variables are set during its expansion:
19151
19152 .ilist
19153 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19154 If the domain was matched against a regular expression, the numeric variables
19155 &$1$&, &$2$&, etc. may be set. For example:
19156 .code
19157 route_list = ^domain(\d+)   host-$1.text.example
19158 .endd
19159 .next
19160 &$0$& is always set to the entire domain.
19161 .next
19162 &$1$& is also set when partial matching is done in a file lookup.
19163
19164 .next
19165 .vindex "&$value$&"
19166 If the pattern that matched the domain was a lookup item, the data that was
19167 looked up is available in the expansion variable &$value$&. For example:
19168 .code
19169 route_list = lsearch;;/some/file.routes  $value
19170 .endd
19171 .endlist
19172
19173 Note the doubling of the semicolon in the pattern that is necessary because
19174 semicolon is the default route list separator.
19175
19176
19177
19178 .section "Format of one host item" "SECTformatonehostitem"
19179 Each item in the list of hosts is either a host name or an IP address,
19180 optionally with an attached port number. When no port is given, an IP address
19181 is not enclosed in brackets. When a port is specified, it overrides the port
19182 specification on the transport. The port is separated from the name or address
19183 by a colon. This leads to some complications:
19184
19185 .ilist
19186 Because colon is the default separator for the list of hosts, either
19187 the colon that specifies a port must be doubled, or the list separator must
19188 be changed. The following two examples have the same effect:
19189 .code
19190 route_list = * "host1.tld::1225 : host2.tld::1226"
19191 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19192 .endd
19193 .next
19194 When IPv6 addresses are involved, it gets worse, because they contain
19195 colons of their own. To make this case easier, it is permitted to
19196 enclose an IP address (either v4 or v6) in square brackets if a port
19197 number follows. For example:
19198 .code
19199 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19200 .endd
19201 .endlist
19202
19203 .section "How the list of hosts is used" "SECThostshowused"
19204 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19205 the hosts is tried, in the order specified, when carrying out the SMTP
19206 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19207 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19208 transport.
19209
19210 Hosts may be listed by name or by IP address. An unadorned name in the list of
19211 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19212 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19213 records in the DNS. For example:
19214 .code
19215 route_list = *  x.y.z:p.q.r/MX:e.f.g
19216 .endd
19217 If this feature is used with a port specifier, the port must come last. For
19218 example:
19219 .code
19220 route_list = *  dom1.tld/mx::1225
19221 .endd
19222 If the &%hosts_randomize%& option is set, the order of the items in the list is
19223 randomized before any lookups are done. Exim then scans the list; for any name
19224 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19225 be an interface on the local host and the item is not the first in the list,
19226 Exim discards it and any subsequent items. If it is the first item, what
19227 happens is controlled by the
19228 .oindex "&%self%&" "in &(manualroute)& router"
19229 &%self%& option of the router.
19230
19231 A name on the list that is followed by &`/MX`& is replaced with the list of
19232 hosts obtained by looking up MX records for the name. This is always a DNS
19233 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19234 below) are not relevant here. The order of these hosts is determined by the
19235 preference values in the MX records, according to the usual rules. Because
19236 randomizing happens before the MX lookup, it does not affect the order that is
19237 defined by MX preferences.
19238
19239 If the local host is present in the sublist obtained from MX records, but is
19240 not the most preferred host in that list, it and any equally or less
19241 preferred hosts are removed before the sublist is inserted into the main list.
19242
19243 If the local host is the most preferred host in the MX list, what happens
19244 depends on where in the original list of hosts the &`/MX`& item appears. If it
19245 is not the first item (that is, there are previous hosts in the main list),
19246 Exim discards this name and any subsequent items in the main list.
19247
19248 If the MX item is first in the list of hosts, and the local host is the
19249 most preferred host, what happens is controlled by the &%self%& option of the
19250 router.
19251
19252 DNS failures when lookup up the MX records are treated in the same way as DNS
19253 failures when looking up IP addresses: &%pass_on_timeout%& and
19254 &%host_find_failed%& are used when relevant.
19255
19256 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19257 whether obtained from an MX lookup or not.
19258
19259
19260
19261 .section "How the options are used" "SECThowoptused"
19262 The options are a sequence of words; in practice no more than three are ever
19263 present. One of the words can be the name of a transport; this overrides the
19264 &%transport%& option on the router for this particular routing rule only. The
19265 other words (if present) control randomization of the list of hosts on a
19266 per-rule basis, and how the IP addresses of the hosts are to be found when
19267 routing to a remote transport. These options are as follows:
19268
19269 .ilist
19270 &%randomize%&: randomize the order of the hosts in this list, overriding the
19271 setting of &%hosts_randomize%& for this routing rule only.
19272 .next
19273 &%no_randomize%&: do not randomize the order of the hosts in this list,
19274 overriding the setting of &%hosts_randomize%& for this routing rule only.
19275 .next
19276 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19277 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19278 also look in &_/etc/hosts_& or other sources of information.
19279 .next
19280 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19281 no address records are found. If there is a temporary DNS error (such as a
19282 timeout), delivery is deferred.
19283 .endlist
19284
19285 For example:
19286 .code
19287 route_list = domain1  host1:host2:host3  randomize bydns;\
19288              domain2  host4:host5
19289 .endd
19290 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19291 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19292 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19293 or &[gethostbyname()]&, and the result of the lookup is the result of that
19294 call.
19295
19296 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19297 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19298 instead of TRY_AGAIN. That is why the default action is to try a DNS
19299 lookup first. Only if that gives a definite &"no such host"& is the local
19300 function called.
19301
19302
19303
19304 If no IP address for a host can be found, what happens is controlled by the
19305 &%host_find_failed%& option.
19306
19307 .vindex "&$host$&"
19308 When an address is routed to a local transport, IP addresses are not looked up.
19309 The host list is passed to the transport in the &$host$& variable.
19310
19311
19312
19313 .section "Manualroute examples" "SECID123"
19314 In some of the examples that follow, the presence of the &%remote_smtp%&
19315 transport, as defined in the default configuration file, is assumed:
19316
19317 .ilist
19318 .cindex "smart host" "example router"
19319 The &(manualroute)& router can be used to forward all external mail to a
19320 &'smart host'&. If you have set up, in the main part of the configuration, a
19321 named domain list that contains your local domains, for example:
19322 .code
19323 domainlist local_domains = my.domain.example
19324 .endd
19325 You can arrange for all other domains to be routed to a smart host by making
19326 your first router something like this:
19327 .code
19328 smart_route:
19329   driver = manualroute
19330   domains = !+local_domains
19331   transport = remote_smtp
19332   route_list = * smarthost.ref.example
19333 .endd
19334 This causes all non-local addresses to be sent to the single host
19335 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19336 they are tried in order
19337 (but you can use &%hosts_randomize%& to vary the order each time).
19338 Another way of configuring the same thing is this:
19339 .code
19340 smart_route:
19341   driver = manualroute
19342   transport = remote_smtp
19343   route_list = !+local_domains  smarthost.ref.example
19344 .endd
19345 There is no difference in behaviour between these two routers as they stand.
19346 However, they behave differently if &%no_more%& is added to them. In the first
19347 example, the router is skipped if the domain does not match the &%domains%&
19348 precondition; the following router is always tried. If the router runs, it
19349 always matches the domain and so can never decline. Therefore, &%no_more%&
19350 would have no effect. In the second case, the router is never skipped; it
19351 always runs. However, if it doesn't match the domain, it declines. In this case
19352 &%no_more%& would prevent subsequent routers from running.
19353
19354 .next
19355 .cindex "mail hub example"
19356 A &'mail hub'& is a host which receives mail for a number of domains via MX
19357 records in the DNS and delivers it via its own private routing mechanism. Often
19358 the final destinations are behind a firewall, with the mail hub being the one
19359 machine that can connect to machines both inside and outside the firewall. The
19360 &(manualroute)& router is usually used on a mail hub to route incoming messages
19361 to the correct hosts. For a small number of domains, the routing can be inline,
19362 using the &%route_list%& option, but for a larger number a file or database
19363 lookup is easier to manage.
19364
19365 If the domain names are in fact the names of the machines to which the mail is
19366 to be sent by the mail hub, the configuration can be quite simple. For
19367 example:
19368 .code
19369 hub_route:
19370   driver = manualroute
19371   transport = remote_smtp
19372   route_list = *.rhodes.tvs.example  $domain
19373 .endd
19374 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19375 whose names are the same as the mail domains. A similar approach can be taken
19376 if the host name can be obtained from the domain name by a string manipulation
19377 that the expansion facilities can handle. Otherwise, a lookup based on the
19378 domain can be used to find the host:
19379 .code
19380 through_firewall:
19381   driver = manualroute
19382   transport = remote_smtp
19383   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19384 .endd
19385 The result of the lookup must be the name or IP address of the host (or
19386 hosts) to which the address is to be routed. If the lookup fails, the route
19387 data is empty, causing the router to decline. The address then passes to the
19388 next router.
19389
19390 .next
19391 .cindex "batched SMTP output example"
19392 .cindex "SMTP" "batched outgoing; example"
19393 You can use &(manualroute)& to deliver messages to pipes or files in batched
19394 SMTP format for onward transportation by some other means. This is one way of
19395 storing mail for a dial-up host when it is not connected. The route list entry
19396 can be as simple as a single domain name in a configuration like this:
19397 .code
19398 save_in_file:
19399   driver = manualroute
19400   transport = batchsmtp_appendfile
19401   route_list = saved.domain.example
19402 .endd
19403 though often a pattern is used to pick up more than one domain. If there are
19404 several domains or groups of domains with different transport requirements,
19405 different transports can be listed in the routing information:
19406 .code
19407 save_in_file:
19408   driver = manualroute
19409   route_list = \
19410     *.saved.domain1.example  $domain  batch_appendfile; \
19411     *.saved.domain2.example  \
19412       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19413       batch_pipe
19414 .endd
19415 .vindex "&$domain$&"
19416 .vindex "&$host$&"
19417 The first of these just passes the domain in the &$host$& variable, which
19418 doesn't achieve much (since it is also in &$domain$&), but the second does a
19419 file lookup to find a value to pass, causing the router to decline to handle
19420 the address if the lookup fails.
19421
19422 .next
19423 .cindex "UUCP" "example of router for"
19424 Routing mail directly to UUCP software is a specific case of the use of
19425 &(manualroute)& in a gateway to another mail environment. This is an example of
19426 one way it can be done:
19427 .code
19428 # Transport
19429 uucp:
19430   driver = pipe
19431   user = nobody
19432   command = /usr/local/bin/uux -r - \
19433     ${substr_-5:$host}!rmail ${local_part}
19434   return_fail_output = true
19435
19436 # Router
19437 uucphost:
19438   transport = uucp
19439   driver = manualroute
19440   route_data = \
19441     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19442 .endd
19443 The file &_/usr/local/exim/uucphosts_& contains entries like
19444 .code
19445 darksite.ethereal.example:           darksite.UUCP
19446 .endd
19447 It can be set up more simply without adding and removing &".UUCP"& but this way
19448 makes clear the distinction between the domain name
19449 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19450 .endlist
19451 .ecindex IIDmanrou1
19452 .ecindex IIDmanrou2
19453
19454
19455
19456
19457
19458
19459
19460
19461 . ////////////////////////////////////////////////////////////////////////////
19462 . ////////////////////////////////////////////////////////////////////////////
19463
19464 .chapter "The queryprogram router" "CHAPdriverlast"
19465 .scindex IIDquerou1 "&(queryprogram)& router"
19466 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19467 .cindex "routing" "by external program"
19468 The &(queryprogram)& router routes an address by running an external command
19469 and acting on its output. This is an expensive way to route, and is intended
19470 mainly for use in lightly-loaded systems, or for performing experiments.
19471 However, if it is possible to use the precondition options (&%domains%&,
19472 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19473 be used in special cases, even on a busy host. There are the following private
19474 options:
19475 .cindex "options" "&(queryprogram)& router"
19476
19477 .option command queryprogram string&!! unset
19478 This option must be set. It specifies the command that is to be run. The
19479 command is split up into a command name and arguments, and then each is
19480 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19481 &<<CHAPpipetransport>>&).
19482
19483
19484 .option command_group queryprogram string unset
19485 .cindex "gid (group id)" "in &(queryprogram)& router"
19486 This option specifies a gid to be set when running the command while routing an
19487 address for deliver. It must be set if &%command_user%& specifies a numerical
19488 uid. If it begins with a digit, it is interpreted as the numerical value of the
19489 gid. Otherwise it is looked up using &[getgrnam()]&.
19490
19491
19492 .option command_user queryprogram string unset
19493 .cindex "uid (user id)" "for &(queryprogram)&"
19494 This option must be set. It specifies the uid which is set when running the
19495 command while routing an address for delivery. If the value begins with a digit,
19496 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19497 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19498 not set, a value for the gid also.
19499
19500 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19501 root, which it does during a normal delivery in a conventional configuration.
19502 However, when an address is being verified during message reception, Exim is
19503 usually running as the Exim user, not as root. If the &(queryprogram)& router
19504 is called from a non-root process, Exim cannot change uid or gid before running
19505 the command. In this circumstance the command runs under the current uid and
19506 gid.
19507
19508
19509 .option current_directory queryprogram string /
19510 This option specifies an absolute path which is made the current directory
19511 before running the command.
19512
19513
19514 .option timeout queryprogram time 1h
19515 If the command does not complete within the timeout period, its process group
19516 is killed and the message is frozen. A value of zero time specifies no
19517 timeout.
19518
19519
19520 The standard output of the command is connected to a pipe, which is read when
19521 the command terminates. It should consist of a single line of output,
19522 containing up to five fields, separated by white space. The maximum length of
19523 the line is 1023 characters. Longer lines are silently truncated. The first
19524 field is one of the following words (case-insensitive):
19525
19526 .ilist
19527 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19528 below).
19529 .next
19530 &'Decline'&: the router declines; pass the address to the next router, unless
19531 &%no_more%& is set.
19532 .next
19533 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19534 subsequent text on the line is an error message. If the router is run as part
19535 of address verification during an incoming SMTP message, the message is
19536 included in the SMTP response.
19537 .next
19538 &'Defer'&: routing could not be completed at this time; try again later. Any
19539 subsequent text on the line is an error message which is logged. It is not
19540 included in any SMTP response.
19541 .next
19542 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19543 .next
19544 &'Pass'&: pass the address to the next router (or the router specified by
19545 &%pass_router%&), overriding &%no_more%&.
19546 .next
19547 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19548 new addresses, which are routed independently, starting with the first router,
19549 or the router specified by &%redirect_router%&, if set.
19550 .endlist
19551
19552 When the first word is &'accept'&, the remainder of the line consists of a
19553 number of keyed data values, as follows (split into two lines here, to fit on
19554 the page):
19555 .code
19556 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19557 LOOKUP=byname|bydns DATA=<text>
19558 .endd
19559 The data items can be given in any order, and all are optional. If no transport
19560 is included, the transport specified by the generic &%transport%& option is
19561 used. The list of hosts and the lookup type are needed only if the transport is
19562 an &(smtp)& transport that does not itself supply a list of hosts.
19563
19564 The format of the list of hosts is the same as for the &(manualroute)& router.
19565 As well as host names and IP addresses with optional port numbers, as described
19566 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19567 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19568 (see section &<<SECThostshowused>>&).
19569
19570 If the lookup type is not specified, Exim behaves as follows when trying to
19571 find an IP address for each host: First, a DNS lookup is done. If this yields
19572 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19573 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19574 result of the lookup is the result of that call.
19575
19576 .vindex "&$address_data$&"
19577 If the DATA field is set, its value is placed in the &$address_data$&
19578 variable. For example, this return line
19579 .code
19580 accept hosts=x1.y.example:x2.y.example data="rule1"
19581 .endd
19582 routes the address to the default transport, passing a list of two hosts. When
19583 the transport runs, the string &"rule1"& is in &$address_data$&.
19584 .ecindex IIDquerou1
19585 .ecindex IIDquerou2
19586
19587
19588
19589
19590 . ////////////////////////////////////////////////////////////////////////////
19591 . ////////////////////////////////////////////////////////////////////////////
19592
19593 .chapter "The redirect router" "CHAPredirect"
19594 .scindex IIDredrou1 "&(redirect)& router"
19595 .scindex IIDredrou2 "routers" "&(redirect)&"
19596 .cindex "alias file" "in a &(redirect)& router"
19597 .cindex "address redirection" "&(redirect)& router"
19598 The &(redirect)& router handles several kinds of address redirection. Its most
19599 common uses are for resolving local part aliases from a central alias file
19600 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19601 files, but it has many other potential uses. The incoming address can be
19602 redirected in several different ways:
19603
19604 .ilist
19605 It can be replaced by one or more new addresses which are themselves routed
19606 independently.
19607 .next
19608 It can be routed to be delivered to a given file or directory.
19609 .next
19610 It can be routed to be delivered to a specified pipe command.
19611 .next
19612 It can cause an automatic reply to be generated.
19613 .next
19614 It can be forced to fail, optionally with a custom error message.
19615 .next
19616 It can be temporarily deferred, optionally with a custom message.
19617 .next
19618 It can be discarded.
19619 .endlist
19620
19621 The generic &%transport%& option must not be set for &(redirect)& routers.
19622 However, there are some private options which define transports for delivery to
19623 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19624 &%pipe_transport%& and &%reply_transport%& descriptions below.
19625
19626 If success DSNs have been requested
19627 .cindex "DSN" "success"
19628 .cindex "Delivery Status Notification" "success"
19629 redirection triggers one and the DSN options are not passed any further.
19630
19631
19632
19633 .section "Redirection data" "SECID124"
19634 The router operates by interpreting a text string which it obtains either by
19635 expanding the contents of the &%data%& option, or by reading the entire
19636 contents of a file whose name is given in the &%file%& option. These two
19637 options are mutually exclusive. The first is commonly used for handling system
19638 aliases, in a configuration like this:
19639 .code
19640 system_aliases:
19641   driver = redirect
19642   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19643 .endd
19644 If the lookup fails, the expanded string in this example is empty. When the
19645 expansion of &%data%& results in an empty string, the router declines. A forced
19646 expansion failure also causes the router to decline; other expansion failures
19647 cause delivery to be deferred.
19648
19649 A configuration using &%file%& is commonly used for handling users'
19650 &_.forward_& files, like this:
19651 .code
19652 userforward:
19653   driver = redirect
19654   check_local_user
19655   file = $home/.forward
19656   no_verify
19657 .endd
19658 If the file does not exist, or causes no action to be taken (for example, it is
19659 empty or consists only of comments), the router declines. &*Warning*&: This
19660 is not the case when the file contains syntactically valid items that happen to
19661 yield empty addresses, for example, items containing only RFC 2822 address
19662 comments.
19663
19664
19665
19666 .section "Forward files and address verification" "SECID125"
19667 .cindex "address redirection" "while verifying"
19668 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19669 &_.forward_& files, as in the example above. There are two reasons for this:
19670
19671 .ilist
19672 When Exim is receiving an incoming SMTP message from a remote host, it is
19673 running under the Exim uid, not as root. Exim is unable to change uid to read
19674 the file as the user, and it may not be able to read it as the Exim user. So in
19675 practice the router may not be able to operate.
19676 .next
19677 However, even when the router can operate, the existence of a &_.forward_& file
19678 is unimportant when verifying an address. What should be checked is whether the
19679 local part is a valid user name or not. Cutting out the redirection processing
19680 saves some resources.
19681 .endlist
19682
19683
19684
19685
19686
19687
19688 .section "Interpreting redirection data" "SECID126"
19689 .cindex "Sieve filter" "specifying in redirection data"
19690 .cindex "filter" "specifying in redirection data"
19691 The contents of the data string, whether obtained from &%data%& or &%file%&,
19692 can be interpreted in two different ways:
19693
19694 .ilist
19695 If the &%allow_filter%& option is set true, and the data begins with the text
19696 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19697 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19698 respectively. Details of the syntax and semantics of filter files are described
19699 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19700 document is intended for use by end users.
19701 .next
19702 Otherwise, the data must be a comma-separated list of redirection items, as
19703 described in the next section.
19704 .endlist
19705
19706 When a message is redirected to a file (a &"mail folder"&), the file name given
19707 in a non-filter redirection list must always be an absolute path. A filter may
19708 generate a relative path &-- how this is handled depends on the transport's
19709 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19710 for the &(appendfile)& transport.
19711
19712
19713
19714 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19715 .cindex "address redirection" "non-filter list items"
19716 When the redirection data is not an Exim or Sieve filter, for example, if it
19717 comes from a conventional alias or forward file, it consists of a list of
19718 addresses, file names, pipe commands, or certain special items (see section
19719 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19720 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19721 depending on their default values. The items in the list are separated by
19722 commas or newlines.
19723 If a comma is required in an item, the entire item must be enclosed in double
19724 quotes.
19725
19726 Lines starting with a # character are comments, and are ignored, and # may
19727 also appear following a comma, in which case everything between the # and the
19728 next newline character is ignored.
19729
19730 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19731 double quotes are retained because some forms of mail address require their use
19732 (but never to enclose the entire address). In the following description,
19733 &"item"& refers to what remains after any surrounding double quotes have been
19734 removed.
19735
19736 .vindex "&$local_part$&"
19737 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19738 and the expansion contains a reference to &$local_part$&, you should make use
19739 of the &%quote_local_part%& expansion operator, in case the local part contains
19740 special characters. For example, to redirect all mail for the domain
19741 &'obsolete.example'&, retaining the existing local part, you could use this
19742 setting:
19743 .code
19744 data = ${quote_local_part:$local_part}@newdomain.example
19745 .endd
19746
19747
19748 .section "Redirecting to a local mailbox" "SECTredlocmai"
19749 .cindex "routing" "loops in"
19750 .cindex "loop" "while routing, avoidance of"
19751 .cindex "address redirection" "to local mailbox"
19752 A redirection item may safely be the same as the address currently under
19753 consideration. This does not cause a routing loop, because a router is
19754 automatically skipped if any ancestor of the address that is being processed
19755 is the same as the current address and was processed by the current router.
19756 Such an address is therefore passed to the following routers, so it is handled
19757 as if there were no redirection. When making this loop-avoidance test, the
19758 complete local part, including any prefix or suffix, is used.
19759
19760 .cindex "address redirection" "local part without domain"
19761 Specifying the same local part without a domain is a common usage in personal
19762 filter files when the user wants to have messages delivered to the local
19763 mailbox and also forwarded elsewhere. For example, the user whose login is
19764 &'cleo'& might have a &_.forward_& file containing this:
19765 .code
19766 cleo, cleopatra@egypt.example
19767 .endd
19768 .cindex "backslash in alias file"
19769 .cindex "alias file" "backslash in"
19770 For compatibility with other MTAs, such unqualified local parts may be
19771 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19772 it does make a difference if more than one domain is being handled
19773 synonymously.
19774
19775 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19776 2822 address that does not include a domain, the item is qualified using the
19777 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19778 addresses are qualified using the value in &%qualify_recipient%&, but you can
19779 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19780
19781 Care must be taken if there are alias names for local users.
19782 Consider an MTA handling a single local domain where the system alias file
19783 contains:
19784 .code
19785 Sam.Reman: spqr
19786 .endd
19787 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19788 messages in the local mailbox, and also forward copies elsewhere. He creates
19789 this forward file:
19790 .code
19791 Sam.Reman, spqr@reme.elsewhere.example
19792 .endd
19793 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19794 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19795 second time round, because it has previously routed it,
19796 and the following routers presumably cannot handle the alias. The forward file
19797 should really contain
19798 .code
19799 spqr, spqr@reme.elsewhere.example
19800 .endd
19801 but because this is such a common error, the &%check_ancestor%& option (see
19802 below) exists to provide a way to get round it. This is normally set on a
19803 &(redirect)& router that is handling users' &_.forward_& files.
19804
19805
19806
19807 .section "Special items in redirection lists" "SECTspecitredli"
19808 In addition to addresses, the following types of item may appear in redirection
19809 lists (that is, in non-filter redirection data):
19810
19811 .ilist
19812 .cindex "pipe" "in redirection list"
19813 .cindex "address redirection" "to pipe"
19814 An item is treated as a pipe command if it begins with &"|"& and does not parse
19815 as a valid RFC 2822 address that includes a domain. A transport for running the
19816 command must be specified by the &%pipe_transport%& option.
19817 Normally, either the router or the transport specifies a user and a group under
19818 which to run the delivery. The default is to use the Exim user and group.
19819
19820 Single or double quotes can be used for enclosing the individual arguments of
19821 the pipe command; no interpretation of escapes is done for single quotes. If
19822 the command contains a comma character, it is necessary to put the whole item
19823 in double quotes, for example:
19824 .code
19825 "|/some/command ready,steady,go"
19826 .endd
19827 since items in redirection lists are terminated by commas. Do not, however,
19828 quote just the command. An item such as
19829 .code
19830 |"/some/command ready,steady,go"
19831 .endd
19832 is interpreted as a pipe with a rather strange command name, and no arguments.
19833
19834 Note that the above example assumes that the text comes from a lookup source
19835 of some sort, so that the quotes are part of the data.  If composing a
19836 redirect router with a &%data%& option directly specifying this command, the
19837 quotes will be used by the configuration parser to define the extent of one
19838 string, but will not be passed down into the redirect router itself.  There
19839 are two main approaches to get around this: escape quotes to be part of the
19840 data itself, or avoid using this mechanism and instead create a custom
19841 transport with the &%command%& option set and reference that transport from
19842 an &%accept%& router.
19843
19844 .next
19845 .cindex "file" "in redirection list"
19846 .cindex "address redirection" "to file"
19847 An item is interpreted as a path name if it begins with &"/"& and does not
19848 parse as a valid RFC 2822 address that includes a domain. For example,
19849 .code
19850 /home/world/minbari
19851 .endd
19852 is treated as a file name, but
19853 .code
19854 /s=molari/o=babylon/@x400gate.way
19855 .endd
19856 is treated as an address. For a file name, a transport must be specified using
19857 the &%file_transport%& option. However, if the generated path name ends with a
19858 forward slash character, it is interpreted as a directory name rather than a
19859 file name, and &%directory_transport%& is used instead.
19860
19861 Normally, either the router or the transport specifies a user and a group under
19862 which to run the delivery. The default is to use the Exim user and group.
19863
19864 .cindex "&_/dev/null_&"
19865 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19866 bypassed at a high level, and the log entry shows &"**bypassed**"&
19867 instead of a transport name. In this case the user and group are not used.
19868
19869 .next
19870 .cindex "included address list"
19871 .cindex "address redirection" "included external list"
19872 If an item is of the form
19873 .code
19874 :include:<path name>
19875 .endd
19876 a list of further items is taken from the given file and included at that
19877 point. &*Note*&: Such a file can not be a filter file; it is just an
19878 out-of-line addition to the list. The items in the included list are separated
19879 by commas or newlines and are not subject to expansion. If this is the first
19880 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19881 the alias name. This example is incorrect:
19882 .code
19883 list1    :include:/opt/lists/list1
19884 .endd
19885 It must be given as
19886 .code
19887 list1:   :include:/opt/lists/list1
19888 .endd
19889 .next
19890 .cindex "address redirection" "to black hole"
19891 .cindex "delivery" "discard"
19892 .cindex "delivery" "blackhole"
19893 .cindex "black hole"
19894 .cindex "abandoning mail"
19895 Sometimes you want to throw away mail to a particular local part.  Making the
19896 &%data%& option expand to an empty string does not work, because that causes
19897 the router to decline. Instead, the alias item
19898 .code
19899 :blackhole:
19900 .endd
19901 can be used. It does what its name implies. No delivery is
19902 done, and no error message is generated. This has the same effect as specifying
19903 &_/dev/null_& as a destination, but it can be independently disabled.
19904
19905 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19906 delivery is done for the original local part, even if other redirection items
19907 are present. If you are generating a multi-item list (for example, by reading a
19908 database) and need the ability to provide a no-op item, you must use
19909 &_/dev/null_&.
19910
19911 .next
19912 .cindex "delivery" "forcing failure"
19913 .cindex "delivery" "forcing deferral"
19914 .cindex "failing delivery" "forcing"
19915 .cindex "deferred delivery, forcing"
19916 .cindex "customizing" "failure message"
19917 An attempt to deliver a particular address can be deferred or forced to fail by
19918 redirection items of the form
19919 .code
19920 :defer:
19921 :fail:
19922 .endd
19923 respectively. When a redirection list contains such an item, it applies
19924 to the entire redirection; any other items in the list are ignored. Any
19925 text following &':fail:'& or &':defer:'& is placed in the error text
19926 associated with the failure. For example, an alias file might contain:
19927 .code
19928 X.Employee:  :fail: Gone away, no forwarding address
19929 .endd
19930 In the case of an address that is being verified from an ACL or as the subject
19931 of a
19932 .cindex "VRFY" "error text, display of"
19933 VRFY command, the text is included in the SMTP error response by
19934 default.
19935 .cindex "EXPN" "error text, display of"
19936 The text is not included in the response to an EXPN command. In non-SMTP cases
19937 the text is included in the error message that Exim generates.
19938
19939 .cindex "SMTP" "error codes"
19940 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19941 &':fail:'&. However, if the message starts with three digits followed by a
19942 space, optionally followed by an extended code of the form &'n.n.n'&, also
19943 followed by a space, and the very first digit is the same as the default error
19944 code, the code from the message is used instead. If the very first digit is
19945 incorrect, a panic error is logged, and the default code is used. You can
19946 suppress the use of the supplied code in a redirect router by setting the
19947 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19948 ignored.
19949
19950 .vindex "&$acl_verify_message$&"
19951 In an ACL, an explicitly provided message overrides the default, but the
19952 default message is available in the variable &$acl_verify_message$& and can
19953 therefore be included in a custom message if this is desired.
19954
19955 Normally the error text is the rest of the redirection list &-- a comma does
19956 not terminate it &-- but a newline does act as a terminator. Newlines are not
19957 normally present in alias expansions. In &(lsearch)& lookups they are removed
19958 as part of the continuation process, but they may exist in other kinds of
19959 lookup and in &':include:'& files.
19960
19961 During routing for message delivery (as opposed to verification), a redirection
19962 containing &':fail:'& causes an immediate failure of the incoming address,
19963 whereas &':defer:'& causes the message to remain on the queue so that a
19964 subsequent delivery attempt can happen at a later time. If an address is
19965 deferred for too long, it will ultimately fail, because the normal retry
19966 rules still apply.
19967
19968 .next
19969 .cindex "alias file" "exception to default"
19970 Sometimes it is useful to use a single-key search type with a default (see
19971 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19972 for exceptions to the default. These can be handled by aliasing them to
19973 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19974 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19975 results in an empty redirection list has the same effect.
19976 .endlist
19977
19978
19979 .section "Duplicate addresses" "SECTdupaddr"
19980 .cindex "duplicate addresses"
19981 .cindex "address duplicate, discarding"
19982 .cindex "pipe" "duplicated"
19983 Exim removes duplicate addresses from the list to which it is delivering, so as
19984 to deliver just one copy to each address. This does not apply to deliveries
19985 routed to pipes by different immediate parent addresses, but an indirect
19986 aliasing scheme of the type
19987 .code
19988 pipe:       |/some/command $local_part
19989 localpart1: pipe
19990 localpart2: pipe
19991 .endd
19992 does not work with a message that is addressed to both local parts, because
19993 when the second is aliased to the intermediate local part &"pipe"& it gets
19994 discarded as being the same as a previously handled address. However, a scheme
19995 such as
19996 .code
19997 localpart1: |/some/command $local_part
19998 localpart2: |/some/command $local_part
19999 .endd
20000 does result in two different pipe deliveries, because the immediate parents of
20001 the pipes are distinct.
20002
20003
20004
20005 .section "Repeated redirection expansion" "SECID128"
20006 .cindex "repeated redirection expansion"
20007 .cindex "address redirection" "repeated for each delivery attempt"
20008 When a message cannot be delivered to all of its recipients immediately,
20009 leading to two or more delivery attempts, redirection expansion is carried out
20010 afresh each time for those addresses whose children were not all previously
20011 delivered. If redirection is being used as a mailing list, this can lead to new
20012 members of the list receiving copies of old messages. The &%one_time%& option
20013 can be used to avoid this.
20014
20015
20016 .section "Errors in redirection lists" "SECID129"
20017 .cindex "address redirection" "errors"
20018 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20019 error is skipped, and an entry is written to the main log. This may be useful
20020 for mailing lists that are automatically managed. Otherwise, if an error is
20021 detected while generating the list of new addresses, the original address is
20022 deferred. See also &%syntax_errors_to%&.
20023
20024
20025
20026 .section "Private options for the redirect router" "SECID130"
20027
20028 .cindex "options" "&(redirect)& router"
20029 The private options for the &(redirect)& router are as follows:
20030
20031
20032 .option allow_defer redirect boolean false
20033 Setting this option allows the use of &':defer:'& in non-filter redirection
20034 data, or the &%defer%& command in an Exim filter file.
20035
20036
20037 .option allow_fail redirect boolean false
20038 .cindex "failing delivery" "from filter"
20039 If this option is true, the &':fail:'& item can be used in a redirection list,
20040 and the &%fail%& command may be used in an Exim filter file.
20041
20042
20043 .option allow_filter redirect boolean false
20044 .cindex "filter" "enabling use of"
20045 .cindex "Sieve filter" "enabling use of"
20046 Setting this option allows Exim to interpret redirection data that starts with
20047 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20048 are some features of Exim filter files that some administrators may wish to
20049 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20050
20051 It is also possible to lock out Exim filters or Sieve filters while allowing
20052 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20053
20054
20055 The filter is run using the uid and gid set by the generic &%user%& and
20056 &%group%& options. These take their defaults from the password data if
20057 &%check_local_user%& is set, so in the normal case of users' personal filter
20058 files, the filter is run as the relevant user. When &%allow_filter%& is set
20059 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20060
20061
20062
20063 .option allow_freeze redirect boolean false
20064 .cindex "freezing messages" "allowing in filter"
20065 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20066 This command is more normally encountered in system filters, and is disabled by
20067 default for redirection filters because it isn't something you usually want to
20068 let ordinary users do.
20069
20070
20071
20072 .option check_ancestor redirect boolean false
20073 This option is concerned with handling generated addresses that are the same
20074 as some address in the list of redirection ancestors of the current address.
20075 Although it is turned off by default in the code, it is set in the default
20076 configuration file for handling users' &_.forward_& files. It is recommended
20077 for this use of the &(redirect)& router.
20078
20079 When &%check_ancestor%& is set, if a generated address (including the domain)
20080 is the same as any ancestor of the current address, it is replaced by a copy of
20081 the current address. This helps in the case where local part A is aliased to B,
20082 and B has a &_.forward_& file pointing back to A. For example, within a single
20083 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20084 &_&~jb/.forward_& contains:
20085 .code
20086 \Joe.Bloggs, <other item(s)>
20087 .endd
20088 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20089 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20090 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20091 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20092 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20093 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20094 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20095 original address. See also the &%repeat_use%& option below.
20096
20097
20098 .option check_group redirect boolean "see below"
20099 When the &%file%& option is used, the group owner of the file is checked only
20100 when this option is set. The permitted groups are those listed in the
20101 &%owngroups%& option, together with the user's default group if
20102 &%check_local_user%& is set. If the file has the wrong group, routing is
20103 deferred. The default setting for this option is true if &%check_local_user%&
20104 is set and the &%modemask%& option permits the group write bit, or if the
20105 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20106
20107
20108
20109 .option check_owner redirect boolean "see below"
20110 When the &%file%& option is used, the owner of the file is checked only when
20111 this option is set. If &%check_local_user%& is set, the local user is
20112 permitted; otherwise the owner must be one of those listed in the &%owners%&
20113 option. The default value for this option is true if &%check_local_user%& or
20114 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20115
20116
20117 .option data redirect string&!! unset
20118 This option is mutually exclusive with &%file%&. One or other of them must be
20119 set, but not both. The contents of &%data%& are expanded, and then used as the
20120 list of forwarding items, or as a set of filtering instructions. If the
20121 expansion is forced to fail, or the result is an empty string or a string that
20122 has no effect (consists entirely of comments), the router declines.
20123
20124 When filtering instructions are used, the string must begin with &"#Exim
20125 filter"&, and all comments in the string, including this initial one, must be
20126 terminated with newline characters. For example:
20127 .code
20128 data = #Exim filter\n\
20129        if $h_to: contains Exim then save $home/mail/exim endif
20130 .endd
20131 If you are reading the data from a database where newlines cannot be included,
20132 you can use the &${sg}$& expansion item to turn the escape string of your
20133 choice into a newline.
20134
20135
20136 .option directory_transport redirect string&!! unset
20137 A &(redirect)& router sets up a direct delivery to a directory when a path name
20138 ending with a slash is specified as a new &"address"&. The transport used is
20139 specified by this option, which, after expansion, must be the name of a
20140 configured transport. This should normally be an &(appendfile)& transport.
20141
20142
20143 .option file redirect string&!! unset
20144 This option specifies the name of a file that contains the redirection data. It
20145 is mutually exclusive with the &%data%& option. The string is expanded before
20146 use; if the expansion is forced to fail, the router declines. Other expansion
20147 failures cause delivery to be deferred. The result of a successful expansion
20148 must be an absolute path. The entire file is read and used as the redirection
20149 data. If the data is an empty string or a string that has no effect (consists
20150 entirely of comments), the router declines.
20151
20152 .cindex "NFS" "checking for file existence"
20153 If the attempt to open the file fails with a &"does not exist"& error, Exim
20154 runs a check on the containing directory,
20155 unless &%ignore_enotdir%& is true (see below).
20156 If the directory does not appear to exist, delivery is deferred. This can
20157 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20158 is a mount problem. If the containing directory does exist, but the file does
20159 not, the router declines.
20160
20161
20162 .option file_transport redirect string&!! unset
20163 .vindex "&$address_file$&"
20164 A &(redirect)& router sets up a direct delivery to a file when a path name not
20165 ending in a slash is specified as a new &"address"&. The transport used is
20166 specified by this option, which, after expansion, must be the name of a
20167 configured transport. This should normally be an &(appendfile)& transport. When
20168 it is running, the file name is in &$address_file$&.
20169
20170
20171 .option filter_prepend_home redirect boolean true
20172 When this option is true, if a &(save)& command in an Exim filter specifies a
20173 relative path, and &$home$& is defined, it is automatically prepended to the
20174 relative path. If this option is set false, this action does not happen. The
20175 relative path is then passed to the transport unmodified.
20176
20177
20178 .option forbid_blackhole redirect boolean false
20179 If this option is true, the &':blackhole:'& item may not appear in a
20180 redirection list.
20181
20182
20183 .option forbid_exim_filter redirect boolean false
20184 If this option is set true, only Sieve filters are permitted when
20185 &%allow_filter%& is true.
20186
20187
20188
20189
20190 .option forbid_file redirect boolean false
20191 .cindex "delivery" "to file; forbidding"
20192 .cindex "Sieve filter" "forbidding delivery to a file"
20193 .cindex "Sieve filter" "&""keep""& facility; disabling"
20194 If this option is true, this router may not generate a new address that
20195 specifies delivery to a local file or directory, either from a filter or from a
20196 conventional forward file. This option is forced to be true if &%one_time%& is
20197 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20198 locks out the Sieve's &"keep"& facility.
20199
20200
20201 .option forbid_filter_dlfunc redirect boolean false
20202 .cindex "filter" "locking out certain features"
20203 If this option is true, string expansions in Exim filters are not allowed to
20204 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20205 functions.
20206
20207 .option forbid_filter_existstest redirect boolean false
20208 .cindex "expansion" "statting a file"
20209 If this option is true, string expansions in Exim filters are not allowed to
20210 make use of the &%exists%& condition or the &%stat%& expansion item.
20211
20212 .option forbid_filter_logwrite redirect boolean false
20213 If this option is true, use of the logging facility in Exim filters is not
20214 permitted. Logging is in any case available only if the filter is being run
20215 under some unprivileged uid (which is normally the case for ordinary users'
20216 &_.forward_& files).
20217
20218
20219 .option forbid_filter_lookup redirect boolean false
20220 If this option is true, string expansions in Exim filter files are not allowed
20221 to make use of &%lookup%& items.
20222
20223
20224 .option forbid_filter_perl redirect boolean false
20225 This option has an effect only if Exim is built with embedded Perl support. If
20226 it is true, string expansions in Exim filter files are not allowed to make use
20227 of the embedded Perl support.
20228
20229
20230 .option forbid_filter_readfile redirect boolean false
20231 If this option is true, string expansions in Exim filter files are not allowed
20232 to make use of &%readfile%& items.
20233
20234
20235 .option forbid_filter_readsocket redirect boolean false
20236 If this option is true, string expansions in Exim filter files are not allowed
20237 to make use of &%readsocket%& items.
20238
20239
20240 .option forbid_filter_reply redirect boolean false
20241 If this option is true, this router may not generate an automatic reply
20242 message. Automatic replies can be generated only from Exim or Sieve filter
20243 files, not from traditional forward files. This option is forced to be true if
20244 &%one_time%& is set.
20245
20246
20247 .option forbid_filter_run redirect boolean false
20248 If this option is true, string expansions in Exim filter files are not allowed
20249 to make use of &%run%& items.
20250
20251
20252 .option forbid_include redirect boolean false
20253 If this option is true, items of the form
20254 .code
20255 :include:<path name>
20256 .endd
20257 are not permitted in non-filter redirection lists.
20258
20259
20260 .option forbid_pipe redirect boolean false
20261 .cindex "delivery" "to pipe; forbidding"
20262 If this option is true, this router may not generate a new address which
20263 specifies delivery to a pipe, either from an Exim filter or from a conventional
20264 forward file. This option is forced to be true if &%one_time%& is set.
20265
20266
20267 .option forbid_sieve_filter redirect boolean false
20268 If this option is set true, only Exim filters are permitted when
20269 &%allow_filter%& is true.
20270
20271
20272 .cindex "SMTP" "error codes"
20273 .option forbid_smtp_code redirect boolean false
20274 If this option is set true, any SMTP error codes that are present at the start
20275 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20276 the default codes (451 and 550, respectively) are always used.
20277
20278
20279
20280
20281 .option hide_child_in_errmsg redirect boolean false
20282 .cindex "bounce message" "redirection details; suppressing"
20283 If this option is true, it prevents Exim from quoting a child address if it
20284 generates a bounce or delay message for it. Instead it says &"an address
20285 generated from <&'the top level address'&>"&. Of course, this applies only to
20286 bounces generated locally. If a message is forwarded to another host, &'its'&
20287 bounce may well quote the generated address.
20288
20289
20290 .option ignore_eacces redirect boolean false
20291 .cindex "EACCES"
20292 If this option is set and an attempt to open a redirection file yields the
20293 EACCES error (permission denied), the &(redirect)& router behaves as if the
20294 file did not exist.
20295
20296
20297 .option ignore_enotdir redirect boolean false
20298 .cindex "ENOTDIR"
20299 If this option is set and an attempt to open a redirection file yields the
20300 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20301 router behaves as if the file did not exist.
20302
20303 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20304 router that has the &%file%& option set discovers that the file does not exist
20305 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20306 against unmounted NFS directories. If the parent can not be statted, delivery
20307 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20308 is set, because that option tells Exim to ignore &"something on the path is not
20309 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20310 that some operating systems give ENOENT where others give ENOTDIR.
20311
20312
20313
20314 .option include_directory redirect string unset
20315 If this option is set, the path names of any &':include:'& items in a
20316 redirection list must start with this directory.
20317
20318
20319 .option modemask redirect "octal integer" 022
20320 This specifies mode bits which must not be set for a file specified by the
20321 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20322
20323
20324 .option one_time redirect boolean false
20325 .cindex "one-time aliasing/forwarding expansion"
20326 .cindex "alias file" "one-time expansion"
20327 .cindex "forward file" "one-time expansion"
20328 .cindex "mailing lists" "one-time expansion"
20329 .cindex "address redirection" "one-time expansion"
20330 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20331 files each time it tries to deliver a message causes a problem when one or more
20332 of the generated addresses fails be delivered at the first attempt. The problem
20333 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20334 but of what happens when the redirection list changes during the time that the
20335 message is on Exim's queue. This is particularly true in the case of mailing
20336 lists, where new subscribers might receive copies of messages that were posted
20337 before they subscribed.
20338
20339 If &%one_time%& is set and any addresses generated by the router fail to
20340 deliver at the first attempt, the failing addresses are added to the message as
20341 &"top level"& addresses, and the parent address that generated them is marked
20342 &"delivered"&. Thus, redirection does not happen again at the next delivery
20343 attempt.
20344
20345 &*Warning 1*&: Any header line addition or removal that is specified by this
20346 router would be lost if delivery did not succeed at the first attempt. For this
20347 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20348 permitted when &%one_time%& is set.
20349
20350 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20351 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20352 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20353
20354 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20355 &%one_time%&.
20356
20357 The original top-level address is remembered with each of the generated
20358 addresses, and is output in any log messages. However, any intermediate parent
20359 addresses are not recorded. This makes a difference to the log only if
20360 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20361 typically be used for mailing lists, where there is normally just one level of
20362 expansion.
20363
20364
20365 .option owners redirect "string list" unset
20366 .cindex "ownership" "alias file"
20367 .cindex "ownership" "forward file"
20368 .cindex "alias file" "ownership"
20369 .cindex "forward file" "ownership"
20370 This specifies a list of permitted owners for the file specified by &%file%&.
20371 This list is in addition to the local user when &%check_local_user%& is set.
20372 See &%check_owner%& above.
20373
20374
20375 .option owngroups redirect "string list" unset
20376 This specifies a list of permitted groups for the file specified by &%file%&.
20377 The list is in addition to the local user's primary group when
20378 &%check_local_user%& is set. See &%check_group%& above.
20379
20380
20381 .option pipe_transport redirect string&!! unset
20382 .vindex "&$address_pipe$&"
20383 A &(redirect)& router sets up a direct delivery to a pipe when a string
20384 starting with a vertical bar character is specified as a new &"address"&. The
20385 transport used is specified by this option, which, after expansion, must be the
20386 name of a configured transport. This should normally be a &(pipe)& transport.
20387 When the transport is run, the pipe command is in &$address_pipe$&.
20388
20389
20390 .option qualify_domain redirect string&!! unset
20391 .vindex "&$qualify_recipient$&"
20392 If this option is set, and an unqualified address (one without a domain) is
20393 generated, and that address would normally be qualified by the global setting
20394 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20395 expanding this string. If the expansion fails, the router declines. If you want
20396 to revert to the default, you can have the expansion generate
20397 &$qualify_recipient$&.
20398
20399 This option applies to all unqualified addresses generated by Exim filters,
20400 but for traditional &_.forward_& files, it applies only to addresses that are
20401 not preceded by a backslash. Sieve filters cannot generate unqualified
20402 addresses.
20403
20404 .option qualify_preserve_domain redirect boolean false
20405 .cindex "domain" "in redirection; preserving"
20406 .cindex "preserving domain in redirection"
20407 .cindex "address redirection" "domain; preserving"
20408 If this option is set, the router's local &%qualify_domain%& option must not be
20409 set (a configuration error occurs if it is). If an unqualified address (one
20410 without a domain) is generated, it is qualified with the domain of the parent
20411 address (the immediately preceding ancestor) instead of the global
20412 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20413 this applies whether or not the address is preceded by a backslash.
20414
20415
20416 .option repeat_use redirect boolean true
20417 If this option is set false, the router is skipped for a child address that has
20418 any ancestor that was routed by this router. This test happens before any of
20419 the other preconditions are tested. Exim's default anti-looping rules skip
20420 only when the ancestor is the same as the current address. See also
20421 &%check_ancestor%& above and the generic &%redirect_router%& option.
20422
20423
20424 .option reply_transport redirect string&!! unset
20425 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20426 &%vacation%& command is used in a filter file. The transport used is specified
20427 by this option, which, after expansion, must be the name of a configured
20428 transport. This should normally be an &(autoreply)& transport. Other transports
20429 are unlikely to do anything sensible or useful.
20430
20431
20432 .option rewrite redirect boolean true
20433 .cindex "address redirection" "disabling rewriting"
20434 If this option is set false, addresses generated by the router are not
20435 subject to address rewriting. Otherwise, they are treated like new addresses
20436 and are rewritten according to the global rewriting rules.
20437
20438
20439 .option sieve_subaddress redirect string&!! unset
20440 The value of this option is passed to a Sieve filter to specify the
20441 :subaddress part of an address.
20442
20443 .option sieve_useraddress redirect string&!! unset
20444 The value of this option is passed to a Sieve filter to specify the :user part
20445 of an address. However, if it is unset, the entire original local part
20446 (including any prefix or suffix) is used for :user.
20447
20448
20449 .option sieve_vacation_directory redirect string&!! unset
20450 .cindex "Sieve filter" "vacation directory"
20451 To enable the &"vacation"& extension for Sieve filters, you must set
20452 &%sieve_vacation_directory%& to the directory where vacation databases are held
20453 (do not put anything else in that directory), and ensure that the
20454 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20455 needs their own directory; Exim will create it if necessary.
20456
20457
20458
20459 .option skip_syntax_errors redirect boolean false
20460 .cindex "forward file" "broken"
20461 .cindex "address redirection" "broken files"
20462 .cindex "alias file" "broken"
20463 .cindex "broken alias or forward files"
20464 .cindex "ignoring faulty addresses"
20465 .cindex "skipping faulty addresses"
20466 .cindex "error" "skipping bad syntax"
20467 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20468 non-filter redirection data are skipped, and each failing address is logged. If
20469 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20470 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20471 are expanded and placed at the head of the error message generated by
20472 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20473 be the same address as the generic &%errors_to%& option. The
20474 &%skip_syntax_errors%& option is often used when handling mailing lists.
20475
20476 If all the addresses in a redirection list are skipped because of syntax
20477 errors, the router declines to handle the original address, and it is passed to
20478 the following routers.
20479
20480 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20481 error in the filter causes filtering to be abandoned without any action being
20482 taken. The incident is logged, and the router declines to handle the address,
20483 so it is passed to the following routers.
20484
20485 .cindex "Sieve filter" "syntax errors in"
20486 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20487 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20488 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20489
20490 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20491 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20492 option, used with an address that does not get redirected, can be used to
20493 notify users of these errors, by means of a router like this:
20494 .code
20495 userforward:
20496   driver = redirect
20497   allow_filter
20498   check_local_user
20499   file = $home/.forward
20500   file_transport = address_file
20501   pipe_transport = address_pipe
20502   reply_transport = address_reply
20503   no_verify
20504   skip_syntax_errors
20505   syntax_errors_to = real-$local_part@$domain
20506   syntax_errors_text = \
20507    This is an automatically generated message. An error has\n\
20508    been found in your .forward file. Details of the error are\n\
20509    reported below. While this error persists, you will receive\n\
20510    a copy of this message for every message that is addressed\n\
20511    to you. If your .forward file is a filter file, or if it is\n\
20512    a non-filter file containing no valid forwarding addresses,\n\
20513    a copy of each incoming message will be put in your normal\n\
20514    mailbox. If a non-filter file contains at least one valid\n\
20515    forwarding address, forwarding to the valid addresses will\n\
20516    happen, and those will be the only deliveries that occur.
20517 .endd
20518 You also need a router to ensure that local addresses that are prefixed by
20519 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20520 put this immediately before the &(userforward)& router:
20521 .code
20522 real_localuser:
20523   driver = accept
20524   check_local_user
20525   local_part_prefix = real-
20526   transport = local_delivery
20527 .endd
20528 For security, it would probably be a good idea to restrict the use of this
20529 router to locally-generated messages, using a condition such as this:
20530 .code
20531   condition = ${if match {$sender_host_address}\
20532                          {\N^(|127\.0\.0\.1)$\N}}
20533 .endd
20534
20535
20536 .option syntax_errors_text redirect string&!! unset
20537 See &%skip_syntax_errors%& above.
20538
20539
20540 .option syntax_errors_to redirect string unset
20541 See &%skip_syntax_errors%& above.
20542 .ecindex IIDredrou1
20543 .ecindex IIDredrou2
20544
20545
20546
20547
20548
20549
20550 . ////////////////////////////////////////////////////////////////////////////
20551 . ////////////////////////////////////////////////////////////////////////////
20552
20553 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20554          "Environment for local transports"
20555 .scindex IIDenvlotra1 "local transports" "environment for"
20556 .scindex IIDenvlotra2 "environment" "local transports"
20557 .scindex IIDenvlotra3 "transport" "local; environment for"
20558 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20559 transport can be thought of as similar to a pipe.) Exim always runs transports
20560 in subprocesses, under specified uids and gids. Typical deliveries to local
20561 mailboxes run under the uid and gid of the local user.
20562
20563 Exim also sets a specific current directory while running the transport; for
20564 some transports a home directory setting is also relevant. The &(pipe)&
20565 transport is the only one that sets up environment variables; see section
20566 &<<SECTpipeenv>>& for details.
20567
20568 The values used for the uid, gid, and the directories may come from several
20569 different places. In many cases, the router that handles the address associates
20570 settings with that address as a result of its &%check_local_user%&, &%group%&,
20571 or &%user%& options. However, values may also be given in the transport's own
20572 configuration, and these override anything that comes from the router.
20573
20574
20575
20576 .section "Concurrent deliveries" "SECID131"
20577 .cindex "concurrent deliveries"
20578 .cindex "simultaneous deliveries"
20579 If two different messages for the same local recipient arrive more or less
20580 simultaneously, the two delivery processes are likely to run concurrently. When
20581 the &(appendfile)& transport is used to write to a file, Exim applies locking
20582 rules to stop concurrent processes from writing to the same file at the same
20583 time.
20584
20585 However, when you use a &(pipe)& transport, it is up to you to arrange any
20586 locking that is needed. Here is a silly example:
20587 .code
20588 my_transport:
20589   driver = pipe
20590   command = /bin/sh -c 'cat >>/some/file'
20591 .endd
20592 This is supposed to write the message at the end of the file. However, if two
20593 messages arrive at the same time, the file will be scrambled. You can use the
20594 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20595 file using the same algorithm that Exim itself uses.
20596
20597
20598
20599
20600 .section "Uids and gids" "SECTenvuidgid"
20601 .cindex "local transports" "uid and gid"
20602 .cindex "transport" "local; uid and gid"
20603 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20604 overrides any group that the router set in the address, even if &%user%& is not
20605 set for the transport. This makes it possible, for example, to run local mail
20606 delivery under the uid of the recipient (set by the router), but in a special
20607 group (set by the transport). For example:
20608 .code
20609 # Routers ...
20610 # User/group are set by check_local_user in this router
20611 local_users:
20612   driver = accept
20613   check_local_user
20614   transport = group_delivery
20615
20616 # Transports ...
20617 # This transport overrides the group
20618 group_delivery:
20619   driver = appendfile
20620   file = /var/spool/mail/$local_part
20621   group = mail
20622 .endd
20623 If &%user%& is set for a transport, its value overrides what is set in the
20624 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20625 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20626 set.
20627
20628 .oindex "&%initgroups%&"
20629 When the uid is taken from the transport's configuration, the &[initgroups()]&
20630 function is called for the groups associated with that uid if the
20631 &%initgroups%& option is set for the transport. When the uid is not specified
20632 by the transport, but is associated with the address by a router, the option
20633 for calling &[initgroups()]& is taken from the router configuration.
20634
20635 .cindex "&(pipe)& transport" "uid for"
20636 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20637 is set and &%user%& is not set, the uid of the process that called Exim to
20638 receive the message is used, and if &%group%& is not set, the corresponding
20639 original gid is also used.
20640
20641 This is the detailed preference order for obtaining a gid; the first of the
20642 following that is set is used:
20643
20644 .ilist
20645 A &%group%& setting of the transport;
20646 .next
20647 A &%group%& setting of the router;
20648 .next
20649 A gid associated with a user setting of the router, either as a result of
20650 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20651 .next
20652 The group associated with a non-numeric &%user%& setting of the transport;
20653 .next
20654 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20655 the uid is the creator's uid;
20656 .next
20657 The Exim gid if the Exim uid is being used as a default.
20658 .endlist
20659
20660 If, for example, the user is specified numerically on the router and there are
20661 no group settings, no gid is available. In this situation, an error occurs.
20662 This is different for the uid, for which there always is an ultimate default.
20663 The first of the following that is set is used:
20664
20665 .ilist
20666 A &%user%& setting of the transport;
20667 .next
20668 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20669 .next
20670 A &%user%& setting of the router;
20671 .next
20672 A &%check_local_user%& setting of the router;
20673 .next
20674 The Exim uid.
20675 .endlist
20676
20677 Of course, an error will still occur if the uid that is chosen is on the
20678 &%never_users%& list.
20679
20680
20681
20682
20683
20684 .section "Current and home directories" "SECID132"
20685 .cindex "current directory for local transport"
20686 .cindex "home directory" "for local transport"
20687 .cindex "transport" "local; home directory for"
20688 .cindex "transport" "local; current directory for"
20689 Routers may set current and home directories for local transports by means of
20690 the &%transport_current_directory%& and &%transport_home_directory%& options.
20691 However, if the transport's &%current_directory%& or &%home_directory%& options
20692 are set, they override the router's values. In detail, the home directory
20693 for a local transport is taken from the first of these values that is set:
20694
20695 .ilist
20696 The &%home_directory%& option on the transport;
20697 .next
20698 The &%transport_home_directory%& option on the router;
20699 .next
20700 The password data if &%check_local_user%& is set on the router;
20701 .next
20702 The &%router_home_directory%& option on the router.
20703 .endlist
20704
20705 The current directory is taken from the first of these values that is set:
20706
20707 .ilist
20708 The &%current_directory%& option on the transport;
20709 .next
20710 The &%transport_current_directory%& option on the router.
20711 .endlist
20712
20713
20714 If neither the router nor the transport sets a current directory, Exim uses the
20715 value of the home directory, if it is set. Otherwise it sets the current
20716 directory to &_/_& before running a local transport.
20717
20718
20719
20720 .section "Expansion variables derived from the address" "SECID133"
20721 .vindex "&$domain$&"
20722 .vindex "&$local_part$&"
20723 .vindex "&$original_domain$&"
20724 Normally a local delivery is handling a single address, and in that case the
20725 variables such as &$domain$& and &$local_part$& are set during local
20726 deliveries. However, in some circumstances more than one address may be handled
20727 at once (for example, while writing batch SMTP for onward transmission by some
20728 other means). In this case, the variables associated with the local part are
20729 never set, &$domain$& is set only if all the addresses have the same domain,
20730 and &$original_domain$& is never set.
20731 .ecindex IIDenvlotra1
20732 .ecindex IIDenvlotra2
20733 .ecindex IIDenvlotra3
20734
20735
20736
20737
20738
20739
20740
20741 . ////////////////////////////////////////////////////////////////////////////
20742 . ////////////////////////////////////////////////////////////////////////////
20743
20744 .chapter "Generic options for transports" "CHAPtransportgeneric"
20745 .scindex IIDgenoptra1 "generic options" "transport"
20746 .scindex IIDgenoptra2 "options" "generic; for transports"
20747 .scindex IIDgenoptra3 "transport" "generic options for"
20748 The following generic options apply to all transports:
20749
20750
20751 .option body_only transports boolean false
20752 .cindex "transport" "body only"
20753 .cindex "message" "transporting body only"
20754 .cindex "body of message" "transporting"
20755 If this option is set, the message's headers are not transported. It is
20756 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20757 or &(pipe)& transports, the settings of &%message_prefix%& and
20758 &%message_suffix%& should be checked, because this option does not
20759 automatically suppress them.
20760
20761
20762 .option current_directory transports string&!! unset
20763 .cindex "transport" "current directory for"
20764 This specifies the current directory that is to be set while running the
20765 transport, overriding any value that may have been set by the router.
20766 If the expansion fails for any reason, including forced failure, an error is
20767 logged, and delivery is deferred.
20768
20769
20770 .option disable_logging transports boolean false
20771 If this option is set true, nothing is logged for any
20772 deliveries by the transport or for any
20773 transport errors. You should not set this option unless you really, really know
20774 what you are doing.
20775
20776
20777 .option debug_print transports string&!! unset
20778 .cindex "testing" "variables in drivers"
20779 If this option is set and debugging is enabled (see the &%-d%& command line
20780 option), the string is expanded and included in the debugging output when the
20781 transport is run.
20782 If expansion of the string fails, the error message is written to the debugging
20783 output, and Exim carries on processing.
20784 This facility is provided to help with checking out the values of variables and
20785 so on when debugging driver configurations. For example, if a &%headers_add%&
20786 option is not working properly, &%debug_print%& could be used to output the
20787 variables it references. A newline is added to the text if it does not end with
20788 one.
20789 The variables &$transport_name$& and &$router_name$& contain the name of the
20790 transport and the router that called it.
20791
20792 .option delivery_date_add transports boolean false
20793 .cindex "&'Delivery-date:'& header line"
20794 If this option is true, a &'Delivery-date:'& header is added to the message.
20795 This gives the actual time the delivery was made. As this is not a standard
20796 header, Exim has a configuration option (&%delivery_date_remove%&) which
20797 requests its removal from incoming messages, so that delivered messages can
20798 safely be resent to other recipients.
20799
20800
20801 .option driver transports string unset
20802 This specifies which of the available transport drivers is to be used.
20803 There is no default, and this option must be set for every transport.
20804
20805
20806 .option envelope_to_add transports boolean false
20807 .cindex "&'Envelope-to:'& header line"
20808 If this option is true, an &'Envelope-to:'& header is added to the message.
20809 This gives the original address(es) in the incoming envelope that caused this
20810 delivery to happen. More than one address may be present if the transport is
20811 configured to handle several addresses at once, or if more than one original
20812 address was redirected to the same final address. As this is not a standard
20813 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20814 its removal from incoming messages, so that delivered messages can safely be
20815 resent to other recipients.
20816
20817
20818 .option event_action transports string&!! unset
20819 .cindex events
20820 This option declares a string to be expanded for Exim's events mechanism.
20821 For details see &<<CHAPevents>>&.
20822
20823
20824 .option group transports string&!! "Exim group"
20825 .cindex "transport" "group; specifying"
20826 This option specifies a gid for running the transport process, overriding any
20827 value that the router supplies, and also overriding any value associated with
20828 &%user%& (see below).
20829
20830
20831 .option headers_add transports list&!! unset
20832 .cindex "header lines" "adding in transport"
20833 .cindex "transport" "header lines; adding"
20834 This option specifies a list of text headers,
20835 newline-separated (by default, changeable in the usual way),
20836 which are (separately) expanded and added to the header
20837 portion of a message as it is transported, as described in section
20838 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20839 routers. If the result of the expansion is an empty string, or if the expansion
20840 is forced to fail, no action is taken. Other expansion failures are treated as
20841 errors and cause the delivery to be deferred.
20842
20843 Unlike most options, &%headers_add%& can be specified multiple times
20844 for a transport; all listed headers are added.
20845
20846
20847 .option headers_only transports boolean false
20848 .cindex "transport" "header lines only"
20849 .cindex "message" "transporting headers only"
20850 .cindex "header lines" "transporting"
20851 If this option is set, the message's body is not transported. It is mutually
20852 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20853 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20854 checked, since this option does not automatically suppress them.
20855
20856
20857 .option headers_remove transports list&!! unset
20858 .cindex "header lines" "removing"
20859 .cindex "transport" "header lines; removing"
20860 This option specifies a list of header names,
20861 colon-separated (by default, changeable in the usual way);
20862 these headers are omitted from the message as it is transported, as described
20863 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20864 routers.
20865 Each list item is separately expanded.
20866 If the result of the expansion is an empty string, or if the expansion
20867 is forced to fail, no action is taken. Other expansion failures are treated as
20868 errors and cause the delivery to be deferred.
20869
20870 Unlike most options, &%headers_remove%& can be specified multiple times
20871 for a transport; all listed headers are removed.
20872
20873 &*Warning*&: Because of the separate expansion of the list items,
20874 items that contain a list separator must have it doubled.
20875 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20876
20877
20878
20879 .option headers_rewrite transports string unset
20880 .cindex "transport" "header lines; rewriting"
20881 .cindex "rewriting" "at transport time"
20882 This option allows addresses in header lines to be rewritten at transport time,
20883 that is, as the message is being copied to its destination. The contents of the
20884 option are a colon-separated list of rewriting rules. Each rule is in exactly
20885 the same form as one of the general rewriting rules that are applied when a
20886 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20887 example,
20888 .code
20889 headers_rewrite = a@b c@d f : \
20890                   x@y w@z
20891 .endd
20892 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20893 &'w@z'& in all address-bearing header lines. The rules are applied to the
20894 header lines just before they are written out at transport time, so they affect
20895 only those copies of the message that pass through the transport. However, only
20896 the message's original header lines, and any that were added by a system
20897 filter, are rewritten. If a router or transport adds header lines, they are not
20898 affected by this option. These rewriting rules are &'not'& applied to the
20899 envelope. You can change the return path using &%return_path%&, but you cannot
20900 change envelope recipients at this time.
20901
20902
20903 .option home_directory transports string&!! unset
20904 .cindex "transport" "home directory for"
20905 .vindex "&$home$&"
20906 This option specifies a home directory setting for a local transport,
20907 overriding any value that may be set by the router. The home directory is
20908 placed in &$home$& while expanding the transport's private options. It is also
20909 used as the current directory if no current directory is set by the
20910 &%current_directory%& option on the transport or the
20911 &%transport_current_directory%& option on the router. If the expansion fails
20912 for any reason, including forced failure, an error is logged, and delivery is
20913 deferred.
20914
20915
20916 .option initgroups transports boolean false
20917 .cindex "additional groups"
20918 .cindex "groups" "additional"
20919 .cindex "transport" "group; additional"
20920 If this option is true and the uid for the delivery process is provided by the
20921 transport, the &[initgroups()]& function is called when running the transport
20922 to ensure that any additional groups associated with the uid are set up.
20923
20924
20925 .option max_parallel transports integer&!! unset
20926 .cindex limit "transport parallelism"
20927 .cindex transport "parallel processes"
20928 .cindex transport "concurrency limit"
20929 .cindex "delivery" "parallelism for transport"
20930 If this option is set and expands to an integer greater than zero
20931 it limits the number of concurrent runs of the transport.
20932 The control does not apply to shadow transports.
20933
20934 .cindex "hints database" "transport concurrency control"
20935 Exim implements this control by means of a hints database in which a record is
20936 incremented whenever a transport process is beaing created. The record
20937 is decremented and possibly removed when the process terminates.
20938 Obviously there is scope for
20939 records to get left lying around if there is a system or program crash. To
20940 guard against this, Exim ignores any records that are more than six hours old.
20941
20942 If you use this option, you should also arrange to delete the
20943 relevant hints database whenever your system reboots. The names of the files
20944 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20945 may be one or two files, depending on the type of DBM in use. The same files
20946 are used for ETRN and smtp transport serialization.
20947
20948
20949 .option message_size_limit transports string&!! 0
20950 .cindex "limit" "message size per transport"
20951 .cindex "size" "of message, limit"
20952 .cindex "transport" "message size; limiting"
20953 This option controls the size of messages passed through the transport. It is
20954 expanded before use; the result of the expansion must be a sequence of decimal
20955 digits, optionally followed by K or M. If the expansion fails for any reason,
20956 including forced failure, or if the result is not of the required form,
20957 delivery is deferred. If the value is greater than zero and the size of a
20958 message exceeds this limit, the address is failed. If there is any chance that
20959 the resulting bounce message could be routed to the same transport, you should
20960 ensure that &%return_size_limit%& is less than the transport's
20961 &%message_size_limit%&, as otherwise the bounce message will fail to get
20962 delivered.
20963
20964
20965
20966 .option rcpt_include_affixes transports boolean false
20967 .cindex "prefix" "for local part, including in envelope"
20968 .cindex "suffix for local part" "including in envelope"
20969 .cindex "local part" "prefix"
20970 .cindex "local part" "suffix"
20971 When this option is false (the default), and an address that has had any
20972 affixes (prefixes or suffixes) removed from the local part is delivered by any
20973 form of SMTP or LMTP, the affixes are not included. For example, if a router
20974 that contains
20975 .code
20976 local_part_prefix = *-
20977 .endd
20978 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20979 is delivered with
20980 .code
20981 RCPT TO:<xyz@some.domain>
20982 .endd
20983 This is also the case when an ACL-time callout is being used to verify a
20984 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20985 whole local part is included in the RCPT command. This option applies to BSMTP
20986 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20987 &(lmtp)& and &(smtp)& transports.
20988
20989
20990 .option retry_use_local_part transports boolean "see below"
20991 .cindex "hints database" "retry keys"
20992 When a delivery suffers a temporary failure, a retry record is created
20993 in Exim's hints database. For remote deliveries, the key for the retry record
20994 is based on the name and/or IP address of the failing remote host. For local
20995 deliveries, the key is normally the entire address, including both the local
20996 part and the domain. This is suitable for most common cases of local delivery
20997 temporary failure &-- for example, exceeding a mailbox quota should delay only
20998 deliveries to that mailbox, not to the whole domain.
20999
21000 However, in some special cases you may want to treat a temporary local delivery
21001 as a failure associated with the domain, and not with a particular local part.
21002 (For example, if you are storing all mail for some domain in files.) You can do
21003 this by setting &%retry_use_local_part%& false.
21004
21005 For all the local transports, its default value is true. For remote transports,
21006 the default value is false for tidiness, but changing the value has no effect
21007 on a remote transport in the current implementation.
21008
21009
21010 .option return_path transports string&!! unset
21011 .cindex "envelope sender"
21012 .cindex "transport" "return path; changing"
21013 .cindex "return path" "changing in transport"
21014 If this option is set, the string is expanded at transport time and replaces
21015 the existing return path (envelope sender) value in the copy of the message
21016 that is being delivered. An empty return path is permitted. This feature is
21017 designed for remote deliveries, where the value of this option is used in the
21018 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21019 only effect is to change the address that is placed in the &'Return-path:'&
21020 header line, if one is added to the message (see the next option).
21021
21022 &*Note:*& A changed return path is not logged unless you add
21023 &%return_path_on_delivery%& to the log selector.
21024
21025 .vindex "&$return_path$&"
21026 The expansion can refer to the existing value via &$return_path$&. This is
21027 either the message's envelope sender, or an address set by the
21028 &%errors_to%& option on a router. If the expansion is forced to fail, no
21029 replacement occurs; if it fails for another reason, delivery is deferred. This
21030 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21031 section &<<SECTverp>>&.
21032
21033 &*Note*&: If a delivery error is detected locally, including the case when a
21034 remote server rejects a message at SMTP time, the bounce message is not sent to
21035 the value of this option. It is sent to the previously set errors address.
21036 This defaults to the incoming sender address, but can be changed by setting
21037 &%errors_to%& in a router.
21038
21039
21040
21041 .option return_path_add transports boolean false
21042 .cindex "&'Return-path:'& header line"
21043 If this option is true, a &'Return-path:'& header is added to the message.
21044 Although the return path is normally available in the prefix line of BSD
21045 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21046 have easy access to it.
21047
21048 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21049 the delivery SMTP server makes the final delivery"&. This implies that this
21050 header should not be present in incoming messages. Exim has a configuration
21051 option, &%return_path_remove%&, which requests removal of this header from
21052 incoming messages, so that delivered messages can safely be resent to other
21053 recipients.
21054
21055
21056 .option shadow_condition transports string&!! unset
21057 See &%shadow_transport%& below.
21058
21059
21060 .option shadow_transport transports string unset
21061 .cindex "shadow transport"
21062 .cindex "transport" "shadow"
21063 A local transport may set the &%shadow_transport%& option to the name of
21064 another local transport. Shadow remote transports are not supported.
21065
21066 Whenever a delivery to the main transport succeeds, and either
21067 &%shadow_condition%& is unset, or its expansion does not result in the empty
21068 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21069 passed to the shadow transport, with the same delivery address or addresses. If
21070 expansion fails, no action is taken except that non-forced expansion failures
21071 cause a log line to be written.
21072
21073 The result of the shadow transport is discarded and does not affect the
21074 subsequent processing of the message. Only a single level of shadowing is
21075 provided; the &%shadow_transport%& option is ignored on any transport when it
21076 is running as a shadow. Options concerned with output from pipes are also
21077 ignored. The log line for the successful delivery has an item added on the end,
21078 of the form
21079 .code
21080 ST=<shadow transport name>
21081 .endd
21082 If the shadow transport did not succeed, the error message is put in
21083 parentheses afterwards. Shadow transports can be used for a number of different
21084 purposes, including keeping more detailed log information than Exim normally
21085 provides, and implementing automatic acknowledgment policies based on message
21086 headers that some sites insist on.
21087
21088
21089 .option transport_filter transports string&!! unset
21090 .cindex "transport" "filter"
21091 .cindex "filter" "transport filter"
21092 This option sets up a filtering (in the Unix shell sense) process for messages
21093 at transport time. It should not be confused with mail filtering as set up by
21094 individual users or via a system filter.
21095 If unset, or expanding to an empty string, no filtering is done.
21096
21097 When the message is about to be written out, the command specified by
21098 &%transport_filter%& is started up in a separate, parallel process, and
21099 the entire message, including the header lines, is passed to it on its standard
21100 input (this in fact is done from a third process, to avoid deadlock). The
21101 command must be specified as an absolute path.
21102
21103 The lines of the message that are written to the transport filter are
21104 terminated by newline (&"\n"&). The message is passed to the filter before any
21105 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21106 lines beginning with a dot, and also before any processing implied by the
21107 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21108 &(pipe)& transports.
21109
21110 The standard error for the filter process is set to the same destination as its
21111 standard output; this is read and written to the message's ultimate
21112 destination. The process that writes the message to the filter, the
21113 filter itself, and the original process that reads the result and delivers it
21114 are all run in parallel, like a shell pipeline.
21115
21116 The filter can perform any transformations it likes, but of course should take
21117 care not to break RFC 2822 syntax. Exim does not check the result, except to
21118 test for a final newline when SMTP is in use. All messages transmitted over
21119 SMTP must end with a newline, so Exim supplies one if it is missing.
21120
21121 .cindex "content scanning" "per user"
21122 A transport filter can be used to provide content-scanning on a per-user basis
21123 at delivery time if the only required effect of the scan is to modify the
21124 message. For example, a content scan could insert a new header line containing
21125 a spam score. This could be interpreted by a filter in the user's MUA. It is
21126 not possible to discard a message at this stage.
21127
21128 .cindex "SMTP" "SIZE"
21129 A problem might arise if the filter increases the size of a message that is
21130 being sent down an SMTP connection. If the receiving SMTP server has indicated
21131 support for the SIZE parameter, Exim will have sent the size of the message
21132 at the start of the SMTP session. If what is actually sent is substantially
21133 more, the server might reject the message. This can be worked round by setting
21134 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21135 additions to the message, or to disable the use of SIZE altogether.
21136
21137 .vindex "&$pipe_addresses$&"
21138 The value of the &%transport_filter%& option is the command string for starting
21139 the filter, which is run directly from Exim, not under a shell. The string is
21140 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21141 Exim breaks it up into arguments and then expands each argument separately (see
21142 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21143 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21144 of arguments, one for each address that applies to this delivery. (This isn't
21145 an ideal name for this feature here, but as it was already implemented for the
21146 &(pipe)& transport, it seemed sensible not to change it.)
21147
21148 .vindex "&$host$&"
21149 .vindex "&$host_address$&"
21150 The expansion variables &$host$& and &$host_address$& are available when the
21151 transport is a remote one. They contain the name and IP address of the host to
21152 which the message is being sent. For example:
21153 .code
21154 transport_filter = /some/directory/transport-filter.pl \
21155   $host $host_address $sender_address $pipe_addresses
21156 .endd
21157
21158 Two problems arise if you want to use more complicated expansion items to
21159 generate transport filter commands, both of which due to the fact that the
21160 command is split up &'before'& expansion.
21161 .ilist
21162 If an expansion item contains white space, you must quote it, so that it is all
21163 part of the same command item. If the entire option setting is one such
21164 expansion item, you have to take care what kind of quoting you use. For
21165 example:
21166 .code
21167 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21168 .endd
21169 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21170 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21171 stripped by Exim when it read the option's value. When the value is used, if
21172 the single quotes were missing, the line would be split into two items,
21173 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21174 Exim tried to expand the first one.
21175 .next
21176 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21177 expansion cannot generate multiple arguments, or a command name followed by
21178 arguments. Consider this example:
21179 .code
21180 transport_filter = ${lookup{$host}lsearch{/a/file}\
21181                     {$value}{/bin/cat}}
21182 .endd
21183 The result of the lookup is interpreted as the name of the command, even
21184 if it contains white space. The simplest way round this is to use a shell:
21185 .code
21186 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21187                                {$value}{/bin/cat}}
21188 .endd
21189 .endlist
21190
21191 The filter process is run under the same uid and gid as the normal delivery.
21192 For remote deliveries this is the Exim uid/gid by default. The command should
21193 normally yield a zero return code. Transport filters are not supposed to fail.
21194 A non-zero code is taken to mean that the transport filter encountered some
21195 serious problem. Delivery of the message is deferred; the message remains on
21196 the queue and is tried again later. It is not possible to cause a message to be
21197 bounced from a transport filter.
21198
21199 If a transport filter is set on an autoreply transport, the original message is
21200 passed through the filter as it is being copied into the newly generated
21201 message, which happens if the &%return_message%& option is set.
21202
21203
21204 .option transport_filter_timeout transports time 5m
21205 .cindex "transport" "filter, timeout"
21206 When Exim is reading the output of a transport filter, it applies a timeout
21207 that can be set by this option. Exceeding the timeout is normally treated as a
21208 temporary delivery failure. However, if a transport filter is used with a
21209 &(pipe)& transport, a timeout in the transport filter is treated in the same
21210 way as a timeout in the pipe command itself. By default, a timeout is a hard
21211 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21212 becomes a temporary error.
21213
21214
21215 .option user transports string&!! "Exim user"
21216 .cindex "uid (user id)" "local delivery"
21217 .cindex "transport" "user, specifying"
21218 This option specifies the user under whose uid the delivery process is to be
21219 run, overriding any uid that may have been set by the router. If the user is
21220 given as a name, the uid is looked up from the password data, and the
21221 associated group is taken as the value of the gid to be used if the &%group%&
21222 option is not set.
21223
21224 For deliveries that use local transports, a user and group are normally
21225 specified explicitly or implicitly (for example, as a result of
21226 &%check_local_user%&) by the router or transport.
21227
21228 .cindex "hints database" "access by remote transport"
21229 For remote transports, you should leave this option unset unless you really are
21230 sure you know what you are doing. When a remote transport is running, it needs
21231 to be able to access Exim's hints databases, because each host may have its own
21232 retry data.
21233 .ecindex IIDgenoptra1
21234 .ecindex IIDgenoptra2
21235 .ecindex IIDgenoptra3
21236
21237
21238
21239
21240
21241
21242 . ////////////////////////////////////////////////////////////////////////////
21243 . ////////////////////////////////////////////////////////////////////////////
21244
21245 .chapter "Address batching in local transports" "CHAPbatching" &&&
21246          "Address batching"
21247 .cindex "transport" "local; address batching in"
21248 The only remote transport (&(smtp)&) is normally configured to handle more than
21249 one address at a time, so that when several addresses are routed to the same
21250 remote host, just one copy of the message is sent. Local transports, however,
21251 normally handle one address at a time. That is, a separate instance of the
21252 transport is run for each address that is routed to the transport. A separate
21253 copy of the message is delivered each time.
21254
21255 .cindex "batched local delivery"
21256 .oindex "&%batch_max%&"
21257 .oindex "&%batch_id%&"
21258 In special cases, it may be desirable to handle several addresses at once in a
21259 local transport, for example:
21260
21261 .ilist
21262 In an &(appendfile)& transport, when storing messages in files for later
21263 delivery by some other means, a single copy of the message with multiple
21264 recipients saves space.
21265 .next
21266 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21267 a single copy saves time, and is the normal way LMTP is expected to work.
21268 .next
21269 In a &(pipe)& transport, when passing the message
21270 to a scanner program or
21271 to some other delivery mechanism such as UUCP, multiple recipients may be
21272 acceptable.
21273 .endlist
21274
21275 These three local transports all have the same options for controlling multiple
21276 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21277 repeating the information for each transport, these options are described here.
21278
21279 The &%batch_max%& option specifies the maximum number of addresses that can be
21280 delivered together in a single run of the transport. Its default value is one
21281 (no batching). When more than one address is routed to a transport that has a
21282 &%batch_max%& value greater than one, the addresses are delivered in a batch
21283 (that is, in a single run of the transport with multiple recipients), subject
21284 to certain conditions:
21285
21286 .ilist
21287 .vindex "&$local_part$&"
21288 If any of the transport's options contain a reference to &$local_part$&, no
21289 batching is possible.
21290 .next
21291 .vindex "&$domain$&"
21292 If any of the transport's options contain a reference to &$domain$&, only
21293 addresses with the same domain are batched.
21294 .next
21295 .cindex "customizing" "batching condition"
21296 If &%batch_id%& is set, it is expanded for each address, and only those
21297 addresses with the same expanded value are batched. This allows you to specify
21298 customized batching conditions. Failure of the expansion for any reason,
21299 including forced failure, disables batching, but it does not stop the delivery
21300 from taking place.
21301 .next
21302 Batched addresses must also have the same errors address (where to send
21303 delivery errors), the same header additions and removals, the same user and
21304 group for the transport, and if a host list is present, the first host must
21305 be the same.
21306 .endlist
21307
21308 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21309 both when the file or pipe command is specified in the transport, and when it
21310 is specified by a &(redirect)& router, but all the batched addresses must of
21311 course be routed to the same file or pipe command. These two transports have an
21312 option called &%use_bsmtp%&, which causes them to deliver the message in
21313 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21314 &%check_string%& and &%escape_string%& options are forced to the values
21315 .code
21316 check_string = "."
21317 escape_string = ".."
21318 .endd
21319 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21320 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21321 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21322
21323 .cindex "&'Envelope-to:'& header line"
21324 If the generic &%envelope_to_add%& option is set for a batching transport, the
21325 &'Envelope-to:'& header that is added to the message contains all the addresses
21326 that are being processed together. If you are using a batching &(appendfile)&
21327 transport without &%use_bsmtp%&, the only way to preserve the recipient
21328 addresses is to set the &%envelope_to_add%& option.
21329
21330 .cindex "&(pipe)& transport" "with multiple addresses"
21331 .vindex "&$pipe_addresses$&"
21332 If you are using a &(pipe)& transport without BSMTP, and setting the
21333 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21334 the command. This is not a true variable; it is a bit of magic that causes each
21335 of the recipient addresses to be inserted into the command as a separate
21336 argument. This provides a way of accessing all the addresses that are being
21337 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21338 are specified by a &(redirect)& router.
21339
21340
21341
21342
21343 . ////////////////////////////////////////////////////////////////////////////
21344 . ////////////////////////////////////////////////////////////////////////////
21345
21346 .chapter "The appendfile transport" "CHAPappendfile"
21347 .scindex IIDapptra1 "&(appendfile)& transport"
21348 .scindex IIDapptra2 "transports" "&(appendfile)&"
21349 .cindex "directory creation"
21350 .cindex "creating directories"
21351 The &(appendfile)& transport delivers a message by appending it to an existing
21352 file, or by creating an entirely new file in a specified directory. Single
21353 files to which messages are appended can be in the traditional Unix mailbox
21354 format, or optionally in the MBX format supported by the Pine MUA and
21355 University of Washington IMAP daemon, &'inter alia'&. When each message is
21356 being delivered as a separate file, &"maildir"& format can optionally be used
21357 to give added protection against failures that happen part-way through the
21358 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21359 supported. For all file formats, Exim attempts to create as many levels of
21360 directory as necessary, provided that &%create_directory%& is set.
21361
21362 The code for the optional formats is not included in the Exim binary by
21363 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21364 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21365 included.
21366
21367 .cindex "quota" "system"
21368 Exim recognizes system quota errors, and generates an appropriate message. Exim
21369 also supports its own quota control within the transport, for use when the
21370 system facility is unavailable or cannot be used for some reason.
21371
21372 If there is an error while appending to a file (for example, quota exceeded or
21373 partition filled), Exim attempts to reset the file's length and last
21374 modification time back to what they were before. If there is an error while
21375 creating an entirely new file, the new file is removed.
21376
21377 Before appending to a file, a number of security checks are made, and the
21378 file is locked. A detailed description is given below, after the list of
21379 private options.
21380
21381 The &(appendfile)& transport is most commonly used for local deliveries to
21382 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21383 putting messages into files for remote delivery by some means other than Exim.
21384 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21385 option).
21386
21387
21388
21389 .section "The file and directory options" "SECTfildiropt"
21390 The &%file%& option specifies a single file, to which the message is appended;
21391 the &%directory%& option specifies a directory, in which a new file containing
21392 the message is created. Only one of these two options can be set, and for
21393 normal deliveries to mailboxes, one of them &'must'& be set.
21394
21395 .vindex "&$address_file$&"
21396 .vindex "&$local_part$&"
21397 However, &(appendfile)& is also used for delivering messages to files or
21398 directories whose names (or parts of names) are obtained from alias,
21399 forwarding, or filtering operations (for example, a &%save%& command in a
21400 user's Exim filter). When such a transport is running, &$local_part$& contains
21401 the local part that was aliased or forwarded, and &$address_file$& contains the
21402 name (or partial name) of the file or directory generated by the redirection
21403 operation. There are two cases:
21404
21405 .ilist
21406 If neither &%file%& nor &%directory%& is set, the redirection operation
21407 must specify an absolute path (one that begins with &`/`&). This is the most
21408 common case when users with local accounts use filtering to sort mail into
21409 different folders. See for example, the &(address_file)& transport in the
21410 default configuration. If the path ends with a slash, it is assumed to be the
21411 name of a directory. A delivery to a directory can also be forced by setting
21412 &%maildir_format%& or &%mailstore_format%&.
21413 .next
21414 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21415 used to determine the file or directory name for the delivery. Normally, the
21416 contents of &$address_file$& are used in some way in the string expansion.
21417 .endlist
21418
21419
21420 .cindex "Sieve filter" "configuring &(appendfile)&"
21421 .cindex "Sieve filter" "relative mailbox path handling"
21422 As an example of the second case, consider an environment where users do not
21423 have home directories. They may be permitted to use Exim filter commands of the
21424 form:
21425 .code
21426 save folder23
21427 .endd
21428 or Sieve filter commands of the form:
21429 .code
21430 require "fileinto";
21431 fileinto "folder23";
21432 .endd
21433 In this situation, the expansion of &%file%& or &%directory%& in the transport
21434 must transform the relative path into an appropriate absolute file name. In the
21435 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21436 is used as a result of a &"keep"& action in the filter. This example shows one
21437 way of handling this requirement:
21438 .code
21439 file = ${if eq{$address_file}{inbox} \
21440             {/var/mail/$local_part} \
21441             {${if eq{${substr_0_1:$address_file}}{/} \
21442                   {$address_file} \
21443                   {$home/mail/$address_file} \
21444             }} \
21445        }
21446 .endd
21447 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21448 location, absolute paths are used without change, and other folders are in the
21449 &_mail_& directory within the home directory.
21450
21451 &*Note 1*&: While processing an Exim filter, a relative path such as
21452 &_folder23_& is turned into an absolute path if a home directory is known to
21453 the router. In particular, this is the case if &%check_local_user%& is set. If
21454 you want to prevent this happening at routing time, you can set
21455 &%router_home_directory%& empty. This forces the router to pass the relative
21456 path to the transport.
21457
21458 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21459 the &%file%& or &%directory%& option is still used if it is set.
21460
21461
21462
21463
21464 .section "Private options for appendfile" "SECID134"
21465 .cindex "options" "&(appendfile)& transport"
21466
21467
21468
21469 .option allow_fifo appendfile boolean false
21470 .cindex "fifo (named pipe)"
21471 .cindex "named pipe (fifo)"
21472 .cindex "pipe" "named (fifo)"
21473 Setting this option permits delivery to named pipes (FIFOs) as well as to
21474 regular files. If no process is reading the named pipe at delivery time, the
21475 delivery is deferred.
21476
21477
21478 .option allow_symlink appendfile boolean false
21479 .cindex "symbolic link" "to mailbox"
21480 .cindex "mailbox" "symbolic link"
21481 By default, &(appendfile)& will not deliver if the path name for the file is
21482 that of a symbolic link. Setting this option relaxes that constraint, but there
21483 are security issues involved in the use of symbolic links. Be sure you know
21484 what you are doing if you set this. Details of exactly what this option affects
21485 are included in the discussion which follows this list of options.
21486
21487
21488 .option batch_id appendfile string&!! unset
21489 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21490 However, batching is automatically disabled for &(appendfile)& deliveries that
21491 happen as a result of forwarding or aliasing or other redirection directly to a
21492 file.
21493
21494
21495 .option batch_max appendfile integer 1
21496 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21497
21498
21499 .option check_group appendfile boolean false
21500 When this option is set, the group owner of the file defined by the &%file%&
21501 option is checked to see that it is the same as the group under which the
21502 delivery process is running. The default setting is false because the default
21503 file mode is 0600, which means that the group is irrelevant.
21504
21505
21506 .option check_owner appendfile boolean true
21507 When this option is set, the owner of the file defined by the &%file%& option
21508 is checked to ensure that it is the same as the user under which the delivery
21509 process is running.
21510
21511
21512 .option check_string appendfile string "see below"
21513 .cindex "&""From""& line"
21514 As &(appendfile)& writes the message, the start of each line is tested for
21515 matching &%check_string%&, and if it does, the initial matching characters are
21516 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21517 a literal string, not a regular expression, and the case of any letters it
21518 contains is significant.
21519
21520 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21521 are forced to &"."& and &".."& respectively, and any settings in the
21522 configuration are ignored. Otherwise, they default to &"From&~"& and
21523 &">From&~"& when the &%file%& option is set, and unset when any of the
21524 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21525
21526 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21527 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21528 &"From&~"& indicates the start of a new message. All four options need changing
21529 if another format is used. For example, to deliver to mailboxes in MMDF format:
21530 .cindex "MMDF format mailbox"
21531 .cindex "mailbox" "MMDF format"
21532 .code
21533 check_string = "\1\1\1\1\n"
21534 escape_string = "\1\1\1\1 \n"
21535 message_prefix = "\1\1\1\1\n"
21536 message_suffix = "\1\1\1\1\n"
21537 .endd
21538 .option create_directory appendfile boolean true
21539 .cindex "directory creation"
21540 When this option is true, Exim attempts to create any missing superior
21541 directories for the file that it is about to write. A created directory's mode
21542 is given by the &%directory_mode%& option.
21543
21544 The group ownership of a newly created directory is highly dependent on the
21545 operating system (and possibly the file system) that is being used. For
21546 example, in Solaris, if the parent directory has the setgid bit set, its group
21547 is propagated to the child; if not, the currently set group is used. However,
21548 in FreeBSD, the parent's group is always used.
21549
21550
21551
21552 .option create_file appendfile string anywhere
21553 This option constrains the location of files and directories that are created
21554 by this transport. It applies to files defined by the &%file%& option and
21555 directories defined by the &%directory%& option. In the case of maildir
21556 delivery, it applies to the top level directory, not the maildir directories
21557 beneath.
21558
21559 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21560 &"belowhome"&. In the second and third cases, a home directory must have been
21561 set for the transport. This option is not useful when an explicit file name is
21562 given for normal mailbox deliveries. It is intended for the case when file
21563 names are generated from users' &_.forward_& files. These are usually handled
21564 by an &(appendfile)& transport called &%address_file%&. See also
21565 &%file_must_exist%&.
21566
21567
21568 .option directory appendfile string&!! unset
21569 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21570 or &%directory%& must be set, unless the delivery is the direct result of a
21571 redirection (see section &<<SECTfildiropt>>&).
21572
21573 When &%directory%& is set, the string is expanded, and the message is delivered
21574 into a new file or files in or below the given directory, instead of being
21575 appended to a single mailbox file. A number of different formats are provided
21576 (see &%maildir_format%& and &%mailstore_format%&), and see section
21577 &<<SECTopdir>>& for further details of this form of delivery.
21578
21579
21580 .option directory_file appendfile string&!! "see below"
21581 .cindex "base62"
21582 .vindex "&$inode$&"
21583 When &%directory%& is set, but neither &%maildir_format%& nor
21584 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21585 whose name is obtained by expanding this string. The default value is:
21586 .code
21587 q${base62:$tod_epoch}-$inode
21588 .endd
21589 This generates a unique name from the current time, in base 62 form, and the
21590 inode of the file. The variable &$inode$& is available only when expanding this
21591 option.
21592
21593
21594 .option directory_mode appendfile "octal integer" 0700
21595 If &(appendfile)& creates any directories as a result of the
21596 &%create_directory%& option, their mode is specified by this option.
21597
21598
21599 .option escape_string appendfile string "see description"
21600 See &%check_string%& above.
21601
21602
21603 .option file appendfile string&!! unset
21604 This option is mutually exclusive with the &%directory%& option, but one of
21605 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21606 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21607 specifies a single file, to which the message is appended. One or more of
21608 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21609 &%file%&.
21610
21611 .cindex "NFS" "lock file"
21612 .cindex "locking files"
21613 .cindex "lock files"
21614 If you are using more than one host to deliver over NFS into the same
21615 mailboxes, you should always use lock files.
21616
21617 The string value is expanded for each delivery, and must yield an absolute
21618 path. The most common settings of this option are variations on one of these
21619 examples:
21620 .code
21621 file = /var/spool/mail/$local_part
21622 file = /home/$local_part/inbox
21623 file = $home/inbox
21624 .endd
21625 .cindex "&""sticky""& bit"
21626 In the first example, all deliveries are done into the same directory. If Exim
21627 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21628 create a file in the directory, so the &"sticky"& bit must be turned on for
21629 deliveries to be possible, or alternatively the &%group%& option can be used to
21630 run the delivery under a group id which has write access to the directory.
21631
21632
21633
21634 .option file_format appendfile string unset
21635 .cindex "file" "mailbox; checking existing format"
21636 This option requests the transport to check the format of an existing file
21637 before adding to it. The check consists of matching a specific string at the
21638 start of the file. The value of the option consists of an even number of
21639 colon-separated strings. The first of each pair is the test string, and the
21640 second is the name of a transport. If the transport associated with a matched
21641 string is not the current transport, control is passed over to the other
21642 transport. For example, suppose the standard &(local_delivery)& transport has
21643 this added to it:
21644 .code
21645 file_format = "From       : local_delivery :\
21646                \1\1\1\1\n : local_mmdf_delivery"
21647 .endd
21648 Mailboxes that begin with &"From"& are still handled by this transport, but if
21649 a mailbox begins with four binary ones followed by a newline, control is passed
21650 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21651 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21652 is assumed to match the current transport. If the start of a mailbox doesn't
21653 match any string, or if the transport named for a given string is not defined,
21654 delivery is deferred.
21655
21656
21657 .option file_must_exist appendfile boolean false
21658 If this option is true, the file specified by the &%file%& option must exist.
21659 A temporary error occurs if it does not, causing delivery to be deferred.
21660 If this option is false, the file is created if it does not exist.
21661
21662
21663 .option lock_fcntl_timeout appendfile time 0s
21664 .cindex "timeout" "mailbox locking"
21665 .cindex "mailbox" "locking, blocking and non-blocking"
21666 .cindex "locking files"
21667 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21668 when locking an open mailbox file. If the call fails, the delivery process
21669 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21670 Non-blocking calls are used so that the file is not kept open during the wait
21671 for the lock; the reason for this is to make it as safe as possible for
21672 deliveries over NFS in the case when processes might be accessing an NFS
21673 mailbox without using a lock file. This should not be done, but
21674 misunderstandings and hence misconfigurations are not unknown.
21675
21676 On a busy system, however, the performance of a non-blocking lock approach is
21677 not as good as using a blocking lock with a timeout. In this case, the waiting
21678 is done inside the system call, and Exim's delivery process acquires the lock
21679 and can proceed as soon as the previous lock holder releases it.
21680
21681 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21682 timeout, are used. There may still be some retrying: the maximum number of
21683 retries is
21684 .code
21685 (lock_retries * lock_interval) / lock_fcntl_timeout
21686 .endd
21687 rounded up to the next whole number. In other words, the total time during
21688 which &(appendfile)& is trying to get a lock is roughly the same, unless
21689 &%lock_fcntl_timeout%& is set very large.
21690
21691 You should consider setting this option if you are getting a lot of delayed
21692 local deliveries because of errors of the form
21693 .code
21694 failed to lock mailbox /some/file (fcntl)
21695 .endd
21696
21697 .option lock_flock_timeout appendfile time 0s
21698 This timeout applies to file locking when using &[flock()]& (see
21699 &%use_flock%&); the timeout operates in a similar manner to
21700 &%lock_fcntl_timeout%&.
21701
21702
21703 .option lock_interval appendfile time 3s
21704 This specifies the time to wait between attempts to lock the file. See below
21705 for details of locking.
21706
21707
21708 .option lock_retries appendfile integer 10
21709 This specifies the maximum number of attempts to lock the file. A value of zero
21710 is treated as 1. See below for details of locking.
21711
21712
21713 .option lockfile_mode appendfile "octal integer" 0600
21714 This specifies the mode of the created lock file, when a lock file is being
21715 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21716
21717
21718 .option lockfile_timeout appendfile time 30m
21719 .cindex "timeout" "mailbox locking"
21720 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21721 exists and is older than this value, it is assumed to have been left behind by
21722 accident, and Exim attempts to remove it.
21723
21724
21725 .option mailbox_filecount appendfile string&!! unset
21726 .cindex "mailbox" "specifying size of"
21727 .cindex "size" "of mailbox"
21728 If this option is set, it is expanded, and the result is taken as the current
21729 number of files in the mailbox. It must be a decimal number, optionally
21730 followed by K or M. This provides a way of obtaining this information from an
21731 external source that maintains the data.
21732
21733
21734 .option mailbox_size appendfile string&!! unset
21735 .cindex "mailbox" "specifying size of"
21736 .cindex "size" "of mailbox"
21737 If this option is set, it is expanded, and the result is taken as the current
21738 size the mailbox. It must be a decimal number, optionally followed by K or M.
21739 This provides a way of obtaining this information from an external source that
21740 maintains the data. This is likely to be helpful for maildir deliveries where
21741 it is computationally expensive to compute the size of a mailbox.
21742
21743
21744
21745 .option maildir_format appendfile boolean false
21746 .cindex "maildir format" "specifying"
21747 If this option is set with the &%directory%& option, the delivery is into a new
21748 file, in the &"maildir"& format that is used by other mail software. When the
21749 transport is activated directly from a &(redirect)& router (for example, the
21750 &(address_file)& transport in the default configuration), setting
21751 &%maildir_format%& causes the path received from the router to be treated as a
21752 directory, whether or not it ends with &`/`&. This option is available only if
21753 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21754 &<<SECTmaildirdelivery>>& below for further details.
21755
21756
21757 .option maildir_quota_directory_regex appendfile string "See below"
21758 .cindex "maildir format" "quota; directories included in"
21759 .cindex "quota" "maildir; directories included in"
21760 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21761 a regular expression for specifying directories, relative to the quota
21762 directory (see &%quota_directory%&), that should be included in the quota
21763 calculation. The default value is:
21764 .code
21765 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21766 .endd
21767 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21768 (directories whose names begin with a dot). If you want to exclude the
21769 &_Trash_&
21770 folder from the count (as some sites do), you need to change this setting to
21771 .code
21772 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21773 .endd
21774 This uses a negative lookahead in the regular expression to exclude the
21775 directory whose name is &_.Trash_&. When a directory is excluded from quota
21776 calculations, quota processing is bypassed for any messages that are delivered
21777 directly into that directory.
21778
21779
21780 .option maildir_retries appendfile integer 10
21781 This option specifies the number of times to retry when writing a file in
21782 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21783
21784
21785 .option maildir_tag appendfile string&!! unset
21786 This option applies only to deliveries in maildir format, and is described in
21787 section &<<SECTmaildirdelivery>>& below.
21788
21789
21790 .option maildir_use_size_file appendfile&!! boolean false
21791 .cindex "maildir format" "&_maildirsize_& file"
21792 The result of string expansion for this option must be a valid boolean value.
21793 If it is true, it enables support for &_maildirsize_& files. Exim
21794 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21795 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21796 value is zero. See &%maildir_quota_directory_regex%& above and section
21797 &<<SECTmaildirdelivery>>& below for further details.
21798
21799 .option maildirfolder_create_regex appendfile string unset
21800 .cindex "maildir format" "&_maildirfolder_& file"
21801 .cindex "&_maildirfolder_&, creating"
21802 The value of this option is a regular expression. If it is unset, it has no
21803 effect. Otherwise, before a maildir delivery takes place, the pattern is
21804 matched against the name of the maildir directory, that is, the directory
21805 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21806 delivery. If there is a match, Exim checks for the existence of a file called
21807 &_maildirfolder_& in the directory, and creates it if it does not exist.
21808 See section &<<SECTmaildirdelivery>>& for more details.
21809
21810
21811 .option mailstore_format appendfile boolean false
21812 .cindex "mailstore format" "specifying"
21813 If this option is set with the &%directory%& option, the delivery is into two
21814 new files in  &"mailstore"& format. The option is available only if
21815 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21816 below for further details.
21817
21818
21819 .option mailstore_prefix appendfile string&!! unset
21820 This option applies only to deliveries in mailstore format, and is described in
21821 section &<<SECTopdir>>& below.
21822
21823
21824 .option mailstore_suffix appendfile string&!! unset
21825 This option applies only to deliveries in mailstore format, and is described in
21826 section &<<SECTopdir>>& below.
21827
21828
21829 .option mbx_format appendfile boolean false
21830 .cindex "locking files"
21831 .cindex "file" "locking"
21832 .cindex "file" "MBX format"
21833 .cindex "MBX format, specifying"
21834 This option is available only if Exim has been compiled with SUPPORT_MBX
21835 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21836 the message is appended to the mailbox file in MBX format instead of
21837 traditional Unix format. This format is supported by Pine4 and its associated
21838 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21839
21840 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21841 automatically changed by the use of &%mbx_format%&. They should normally be set
21842 empty when using MBX format, so this option almost always appears in this
21843 combination:
21844 .code
21845 mbx_format = true
21846 message_prefix =
21847 message_suffix =
21848 .endd
21849 If none of the locking options are mentioned in the configuration,
21850 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21851 is possible to specify the other kinds of locking with &%mbx_format%&, but
21852 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21853 interworks with &'c-client'&, providing for shared access to the mailbox. It
21854 should not be used if any program that does not use this form of locking is
21855 going to access the mailbox, nor should it be used if the mailbox file is NFS
21856 mounted, because it works only when the mailbox is accessed from a single host.
21857
21858 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21859 the standard version of &'c-client'&, because as long as it has a mailbox open
21860 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21861 append messages to it.
21862
21863
21864 .option message_prefix appendfile string&!! "see below"
21865 .cindex "&""From""& line"
21866 The string specified here is expanded and output at the start of every message.
21867 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21868 in which case it is:
21869 .code
21870 message_prefix = "From ${if def:return_path{$return_path}\
21871   {MAILER-DAEMON}} $tod_bsdinbox\n"
21872 .endd
21873 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21874 &`\n`& to &`\r\n`& in &%message_prefix%&.
21875
21876 .option message_suffix appendfile string&!! "see below"
21877 The string specified here is expanded and output at the end of every message.
21878 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21879 in which case it is a single newline character. The suffix can be suppressed by
21880 setting
21881 .code
21882 message_suffix =
21883 .endd
21884 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21885 &`\n`& to &`\r\n`& in &%message_suffix%&.
21886
21887 .option mode appendfile "octal integer" 0600
21888 If the output file is created, it is given this mode. If it already exists and
21889 has wider permissions, they are reduced to this mode. If it has narrower
21890 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21891 if the delivery is the result of a &%save%& command in a filter file specifying
21892 a particular mode, the mode of the output file is always forced to take that
21893 value, and this option is ignored.
21894
21895
21896 .option mode_fail_narrower appendfile boolean true
21897 This option applies in the case when an existing mailbox file has a narrower
21898 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21899 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21900 continues with the delivery attempt, using the existing mode of the file.
21901
21902
21903 .option notify_comsat appendfile boolean false
21904 If this option is true, the &'comsat'& daemon is notified after every
21905 successful delivery to a user mailbox. This is the daemon that notifies logged
21906 on users about incoming mail.
21907
21908
21909 .option quota appendfile string&!! unset
21910 .cindex "quota" "imposed by Exim"
21911 This option imposes a limit on the size of the file to which Exim is appending,
21912 or to the total space used in the directory tree when the &%directory%& option
21913 is set. In the latter case, computation of the space used is expensive, because
21914 all the files in the directory (and any sub-directories) have to be
21915 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21916 &%maildir_use_size_file%& for ways to avoid this in environments where users
21917 have no shell access to their mailboxes).
21918
21919 As there is no interlock against two simultaneous deliveries into a
21920 multi-file mailbox, it is possible for the quota to be overrun in this case.
21921 For single-file mailboxes, of course, an interlock is a necessity.
21922
21923 A file's size is taken as its &'used'& value. Because of blocking effects, this
21924 may be a lot less than the actual amount of disk space allocated to the file.
21925 If the sizes of a number of files are being added up, the rounding effect can
21926 become quite noticeable, especially on systems that have large block sizes.
21927 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21928 the obvious value which users understand most easily.
21929
21930 The value of the option is expanded, and must then be a numerical value
21931 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21932 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21933 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21934 be handled.
21935
21936 &*Note*&: A value of zero is interpreted as &"no quota"&.
21937
21938 The expansion happens while Exim is running as root, before it changes uid for
21939 the delivery. This means that files that are inaccessible to the end user can
21940 be used to hold quota values that are looked up in the expansion. When delivery
21941 fails because this quota is exceeded, the handling of the error is as for
21942 system quota failures.
21943
21944 By default, Exim's quota checking mimics system quotas, and restricts the
21945 mailbox to the specified maximum size, though the value is not accurate to the
21946 last byte, owing to separator lines and additional headers that may get added
21947 during message delivery. When a mailbox is nearly full, large messages may get
21948 refused even though small ones are accepted, because the size of the current
21949 message is added to the quota when the check is made. This behaviour can be
21950 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21951 for exceeding the quota does not include the current message. Thus, deliveries
21952 continue until the quota has been exceeded; thereafter, no further messages are
21953 delivered. See also &%quota_warn_threshold%&.
21954
21955
21956 .option quota_directory appendfile string&!! unset
21957 This option defines the directory to check for quota purposes when delivering
21958 into individual files. The default is the delivery directory, or, if a file
21959 called &_maildirfolder_& exists in a maildir directory, the parent of the
21960 delivery directory.
21961
21962
21963 .option quota_filecount appendfile string&!! 0
21964 This option applies when the &%directory%& option is set. It limits the total
21965 number of files in the directory (compare the inode limit in system quotas). It
21966 can only be used if &%quota%& is also set. The value is expanded; an expansion
21967 failure causes delivery to be deferred. A value of zero is interpreted as
21968 &"no quota"&.
21969
21970
21971 .option quota_is_inclusive appendfile boolean true
21972 See &%quota%& above.
21973
21974
21975 .option quota_size_regex appendfile string unset
21976 This option applies when one of the delivery modes that writes a separate file
21977 for each message is being used. When Exim wants to find the size of one of
21978 these files in order to test the quota, it first checks &%quota_size_regex%&.
21979 If this is set to a regular expression that matches the file name, and it
21980 captures one string, that string is interpreted as a representation of the
21981 file's size. The value of &%quota_size_regex%& is not expanded.
21982
21983 This feature is useful only when users have no shell access to their mailboxes
21984 &-- otherwise they could defeat the quota simply by renaming the files. This
21985 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21986 the file length to the file name. For example:
21987 .code
21988 maildir_tag = ,S=$message_size
21989 quota_size_regex = ,S=(\d+)
21990 .endd
21991 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21992 number of lines in the message.
21993
21994 The regular expression should not assume that the length is at the end of the
21995 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21996 sometimes add other information onto the ends of message file names.
21997
21998 Section &<<SECID136>>& contains further information.
21999
22000
22001 .option quota_warn_message appendfile string&!! "see below"
22002 See below for the use of this option. If it is not set when
22003 &%quota_warn_threshold%& is set, it defaults to
22004 .code
22005 quota_warn_message = "\
22006   To: $local_part@$domain\n\
22007   Subject: Your mailbox\n\n\
22008   This message is automatically created \
22009   by mail delivery software.\n\n\
22010   The size of your mailbox has exceeded \
22011   a warning threshold that is\n\
22012   set by the system administrator.\n"
22013 .endd
22014
22015
22016 .option quota_warn_threshold appendfile string&!! 0
22017 .cindex "quota" "warning threshold"
22018 .cindex "mailbox" "size warning"
22019 .cindex "size" "of mailbox"
22020 This option is expanded in the same way as &%quota%& (see above). If the
22021 resulting value is greater than zero, and delivery of the message causes the
22022 size of the file or total space in the directory tree to cross the given
22023 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22024 may be specified as a percentage of it by following the value with a percent
22025 sign. For example:
22026 .code
22027 quota = 10M
22028 quota_warn_threshold = 75%
22029 .endd
22030 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22031 percent sign is ignored.
22032
22033 The warning message itself is specified by the &%quota_warn_message%& option,
22034 and it must start with a &'To:'& header line containing the recipient(s) of the
22035 warning message. These do not necessarily have to include the recipient(s) of
22036 the original message. A &'Subject:'& line should also normally be supplied. You
22037 can include any other header lines that you want. If you do not include a
22038 &'From:'& line, the default is:
22039 .code
22040 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22041 .endd
22042 .oindex &%errors_reply_to%&
22043 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22044 option.
22045
22046 The &%quota%& option does not have to be set in order to use this option; they
22047 are independent of one another except when the threshold is specified as a
22048 percentage.
22049
22050
22051 .option use_bsmtp appendfile boolean false
22052 .cindex "envelope sender"
22053 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22054 format, with the envelope sender and recipient(s) included as SMTP commands. If
22055 you want to include a leading HELO command with such messages, you can do
22056 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22057 for details of batch SMTP.
22058
22059
22060 .option use_crlf appendfile boolean false
22061 .cindex "carriage return"
22062 .cindex "linefeed"
22063 This option causes lines to be terminated with the two-character CRLF sequence
22064 (carriage return, linefeed) instead of just a linefeed character. In the case
22065 of batched SMTP, the byte sequence written to the file is then an exact image
22066 of what would be sent down a real SMTP connection.
22067
22068 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22069 (which are used to supply the traditional &"From&~"& and blank line separators
22070 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22071 carriage return characters if these are needed. In cases where these options
22072 have non-empty defaults, the values end with a single linefeed, so they must be
22073 changed to end with &`\r\n`& if &%use_crlf%& is set.
22074
22075
22076 .option use_fcntl_lock appendfile boolean "see below"
22077 This option controls the use of the &[fcntl()]& function to lock a file for
22078 exclusive use when a message is being appended. It is set by default unless
22079 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22080 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22081 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22082
22083
22084 .option use_flock_lock appendfile boolean false
22085 This option is provided to support the use of &[flock()]& for file locking, for
22086 the few situations where it is needed. Most modern operating systems support
22087 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22088 each other. Exim uses &[fcntl()]& locking by default.
22089
22090 This option is required only if you are using an operating system where
22091 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22092 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22093 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22094
22095 .cindex "Solaris" "&[flock()]& support"
22096 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22097 have it (and some, I think, provide a not quite right version built on top of
22098 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22099 the ability to use it, and any attempt to do so will cause a configuration
22100 error.
22101
22102 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22103 is just being mapped onto &[fcntl()]& by the OS).
22104
22105
22106 .option use_lockfile appendfile boolean "see below"
22107 If this option is turned off, Exim does not attempt to create a lock file when
22108 appending to a mailbox file. In this situation, the only locking is by
22109 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22110 sure that every MUA that is ever going to look at your users' mailboxes uses
22111 &[fcntl()]& rather than a lock file, and even then only when you are not
22112 delivering over NFS from more than one host.
22113
22114 .cindex "NFS" "lock file"
22115 In order to append to an NFS file safely from more than one host, it is
22116 necessary to take out a lock &'before'& opening the file, and the lock file
22117 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22118 file corruption.
22119
22120 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22121 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22122 except when &%mbx_format%& is set.
22123
22124
22125 .option use_mbx_lock appendfile boolean "see below"
22126 This option is available only if Exim has been compiled with SUPPORT_MBX
22127 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22128 locking rules be used. It is set by default if &%mbx_format%& is set and none
22129 of the locking options are mentioned in the configuration. The locking rules
22130 are the same as are used by the &'c-client'& library that underlies Pine and
22131 the IMAP4 and POP daemons that come with it (see the discussion below). The
22132 rules allow for shared access to the mailbox. However, this kind of locking
22133 does not work when the mailbox is NFS mounted.
22134
22135 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22136 &%use_flock_lock%& to control what kind of locking is used in implementing the
22137 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22138 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22139
22140
22141
22142
22143 .section "Operational details for appending" "SECTopappend"
22144 .cindex "appending to a file"
22145 .cindex "file" "appending"
22146 Before appending to a file, the following preparations are made:
22147
22148 .ilist
22149 If the name of the file is &_/dev/null_&, no action is taken, and a success
22150 return is given.
22151
22152 .next
22153 .cindex "directory creation"
22154 If any directories on the file's path are missing, Exim creates them if the
22155 &%create_directory%& option is set. A created directory's mode is given by the
22156 &%directory_mode%& option.
22157
22158 .next
22159 If &%file_format%& is set, the format of an existing file is checked. If this
22160 indicates that a different transport should be used, control is passed to that
22161 transport.
22162
22163 .next
22164 .cindex "file" "locking"
22165 .cindex "locking files"
22166 .cindex "NFS" "lock file"
22167 If &%use_lockfile%& is set, a lock file is built in a way that will work
22168 reliably over NFS, as follows:
22169
22170 .olist
22171 Create a &"hitching post"& file whose name is that of the lock file with the
22172 current time, primary host name, and process id added, by opening for writing
22173 as a new file. If this fails with an access error, delivery is deferred.
22174 .next
22175 Close the hitching post file, and hard link it to the lock file name.
22176 .next
22177 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22178 Unlink the hitching post name.
22179 .next
22180 Otherwise, use &[stat()]& to get information about the hitching post file, and
22181 then unlink hitching post name. If the number of links is exactly two, creation
22182 of the lock file succeeded but something (for example, an NFS server crash and
22183 restart) caused this fact not to be communicated to the &[link()]& call.
22184 .next
22185 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22186 up to &%lock_retries%& times. However, since any program that writes to a
22187 mailbox should complete its task very quickly, it is reasonable to time out old
22188 lock files that are normally the result of user agent and system crashes. If an
22189 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22190 it before trying again.
22191 .endlist olist
22192
22193 .next
22194 A call is made to &[lstat()]& to discover whether the main file exists, and if
22195 so, what its characteristics are. If &[lstat()]& fails for any reason other
22196 than non-existence, delivery is deferred.
22197
22198 .next
22199 .cindex "symbolic link" "to mailbox"
22200 .cindex "mailbox" "symbolic link"
22201 If the file does exist and is a symbolic link, delivery is deferred, unless the
22202 &%allow_symlink%& option is set, in which case the ownership of the link is
22203 checked, and then &[stat()]& is called to find out about the real file, which
22204 is then subjected to the checks below. The check on the top-level link
22205 ownership prevents one user creating a link for another's mailbox in a sticky
22206 directory, though allowing symbolic links in this case is definitely not a good
22207 idea. If there is a chain of symbolic links, the intermediate ones are not
22208 checked.
22209
22210 .next
22211 If the file already exists but is not a regular file, or if the file's owner
22212 and group (if the group is being checked &-- see &%check_group%& above) are
22213 different from the user and group under which the delivery is running,
22214 delivery is deferred.
22215
22216 .next
22217 If the file's permissions are more generous than specified, they are reduced.
22218 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22219 is set false, in which case the delivery is tried using the existing
22220 permissions.
22221
22222 .next
22223 The file's inode number is saved, and the file is then opened for appending.
22224 If this fails because the file has vanished, &(appendfile)& behaves as if it
22225 hadn't existed (see below). For any other failures, delivery is deferred.
22226
22227 .next
22228 If the file is opened successfully, check that the inode number hasn't
22229 changed, that it is still a regular file, and that the owner and permissions
22230 have not changed. If anything is wrong, defer delivery and freeze the message.
22231
22232 .next
22233 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22234 option is set. Otherwise, check that the file is being created in a permitted
22235 directory if the &%create_file%& option is set (deferring on failure), and then
22236 open for writing as a new file, with the O_EXCL and O_CREAT options,
22237 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22238 set). In this case, which can happen if the link points to a non-existent file,
22239 the file is opened for writing using O_CREAT but not O_EXCL, because
22240 that prevents link following.
22241
22242 .next
22243 .cindex "loop" "while file testing"
22244 If opening fails because the file exists, obey the tests given above for
22245 existing files. However, to avoid looping in a situation where the file is
22246 being continuously created and destroyed, the exists/not-exists loop is broken
22247 after 10 repetitions, and the message is then frozen.
22248
22249 .next
22250 If opening fails with any other error, defer delivery.
22251
22252 .next
22253 .cindex "file" "locking"
22254 .cindex "locking files"
22255 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22256 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22257 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22258 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22259 file, and an exclusive lock on the file whose name is
22260 .code
22261 /tmp/.<device-number>.<inode-number>
22262 .endd
22263 using the device and inode numbers of the open mailbox file, in accordance with
22264 the MBX locking rules. This file is created with a mode that is specified by
22265 the &%lockfile_mode%& option.
22266
22267 If Exim fails to lock the file, there are two possible courses of action,
22268 depending on the value of the locking timeout. This is obtained from
22269 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22270
22271 If the timeout value is zero, the file is closed, Exim waits for
22272 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22273 to lock it again. This happens up to &%lock_retries%& times, after which the
22274 delivery is deferred.
22275
22276 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22277 &[flock()]& are used (with the given timeout), so there has already been some
22278 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22279 immediately. It retries up to
22280 .code
22281 (lock_retries * lock_interval) / <timeout>
22282 .endd
22283 times (rounded up).
22284 .endlist
22285
22286 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22287 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22288
22289
22290 .section "Operational details for delivery to a new file" "SECTopdir"
22291 .cindex "delivery" "to single file"
22292 .cindex "&""From""& line"
22293 When the &%directory%& option is set instead of &%file%&, each message is
22294 delivered into a newly-created file or set of files. When &(appendfile)& is
22295 activated directly from a &(redirect)& router, neither &%file%& nor
22296 &%directory%& is normally set, because the path for delivery is supplied by the
22297 router. (See for example, the &(address_file)& transport in the default
22298 configuration.) In this case, delivery is to a new file if either the path name
22299 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22300
22301 No locking is required while writing the message to a new file, so the various
22302 locking options of the transport are ignored. The &"From"& line that by default
22303 separates messages in a single file is not normally needed, nor is the escaping
22304 of message lines that start with &"From"&, and there is no need to ensure a
22305 newline at the end of each message. Consequently, the default values for
22306 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22307 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22308
22309 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22310 the files in the delivery directory by default. However, you can specify a
22311 different directory by setting &%quota_directory%&. Also, for maildir
22312 deliveries (see below) the &_maildirfolder_& convention is honoured.
22313
22314
22315 .cindex "maildir format"
22316 .cindex "mailstore format"
22317 There are three different ways in which delivery to individual files can be
22318 done, controlled by the settings of the &%maildir_format%& and
22319 &%mailstore_format%& options. Note that code to support maildir or mailstore
22320 formats is not included in the binary unless SUPPORT_MAILDIR or
22321 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22322
22323 .cindex "directory creation"
22324 In all three cases an attempt is made to create the directory and any necessary
22325 sub-directories if they do not exist, provided that the &%create_directory%&
22326 option is set (the default). The location of a created directory can be
22327 constrained by setting &%create_file%&. A created directory's mode is given by
22328 the &%directory_mode%& option. If creation fails, or if the
22329 &%create_directory%& option is not set when creation is required, delivery is
22330 deferred.
22331
22332
22333
22334 .section "Maildir delivery" "SECTmaildirdelivery"
22335 .cindex "maildir format" "description of"
22336 If the &%maildir_format%& option is true, Exim delivers each message by writing
22337 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22338 directory that is defined by the &%directory%& option (the &"delivery
22339 directory"&). If the delivery is successful, the file is renamed into the
22340 &_new_& subdirectory.
22341
22342 In the file name, <&'stime'&> is the current time of day in seconds, and
22343 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22344 Exim checks that the time-of-day clock has moved on by at least one microsecond
22345 before terminating the delivery process. This guarantees uniqueness for the
22346 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22347 opening it. If any response other than ENOENT (does not exist) is given,
22348 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22349
22350 Before Exim carries out a maildir delivery, it ensures that subdirectories
22351 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22352 do not exist, Exim tries to create them and any superior directories in their
22353 path, subject to the &%create_directory%& and &%create_file%& options. If the
22354 &%maildirfolder_create_regex%& option is set, and the regular expression it
22355 contains matches the delivery directory, Exim also ensures that a file called
22356 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22357 &_maildirfolder_& file cannot be created, delivery is deferred.
22358
22359 These features make it possible to use Exim to create all the necessary files
22360 and directories in a maildir mailbox, including subdirectories for maildir++
22361 folders. Consider this example:
22362 .code
22363 maildir_format = true
22364 directory = /var/mail/$local_part\
22365            ${if eq{$local_part_suffix}{}{}\
22366            {/.${substr_1:$local_part_suffix}}}
22367 maildirfolder_create_regex = /\.[^/]+$
22368 .endd
22369 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22370 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22371 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22372 not match this name, so Exim will not look for or create the file
22373 &_/var/mail/pimbo/maildirfolder_&, though it will create
22374 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22375
22376 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22377 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22378 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22379 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22380 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22381
22382 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22383 not inadvertently match the toplevel maildir directory, because a
22384 &_maildirfolder_& file at top level would completely break quota calculations.
22385
22386 .cindex "quota" "in maildir delivery"
22387 .cindex "maildir++"
22388 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22389 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22390 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22391 Exim assumes the directory is a maildir++ folder directory, which is one level
22392 down from the user's top level mailbox directory. This causes it to start at
22393 the parent directory instead of the current directory when calculating the
22394 amount of space used.
22395
22396 One problem with delivering into a multi-file mailbox is that it is
22397 computationally expensive to compute the size of the mailbox for quota
22398 checking. Various approaches have been taken to reduce the amount of work
22399 needed. The next two sections describe two of them. A third alternative is to
22400 use some external process for maintaining the size data, and use the expansion
22401 of the &%mailbox_size%& option as a way of importing it into Exim.
22402
22403
22404
22405
22406 .section "Using tags to record message sizes" "SECID135"
22407 If &%maildir_tag%& is set, the string is expanded for each delivery.
22408 When the maildir file is renamed into the &_new_& sub-directory, the
22409 tag is added to its name. However, if adding the tag takes the length of the
22410 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22411 the tag is dropped and the maildir file is created with no tag.
22412
22413
22414 .vindex "&$message_size$&"
22415 Tags can be used to encode the size of files in their names; see
22416 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22417 happens after the message has been written. The value of the &$message_size$&
22418 variable is set to the number of bytes actually written. If the expansion is
22419 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22420 be deferred. The expanded tag may contain any printing characters except &"/"&.
22421 Non-printing characters in the string are ignored; if the resulting string is
22422 empty, it is ignored. If it starts with an alphanumeric character, a leading
22423 colon is inserted; this default has not proven to be the path that popular
22424 maildir implementations have chosen (but changing it in Exim would break
22425 backwards compatibility).
22426
22427 For one common implementation, you might set:
22428 .code
22429 maildir_tag = ,S=${message_size}
22430 .endd
22431 but you should check the documentation of the other software to be sure.
22432
22433 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22434 as this allows Exim to extract the size from your tag, instead of having to
22435 &[stat()]& each message file.
22436
22437
22438 .section "Using a maildirsize file" "SECID136"
22439 .cindex "quota" "in maildir delivery"
22440 .cindex "maildir format" "&_maildirsize_& file"
22441 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22442 storing quota and message size information in a file called &_maildirsize_&
22443 within the toplevel maildir directory. If this file does not exist, Exim
22444 creates it, setting the quota from the &%quota%& option of the transport. If
22445 the maildir directory itself does not exist, it is created before any attempt
22446 to write a &_maildirsize_& file.
22447
22448 The &_maildirsize_& file is used to hold information about the sizes of
22449 messages in the maildir, thus speeding up quota calculations. The quota value
22450 in the file is just a cache; if the quota is changed in the transport, the new
22451 value overrides the cached value when the next message is delivered. The cache
22452 is maintained for the benefit of other programs that access the maildir and
22453 need to know the quota.
22454
22455 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22456 file is maintained (with a zero quota setting), but no quota is imposed.
22457
22458 A regular expression is available for controlling which directories in the
22459 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22460 See the description of the &%maildir_quota_directory_regex%& option above for
22461 details.
22462
22463
22464 .section "Mailstore delivery" "SECID137"
22465 .cindex "mailstore format" "description of"
22466 If the &%mailstore_format%& option is true, each message is written as two
22467 files in the given directory. A unique base name is constructed from the
22468 message id and the current delivery process, and the files that are written use
22469 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22470 contains the message's envelope, and the &_.msg_& file contains the message
22471 itself. The base name is placed in the variable &$mailstore_basename$&.
22472
22473 During delivery, the envelope is first written to a file with the suffix
22474 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22475 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22476 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22477 file before accessing either of them. An alternative approach is to wait for
22478 the absence of a &_.tmp_& file.
22479
22480 The envelope file starts with any text defined by the &%mailstore_prefix%&
22481 option, expanded and terminated by a newline if there isn't one. Then follows
22482 the sender address on one line, then all the recipient addresses, one per line.
22483 There can be more than one recipient only if the &%batch_max%& option is set
22484 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22485 appended to the file, followed by a newline if it does not end with one.
22486
22487 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22488 failure, it is ignored. Other expansion errors are treated as serious
22489 configuration errors, and delivery is deferred. The variable
22490 &$mailstore_basename$& is available for use during these expansions.
22491
22492
22493 .section "Non-special new file delivery" "SECID138"
22494 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22495 file is created directly in the named directory. For example, when delivering
22496 messages into files in batched SMTP format for later delivery to some host (see
22497 section &<<SECTbatchSMTP>>&), a setting such as
22498 .code
22499 directory = /var/bsmtp/$host
22500 .endd
22501 might be used. A message is written to a file with a temporary name, which is
22502 then renamed when the delivery is complete. The final name is obtained by
22503 expanding the contents of the &%directory_file%& option.
22504 .ecindex IIDapptra1
22505 .ecindex IIDapptra2
22506
22507
22508
22509
22510
22511
22512 . ////////////////////////////////////////////////////////////////////////////
22513 . ////////////////////////////////////////////////////////////////////////////
22514
22515 .chapter "The autoreply transport" "CHID8"
22516 .scindex IIDauttra1 "transports" "&(autoreply)&"
22517 .scindex IIDauttra2 "&(autoreply)& transport"
22518 The &(autoreply)& transport is not a true transport in that it does not cause
22519 the message to be transmitted. Instead, it generates a new mail message as an
22520 automatic reply to the incoming message. &'References:'& and
22521 &'Auto-Submitted:'& header lines are included. These are constructed according
22522 to the rules in RFCs 2822 and 3834, respectively.
22523
22524 If the router that passes the message to this transport does not have the
22525 &%unseen%& option set, the original message (for the current recipient) is not
22526 delivered anywhere. However, when the &%unseen%& option is set on the router
22527 that passes the message to this transport, routing of the address continues, so
22528 another router can set up a normal message delivery.
22529
22530
22531 The &(autoreply)& transport is usually run as the result of mail filtering, a
22532 &"vacation"& message being the standard example. However, it can also be run
22533 directly from a router like any other transport. To reduce the possibility of
22534 message cascades, messages created by the &(autoreply)& transport always have
22535 empty envelope sender addresses, like bounce messages.
22536
22537 The parameters of the message to be sent can be specified in the configuration
22538 by options described below. However, these are used only when the address
22539 passed to the transport does not contain its own reply information. When the
22540 transport is run as a consequence of a
22541 &%mail%&
22542 or &%vacation%& command in a filter file, the parameters of the message are
22543 supplied by the filter, and passed with the address. The transport's options
22544 that define the message are then ignored (so they are not usually set in this
22545 case). The message is specified entirely by the filter or by the transport; it
22546 is never built from a mixture of options. However, the &%file_optional%&,
22547 &%mode%&, and &%return_message%& options apply in all cases.
22548
22549 &(Autoreply)& is implemented as a local transport. When used as a result of a
22550 command in a user's filter file, &(autoreply)& normally runs under the uid and
22551 gid of the user, and with appropriate current and home directories (see chapter
22552 &<<CHAPenvironment>>&).
22553
22554 There is a subtle difference between routing a message to a &(pipe)& transport
22555 that generates some text to be returned to the sender, and routing it to an
22556 &(autoreply)& transport. This difference is noticeable only if more than one
22557 address from the same message is so handled. In the case of a pipe, the
22558 separate outputs from the different addresses are gathered up and returned to
22559 the sender in a single message, whereas if &(autoreply)& is used, a separate
22560 message is generated for each address that is passed to it.
22561
22562 Non-printing characters are not permitted in the header lines generated for the
22563 message that &(autoreply)& creates, with the exception of newlines that are
22564 immediately followed by white space. If any non-printing characters are found,
22565 the transport defers.
22566 Whether characters with the top bit set count as printing characters or not is
22567 controlled by the &%print_topbitchars%& global option.
22568
22569 If any of the generic options for manipulating headers (for example,
22570 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22571 of the original message that is included in the generated message when
22572 &%return_message%& is set. They do not apply to the generated message itself.
22573
22574 .vindex "&$sender_address$&"
22575 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22576 the message, indicating that there were no recipients, it does not treat this
22577 as an error. This means that autoreplies sent to &$sender_address$& when this
22578 is empty (because the incoming message is a bounce message) do not cause
22579 problems. They are just discarded.
22580
22581
22582
22583 .section "Private options for autoreply" "SECID139"
22584 .cindex "options" "&(autoreply)& transport"
22585
22586 .option bcc autoreply string&!! unset
22587 This specifies the addresses that are to receive &"blind carbon copies"& of the
22588 message when the message is specified by the transport.
22589
22590
22591 .option cc autoreply string&!! unset
22592 This specifies recipients of the message and the contents of the &'Cc:'& header
22593 when the message is specified by the transport.
22594
22595
22596 .option file autoreply string&!! unset
22597 The contents of the file are sent as the body of the message when the message
22598 is specified by the transport. If both &%file%& and &%text%& are set, the text
22599 string comes first.
22600
22601
22602 .option file_expand autoreply boolean false
22603 If this is set, the contents of the file named by the &%file%& option are
22604 subjected to string expansion as they are added to the message.
22605
22606
22607 .option file_optional autoreply boolean false
22608 If this option is true, no error is generated if the file named by the &%file%&
22609 option or passed with the address does not exist or cannot be read.
22610
22611
22612 .option from autoreply string&!! unset
22613 This specifies the contents of the &'From:'& header when the message is
22614 specified by the transport.
22615
22616
22617 .option headers autoreply string&!! unset
22618 This specifies additional RFC 2822 headers that are to be added to the message
22619 when the message is specified by the transport. Several can be given by using
22620 &"\n"& to separate them. There is no check on the format.
22621
22622
22623 .option log autoreply string&!! unset
22624 This option names a file in which a record of every message sent is logged when
22625 the message is specified by the transport.
22626
22627
22628 .option mode autoreply "octal integer" 0600
22629 If either the log file or the &"once"& file has to be created, this mode is
22630 used.
22631
22632
22633 .option never_mail autoreply "address list&!!" unset
22634 If any run of the transport creates a message with a recipient that matches any
22635 item in the list, that recipient is quietly discarded. If all recipients are
22636 discarded, no message is created. This applies both when the recipients are
22637 generated by a filter and when they are specified in the transport.
22638
22639
22640
22641 .option once autoreply string&!! unset
22642 This option names a file or DBM database in which a record of each &'To:'&
22643 recipient is kept when the message is specified by the transport. &*Note*&:
22644 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22645
22646 If &%once%& is unset, or is set to an empty string, the message is always sent.
22647 By default, if &%once%& is set to a non-empty file name, the message
22648 is not sent if a potential recipient is already listed in the database.
22649 However, if the &%once_repeat%& option specifies a time greater than zero, the
22650 message is sent if that much time has elapsed since a message was last sent to
22651 this recipient. A setting of zero time for &%once_repeat%& (the default)
22652 prevents a message from being sent a second time &-- in this case, zero means
22653 infinity.
22654
22655 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22656 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22657 greater than zero, it changes the way Exim implements the &%once%& option.
22658 Instead of using a DBM file to record every recipient it sends to, it uses a
22659 regular file, whose size will never get larger than the given value.
22660
22661 In the file, Exim keeps a linear list of recipient addresses and the times at
22662 which they were sent messages. If the file is full when a new address needs to
22663 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22664 means that a given recipient may receive multiple messages, but at
22665 unpredictable intervals that depend on the rate of turnover of addresses in the
22666 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22667
22668
22669 .option once_file_size autoreply integer 0
22670 See &%once%& above.
22671
22672
22673 .option once_repeat autoreply time&!! 0s
22674 See &%once%& above.
22675 After expansion, the value of this option must be a valid time value.
22676
22677
22678 .option reply_to autoreply string&!! unset
22679 This specifies the contents of the &'Reply-To:'& header when the message is
22680 specified by the transport.
22681
22682
22683 .option return_message autoreply boolean false
22684 If this is set, a copy of the original message is returned with the new
22685 message, subject to the maximum size set in the &%return_size_limit%& global
22686 configuration option.
22687
22688
22689 .option subject autoreply string&!! unset
22690 This specifies the contents of the &'Subject:'& header when the message is
22691 specified by the transport. It is tempting to quote the original subject in
22692 automatic responses. For example:
22693 .code
22694 subject = Re: $h_subject:
22695 .endd
22696 There is a danger in doing this, however. It may allow a third party to
22697 subscribe your users to an opt-in mailing list, provided that the list accepts
22698 bounce messages as subscription confirmations. Well-managed lists require a
22699 non-bounce message to confirm a subscription, so the danger is relatively
22700 small.
22701
22702
22703
22704 .option text autoreply string&!! unset
22705 This specifies a single string to be used as the body of the message when the
22706 message is specified by the transport. If both &%text%& and &%file%& are set,
22707 the text comes first.
22708
22709
22710 .option to autoreply string&!! unset
22711 This specifies recipients of the message and the contents of the &'To:'& header
22712 when the message is specified by the transport.
22713 .ecindex IIDauttra1
22714 .ecindex IIDauttra2
22715
22716
22717
22718
22719 . ////////////////////////////////////////////////////////////////////////////
22720 . ////////////////////////////////////////////////////////////////////////////
22721
22722 .chapter "The lmtp transport" "CHAPLMTP"
22723 .cindex "transports" "&(lmtp)&"
22724 .cindex "&(lmtp)& transport"
22725 .cindex "LMTP" "over a pipe"
22726 .cindex "LMTP" "over a socket"
22727 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22728 specified command
22729 or by interacting with a Unix domain socket.
22730 This transport is something of a cross between the &(pipe)& and &(smtp)&
22731 transports. Exim also has support for using LMTP over TCP/IP; this is
22732 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22733 to be of minority interest, the default build-time configure in &_src/EDITME_&
22734 has it commented out. You need to ensure that
22735 .code
22736 TRANSPORT_LMTP=yes
22737 .endd
22738 .cindex "options" "&(lmtp)& transport"
22739 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22740 included in the Exim binary. The private options of the &(lmtp)& transport are
22741 as follows:
22742
22743 .option batch_id lmtp string&!! unset
22744 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22745
22746
22747 .option batch_max lmtp integer 1
22748 This limits the number of addresses that can be handled in a single delivery.
22749 Most LMTP servers can handle several addresses at once, so it is normally a
22750 good idea to increase this value. See the description of local delivery
22751 batching in chapter &<<CHAPbatching>>&.
22752
22753
22754 .option command lmtp string&!! unset
22755 This option must be set if &%socket%& is not set. The string is a command which
22756 is run in a separate process. It is split up into a command name and list of
22757 arguments, each of which is separately expanded (so expansion cannot change the
22758 number of arguments). The command is run directly, not via a shell. The message
22759 is passed to the new process using the standard input and output to operate the
22760 LMTP protocol.
22761
22762 .option ignore_quota lmtp boolean false
22763 .cindex "LMTP" "ignoring quota errors"
22764 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22765 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22766 in its response to the LHLO command.
22767
22768 .option socket lmtp string&!! unset
22769 This option must be set if &%command%& is not set. The result of expansion must
22770 be the name of a Unix domain socket. The transport connects to the socket and
22771 delivers the message to it using the LMTP protocol.
22772
22773
22774 .option timeout lmtp time 5m
22775 The transport is aborted if the created process or Unix domain socket does not
22776 respond to LMTP commands or message input within this timeout. Delivery
22777 is deferred, and will be tried again later. Here is an example of a typical
22778 LMTP transport:
22779 .code
22780 lmtp:
22781   driver = lmtp
22782   command = /some/local/lmtp/delivery/program
22783   batch_max = 20
22784   user = exim
22785 .endd
22786 This delivers up to 20 addresses at a time, in a mixture of domains if
22787 necessary, running as the user &'exim'&.
22788
22789
22790
22791 . ////////////////////////////////////////////////////////////////////////////
22792 . ////////////////////////////////////////////////////////////////////////////
22793
22794 .chapter "The pipe transport" "CHAPpipetransport"
22795 .scindex IIDpiptra1 "transports" "&(pipe)&"
22796 .scindex IIDpiptra2 "&(pipe)& transport"
22797 The &(pipe)& transport is used to deliver messages via a pipe to a command
22798 running in another process. One example is the use of &(pipe)& as a
22799 pseudo-remote transport for passing messages to some other delivery mechanism
22800 (such as UUCP). Another is the use by individual users to automatically process
22801 their incoming messages. The &(pipe)& transport can be used in one of the
22802 following ways:
22803
22804 .ilist
22805 .vindex "&$local_part$&"
22806 A router routes one address to a transport in the normal way, and the
22807 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22808 contains the local part of the address (as usual), and the command that is run
22809 is specified by the &%command%& option on the transport.
22810 .next
22811 .vindex "&$pipe_addresses$&"
22812 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22813 transport can handle more than one address in a single run. In this case, when
22814 more than one address is routed to the transport, &$local_part$& is not set
22815 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22816 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22817 that are routed to the transport.
22818 .next
22819 .vindex "&$address_pipe$&"
22820 A router redirects an address directly to a pipe command (for example, from an
22821 alias or forward file). In this case, &$address_pipe$& contains the text of the
22822 pipe command, and the &%command%& option on the transport is ignored unless
22823 &%force_command%& is set. If only one address is being transported
22824 (&%batch_max%& is not greater than one, or only one address was redirected to
22825 this pipe command), &$local_part$& contains the local part that was redirected.
22826 .endlist
22827
22828
22829 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22830 deliver messages over pipes using the LMTP interactive protocol. This is
22831 implemented by the &(lmtp)& transport.
22832
22833 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22834 &_.forward_& file, the command runs under the uid and gid of that user. In
22835 other cases, the uid and gid have to be specified explicitly, either on the
22836 transport or on the router that handles the address. Current and &"home"&
22837 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22838 details of the local delivery environment and chapter &<<CHAPbatching>>&
22839 for a discussion of local delivery batching.
22840
22841
22842 .section "Concurrent delivery" "SECID140"
22843 If two messages arrive at almost the same time, and both are routed to a pipe
22844 delivery, the two pipe transports may be run concurrently. You must ensure that
22845 any pipe commands you set up are robust against this happening. If the commands
22846 write to a file, the &%exim_lock%& utility might be of use.
22847 Alternatively the &%max_parallel%& option could be used with a value
22848 of "1" to enforce serialization.
22849
22850
22851
22852
22853 .section "Returned status and data" "SECID141"
22854 .cindex "&(pipe)& transport" "returned data"
22855 If the command exits with a non-zero return code, the delivery is deemed to
22856 have failed, unless either the &%ignore_status%& option is set (in which case
22857 the return code is treated as zero), or the return code is one of those listed
22858 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22859 later"&. In this case, delivery is deferred. Details of a permanent failure are
22860 logged, but are not included in the bounce message, which merely contains
22861 &"local delivery failed"&.
22862
22863 If the command exits on a signal and the &%freeze_signal%& option is set then
22864 the message will be frozen in the queue. If that option is not set, a bounce
22865 will be sent as normal.
22866
22867 If the return code is greater than 128 and the command being run is a shell
22868 script, it normally means that the script was terminated by a signal whose
22869 value is the return code minus 128. The &%freeze_signal%& option does not
22870 apply in this case.
22871
22872 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22873 return code is set to 127. This is the value that a shell returns if it is
22874 asked to run a non-existent command. The wording for the log line suggests that
22875 a non-existent command may be the problem.
22876
22877 The &%return_output%& option can affect the result of a pipe delivery. If it is
22878 set and the command produces any output on its standard output or standard
22879 error streams, the command is considered to have failed, even if it gave a zero
22880 return code or if &%ignore_status%& is set. The output from the command is
22881 included as part of the bounce message. The &%return_fail_output%& option is
22882 similar, except that output is returned only when the command exits with a
22883 failure return code, that is, a value other than zero or a code that matches
22884 &%temp_errors%&.
22885
22886
22887
22888 .section "How the command is run" "SECThowcommandrun"
22889 .cindex "&(pipe)& transport" "path for command"
22890 The command line is (by default) broken down into a command name and arguments
22891 by the &(pipe)& transport itself. The &%allow_commands%& and
22892 &%restrict_to_path%& options can be used to restrict the commands that may be
22893 run.
22894
22895 .cindex "quoting" "in pipe command"
22896 Unquoted arguments are delimited by white space. If an argument appears in
22897 double quotes, backslash is interpreted as an escape character in the usual
22898 way. If an argument appears in single quotes, no escaping is done.
22899
22900 String expansion is applied to the command line except when it comes from a
22901 traditional &_.forward_& file (commands from a filter file are expanded). The
22902 expansion is applied to each argument in turn rather than to the whole line.
22903 For this reason, any string expansion item that contains white space must be
22904 quoted so as to be contained within a single argument. A setting such as
22905 .code
22906 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22907 .endd
22908 will not work, because the expansion item gets split between several
22909 arguments. You have to write
22910 .code
22911 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22912 .endd
22913 to ensure that it is all in one argument. The expansion is done in this way,
22914 argument by argument, so that the number of arguments cannot be changed as a
22915 result of expansion, and quotes or backslashes in inserted variables do not
22916 interact with external quoting. However, this leads to problems if you want to
22917 generate multiple arguments (or the command name plus arguments) from a single
22918 expansion. In this situation, the simplest solution is to use a shell. For
22919 example:
22920 .code
22921 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22922 .endd
22923
22924 .cindex "transport" "filter"
22925 .cindex "filter" "transport filter"
22926 .vindex "&$pipe_addresses$&"
22927 Special handling takes place when an argument consists of precisely the text
22928 &`$pipe_addresses`&. This is not a general expansion variable; the only
22929 place this string is recognized is when it appears as an argument for a pipe or
22930 transport filter command. It causes each address that is being handled to be
22931 inserted in the argument list at that point &'as a separate argument'&. This
22932 avoids any problems with spaces or shell metacharacters, and is of use when a
22933 &(pipe)& transport is handling groups of addresses in a batch.
22934
22935 If &%force_command%& is enabled on the transport, Special handling takes place
22936 for an argument that consists of precisely the text &`$address_pipe`&.  It
22937 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22938 argument is inserted in the argument list at that point
22939 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22940 the only item in the argument; in fact, if it were then &%force_command%&
22941 should behave as a no-op.  Rather, it should be used to adjust the command
22942 run while preserving the argument vector separation.
22943
22944 After splitting up into arguments and expansion, the resulting command is run
22945 in a subprocess directly from the transport, &'not'& under a shell. The
22946 message that is being delivered is supplied on the standard input, and the
22947 standard output and standard error are both connected to a single pipe that is
22948 read by Exim. The &%max_output%& option controls how much output the command
22949 may produce, and the &%return_output%& and &%return_fail_output%& options
22950 control what is done with it.
22951
22952 Not running the command under a shell (by default) lessens the security risks
22953 in cases when a command from a user's filter file is built out of data that was
22954 taken from an incoming message. If a shell is required, it can of course be
22955 explicitly specified as the command to be run. However, there are circumstances
22956 where existing commands (for example, in &_.forward_& files) expect to be run
22957 under a shell and cannot easily be modified. To allow for these cases, there is
22958 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22959 works. Instead of breaking up the command line as just described, it expands it
22960 as a single string and passes the result to &_/bin/sh_&. The
22961 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22962 with &%use_shell%&, and the whole mechanism is inherently less secure.
22963
22964
22965
22966 .section "Environment variables" "SECTpipeenv"
22967 .cindex "&(pipe)& transport" "environment for command"
22968 .cindex "environment" "&(pipe)& transport"
22969 The environment variables listed below are set up when the command is invoked.
22970 This list is a compromise for maximum compatibility with other MTAs. Note that
22971 the &%environment%& option can be used to add additional variables to this
22972 environment. The environment for the &(pipe)& transport is not subject
22973 to the &%add_environment%& and &%keep_environment%& main config options.
22974 .display
22975 &`DOMAIN            `&   the domain of the address
22976 &`HOME              `&   the home directory, if set
22977 &`HOST              `&   the host name when called from a router (see below)
22978 &`LOCAL_PART        `&   see below
22979 &`LOCAL_PART_PREFIX `&   see below
22980 &`LOCAL_PART_SUFFIX `&   see below
22981 &`LOGNAME           `&   see below
22982 &`MESSAGE_ID        `&   Exim's local ID for the message
22983 &`PATH              `&   as specified by the &%path%& option below
22984 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22985 &`RECIPIENT         `&   the complete recipient address
22986 &`SENDER            `&   the sender of the message (empty if a bounce)
22987 &`SHELL             `&   &`/bin/sh`&
22988 &`TZ                `&   the value of the &%timezone%& option, if set
22989 &`USER              `&   see below
22990 .endd
22991 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22992 router, LOCAL_PART is set to the local part of the address. When it is
22993 called as a result of a forward or alias expansion, LOCAL_PART is set to
22994 the local part of the address that was expanded. In both cases, any affixes are
22995 removed from the local part, and made available in LOCAL_PART_PREFIX and
22996 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22997 same value as LOCAL_PART for compatibility with other MTAs.
22998
22999 .cindex "HOST"
23000 HOST is set only when a &(pipe)& transport is called from a router that
23001 associates hosts with an address, typically when using &(pipe)& as a
23002 pseudo-remote transport. HOST is set to the first host name specified by
23003 the router.
23004
23005 .cindex "HOME"
23006 If the transport's generic &%home_directory%& option is set, its value is used
23007 for the HOME environment variable. Otherwise, a home directory may be set
23008 by the router's &%transport_home_directory%& option, which defaults to the
23009 user's home directory if &%check_local_user%& is set.
23010
23011
23012 .section "Private options for pipe" "SECID142"
23013 .cindex "options" "&(pipe)& transport"
23014
23015
23016
23017 .option allow_commands pipe "string list&!!" unset
23018 .cindex "&(pipe)& transport" "permitted commands"
23019 The string is expanded, and is then interpreted as a colon-separated list of
23020 permitted commands. If &%restrict_to_path%& is not set, the only commands
23021 permitted are those in the &%allow_commands%& list. They need not be absolute
23022 paths; the &%path%& option is still used for relative paths. If
23023 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23024 in the &%allow_commands%& list, or a name without any slashes that is found on
23025 the path. In other words, if neither &%allow_commands%& nor
23026 &%restrict_to_path%& is set, there is no restriction on the command, but
23027 otherwise only commands that are permitted by one or the other are allowed. For
23028 example, if
23029 .code
23030 allow_commands = /usr/bin/vacation
23031 .endd
23032 and &%restrict_to_path%& is not set, the only permitted command is
23033 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23034 &%use_shell%& is set.
23035
23036
23037 .option batch_id pipe string&!! unset
23038 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23039
23040
23041 .option batch_max pipe integer 1
23042 This limits the number of addresses that can be handled in a single delivery.
23043 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23044
23045
23046 .option check_string pipe string unset
23047 As &(pipe)& writes the message, the start of each line is tested for matching
23048 &%check_string%&, and if it does, the initial matching characters are replaced
23049 by the contents of &%escape_string%&, provided both are set. The value of
23050 &%check_string%& is a literal string, not a regular expression, and the case of
23051 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23052 of &%check_string%& and &%escape_string%& are forced to values that implement
23053 the SMTP escaping protocol. Any settings made in the configuration file are
23054 ignored.
23055
23056
23057 .option command pipe string&!! unset
23058 This option need not be set when &(pipe)& is being used to deliver to pipes
23059 obtained directly from address redirections. In other cases, the option must be
23060 set, to provide a command to be run. It need not yield an absolute path (see
23061 the &%path%& option below). The command is split up into separate arguments by
23062 Exim, and each argument is separately expanded, as described in section
23063 &<<SECThowcommandrun>>& above.
23064
23065
23066 .option environment pipe string&!! unset
23067 .cindex "&(pipe)& transport" "environment for command"
23068 .cindex "environment" "&(pipe)& transport"
23069 This option is used to add additional variables to the environment in which the
23070 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23071 a string which is expanded, and then interpreted as a colon-separated list of
23072 environment settings of the form <&'name'&>=<&'value'&>.
23073
23074
23075 .option escape_string pipe string unset
23076 See &%check_string%& above.
23077
23078
23079 .option freeze_exec_fail pipe boolean false
23080 .cindex "exec failure"
23081 .cindex "failure of exec"
23082 .cindex "&(pipe)& transport" "failure of exec"
23083 Failure to exec the command in a pipe transport is by default treated like
23084 any other failure while running the command. However, if &%freeze_exec_fail%&
23085 is set, failure to exec is treated specially, and causes the message to be
23086 frozen, whatever the setting of &%ignore_status%&.
23087
23088
23089 .option freeze_signal pipe boolean false
23090 .cindex "signal exit"
23091 .cindex "&(pipe)& transport", "signal exit"
23092 Normally if the process run by a command in a pipe transport exits on a signal,
23093 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23094 frozen in Exim's queue instead.
23095
23096
23097 .option force_command pipe boolean false
23098 .cindex "force command"
23099 .cindex "&(pipe)& transport", "force command"
23100 Normally when a router redirects an address directly to a pipe command
23101 the &%command%& option on the transport is ignored.  If &%force_command%&
23102 is set, the &%command%& option will used. This is especially
23103 useful for forcing a wrapper or additional argument to be added to the
23104 command. For example:
23105 .code
23106 command = /usr/bin/remote_exec myhost -- $address_pipe
23107 force_command
23108 .endd
23109
23110 Note that &$address_pipe$& is handled specially in &%command%& when
23111 &%force_command%& is set, expanding out to the original argument vector as
23112 separate items, similarly to a Unix shell &`"$@"`& construct.
23113
23114
23115 .option ignore_status pipe boolean false
23116 If this option is true, the status returned by the subprocess that is set up to
23117 run the command is ignored, and Exim behaves as if zero had been returned.
23118 Otherwise, a non-zero status or termination by signal causes an error return
23119 from the transport unless the status value is one of those listed in
23120 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23121
23122 &*Note*&: This option does not apply to timeouts, which do not return a status.
23123 See the &%timeout_defer%& option for how timeouts are handled.
23124
23125
23126 .option log_defer_output pipe boolean false
23127 .cindex "&(pipe)& transport" "logging output"
23128 If this option is set, and the status returned by the command is
23129 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23130 and any output was produced on stdout or stderr, the first line of it is
23131 written to the main log.
23132
23133
23134 .option log_fail_output pipe boolean false
23135 If this option is set, and the command returns any output on stdout or
23136 stderr, and also ends with a return code that is neither zero nor one of
23137 the return codes listed in &%temp_errors%& (that is, the delivery
23138 failed), the first line of output is written to the main log. This
23139 option and &%log_output%& are mutually exclusive.  Only one of them may
23140 be set.
23141
23142
23143 .option log_output pipe boolean false
23144 If this option is set and the command returns any output on stdout or
23145 stderr, the first line of output is written to the main log, whatever
23146 the return code. This option and &%log_fail_output%& are mutually
23147 exclusive. Only one of them may be set.
23148
23149
23150 .option max_output pipe integer 20K
23151 This specifies the maximum amount of output that the command may produce on its
23152 standard output and standard error file combined. If the limit is exceeded, the
23153 process running the command is killed. This is intended as a safety measure to
23154 catch runaway processes. The limit is applied independently of the settings of
23155 the options that control what is done with such output (for example,
23156 &%return_output%&). Because of buffering effects, the amount of output may
23157 exceed the limit by a small amount before Exim notices.
23158
23159
23160 .option message_prefix pipe string&!! "see below"
23161 The string specified here is expanded and output at the start of every message.
23162 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23163 .code
23164 message_prefix = \
23165   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23166   ${tod_bsdinbox}\n
23167 .endd
23168 .cindex "Cyrus"
23169 .cindex "&%tmail%&"
23170 .cindex "&""From""& line"
23171 This is required by the commonly used &_/usr/bin/vacation_& program.
23172 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23173 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23174 setting
23175 .code
23176 message_prefix =
23177 .endd
23178 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23179 &`\n`& to &`\r\n`& in &%message_prefix%&.
23180
23181
23182 .option message_suffix pipe string&!! "see below"
23183 The string specified here is expanded and output at the end of every message.
23184 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23185 The suffix can be suppressed by setting
23186 .code
23187 message_suffix =
23188 .endd
23189 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23190 &`\n`& to &`\r\n`& in &%message_suffix%&.
23191
23192
23193 .option path pipe string "see below"
23194 This option specifies the string that is set up in the PATH environment
23195 variable of the subprocess. The default is:
23196 .code
23197 /bin:/usr/bin
23198 .endd
23199 If the &%command%& option does not yield an absolute path name, the command is
23200 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23201 apply to a command specified as a transport filter.
23202
23203
23204 .option permit_coredump pipe boolean false
23205 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23206 a core-dump of a pipe command, enable this command.  This enables core-dumps
23207 during delivery and affects both the Exim binary and the pipe command run.
23208 It is recommended that this option remain off unless and until you have a need
23209 for it and that this only be enabled when needed, as the risk of excessive
23210 resource consumption can be quite high.  Note also that Exim is typically
23211 installed as a setuid binary and most operating systems will inhibit coredumps
23212 of these by default, so further OS-specific action may be required.
23213
23214
23215 .option pipe_as_creator pipe boolean false
23216 .cindex "uid (user id)" "local delivery"
23217 If the generic &%user%& option is not set and this option is true, the delivery
23218 process is run under the uid that was in force when Exim was originally called
23219 to accept the message. If the group id is not otherwise set (via the generic
23220 &%group%& option), the gid that was in force when Exim was originally called to
23221 accept the message is used.
23222
23223
23224 .option restrict_to_path pipe boolean false
23225 When this option is set, any command name not listed in &%allow_commands%& must
23226 contain no slashes. The command is searched for only in the directories listed
23227 in the &%path%& option. This option is intended for use in the case when a pipe
23228 command has been generated from a user's &_.forward_& file. This is usually
23229 handled by a &(pipe)& transport called &%address_pipe%&.
23230
23231
23232 .option return_fail_output pipe boolean false
23233 If this option is true, and the command produced any output and ended with a
23234 return code other than zero or one of the codes listed in &%temp_errors%& (that
23235 is, the delivery failed), the output is returned in the bounce message.
23236 However, if the message has a null sender (that is, it is itself a bounce
23237 message), output from the command is discarded. This option and
23238 &%return_output%& are mutually exclusive. Only one of them may be set.
23239
23240
23241
23242 .option return_output pipe boolean false
23243 If this option is true, and the command produced any output, the delivery is
23244 deemed to have failed whatever the return code from the command, and the output
23245 is returned in the bounce message. Otherwise, the output is just discarded.
23246 However, if the message has a null sender (that is, it is a bounce message),
23247 output from the command is always discarded, whatever the setting of this
23248 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23249 of them may be set.
23250
23251
23252
23253 .option temp_errors pipe "string list" "see below"
23254 .cindex "&(pipe)& transport" "temporary failure"
23255 This option contains either a colon-separated list of numbers, or a single
23256 asterisk. If &%ignore_status%& is false
23257 and &%return_output%& is not set,
23258 and the command exits with a non-zero return code, the failure is treated as
23259 temporary and the delivery is deferred if the return code matches one of the
23260 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23261 codes are treated as permanent errors. The default setting contains the codes
23262 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23263 compiled on a system that does not define these macros, it assumes values of 75
23264 and 73, respectively.
23265
23266
23267 .option timeout pipe time 1h
23268 If the command fails to complete within this time, it is killed. This normally
23269 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23270 specifies no timeout. In order to ensure that any subprocesses created by the
23271 command are also killed, Exim makes the initial process a process group leader,
23272 and kills the whole process group on a timeout. However, this can be defeated
23273 if one of the processes starts a new process group.
23274
23275 .option timeout_defer pipe boolean false
23276 A timeout in a &(pipe)& transport, either in the command that the transport
23277 runs, or in a transport filter that is associated with it, is by default
23278 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23279 is set true, both kinds of timeout become temporary errors, causing the
23280 delivery to be deferred.
23281
23282 .option umask pipe "octal integer" 022
23283 This specifies the umask setting for the subprocess that runs the command.
23284
23285
23286 .option use_bsmtp pipe boolean false
23287 .cindex "envelope sender"
23288 If this option is set true, the &(pipe)& transport writes messages in &"batch
23289 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23290 commands. If you want to include a leading HELO command with such messages,
23291 you can do so by setting the &%message_prefix%& option. See section
23292 &<<SECTbatchSMTP>>& for details of batch SMTP.
23293
23294 .option use_classresources pipe boolean false
23295 .cindex "class resources (BSD)"
23296 This option is available only when Exim is running on FreeBSD, NetBSD, or
23297 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23298 resource limits when a &(pipe)& transport is run to perform a delivery. The
23299 limits for the uid under which the pipe is to run are obtained from the login
23300 class database.
23301
23302
23303 .option use_crlf pipe boolean false
23304 .cindex "carriage return"
23305 .cindex "linefeed"
23306 This option causes lines to be terminated with the two-character CRLF sequence
23307 (carriage return, linefeed) instead of just a linefeed character. In the case
23308 of batched SMTP, the byte sequence written to the pipe is then an exact image
23309 of what would be sent down a real SMTP connection.
23310
23311 The contents of the &%message_prefix%& and &%message_suffix%& options are
23312 written verbatim, so must contain their own carriage return characters if these
23313 are needed. When &%use_bsmtp%& is not set, the default values for both
23314 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23315 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23316
23317
23318 .option use_shell pipe boolean false
23319 .vindex "&$pipe_addresses$&"
23320 If this option is set, it causes the command to be passed to &_/bin/sh_&
23321 instead of being run directly from the transport, as described in section
23322 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23323 where the command is expected to be run under a shell and cannot easily be
23324 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23325 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23326 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23327 its &%-c%& option.
23328
23329
23330
23331 .section "Using an external local delivery agent" "SECID143"
23332 .cindex "local delivery" "using an external agent"
23333 .cindex "&'procmail'&"
23334 .cindex "external local delivery"
23335 .cindex "delivery" "&'procmail'&"
23336 .cindex "delivery" "by external agent"
23337 The &(pipe)& transport can be used to pass all messages that require local
23338 delivery to a separate local delivery agent such as &%procmail%&. When doing
23339 this, care must be taken to ensure that the pipe is run under an appropriate
23340 uid and gid. In some configurations one wants this to be a uid that is trusted
23341 by the delivery agent to supply the correct sender of the message. It may be
23342 necessary to recompile or reconfigure the delivery agent so that it trusts an
23343 appropriate user. The following is an example transport and router
23344 configuration for &%procmail%&:
23345 .code
23346 # transport
23347 procmail_pipe:
23348   driver = pipe
23349   command = /usr/local/bin/procmail -d $local_part
23350   return_path_add
23351   delivery_date_add
23352   envelope_to_add
23353   check_string = "From "
23354   escape_string = ">From "
23355   umask = 077
23356   user = $local_part
23357   group = mail
23358
23359 # router
23360 procmail:
23361   driver = accept
23362   check_local_user
23363   transport = procmail_pipe
23364 .endd
23365 In this example, the pipe is run as the local user, but with the group set to
23366 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23367 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23368 user to supply a correct sender address. If you do not specify either a
23369 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23370 home directory is the user's home directory by default.
23371
23372 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23373 .code
23374 IFS=" "
23375 .endd
23376 as shown in some &%procmail%& documentation, because Exim does not by default
23377 use a shell to run pipe commands.
23378
23379 .cindex "Cyrus"
23380 The next example shows a transport and a router for a system where local
23381 deliveries are handled by the Cyrus IMAP server.
23382 .code
23383 # transport
23384 local_delivery_cyrus:
23385   driver = pipe
23386   command = /usr/cyrus/bin/deliver \
23387             -m ${substr_1:$local_part_suffix} -- $local_part
23388   user = cyrus
23389   group = mail
23390   return_output
23391   log_output
23392   message_prefix =
23393   message_suffix =
23394
23395 # router
23396 local_user_cyrus:
23397   driver = accept
23398   check_local_user
23399   local_part_suffix = .*
23400   transport = local_delivery_cyrus
23401 .endd
23402 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23403 &%return_output%& to cause any text written by Cyrus to be returned to the
23404 sender.
23405 .ecindex IIDpiptra1
23406 .ecindex IIDpiptra2
23407
23408
23409 . ////////////////////////////////////////////////////////////////////////////
23410 . ////////////////////////////////////////////////////////////////////////////
23411
23412 .chapter "The smtp transport" "CHAPsmtptrans"
23413 .scindex IIDsmttra1 "transports" "&(smtp)&"
23414 .scindex IIDsmttra2 "&(smtp)& transport"
23415 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23416 or LMTP protocol. The list of hosts to try can either be taken from the address
23417 that is being processed (having been set up by the router), or specified
23418 explicitly for the transport. Timeout and retry processing (see chapter
23419 &<<CHAPretry>>&) is applied to each IP address independently.
23420
23421
23422 .section "Multiple messages on a single connection" "SECID144"
23423 The sending of multiple messages over a single TCP/IP connection can arise in
23424 two ways:
23425
23426 .ilist
23427 If a message contains more than &%max_rcpt%& (see below) addresses that are
23428 routed to the same host, more than one copy of the message has to be sent to
23429 that host. In this situation, multiple copies may be sent in a single run of
23430 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23431 does when it has too many addresses to send in one message also depends on the
23432 value of the global &%remote_max_parallel%& option. Details are given in
23433 section &<<SECToutSMTPTCP>>&.)
23434 .next
23435 .cindex "hints database" "remembering routing"
23436 When a message has been successfully delivered over a TCP/IP connection, Exim
23437 looks in its hints database to see if there are any other messages awaiting a
23438 connection to the same host. If there are, a new delivery process is started
23439 for one of them, and the current TCP/IP connection is passed on to it. The new
23440 process may in turn send multiple copies and possibly create yet another
23441 process.
23442 .endlist
23443
23444
23445 For each copy sent over the same TCP/IP connection, a sequence counter is
23446 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23447 no further messages are sent over that connection.
23448
23449
23450
23451 .section "Use of the $host and $host_address variables" "SECID145"
23452 .vindex "&$host$&"
23453 .vindex "&$host_address$&"
23454 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23455 &$host_address$& are the name and IP address of the first host on the host list
23456 passed by the router. However, when the transport is about to connect to a
23457 specific host, and while it is connected to that host, &$host$& and
23458 &$host_address$& are set to the values for that host. These are the values
23459 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23460 &%serialize_hosts%&, and the various TLS options are expanded.
23461
23462
23463 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23464 .vindex &$tls_bits$&
23465 .vindex &$tls_cipher$&
23466 .vindex &$tls_peerdn$&
23467 .vindex &$tls_sni$&
23468 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23469 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23470 are the values that were set when the message was received.
23471 These are the values that are used for options that are expanded before any
23472 SMTP connections are made. Just before each connection is made, these four
23473 variables are emptied. If TLS is subsequently started, they are set to the
23474 appropriate values for the outgoing connection, and these are the values that
23475 are in force when any authenticators are run and when the
23476 &%authenticated_sender%& option is expanded.
23477
23478 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23479 and will be removed in a future release.
23480
23481
23482 .section "Private options for smtp" "SECID146"
23483 .cindex "options" "&(smtp)& transport"
23484 The private options of the &(smtp)& transport are as follows:
23485
23486
23487 .option address_retry_include_sender smtp boolean true
23488 .cindex "4&'xx'& responses" "retrying after"
23489 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23490 is the combination of sender and recipient that is delayed in subsequent queue
23491 runs until the retry time is reached. You can delay the recipient without
23492 reference to the sender (which is what earlier versions of Exim did), by
23493 setting &%address_retry_include_sender%& false. However, this can lead to
23494 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23495
23496 .option allow_localhost smtp boolean false
23497 .cindex "local host" "sending to"
23498 .cindex "fallback" "hosts specified on transport"
23499 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23500 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23501 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23502 the delivery anyway. This should be used only in special cases when the
23503 configuration ensures that no looping will result (for example, a differently
23504 configured Exim is listening on the port to which the message is sent).
23505
23506
23507 .option authenticated_sender smtp string&!! unset
23508 .cindex "Cyrus"
23509 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23510 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23511 overriding any existing authenticated sender value. If the string expansion is
23512 forced to fail, the option is ignored. Other expansion failures cause delivery
23513 to be deferred. If the result of expansion is an empty string, that is also
23514 ignored.
23515
23516 The expansion happens after the outgoing connection has been made and TLS
23517 started, if required. This means that the &$host$&, &$host_address$&,
23518 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23519 particular connection.
23520
23521 If the SMTP session is not authenticated, the expansion of
23522 &%authenticated_sender%& still happens (and can cause the delivery to be
23523 deferred if it fails), but no AUTH= item is added to MAIL commands
23524 unless &%authenticated_sender_force%& is true.
23525
23526 This option allows you to use the &(smtp)& transport in LMTP mode to
23527 deliver mail to Cyrus IMAP and provide the proper local part as the
23528 &"authenticated sender"&, via a setting such as:
23529 .code
23530 authenticated_sender = $local_part
23531 .endd
23532 This removes the need for IMAP subfolders to be assigned special ACLs to
23533 allow direct delivery to those subfolders.
23534
23535 Because of expected uses such as that just described for Cyrus (when no
23536 domain is involved), there is no checking on the syntax of the provided
23537 value.
23538
23539
23540 .option authenticated_sender_force smtp boolean false
23541 If this option is set true, the &%authenticated_sender%& option's value
23542 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23543 authenticated as a client.
23544
23545
23546 .option command_timeout smtp time 5m
23547 This sets a timeout for receiving a response to an SMTP command that has been
23548 sent out. It is also used when waiting for the initial banner line from the
23549 remote host. Its value must not be zero.
23550
23551
23552 .option connect_timeout smtp time 5m
23553 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23554 to a remote host. A setting of zero allows the system timeout (typically
23555 several minutes) to act. To have any effect, the value of this option must be
23556 less than the system timeout. However, it has been observed that on some
23557 systems there is no system timeout, which is why the default value for this
23558 option is 5 minutes, a value recommended by RFC 1123.
23559
23560
23561 .option connection_max_messages smtp integer 500
23562 .cindex "SMTP" "passed connection"
23563 .cindex "SMTP" "multiple deliveries"
23564 .cindex "multiple SMTP deliveries"
23565 This controls the maximum number of separate message deliveries that are sent
23566 over a single TCP/IP connection. If the value is zero, there is no limit.
23567 For testing purposes, this value can be overridden by the &%-oB%& command line
23568 option.
23569
23570
23571 .option data_timeout smtp time 5m
23572 This sets a timeout for the transmission of each block in the data portion of
23573 the message. As a result, the overall timeout for a message depends on the size
23574 of the message. Its value must not be zero. See also &%final_timeout%&.
23575
23576
23577 .option dkim_domain smtp string&!! unset
23578 .option dkim_selector smtp string&!! unset
23579 .option dkim_private_key smtp string&!! unset
23580 .option dkim_canon smtp string&!! unset
23581 .option dkim_strict smtp string&!! unset
23582 .option dkim_sign_headers smtp string&!! unset
23583 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23584
23585
23586 .option delay_after_cutoff smtp boolean true
23587 This option controls what happens when all remote IP addresses for a given
23588 domain have been inaccessible for so long that they have passed their retry
23589 cutoff times.
23590
23591 In the default state, if the next retry time has not been reached for any of
23592 them, the address is bounced without trying any deliveries. In other words,
23593 Exim delays retrying an IP address after the final cutoff time until a new
23594 retry time is reached, and can therefore bounce an address without ever trying
23595 a delivery, when machines have been down for a long time. Some people are
23596 unhappy at this prospect, so...
23597
23598 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23599 addresses are past their final cutoff time, Exim tries to deliver to those
23600 IP addresses that have not been tried since the message arrived. If there are
23601 none, of if they all fail, the address is bounced. In other words, it does not
23602 delay when a new message arrives, but immediately tries those expired IP
23603 addresses that haven't been tried since the message arrived. If there is a
23604 continuous stream of messages for the dead hosts, unsetting
23605 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23606 to them.
23607
23608
23609 .option dns_qualify_single smtp boolean true
23610 If the &%hosts%& or &%fallback_hosts%& option is being used,
23611 and the &%gethostbyname%& option is false,
23612 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23613 in chapter &<<CHAPdnslookup>>& for more details.
23614
23615
23616 .option dns_search_parents smtp boolean false
23617 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23618 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23619 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23620 details.
23621
23622
23623 .option dnssec_request_domains smtp "domain list&!!" unset
23624 .cindex "MX record" "security"
23625 .cindex "DNSSEC" "MX lookup"
23626 .cindex "security" "MX lookup"
23627 .cindex "DNS" "DNSSEC"
23628 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23629 the dnssec request bit set.
23630 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23631
23632
23633
23634 .option dnssec_require_domains smtp "domain list&!!" unset
23635 .cindex "MX record" "security"
23636 .cindex "DNSSEC" "MX lookup"
23637 .cindex "security" "MX lookup"
23638 .cindex "DNS" "DNSSEC"
23639 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23640 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23641 (AD bit) set will be ignored and logged as a host-lookup failure.
23642 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23643
23644
23645
23646 .option dscp smtp string&!! unset
23647 .cindex "DCSP" "outbound"
23648 This option causes the DSCP value associated with a socket to be set to one
23649 of a number of fixed strings or to numeric value.
23650 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23651 Common values include &`throughput`&, &`mincost`&, and on newer systems
23652 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23653
23654 The outbound packets from Exim will be marked with this value in the header
23655 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23656 that these values will have any effect, not be stripped by networking
23657 equipment, or do much of anything without cooperation with your Network
23658 Engineer and those of all network operators between the source and destination.
23659
23660
23661 .option fallback_hosts smtp "string list" unset
23662 .cindex "fallback" "hosts specified on transport"
23663 String expansion is not applied to this option. The argument must be a
23664 colon-separated list of host names or IP addresses, optionally also including
23665 port numbers, though the separator can be changed, as described in section
23666 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23667 item in a &%route_list%& setting for the &(manualroute)& router, as described
23668 in section &<<SECTformatonehostitem>>&.
23669
23670 Fallback hosts can also be specified on routers, which associate them with the
23671 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23672 &%fallback_hosts%& specified on the transport is used only if the address does
23673 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23674 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23675 However, &%hosts_randomize%& does apply to fallback host lists.
23676
23677 If Exim is unable to deliver to any of the hosts for a particular address, and
23678 the errors are not permanent rejections, the address is put on a separate
23679 transport queue with its host list replaced by the fallback hosts, unless the
23680 address was routed via MX records and the current host was in the original MX
23681 list. In that situation, the fallback host list is not used.
23682
23683 Once normal deliveries are complete, the fallback queue is delivered by
23684 re-running the same transports with the new host lists. If several failing
23685 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23686 copy of the message is sent.
23687
23688 The resolution of the host names on the fallback list is controlled by the
23689 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23690 both to cases when the host list comes with the address and when it is taken
23691 from &%hosts%&. This option provides a &"use a smart host only if delivery
23692 fails"& facility.
23693
23694
23695 .option final_timeout smtp time 10m
23696 This is the timeout that applies while waiting for the response to the final
23697 line containing just &"."& that terminates a message. Its value must not be
23698 zero.
23699
23700 .option gethostbyname smtp boolean false
23701 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23702 being used, names are looked up using &[gethostbyname()]&
23703 (or &[getipnodebyname()]& when available)
23704 instead of using the DNS. Of course, that function may in fact use the DNS, but
23705 it may also consult other sources of information such as &_/etc/hosts_&.
23706
23707 .option gnutls_compat_mode smtp boolean unset
23708 This option controls whether GnuTLS is used in compatibility mode in an Exim
23709 server. This reduces security slightly, but improves interworking with older
23710 implementations of TLS.
23711
23712 .option helo_data smtp string&!! "see below"
23713 .cindex "HELO" "argument, setting"
23714 .cindex "EHLO" "argument, setting"
23715 .cindex "LHLO argument setting"
23716 The value of this option is expanded after a connection to a another host has
23717 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23718 command that starts the outgoing SMTP or LMTP session. The default value of the
23719 option is:
23720 .code
23721 $primary_hostname
23722 .endd
23723 During the expansion, the variables &$host$& and &$host_address$& are set to
23724 the identity of the remote host, and the variables &$sending_ip_address$& and
23725 &$sending_port$& are set to the local IP address and port number that are being
23726 used. These variables can be used to generate different values for different
23727 servers or different local IP addresses. For example, if you want the string
23728 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23729 interface address, you could use this:
23730 .code
23731 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23732   {$primary_hostname}}
23733 .endd
23734 The use of &%helo_data%& applies both to sending messages and when doing
23735 callouts.
23736
23737 .option hosts smtp "string list&!!" unset
23738 Hosts are associated with an address by a router such as &(dnslookup)&, which
23739 finds the hosts by looking up the address domain in the DNS, or by
23740 &(manualroute)&, which has lists of hosts in its configuration. However,
23741 email addresses can be passed to the &(smtp)& transport by any router, and not
23742 all of them can provide an associated list of hosts.
23743
23744 The &%hosts%& option specifies a list of hosts to be used if the address being
23745 processed does not have any hosts associated with it. The hosts specified by
23746 &%hosts%& are also used, whether or not the address has its own hosts, if
23747 &%hosts_override%& is set.
23748
23749 The string is first expanded, before being interpreted as a colon-separated
23750 list of host names or IP addresses, possibly including port numbers. The
23751 separator may be changed to something other than colon, as described in section
23752 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23753 item in a &%route_list%& setting for the &(manualroute)& router, as described
23754 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23755 of the &(manualroute)& router is not available here.
23756
23757 If the expansion fails, delivery is deferred. Unless the failure was caused by
23758 the inability to complete a lookup, the error is logged to the panic log as
23759 well as the main log. Host names are looked up either by searching directly for
23760 address records in the DNS or by calling &[gethostbyname()]& (or
23761 &[getipnodebyname()]& when available), depending on the setting of the
23762 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23763 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23764 address are used.
23765
23766 During delivery, the hosts are tried in order, subject to their retry status,
23767 unless &%hosts_randomize%& is set.
23768
23769
23770 .option hosts_avoid_esmtp smtp "host list&!!" unset
23771 .cindex "ESMTP, avoiding use of"
23772 .cindex "HELO" "forcing use of"
23773 .cindex "EHLO" "avoiding use of"
23774 .cindex "PIPELINING" "avoiding the use of"
23775 This option is for use with broken hosts that announce ESMTP facilities (for
23776 example, PIPELINING) and then fail to implement them properly. When a host
23777 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23778 start of the SMTP session. This means that it cannot use any of the ESMTP
23779 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23780
23781
23782 .option hosts_avoid_pipelining smtp "host list&!!" unset
23783 .cindex "PIPELINING" "avoiding the use of"
23784 Exim will not use the SMTP PIPELINING extension when delivering to any host
23785 that matches this list, even if the server host advertises PIPELINING support.
23786
23787
23788 .option hosts_avoid_tls smtp "host list&!!" unset
23789 .cindex "TLS" "avoiding for certain hosts"
23790 Exim will not try to start a TLS session when delivering to any host that
23791 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23792
23793 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23794 .cindex "TLS" "avoiding for certain hosts"
23795 Exim will not try to start a TLS session for a verify callout,
23796 or when delivering in cutthrough mode,
23797 to any host that matches this list.
23798
23799
23800 .option hosts_max_try smtp integer 5
23801 .cindex "host" "maximum number to try"
23802 .cindex "limit" "number of hosts tried"
23803 .cindex "limit" "number of MX tried"
23804 .cindex "MX record" "maximum tried"
23805 This option limits the number of IP addresses that are tried for any one
23806 delivery in cases where there are temporary delivery errors. Section
23807 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23808
23809
23810 .option hosts_max_try_hardlimit smtp integer 50
23811 This is an additional check on the maximum number of IP addresses that Exim
23812 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23813 why it exists.
23814
23815
23816
23817 .option hosts_nopass_tls smtp "host list&!!" unset
23818 .cindex "TLS" "passing connection"
23819 .cindex "multiple SMTP deliveries"
23820 .cindex "TLS" "multiple message deliveries"
23821 For any host that matches this list, a connection on which a TLS session has
23822 been started will not be passed to a new delivery process for sending another
23823 message on the same connection. See section &<<SECTmulmessam>>& for an
23824 explanation of when this might be needed.
23825
23826
23827 .option hosts_override smtp boolean false
23828 If this option is set and the &%hosts%& option is also set, any hosts that are
23829 attached to the address are ignored, and instead the hosts specified by the
23830 &%hosts%& option are always used. This option does not apply to
23831 &%fallback_hosts%&.
23832
23833
23834 .option hosts_randomize smtp boolean false
23835 .cindex "randomized host list"
23836 .cindex "host" "list of; randomized"
23837 .cindex "fallback" "randomized hosts"
23838 If this option is set, and either the list of hosts is taken from the
23839 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23840 were not obtained from MX records (this includes fallback hosts from the
23841 router), and were not randomized by the router, the order of trying the hosts
23842 is randomized each time the transport runs. Randomizing the order of a host
23843 list can be used to do crude load sharing.
23844
23845 When &%hosts_randomize%& is true, a host list may be split into groups whose
23846 order is separately randomized. This makes it possible to set up MX-like
23847 behaviour. The boundaries between groups are indicated by an item that is just
23848 &`+`& in the host list. For example:
23849 .code
23850 hosts = host1:host2:host3:+:host4:host5
23851 .endd
23852 The order of the first three hosts and the order of the last two hosts is
23853 randomized for each use, but the first three always end up before the last two.
23854 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23855
23856 .option hosts_require_auth smtp "host list&!!" unset
23857 .cindex "authentication" "required by client"
23858 This option provides a list of servers for which authentication must succeed
23859 before Exim will try to transfer a message. If authentication fails for
23860 servers which are not in this list, Exim tries to send unauthenticated. If
23861 authentication fails for one of these servers, delivery is deferred. This
23862 temporary error is detectable in the retry rules, so it can be turned into a
23863 hard failure if required. See also &%hosts_try_auth%&, and chapter
23864 &<<CHAPSMTPAUTH>>& for details of authentication.
23865
23866
23867 .option hosts_request_ocsp smtp "host list&!!" *
23868 .cindex "TLS" "requiring for certain servers"
23869 Exim will request a Certificate Status on a
23870 TLS session for any host that matches this list.
23871 &%tls_verify_certificates%& should also be set for the transport.
23872
23873 .option hosts_require_ocsp smtp "host list&!!" unset
23874 .cindex "TLS" "requiring for certain servers"
23875 Exim will request, and check for a valid Certificate Status being given, on a
23876 TLS session for any host that matches this list.
23877 &%tls_verify_certificates%& should also be set for the transport.
23878
23879 .option hosts_require_tls smtp "host list&!!" unset
23880 .cindex "TLS" "requiring for certain servers"
23881 Exim will insist on using a TLS session when delivering to any host that
23882 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23883 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23884 incoming messages, use an appropriate ACL.
23885
23886 .option hosts_try_auth smtp "host list&!!" unset
23887 .cindex "authentication" "optional in client"
23888 This option provides a list of servers to which, provided they announce
23889 authentication support, Exim will attempt to authenticate as a client when it
23890 connects. If authentication fails, Exim will try to transfer the message
23891 unauthenticated. See also &%hosts_require_auth%&, and chapter
23892 &<<CHAPSMTPAUTH>>& for details of authentication.
23893
23894 .option hosts_try_prdr smtp "host list&!!" *
23895 .cindex "PRDR" "enabling, optional in client"
23896 This option provides a list of servers to which, provided they announce
23897 PRDR support, Exim will attempt to negotiate PRDR
23898 for multi-recipient messages.
23899 The option can usually be left as default.
23900
23901 .option interface smtp "string list&!!" unset
23902 .cindex "bind IP address"
23903 .cindex "IP address" "binding"
23904 .vindex "&$host$&"
23905 .vindex "&$host_address$&"
23906 This option specifies which interface to bind to when making an outgoing SMTP
23907 call. The value is an IP address, not an interface name such as
23908 &`eth0`&. Do not confuse this with the interface address that was used when a
23909 message was received, which is in &$received_ip_address$&, formerly known as
23910 &$interface_address$&. The name was changed to minimize confusion with the
23911 outgoing interface address. There is no variable that contains an outgoing
23912 interface address because, unless it is set by this option, its value is
23913 unknown.
23914
23915 During the expansion of the &%interface%& option the variables &$host$& and
23916 &$host_address$& refer to the host to which a connection is about to be made
23917 during the expansion of the string. Forced expansion failure, or an empty
23918 string result causes the option to be ignored. Otherwise, after expansion, the
23919 string must be a list of IP addresses, colon-separated by default, but the
23920 separator can be changed in the usual way. For example:
23921 .code
23922 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23923 .endd
23924 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23925 connection. If none of them are the correct type, the option is ignored. If
23926 &%interface%& is not set, or is ignored, the system's IP functions choose which
23927 interface to use if the host has more than one.
23928
23929
23930 .option keepalive smtp boolean true
23931 .cindex "keepalive" "on outgoing connection"
23932 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23933 connections. When set, it causes the kernel to probe idle connections
23934 periodically, by sending packets with &"old"& sequence numbers. The other end
23935 of the connection should send a acknowledgment if the connection is still okay
23936 or a reset if the connection has been aborted. The reason for doing this is
23937 that it has the beneficial effect of freeing up certain types of connection
23938 that can get stuck when the remote host is disconnected without tidying up the
23939 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23940 unreachable hosts.
23941
23942
23943 .option lmtp_ignore_quota smtp boolean false
23944 .cindex "LMTP" "ignoring quota errors"
23945 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23946 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23947 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23948
23949 .option max_rcpt smtp integer 100
23950 .cindex "RCPT" "maximum number of outgoing"
23951 This option limits the number of RCPT commands that are sent in a single
23952 SMTP message transaction. Each set of addresses is treated independently, and
23953 so can cause parallel connections to the same host if &%remote_max_parallel%&
23954 permits this.
23955
23956
23957 .option multi_domain smtp boolean&!! true
23958 .vindex "&$domain$&"
23959 When this option is set, the &(smtp)& transport can handle a number of
23960 addresses containing a mixture of different domains provided they all resolve
23961 to the same list of hosts. Turning the option off restricts the transport to
23962 handling only one domain at a time. This is useful if you want to use
23963 &$domain$& in an expansion for the transport, because it is set only when there
23964 is a single domain involved in a remote delivery.
23965
23966 It is expanded per-address and can depend on any of
23967 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23968 &$host$&, &$host_address$& and &$host_port$&.
23969
23970 .option port smtp string&!! "see below"
23971 .cindex "port" "sending TCP/IP"
23972 .cindex "TCP/IP" "setting outgoing port"
23973 This option specifies the TCP/IP port on the server to which Exim connects.
23974 &*Note:*& Do not confuse this with the port that was used when a message was
23975 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23976 The name was changed to minimize confusion with the outgoing port. There is no
23977 variable that contains an outgoing port.
23978
23979 If the value of this option begins with a digit it is taken as a port number;
23980 otherwise it is looked up using &[getservbyname()]&. The default value is
23981 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23982 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23983 is deferred.
23984
23985
23986
23987 .option protocol smtp string smtp
23988 .cindex "LMTP" "over TCP/IP"
23989 .cindex "ssmtp protocol" "outbound"
23990 .cindex "TLS" "SSL-on-connect outbound"
23991 .vindex "&$port$&"
23992 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23993 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23994 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23995 deliveries into closed message stores. Exim also has support for running LMTP
23996 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23997
23998 If this option is set to &"smtps"&, the default value for the &%port%& option
23999 changes to &"smtps"&, and the transport initiates TLS immediately after
24000 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24001 The Internet standards bodies strongly discourage use of this mode.
24002
24003
24004 .option retry_include_ip_address smtp boolean&!! true
24005 Exim normally includes both the host name and the IP address in the key it
24006 constructs for indexing retry data after a temporary delivery failure. This
24007 means that when one of several IP addresses for a host is failing, it gets
24008 tried periodically (controlled by the retry rules), but use of the other IP
24009 addresses is not affected.
24010
24011 However, in some dialup environments hosts are assigned a different IP address
24012 each time they connect. In this situation the use of the IP address as part of
24013 the retry key leads to undesirable behaviour. Setting this option false causes
24014 Exim to use only the host name.
24015 Since it is expanded it can be made to depend on the host or domain.
24016
24017
24018 .option serialize_hosts smtp "host list&!!" unset
24019 .cindex "serializing connections"
24020 .cindex "host" "serializing connections"
24021 Because Exim operates in a distributed manner, if several messages for the same
24022 host arrive at around the same time, more than one simultaneous connection to
24023 the remote host can occur. This is not usually a problem except when there is a
24024 slow link between the hosts. In that situation it may be helpful to restrict
24025 Exim to one connection at a time. This can be done by setting
24026 &%serialize_hosts%& to match the relevant hosts.
24027
24028 .cindex "hints database" "serializing deliveries to a host"
24029 Exim implements serialization by means of a hints database in which a record is
24030 written whenever a process connects to one of the restricted hosts. The record
24031 is deleted when the connection is completed. Obviously there is scope for
24032 records to get left lying around if there is a system or program crash. To
24033 guard against this, Exim ignores any records that are more than six hours old.
24034
24035 If you set up this kind of serialization, you should also arrange to delete the
24036 relevant hints database whenever your system reboots. The names of the files
24037 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24038 may be one or two files, depending on the type of DBM in use. The same files
24039 are used for ETRN serialization.
24040
24041 See also the &%max_parallel%& generic transport option.
24042
24043
24044 .option size_addition smtp integer 1024
24045 .cindex "SMTP" "SIZE"
24046 .cindex "message" "size issue for transport filter"
24047 .cindex "size" "of message"
24048 .cindex "transport" "filter"
24049 .cindex "filter" "transport filter"
24050 If a remote SMTP server indicates that it supports the SIZE option of the
24051 MAIL command, Exim uses this to pass over the message size at the start of
24052 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24053 sends, to allow for headers and other text that may be added during delivery by
24054 configuration options or in a transport filter. It may be necessary to increase
24055 this if a lot of text is added to messages.
24056
24057 Alternatively, if the value of &%size_addition%& is set negative, it disables
24058 the use of the SIZE option altogether.
24059
24060
24061 .option socks_proxy smtp string&!! unset
24062 .cindex proxy SOCKS
24063 This option enables use of SOCKS proxies for connections made by the
24064 transport.  For details see &<<SECTproxySOCKS>>&.
24065
24066
24067 .option tls_certificate smtp string&!! unset
24068 .cindex "TLS" "client certificate, location of"
24069 .cindex "certificate" "client, location of"
24070 .vindex "&$host$&"
24071 .vindex "&$host_address$&"
24072 The value of this option must be the absolute path to a file which contains the
24073 client's certificate, for possible use when sending a message over an encrypted
24074 connection. The values of &$host$& and &$host_address$& are set to the name and
24075 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24076 details of TLS.
24077
24078 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24079 certificate when sending messages as a client. The global option of the same
24080 name specifies the certificate for Exim as a server; it is not automatically
24081 assumed that the same certificate should be used when Exim is operating as a
24082 client.
24083
24084
24085 .option tls_crl smtp string&!! unset
24086 .cindex "TLS" "client certificate revocation list"
24087 .cindex "certificate" "revocation list for client"
24088 This option specifies a certificate revocation list. The expanded value must
24089 be the name of a file that contains a CRL in PEM format.
24090
24091
24092 .option tls_dh_min_bits smtp integer 1024
24093 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24094 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24095 key agreement is negotiated, the server will provide a large prime number
24096 for use.  This option establishes the minimum acceptable size of that number.
24097 If the parameter offered by the server is too small, then the TLS handshake
24098 will fail.
24099
24100 Only supported when using GnuTLS.
24101
24102
24103 .option tls_privatekey smtp string&!! unset
24104 .cindex "TLS" "client private key, location of"
24105 .vindex "&$host$&"
24106 .vindex "&$host_address$&"
24107 The value of this option must be the absolute path to a file which contains the
24108 client's private key. This is used when sending a message over an encrypted
24109 connection using a client certificate. The values of &$host$& and
24110 &$host_address$& are set to the name and address of the server during the
24111 expansion. If this option is unset, or the expansion is forced to fail, or the
24112 result is an empty string, the private key is assumed to be in the same file as
24113 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24114
24115
24116 .option tls_require_ciphers smtp string&!! unset
24117 .cindex "TLS" "requiring specific ciphers"
24118 .cindex "cipher" "requiring specific"
24119 .vindex "&$host$&"
24120 .vindex "&$host_address$&"
24121 The value of this option must be a list of permitted cipher suites, for use
24122 when setting up an outgoing encrypted connection. (There is a global option of
24123 the same name for controlling incoming connections.) The values of &$host$& and
24124 &$host_address$& are set to the name and address of the server during the
24125 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24126 is used in different ways by OpenSSL and GnuTLS (see sections
24127 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24128 ciphers is a preference order.
24129
24130
24131
24132 .option tls_sni smtp string&!! unset
24133 .cindex "TLS" "Server Name Indication"
24134 .vindex "&$tls_sni$&"
24135 If this option is set then it sets the $tls_out_sni variable and causes any
24136 TLS session to pass this value as the Server Name Indication extension to
24137 the remote side, which can be used by the remote side to select an appropriate
24138 certificate and private key for the session.
24139
24140 See &<<SECTtlssni>>& for more information.
24141
24142 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24143 TLS extensions.
24144
24145
24146
24147
24148 .option tls_tempfail_tryclear smtp boolean true
24149 .cindex "4&'xx'& responses" "to STARTTLS"
24150 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24151 setting up a TLS session, this option determines whether or not Exim should try
24152 to deliver the message unencrypted. If it is set false, delivery to the
24153 current host is deferred; if there are other hosts, they are tried. If this
24154 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24155 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24156 TLS negotiation fails, Exim closes the current connection (because it is in an
24157 unknown state), opens a new one to the same host, and then tries the delivery
24158 in clear.
24159
24160
24161 .option tls_try_verify_hosts smtp "host list&!!" *
24162 .cindex "TLS" "server certificate verification"
24163 .cindex "certificate" "verification of server"
24164 This option gives a list of hosts for which, on encrypted connections,
24165 certificate verification will be tried but need not succeed.
24166 The &%tls_verify_certificates%& option must also be set.
24167 Note that unless the host is in this list
24168 TLS connections will be denied to hosts using self-signed certificates
24169 when &%tls_verify_certificates%& is matched.
24170 The &$tls_out_certificate_verified$& variable is set when
24171 certificate verification succeeds.
24172
24173
24174 .option tls_verify_cert_hostnames smtp "host list&!!" *
24175 .cindex "TLS" "server certificate hostname verification"
24176 .cindex "certificate" "verification of server"
24177 This option give a list of hosts for which,
24178 while verifying the server certificate,
24179 checks will be included on the host name
24180 (note that this will generally be the result of a DNS MX lookup)
24181 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24182 limited to being the initial component of a 3-or-more component FQDN.
24183
24184 There is no equivalent checking on client certificates.
24185
24186
24187 .option tls_verify_certificates smtp string&!! system
24188 .cindex "TLS" "server certificate verification"
24189 .cindex "certificate" "verification of server"
24190 .vindex "&$host$&"
24191 .vindex "&$host_address$&"
24192 The value of this option must be either the
24193 word "system"
24194 or the absolute path to
24195 a file or directory containing permitted certificates for servers,
24196 for use when setting up an encrypted connection.
24197
24198 The "system" value for the option will use a location compiled into the SSL library.
24199 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24200 is taken as empty and an explicit location
24201 must be specified.
24202
24203 The use of a directory for the option value is not available for GnuTLS versions
24204 preceding 3.3.6 and a single file must be used.
24205
24206 With OpenSSL the certificates specified
24207 explicitly
24208 either by file or directory
24209 are added to those given by the system default location.
24210
24211 The values of &$host$& and
24212 &$host_address$& are set to the name and address of the server during the
24213 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24214
24215 For back-compatibility,
24216 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24217 (a single-colon empty list counts as being set)
24218 and certificate verification fails the TLS connection is closed.
24219
24220
24221 .option tls_verify_hosts smtp "host list&!!" unset
24222 .cindex "TLS" "server certificate verification"
24223 .cindex "certificate" "verification of server"
24224 This option gives a list of hosts for which, on encrypted connections,
24225 certificate verification must succeed.
24226 The &%tls_verify_certificates%& option must also be set.
24227 If both this option and &%tls_try_verify_hosts%& are unset
24228 operation is as if this option selected all hosts.
24229
24230
24231
24232
24233 .section "How the limits for the number of hosts to try are used" &&&
24234          "SECTvalhosmax"
24235 .cindex "host" "maximum number to try"
24236 .cindex "limit" "hosts; maximum number tried"
24237 There are two options that are concerned with the number of hosts that are
24238 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24239 &%hosts_max_try_hardlimit%&.
24240
24241
24242 The &%hosts_max_try%& option limits the number of hosts that are tried
24243 for a single delivery. However, despite the term &"host"& in its name, the
24244 option actually applies to each IP address independently. In other words, a
24245 multihomed host is treated as several independent hosts, just as it is for
24246 retrying.
24247
24248 Many of the larger ISPs have multiple MX records which often point to
24249 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24250 created as a result of routing one of these domains.
24251
24252 Trying every single IP address on such a long list does not seem sensible; if
24253 several at the top of the list fail, it is reasonable to assume there is some
24254 problem that is likely to affect all of them. Roughly speaking, the value of
24255 &%hosts_max_try%& is the maximum number that are tried before deferring the
24256 delivery. However, the logic cannot be quite that simple.
24257
24258 Firstly, IP addresses that are skipped because their retry times have not
24259 arrived do not count, and in addition, addresses that are past their retry
24260 limits are also not counted, even when they are tried. This means that when
24261 some IP addresses are past their retry limits, more than the value of
24262 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24263 that all IP addresses are considered before timing out an email address (but
24264 see below for an exception).
24265
24266 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24267 list to see if there is a subsequent host with a different (higher valued) MX.
24268 If there is, that host is considered next, and the current IP address is used
24269 but not counted. This behaviour helps in the case of a domain with a retry rule
24270 that hardly ever delays any hosts, as is now explained:
24271
24272 Consider the case of a long list of hosts with one MX value, and a few with a
24273 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24274 hosts at the top of the list are tried at first. With the default retry rule,
24275 which specifies increasing retry times, the higher MX hosts are eventually
24276 tried when those at the top of the list are skipped because they have not
24277 reached their retry times.
24278
24279 However, it is common practice to put a fixed short retry time on domains for
24280 large ISPs, on the grounds that their servers are rarely down for very long.
24281 Unfortunately, these are exactly the domains that tend to resolve to long lists
24282 of hosts. The short retry time means that the lowest MX hosts are tried every
24283 time. The attempts may be in a different order because of random sorting, but
24284 without the special MX check, the higher MX hosts would never be tried until
24285 all the lower MX hosts had timed out (which might be several days), because
24286 there are always some lower MX hosts that have reached their retry times. With
24287 the special check, Exim considers at least one IP address from each MX value at
24288 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24289 reached.
24290
24291 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24292 particular, Exim normally eventually tries all the IP addresses before timing
24293 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24294 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24295 been set up with hundreds of IP addresses for some domains. It can
24296 take a very long time indeed for an address to time out in these cases.
24297
24298 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24299 Exim never tries more than this number of IP addresses; if it hits this limit
24300 and they are all timed out, the email address is bounced, even though not all
24301 possible IP addresses have been tried.
24302 .ecindex IIDsmttra1
24303 .ecindex IIDsmttra2
24304
24305
24306
24307
24308
24309 . ////////////////////////////////////////////////////////////////////////////
24310 . ////////////////////////////////////////////////////////////////////////////
24311
24312 .chapter "Address rewriting" "CHAPrewrite"
24313 .scindex IIDaddrew "rewriting" "addresses"
24314 There are some circumstances in which Exim automatically rewrites domains in
24315 addresses. The two most common are when an address is given without a domain
24316 (referred to as an &"unqualified address"&) or when an address contains an
24317 abbreviated domain that is expanded by DNS lookup.
24318
24319 Unqualified envelope addresses are accepted only for locally submitted
24320 messages, or for messages that are received from hosts matching
24321 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24322 appropriate. Unqualified addresses in header lines are qualified if they are in
24323 locally submitted messages, or messages from hosts that are permitted to send
24324 unqualified envelope addresses. Otherwise, unqualified addresses in header
24325 lines are neither qualified nor rewritten.
24326
24327 One situation in which Exim does &'not'& automatically rewrite a domain is
24328 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24329 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24330 do this. The new RFCs do not contain this suggestion.
24331
24332
24333 .section "Explicitly configured address rewriting" "SECID147"
24334 This chapter describes the rewriting rules that can be used in the
24335 main rewrite section of the configuration file, and also in the generic
24336 &%headers_rewrite%& option that can be set on any transport.
24337
24338 Some people believe that configured address rewriting is a Mortal Sin.
24339 Others believe that life is not possible without it. Exim provides the
24340 facility; you do not have to use it.
24341
24342 The main rewriting rules that appear in the &"rewrite"& section of the
24343 configuration file are applied to addresses in incoming messages, both envelope
24344 addresses and addresses in header lines. Each rule specifies the types of
24345 address to which it applies.
24346
24347 Whether or not addresses in header lines are rewritten depends on the origin of
24348 the headers and the type of rewriting. Global rewriting, that is, rewriting
24349 rules from the rewrite section of the configuration file, is applied only to
24350 those headers that were received with the message. Header lines that are added
24351 by ACLs or by a system filter or by individual routers or transports (which
24352 are specific to individual recipient addresses) are not rewritten by the global
24353 rules.
24354
24355 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24356 applies all headers except those added by routers and transports. That is, as
24357 well as the headers that were received with the message, it also applies to
24358 headers that were added by an ACL or a system filter.
24359
24360
24361 In general, rewriting addresses from your own system or domain has some
24362 legitimacy. Rewriting other addresses should be done only with great care and
24363 in special circumstances. The author of Exim believes that rewriting should be
24364 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24365 Although it can sometimes be used as a routing tool, this is very strongly
24366 discouraged.
24367
24368 There are two commonly encountered circumstances where rewriting is used, as
24369 illustrated by these examples:
24370
24371 .ilist
24372 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24373 exchange mail with each other behind a firewall, but there is only a single
24374 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24375 &'hitch.fict.example'& when sending mail off-site.
24376 .next
24377 A host rewrites the local parts of its own users so that, for example,
24378 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24379 .endlist
24380
24381
24382
24383 .section "When does rewriting happen?" "SECID148"
24384 .cindex "rewriting" "timing of"
24385 .cindex "&ACL;" "rewriting addresses in"
24386 Configured address rewriting can take place at several different stages of a
24387 message's processing.
24388
24389 .vindex "&$sender_address$&"
24390 At the start of an ACL for MAIL, the sender address may have been rewritten
24391 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24392 ordinary rewrite rules have yet been applied. If, however, the sender address
24393 is verified in the ACL, it is rewritten before verification, and remains
24394 rewritten thereafter. The subsequent value of &$sender_address$& is the
24395 rewritten address. This also applies if sender verification happens in a
24396 RCPT ACL. Otherwise, when the sender address is not verified, it is
24397 rewritten as soon as a message's header lines have been received.
24398
24399 .vindex "&$domain$&"
24400 .vindex "&$local_part$&"
24401 Similarly, at the start of an ACL for RCPT, the current recipient's address
24402 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24403 rewrite rules have yet been applied to it. However, the behaviour is different
24404 from the sender address when a recipient is verified. The address is rewritten
24405 for the verification, but the rewriting is not remembered at this stage. The
24406 value of &$local_part$& and &$domain$& after verification are always the same
24407 as they were before (that is, they contain the unrewritten &-- except for
24408 SMTP-time rewriting &-- address).
24409
24410 As soon as a message's header lines have been received, all the envelope
24411 recipient addresses are permanently rewritten, and rewriting is also applied to
24412 the addresses in the header lines (if configured). This happens before adding
24413 any header lines that were specified in MAIL or RCPT ACLs, and
24414 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24415 before the DATA ACL and &[local_scan()]& functions are run.
24416
24417 When an address is being routed, either for delivery or for verification,
24418 rewriting is applied immediately to child addresses that are generated by
24419 redirection, unless &%no_rewrite%& is set on the router.
24420
24421 .cindex "envelope sender" "rewriting at transport time"
24422 .cindex "rewriting" "at transport time"
24423 .cindex "header lines" "rewriting at transport time"
24424 At transport time, additional rewriting of addresses in header lines can be
24425 specified by setting the generic &%headers_rewrite%& option on a transport.
24426 This option contains rules that are identical in form to those in the rewrite
24427 section of the configuration file. They are applied to the original message
24428 header lines and any that were added by ACLs or a system filter. They are not
24429 applied to header lines that are added by routers or the transport.
24430
24431 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24432 transport option. However, it is not possible to rewrite envelope recipients at
24433 transport time.
24434
24435
24436
24437
24438 .section "Testing the rewriting rules that apply on input" "SECID149"
24439 .cindex "rewriting" "testing"
24440 .cindex "testing" "rewriting"
24441 Exim's input rewriting configuration appears in a part of the run time
24442 configuration file headed by &"begin rewrite"&. It can be tested by the
24443 &%-brw%& command line option. This takes an address (which can be a full RFC
24444 2822 address) as its argument. The output is a list of how the address would be
24445 transformed by the rewriting rules for each of the different places it might
24446 appear in an incoming message, that is, for each different header and for the
24447 envelope sender and recipient fields. For example,
24448 .code
24449 exim -brw ph10@exim.workshop.example
24450 .endd
24451 might produce the output
24452 .code
24453 sender: Philip.Hazel@exim.workshop.example
24454 from: Philip.Hazel@exim.workshop.example
24455 to: ph10@exim.workshop.example
24456 cc: ph10@exim.workshop.example
24457 bcc: ph10@exim.workshop.example
24458 reply-to: Philip.Hazel@exim.workshop.example
24459 env-from: Philip.Hazel@exim.workshop.example
24460 env-to: ph10@exim.workshop.example
24461 .endd
24462 which shows that rewriting has been set up for that address when used in any of
24463 the source fields, but not when it appears as a recipient address. At the
24464 present time, there is no equivalent way of testing rewriting rules that are
24465 set for a particular transport.
24466
24467
24468 .section "Rewriting rules" "SECID150"
24469 .cindex "rewriting" "rules"
24470 The rewrite section of the configuration file consists of lines of rewriting
24471 rules in the form
24472 .display
24473 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24474 .endd
24475 Rewriting rules that are specified for the &%headers_rewrite%& generic
24476 transport option are given as a colon-separated list. Each item in the list
24477 takes the same form as a line in the main rewriting configuration (except that
24478 any colons must be doubled, of course).
24479
24480 The formats of source patterns and replacement strings are described below.
24481 Each is terminated by white space, unless enclosed in double quotes, in which
24482 case normal quoting conventions apply inside the quotes. The flags are single
24483 characters which may appear in any order. Spaces and tabs between them are
24484 ignored.
24485
24486 For each address that could potentially be rewritten, the rules are scanned in
24487 order, and replacements for the address from earlier rules can themselves be
24488 replaced by later rules (but see the &"q"& and &"R"& flags).
24489
24490 The order in which addresses are rewritten is undefined, may change between
24491 releases, and must not be relied on, with one exception: when a message is
24492 received, the envelope sender is always rewritten first, before any header
24493 lines are rewritten. For example, the replacement string for a rewrite of an
24494 address in &'To:'& must not assume that the message's address in &'From:'& has
24495 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24496 that the envelope sender has already been rewritten.
24497
24498 .vindex "&$domain$&"
24499 .vindex "&$local_part$&"
24500 The variables &$local_part$& and &$domain$& can be used in the replacement
24501 string to refer to the address that is being rewritten. Note that lookup-driven
24502 rewriting can be done by a rule of the form
24503 .code
24504 *@*   ${lookup ...
24505 .endd
24506 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24507 refer to the address that is being rewritten.
24508
24509
24510 .section "Rewriting patterns" "SECID151"
24511 .cindex "rewriting" "patterns"
24512 .cindex "address list" "in a rewriting pattern"
24513 The source pattern in a rewriting rule is any item which may appear in an
24514 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24515 single-item address list, which means that it is expanded before being tested
24516 against the address. As always, if you use a regular expression as a pattern,
24517 you must take care to escape dollar and backslash characters, or use the &`\N`&
24518 facility to suppress string expansion within the regular expression.
24519
24520 Domains in patterns should be given in lower case. Local parts in patterns are
24521 case-sensitive. If you want to do case-insensitive matching of local parts, you
24522 can use a regular expression that starts with &`^(?i)`&.
24523
24524 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24525 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24526 depending on the type of match which occurred. These can be used in the
24527 replacement string to insert portions of the incoming address. &$0$& always
24528 refers to the complete incoming address. When a regular expression is used, the
24529 numerical variables are set from its capturing subexpressions. For other types
24530 of pattern they are set as follows:
24531
24532 .ilist
24533 If a local part or domain starts with an asterisk, the numerical variables
24534 refer to the character strings matched by asterisks, with &$1$& associated with
24535 the first asterisk, and &$2$& with the second, if present. For example, if the
24536 pattern
24537 .code
24538 *queen@*.fict.example
24539 .endd
24540 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24541 .code
24542 $0 = hearts-queen@wonderland.fict.example
24543 $1 = hearts-
24544 $2 = wonderland
24545 .endd
24546 Note that if the local part does not start with an asterisk, but the domain
24547 does, it is &$1$& that contains the wild part of the domain.
24548
24549 .next
24550 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24551 of the domain are placed in the next available numerical variables. Suppose,
24552 for example, that the address &'foo@bar.baz.example'& is processed by a
24553 rewriting rule of the form
24554 .display
24555 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24556 .endd
24557 and the key in the file that matches the domain is &`*.baz.example`&. Then
24558 .code
24559 $1 = foo
24560 $2 = bar
24561 $3 = baz.example
24562 .endd
24563 If the address &'foo@baz.example'& is looked up, this matches the same
24564 wildcard file entry, and in this case &$2$& is set to the empty string, but
24565 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24566 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24567 whole domain. For non-partial domain lookups, no numerical variables are set.
24568 .endlist
24569
24570
24571 .section "Rewriting replacements" "SECID152"
24572 .cindex "rewriting" "replacements"
24573 If the replacement string for a rule is a single asterisk, addresses that
24574 match the pattern and the flags are &'not'& rewritten, and no subsequent
24575 rewriting rules are scanned. For example,
24576 .code
24577 hatta@lookingglass.fict.example  *  f
24578 .endd
24579 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24580 &'From:'& headers.
24581
24582 .vindex "&$domain$&"
24583 .vindex "&$local_part$&"
24584 If the replacement string is not a single asterisk, it is expanded, and must
24585 yield a fully qualified address. Within the expansion, the variables
24586 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24587 Any letters they contain retain their original case &-- they are not lower
24588 cased. The numerical variables are set up according to the type of pattern that
24589 matched the address, as described above. If the expansion is forced to fail by
24590 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24591 current rule is abandoned, but subsequent rules may take effect. Any other
24592 expansion failure causes the entire rewriting operation to be abandoned, and an
24593 entry written to the panic log.
24594
24595
24596
24597 .section "Rewriting flags" "SECID153"
24598 There are three different kinds of flag that may appear on rewriting rules:
24599
24600 .ilist
24601 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24602 c, f, h, r, s, t.
24603 .next
24604 A flag that specifies rewriting at SMTP time: S.
24605 .next
24606 Flags that control the rewriting process: Q, q, R, w.
24607 .endlist
24608
24609 For rules that are part of the &%headers_rewrite%& generic transport option,
24610 E, F, T, and S are not permitted.
24611
24612
24613
24614 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24615          "SECID154"
24616 .cindex "rewriting" "flags"
24617 If none of the following flag letters, nor the &"S"& flag (see section
24618 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24619 and to both the sender and recipient fields of the envelope, whereas a
24620 transport-time rewriting rule just applies to all headers. Otherwise, the
24621 rewriting rule is skipped unless the relevant addresses are being processed.
24622 .display
24623 &`E`&       rewrite all envelope fields
24624 &`F`&       rewrite the envelope From field
24625 &`T`&       rewrite the envelope To field
24626 &`b`&       rewrite the &'Bcc:'& header
24627 &`c`&       rewrite the &'Cc:'& header
24628 &`f`&       rewrite the &'From:'& header
24629 &`h`&       rewrite all headers
24630 &`r`&       rewrite the &'Reply-To:'& header
24631 &`s`&       rewrite the &'Sender:'& header
24632 &`t`&       rewrite the &'To:'& header
24633 .endd
24634 "All headers" means all of the headers listed above that can be selected
24635 individually, plus their &'Resent-'& versions. It does not include
24636 other headers such as &'Subject:'& etc.
24637
24638 You should be particularly careful about rewriting &'Sender:'& headers, and
24639 restrict this to special known cases in your own domains.
24640
24641
24642 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24643 .cindex "SMTP" "rewriting malformed addresses"
24644 .cindex "RCPT" "rewriting argument of"
24645 .cindex "MAIL" "rewriting argument of"
24646 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24647 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24648 before any other processing; even before syntax checking. The pattern is
24649 required to be a regular expression, and it is matched against the whole of the
24650 data for the command, including any surrounding angle brackets.
24651
24652 .vindex "&$domain$&"
24653 .vindex "&$local_part$&"
24654 This form of rewrite rule allows for the handling of addresses that are not
24655 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24656 input). Because the input is not required to be a syntactically valid address,
24657 the variables &$local_part$& and &$domain$& are not available during the
24658 expansion of the replacement string. The result of rewriting replaces the
24659 original address in the MAIL or RCPT command.
24660
24661
24662 .section "Flags controlling the rewriting process" "SECID155"
24663 There are four flags which control the way the rewriting process works. These
24664 take effect only when a rule is invoked, that is, when the address is of the
24665 correct type (matches the flags) and matches the pattern:
24666
24667 .ilist
24668 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24669 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24670 absence of &"Q"& the rewritten address must always include a domain.
24671 .next
24672 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24673 even if no rewriting actually takes place because of a &"fail"& in the
24674 expansion. The &"q"& flag is not effective if the address is of the wrong type
24675 (does not match the flags) or does not match the pattern.
24676 .next
24677 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24678 address, up to ten times. It can be combined with the &"q"& flag, to stop
24679 rewriting once it fails to match (after at least one successful rewrite).
24680 .next
24681 .cindex "rewriting" "whole addresses"
24682 When an address in a header is rewritten, the rewriting normally applies only
24683 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24684 left unchanged. For example, rewriting might change
24685 .code
24686 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24687 .endd
24688 into
24689 .code
24690 From: Ford Prefect <prefectf@hitch.fict.example>
24691 .endd
24692 .cindex "RFC 2047"
24693 Sometimes there is a need to replace the whole address item, and this can be
24694 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24695 causes an address in a header line to be rewritten, the entire address is
24696 replaced, not just the working part. The replacement must be a complete RFC
24697 2822 address, including the angle brackets if necessary. If text outside angle
24698 brackets contains a character whose value is greater than 126 or less than 32
24699 (except for tab), the text is encoded according to RFC 2047. The character set
24700 is taken from &%headers_charset%&, which gets its default at build time.
24701
24702 When the &"w"& flag is set on a rule that causes an envelope address to be
24703 rewritten, all but the working part of the replacement address is discarded.
24704 .endlist
24705
24706
24707 .section "Rewriting examples" "SECID156"
24708 Here is an example of the two common rewriting paradigms:
24709 .code
24710 *@*.hitch.fict.example  $1@hitch.fict.example
24711 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24712                      {$value}fail}@hitch.fict.example bctfrF
24713 .endd
24714 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24715 the string expansion to fail if the lookup does not succeed. In this context it
24716 has the effect of leaving the original address unchanged, but Exim goes on to
24717 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24718 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24719 explicitly, which would cause the rewritten address to be the same as before,
24720 at the cost of a small bit of processing. Not supplying either of these is an
24721 error, since the rewritten address would then contain no local part.
24722
24723 The first example above replaces the domain with a superior, more general
24724 domain. This may not be desirable for certain local parts. If the rule
24725 .code
24726 root@*.hitch.fict.example  *
24727 .endd
24728 were inserted before the first rule, rewriting would be suppressed for the
24729 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24730
24731 Rewriting can be made conditional on a number of tests, by making use of
24732 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24733 messages that originate outside the local host:
24734 .code
24735 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24736                          {$1@hitch.fict.example}fail}"
24737 .endd
24738 The replacement string is quoted in this example because it contains white
24739 space.
24740
24741 .cindex "rewriting" "bang paths"
24742 .cindex "bang paths" "rewriting"
24743 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24744 an address it treats it as an unqualified local part which it qualifies with
24745 the local qualification domain (if the source of the message is local or if the
24746 remote host is permitted to send unqualified addresses). Rewriting can
24747 sometimes be used to handle simple bang paths with a fixed number of
24748 components. For example, the rule
24749 .code
24750 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24751 .endd
24752 rewrites a two-component bang path &'host.name!user'& as the domain address
24753 &'user@host.name'&. However, there is a security implication in using this as
24754 a global rewriting rule for envelope addresses. It can provide a backdoor
24755 method for using your system as a relay, because the incoming addresses appear
24756 to be local. If the bang path addresses are received via SMTP, it is safer to
24757 use the &"S"& flag to rewrite them as they are received, so that relay checking
24758 can be done on the rewritten addresses.
24759 .ecindex IIDaddrew
24760
24761
24762
24763
24764
24765 . ////////////////////////////////////////////////////////////////////////////
24766 . ////////////////////////////////////////////////////////////////////////////
24767
24768 .chapter "Retry configuration" "CHAPretry"
24769 .scindex IIDretconf1 "retry" "configuration, description of"
24770 .scindex IIDregconf2 "configuration file" "retry section"
24771 The &"retry"& section of the runtime configuration file contains a list of
24772 retry rules that control how often Exim tries to deliver messages that cannot
24773 be delivered at the first attempt. If there are no retry rules (the section is
24774 empty or not present), there are no retries. In this situation, temporary
24775 errors are treated as permanent. The default configuration contains a single,
24776 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24777 line option can be used to test which retry rule will be used for a given
24778 address, domain and error.
24779
24780 The most common cause of retries is temporary failure to deliver to a remote
24781 host because the host is down, or inaccessible because of a network problem.
24782 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24783 address) basis, not on a per-message basis. Thus, if one message has recently
24784 been delayed, delivery of a new message to the same host is not immediately
24785 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24786 log selector is set, the message
24787 .cindex "retry" "time not reached"
24788 &"retry time not reached"& is written to the main log whenever a delivery is
24789 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24790 the handling of errors during remote deliveries.
24791
24792 Retry processing applies to routing as well as to delivering, except as covered
24793 in the next paragraph. The retry rules do not distinguish between these
24794 actions. It is not possible, for example, to specify different behaviour for
24795 failures to route the domain &'snark.fict.example'& and failures to deliver to
24796 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24797 added complication, so did not implement it. However, although they share the
24798 same retry rule, the actual retry times for routing and transporting a given
24799 domain are maintained independently.
24800
24801 When a delivery is not part of a queue run (typically an immediate delivery on
24802 receipt of a message), the routers are always run, and local deliveries are
24803 always attempted, even if retry times are set for them. This makes for better
24804 behaviour if one particular message is causing problems (for example, causing
24805 quota overflow, or provoking an error in a filter file). If such a delivery
24806 suffers a temporary failure, the retry data is updated as normal, and
24807 subsequent delivery attempts from queue runs occur only when the retry time for
24808 the local address is reached.
24809
24810 .section "Changing retry rules" "SECID157"
24811 If you change the retry rules in your configuration, you should consider
24812 whether or not to delete the retry data that is stored in Exim's spool area in
24813 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24814 always safe; that is why they are called &"hints"&.
24815
24816 The hints retry data contains suggested retry times based on the previous
24817 rules. In the case of a long-running problem with a remote host, it might
24818 record the fact that the host has timed out. If your new rules increase the
24819 timeout time for such a host, you should definitely remove the old retry data
24820 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24821 messages that it should now be retaining.
24822
24823
24824
24825 .section "Format of retry rules" "SECID158"
24826 .cindex "retry" "rules"
24827 Each retry rule occupies one line and consists of three or four parts,
24828 separated by white space: a pattern, an error name, an optional list of sender
24829 addresses, and a list of retry parameters. The pattern and sender lists must be
24830 enclosed in double quotes if they contain white space. The rules are searched
24831 in order until one is found where the pattern, error name, and sender list (if
24832 present) match the failing host or address, the error that occurred, and the
24833 message's sender, respectively.
24834
24835
24836 The pattern is any single item that may appear in an address list (see section
24837 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24838 which means that it is expanded before being tested against the address that
24839 has been delayed. A negated address list item is permitted. Address
24840 list processing treats a plain domain name as if it were preceded by &"*@"&,
24841 which makes it possible for many retry rules to start with just a domain. For
24842 example,
24843 .code
24844 lookingglass.fict.example        *  F,24h,30m;
24845 .endd
24846 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24847 whereas
24848 .code
24849 alice@lookingglass.fict.example  *  F,24h,30m;
24850 .endd
24851 applies only to temporary failures involving the local part &%alice%&.
24852 In practice, almost all rules start with a domain name pattern without a local
24853 part.
24854
24855 .cindex "regular expressions" "in retry rules"
24856 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24857 must match a complete address, not just a domain, because that is how regular
24858 expressions work in address lists.
24859 .display
24860 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24861 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24862 .endd
24863
24864
24865 .section "Choosing which retry rule to use for address errors" "SECID159"
24866 When Exim is looking for a retry rule after a routing attempt has failed (for
24867 example, after a DNS timeout), each line in the retry configuration is tested
24868 against the complete address only if &%retry_use_local_part%& is set for the
24869 router. Otherwise, only the domain is used, except when matching against a
24870 regular expression, when the local part of the address is replaced with &"*"&.
24871 A domain on its own can match a domain pattern, or a pattern that starts with
24872 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24873 &%check_local_user%& is true, and false for other routers.
24874
24875 Similarly, when Exim is looking for a retry rule after a local delivery has
24876 failed (for example, after a mailbox full error), each line in the retry
24877 configuration is tested against the complete address only if
24878 &%retry_use_local_part%& is set for the transport (it defaults true for all
24879 local transports).
24880
24881 .cindex "4&'xx'& responses" "retry rules for"
24882 However, when Exim is looking for a retry rule after a remote delivery attempt
24883 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24884 whole address is always used as the key when searching the retry rules. The
24885 rule that is found is used to create a retry time for the combination of the
24886 failing address and the message's sender. It is the combination of sender and
24887 recipient that is delayed in subsequent queue runs until its retry time is
24888 reached. You can delay the recipient without regard to the sender by setting
24889 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24890 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24891 commands.
24892
24893
24894
24895 .section "Choosing which retry rule to use for host and message errors" &&&
24896          "SECID160"
24897 For a temporary error that is not related to an individual address (for
24898 example, a connection timeout), each line in the retry configuration is checked
24899 twice. First, the name of the remote host is used as a domain name (preceded by
24900 &"*@"& when matching a regular expression). If this does not match the line,
24901 the domain from the email address is tried in a similar fashion. For example,
24902 suppose the MX records for &'a.b.c.example'& are
24903 .code
24904 a.b.c.example  MX  5  x.y.z.example
24905                MX  6  p.q.r.example
24906                MX  7  m.n.o.example
24907 .endd
24908 and the retry rules are
24909 .code
24910 p.q.r.example    *      F,24h,30m;
24911 a.b.c.example    *      F,4d,45m;
24912 .endd
24913 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24914 first rule matches neither the host nor the domain, so Exim looks at the second
24915 rule. This does not match the host, but it does match the domain, so it is used
24916 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24917 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24918 first retry rule is used, because it matches the host.
24919
24920 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24921 first rule to determine retry times, but for all the other hosts for the domain
24922 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24923 routing to &'a.b.c.example'& suffers a temporary failure.
24924
24925 &*Note*&: The host name is used when matching the patterns, not its IP address.
24926 However, if a message is routed directly to an IP address without the use of a
24927 host name, for example, if a &(manualroute)& router contains a setting such as:
24928 .code
24929 route_list = *.a.example  192.168.34.23
24930 .endd
24931 then the &"host name"& that is used when searching for a retry rule is the
24932 textual form of the IP address.
24933
24934 .section "Retry rules for specific errors" "SECID161"
24935 .cindex "retry" "specific errors; specifying"
24936 The second field in a retry rule is the name of a particular error, or an
24937 asterisk, which matches any error. The errors that can be tested for are:
24938
24939 .vlist
24940 .vitem &%auth_failed%&
24941 Authentication failed when trying to send to a host in the
24942 &%hosts_require_auth%& list in an &(smtp)& transport.
24943
24944 .vitem &%data_4xx%&
24945 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24946 after the command, or after sending the message's data.
24947
24948 .vitem &%mail_4xx%&
24949 A 4&'xx'& error was received for an outgoing MAIL command.
24950
24951 .vitem &%rcpt_4xx%&
24952 A 4&'xx'& error was received for an outgoing RCPT command.
24953 .endlist
24954
24955 For the three 4&'xx'& errors, either the first or both of the x's can be given
24956 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24957 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24958 and have retries every ten minutes with a one-hour timeout, you could set up a
24959 retry rule of this form:
24960 .code
24961 the.domain.name  rcpt_452   F,1h,10m
24962 .endd
24963 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24964 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24965
24966 .vlist
24967 .vitem &%lost_connection%&
24968 A server unexpectedly closed the SMTP connection. There may, of course,
24969 legitimate reasons for this (host died, network died), but if it repeats a lot
24970 for the same host, it indicates something odd.
24971
24972 .vitem &%lookup%&
24973 A DNS lookup for a host failed.
24974 Note that a &%dnslookup%& router will need to have matched
24975 its &%fail_defer_domains%& option for this retry type to be usable.
24976 Also note that a &%manualroute%& router will probably need
24977 its &%host_find_failed%& option set to &%defer%&.
24978
24979 .vitem &%refused_MX%&
24980 A connection to a host obtained from an MX record was refused.
24981
24982 .vitem &%refused_A%&
24983 A connection to a host not obtained from an MX record was refused.
24984
24985 .vitem &%refused%&
24986 A connection was refused.
24987
24988 .vitem &%timeout_connect_MX%&
24989 A connection attempt to a host obtained from an MX record timed out.
24990
24991 .vitem &%timeout_connect_A%&
24992 A connection attempt to a host not obtained from an MX record timed out.
24993
24994 .vitem &%timeout_connect%&
24995 A connection attempt timed out.
24996
24997 .vitem &%timeout_MX%&
24998 There was a timeout while connecting or during an SMTP session with a host
24999 obtained from an MX record.
25000
25001 .vitem &%timeout_A%&
25002 There was a timeout while connecting or during an SMTP session with a host not
25003 obtained from an MX record.
25004
25005 .vitem &%timeout%&
25006 There was a timeout while connecting or during an SMTP session.
25007
25008 .vitem &%tls_required%&
25009 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25010 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25011 to STARTTLS, or there was a problem setting up the TLS connection.
25012
25013 .vitem &%quota%&
25014 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25015 transport.
25016
25017 .vitem &%quota_%&<&'time'&>
25018 .cindex "quota" "error testing in retry rule"
25019 .cindex "retry" "quota error testing"
25020 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25021 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25022 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25023 for four days.
25024 .endlist
25025
25026 .cindex "mailbox" "time of last read"
25027 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25028 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25029 it should be based on the last time that the user accessed the mailbox.
25030 However, it is not always possible to determine this. Exim uses the following
25031 heuristic rules:
25032
25033 .ilist
25034 If the mailbox is a single file, the time of last access (the &"atime"&) is
25035 used. As no new messages are being delivered (because the mailbox is over
25036 quota), Exim does not access the file, so this is the time of last user access.
25037 .next
25038 .cindex "maildir format" "time of last read"
25039 For a maildir delivery, the time of last modification of the &_new_&
25040 subdirectory is used. As the mailbox is over quota, no new files are created in
25041 the &_new_& subdirectory, because no new messages are being delivered. Any
25042 change to the &_new_& subdirectory is therefore assumed to be the result of an
25043 MUA moving a new message to the &_cur_& directory when it is first read. The
25044 time that is used is therefore the last time that the user read a new message.
25045 .next
25046 For other kinds of multi-file mailbox, the time of last access cannot be
25047 obtained, so a retry rule that uses this type of error field is never matched.
25048 .endlist
25049
25050 The quota errors apply both to system-enforced quotas and to Exim's own quota
25051 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25052 when a local delivery is deferred because a partition is full (the ENOSPC
25053 error).
25054
25055
25056
25057 .section "Retry rules for specified senders" "SECID162"
25058 .cindex "retry" "rules; sender-specific"
25059 You can specify retry rules that apply only when the failing message has a
25060 specific sender. In particular, this can be used to define retry rules that
25061 apply only to bounce messages. The third item in a retry rule can be of this
25062 form:
25063 .display
25064 &`senders=`&<&'address list'&>
25065 .endd
25066 The retry timings themselves are then the fourth item. For example:
25067 .code
25068 *   rcpt_4xx   senders=:   F,1h,30m
25069 .endd
25070 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25071 host. If the address list contains white space, it must be enclosed in quotes.
25072 For example:
25073 .code
25074 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25075 .endd
25076 &*Warning*&: This facility can be unhelpful if it is used for host errors
25077 (which do not depend on the recipient). The reason is that the sender is used
25078 only to match the retry rule. Once the rule has been found for a host error,
25079 its contents are used to set a retry time for the host, and this will apply to
25080 all messages, not just those with specific senders.
25081
25082 When testing retry rules using &%-brt%&, you can supply a sender using the
25083 &%-f%& command line option, like this:
25084 .code
25085 exim -f "" -brt user@dom.ain
25086 .endd
25087 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25088 list is never matched.
25089
25090
25091
25092
25093
25094 .section "Retry parameters" "SECID163"
25095 .cindex "retry" "parameters in rules"
25096 The third (or fourth, if a senders list is present) field in a retry rule is a
25097 sequence of retry parameter sets, separated by semicolons. Each set consists of
25098 .display
25099 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25100 .endd
25101 The letter identifies the algorithm for computing a new retry time; the cutoff
25102 time is the time beyond which this algorithm no longer applies, and the
25103 arguments vary the algorithm's action. The cutoff time is measured from the
25104 time that the first failure for the domain (combined with the local part if
25105 relevant) was detected, not from the time the message was received.
25106
25107 .cindex "retry" "algorithms"
25108 .cindex "retry" "fixed intervals"
25109 .cindex "retry" "increasing intervals"
25110 .cindex "retry" "random intervals"
25111 The available algorithms are:
25112
25113 .ilist
25114 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25115 the interval.
25116 .next
25117 &'G'&: retry at geometrically increasing intervals. The first argument
25118 specifies a starting value for the interval, and the second a multiplier, which
25119 is used to increase the size of the interval at each retry.
25120 .next
25121 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25122 retry, the previous interval is multiplied by the factor in order to get a
25123 maximum for the next interval. The minimum interval is the first argument of
25124 the parameter, and an actual interval is chosen randomly between them. Such a
25125 rule has been found to be helpful in cluster configurations when all the
25126 members of the cluster restart at once, and may therefore synchronize their
25127 queue processing times.
25128 .endlist
25129
25130 When computing the next retry time, the algorithm definitions are scanned in
25131 order until one whose cutoff time has not yet passed is reached. This is then
25132 used to compute a new retry time that is later than the current time. In the
25133 case of fixed interval retries, this simply means adding the interval to the
25134 current time. For geometrically increasing intervals, retry intervals are
25135 computed from the rule's parameters until one that is greater than the previous
25136 interval is found. The main configuration variable
25137 .cindex "limit" "retry interval"
25138 .cindex "retry" "interval, maximum"
25139 .oindex "&%retry_interval_max%&"
25140 &%retry_interval_max%& limits the maximum interval between retries. It
25141 cannot be set greater than &`24h`&, which is its default value.
25142
25143 A single remote domain may have a number of hosts associated with it, and each
25144 host may have more than one IP address. Retry algorithms are selected on the
25145 basis of the domain name, but are applied to each IP address independently. If,
25146 for example, a host has two IP addresses and one is unusable, Exim will
25147 generate retry times for it and will not try to use it until its next retry
25148 time comes. Thus the good IP address is likely to be tried first most of the
25149 time.
25150
25151 .cindex "hints database" "use for retrying"
25152 Retry times are hints rather than promises. Exim does not make any attempt to
25153 run deliveries exactly at the computed times. Instead, a queue runner process
25154 starts delivery processes for delayed messages periodically, and these attempt
25155 new deliveries only for those addresses that have passed their next retry time.
25156 If a new message arrives for a deferred address, an immediate delivery attempt
25157 occurs only if the address has passed its retry time. In the absence of new
25158 messages, the minimum time between retries is the interval between queue runner
25159 processes. There is not much point in setting retry times of five minutes if
25160 your queue runners happen only once an hour, unless there are a significant
25161 number of incoming messages (which might be the case on a system that is
25162 sending everything to a smart host, for example).
25163
25164 The data in the retry hints database can be inspected by using the
25165 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25166 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25167 &'exinext'& utility script can be used to find out what the next retry times
25168 are for the hosts associated with a particular mail domain, and also for local
25169 deliveries that have been deferred.
25170
25171
25172 .section "Retry rule examples" "SECID164"
25173 Here are some example retry rules:
25174 .code
25175 alice@wonderland.fict.example quota_5d  F,7d,3h
25176 wonderland.fict.example       quota_5d
25177 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25178 lookingglass.fict.example     *         F,24h,30m;
25179 *                 refused_A   F,2h,20m;
25180 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25181 .endd
25182 The first rule sets up special handling for mail to
25183 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25184 mailbox has not been read for at least 5 days. Retries continue every three
25185 hours for 7 days. The second rule handles over-quota errors for all other local
25186 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25187 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25188 fail are bounced immediately if the mailbox has not been read for at least 5
25189 days.
25190
25191 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25192 happen every 15 minutes for an hour, then with geometrically increasing
25193 intervals until two days have passed since a delivery first failed. After the
25194 first hour there is a delay of one hour, then two hours, then four hours, and
25195 so on (this is a rather extreme example).
25196
25197 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25198 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25199 all other domains, with special action for connection refusal from hosts that
25200 were not obtained from an MX record.
25201
25202 The final rule in a retry configuration should always have asterisks in the
25203 first two fields so as to provide a general catch-all for any addresses that do
25204 not have their own special handling. This example tries every 15 minutes for 2
25205 hours, then with intervals starting at one hour and increasing by a factor of
25206 1.5 up to 16 hours, then every 8 hours up to 5 days.
25207
25208
25209
25210 .section "Timeout of retry data" "SECID165"
25211 .cindex "timeout" "of retry data"
25212 .oindex "&%retry_data_expire%&"
25213 .cindex "hints database" "data expiry"
25214 .cindex "retry" "timeout of data"
25215 Exim timestamps the data that it writes to its retry hints database. When it
25216 consults the data during a delivery it ignores any that is older than the value
25217 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25218 been tried for 7 days, Exim will try to deliver to it immediately a message
25219 arrives, and if that fails, it will calculate a retry time as if it were
25220 failing for the first time.
25221
25222 This improves the behaviour for messages routed to rarely-used hosts such as MX
25223 backups. If such a host was down at one time, and happens to be down again when
25224 Exim tries a month later, using the old retry data would imply that it had been
25225 down all the time, which is not a justified assumption.
25226
25227 If a host really is permanently dead, this behaviour causes a burst of retries
25228 every now and again, but only if messages routed to it are rare. If there is a
25229 message at least once every 7 days the retry data never expires.
25230
25231
25232
25233
25234 .section "Long-term failures" "SECID166"
25235 .cindex "delivery failure, long-term"
25236 .cindex "retry" "after long-term failure"
25237 Special processing happens when an email address has been failing for so long
25238 that the cutoff time for the last algorithm is reached. For example, using the
25239 default retry rule:
25240 .code
25241 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25242 .endd
25243 the cutoff time is four days. Reaching the retry cutoff is independent of how
25244 long any specific message has been failing; it is the length of continuous
25245 failure for the recipient address that counts.
25246
25247 When the cutoff time is reached for a local delivery, or for all the IP
25248 addresses associated with a remote delivery, a subsequent delivery failure
25249 causes Exim to give up on the address, and a bounce message is generated.
25250 In order to cater for new messages that use the failing address, a next retry
25251 time is still computed from the final algorithm, and is used as follows:
25252
25253 For local deliveries, one delivery attempt is always made for any subsequent
25254 messages. If this delivery fails, the address fails immediately. The
25255 post-cutoff retry time is not used.
25256
25257 If the delivery is remote, there are two possibilities, controlled by the
25258 .oindex "&%delay_after_cutoff%&"
25259 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25260 default. Until the post-cutoff retry time for one of the IP addresses is
25261 reached, the failing email address is bounced immediately, without a delivery
25262 attempt taking place. After that time, one new delivery attempt is made to
25263 those IP addresses that are past their retry times, and if that still fails,
25264 the address is bounced and new retry times are computed.
25265
25266 In other words, when all the hosts for a given email address have been failing
25267 for a long time, Exim bounces rather then defers until one of the hosts' retry
25268 times is reached. Then it tries once, and bounces if that attempt fails. This
25269 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25270 to a broken destination, but if the host does recover, Exim will eventually
25271 notice.
25272
25273 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25274 addresses are past their final cutoff time, Exim tries to deliver to those IP
25275 addresses that have not been tried since the message arrived. If there are
25276 no suitable IP addresses, or if they all fail, the address is bounced. In other
25277 words, it does not delay when a new message arrives, but tries the expired
25278 addresses immediately, unless they have been tried since the message arrived.
25279 If there is a continuous stream of messages for the failing domains, setting
25280 &%delay_after_cutoff%& false means that there will be many more attempts to
25281 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25282 true.
25283
25284 .section "Deliveries that work intermittently" "SECID167"
25285 .cindex "retry" "intermittently working deliveries"
25286 Some additional logic is needed to cope with cases where a host is
25287 intermittently available, or when a message has some attribute that prevents
25288 its delivery when others to the same address get through. In this situation,
25289 because some messages are successfully delivered, the &"retry clock"& for the
25290 host or address keeps getting reset by the successful deliveries, and so
25291 failing messages remain on the queue for ever because the cutoff time is never
25292 reached.
25293
25294 Two exceptional actions are applied to prevent this happening. The first
25295 applies to errors that are related to a message rather than a remote host.
25296 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25297 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25298 commands, and quota failures. For this type of error, if a message's arrival
25299 time is earlier than the &"first failed"& time for the error, the earlier time
25300 is used when scanning the retry rules to decide when to try next and when to
25301 time out the address.
25302
25303 The exceptional second action applies in all cases. If a message has been on
25304 the queue for longer than the cutoff time of any applicable retry rule for a
25305 given address, a delivery is attempted for that address, even if it is not yet
25306 time, and if this delivery fails, the address is timed out. A new retry time is
25307 not computed in this case, so that other messages for the same address are
25308 considered immediately.
25309 .ecindex IIDretconf1
25310 .ecindex IIDregconf2
25311
25312
25313
25314
25315
25316
25317 . ////////////////////////////////////////////////////////////////////////////
25318 . ////////////////////////////////////////////////////////////////////////////
25319
25320 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25321 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25322 .scindex IIDauthconf2 "authentication"
25323 The &"authenticators"& section of Exim's run time configuration is concerned
25324 with SMTP authentication. This facility is an extension to the SMTP protocol,
25325 described in RFC 2554, which allows a client SMTP host to authenticate itself
25326 to a server. This is a common way for a server to recognize clients that are
25327 permitted to use it as a relay. SMTP authentication is not of relevance to the
25328 transfer of mail between servers that have no managerial connection with each
25329 other.
25330
25331 .cindex "AUTH" "description of"
25332 Very briefly, the way SMTP authentication works is as follows:
25333
25334 .ilist
25335 The server advertises a number of authentication &'mechanisms'& in response to
25336 the client's EHLO command.
25337 .next
25338 The client issues an AUTH command, naming a specific mechanism. The command
25339 may, optionally, contain some authentication data.
25340 .next
25341 The server may issue one or more &'challenges'&, to which the client must send
25342 appropriate responses. In simple authentication mechanisms, the challenges are
25343 just prompts for user names and passwords. The server does not have to issue
25344 any challenges &-- in some mechanisms the relevant data may all be transmitted
25345 with the AUTH command.
25346 .next
25347 The server either accepts or denies authentication.
25348 .next
25349 If authentication succeeds, the client may optionally make use of the AUTH
25350 option on the MAIL command to pass an authenticated sender in subsequent
25351 mail transactions. Authentication lasts for the remainder of the SMTP
25352 connection.
25353 .next
25354 If authentication fails, the client may give up, or it may try a different
25355 authentication mechanism, or it may try transferring mail over the
25356 unauthenticated connection.
25357 .endlist
25358
25359 If you are setting up a client, and want to know which authentication
25360 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25361 SMTP port) on the server, and issue an EHLO command. The response to this
25362 includes the list of supported mechanisms. For example:
25363 .display
25364 &`$ `&&*&`telnet server.example 25`&*&
25365 &`Trying 192.168.34.25...`&
25366 &`Connected to server.example.`&
25367 &`Escape character is &#x0027;^]&#x0027;.`&
25368 &`220 server.example ESMTP Exim 4.20 ...`&
25369 &*&`ehlo client.example`&*&
25370 &`250-server.example Hello client.example [10.8.4.5]`&
25371 &`250-SIZE 52428800`&
25372 &`250-PIPELINING`&
25373 &`250-AUTH PLAIN`&
25374 &`250 HELP`&
25375 .endd
25376 The second-last line of this example output shows that the server supports
25377 authentication using the PLAIN mechanism. In Exim, the different authentication
25378 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25379 routers and transports, which authenticators are included in the binary is
25380 controlled by build-time definitions. The following are currently available,
25381 included by setting
25382 .code
25383 AUTH_CRAM_MD5=yes
25384 AUTH_CYRUS_SASL=yes
25385 AUTH_DOVECOT=yes
25386 AUTH_GSASL=yes
25387 AUTH_HEIMDAL_GSSAPI=yes
25388 AUTH_PLAINTEXT=yes
25389 AUTH_SPA=yes
25390 AUTH_TLS=yes
25391 .endd
25392 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25393 authentication mechanism (RFC 2195), and the second provides an interface to
25394 the Cyrus SASL authentication library.
25395 The third is an interface to Dovecot's authentication system, delegating the
25396 work via a socket interface.
25397 The fourth provides an interface to the GNU SASL authentication library, which
25398 provides mechanisms but typically not data sources.
25399 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25400 supporting setting a server keytab.
25401 The sixth can be configured to support
25402 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25403 not formally documented, but used by several MUAs. The seventh authenticator
25404 supports Microsoft's &'Secure Password Authentication'& mechanism.
25405 The eighth is an Exim authenticator but not an SMTP one;
25406 instead it can use information from a TLS negotiation.
25407
25408 The authenticators are configured using the same syntax as other drivers (see
25409 section &<<SECTfordricon>>&). If no authenticators are required, no
25410 authentication section need be present in the configuration file. Each
25411 authenticator can in principle have both server and client functions. When Exim
25412 is receiving SMTP mail, it is acting as a server; when it is sending out
25413 messages over SMTP, it is acting as a client. Authenticator configuration
25414 options are provided for use in both these circumstances.
25415
25416 To make it clear which options apply to which situation, the prefixes
25417 &%server_%& and &%client_%& are used on option names that are specific to
25418 either the server or the client function, respectively. Server and client
25419 functions are disabled if none of their options are set. If an authenticator is
25420 to be used for both server and client functions, a single definition, using
25421 both sets of options, is required. For example:
25422 .code
25423 cram:
25424   driver = cram_md5
25425   public_name = CRAM-MD5
25426   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25427   client_name = ph10
25428   client_secret = secret2
25429 .endd
25430 The &%server_%& option is used when Exim is acting as a server, and the
25431 &%client_%& options when it is acting as a client.
25432
25433 Descriptions of the individual authenticators are given in subsequent chapters.
25434 The remainder of this chapter covers the generic options for the
25435 authenticators, followed by general discussion of the way authentication works
25436 in Exim.
25437
25438 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25439 per-mechanism basis.  Please read carefully to determine which variables hold
25440 account labels such as usercodes and which hold passwords or other
25441 authenticating data.
25442
25443 Note that some mechanisms support two different identifiers for accounts: the
25444 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25445 and &'authz'& are commonly encountered.  The American spelling is standard here.
25446 Conceptually, authentication data such as passwords are tied to the identifier
25447 used to authenticate; servers may have rules to permit one user to act as a
25448 second user, so that after login the session is treated as though that second
25449 user had logged in.  That second user is the &'authorization id'&.  A robust
25450 configuration might confirm that the &'authz'& field is empty or matches the
25451 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25452 as verified data, the &'authz'& as an unverified request which the server might
25453 choose to honour.
25454
25455 A &'realm'& is a text string, typically a domain name, presented by a server
25456 to a client to help it select an account and credentials to use.  In some
25457 mechanisms, the client and server provably agree on the realm, but clients
25458 typically can not treat the realm as secure data to be blindly trusted.
25459
25460
25461
25462 .section "Generic options for authenticators" "SECID168"
25463 .cindex "authentication" "generic options"
25464 .cindex "options" "generic; for authenticators"
25465
25466 .option client_condition authenticators string&!! unset
25467 When Exim is authenticating as a client, it skips any authenticator whose
25468 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25469 used, for example, to skip plain text authenticators when the connection is not
25470 encrypted by a setting such as:
25471 .code
25472 client_condition = ${if !eq{$tls_out_cipher}{}}
25473 .endd
25474
25475
25476 .option client_set_id authenticators string&!! unset
25477 When client authentication succeeds, this condition is expanded; the
25478 result is used in the log lines for outbound messages.
25479 Typically it will be the user name used for authentication.
25480
25481
25482 .option driver authenticators string unset
25483 This option must always be set. It specifies which of the available
25484 authenticators is to be used.
25485
25486
25487 .option public_name authenticators string unset
25488 This option specifies the name of the authentication mechanism that the driver
25489 implements, and by which it is known to the outside world. These names should
25490 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25491 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25492 defaults to the driver's instance name.
25493
25494
25495 .option server_advertise_condition authenticators string&!! unset
25496 When a server is about to advertise an authentication mechanism, the condition
25497 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25498 mechanism is not advertised.
25499 If the expansion fails, the mechanism is not advertised. If the failure was not
25500 forced, and was not caused by a lookup defer, the incident is logged.
25501 See section &<<SECTauthexiser>>& below for further discussion.
25502
25503
25504 .option server_condition authenticators string&!! unset
25505 This option must be set for a &%plaintext%& server authenticator, where it
25506 is used directly to control authentication. See section &<<SECTplainserver>>&
25507 for details.
25508
25509 For the &(gsasl)& authenticator, this option is required for various
25510 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25511
25512 For the other authenticators, &%server_condition%& can be used as an additional
25513 authentication or authorization mechanism that is applied after the other
25514 authenticator conditions succeed. If it is set, it is expanded when the
25515 authenticator would otherwise return a success code. If the expansion is forced
25516 to fail, authentication fails. Any other expansion failure causes a temporary
25517 error code to be returned. If the result of a successful expansion is an empty
25518 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25519 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25520 other result, a temporary error code is returned, with the expanded string as
25521 the error text.
25522
25523
25524 .option server_debug_print authenticators string&!! unset
25525 If this option is set and authentication debugging is enabled (see the &%-d%&
25526 command line option), the string is expanded and included in the debugging
25527 output when the authenticator is run as a server. This can help with checking
25528 out the values of variables.
25529 If expansion of the string fails, the error message is written to the debugging
25530 output, and Exim carries on processing.
25531
25532
25533 .option server_set_id authenticators string&!! unset
25534 .vindex "&$authenticated_id$&"
25535 When an Exim server successfully authenticates a client, this string is
25536 expanded using data from the authentication, and preserved for any incoming
25537 messages in the variable &$authenticated_id$&. It is also included in the log
25538 lines for incoming messages. For example, a user/password authenticator
25539 configuration might preserve the user name that was used to authenticate, and
25540 refer to it subsequently during delivery of the message.
25541 If expansion fails, the option is ignored.
25542
25543
25544 .option server_mail_auth_condition authenticators string&!! unset
25545 This option allows a server to discard authenticated sender addresses supplied
25546 as part of MAIL commands in SMTP connections that are authenticated by the
25547 driver on which &%server_mail_auth_condition%& is set. The option is not used
25548 as part of the authentication process; instead its (unexpanded) value is
25549 remembered for later use.
25550 How it is used is described in the following section.
25551
25552
25553
25554
25555
25556 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25557 .cindex "authentication" "sender; authenticated"
25558 .cindex "AUTH" "on MAIL command"
25559 When a client supplied an AUTH= item on a MAIL command, Exim applies
25560 the following checks before accepting it as the authenticated sender of the
25561 message:
25562
25563 .ilist
25564 If the connection is not using extended SMTP (that is, HELO was used rather
25565 than EHLO), the use of AUTH= is a syntax error.
25566 .next
25567 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25568 .next
25569 .vindex "&$authenticated_sender$&"
25570 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25571 running, the value of &$authenticated_sender$& is set to the value obtained
25572 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25573 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25574 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25575 given for the MAIL command.
25576 .next
25577 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25578 is accepted and placed in &$authenticated_sender$& only if the client has
25579 authenticated.
25580 .next
25581 If the AUTH= value was accepted by either of the two previous rules, and
25582 the client has authenticated, and the authenticator has a setting for the
25583 &%server_mail_auth_condition%&, the condition is checked at this point. The
25584 valued that was saved from the authenticator is expanded. If the expansion
25585 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25586 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25587 the value of &$authenticated_sender$& is retained and passed on with the
25588 message.
25589 .endlist
25590
25591
25592 When &$authenticated_sender$& is set for a message, it is passed on to other
25593 hosts to which Exim authenticates as a client. Do not confuse this value with
25594 &$authenticated_id$&, which is a string obtained from the authentication
25595 process, and which is not usually a complete email address.
25596
25597 .vindex "&$sender_address$&"
25598 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25599 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25600 therefore make use of &$authenticated_sender$&. The converse is not true: the
25601 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25602 ACL is run.
25603
25604
25605
25606 .section "Authentication on an Exim server" "SECTauthexiser"
25607 .cindex "authentication" "on an Exim server"
25608 When Exim receives an EHLO command, it advertises the public names of those
25609 authenticators that are configured as servers, subject to the following
25610 conditions:
25611
25612 .ilist
25613 The client host must match &%auth_advertise_hosts%& (default *).
25614 .next
25615 It the &%server_advertise_condition%& option is set, its expansion must not
25616 yield the empty string, &"0"&, &"no"&, or &"false"&.
25617 .endlist
25618
25619 The order in which the authenticators are defined controls the order in which
25620 the mechanisms are advertised.
25621
25622 Some mail clients (for example, some versions of Netscape) require the user to
25623 provide a name and password for authentication whenever AUTH is advertised,
25624 even though authentication may not in fact be needed (for example, Exim may be
25625 set up to allow unconditional relaying from the client by an IP address check).
25626 You can make such clients more friendly by not advertising AUTH to them.
25627 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25628 that runs for RCPT) to relay without authentication, you should set
25629 .code
25630 auth_advertise_hosts = ! 10.9.8.0/24
25631 .endd
25632 so that no authentication mechanisms are advertised to them.
25633
25634 The &%server_advertise_condition%& controls the advertisement of individual
25635 authentication mechanisms. For example, it can be used to restrict the
25636 advertisement of a particular mechanism to encrypted connections, by a setting
25637 such as:
25638 .code
25639 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25640 .endd
25641 .vindex "&$tls_in_cipher$&"
25642 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25643 yields &"yes"&, which allows the advertisement to happen.
25644
25645 When an Exim server receives an AUTH command from a client, it rejects it
25646 immediately if AUTH was not advertised in response to an earlier EHLO
25647 command. This is the case if
25648
25649 .ilist
25650 The client host does not match &%auth_advertise_hosts%&; or
25651 .next
25652 No authenticators are configured with server options; or
25653 .next
25654 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25655 server authenticators.
25656 .endlist
25657
25658
25659 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25660 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25661 AUTH is accepted from any client host.
25662
25663 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25664 server authentication mechanism that was advertised in response to EHLO and
25665 that matches the one named in the AUTH command. If it finds one, it runs
25666 the appropriate authentication protocol, and authentication either succeeds or
25667 fails. If there is no matching advertised mechanism, the AUTH command is
25668 rejected with a 504 error.
25669
25670 .vindex "&$received_protocol$&"
25671 .vindex "&$sender_host_authenticated$&"
25672 When a message is received from an authenticated host, the value of
25673 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25674 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25675 public name) of the authenticator driver that successfully authenticated the
25676 client from which the message was received. This variable is empty if there was
25677 no successful authentication.
25678
25679
25680
25681
25682 .section "Testing server authentication" "SECID169"
25683 .cindex "authentication" "testing a server"
25684 .cindex "AUTH" "testing a server"
25685 .cindex "base64 encoding" "creating authentication test data"
25686 Exim's &%-bh%& option can be useful for testing server authentication
25687 configurations. The data for the AUTH command has to be sent using base64
25688 encoding. A quick way to produce such data for testing is the following Perl
25689 script:
25690 .code
25691 use MIME::Base64;
25692 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25693 .endd
25694 .cindex "binary zero" "in authentication data"
25695 This interprets its argument as a Perl string, and then encodes it. The
25696 interpretation as a Perl string allows binary zeros, which are required for
25697 some kinds of authentication, to be included in the data. For example, a
25698 command line to run this script on such data might be
25699 .code
25700 encode '\0user\0password'
25701 .endd
25702 Note the use of single quotes to prevent the shell interpreting the
25703 backslashes, so that they can be interpreted by Perl to specify characters
25704 whose code value is zero.
25705
25706 &*Warning 1*&: If either of the user or password strings starts with an octal
25707 digit, you must use three zeros instead of one after the leading backslash. If
25708 you do not, the octal digit that starts your string will be incorrectly
25709 interpreted as part of the code for the first character.
25710
25711 &*Warning 2*&: If there are characters in the strings that Perl interprets
25712 specially, you must use a Perl escape to prevent them being misinterpreted. For
25713 example, a command such as
25714 .code
25715 encode '\0user@domain.com\0pas$$word'
25716 .endd
25717 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25718
25719 If you have the &%mimencode%& command installed, another way to do produce
25720 base64-encoded strings is to run the command
25721 .code
25722 echo -e -n `\0user\0password' | mimencode
25723 .endd
25724 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25725 in the argument, and the &%-n%& option specifies no newline at the end of its
25726 output. However, not all versions of &%echo%& recognize these options, so you
25727 should check your version before relying on this suggestion.
25728
25729
25730
25731 .section "Authentication by an Exim client" "SECID170"
25732 .cindex "authentication" "on an Exim client"
25733 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25734 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25735 announces support for authentication, and the host matches an entry in either
25736 of these options, Exim (as a client) tries to authenticate as follows:
25737
25738 .ilist
25739 For each authenticator that is configured as a client, in the order in which
25740 they are defined in the configuration, it searches the authentication
25741 mechanisms announced by the server for one whose name matches the public name
25742 of the authenticator.
25743 .next
25744 .vindex "&$host$&"
25745 .vindex "&$host_address$&"
25746 When it finds one that matches, it runs the authenticator's client code. The
25747 variables &$host$& and &$host_address$& are available for any string expansions
25748 that the client might do. They are set to the server's name and IP address. If
25749 any expansion is forced to fail, the authentication attempt is abandoned, and
25750 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25751 delivery to be deferred.
25752 .next
25753 If the result of the authentication attempt is a temporary error or a timeout,
25754 Exim abandons trying to send the message to the host for the moment. It will
25755 try again later. If there are any backup hosts available, they are tried in the
25756 usual way.
25757 .next
25758 If the response to authentication is a permanent error (5&'xx'& code), Exim
25759 carries on searching the list of authenticators and tries another one if
25760 possible. If all authentication attempts give permanent errors, or if there are
25761 no attempts because no mechanisms match (or option expansions force failure),
25762 what happens depends on whether the host matches &%hosts_require_auth%& or
25763 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25764 delivery is deferred. The error can be detected in the retry rules, and thereby
25765 turned into a permanent error if you wish. In the second case, Exim tries to
25766 deliver the message unauthenticated.
25767 .endlist
25768
25769 .cindex "AUTH" "on MAIL command"
25770 When Exim has authenticated itself to a remote server, it adds the AUTH
25771 parameter to the MAIL commands it sends, if it has an authenticated sender for
25772 the message. If the message came from a remote host, the authenticated sender
25773 is the one that was receiving on an incoming MAIL command, provided that the
25774 incoming connection was authenticated and the &%server_mail_auth%& condition
25775 allowed the authenticated sender to be retained. If a local process calls Exim
25776 to send a message, the sender address that is built from the login name and
25777 &%qualify_domain%& is treated as authenticated. However, if the
25778 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25779 the authenticated sender that was received with the message.
25780 .ecindex IIDauthconf1
25781 .ecindex IIDauthconf2
25782
25783
25784
25785
25786
25787
25788 . ////////////////////////////////////////////////////////////////////////////
25789 . ////////////////////////////////////////////////////////////////////////////
25790
25791 .chapter "The plaintext authenticator" "CHAPplaintext"
25792 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25793 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25794 The &(plaintext)& authenticator can be configured to support the PLAIN and
25795 LOGIN authentication mechanisms, both of which transfer authentication data as
25796 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25797 security risk; you are strongly advised to insist on the use of SMTP encryption
25798 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25799 use unencrypted plain text, you should not use the same passwords for SMTP
25800 connections as you do for login accounts.
25801
25802 .section "Plaintext options" "SECID171"
25803 .cindex "options" "&(plaintext)& authenticator (server)"
25804 When configured as a server, &(plaintext)& uses the following options:
25805
25806 .option server_condition authenticators string&!! unset
25807 This is actually a global authentication option, but it must be set in order to
25808 configure the &(plaintext)& driver as a server. Its use is described below.
25809
25810 .option server_prompts plaintext string&!! unset
25811 The contents of this option, after expansion, must be a colon-separated list of
25812 prompt strings. If expansion fails, a temporary authentication rejection is
25813 given.
25814
25815 .section "Using plaintext in a server" "SECTplainserver"
25816 .cindex "AUTH" "in &(plaintext)& authenticator"
25817 .cindex "binary zero" "in &(plaintext)& authenticator"
25818 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25819         "in &(plaintext)& authenticator"
25820 .vindex "&$auth1$&, &$auth2$&, etc"
25821 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25822
25823 When running as a server, &(plaintext)& performs the authentication test by
25824 expanding a string. The data sent by the client with the AUTH command, or in
25825 response to subsequent prompts, is base64 encoded, and so may contain any byte
25826 values when decoded. If any data is supplied with the command, it is treated as
25827 a list of strings, separated by NULs (binary zeros), the first three of which
25828 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25829 (neither LOGIN nor PLAIN uses more than three strings).
25830
25831 For compatibility with previous releases of Exim, the values are also placed in
25832 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25833 variables for this purpose is now deprecated, as it can lead to confusion in
25834 string expansions that also use them for other things.
25835
25836 If there are more strings in &%server_prompts%& than the number of strings
25837 supplied with the AUTH command, the remaining prompts are used to obtain more
25838 data. Each response from the client may be a list of NUL-separated strings.
25839
25840 .vindex "&$authenticated_id$&"
25841 Once a sufficient number of data strings have been received,
25842 &%server_condition%& is expanded. If the expansion is forced to fail,
25843 authentication fails. Any other expansion failure causes a temporary error code
25844 to be returned. If the result of a successful expansion is an empty string,
25845 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25846 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25847 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25848 For any other result, a temporary error code is returned, with the expanded
25849 string as the error text
25850
25851 &*Warning*&: If you use a lookup in the expansion to find the user's
25852 password, be sure to make the authentication fail if the user is unknown.
25853 There are good and bad examples at the end of the next section.
25854
25855
25856
25857 .section "The PLAIN authentication mechanism" "SECID172"
25858 .cindex "PLAIN authentication mechanism"
25859 .cindex "authentication" "PLAIN mechanism"
25860 .cindex "binary zero" "in &(plaintext)& authenticator"
25861 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25862 sent as one item of data (that is, one combined string containing two NUL
25863 separators). The data is sent either as part of the AUTH command, or
25864 subsequently in response to an empty prompt from the server.
25865
25866 The second and third strings are a user name and a corresponding password.
25867 Using a single fixed user name and password as an example, this could be
25868 configured as follows:
25869 .code
25870 fixed_plain:
25871   driver = plaintext
25872   public_name = PLAIN
25873   server_prompts = :
25874   server_condition = \
25875     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25876   server_set_id = $auth2
25877 .endd
25878 Note that the default result strings from &%if%& (&"true"& or an empty string)
25879 are exactly what we want here, so they need not be specified. Obviously, if the
25880 password contains expansion-significant characters such as dollar, backslash,
25881 or closing brace, they have to be escaped.
25882
25883 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25884 the end of a string list are ignored). If all the data comes as part of the
25885 AUTH command, as is commonly the case, the prompt is not used. This
25886 authenticator is advertised in the response to EHLO as
25887 .code
25888 250-AUTH PLAIN
25889 .endd
25890 and a client host can authenticate itself by sending the command
25891 .code
25892 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25893 .endd
25894 As this contains three strings (more than the number of prompts), no further
25895 data is required from the client. Alternatively, the client may just send
25896 .code
25897 AUTH PLAIN
25898 .endd
25899 to initiate authentication, in which case the server replies with an empty
25900 prompt. The client must respond with the combined data string.
25901
25902 The data string is base64 encoded, as required by the RFC. This example,
25903 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25904 represents a zero byte. This is split up into three strings, the first of which
25905 is empty. The &%server_condition%& option in the authenticator checks that the
25906 second two are &`username`& and &`mysecret`& respectively.
25907
25908 Having just one fixed user name and password, as in this example, is not very
25909 realistic, though for a small organization with only a handful of
25910 authenticating clients it could make sense.
25911
25912 A more sophisticated instance of this authenticator could use the user name in
25913 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25914 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25915 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25916 This is an incorrect example:
25917 .code
25918 server_condition = \
25919   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25920 .endd
25921 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25922 which it then compares to the supplied password (&$auth3$&). Why is this example
25923 incorrect? It works fine for existing users, but consider what happens if a
25924 non-existent user name is given. The lookup fails, but as no success/failure
25925 strings are given for the lookup, it yields an empty string. Thus, to defeat
25926 the authentication, all a client has to do is to supply a non-existent user
25927 name and an empty password. The correct way of writing this test is:
25928 .code
25929 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25930   {${if eq{$value}{$auth3}}} {false}}
25931 .endd
25932 In this case, if the lookup succeeds, the result is checked; if the lookup
25933 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25934 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25935 always fails if its second argument is empty. However, the second way of
25936 writing the test makes the logic clearer.
25937
25938
25939 .section "The LOGIN authentication mechanism" "SECID173"
25940 .cindex "LOGIN authentication mechanism"
25941 .cindex "authentication" "LOGIN mechanism"
25942 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25943 in a number of programs. No data is sent with the AUTH command. Instead, a
25944 user name and password are supplied separately, in response to prompts. The
25945 plaintext authenticator can be configured to support this as in this example:
25946 .code
25947 fixed_login:
25948   driver = plaintext
25949   public_name = LOGIN
25950   server_prompts = User Name : Password
25951   server_condition = \
25952     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25953   server_set_id = $auth1
25954 .endd
25955 Because of the way plaintext operates, this authenticator accepts data supplied
25956 with the AUTH command (in contravention of the specification of LOGIN), but
25957 if the client does not supply it (as is the case for LOGIN clients), the prompt
25958 strings are used to obtain two data items.
25959
25960 Some clients are very particular about the precise text of the prompts. For
25961 example, Outlook Express is reported to recognize only &"Username:"& and
25962 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25963 strings. It uses the &%ldapauth%& expansion condition to check the user
25964 name and password by binding to an LDAP server:
25965 .code
25966 login:
25967   driver = plaintext
25968   public_name = LOGIN
25969   server_prompts = Username:: : Password::
25970   server_condition = ${if and{{ \
25971     !eq{}{$auth1} }{ \
25972     ldapauth{\
25973       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25974       pass=${quote:$auth2} \
25975       ldap://ldap.example.org/} }} }
25976   server_set_id = uid=$auth1,ou=people,o=example.org
25977 .endd
25978 We have to check that the username is not empty before using it, because LDAP
25979 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25980 operator to correctly quote the DN for authentication. However, the basic
25981 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25982 correct one to use for the password, because quoting is needed only to make
25983 the password conform to the Exim syntax. At the LDAP level, the password is an
25984 uninterpreted string.
25985
25986
25987 .section "Support for different kinds of authentication" "SECID174"
25988 A number of string expansion features are provided for the purpose of
25989 interfacing to different ways of user authentication. These include checking
25990 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25991 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25992 &<<SECTexpcond>>&.
25993
25994
25995
25996
25997 .section "Using plaintext in a client" "SECID175"
25998 .cindex "options" "&(plaintext)& authenticator (client)"
25999 The &(plaintext)& authenticator has two client options:
26000
26001 .option client_ignore_invalid_base64 plaintext boolean false
26002 If the client receives a server prompt that is not a valid base64 string,
26003 authentication is abandoned by default. However, if this option is set true,
26004 the error in the challenge is ignored and the client sends the response as
26005 usual.
26006
26007 .option client_send plaintext string&!! unset
26008 The string is a colon-separated list of authentication data strings. Each
26009 string is independently expanded before being sent to the server. The first
26010 string is sent with the AUTH command; any more strings are sent in response
26011 to prompts from the server. Before each string is expanded, the value of the
26012 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26013 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26014 way. Thus, the prompt that is received in response to sending the first string
26015 (with the AUTH command) can be used in the expansion of the second string, and
26016 so on. If an invalid base64 string is received when
26017 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26018 &$auth$&<&'n'&> variable.
26019
26020 &*Note*&: You cannot use expansion to create multiple strings, because
26021 splitting takes priority and happens first.
26022
26023 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26024 the data, further processing is applied to each string before it is sent. If
26025 there are any single circumflex characters in the string, they are converted to
26026 NULs. Should an actual circumflex be required as data, it must be doubled in
26027 the string.
26028
26029 This is an example of a client configuration that implements the PLAIN
26030 authentication mechanism with a fixed user name and password:
26031 .code
26032 fixed_plain:
26033   driver = plaintext
26034   public_name = PLAIN
26035   client_send = ^username^mysecret
26036 .endd
26037 The lack of colons means that the entire text is sent with the AUTH
26038 command, with the circumflex characters converted to NULs. A similar example
26039 that uses the LOGIN mechanism is:
26040 .code
26041 fixed_login:
26042   driver = plaintext
26043   public_name = LOGIN
26044   client_send = : username : mysecret
26045 .endd
26046 The initial colon means that the first string is empty, so no data is sent with
26047 the AUTH command itself. The remaining strings are sent in response to
26048 prompts.
26049 .ecindex IIDplaiauth1
26050 .ecindex IIDplaiauth2
26051
26052
26053
26054
26055 . ////////////////////////////////////////////////////////////////////////////
26056 . ////////////////////////////////////////////////////////////////////////////
26057
26058 .chapter "The cram_md5 authenticator" "CHID9"
26059 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26060 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26061 .cindex "CRAM-MD5 authentication mechanism"
26062 .cindex "authentication" "CRAM-MD5 mechanism"
26063 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26064 sends a challenge string to the client, and the response consists of a user
26065 name and the CRAM-MD5 digest of the challenge string combined with a secret
26066 string (password) which is known to both server and client. Thus, the secret
26067 is not sent over the network as plain text, which makes this authenticator more
26068 secure than &(plaintext)&. However, the downside is that the secret has to be
26069 available in plain text at either end.
26070
26071
26072 .section "Using cram_md5 as a server" "SECID176"
26073 .cindex "options" "&(cram_md5)& authenticator (server)"
26074 This authenticator has one server option, which must be set to configure the
26075 authenticator as a server:
26076
26077 .option server_secret cram_md5 string&!! unset
26078 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26079 When the server receives the client's response, the user name is placed in
26080 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26081 obtain the password for that user. The server then computes the CRAM-MD5 digest
26082 that the client should have sent, and checks that it received the correct
26083 string. If the expansion of &%server_secret%& is forced to fail, authentication
26084 fails. If the expansion fails for some other reason, a temporary error code is
26085 returned to the client.
26086
26087 For compatibility with previous releases of Exim, the user name is also placed
26088 in &$1$&. However, the use of this variables for this purpose is now
26089 deprecated, as it can lead to confusion in string expansions that also use
26090 numeric variables for other things.
26091
26092 For example, the following authenticator checks that the user name given by the
26093 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26094 user name, authentication fails.
26095 .code
26096 fixed_cram:
26097   driver = cram_md5
26098   public_name = CRAM-MD5
26099   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26100   server_set_id = $auth1
26101 .endd
26102 .vindex "&$authenticated_id$&"
26103 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26104 name in &$authenticated_id$&. A more typical configuration might look up the
26105 secret string in a file, using the user name as the key. For example:
26106 .code
26107 lookup_cram:
26108   driver = cram_md5
26109   public_name = CRAM-MD5
26110   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26111                   {$value}fail}
26112   server_set_id = $auth1
26113 .endd
26114 Note that this expansion explicitly forces failure if the lookup fails
26115 because &$auth1$& contains an unknown user name.
26116
26117 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26118 using the relevant libraries, you need to know the realm to specify in the
26119 lookup and then ask for the &"userPassword"& attribute for that user in that
26120 realm, with:
26121 .code
26122 cyrusless_crammd5:
26123   driver = cram_md5
26124   public_name = CRAM-MD5
26125   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26126                   dbmjz{/etc/sasldb2}{$value}fail}
26127   server_set_id = $auth1
26128 .endd
26129
26130 .section "Using cram_md5 as a client" "SECID177"
26131 .cindex "options" "&(cram_md5)& authenticator (client)"
26132 When used as a client, the &(cram_md5)& authenticator has two options:
26133
26134
26135
26136 .option client_name cram_md5 string&!! "the primary host name"
26137 This string is expanded, and the result used as the user name data when
26138 computing the response to the server's challenge.
26139
26140
26141 .option client_secret cram_md5 string&!! unset
26142 This option must be set for the authenticator to work as a client. Its value is
26143 expanded and the result used as the secret string when computing the response.
26144
26145
26146 .vindex "&$host$&"
26147 .vindex "&$host_address$&"
26148 Different user names and secrets can be used for different servers by referring
26149 to &$host$& or &$host_address$& in the options. Forced failure of either
26150 expansion string is treated as an indication that this authenticator is not
26151 prepared to handle this case. Exim moves on to the next configured client
26152 authenticator. Any other expansion failure causes Exim to give up trying to
26153 send the message to the current server.
26154
26155 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26156 strings, is:
26157 .code
26158 fixed_cram:
26159   driver = cram_md5
26160   public_name = CRAM-MD5
26161   client_name = ph10
26162   client_secret = secret
26163 .endd
26164 .ecindex IIDcramauth1
26165 .ecindex IIDcramauth2
26166
26167
26168
26169 . ////////////////////////////////////////////////////////////////////////////
26170 . ////////////////////////////////////////////////////////////////////////////
26171
26172 .chapter "The cyrus_sasl authenticator" "CHID10"
26173 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26174 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26175 .cindex "Cyrus" "SASL library"
26176 .cindex "Kerberos"
26177 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26178 Digital Ltd (&url(http://www.aldigital.co.uk)).
26179
26180 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26181 library implementation of the RFC 2222 (&"Simple Authentication and Security
26182 Layer"&). This library supports a number of authentication mechanisms,
26183 including PLAIN and LOGIN, but also several others that Exim does not support
26184 directly. In particular, there is support for Kerberos authentication.
26185
26186 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26187 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26188 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26189 name of the driver to determine which mechanism to support.
26190
26191 Where access to some kind of secret file is required, for example in GSSAPI
26192 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26193 user, and that the Cyrus SASL library has no way of escalating privileges
26194 by default. You may also find you need to set environment variables,
26195 depending on the driver you are using.
26196
26197 The application name provided by Exim is &"exim"&, so various SASL options may
26198 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26199 Kerberos, note that because of limitations in the GSSAPI interface,
26200 changing the server keytab might need to be communicated down to the Kerberos
26201 layer independently. The mechanism for doing so is dependent upon the Kerberos
26202 implementation.
26203
26204 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26205 may be set to point to an alternative keytab file. Exim will pass this
26206 variable through from its own inherited environment when started as root or the
26207 Exim user. The keytab file needs to be readable by the Exim user.
26208 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26209 environment variable.  In practice, for those releases, the Cyrus authenticator
26210 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26211 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26212
26213
26214 .section "Using cyrus_sasl as a server" "SECID178"
26215 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26216 (on a successful authentication) into &$auth1$&. For compatibility with
26217 previous releases of Exim, the username is also placed in &$1$&. However, the
26218 use of this variable for this purpose is now deprecated, as it can lead to
26219 confusion in string expansions that also use numeric variables for other
26220 things.
26221
26222
26223 .option server_hostname cyrus_sasl string&!! "see below"
26224 This option selects the hostname that is used when communicating with the
26225 library. The default value is &`$primary_hostname`&. It is up to the underlying
26226 SASL plug-in what it does with this data.
26227
26228
26229 .option server_mech cyrus_sasl string "see below"
26230 This option selects the authentication mechanism this driver should use. The
26231 default is the value of the generic &%public_name%& option. This option allows
26232 you to use a different underlying mechanism from the advertised name. For
26233 example:
26234 .code
26235 sasl:
26236   driver = cyrus_sasl
26237   public_name = X-ANYTHING
26238   server_mech = CRAM-MD5
26239   server_set_id = $auth1
26240 .endd
26241
26242 .option server_realm cyrus_sasl string&!! unset
26243 This specifies the SASL realm that the server claims to be in.
26244
26245
26246 .option server_service cyrus_sasl string &`smtp`&
26247 This is the SASL service that the server claims to implement.
26248
26249
26250 For straightforward cases, you do not need to set any of the authenticator's
26251 private options. All you need to do is to specify an appropriate mechanism as
26252 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26253 PLAIN, you could have two authenticators as follows:
26254 .code
26255 sasl_cram_md5:
26256   driver = cyrus_sasl
26257   public_name = CRAM-MD5
26258   server_set_id = $auth1
26259
26260 sasl_plain:
26261   driver = cyrus_sasl
26262   public_name = PLAIN
26263   server_set_id = $auth2
26264 .endd
26265 Cyrus SASL does implement the LOGIN authentication method, even though it is
26266 not a standard method. It is disabled by default in the source distribution,
26267 but it is present in many binary distributions.
26268 .ecindex IIDcyrauth1
26269 .ecindex IIDcyrauth2
26270
26271
26272
26273
26274 . ////////////////////////////////////////////////////////////////////////////
26275 . ////////////////////////////////////////////////////////////////////////////
26276 .chapter "The dovecot authenticator" "CHAPdovecot"
26277 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26278 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26279 This authenticator is an interface to the authentication facility of the
26280 Dovecot POP/IMAP server, which can support a number of authentication methods.
26281 Note that Dovecot must be configured to use auth-client not auth-userdb.
26282 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26283 to use the same mechanisms for SMTP authentication. This is a server
26284 authenticator only. There is only one option:
26285
26286 .option server_socket dovecot string unset
26287
26288 This option must specify the socket that is the interface to Dovecot
26289 authentication. The &%public_name%& option must specify an authentication
26290 mechanism that Dovecot is configured to support. You can have several
26291 authenticators for different mechanisms. For example:
26292 .code
26293 dovecot_plain:
26294   driver = dovecot
26295   public_name = PLAIN
26296   server_socket = /var/run/dovecot/auth-client
26297   server_set_id = $auth1
26298
26299 dovecot_ntlm:
26300   driver = dovecot
26301   public_name = NTLM
26302   server_socket = /var/run/dovecot/auth-client
26303   server_set_id = $auth1
26304 .endd
26305 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26306 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26307 option is passed in the Dovecot authentication command. If, for a TLS
26308 connection, a client certificate has been verified, the &"valid-client-cert"&
26309 option is passed. When authentication succeeds, the identity of the user
26310 who authenticated is placed in &$auth1$&.
26311 .ecindex IIDdcotauth1
26312 .ecindex IIDdcotauth2
26313
26314
26315 . ////////////////////////////////////////////////////////////////////////////
26316 . ////////////////////////////////////////////////////////////////////////////
26317 .chapter "The gsasl authenticator" "CHAPgsasl"
26318 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26319 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26320 .cindex "authentication" "GNU SASL"
26321 .cindex "authentication" "SASL"
26322 .cindex "authentication" "EXTERNAL"
26323 .cindex "authentication" "ANONYMOUS"
26324 .cindex "authentication" "PLAIN"
26325 .cindex "authentication" "LOGIN"
26326 .cindex "authentication" "DIGEST-MD5"
26327 .cindex "authentication" "CRAM-MD5"
26328 .cindex "authentication" "SCRAM-SHA-1"
26329 The &(gsasl)& authenticator provides server integration for the GNU SASL
26330 library and the mechanisms it provides.  This is new as of the 4.80 release
26331 and there are a few areas where the library does not let Exim smoothly
26332 scale to handle future authentication mechanisms, so no guarantee can be
26333 made that any particular new authentication mechanism will be supported
26334 without code changes in Exim.
26335
26336
26337 .option server_channelbinding gsasl boolean false
26338 Some authentication mechanisms are able to use external context at both ends
26339 of the session to bind the authentication to that context, and fail the
26340 authentication process if that context differs.  Specifically, some TLS
26341 ciphersuites can provide identifying information about the cryptographic
26342 context.
26343
26344 This means that certificate identity and verification becomes a non-issue,
26345 as a man-in-the-middle attack will cause the correct client and server to
26346 see different identifiers and authentication will fail.
26347
26348 This is currently only supported when using the GnuTLS library.  This is
26349 only usable by mechanisms which support "channel binding"; at time of
26350 writing, that's the SCRAM family.
26351
26352 This defaults off to ensure smooth upgrade across Exim releases, in case
26353 this option causes some clients to start failing.  Some future release
26354 of Exim may switch the default to be true.
26355
26356
26357 .option server_hostname gsasl string&!! "see below"
26358 This option selects the hostname that is used when communicating with the
26359 library. The default value is &`$primary_hostname`&.
26360 Some mechanisms will use this data.
26361
26362
26363 .option server_mech gsasl string "see below"
26364 This option selects the authentication mechanism this driver should use. The
26365 default is the value of the generic &%public_name%& option. This option allows
26366 you to use a different underlying mechanism from the advertised name. For
26367 example:
26368 .code
26369 sasl:
26370   driver = gsasl
26371   public_name = X-ANYTHING
26372   server_mech = CRAM-MD5
26373   server_set_id = $auth1
26374 .endd
26375
26376
26377 .option server_password gsasl string&!! unset
26378 Various mechanisms need access to the cleartext password on the server, so
26379 that proof-of-possession can be demonstrated on the wire, without sending
26380 the password itself.
26381
26382 The data available for lookup varies per mechanism.
26383 In all cases, &$auth1$& is set to the &'authentication id'&.
26384 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26385 if available, else the empty string.
26386 The &$auth3$& variable will always be the &'realm'& if available,
26387 else the empty string.
26388
26389 A forced failure will cause authentication to defer.
26390
26391 If using this option, it may make sense to set the &%server_condition%&
26392 option to be simply "true".
26393
26394
26395 .option server_realm gsasl string&!! unset
26396 This specifies the SASL realm that the server claims to be in.
26397 Some mechanisms will use this data.
26398
26399
26400 .option server_scram_iter gsasl string&!! unset
26401 This option provides data for the SCRAM family of mechanisms.
26402 &$auth1$& is not available at evaluation time.
26403 (This may change, as we receive feedback on use)
26404
26405
26406 .option server_scram_salt gsasl string&!! unset
26407 This option provides data for the SCRAM family of mechanisms.
26408 &$auth1$& is not available at evaluation time.
26409 (This may change, as we receive feedback on use)
26410
26411
26412 .option server_service gsasl string &`smtp`&
26413 This is the SASL service that the server claims to implement.
26414 Some mechanisms will use this data.
26415
26416
26417 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26418 .vindex "&$auth1$&, &$auth2$&, etc"
26419 These may be set when evaluating specific options, as detailed above.
26420 They will also be set when evaluating &%server_condition%&.
26421
26422 Unless otherwise stated below, the &(gsasl)& integration will use the following
26423 meanings for these variables:
26424
26425 .ilist
26426 .vindex "&$auth1$&"
26427 &$auth1$&: the &'authentication id'&
26428 .next
26429 .vindex "&$auth2$&"
26430 &$auth2$&: the &'authorization id'&
26431 .next
26432 .vindex "&$auth3$&"
26433 &$auth3$&: the &'realm'&
26434 .endlist
26435
26436 On a per-mechanism basis:
26437
26438 .ilist
26439 .cindex "authentication" "EXTERNAL"
26440 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26441 the &%server_condition%& option must be present.
26442 .next
26443 .cindex "authentication" "ANONYMOUS"
26444 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26445 the &%server_condition%& option must be present.
26446 .next
26447 .cindex "authentication" "GSSAPI"
26448 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26449 &$auth2$& will be set to the &'authorization id'&,
26450 the &%server_condition%& option must be present.
26451 .endlist
26452
26453 An &'anonymous token'& is something passed along as an unauthenticated
26454 identifier; this is analogous to FTP anonymous authentication passing an
26455 email address, or software-identifier@, as the "password".
26456
26457
26458 An example showing the password having the realm specified in the callback
26459 and demonstrating a Cyrus SASL to GSASL migration approach is:
26460 .code
26461 gsasl_cyrusless_crammd5:
26462   driver = gsasl
26463   public_name = CRAM-MD5
26464   server_realm = imap.example.org
26465   server_password = ${lookup{$auth1:$auth3:userPassword}\
26466                     dbmjz{/etc/sasldb2}{$value}fail}
26467   server_set_id = ${quote:$auth1}
26468   server_condition = yes
26469 .endd
26470
26471
26472 . ////////////////////////////////////////////////////////////////////////////
26473 . ////////////////////////////////////////////////////////////////////////////
26474
26475 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26476 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26477 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26478 .cindex "authentication" "GSSAPI"
26479 .cindex "authentication" "Kerberos"
26480 The &(heimdal_gssapi)& authenticator provides server integration for the
26481 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26482 reliably.
26483
26484 .option server_hostname heimdal_gssapi string&!! "see below"
26485 This option selects the hostname that is used, with &%server_service%&,
26486 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26487 identifier.  The default value is &`$primary_hostname`&.
26488
26489 .option server_keytab heimdal_gssapi string&!! unset
26490 If set, then Heimdal will not use the system default keytab (typically
26491 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26492 The value should be a pathname, with no &"file:"& prefix.
26493
26494 .option server_service heimdal_gssapi string&!! "smtp"
26495 This option specifies the service identifier used, in conjunction with
26496 &%server_hostname%&, for building the identifier for finding credentials
26497 from the keytab.
26498
26499
26500 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26501 Beware that these variables will typically include a realm, thus will appear
26502 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26503 not verified, so a malicious client can set it to anything.
26504
26505 The &$auth1$& field should be safely trustable as a value from the Key
26506 Distribution Center.  Note that these are not quite email addresses.
26507 Each identifier is for a role, and so the left-hand-side may include a
26508 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26509
26510 .vindex "&$auth1$&, &$auth2$&, etc"
26511 .ilist
26512 .vindex "&$auth1$&"
26513 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26514 .next
26515 .vindex "&$auth2$&"
26516 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26517 authentication.  If that was empty, this will also be set to the
26518 GSS Display Name.
26519 .endlist
26520
26521
26522 . ////////////////////////////////////////////////////////////////////////////
26523 . ////////////////////////////////////////////////////////////////////////////
26524
26525 .chapter "The spa authenticator" "CHAPspa"
26526 .scindex IIDspaauth1 "&(spa)& authenticator"
26527 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26528 .cindex "authentication" "Microsoft Secure Password"
26529 .cindex "authentication" "NTLM"
26530 .cindex "Microsoft Secure Password Authentication"
26531 .cindex "NTLM authentication"
26532 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26533 Password Authentication'& mechanism,
26534 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26535 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26536 taken from the Samba project (&url(http://www.samba.org)). The code for the
26537 server side was subsequently contributed by Tom Kistner. The mechanism works as
26538 follows:
26539
26540 .ilist
26541 After the AUTH command has been accepted, the client sends an SPA
26542 authentication request based on the user name and optional domain.
26543 .next
26544 The server sends back a challenge.
26545 .next
26546 The client builds a challenge response which makes use of the user's password
26547 and sends it to the server, which then accepts or rejects it.
26548 .endlist
26549
26550 Encryption is used to protect the password in transit.
26551
26552
26553
26554 .section "Using spa as a server" "SECID179"
26555 .cindex "options" "&(spa)& authenticator (server)"
26556 The &(spa)& authenticator has just one server option:
26557
26558 .option server_password spa string&!! unset
26559 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26560 This option is expanded, and the result must be the cleartext password for the
26561 authenticating user, whose name is at this point in &$auth1$&. For
26562 compatibility with previous releases of Exim, the user name is also placed in
26563 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26564 it can lead to confusion in string expansions that also use numeric variables
26565 for other things. For example:
26566 .code
26567 spa:
26568   driver = spa
26569   public_name = NTLM
26570   server_password = \
26571     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26572 .endd
26573 If the expansion is forced to fail, authentication fails. Any other expansion
26574 failure causes a temporary error code to be returned.
26575
26576
26577
26578
26579
26580 .section "Using spa as a client" "SECID180"
26581 .cindex "options" "&(spa)& authenticator (client)"
26582 The &(spa)& authenticator has the following client options:
26583
26584
26585
26586 .option client_domain spa string&!! unset
26587 This option specifies an optional domain for the authentication.
26588
26589
26590 .option client_password spa string&!! unset
26591 This option specifies the user's password, and must be set.
26592
26593
26594 .option client_username spa string&!! unset
26595 This option specifies the user name, and must be set. Here is an example of a
26596 configuration of this authenticator for use with the mail servers at
26597 &'msn.com'&:
26598 .code
26599 msn:
26600   driver = spa
26601   public_name = MSN
26602   client_username = msn/msn_username
26603   client_password = msn_plaintext_password
26604   client_domain = DOMAIN_OR_UNSET
26605 .endd
26606 .ecindex IIDspaauth1
26607 .ecindex IIDspaauth2
26608
26609
26610
26611
26612
26613 . ////////////////////////////////////////////////////////////////////////////
26614 . ////////////////////////////////////////////////////////////////////////////
26615
26616 .chapter "The tls authenticator" "CHAPtlsauth"
26617 .scindex IIDtlsauth1 "&(tls)& authenticator"
26618 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26619 .cindex "authentication" "Client Certificate"
26620 .cindex "authentication" "X509"
26621 .cindex "Certificate-based authentication"
26622 The &(tls)& authenticator provides server support for
26623 authentication based on client certificates.
26624
26625 It is not an SMTP authentication mechanism and is not
26626 advertised by the server as part of the SMTP EHLO response.
26627 It is an Exim authenticator in the sense that it affects
26628 the protocol element of the log line, can be tested for
26629 by the &%authenticated%& ACL condition, and can set
26630 the &$authenticated_id$& variable.
26631
26632 The client must present a verifiable certificate,
26633 for which it must have been requested via the
26634 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26635 (see &<<CHAPTLS>>&).
26636
26637 If an authenticator of this type is configured it is
26638 run before any SMTP-level communication is done,
26639 and can authenticate the connection.
26640 If it does, SMTP authentication is not offered.
26641
26642 A maximum of one authenticator of this type may be present.
26643
26644
26645 .cindex "options" "&(tls)& authenticator (server)"
26646 The &(tls)& authenticator has three server options:
26647
26648 .option server_param1 tls string&!! unset
26649 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26650 This option is expanded after the TLS negotiation and
26651 the result is placed in &$auth1$&.
26652 If the expansion is forced to fail, authentication fails. Any other expansion
26653 failure causes a temporary error code to be returned.
26654
26655 .option server_param2 tls string&!! unset
26656 .option server_param3 tls string&!! unset
26657 As above, for &$auth2$& and &$auth3$&.
26658
26659 &%server_param1%& may also be spelled &%server_param%&.
26660
26661
26662 Example:
26663 .code
26664 tls:
26665   driver = tls
26666   server_param1 =     ${certextract {subj_altname,mail,>:} \
26667                                     {$tls_in_peercert}}
26668   server_condition =  ${if forany {$auth1} \
26669                             {!= {0} \
26670                                 {${lookup ldap{ldap:///\
26671                          mailname=${quote_ldap_dn:${lc:$item}},\
26672                          ou=users,LDAP_DC?mailid} {$value}{0} \
26673                        }    }   } }
26674   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26675 .endd
26676 This accepts a client certificate that is verifiable against any
26677 of your configured trust-anchors
26678 which usually means the full set of public CAs)
26679 and which has a SAN with a good account name.
26680 Note that the client cert is on the wire in-clear, including the SAN,
26681 whereas a plaintext SMTP AUTH done inside TLS is not.
26682
26683 . An alternative might use
26684 . .code
26685 .   server_param1 = ${sha256:$tls_in_peercert}
26686 . .endd
26687 . to require one of a set of specific certs that define a given account
26688 . (the verification is still required, but mostly irrelevant).
26689 . This would help for per-device use.
26690 .
26691 . However, for the future we really need support for checking a
26692 . user cert in LDAP - which probably wants a base-64 DER.
26693
26694 .ecindex IIDtlsauth1
26695 .ecindex IIDtlsauth2
26696
26697
26698 Note that because authentication is traditionally an SMTP operation,
26699 the &%authenticated%& ACL condition cannot be used in
26700 a connect- or helo-ACL.
26701
26702
26703
26704 . ////////////////////////////////////////////////////////////////////////////
26705 . ////////////////////////////////////////////////////////////////////////////
26706
26707 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26708          "Encrypted SMTP connections"
26709 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26710 .scindex IIDencsmtp2 "SMTP" "encryption"
26711 .cindex "TLS" "on SMTP connection"
26712 .cindex "OpenSSL"
26713 .cindex "GnuTLS"
26714 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26715 Sockets Layer), is implemented by making use of the OpenSSL library or the
26716 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26717 cryptographic code in the Exim distribution itself for implementing TLS. In
26718 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26719 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26720 You also need to understand the basic concepts of encryption at a managerial
26721 level, and in particular, the way that public keys, private keys, and
26722 certificates are used.
26723
26724 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26725 connection is established, the client issues a STARTTLS command. If the
26726 server accepts this, the client and the server negotiate an encryption
26727 mechanism. If the negotiation succeeds, the data that subsequently passes
26728 between them is encrypted.
26729
26730 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26731 and if so, what cipher suite is in use, whether the client supplied a
26732 certificate, and whether or not that certificate was verified. This makes it
26733 possible for an Exim server to deny or accept certain commands based on the
26734 encryption state.
26735
26736 &*Warning*&: Certain types of firewall and certain anti-virus products can
26737 disrupt TLS connections. You need to turn off SMTP scanning for these products
26738 in order to get TLS to work.
26739
26740
26741
26742 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26743          "SECID284"
26744 .cindex "ssmtp protocol"
26745 .cindex "smtps protocol"
26746 .cindex "SMTP" "ssmtp protocol"
26747 .cindex "SMTP" "smtps protocol"
26748 Early implementations of encrypted SMTP used a different TCP port from normal
26749 SMTP, and expected an encryption negotiation to start immediately, instead of
26750 waiting for a STARTTLS command from the client using the standard SMTP
26751 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26752 allocated for this purpose.
26753
26754 This approach was abandoned when encrypted SMTP was standardized, but there are
26755 still some legacy clients that use it. Exim supports these clients by means of
26756 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26757 numbers; the most common use is expected to be:
26758 .code
26759 tls_on_connect_ports = 465
26760 .endd
26761 The port numbers specified by this option apply to all SMTP connections, both
26762 via the daemon and via &'inetd'&. You still need to specify all the ports that
26763 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26764 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26765 an extra port &-- rather, it specifies different behaviour on a port that is
26766 defined elsewhere.
26767
26768 There is also a &%-tls-on-connect%& command line option. This overrides
26769 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26770
26771
26772
26773
26774
26775
26776 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26777 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26778 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26779 followed later, when the first versions of GnuTLS were released. To build Exim
26780 to use GnuTLS, you need to set
26781 .code
26782 USE_GNUTLS=yes
26783 .endd
26784 in Local/Makefile, in addition to
26785 .code
26786 SUPPORT_TLS=yes
26787 .endd
26788 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26789 include files and libraries for GnuTLS can be found.
26790
26791 There are some differences in usage when using GnuTLS instead of OpenSSL:
26792
26793 .ilist
26794 The &%tls_verify_certificates%& option
26795 cannot be the path of a directory
26796 for GnuTLS versions before 3.3.6
26797 (for later versions, or OpenSSL, it can be either).
26798 .next
26799 The default value for &%tls_dhparam%& differs for historical reasons.
26800 .next
26801 .vindex "&$tls_in_peerdn$&"
26802 .vindex "&$tls_out_peerdn$&"
26803 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26804 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26805 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26806 .next
26807 OpenSSL identifies cipher suites using hyphens as separators, for example:
26808 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26809 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26810 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26811 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26812 to handle its own older variants) when processing lists of cipher suites in the
26813 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26814 option).
26815 .next
26816 The &%tls_require_ciphers%& options operate differently, as described in the
26817 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26818 .next
26819 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26820 When using OpenSSL, this option is ignored.
26821 (If an API is found to let OpenSSL be configured in this way,
26822 let the Exim Maintainers know and we'll likely use it).
26823 .next
26824 Some other recently added features may only be available in one or the other.
26825 This should be documented with the feature.  If the documentation does not
26826 explicitly state that the feature is infeasible in the other TLS
26827 implementation, then patches are welcome.
26828 .endlist
26829
26830
26831 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26832 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26833 an explicit path; if the latter, then the text about generation still applies,
26834 but not the chosen filename.
26835 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26836 See the documentation of &%tls_dhparam%& for more information.
26837
26838 GnuTLS uses D-H parameters that may take a substantial amount of time
26839 to compute. It is unreasonable to re-compute them for every TLS session.
26840 Therefore, Exim keeps this data in a file in its spool directory, called
26841 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26842 of bits requested.
26843 The file is owned by the Exim user and is readable only by
26844 its owner. Every Exim process that start up GnuTLS reads the D-H
26845 parameters from this file. If the file does not exist, the first Exim process
26846 that needs it computes the data and writes it to a temporary file which is
26847 renamed once it is complete. It does not matter if several Exim processes do
26848 this simultaneously (apart from wasting a few resources). Once a file is in
26849 place, new Exim processes immediately start using it.
26850
26851 For maximum security, the parameters that are stored in this file should be
26852 recalculated periodically, the frequency depending on your paranoia level.
26853 If you are avoiding using the fixed D-H primes published in RFCs, then you
26854 are concerned about some advanced attacks and will wish to do this; if you do
26855 not regenerate then you might as well stick to the standard primes.
26856
26857 Arranging this is easy in principle; just delete the file when you want new
26858 values to be computed. However, there may be a problem. The calculation of new
26859 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26860 If the system is not very active, &_/dev/random_& may delay returning data
26861 until enough randomness (entropy) is available. This may cause Exim to hang for
26862 a substantial amount of time, causing timeouts on incoming connections.
26863
26864 The solution is to generate the parameters externally to Exim. They are stored
26865 in &_gnutls-params-N_& in PEM format, which means that they can be
26866 generated externally using the &(certtool)& command that is part of GnuTLS.
26867
26868 To replace the parameters with new ones, instead of deleting the file
26869 and letting Exim re-create it, you can generate new parameters using
26870 &(certtool)& and, when this has been done, replace Exim's cache file by
26871 renaming. The relevant commands are something like this:
26872 .code
26873 # ls
26874 [ look for file; assume gnutls-params-2236 is the most recent ]
26875 # rm -f new-params
26876 # touch new-params
26877 # chown exim:exim new-params
26878 # chmod 0600 new-params
26879 # certtool --generate-dh-params --bits 2236 >>new-params
26880 # openssl dhparam -noout -text -in new-params | head
26881 [ check the first line, make sure it's not more than 2236;
26882   if it is, then go back to the start ("rm") and repeat
26883   until the size generated is at most the size requested ]
26884 # chmod 0400 new-params
26885 # mv new-params gnutls-params-2236
26886 .endd
26887 If Exim never has to generate the parameters itself, the possibility of
26888 stalling is removed.
26889
26890 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26891 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26892 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26893 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26894 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26895 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26896 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26897 which applies to all D-H usage, client or server.  If the value returned by
26898 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26899 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26900 limit, which is still much higher than Exim historically used.
26901
26902 The filename and bits used will change as the GnuTLS maintainers change the
26903 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26904 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26905 2432 bits, while NSS is limited to 2236 bits.
26906
26907 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26908 increase the chance of the generated prime actually being within acceptable
26909 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26910 procedure above.  There is no sane procedure available to Exim to double-check
26911 the size of the generated prime, so it might still be too large.
26912
26913
26914 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26915 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26916 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26917 There is a function in the OpenSSL library that can be passed a list of cipher
26918 suites before the cipher negotiation takes place. This specifies which ciphers
26919 are acceptable. The list is colon separated and may contain names like
26920 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26921 directly to this function call.
26922 Many systems will install the OpenSSL manual-pages, so you may have
26923 &'ciphers(1)'& available to you.
26924 The following quotation from the OpenSSL
26925 documentation specifies what forms of item are allowed in the cipher string:
26926
26927 .ilist
26928 It can consist of a single cipher suite such as RC4-SHA.
26929 .next
26930 It can represent a list of cipher suites containing a certain algorithm,
26931 or cipher suites of a certain type. For example SHA1 represents all
26932 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26933 SSL v3 algorithms.
26934 .next
26935 Lists of cipher suites can be combined in a single cipher string using
26936 the + character. This is used as a logical and operation. For example
26937 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26938 algorithms.
26939 .endlist
26940
26941 Each cipher string can be optionally preceded by one of the characters &`!`&,
26942 &`-`& or &`+`&.
26943 .ilist
26944 If &`!`& is used, the ciphers are permanently deleted from the list. The
26945 ciphers deleted can never reappear in the list even if they are explicitly
26946 stated.
26947 .next
26948 If &`-`& is used, the ciphers are deleted from the list, but some or all
26949 of the ciphers can be added again by later options.
26950 .next
26951 If &`+`& is used, the ciphers are moved to the end of the list. This
26952 option does not add any new ciphers; it just moves matching existing ones.
26953 .endlist
26954
26955 If none of these characters is present, the string is interpreted as
26956 a list of ciphers to be appended to the current preference list. If the list
26957 includes any ciphers already present they will be ignored: that is, they will
26958 not be moved to the end of the list.
26959 .endlist
26960
26961 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26962 string:
26963 .code
26964 # note single-quotes to get ! past any shell history expansion
26965 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26966 .endd
26967
26968 This example will let the library defaults be permitted on the MX port, where
26969 there's probably no identity verification anyway, but ups the ante on the
26970 submission ports where the administrator might have some influence on the
26971 choice of clients used:
26972 .code
26973 # OpenSSL variant; see man ciphers(1)
26974 tls_require_ciphers = ${if =={$received_port}{25}\
26975                            {DEFAULT}\
26976                            {HIGH:!MD5:!SHA1}}
26977 .endd
26978
26979
26980
26981 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26982          "SECTreqciphgnu"
26983 .cindex "GnuTLS" "specifying parameters for"
26984 .cindex "TLS" "specifying ciphers (GnuTLS)"
26985 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26986 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26987 .cindex "TLS" "specifying protocols (GnuTLS)"
26988 .cindex "TLS" "specifying priority string (GnuTLS)"
26989 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26990 The GnuTLS library allows the caller to provide a "priority string", documented
26991 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26992 ciphersuite specification in OpenSSL.
26993
26994 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26995 and controls both protocols and ciphers.
26996
26997 The &%tls_require_ciphers%& option is available both as an global option,
26998 controlling how Exim behaves as a server, and also as an option of the
26999 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27000 the value is string expanded.  The resulting string is not an Exim list and
27001 the string is given to the GnuTLS library, so that Exim does not need to be
27002 aware of future feature enhancements of GnuTLS.
27003
27004 Documentation of the strings accepted may be found in the GnuTLS manual, under
27005 "Priority strings".  This is online as
27006 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27007 but beware that this relates to GnuTLS 3, which may be newer than the version
27008 installed on your system.  If you are using GnuTLS 3,
27009 then the example code
27010 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27011 on that site can be used to test a given string.
27012
27013 For example:
27014 .code
27015 # Disable older versions of protocols
27016 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27017 .endd
27018
27019 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27020 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27021 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27022
27023 This example will let the library defaults be permitted on the MX port, where
27024 there's probably no identity verification anyway, and lowers security further
27025 by increasing compatibility; but this ups the ante on the submission ports
27026 where the administrator might have some influence on the choice of clients
27027 used:
27028 .code
27029 # GnuTLS variant
27030 tls_require_ciphers = ${if =={$received_port}{25}\
27031                            {NORMAL:%COMPAT}\
27032                            {SECURE128}}
27033 .endd
27034
27035
27036 .section "Configuring an Exim server to use TLS" "SECID182"
27037 .cindex "TLS" "configuring an Exim server"
27038 When Exim has been built with TLS support, it advertises the availability of
27039 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27040 but not to any others. The default value of this option is unset, which means
27041 that STARTTLS is not advertised at all. This default is chosen because you
27042 need to set some other options in order to make TLS available, and also it is
27043 sensible for systems that want to use TLS only as a client.
27044
27045 If a client issues a STARTTLS command and there is some configuration
27046 problem in the server, the command is rejected with a 454 error. If the client
27047 persists in trying to issue SMTP commands, all except QUIT are rejected
27048 with the error
27049 .code
27050 554 Security failure
27051 .endd
27052 If a STARTTLS command is issued within an existing TLS session, it is
27053 rejected with a 554 error code.
27054
27055 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27056 must be set to match some hosts. The default is * which matches all hosts.
27057
27058 .new
27059 If this is all you do, TLS encryption will be enabled but not authentication -
27060 meaning that the peer has no assurance it is actually you he is talking to.
27061 You gain protection from a passive sniffer listening on the wire but not
27062 from someone able to intercept the communication.
27063 .wen
27064
27065 Further protection requires some further configuration at the server end.
27066
27067 It is rumoured that all existing clients that support TLS/SSL use RSA
27068 encryption. To make this work you need to set, in the server,
27069 .code
27070 tls_certificate = /some/file/name
27071 tls_privatekey = /some/file/name
27072 .endd
27073 These options are, in fact, expanded strings, so you can make them depend on
27074 the identity of the client that is connected if you wish. The first file
27075 contains the server's X509 certificate, and the second contains the private key
27076 that goes with it. These files need to be
27077 PEM format and readable by the Exim user, and must
27078 always be given as full path names.
27079 The key must not be password-protected.
27080 They can be the same file if both the
27081 certificate and the key are contained within it. If &%tls_privatekey%& is not
27082 set, or if its expansion is forced to fail or results in an empty string, this
27083 is assumed to be the case. The certificate file may also contain intermediate
27084 certificates that need to be sent to the client to enable it to authenticate
27085 the server's certificate.
27086
27087 If you do not understand about certificates and keys, please try to find a
27088 source of this background information, which is not Exim-specific. (There are a
27089 few comments below in section &<<SECTcerandall>>&.)
27090
27091 &*Note*&: These options do not apply when Exim is operating as a client &--
27092 they apply only in the case of a server. If you need to use a certificate in an
27093 Exim client, you must set the options of the same names in an &(smtp)&
27094 transport.
27095
27096 With just these options, an Exim server will be able to use TLS. It does not
27097 require the client to have a certificate (but see below for how to insist on
27098 this). There is one other option that may be needed in other situations. If
27099 .code
27100 tls_dhparam = /some/file/name
27101 .endd
27102 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27103 with the parameters contained in the file.
27104 Set this to &`none`& to disable use of DH entirely, by making no prime
27105 available:
27106 .code
27107 tls_dhparam = none
27108 .endd
27109 This may also be set to a string identifying a standard prime to be used for
27110 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27111 used is &`ike23`&.  There are a few standard primes available, see the
27112 documentation for &%tls_dhparam%& for the complete list.
27113
27114 See the command
27115 .code
27116 openssl dhparam
27117 .endd
27118 for a way of generating file data.
27119
27120 The strings supplied for these three options are expanded every time a client
27121 host connects. It is therefore possible to use different certificates and keys
27122 for different hosts, if you so wish, by making use of the client's IP address
27123 in &$sender_host_address$& to control the expansion. If a string expansion is
27124 forced to fail, Exim behaves as if the option is not set.
27125
27126 .cindex "cipher" "logging"
27127 .cindex "log" "TLS cipher"
27128 .vindex "&$tls_in_cipher$&"
27129 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27130 an incoming TLS connection. It is included in the &'Received:'& header of an
27131 incoming message (by default &-- you can, of course, change this), and it is
27132 also included in the log line that records a message's arrival, keyed by
27133 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27134 condition can be used to test for specific cipher suites in ACLs.
27135
27136 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27137 can check the name of the cipher suite and vary their actions accordingly. The
27138 cipher suite names vary, depending on which TLS library is being used. For
27139 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27140 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27141 documentation for more details.
27142
27143 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27144 (again depending on the &%tls_cipher%& log selector).
27145
27146
27147 .section "Requesting and verifying client certificates" "SECID183"
27148 .cindex "certificate" "verification of client"
27149 .cindex "TLS" "client certificate verification"
27150 If you want an Exim server to request a certificate when negotiating a TLS
27151 session with a client, you must set either &%tls_verify_hosts%& or
27152 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27153 apply to all TLS connections. For any host that matches one of these options,
27154 Exim requests a certificate as part of the setup of the TLS session. The
27155 contents of the certificate are verified by comparing it with a list of
27156 expected certificates.
27157 These may be the system default set (depending on library version),
27158 an explicit file or,
27159 depending on library version, a directory, identified by
27160 &%tls_verify_certificates%&.
27161
27162 A file can contain multiple certificates, concatenated end to end. If a
27163 directory is used
27164 (OpenSSL only),
27165 each certificate must be in a separate file, with a name (or a symbolic link)
27166 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27167 certificate. You can compute the relevant hash by running the command
27168 .code
27169 openssl x509 -hash -noout -in /cert/file
27170 .endd
27171 where &_/cert/file_& contains a single certificate.
27172
27173 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27174 what happens if the client does not supply a certificate, or if the certificate
27175 does not match any of the certificates in the collection named by
27176 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27177 attempt to set up a TLS session is aborted, and the incoming connection is
27178 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27179 session continues. ACLs that run for subsequent SMTP commands can detect the
27180 fact that no certificate was verified, and vary their actions accordingly. For
27181 example, you can insist on a certificate before accepting a message for
27182 relaying, but not when the message is destined for local delivery.
27183
27184 .vindex "&$tls_in_peerdn$&"
27185 When a client supplies a certificate (whether it verifies or not), the value of
27186 the Distinguished Name of the certificate is made available in the variable
27187 &$tls_in_peerdn$& during subsequent processing of the message.
27188
27189 .cindex "log" "distinguished name"
27190 Because it is often a long text string, it is not included in the log line or
27191 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27192 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27193 &%received_header_text%& to change the &'Received:'& header. When no
27194 certificate is supplied, &$tls_in_peerdn$& is empty.
27195
27196
27197 .section "Revoked certificates" "SECID184"
27198 .cindex "TLS" "revoked certificates"
27199 .cindex "revocation list"
27200 .cindex "certificate" "revocation list"
27201 .cindex "OCSP" "stapling"
27202 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27203 certificates are revoked. If you have such a list, you can pass it to an Exim
27204 server using the global option called &%tls_crl%& and to an Exim client using
27205 an identically named option for the &(smtp)& transport. In each case, the value
27206 of the option is expanded and must then be the name of a file that contains a
27207 CRL in PEM format.
27208 The downside is that clients have to periodically re-download a potentially huge
27209 file from every certificate authority they know of.
27210
27211 The way with most moving parts at query time is Online Certificate
27212 Status Protocol (OCSP), where the client verifies the certificate
27213 against an OCSP server run by the CA.  This lets the CA track all
27214 usage of the certs.  It requires running software with access to the
27215 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27216 is based on HTTP and can be proxied accordingly.
27217
27218 The only widespread OCSP server implementation (known to this writer)
27219 comes as part of OpenSSL and aborts on an invalid request, such as
27220 connecting to the port and then disconnecting.  This requires
27221 re-entering the passphrase each time some random client does this.
27222
27223 The third way is OCSP Stapling; in this, the server using a certificate
27224 issued by the CA periodically requests an OCSP proof of validity from
27225 the OCSP server, then serves it up inline as part of the TLS
27226 negotiation.   This approach adds no extra round trips, does not let the
27227 CA track users, scales well with number of certs issued by the CA and is
27228 resilient to temporary OCSP server failures, as long as the server
27229 starts retrying to fetch an OCSP proof some time before its current
27230 proof expires.  The downside is that it requires server support.
27231
27232 Unless Exim is built with the support disabled,
27233 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27234 support for OCSP stapling is included.
27235
27236 There is a global option called &%tls_ocsp_file%&.
27237 The file specified therein is expected to be in DER format, and contain
27238 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27239 option will be re-expanded for SNI, if the &%tls_certificate%& option
27240 contains &`tls_in_sni`&, as per other TLS options.
27241
27242 Exim does not at this time implement any support for fetching a new OCSP
27243 proof.  The burden is on the administrator to handle this, outside of
27244 Exim.  The file specified should be replaced atomically, so that the
27245 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27246 on each connection, so a new file will be handled transparently on the
27247 next connection.
27248
27249 When built with OpenSSL Exim will check for a valid next update timestamp
27250 in the OCSP proof; if not present, or if the proof has expired, it will be
27251 ignored.
27252
27253 For the client to be able to verify the stapled OCSP the server must
27254 also supply, in its stapled information, any intermediate
27255 certificates for the chain leading to the OCSP proof from the signer
27256 of the server certificate.  There may be zero or one such. These
27257 intermediate certificates should be added to the server OCSP stapling
27258 file named by &%tls_ocsp_file%&.
27259
27260 Note that the proof only covers the terminal server certificate,
27261 not any of the chain from CA to it.
27262
27263 There is no current way to staple a proof for a client certificate.
27264
27265 .code
27266   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27267   OCSP server is supplied.  The server URL may be included in the
27268   server certificate, if the CA is helpful.
27269
27270   One failure mode seen was the OCSP Signer cert expiring before the end
27271   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27272   noted this as invalid overall, but the re-fetch script did not.
27273 .endd
27274
27275
27276
27277
27278 .section "Configuring an Exim client to use TLS" "SECID185"
27279 .cindex "cipher" "logging"
27280 .cindex "log" "TLS cipher"
27281 .cindex "log" "distinguished name"
27282 .cindex "TLS" "configuring an Exim client"
27283 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27284 deliveries as well as to incoming, the latter one causing logging of the
27285 server certificate's DN. The remaining client configuration for TLS is all
27286 within the &(smtp)& transport.
27287
27288 It is not necessary to set any options to have TLS work in the &(smtp)&
27289 transport. If Exim is built with TLS support, and TLS is advertised by a
27290 server, the &(smtp)& transport always tries to start a TLS session. However,
27291 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27292 transport) to a list of server hosts for which TLS should not be used.
27293
27294 If you do not want Exim to attempt to send messages unencrypted when an attempt
27295 to set up an encrypted connection fails in any way, you can set
27296 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27297 those hosts, delivery is always deferred if an encrypted connection cannot be
27298 set up. If there are any other hosts for the address, they are tried in the
27299 usual way.
27300
27301 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27302 the message unencrypted. It always does this if the response to STARTTLS is
27303 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27304 session after a success response code, what happens is controlled by the
27305 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27306 delivery to this host is deferred, and other hosts (if available) are tried. If
27307 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27308 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27309 negotiation fails, Exim closes the current connection (because it is in an
27310 unknown state), opens a new one to the same host, and then tries the delivery
27311 unencrypted.
27312
27313 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27314 transport provide the client with a certificate, which is passed to the server
27315 if it requests it. If the server is Exim, it will request a certificate only if
27316 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27317
27318 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27319 specifies a collection of expected server certificates.
27320 These may be the system default set (depending on library version),
27321 a file or,
27322 depending on library version, a directory,
27323 must name a file or,
27324 for OpenSSL only (not GnuTLS), a directory.
27325 The client verifies the server's certificate
27326 against this collection, taking into account any revoked certificates that are
27327 in the list defined by &%tls_crl%&.
27328 Failure to verify fails the TLS connection unless either of the
27329 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27330
27331 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27332 certificate verification to the listed servers.  Verification either must
27333 or need not succeed respectively.
27334
27335 The &(smtp)& transport has two OCSP-related options:
27336 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27337 is requested and required for the connection to proceed.  The default
27338 value is empty.
27339 &%hosts_request_ocsp%&; a host-list for which (additionally)
27340 a Certificate Status is requested (but not necessarily verified).  The default
27341 value is "*" meaning that requests are made unless configured
27342 otherwise.
27343
27344 The host(s) should also be in &%hosts_require_tls%&, and
27345 &%tls_verify_certificates%& configured for the transport,
27346 for OCSP to be relevant.
27347
27348 If
27349 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27350 list of permitted cipher suites. If either of these checks fails, delivery to
27351 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27352 alternative hosts, if any.
27353
27354  &*Note*&:
27355 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27356 is operating as a client. Exim does not assume that a server certificate (set
27357 by the global options of the same name) should also be used when operating as a
27358 client.
27359
27360 .vindex "&$host$&"
27361 .vindex "&$host_address$&"
27362 All the TLS options in the &(smtp)& transport are expanded before use, with
27363 &$host$& and &$host_address$& containing the name and address of the server to
27364 which the client is connected. Forced failure of an expansion causes Exim to
27365 behave as if the relevant option were unset.
27366
27367 .vindex &$tls_out_bits$&
27368 .vindex &$tls_out_cipher$&
27369 .vindex &$tls_out_peerdn$&
27370 .vindex &$tls_out_sni$&
27371 Before an SMTP connection is established, the
27372 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27373 variables are emptied. (Until the first connection, they contain the values
27374 that were set when the message was received.) If STARTTLS is subsequently
27375 successfully obeyed, these variables are set to the relevant values for the
27376 outgoing connection.
27377
27378
27379
27380 .section "Use of TLS Server Name Indication" "SECTtlssni"
27381 .cindex "TLS" "Server Name Indication"
27382 .vindex "&$tls_in_sni$&"
27383 .oindex "&%tls_in_sni%&"
27384 With TLS1.0 or above, there is an extension mechanism by which extra
27385 information can be included at various points in the protocol.  One of these
27386 extensions, documented in RFC 6066 (and before that RFC 4366) is
27387 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27388 client in the initial handshake, so that the server can examine the servername
27389 within and possibly choose to use different certificates and keys (and more)
27390 for this session.
27391
27392 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27393 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27394 address.
27395
27396 With SMTP to MX, there are the same problems here as in choosing the identity
27397 against which to validate a certificate: you can't rely on insecure DNS to
27398 provide the identity which you then cryptographically verify.  So this will
27399 be of limited use in that environment.
27400
27401 With SMTP to Submission, there is a well-defined hostname which clients are
27402 connecting to and can validate certificates against.  Thus clients &*can*&
27403 choose to include this information in the TLS negotiation.  If this becomes
27404 wide-spread, then hosters can choose to present different certificates to
27405 different clients.  Or even negotiate different cipher suites.
27406
27407 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27408 if not empty, will be sent on a TLS session as part of the handshake.  There's
27409 nothing more to it.  Choosing a sensible value not derived insecurely is the
27410 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27411 for the lifetime of the client connection (including during authentication).
27412
27413 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27414 received from a client.
27415 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27416
27417 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27418 option (prior to expansion) then the following options will be re-expanded
27419 during TLS session handshake, to permit alternative values to be chosen:
27420
27421 .ilist
27422 .vindex "&%tls_certificate%&"
27423 &%tls_certificate%&
27424 .next
27425 .vindex "&%tls_crl%&"
27426 &%tls_crl%&
27427 .next
27428 .vindex "&%tls_privatekey%&"
27429 &%tls_privatekey%&
27430 .next
27431 .vindex "&%tls_verify_certificates%&"
27432 &%tls_verify_certificates%&
27433 .next
27434 .vindex "&%tls_ocsp_file%&"
27435 &%tls_ocsp_file%&
27436 .endlist
27437
27438 Great care should be taken to deal with matters of case, various injection
27439 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27440 can always be referenced; it is important to remember that &$tls_sni$& is
27441 arbitrary unverified data provided prior to authentication.
27442
27443 The Exim developers are proceeding cautiously and so far no other TLS options
27444 are re-expanded.
27445
27446 When Exim is built against OpenSSL, OpenSSL must have been built with support
27447 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27448 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27449 see &`-servername`& in the output, then OpenSSL has support.
27450
27451 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27452 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27453 built, then you have SNI support).
27454
27455
27456
27457 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27458          "SECTmulmessam"
27459 .cindex "multiple SMTP deliveries with TLS"
27460 .cindex "TLS" "multiple message deliveries"
27461 Exim sends multiple messages down the same TCP/IP connection by starting up
27462 an entirely new delivery process for each message, passing the socket from
27463 one process to the next. This implementation does not fit well with the use
27464 of TLS, because there is quite a lot of state information associated with a TLS
27465 connection, not just a socket identification. Passing all the state information
27466 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27467 session before passing the socket to a new process. The new process may then
27468 try to start a new TLS session, and if successful, may try to re-authenticate
27469 if AUTH is in use, before sending the next message.
27470
27471 The RFC is not clear as to whether or not an SMTP session continues in clear
27472 after TLS has been shut down, or whether TLS may be restarted again later, as
27473 just described. However, if the server is Exim, this shutdown and
27474 reinitialization works. It is not known which (if any) other servers operate
27475 successfully if the client closes a TLS session and continues with unencrypted
27476 SMTP, but there are certainly some that do not work. For such servers, Exim
27477 should not pass the socket to another process, because the failure of the
27478 subsequent attempt to use it would cause Exim to record a temporary host error,
27479 and delay other deliveries to that host.
27480
27481 To test for this case, Exim sends an EHLO command to the server after
27482 closing down the TLS session. If this fails in any way, the connection is
27483 closed instead of being passed to a new delivery process, but no retry
27484 information is recorded.
27485
27486 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27487 &(smtp)& transport to match those hosts for which Exim should not pass
27488 connections to new processes if TLS has been used.
27489
27490
27491
27492
27493 .section "Certificates and all that" "SECTcerandall"
27494 .cindex "certificate" "references to discussion"
27495 In order to understand fully how TLS works, you need to know about
27496 certificates, certificate signing, and certificate authorities. This is not the
27497 place to give a tutorial, especially as I do not know very much about it
27498 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27499 to Apache, currently at
27500 .display
27501 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27502 .endd
27503 Other parts of the &'modssl'& documentation are also helpful, and have
27504 links to further files.
27505 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27506 0-201-61598-3), contains both introductory and more in-depth descriptions.
27507 Some sample programs taken from the book are available from
27508 .display
27509 &url(http://www.rtfm.com/openssl-examples/)
27510 .endd
27511
27512
27513 .section "Certificate chains" "SECID186"
27514 The file named by &%tls_certificate%& may contain more than one
27515 certificate. This is useful in the case where the certificate that is being
27516 sent is validated by an intermediate certificate which the other end does
27517 not have. Multiple certificates must be in the correct order in the file.
27518 First the host's certificate itself, then the first intermediate
27519 certificate to validate the issuer of the host certificate, then the next
27520 intermediate certificate to validate the issuer of the first intermediate
27521 certificate, and so on, until finally (optionally) the root certificate.
27522 The root certificate must already be trusted by the recipient for
27523 validation to succeed, of course, but if it's not preinstalled, sending the
27524 root certificate along with the rest makes it available for the user to
27525 install if the receiving end is a client MUA that can interact with a user.
27526
27527 Note that certificates using MD5 are unlikely to work on today's Internet;
27528 even if your libraries allow loading them for use in Exim when acting as a
27529 server, increasingly clients will not accept such certificates.  The error
27530 diagnostics in such a case can be frustratingly vague.
27531
27532
27533
27534 .section "Self-signed certificates" "SECID187"
27535 .cindex "certificate" "self-signed"
27536 You can create a self-signed certificate using the &'req'& command provided
27537 with OpenSSL, like this:
27538 . ==== Do not shorten the duration here without reading and considering
27539 . ==== the text below.  Please leave it at 9999 days.
27540 .code
27541 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27542             -days 9999 -nodes
27543 .endd
27544 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27545 delimited and so can be identified independently. The &%-days%& option
27546 specifies a period for which the certificate is valid. The &%-nodes%& option is
27547 important: if you do not set it, the key is encrypted with a passphrase
27548 that you are prompted for, and any use that is made of the key causes more
27549 prompting for the passphrase. This is not helpful if you are going to use
27550 this certificate and key in an MTA, where prompting is not possible.
27551
27552 . ==== I expect to still be working 26 years from now.  The less technical
27553 . ==== debt I create, in terms of storing up trouble for my later years, the
27554 . ==== happier I will be then.  We really have reached the point where we
27555 . ==== should start, at the very least, provoking thought and making folks
27556 . ==== pause before proceeding, instead of leaving all the fixes until two
27557 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27558 . ==== -pdp, 2012
27559 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27560 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27561 the above command might produce a date in the past.  Think carefully about
27562 the lifetime of the systems you're deploying, and either reduce the duration
27563 of the certificate or reconsider your platform deployment.  (At time of
27564 writing, reducing the duration is the most likely choice, but the inexorable
27565 progression of time takes us steadily towards an era where this will not
27566 be a sensible resolution).
27567
27568 A self-signed certificate made in this way is sufficient for testing, and
27569 may be adequate for all your requirements if you are mainly interested in
27570 encrypting transfers, and not in secure identification.
27571
27572 However, many clients require that the certificate presented by the server be a
27573 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27574 certificate. In this situation, the self-signed certificate described above
27575 must be installed on the client host as a trusted root &'certification
27576 authority'& (CA), and the certificate used by Exim must be a user certificate
27577 signed with that self-signed certificate.
27578
27579 For information on creating self-signed CA certificates and using them to sign
27580 user certificates, see the &'General implementation overview'& chapter of the
27581 Open-source PKI book, available online at
27582 &url(http://ospkibook.sourceforge.net/).
27583 .ecindex IIDencsmtp1
27584 .ecindex IIDencsmtp2
27585
27586
27587
27588 . ////////////////////////////////////////////////////////////////////////////
27589 . ////////////////////////////////////////////////////////////////////////////
27590
27591 .chapter "Access control lists" "CHAPACL"
27592 .scindex IIDacl "&ACL;" "description"
27593 .cindex "control of incoming mail"
27594 .cindex "message" "controlling incoming"
27595 .cindex "policy control" "access control lists"
27596 Access Control Lists (ACLs) are defined in a separate section of the run time
27597 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27598 name, terminated by a colon. Here is a complete ACL section that contains just
27599 one very small ACL:
27600 .code
27601 begin acl
27602 small_acl:
27603   accept   hosts = one.host.only
27604 .endd
27605 You can have as many lists as you like in the ACL section, and the order in
27606 which they appear does not matter. The lists are self-terminating.
27607
27608 The majority of ACLs are used to control Exim's behaviour when it receives
27609 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27610 when a local process submits a message using SMTP by specifying the &%-bs%&
27611 option. The most common use is for controlling which recipients are accepted
27612 in incoming messages. In addition, you can define an ACL that is used to check
27613 local non-SMTP messages. The default configuration file contains an example of
27614 a realistic ACL for checking RCPT commands. This is discussed in chapter
27615 &<<CHAPdefconfil>>&.
27616
27617
27618 .section "Testing ACLs" "SECID188"
27619 The &%-bh%& command line option provides a way of testing your ACL
27620 configuration locally by running a fake SMTP session with which you interact.
27621
27622
27623 .section "Specifying when ACLs are used" "SECID189"
27624 .cindex "&ACL;" "options for specifying"
27625 In order to cause an ACL to be used, you have to name it in one of the relevant
27626 options in the main part of the configuration. These options are:
27627 .cindex "AUTH" "ACL for"
27628 .cindex "DATA" "ACLs for"
27629 .cindex "ETRN" "ACL for"
27630 .cindex "EXPN" "ACL for"
27631 .cindex "HELO" "ACL for"
27632 .cindex "EHLO" "ACL for"
27633 .cindex "DKIM" "ACL for"
27634 .cindex "MAIL" "ACL for"
27635 .cindex "QUIT, ACL for"
27636 .cindex "RCPT" "ACL for"
27637 .cindex "STARTTLS, ACL for"
27638 .cindex "VRFY" "ACL for"
27639 .cindex "SMTP" "connection, ACL for"
27640 .cindex "non-SMTP messages" "ACLs for"
27641 .cindex "MIME content scanning" "ACL for"
27642 .cindex "PRDR" "ACL for"
27643
27644 .table2 140pt
27645 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27646 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27647 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27648 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27649 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27650 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27651 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27652 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27653 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27654 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27655 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27656 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27657 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27658 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27659 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27660 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27661 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27662 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27663 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27664 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27665 .endtable
27666
27667 For example, if you set
27668 .code
27669 acl_smtp_rcpt = small_acl
27670 .endd
27671 the little ACL defined above is used whenever Exim receives a RCPT command
27672 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27673 done when RCPT commands arrive. A rejection of RCPT should cause the
27674 sending MTA to give up on the recipient address contained in the RCPT
27675 command, whereas rejection at other times may cause the client MTA to keep on
27676 trying to deliver the message. It is therefore recommended that you do as much
27677 testing as possible at RCPT time.
27678
27679
27680 .section "The non-SMTP ACLs" "SECID190"
27681 .cindex "non-SMTP messages" "ACLs for"
27682 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27683 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27684 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27685 the state of the SMTP connection such as encryption and authentication) are not
27686 relevant and are forbidden in these ACLs. However, the sender and recipients
27687 are known, so the &%senders%& and &%sender_domains%& conditions and the
27688 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27689 &$authenticated_sender$& are also available. You can specify added header lines
27690 in any of these ACLs.
27691
27692 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27693 non-SMTP message, before any of the message has been read. (This is the
27694 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27695 batched SMTP input, it runs after the DATA command has been reached. The
27696 result of this ACL is ignored; it cannot be used to reject a message. If you
27697 really need to, you could set a value in an ACL variable here and reject based
27698 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27699 controls, and in particular, it can be used to set
27700 .code
27701 control = suppress_local_fixups
27702 .endd
27703 This cannot be used in the other non-SMTP ACLs because by the time they are
27704 run, it is too late.
27705
27706 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27707 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27708
27709 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27710 kind of rejection is treated as permanent, because there is no way of sending a
27711 temporary error for these kinds of message.
27712
27713
27714 .section "The SMTP connect ACL" "SECID191"
27715 .cindex "SMTP" "connection, ACL for"
27716 .oindex &%smtp_banner%&
27717 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27718 session, after the test specified by &%host_reject_connection%& (which is now
27719 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27720 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27721 the message override the banner message that is otherwise specified by the
27722 &%smtp_banner%& option.
27723
27724
27725 .section "The EHLO/HELO ACL" "SECID192"
27726 .cindex "EHLO" "ACL for"
27727 .cindex "HELO" "ACL for"
27728 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27729 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27730 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27731 Note that a client may issue more than one EHLO or HELO command in an SMTP
27732 session, and indeed is required to issue a new EHLO or HELO after successfully
27733 setting up encryption following a STARTTLS command.
27734
27735 Note also that a deny neither forces the client to go away nor means that
27736 mail will be refused on the connection.  Consider checking for
27737 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27738
27739 If the command is accepted by an &%accept%& verb that has a &%message%&
27740 modifier, the message may not contain more than one line (it will be truncated
27741 at the first newline and a panic logged if it does). Such a message cannot
27742 affect the EHLO options that are listed on the second and subsequent lines of
27743 an EHLO response.
27744
27745
27746 .section "The DATA ACLs" "SECID193"
27747 .cindex "DATA" "ACLs for"
27748 Two ACLs are associated with the DATA command, because it is two-stage
27749 command, with two responses being sent to the client.
27750 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27751 is obeyed. This gives you control after all the RCPT commands, but before
27752 the message itself is received. It offers the opportunity to give a negative
27753 response to the DATA command before the data is transmitted. Header lines
27754 added by MAIL or RCPT ACLs are not visible at this time, but any that
27755 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27756
27757 You cannot test the contents of the message, for example, to verify addresses
27758 in the headers, at RCPT time or when the DATA command is received. Such
27759 tests have to appear in the ACL that is run after the message itself has been
27760 received, before the final response to the DATA command is sent. This is
27761 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27762 associated with the DATA command.
27763
27764 For both of these ACLs, it is not possible to reject individual recipients. An
27765 error response rejects the entire message. Unfortunately, it is known that some
27766 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27767 before or after the data) correctly &-- they keep the message on their queues
27768 and try again later, but that is their problem, though it does waste some of
27769 your resources.
27770
27771 The &%acl_smtp_data%& ACL is run after
27772 the &%acl_smtp_data_prdr%&,
27773 the &%acl_smtp_dkim%&
27774 and the &%acl_smtp_mime%& ACLs.
27775
27776 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27777 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27778 enabled (which is the default).
27779
27780 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27781 received, and is executed for each DKIM signature found in a message.  If not
27782 otherwise specified, the default action is to accept.
27783
27784 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27785
27786 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27787
27788
27789 .section "The SMTP MIME ACL" "SECID194"
27790 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27791 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27792
27793 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27794
27795
27796 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27797 .cindex "PRDR" "ACL for"
27798 .oindex "&%prdr_enable%&"
27799 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27800 with PRDR support enabled (which is the default).
27801 It becomes active only when the PRDR feature is negotiated between
27802 client and server for a message, and more than one recipient
27803 has been accepted.
27804
27805 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27806 has been received, and is executed once for each recipient of the message
27807 with &$local_part$& and &$domain$& valid.
27808 The test may accept, defer or deny for individual recipients.
27809 The &%acl_smtp_data%& will still be called after this ACL and
27810 can reject the message overall, even if this ACL has accepted it
27811 for some or all recipients.
27812
27813 PRDR may be used to support per-user content filtering.  Without it
27814 one must defer any recipient after the first that has a different
27815 content-filter configuration.  With PRDR, the RCPT-time check
27816 .cindex "PRDR" "variable for"
27817 for this can be disabled when the variable &$prdr_requested$&
27818 is &"yes"&.
27819 Any required difference in behaviour of the main DATA-time
27820 ACL should however depend on the PRDR-time ACL having run, as Exim
27821 will avoid doing so in some situations (e.g.  single-recipient mails).
27822
27823 See also the &%prdr_enable%& global option
27824 and the &%hosts_try_prdr%& smtp transport option.
27825
27826 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27827 If the ACL is not defined, processing completes as if
27828 the feature was not requested by the client.
27829
27830 .section "The QUIT ACL" "SECTQUITACL"
27831 .cindex "QUIT, ACL for"
27832 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27833 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27834 does not in fact control any access.
27835 For this reason, it may only accept
27836 or warn as its final result.
27837
27838 This ACL can be used for tasks such as custom logging at the end of an SMTP
27839 session. For example, you can use ACL variables in other ACLs to count
27840 messages, recipients, etc., and log the totals at QUIT time using one or
27841 more &%logwrite%& modifiers on a &%warn%& verb.
27842
27843 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27844 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27845
27846 You do not need to have a final &%accept%&, but if you do, you can use a
27847 &%message%& modifier to specify custom text that is sent as part of the 221
27848 response to QUIT.
27849
27850 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27851 failure (for example, failure to open a log file, or when Exim is bombing out
27852 because it has detected an unrecoverable error), all SMTP commands from the
27853 client are given temporary error responses until QUIT is received or the
27854 connection is closed. In these special cases, the QUIT ACL does not run.
27855
27856
27857 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27858 .vindex &$acl_smtp_notquit$&
27859 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27860 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27861 trouble, such as being unable to write to its log files, this ACL is not run,
27862 because it might try to do things (such as write to log files) that make the
27863 situation even worse.
27864
27865 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27866 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27867 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27868 and &%warn%&.
27869
27870 .vindex &$smtp_notquit_reason$&
27871 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27872 to a string that indicates the reason for the termination of the SMTP
27873 connection. The possible values are:
27874 .table2
27875 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27876 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27877 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27878 .irow &`connection-lost`&          "The SMTP connection has been lost"
27879 .irow &`data-timeout`&             "Timeout while reading message data"
27880 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27881 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27882 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27883 .irow &`synchronization-error`&    "SMTP synchronization error"
27884 .irow &`tls-failed`&               "TLS failed to start"
27885 .endtable
27886 In most cases when an SMTP connection is closed without having received QUIT,
27887 Exim sends an SMTP response message before actually closing the connection.
27888 With the exception of the &`acl-drop`& case, the default message can be
27889 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27890 &%drop%& verb in another ACL, it is the message from the other ACL that is
27891 used.
27892
27893
27894 .section "Finding an ACL to use" "SECID195"
27895 .cindex "&ACL;" "finding which to use"
27896 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27897 you can use different ACLs in different circumstances. For example,
27898 .code
27899 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27900                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27901 .endd
27902 In the default configuration file there are some example settings for
27903 providing an RFC 4409 message submission service on port 587 and a
27904 non-standard &"smtps"& service on port 465. You can use a string
27905 expansion like this to choose an ACL for MUAs on these ports which is
27906 more appropriate for this purpose than the default ACL on port 25.
27907
27908 The expanded string does not have to be the name of an ACL in the
27909 configuration file; there are other possibilities. Having expanded the
27910 string, Exim searches for an ACL as follows:
27911
27912 .ilist
27913 If the string begins with a slash, Exim uses it as a file name, and reads its
27914 contents as an ACL. The lines are processed in the same way as lines in the
27915 Exim configuration file. In particular, continuation lines are supported, blank
27916 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27917 If the file does not exist or cannot be read, an error occurs (typically
27918 causing a temporary failure of whatever caused the ACL to be run). For example:
27919 .code
27920 acl_smtp_data = /etc/acls/\
27921   ${lookup{$sender_host_address}lsearch\
27922   {/etc/acllist}{$value}{default}}
27923 .endd
27924 This looks up an ACL file to use on the basis of the host's IP address, falling
27925 back to a default if the lookup fails. If an ACL is successfully read from a
27926 file, it is retained in memory for the duration of the Exim process, so that it
27927 can be re-used without having to re-read the file.
27928 .next
27929 If the string does not start with a slash, and does not contain any spaces,
27930 Exim searches the ACL section of the configuration for an ACL whose name
27931 matches the string.
27932 .next
27933 If no named ACL is found, or if the string contains spaces, Exim parses
27934 the string as an inline ACL. This can save typing in cases where you just
27935 want to have something like
27936 .code
27937 acl_smtp_vrfy = accept
27938 .endd
27939 in order to allow free use of the VRFY command. Such a string may contain
27940 newlines; it is processed in the same way as an ACL that is read from a file.
27941 .endlist
27942
27943
27944
27945
27946 .section "ACL return codes" "SECID196"
27947 .cindex "&ACL;" "return codes"
27948 Except for the QUIT ACL, which does not affect the SMTP return code (see
27949 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27950 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27951 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27952 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27953 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27954 This also causes a 4&'xx'& return code.
27955
27956 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27957 &"deny"&, because there is no mechanism for passing temporary errors to the
27958 submitters of non-SMTP messages.
27959
27960
27961 ACLs that are relevant to message reception may also return &"discard"&. This
27962 has the effect of &"accept"&, but causes either the entire message or an
27963 individual recipient address to be discarded. In other words, it is a
27964 blackholing facility. Use it with care.
27965
27966 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27967 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27968 RCPT ACL is to discard just the one recipient address. If there are no
27969 recipients left when the message's data is received, the DATA ACL is not
27970 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27971 remaining recipients. The &"discard"& return is not permitted for the
27972 &%acl_smtp_predata%& ACL.
27973
27974
27975 .cindex "&[local_scan()]& function" "when all recipients discarded"
27976 The &[local_scan()]& function is always run, even if there are no remaining
27977 recipients; it may create new recipients.
27978
27979
27980
27981 .section "Unset ACL options" "SECID197"
27982 .cindex "&ACL;" "unset options"
27983 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27984 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27985 not defined at all. For any defined ACL, the default action when control
27986 reaches the end of the ACL statements is &"deny"&.
27987
27988 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27989 these two are ACLs that are used only for their side effects. They cannot be
27990 used to accept or reject anything.
27991
27992 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27993 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27994 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27995 when the ACL is not defined is &"accept"&.
27996
27997 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27998 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27999 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28000 messages over an SMTP connection. For an example, see the ACL in the default
28001 configuration file.
28002
28003
28004
28005
28006 .section "Data for message ACLs" "SECID198"
28007 .cindex "&ACL;" "data for message ACL"
28008 .vindex &$domain$&
28009 .vindex &$local_part$&
28010 .vindex &$sender_address$&
28011 .vindex &$sender_host_address$&
28012 .vindex &$smtp_command$&
28013 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28014 that contain information about the host and the message's sender (for example,
28015 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28016 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28017 &$local_part$& are set from the argument address. The entire SMTP command
28018 is available in &$smtp_command$&.
28019
28020 When an ACL for the AUTH parameter of MAIL is running, the variables that
28021 contain information about the host are set, but &$sender_address$& is not yet
28022 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28023 how it is used.
28024
28025 .vindex "&$message_size$&"
28026 The &$message_size$& variable is set to the value of the SIZE parameter on
28027 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28028 that parameter is not given. The value is updated to the true message size by
28029 the time the final DATA ACL is run (after the message data has been
28030 received).
28031
28032 .vindex "&$rcpt_count$&"
28033 .vindex "&$recipients_count$&"
28034 The &$rcpt_count$& variable increases by one for each RCPT command received.
28035 The &$recipients_count$& variable increases by one each time a RCPT command is
28036 accepted, so while an ACL for RCPT is being processed, it contains the number
28037 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28038 &$rcpt_count$& contains the total number of RCPT commands, and
28039 &$recipients_count$& contains the total number of accepted recipients.
28040
28041
28042
28043
28044
28045 .section "Data for non-message ACLs" "SECTdatfornon"
28046 .cindex "&ACL;" "data for non-message ACL"
28047 .vindex &$smtp_command_argument$&
28048 .vindex &$smtp_command$&
28049 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28050 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28051 and the entire SMTP command is available in &$smtp_command$&.
28052 These variables can be tested using a &%condition%& condition. For example,
28053 here is an ACL for use with AUTH, which insists that either the session is
28054 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28055 does not permit authentication methods that use cleartext passwords on
28056 unencrypted connections.
28057 .code
28058 acl_check_auth:
28059   accept encrypted = *
28060   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28061                      {CRAM-MD5}}
28062   deny   message   = TLS encryption or CRAM-MD5 required
28063 .endd
28064 (Another way of applying this restriction is to arrange for the authenticators
28065 that use cleartext passwords not to be advertised when the connection is not
28066 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28067 option to do this.)
28068
28069
28070
28071 .section "Format of an ACL" "SECID199"
28072 .cindex "&ACL;" "format of"
28073 .cindex "&ACL;" "verbs, definition of"
28074 An individual ACL consists of a number of statements. Each statement starts
28075 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28076 Modifiers can change the way the verb operates, define error and log messages,
28077 set variables, insert delays, and vary the processing of accepted messages.
28078
28079 If all the conditions are met, the verb is obeyed. The same condition may be
28080 used (with different arguments) more than once in the same statement. This
28081 provides a means of specifying an &"and"& conjunction between conditions. For
28082 example:
28083 .code
28084 deny  dnslists = list1.example
28085 dnslists = list2.example
28086 .endd
28087 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28088 the conditions and modifiers when it reaches a condition that fails. What
28089 happens then depends on the verb (and in one case, on a special modifier). Not
28090 all the conditions make sense at every testing point. For example, you cannot
28091 test a sender address in the ACL that is run for a VRFY command.
28092
28093
28094 .section "ACL verbs" "SECID200"
28095 The ACL verbs are as follows:
28096
28097 .ilist
28098 .cindex "&%accept%& ACL verb"
28099 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28100 of the conditions are not met, what happens depends on whether &%endpass%&
28101 appears among the conditions (for syntax see below). If the failing condition
28102 is before &%endpass%&, control is passed to the next ACL statement; if it is
28103 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28104 check a RCPT command:
28105 .code
28106 accept domains = +local_domains
28107 endpass
28108 verify = recipient
28109 .endd
28110 If the recipient domain does not match the &%domains%& condition, control
28111 passes to the next statement. If it does match, the recipient is verified, and
28112 the command is accepted if verification succeeds. However, if verification
28113 fails, the ACL yields &"deny"&, because the failing condition is after
28114 &%endpass%&.
28115
28116 The &%endpass%& feature has turned out to be confusing to many people, so its
28117 use is not recommended nowadays. It is always possible to rewrite an ACL so
28118 that &%endpass%& is not needed, and it is no longer used in the default
28119 configuration.
28120
28121 .cindex "&%message%& ACL modifier" "with &%accept%&"
28122 If a &%message%& modifier appears on an &%accept%& statement, its action
28123 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28124 (when an &%accept%& verb either accepts or passes control to the next
28125 statement), &%message%& can be used to vary the message that is sent when an
28126 SMTP command is accepted. For example, in a RCPT ACL you could have:
28127 .display
28128 &`accept  `&<&'some conditions'&>
28129 &`        message = OK, I will allow you through today`&
28130 .endd
28131 You can specify an SMTP response code, optionally followed by an &"extended
28132 response code"& at the start of the message, but the first digit must be the
28133 same as would be sent by default, which is 2 for an &%accept%& verb.
28134
28135 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28136 an error message that is used when access is denied. This behaviour is retained
28137 for backward compatibility, but current &"best practice"& is to avoid the use
28138 of &%endpass%&.
28139
28140
28141 .next
28142 .cindex "&%defer%& ACL verb"
28143 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28144 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28145 &%defer%& is the same as &%deny%&, because there is no way of sending a
28146 temporary error. For a RCPT command, &%defer%& is much the same as using a
28147 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28148 be used in any ACL, and even for a recipient it might be a simpler approach.
28149
28150
28151 .next
28152 .cindex "&%deny%& ACL verb"
28153 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28154 the conditions are not met, control is passed to the next ACL statement. For
28155 example,
28156 .code
28157 deny dnslists = blackholes.mail-abuse.org
28158 .endd
28159 rejects commands from hosts that are on a DNS black list.
28160
28161
28162 .next
28163 .cindex "&%discard%& ACL verb"
28164 &%discard%&: This verb behaves like &%accept%&, except that it returns
28165 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28166 that are concerned with receiving messages. When all the conditions are true,
28167 the sending entity receives a &"success"& response. However, &%discard%& causes
28168 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28169 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28170 message's recipients are discarded. Recipients that are discarded before DATA
28171 do not appear in the log line when the &%received_recipients%& log selector is set.
28172
28173 If the &%log_message%& modifier is set when &%discard%& operates,
28174 its contents are added to the line that is automatically written to the log.
28175 The &%message%& modifier operates exactly as it does for &%accept%&.
28176
28177
28178 .next
28179 .cindex "&%drop%& ACL verb"
28180 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28181 forcibly closed after the 5&'xx'& error message has been sent. For example:
28182 .code
28183 drop   message   = I don't take more than 20 RCPTs
28184        condition = ${if > {$rcpt_count}{20}}
28185 .endd
28186 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28187 The connection is always dropped after sending a 550 response.
28188
28189 .next
28190 .cindex "&%require%& ACL verb"
28191 &%require%&: If all the conditions are met, control is passed to the next ACL
28192 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28193 example, when checking a RCPT command,
28194 .code
28195 require message = Sender did not verify
28196         verify  = sender
28197 .endd
28198 passes control to subsequent statements only if the message's sender can be
28199 verified. Otherwise, it rejects the command. Note the positioning of the
28200 &%message%& modifier, before the &%verify%& condition. The reason for this is
28201 discussed in section &<<SECTcondmodproc>>&.
28202
28203 .next
28204 .cindex "&%warn%& ACL verb"
28205 &%warn%&: If all the conditions are true, a line specified by the
28206 &%log_message%& modifier is written to Exim's main log. Control always passes
28207 to the next ACL statement. If any condition is false, the log line is not
28208 written. If an identical log line is requested several times in the same
28209 message, only one copy is actually written to the log. If you want to force
28210 duplicates to be written, use the &%logwrite%& modifier instead.
28211
28212 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28213 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28214 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28215 first failing condition. There is more about adding header lines in section
28216 &<<SECTaddheadacl>>&.
28217
28218 If any condition on a &%warn%& statement cannot be completed (that is, there is
28219 some sort of defer), the log line specified by &%log_message%& is not written.
28220 This does not include the case of a forced failure from a lookup, which
28221 is considered to be a successful completion. After a defer, no further
28222 conditions or modifiers in the &%warn%& statement are processed. The incident
28223 is logged, and the ACL continues to be processed, from the next statement
28224 onwards.
28225
28226
28227 .vindex "&$acl_verify_message$&"
28228 When one of the &%warn%& conditions is an address verification that fails, the
28229 text of the verification failure message is in &$acl_verify_message$&. If you
28230 want this logged, you must set it up explicitly. For example:
28231 .code
28232 warn   !verify = sender
28233        log_message = sender verify failed: $acl_verify_message
28234 .endd
28235 .endlist
28236
28237 At the end of each ACL there is an implicit unconditional &%deny%&.
28238
28239 As you can see from the examples above, the conditions and modifiers are
28240 written one to a line, with the first one on the same line as the verb, and
28241 subsequent ones on following lines. If you have a very long condition, you can
28242 continue it onto several physical lines by the usual backslash continuation
28243 mechanism. It is conventional to align the conditions vertically.
28244
28245
28246
28247 .section "ACL variables" "SECTaclvariables"
28248 .cindex "&ACL;" "variables"
28249 There are some special variables that can be set during ACL processing. They
28250 can be used to pass information between different ACLs, different invocations
28251 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28252 transports, and filters that are used to deliver a message. The names of these
28253 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28254 an underscore, but the remainder of the name can be any sequence of
28255 alphanumeric characters and underscores that you choose. There is no limit on
28256 the number of ACL variables. The two sets act as follows:
28257 .ilist
28258 The values of those variables whose names begin with &$acl_c$& persist
28259 throughout an SMTP connection. They are never reset. Thus, a value that is set
28260 while receiving one message is still available when receiving the next message
28261 on the same SMTP connection.
28262 .next
28263 The values of those variables whose names begin with &$acl_m$& persist only
28264 while a message is being received. They are reset afterwards. They are also
28265 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28266 .endlist
28267
28268 When a message is accepted, the current values of all the ACL variables are
28269 preserved with the message and are subsequently made available at delivery
28270 time. The ACL variables are set by a modifier called &%set%&. For example:
28271 .code
28272 accept hosts = whatever
28273        set acl_m4 = some value
28274 accept authenticated = *
28275        set acl_c_auth = yes
28276 .endd
28277 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28278 be set. If you want to set a variable without taking any action, you can use a
28279 &%warn%& verb without any other modifiers or conditions.
28280
28281 .oindex &%strict_acl_vars%&
28282 What happens if a syntactically valid but undefined ACL variable is
28283 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28284 false (the default), an empty string is substituted; if it is true, an
28285 error is generated.
28286
28287 Versions of Exim before 4.64 have a limited set of numbered variables, but
28288 their names are compatible, so there is no problem with upgrading.
28289
28290
28291 .section "Condition and modifier processing" "SECTcondmodproc"
28292 .cindex "&ACL;" "conditions; processing"
28293 .cindex "&ACL;" "modifiers; processing"
28294 An exclamation mark preceding a condition negates its result. For example:
28295 .code
28296 deny   domains = *.dom.example
28297       !verify  = recipient
28298 .endd
28299 causes the ACL to return &"deny"& if the recipient domain ends in
28300 &'dom.example'& and the recipient address cannot be verified. Sometimes
28301 negation can be used on the right-hand side of a condition. For example, these
28302 two statements are equivalent:
28303 .code
28304 deny  hosts = !192.168.3.4
28305 deny !hosts =  192.168.3.4
28306 .endd
28307 However, for many conditions (&%verify%& being a good example), only left-hand
28308 side negation of the whole condition is possible.
28309
28310 The arguments of conditions and modifiers are expanded. A forced failure
28311 of an expansion causes a condition to be ignored, that is, it behaves as if the
28312 condition is true. Consider these two statements:
28313 .code
28314 accept  senders = ${lookup{$host_name}lsearch\
28315                   {/some/file}{$value}fail}
28316 accept  senders = ${lookup{$host_name}lsearch\
28317                   {/some/file}{$value}{}}
28318 .endd
28319 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28320 the returned list is searched, but if the lookup fails the behaviour is
28321 different in the two cases. The &%fail%& in the first statement causes the
28322 condition to be ignored, leaving no further conditions. The &%accept%& verb
28323 therefore succeeds. The second statement, however, generates an empty list when
28324 the lookup fails. No sender can match an empty list, so the condition fails,
28325 and therefore the &%accept%& also fails.
28326
28327 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28328 specify actions that are taken as the conditions for a statement are checked;
28329 others specify text for messages that are used when access is denied or a
28330 warning is generated. The &%control%& modifier affects the way an incoming
28331 message is handled.
28332
28333 The positioning of the modifiers in an ACL statement is important, because the
28334 processing of a verb ceases as soon as its outcome is known. Only those
28335 modifiers that have already been encountered will take effect. For example,
28336 consider this use of the &%message%& modifier:
28337 .code
28338 require message = Can't verify sender
28339         verify  = sender
28340         message = Can't verify recipient
28341         verify  = recipient
28342         message = This message cannot be used
28343 .endd
28344 If sender verification fails, Exim knows that the result of the statement is
28345 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28346 so its text is used as the error message. If sender verification succeeds, but
28347 recipient verification fails, the second message is used. If recipient
28348 verification succeeds, the third message becomes &"current"&, but is never used
28349 because there are no more conditions to cause failure.
28350
28351 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28352 modifier that is used, because all the conditions must be true for rejection to
28353 happen. Specifying more than one &%message%& modifier does not make sense, and
28354 the message can even be specified after all the conditions. For example:
28355 .code
28356 deny   hosts = ...
28357       !senders = *@my.domain.example
28358        message = Invalid sender from client host
28359 .endd
28360 The &"deny"& result does not happen until the end of the statement is reached,
28361 by which time Exim has set up the message.
28362
28363
28364
28365 .section "ACL modifiers" "SECTACLmodi"
28366 .cindex "&ACL;" "modifiers; list of"
28367 The ACL modifiers are as follows:
28368
28369 .vlist
28370 .vitem &*add_header*&&~=&~<&'text'&>
28371 This modifier specifies one or more header lines that are to be added to an
28372 incoming message, assuming, of course, that the message is ultimately
28373 accepted. For details, see section &<<SECTaddheadacl>>&.
28374
28375 .vitem &*continue*&&~=&~<&'text'&>
28376 .cindex "&%continue%& ACL modifier"
28377 .cindex "database" "updating in ACL"
28378 This modifier does nothing of itself, and processing of the ACL always
28379 continues with the next condition or modifier. The value of &%continue%& is in
28380 the side effects of expanding its argument. Typically this could be used to
28381 update a database. It is really just a syntactic tidiness, to avoid having to
28382 write rather ugly lines like this:
28383 .display
28384 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28385 .endd
28386 Instead, all you need is
28387 .display
28388 &`continue = `&<&'some expansion'&>
28389 .endd
28390
28391 .vitem &*control*&&~=&~<&'text'&>
28392 .cindex "&%control%& ACL modifier"
28393 This modifier affects the subsequent processing of the SMTP connection or of an
28394 incoming message that is accepted. The effect of the first type of control
28395 lasts for the duration of the connection, whereas the effect of the second type
28396 lasts only until the current message has been received. The message-specific
28397 controls always apply to the whole message, not to individual recipients,
28398 even if the &%control%& modifier appears in a RCPT ACL.
28399
28400 As there are now quite a few controls that can be applied, they are described
28401 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28402 in several different ways. For example:
28403
28404 . ==== As this is a nested list, any displays it contains must be indented
28405 . ==== as otherwise they are too far to the left. That comment applies only
28406 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28407 . ==== way.
28408
28409 .ilist
28410 It can be at the end of an &%accept%& statement:
28411 .code
28412     accept  ...some conditions
28413             control = queue_only
28414 .endd
28415 In this case, the control is applied when this statement yields &"accept"&, in
28416 other words, when the conditions are all true.
28417
28418 .next
28419 It can be in the middle of an &%accept%& statement:
28420 .code
28421     accept  ...some conditions...
28422             control = queue_only
28423             ...some more conditions...
28424 .endd
28425 If the first set of conditions are true, the control is applied, even if the
28426 statement does not accept because one of the second set of conditions is false.
28427 In this case, some subsequent statement must yield &"accept"& for the control
28428 to be relevant.
28429
28430 .next
28431 It can be used with &%warn%& to apply the control, leaving the
28432 decision about accepting or denying to a subsequent verb. For
28433 example:
28434 .code
28435     warn    ...some conditions...
28436             control = freeze
28437     accept  ...
28438 .endd
28439 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28440 &%logwrite%&, so it does not add anything to the message and does not write a
28441 log entry.
28442
28443 .next
28444 If you want to apply a control unconditionally, you can use it with a
28445 &%require%& verb. For example:
28446 .code
28447     require  control = no_multiline_responses
28448 .endd
28449 .endlist
28450
28451 .vitem &*delay*&&~=&~<&'time'&>
28452 .cindex "&%delay%& ACL modifier"
28453 .oindex "&%-bh%&"
28454 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28455 the time interval before proceeding. However, when testing Exim using the
28456 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28457 output instead). The time is given in the usual Exim notation, and the delay
28458 happens as soon as the modifier is processed. In an SMTP session, pending
28459 output is flushed before the delay is imposed.
28460
28461 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28462 example:
28463 .code
28464 deny    ...some conditions...
28465         delay = 30s
28466 .endd
28467 The delay happens if all the conditions are true, before the statement returns
28468 &"deny"&. Compare this with:
28469 .code
28470 deny    delay = 30s
28471         ...some conditions...
28472 .endd
28473 which waits for 30s before processing the conditions. The &%delay%& modifier
28474 can also be used with &%warn%& and together with &%control%&:
28475 .code
28476 warn    ...some conditions...
28477         delay = 2m
28478         control = freeze
28479 accept  ...
28480 .endd
28481
28482 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28483 responses to several commands are no longer buffered and sent in one packet (as
28484 they would normally be) because all output is flushed before imposing the
28485 delay. This optimization is disabled so that a number of small delays do not
28486 appear to the client as one large aggregated delay that might provoke an
28487 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28488 using a &%control%& modifier to set &%no_delay_flush%&.
28489
28490
28491 .vitem &*endpass*&
28492 .cindex "&%endpass%& ACL modifier"
28493 This modifier, which has no argument, is recognized only in &%accept%& and
28494 &%discard%& statements. It marks the boundary between the conditions whose
28495 failure causes control to pass to the next statement, and the conditions whose
28496 failure causes the ACL to return &"deny"&. This concept has proved to be
28497 confusing to some people, so the use of &%endpass%& is no longer recommended as
28498 &"best practice"&. See the description of &%accept%& above for more details.
28499
28500
28501 .vitem &*log_message*&&~=&~<&'text'&>
28502 .cindex "&%log_message%& ACL modifier"
28503 This modifier sets up a message that is used as part of the log message if the
28504 ACL denies access or a &%warn%& statement's conditions are true. For example:
28505 .code
28506 require log_message = wrong cipher suite $tls_in_cipher
28507         encrypted   = DES-CBC3-SHA
28508 .endd
28509 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28510 example:
28511 .display
28512 &`discard `&<&'some conditions'&>
28513 &`        log_message = Discarded $local_part@$domain because...`&
28514 .endd
28515 When access is denied, &%log_message%& adds to any underlying error message
28516 that may exist because of a condition failure. For example, while verifying a
28517 recipient address, a &':fail:'& redirection might have already set up a
28518 message.
28519
28520 The message may be defined before the conditions to which it applies, because
28521 the string expansion does not happen until Exim decides that access is to be
28522 denied. This means that any variables that are set by the condition are
28523 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28524 variables are set after a DNS black list lookup succeeds. If the expansion of
28525 &%log_message%& fails, or if the result is an empty string, the modifier is
28526 ignored.
28527
28528 .vindex "&$acl_verify_message$&"
28529 If you want to use a &%warn%& statement to log the result of an address
28530 verification, you can use &$acl_verify_message$& to include the verification
28531 error message.
28532
28533 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28534 the start of the logged message. If the same warning log message is requested
28535 more than once while receiving  a single email message, only one copy is
28536 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28537 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28538 is logged for a successful &%warn%& statement.
28539
28540 If &%log_message%& is not present and there is no underlying error message (for
28541 example, from the failure of address verification), but &%message%& is present,
28542 the &%message%& text is used for logging rejections. However, if any text for
28543 logging contains newlines, only the first line is logged. In the absence of
28544 both &%log_message%& and &%message%&, a default built-in message is used for
28545 logging rejections.
28546
28547
28548 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28549 .cindex "&%log_reject_target%& ACL modifier"
28550 .cindex "logging in ACL" "specifying which log"
28551 This modifier makes it possible to specify which logs are used for messages
28552 about ACL rejections. Its argument is a colon-separated list of words that can
28553 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28554 may be empty, in which case a rejection is not logged at all. For example, this
28555 ACL fragment writes no logging information when access is denied:
28556 .display
28557 &`deny `&<&'some conditions'&>
28558 &`     log_reject_target =`&
28559 .endd
28560 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28561 permanent and temporary rejections. Its effect lasts for the rest of the
28562 current ACL.
28563
28564
28565 .vitem &*logwrite*&&~=&~<&'text'&>
28566 .cindex "&%logwrite%& ACL modifier"
28567 .cindex "logging in ACL" "immediate"
28568 This modifier writes a message to a log file as soon as it is encountered when
28569 processing an ACL. (Compare &%log_message%&, which, except in the case of
28570 &%warn%& and &%discard%&, is used only if the ACL statement denies
28571 access.) The &%logwrite%& modifier can be used to log special incidents in
28572 ACLs. For example:
28573 .display
28574 &`accept `&<&'some special conditions'&>
28575 &`       control  = freeze`&
28576 &`       logwrite = froze message because ...`&
28577 .endd
28578 By default, the message is written to the main log. However, it may begin
28579 with a colon, followed by a comma-separated list of log names, and then
28580 another colon, to specify exactly which logs are to be written. For
28581 example:
28582 .code
28583 logwrite = :main,reject: text for main and reject logs
28584 logwrite = :panic: text for panic log only
28585 .endd
28586
28587
28588 .vitem &*message*&&~=&~<&'text'&>
28589 .cindex "&%message%& ACL modifier"
28590 This modifier sets up a text string that is expanded and used as a response
28591 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28592 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28593 there is some complication if &%endpass%& is involved; see the description of
28594 &%accept%& for details.)
28595
28596 The expansion of the message happens at the time Exim decides that the ACL is
28597 to end, not at the time it processes &%message%&. If the expansion fails, or
28598 generates an empty string, the modifier is ignored. Here is an example where
28599 &%message%& must be specified first, because the ACL ends with a rejection if
28600 the &%hosts%& condition fails:
28601 .code
28602 require  message = Host not recognized
28603          hosts = 10.0.0.0/8
28604 .endd
28605 (Once a condition has failed, no further conditions or modifiers are
28606 processed.)
28607
28608 .cindex "SMTP" "error codes"
28609 .oindex "&%smtp_banner%&
28610 For ACLs that are triggered by SMTP commands, the message is returned as part
28611 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28612 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28613 is accepted. In the case of the connect ACL, accepting with a message modifier
28614 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28615 accept message may not contain more than one line (otherwise it will be
28616 truncated at the first newline and a panic logged), and it cannot affect the
28617 EHLO options.
28618
28619 When SMTP is involved, the message may begin with an overriding response code,
28620 consisting of three digits optionally followed by an &"extended response code"&
28621 of the form &'n.n.n'&, each code being followed by a space. For example:
28622 .code
28623 deny  message = 599 1.2.3 Host not welcome
28624       hosts = 192.168.34.0/24
28625 .endd
28626 The first digit of the supplied response code must be the same as would be sent
28627 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28628 access, but for the predata ACL, note that the default success code is 354, not
28629 2&'xx'&.
28630
28631 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28632 the message modifier cannot override the 221 response code.
28633
28634 The text in a &%message%& modifier is literal; any quotes are taken as
28635 literals, but because the string is expanded, backslash escapes are processed
28636 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28637 response.
28638
28639 .vindex "&$acl_verify_message$&"
28640 For ACLs that are called by an &%acl =%& ACL condition, the message is
28641 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28642
28643 If &%message%& is used on a statement that verifies an address, the message
28644 specified overrides any message that is generated by the verification process.
28645 However, the original message is available in the variable
28646 &$acl_verify_message$&, so you can incorporate it into your message if you
28647 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28648 routers to be passed back as part of the SMTP response, you should either not
28649 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28650
28651 For compatibility with previous releases of Exim, a &%message%& modifier that
28652 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28653 modifier, but this usage is now deprecated. However, &%message%& acts only when
28654 all the conditions are true, wherever it appears in an ACL command, whereas
28655 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28656 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28657 effect.
28658
28659
28660 .new
28661 .vitem &*queue*&&~=&~<&'text'&>
28662 This modifier specifies the use of a named queue for spool files
28663 for the message.
28664 It can only be used before the message is received (i.e. not in
28665 the DATA ACL).
28666 This could be used, for example, for known high-volume burst sources
28667 of traffic, or for quarantine of messages.
28668 Separate queue-runner processes will be needed for named queues.
28669 If the text after expansion is empty, the default queue is used.
28670 .wen
28671
28672
28673 .vitem &*remove_header*&&~=&~<&'text'&>
28674 This modifier specifies one or more header names in a colon-separated list
28675  that are to be removed from an incoming message, assuming, of course, that
28676 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28677
28678
28679 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28680 .cindex "&%set%& ACL modifier"
28681 This modifier puts a value into one of the ACL variables (see section
28682 &<<SECTaclvariables>>&).
28683
28684
28685 .vitem &*udpsend*&&~=&~<&'parameters'&>
28686 This modifier sends a UDP packet, for purposes such as statistics
28687 collection or behaviour monitoring. The parameters are expanded, and
28688 the result of the expansion must be a colon-separated list consisting
28689 of a destination server, port number, and the packet contents. The
28690 server can be specified as a host name or IPv4 or IPv6 address. The
28691 separator can be changed with the usual angle bracket syntax. For
28692 example, you might want to collect information on which hosts connect
28693 when:
28694 .code
28695 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28696              $tod_zulu $sender_host_address
28697 .endd
28698 .endlist
28699
28700
28701
28702
28703 .section "Use of the control modifier" "SECTcontrols"
28704 .cindex "&%control%& ACL modifier"
28705 The &%control%& modifier supports the following settings:
28706
28707 .vlist
28708 .vitem &*control&~=&~allow_auth_unadvertised*&
28709 This modifier allows a client host to use the SMTP AUTH command even when it
28710 has not been advertised in response to EHLO. Furthermore, because there are
28711 apparently some really broken clients that do this, Exim will accept AUTH after
28712 HELO (rather than EHLO) when this control is set. It should be used only if you
28713 really need it, and you should limit its use to those broken clients that do
28714 not work without it. For example:
28715 .code
28716 warn hosts   = 192.168.34.25
28717      control = allow_auth_unadvertised
28718 .endd
28719 Normally, when an Exim server receives an AUTH command, it checks the name of
28720 the authentication mechanism that is given in the command to ensure that it
28721 matches an advertised mechanism. When this control is set, the check that a
28722 mechanism has been advertised is bypassed. Any configured mechanism can be used
28723 by the client. This control is permitted only in the connection and HELO ACLs.
28724
28725
28726 .vitem &*control&~=&~caseful_local_part*& &&&
28727        &*control&~=&~caselower_local_part*&
28728 .cindex "&ACL;" "case of local part in"
28729 .cindex "case of local parts"
28730 .vindex "&$local_part$&"
28731 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28732 (that is, during RCPT processing). By default, the contents of &$local_part$&
28733 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28734 any uppercase letters in the original local part are restored in &$local_part$&
28735 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28736 is encountered.
28737
28738 These controls affect only the current recipient. Moreover, they apply only to
28739 local part handling that takes place directly in the ACL (for example, as a key
28740 in lookups). If a test to verify the recipient is obeyed, the case-related
28741 handling of the local part during the verification is controlled by the router
28742 configuration (see the &%caseful_local_part%& generic router option).
28743
28744 This facility could be used, for example, to add a spam score to local parts
28745 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28746 spam score:
28747 .code
28748 warn  control = caseful_local_part
28749       set acl_m4 = ${eval:\
28750                      $acl_m4 + \
28751                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28752                     }
28753       control = caselower_local_part
28754 .endd
28755 Notice that we put back the lower cased version afterwards, assuming that
28756 is what is wanted for subsequent tests.
28757
28758
28759 .vitem &*control&~=&~cutthrough_delivery*&
28760 .cindex "&ACL;" "cutthrough routing"
28761 .cindex "cutthrough" "requesting"
28762 This option requests delivery be attempted while the item is being received.
28763
28764 The option is usable in the RCPT ACL.
28765 If enabled for a message received via smtp and routed to an smtp transport,
28766 and only one transport, interface, destination host and port combination
28767 is used for all recipients of the message,
28768 then the delivery connection is made while the receiving connection is open
28769 and data is copied from one to the other.
28770
28771 An attempt to set this option for any recipient but the first
28772 for a mail will be quietly ignored.
28773 If a recipient-verify callout
28774 (with use_sender)
28775 connection is subsequently
28776 requested in the same ACL it is held open and used for
28777 any subsequent recipients and the data,
28778 otherwise one is made after the initial RCPT ACL completes.
28779
28780 Note that routers are used in verify mode,
28781 and cannot depend on content of received headers.
28782 Note also that headers cannot be
28783 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28784 Headers may be modified by routers (subject to the above) and transports.
28785
28786 All the usual ACLs are called; if one results in the message being
28787 rejected, all effort spent in delivery (including the costs on
28788 the ultimate destination) will be wasted.
28789 Note that in the case of data-time ACLs this includes the entire
28790 message body.
28791
28792 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28793 of outgoing messages is done, because it sends data to the ultimate destination
28794 before the entire message has been received from the source.
28795 It is not supported for messages received with the SMTP PRDR option in use.
28796
28797 Should the ultimate destination system positively accept or reject the mail,
28798 a corresponding indication is given to the source system and nothing is queued.
28799 If there is a temporary error the item is queued for later delivery in the
28800 usual fashion. If the item is successfully delivered in cutthrough mode
28801 the delivery log lines are tagged with ">>" rather than "=>" and appear
28802 before the acceptance "<=" line.
28803
28804 Delivery in this mode avoids the generation of a bounce mail to a
28805 (possibly faked)
28806 sender when the destination system is doing content-scan based rejection.
28807
28808
28809 .vitem &*control&~=&~debug/*&<&'options'&>
28810 .cindex "&ACL;" "enabling debug logging"
28811 .cindex "debugging" "enabling from an ACL"
28812 This control turns on debug logging, almost as though Exim had been invoked
28813 with &`-d`&, with the output going to a new logfile, by default called
28814 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28815 may access any variables already defined.  The logging may be adjusted with
28816 the &'opts'& option, which takes the same values as the &`-d`& command-line
28817 option.
28818 .new
28819 Logging may be stopped, and the file removed, with the &'kill'& option.
28820 .wen
28821 Some examples (which depend on variables that don't exist in all
28822 contexts):
28823 .code
28824       control = debug
28825       control = debug/tag=.$sender_host_address
28826       control = debug/opts=+expand+acl
28827       control = debug/tag=.$message_exim_id/opts=+expand
28828       control = debug/kill
28829 .endd
28830
28831
28832 .vitem &*control&~=&~dkim_disable_verify*&
28833 .cindex "disable DKIM verify"
28834 .cindex "DKIM" "disable verify"
28835 This control turns off DKIM verification processing entirely.  For details on
28836 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28837
28838
28839 .vitem &*control&~=&~dscp/*&<&'value'&>
28840 .cindex "&ACL;" "setting DSCP value"
28841 .cindex "DSCP" "inbound"
28842 This option causes the DSCP value associated with the socket for the inbound
28843 connection to be adjusted to a given value, given as one of a number of fixed
28844 strings or to numeric value.
28845 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28846 Common values include &`throughput`&, &`mincost`&, and on newer systems
28847 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28848
28849 The outbound packets from Exim will be marked with this value in the header
28850 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28851 that these values will have any effect, not be stripped by networking
28852 equipment, or do much of anything without cooperation with your Network
28853 Engineer and those of all network operators between the source and destination.
28854
28855
28856 .vitem &*control&~=&~enforce_sync*& &&&
28857        &*control&~=&~no_enforce_sync*&
28858 .cindex "SMTP" "synchronization checking"
28859 .cindex "synchronization checking in SMTP"
28860 These controls make it possible to be selective about when SMTP synchronization
28861 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28862 state of the switch (it is true by default). See the description of this option
28863 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28864
28865 The effect of these two controls lasts for the remainder of the SMTP
28866 connection. They can appear in any ACL except the one for the non-SMTP
28867 messages. The most straightforward place to put them is in the ACL defined by
28868 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28869 before the first synchronization check. The expected use is to turn off the
28870 synchronization checks for badly-behaved hosts that you nevertheless need to
28871 work with.
28872
28873
28874 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28875 .cindex "fake defer"
28876 .cindex "defer, fake"
28877 This control works in exactly the same way as &%fakereject%& (described below)
28878 except that it causes an SMTP 450 response after the message data instead of a
28879 550 response. You must take care when using &%fakedefer%& because it causes the
28880 messages to be duplicated when the sender retries. Therefore, you should not
28881 use &%fakedefer%& if the message is to be delivered normally.
28882
28883 .vitem &*control&~=&~fakereject/*&<&'message'&>
28884 .cindex "fake rejection"
28885 .cindex "rejection, fake"
28886 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28887 words, only when an SMTP message is being received. If Exim accepts the
28888 message, instead the final 250 response, a 550 rejection message is sent.
28889 However, Exim proceeds to deliver the message as normal. The control applies
28890 only to the current message, not to any subsequent ones that may be received in
28891 the same SMTP connection.
28892
28893 The text for the 550 response is taken from the &%control%& modifier. If no
28894 message is supplied, the following is used:
28895 .code
28896 550-Your message has been rejected but is being
28897 550-kept for evaluation.
28898 550-If it was a legitimate message, it may still be
28899 550 delivered to the target recipient(s).
28900 .endd
28901 This facility should be used with extreme caution.
28902
28903 .vitem &*control&~=&~freeze*&
28904 .cindex "frozen messages" "forcing in ACL"
28905 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28906 other words, only when a message is being received. If the message is accepted,
28907 it is placed on Exim's queue and frozen. The control applies only to the
28908 current message, not to any subsequent ones that may be received in the same
28909 SMTP connection.
28910
28911 This modifier can optionally be followed by &`/no_tell`&. If the global option
28912 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28913 is told about the freezing), provided all the &*control=freeze*& modifiers that
28914 are obeyed for the current message have the &`/no_tell`& option.
28915
28916 .vitem &*control&~=&~no_delay_flush*&
28917 .cindex "SMTP" "output flushing, disabling for delay"
28918 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28919 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28920 use. This control, as long as it is encountered before the &%delay%& modifier,
28921 disables such output flushing.
28922
28923 .vitem &*control&~=&~no_callout_flush*&
28924 .cindex "SMTP" "output flushing, disabling for callout"
28925 Exim normally flushes SMTP output before performing a callout in an ACL, to
28926 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28927 use. This control, as long as it is encountered before the &%verify%& condition
28928 that causes the callout, disables such output flushing.
28929
28930 .vitem &*control&~=&~no_mbox_unspool*&
28931 This control is available when Exim is compiled with the content scanning
28932 extension. Content scanning may require a copy of the current message, or parts
28933 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28934 or spam scanner. Normally, such copies are deleted when they are no longer
28935 needed. If this control is set, the copies are not deleted. The control applies
28936 only to the current message, not to any subsequent ones that may be received in
28937 the same SMTP connection. It is provided for debugging purposes and is unlikely
28938 to be useful in production.
28939
28940 .vitem &*control&~=&~no_multiline_responses*&
28941 .cindex "multiline responses, suppressing"
28942 This control is permitted for any ACL except the one for non-SMTP messages.
28943 It seems that there are broken clients in use that cannot handle multiline
28944 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28945
28946 If this control is set, multiline SMTP responses from ACL rejections are
28947 suppressed. One way of doing this would have been to put out these responses as
28948 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28949 (&"use multiline responses for more"& it says &-- ha!), and some of the
28950 responses might get close to that. So this facility, which is after all only a
28951 sop to broken clients, is implemented by doing two very easy things:
28952
28953 .ilist
28954 Extra information that is normally output as part of a rejection caused by
28955 sender verification failure is omitted. Only the final line (typically &"sender
28956 verification failed"&) is sent.
28957 .next
28958 If a &%message%& modifier supplies a multiline response, only the first
28959 line is output.
28960 .endlist
28961
28962 The setting of the switch can, of course, be made conditional on the
28963 calling host. Its effect lasts until the end of the SMTP connection.
28964
28965 .vitem &*control&~=&~no_pipelining*&
28966 .cindex "PIPELINING" "suppressing advertising"
28967 This control turns off the advertising of the PIPELINING extension to SMTP in
28968 the current session. To be useful, it must be obeyed before Exim sends its
28969 response to an EHLO command. Therefore, it should normally appear in an ACL
28970 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28971 &%pipelining_advertise_hosts%&.
28972
28973 .vitem &*control&~=&~queue_only*&
28974 .oindex "&%queue_only%&"
28975 .cindex "queueing incoming messages"
28976 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28977 other words, only when a message is being received. If the message is accepted,
28978 it is placed on Exim's queue and left there for delivery by a subsequent queue
28979 runner. No immediate delivery process is started. In other words, it has the
28980 effect as the &%queue_only%& global option. However, the control applies only
28981 to the current message, not to any subsequent ones that may be received in the
28982 same SMTP connection.
28983
28984 .vitem &*control&~=&~submission/*&<&'options'&>
28985 .cindex "message" "submission"
28986 .cindex "submission mode"
28987 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28988 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28989 the current message is a submission from a local MUA. In this case, Exim
28990 operates in &"submission mode"&, and applies certain fixups to the message if
28991 necessary. For example, it adds a &'Date:'& header line if one is not present.
28992 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28993 late (the message has already been created).
28994
28995 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28996 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28997 submission mode; the available options for this control are described there.
28998 The control applies only to the current message, not to any subsequent ones
28999 that may be received in the same SMTP connection.
29000
29001 .vitem &*control&~=&~suppress_local_fixups*&
29002 .cindex "submission fixups, suppressing"
29003 This control applies to locally submitted (non TCP/IP) messages, and is the
29004 complement of &`control = submission`&. It disables the fixups that are
29005 normally applied to locally-submitted messages. Specifically:
29006
29007 .ilist
29008 Any &'Sender:'& header line is left alone (in this respect, it is a
29009 dynamic version of &%local_sender_retain%&).
29010 .next
29011 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29012 .next
29013 There is no check that &'From:'& corresponds to the actual sender.
29014 .endlist ilist
29015
29016 This control may be useful when a remotely-originated message is accepted,
29017 passed to some scanning program, and then re-submitted for delivery. It can be
29018 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29019 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29020 data is read.
29021
29022 &*Note:*& This control applies only to the current message, not to any others
29023 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29024
29025 .vitem &*control&~=&~utf8_downconvert*&
29026 This control enables conversion of UTF-8 in message addresses
29027 to a-label form.
29028 For details see &<<SECTi18nMTA>>&.
29029 .endlist vlist
29030
29031
29032 .section "Summary of message fixup control" "SECTsummesfix"
29033 All four possibilities for message fixups can be specified:
29034
29035 .ilist
29036 Locally submitted, fixups applied: the default.
29037 .next
29038 Locally submitted, no fixups applied: use
29039 &`control = suppress_local_fixups`&.
29040 .next
29041 Remotely submitted, no fixups applied: the default.
29042 .next
29043 Remotely submitted, fixups applied: use &`control = submission`&.
29044 .endlist
29045
29046
29047
29048 .section "Adding header lines in ACLs" "SECTaddheadacl"
29049 .cindex "header lines" "adding in an ACL"
29050 .cindex "header lines" "position of added lines"
29051 .cindex "&%add_header%& ACL modifier"
29052 The &%add_header%& modifier can be used to add one or more extra header lines
29053 to an incoming message, as in this example:
29054 .code
29055 warn dnslists = sbl.spamhaus.org : \
29056                 dialup.mail-abuse.org
29057      add_header = X-blacklisted-at: $dnslist_domain
29058 .endd
29059 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29060 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29061 receiving a message). The message must ultimately be accepted for
29062 &%add_header%& to have any significant effect. You can use &%add_header%& with
29063 any ACL verb, including &%deny%& (though this is potentially useful only in a
29064 RCPT ACL).
29065
29066 Headers will not be added to the message if the modifier is used in
29067 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29068
29069 Leading and trailing newlines are removed from
29070 the data for the &%add_header%& modifier; if it then
29071 contains one or more newlines that
29072 are not followed by a space or a tab, it is assumed to contain multiple header
29073 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29074 front of any line that is not a valid header line.
29075
29076 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29077 They are added to the message before processing the DATA and MIME ACLs.
29078 However, if an identical header line is requested more than once, only one copy
29079 is actually added to the message. Further header lines may be accumulated
29080 during the DATA and MIME ACLs, after which they are added to the message, again
29081 with duplicates suppressed. Thus, it is possible to add two identical header
29082 lines to an SMTP message, but only if one is added before DATA and one after.
29083 In the case of non-SMTP messages, new headers are accumulated during the
29084 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29085 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29086 are included in the entry that is written to the reject log.
29087
29088 .cindex "header lines" "added; visibility of"
29089 Header lines are not visible in string expansions
29090 of message headers
29091 until they are added to the
29092 message. It follows that header lines defined in the MAIL, RCPT, and predata
29093 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29094 header lines that are added by the DATA or MIME ACLs are not visible in those
29095 ACLs. Because of this restriction, you cannot use header lines as a way of
29096 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29097 this, you can use ACL variables, as described in section
29098 &<<SECTaclvariables>>&.
29099
29100 The list of headers yet to be added is given by the &%$headers_added%& variable.
29101
29102 The &%add_header%& modifier acts immediately as it is encountered during the
29103 processing of an ACL. Notice the difference between these two cases:
29104 .display
29105 &`accept add_header = ADDED: some text`&
29106 &`       `&<&'some condition'&>
29107
29108 &`accept `&<&'some condition'&>
29109 &`       add_header = ADDED: some text`&
29110 .endd
29111 In the first case, the header line is always added, whether or not the
29112 condition is true. In the second case, the header line is added only if the
29113 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29114 ACL statement. All those that are encountered before a condition fails are
29115 honoured.
29116
29117 .cindex "&%warn%& ACL verb"
29118 For compatibility with previous versions of Exim, a &%message%& modifier for a
29119 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29120 effect only if all the conditions are true, even if it appears before some of
29121 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29122 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29123 are present on a &%warn%& verb, both are processed according to their
29124 specifications.
29125
29126 By default, new header lines are added to a message at the end of the existing
29127 header lines. However, you can specify that any particular header line should
29128 be added right at the start (before all the &'Received:'& lines), immediately
29129 after the first block of &'Received:'& lines, or immediately before any line
29130 that is not a &'Received:'& or &'Resent-something:'& header.
29131
29132 This is done by specifying &":at_start:"&, &":after_received:"&, or
29133 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29134 header line, respectively. (Header text cannot start with a colon, as there has
29135 to be a header name first.) For example:
29136 .code
29137 warn add_header = \
29138        :after_received:X-My-Header: something or other...
29139 .endd
29140 If more than one header line is supplied in a single &%add_header%& modifier,
29141 each one is treated independently and can therefore be placed differently. If
29142 you add more than one line at the start, or after the Received: block, they end
29143 up in reverse order.
29144
29145 &*Warning*&: This facility currently applies only to header lines that are
29146 added in an ACL. It does NOT work for header lines that are added in a
29147 system filter or in a router or transport.
29148
29149
29150
29151 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29152 .cindex "header lines" "removing in an ACL"
29153 .cindex "header lines" "position of removed lines"
29154 .cindex "&%remove_header%& ACL modifier"
29155 The &%remove_header%& modifier can be used to remove one or more header lines
29156 from an incoming message, as in this example:
29157 .code
29158 warn   message        = Remove internal headers
29159        remove_header  = x-route-mail1 : x-route-mail2
29160 .endd
29161 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29162 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29163 receiving a message). The message must ultimately be accepted for
29164 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29165 with any ACL verb, including &%deny%&, though this is really not useful for
29166 any verb that doesn't result in a delivered message.
29167
29168 Headers will not be removed from the message if the modifier is used in
29169 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29170
29171 More than one header can be removed at the same time by using a colon separated
29172 list of header names. The header matching is case insensitive. Wildcards are
29173 not permitted, nor is list expansion performed, so you cannot use hostlists to
29174 create a list of headers, however both connection and message variable expansion
29175 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29176 .code
29177 warn   hosts           = +internal_hosts
29178        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29179 warn   message         = Remove internal headers
29180        remove_header   = $acl_c_ihdrs
29181 .endd
29182 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29183 They are removed from the message before processing the DATA and MIME ACLs.
29184 There is no harm in attempting to remove the same header twice nor is removing
29185 a non-existent header. Further header lines to be removed may be accumulated
29186 during the DATA and MIME ACLs, after which they are removed from the message,
29187 if present. In the case of non-SMTP messages, headers to be removed are
29188 accumulated during the non-SMTP ACLs, and are removed from the message after
29189 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29190 ACL, there really is no effect because there is no logging of what headers
29191 would have been removed.
29192
29193 .cindex "header lines" "removed; visibility of"
29194 Header lines are not visible in string expansions until the DATA phase when it
29195 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29196 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29197 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29198 this restriction, you cannot use header lines as a way of controlling data
29199 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29200 you should instead use ACL variables, as described in section
29201 &<<SECTaclvariables>>&.
29202
29203 The &%remove_header%& modifier acts immediately as it is encountered during the
29204 processing of an ACL. Notice the difference between these two cases:
29205 .display
29206 &`accept remove_header = X-Internal`&
29207 &`       `&<&'some condition'&>
29208
29209 &`accept `&<&'some condition'&>
29210 &`       remove_header = X-Internal`&
29211 .endd
29212 In the first case, the header line is always removed, whether or not the
29213 condition is true. In the second case, the header line is removed only if the
29214 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29215 same ACL statement. All those that are encountered before a condition fails
29216 are honoured.
29217
29218 &*Warning*&: This facility currently applies only to header lines that are
29219 present during ACL processing. It does NOT remove header lines that are added
29220 in a system filter or in a router or transport.
29221
29222
29223
29224
29225 .section "ACL conditions" "SECTaclconditions"
29226 .cindex "&ACL;" "conditions; list of"
29227 Some of the conditions listed in this section are available only when Exim is
29228 compiled with the content-scanning extension. They are included here briefly
29229 for completeness. More detailed descriptions can be found in the discussion on
29230 content scanning in chapter &<<CHAPexiscan>>&.
29231
29232 Not all conditions are relevant in all circumstances. For example, testing
29233 senders and recipients does not make sense in an ACL that is being run as the
29234 result of the arrival of an ETRN command, and checks on message headers can be
29235 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29236 can use the same condition (with different parameters) more than once in the
29237 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29238 The conditions are as follows:
29239
29240
29241 .vlist
29242 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29243 .cindex "&ACL;" "nested"
29244 .cindex "&ACL;" "indirect"
29245 .cindex "&ACL;" "arguments"
29246 .cindex "&%acl%& ACL condition"
29247 The possible values of the argument are the same as for the
29248 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29249 &"accept"& the condition is true; if it returns &"deny"& the condition is
29250 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29251 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29252 condition false. This means that further processing of the &%warn%& verb
29253 ceases, but processing of the ACL continues.
29254
29255 If the argument is a named ACL, up to nine space-separated optional values
29256 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29257 and $acl_narg is set to the count of values.
29258 Previous values of these variables are restored after the call returns.
29259 The name and values are expanded separately.
29260 Note that spaces in complex expansions which are used as arguments
29261 will act as argument separators.
29262
29263 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29264 the connection is dropped. If it returns &"discard"&, the verb must be
29265 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29266 conditions are tested.
29267
29268 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29269 loops. This condition allows you to use different ACLs in different
29270 circumstances. For example, different ACLs can be used to handle RCPT commands
29271 for different local users or different local domains.
29272
29273 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29274 .cindex "&%authenticated%& ACL condition"
29275 .cindex "authentication" "ACL checking"
29276 .cindex "&ACL;" "testing for authentication"
29277 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29278 the name of the authenticator is tested against the list. To test for
29279 authentication by any authenticator, you can set
29280 .code
29281 authenticated = *
29282 .endd
29283
29284 .vitem &*condition&~=&~*&<&'string'&>
29285 .cindex "&%condition%& ACL condition"
29286 .cindex "customizing" "ACL condition"
29287 .cindex "&ACL;" "customized test"
29288 .cindex "&ACL;" "testing, customized"
29289 This feature allows you to make up custom conditions. If the result of
29290 expanding the string is an empty string, the number zero, or one of the strings
29291 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29292 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29293 any other value, some error is assumed to have occurred, and the ACL returns
29294 &"defer"&. However, if the expansion is forced to fail, the condition is
29295 ignored. The effect is to treat it as true, whether it is positive or
29296 negative.
29297
29298 .vitem &*decode&~=&~*&<&'location'&>
29299 .cindex "&%decode%& ACL condition"
29300 This condition is available only when Exim is compiled with the
29301 content-scanning extension, and it is allowed only in the ACL defined by
29302 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29303 If all goes well, the condition is true. It is false only if there are
29304 problems such as a syntax error or a memory shortage. For more details, see
29305 chapter &<<CHAPexiscan>>&.
29306
29307 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29308 .cindex "&%dnslists%& ACL condition"
29309 .cindex "DNS list" "in ACL"
29310 .cindex "black list (DNS)"
29311 .cindex "&ACL;" "testing a DNS list"
29312 This condition checks for entries in DNS black lists. These are also known as
29313 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29314 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29315 different variants of this condition to describe briefly here. See sections
29316 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29317
29318 .vitem &*domains&~=&~*&<&'domain&~list'&>
29319 .cindex "&%domains%& ACL condition"
29320 .cindex "domain" "ACL checking"
29321 .cindex "&ACL;" "testing a recipient domain"
29322 .vindex "&$domain_data$&"
29323 This condition is relevant only after a RCPT command. It checks that the domain
29324 of the recipient address is in the domain list. If percent-hack processing is
29325 enabled, it is done before this test is done. If the check succeeds with a
29326 lookup, the result of the lookup is placed in &$domain_data$& until the next
29327 &%domains%& test.
29328
29329 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29330 use &%domains%& in a DATA ACL.
29331
29332
29333 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29334 .cindex "&%encrypted%& ACL condition"
29335 .cindex "encryption" "checking in an ACL"
29336 .cindex "&ACL;" "testing for encryption"
29337 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29338 name of the cipher suite in use is tested against the list. To test for
29339 encryption without testing for any specific cipher suite(s), set
29340 .code
29341 encrypted = *
29342 .endd
29343
29344
29345 .vitem &*hosts&~=&~*&<&'host&~list'&>
29346 .cindex "&%hosts%& ACL condition"
29347 .cindex "host" "ACL checking"
29348 .cindex "&ACL;" "testing the client host"
29349 This condition tests that the calling host matches the host list. If you have
29350 name lookups or wildcarded host names and IP addresses in the same host list,
29351 you should normally put the IP addresses first. For example, you could have:
29352 .code
29353 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29354 .endd
29355 The lookup in this example uses the host name for its key. This is implied by
29356 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29357 and it wouldn't matter which way round you had these two items.)
29358
29359 The reason for the problem with host names lies in the left-to-right way that
29360 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29361 but when it reaches an item that requires a host name, it fails if it cannot
29362 find a host name to compare with the pattern. If the above list is given in the
29363 opposite order, the &%accept%& statement fails for a host whose name cannot be
29364 found, even if its IP address is 10.9.8.7.
29365
29366 If you really do want to do the name check first, and still recognize the IP
29367 address even if the name lookup fails, you can rewrite the ACL like this:
29368 .code
29369 accept hosts = dbm;/etc/friendly/hosts
29370 accept hosts = 10.9.8.7
29371 .endd
29372 The default action on failing to find the host name is to assume that the host
29373 is not in the list, so the first &%accept%& statement fails. The second
29374 statement can then check the IP address.
29375
29376 .vindex "&$host_data$&"
29377 If a &%hosts%& condition is satisfied by means of a lookup, the result
29378 of the lookup is made available in the &$host_data$& variable. This
29379 allows you, for example, to set up a statement like this:
29380 .code
29381 deny  hosts = net-lsearch;/some/file
29382 message = $host_data
29383 .endd
29384 which gives a custom error message for each denied host.
29385
29386 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29387 .cindex "&%local_parts%& ACL condition"
29388 .cindex "local part" "ACL checking"
29389 .cindex "&ACL;" "testing a local part"
29390 .vindex "&$local_part_data$&"
29391 This condition is relevant only after a RCPT command. It checks that the local
29392 part of the recipient address is in the list. If percent-hack processing is
29393 enabled, it is done before this test. If the check succeeds with a lookup, the
29394 result of the lookup is placed in &$local_part_data$&, which remains set until
29395 the next &%local_parts%& test.
29396
29397 .vitem &*malware&~=&~*&<&'option'&>
29398 .cindex "&%malware%& ACL condition"
29399 .cindex "&ACL;" "virus scanning"
29400 .cindex "&ACL;" "scanning for viruses"
29401 This condition is available only when Exim is compiled with the
29402 content-scanning extension. It causes the incoming message to be scanned for
29403 viruses. For details, see chapter &<<CHAPexiscan>>&.
29404
29405 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29406 .cindex "&%mime_regex%& ACL condition"
29407 .cindex "&ACL;" "testing by regex matching"
29408 This condition is available only when Exim is compiled with the
29409 content-scanning extension, and it is allowed only in the ACL defined by
29410 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29411 with any of the regular expressions. For details, see chapter
29412 &<<CHAPexiscan>>&.
29413
29414 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29415 .cindex "rate limiting"
29416 This condition can be used to limit the rate at which a user or host submits
29417 messages. Details are given in section &<<SECTratelimiting>>&.
29418
29419 .vitem &*recipients&~=&~*&<&'address&~list'&>
29420 .cindex "&%recipients%& ACL condition"
29421 .cindex "recipient" "ACL checking"
29422 .cindex "&ACL;" "testing a recipient"
29423 This condition is relevant only after a RCPT command. It checks the entire
29424 recipient address against a list of recipients.
29425
29426 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29427 .cindex "&%regex%& ACL condition"
29428 .cindex "&ACL;" "testing by regex matching"
29429 This condition is available only when Exim is compiled with the
29430 content-scanning extension, and is available only in the DATA, MIME, and
29431 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29432 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29433
29434 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29435 .cindex "&%sender_domains%& ACL condition"
29436 .cindex "sender" "ACL checking"
29437 .cindex "&ACL;" "testing a sender domain"
29438 .vindex "&$domain$&"
29439 .vindex "&$sender_address_domain$&"
29440 This condition tests the domain of the sender of the message against the given
29441 domain list. &*Note*&: The domain of the sender address is in
29442 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29443 of this condition. This is an exception to the general rule for testing domain
29444 lists. It is done this way so that, if this condition is used in an ACL for a
29445 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29446 influence the sender checking.
29447
29448 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29449 relaying, because sender addresses are easily, and commonly, forged.
29450
29451 .vitem &*senders&~=&~*&<&'address&~list'&>
29452 .cindex "&%senders%& ACL condition"
29453 .cindex "sender" "ACL checking"
29454 .cindex "&ACL;" "testing a sender"
29455 This condition tests the sender of the message against the given list. To test
29456 for a bounce message, which has an empty sender, set
29457 .code
29458 senders = :
29459 .endd
29460 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29461 relaying, because sender addresses are easily, and commonly, forged.
29462
29463 .vitem &*spam&~=&~*&<&'username'&>
29464 .cindex "&%spam%& ACL condition"
29465 .cindex "&ACL;" "scanning for spam"
29466 This condition is available only when Exim is compiled with the
29467 content-scanning extension. It causes the incoming message to be scanned by
29468 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29469
29470 .vitem &*verify&~=&~certificate*&
29471 .cindex "&%verify%& ACL condition"
29472 .cindex "TLS" "client certificate verification"
29473 .cindex "certificate" "verification of client"
29474 .cindex "&ACL;" "certificate verification"
29475 .cindex "&ACL;" "testing a TLS certificate"
29476 This condition is true in an SMTP session if the session is encrypted, and a
29477 certificate was received from the client, and the certificate was verified. The
29478 server requests a certificate only if the client matches &%tls_verify_hosts%&
29479 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29480
29481 .vitem &*verify&~=&~csa*&
29482 .cindex "CSA verification"
29483 This condition checks whether the sending host (the client) is authorized to
29484 send email. Details of how this works are given in section
29485 &<<SECTverifyCSA>>&.
29486
29487 .vitem &*verify&~=&~header_names_ascii*&
29488 .cindex "&%verify%& ACL condition"
29489 .cindex "&ACL;" "verifying header names only ASCII"
29490 .cindex "header lines" "verifying header names only ASCII"
29491 .cindex "verifying" "header names only ASCII"
29492 This condition is relevant only in an ACL that is run after a message has been
29493 received, that is, in an ACL specified by &%acl_smtp_data%& or
29494 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29495 there are no non-ASCII characters, also excluding control characters.  The
29496 allowable characters are decimal ASCII values 33 through 126.
29497
29498 Exim itself will handle headers with non-ASCII characters, but it can cause
29499 problems for downstream applications, so this option will allow their
29500 detection and rejection in the DATA ACL's.
29501
29502 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29503 .cindex "&%verify%& ACL condition"
29504 .cindex "&ACL;" "verifying sender in the header"
29505 .cindex "header lines" "verifying the sender in"
29506 .cindex "sender" "verifying in header"
29507 .cindex "verifying" "sender in header"
29508 This condition is relevant only in an ACL that is run after a message has been
29509 received, that is, in an ACL specified by &%acl_smtp_data%& or
29510 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29511 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29512 is loosely thought of as a &"sender"& address (hence the name of the test).
29513 However, an address that appears in one of these headers need not be an address
29514 that accepts bounce messages; only sender addresses in envelopes are required
29515 to accept bounces. Therefore, if you use the callout option on this check, you
29516 might want to arrange for a non-empty address in the MAIL command.
29517
29518 Details of address verification and the options are given later, starting at
29519 section &<<SECTaddressverification>>& (callouts are described in section
29520 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29521 condition to restrict it to bounce messages only:
29522 .code
29523 deny    senders = :
29524         message = A valid sender header is required for bounces
29525        !verify  = header_sender
29526 .endd
29527
29528 .vitem &*verify&~=&~header_syntax*&
29529 .cindex "&%verify%& ACL condition"
29530 .cindex "&ACL;" "verifying header syntax"
29531 .cindex "header lines" "verifying syntax"
29532 .cindex "verifying" "header syntax"
29533 This condition is relevant only in an ACL that is run after a message has been
29534 received, that is, in an ACL specified by &%acl_smtp_data%& or
29535 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29536 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29537 and &'Bcc:'&), returning true if there are no problems.
29538 Unqualified addresses (local parts without domains) are
29539 permitted only in locally generated messages and from hosts that match
29540 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29541 appropriate.
29542
29543 Note that this condition is a syntax check only. However, a common spamming
29544 ploy used to be to send syntactically invalid headers such as
29545 .code
29546 To: @
29547 .endd
29548 and this condition can be used to reject such messages, though they are not as
29549 common as they used to be.
29550
29551 .vitem &*verify&~=&~helo*&
29552 .cindex "&%verify%& ACL condition"
29553 .cindex "&ACL;" "verifying HELO/EHLO"
29554 .cindex "HELO" "verifying"
29555 .cindex "EHLO" "verifying"
29556 .cindex "verifying" "EHLO"
29557 .cindex "verifying" "HELO"
29558 This condition is true if a HELO or EHLO command has been received from the
29559 client host, and its contents have been verified. If there has been no previous
29560 attempt to verify the HELO/EHLO contents, it is carried out when this
29561 condition is encountered. See the description of the &%helo_verify_hosts%& and
29562 &%helo_try_verify_hosts%& options for details of how to request verification
29563 independently of this condition.
29564
29565 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29566 option), this condition is always true.
29567
29568
29569 .vitem &*verify&~=&~not_blind*&
29570 .cindex "verifying" "not blind"
29571 .cindex "bcc recipients, verifying none"
29572 This condition checks that there are no blind (bcc) recipients in the message.
29573 Every envelope recipient must appear either in a &'To:'& header line or in a
29574 &'Cc:'& header line for this condition to be true. Local parts are checked
29575 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29576 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29577 used only in a DATA or non-SMTP ACL.
29578
29579 There are, of course, many legitimate messages that make use of blind (bcc)
29580 recipients. This check should not be used on its own for blocking messages.
29581
29582
29583 .vitem &*verify&~=&~recipient/*&<&'options'&>
29584 .cindex "&%verify%& ACL condition"
29585 .cindex "&ACL;" "verifying recipient"
29586 .cindex "recipient" "verifying"
29587 .cindex "verifying" "recipient"
29588 .vindex "&$address_data$&"
29589 This condition is relevant only after a RCPT command. It verifies the current
29590 recipient. Details of address verification are given later, starting at section
29591 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29592 of &$address_data$& is the last value that was set while routing the address.
29593 This applies even if the verification fails. When an address that is being
29594 verified is redirected to a single address, verification continues with the new
29595 address, and in that case, the subsequent value of &$address_data$& is the
29596 value for the child address.
29597
29598 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29599 .cindex "&%verify%& ACL condition"
29600 .cindex "&ACL;" "verifying host reverse lookup"
29601 .cindex "host" "verifying reverse lookup"
29602 This condition ensures that a verified host name has been looked up from the IP
29603 address of the client host. (This may have happened already if the host name
29604 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29605 Verification ensures that the host name obtained from a reverse DNS lookup, or
29606 one of its aliases, does, when it is itself looked up in the DNS, yield the
29607 original IP address.
29608
29609 There is one possible option, &`defer_ok`&.  If this is present and a
29610 DNS operation returns a temporary error, the verify condition succeeds.
29611
29612 If this condition is used for a locally generated message (that is, when there
29613 is no client host involved), it always succeeds.
29614
29615 .vitem &*verify&~=&~sender/*&<&'options'&>
29616 .cindex "&%verify%& ACL condition"
29617 .cindex "&ACL;" "verifying sender"
29618 .cindex "sender" "verifying"
29619 .cindex "verifying" "sender"
29620 This condition is relevant only after a MAIL or RCPT command, or after a
29621 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29622 the message's sender is empty (that is, this is a bounce message), the
29623 condition is true. Otherwise, the sender address is verified.
29624
29625 .vindex "&$address_data$&"
29626 .vindex "&$sender_address_data$&"
29627 If there is data in the &$address_data$& variable at the end of routing, its
29628 value is placed in &$sender_address_data$& at the end of verification. This
29629 value can be used in subsequent conditions and modifiers in the same ACL
29630 statement. It does not persist after the end of the current statement. If you
29631 want to preserve the value for longer, you can save it in an ACL variable.
29632
29633 Details of verification are given later, starting at section
29634 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29635 to avoid doing it more than once per message.
29636
29637 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29638 .cindex "&%verify%& ACL condition"
29639 This is a variation of the previous option, in which a modified address is
29640 verified as a sender.
29641 .endlist
29642
29643
29644
29645 .section "Using DNS lists" "SECTmorednslists"
29646 .cindex "DNS list" "in ACL"
29647 .cindex "black list (DNS)"
29648 .cindex "&ACL;" "testing a DNS list"
29649 In its simplest form, the &%dnslists%& condition tests whether the calling host
29650 is on at least one of a number of DNS lists by looking up the inverted IP
29651 address in one or more DNS domains. (Note that DNS list domains are not mail
29652 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29653 special options instead.) For example, if the calling host's IP
29654 address is 192.168.62.43, and the ACL statement is
29655 .code
29656 deny dnslists = blackholes.mail-abuse.org : \
29657                 dialups.mail-abuse.org
29658 .endd
29659 the following records are looked up:
29660 .code
29661 43.62.168.192.blackholes.mail-abuse.org
29662 43.62.168.192.dialups.mail-abuse.org
29663 .endd
29664 As soon as Exim finds an existing DNS record, processing of the list stops.
29665 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29666 to test that a host is on more than one list (an &"and"& conjunction), you can
29667 use two separate conditions:
29668 .code
29669 deny dnslists = blackholes.mail-abuse.org
29670      dnslists = dialups.mail-abuse.org
29671 .endd
29672 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29673 behaves as if the host does not match the list item, that is, as if the DNS
29674 record does not exist. If there are further items in the DNS list, they are
29675 processed.
29676
29677 This is usually the required action when &%dnslists%& is used with &%deny%&
29678 (which is the most common usage), because it prevents a DNS failure from
29679 blocking mail. However, you can change this behaviour by putting one of the
29680 following special items in the list:
29681 .display
29682 &`+include_unknown `&   behave as if the item is on the list
29683 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29684 &`+defer_unknown   `&   give a temporary error
29685 .endd
29686 .cindex "&`+include_unknown`&"
29687 .cindex "&`+exclude_unknown`&"
29688 .cindex "&`+defer_unknown`&"
29689 Each of these applies to any subsequent items on the list. For example:
29690 .code
29691 deny dnslists = +defer_unknown : foo.bar.example
29692 .endd
29693 Testing the list of domains stops as soon as a match is found. If you want to
29694 warn for one list and block for another, you can use two different statements:
29695 .code
29696 deny  dnslists = blackholes.mail-abuse.org
29697 warn  message  = X-Warn: sending host is on dialups list
29698       dnslists = dialups.mail-abuse.org
29699 .endd
29700 .cindex cacheing "of dns lookup"
29701 .cindex DNS TTL
29702 DNS list lookups are cached by Exim for the duration of the SMTP session
29703 (but limited by the DNS return TTL value),
29704 so a lookup based on the IP address is done at most once for any incoming
29705 connection (assuming long-enough TTL).
29706 Exim does not share information between multiple incoming
29707 connections (but your local name server cache should be active).
29708
29709
29710
29711 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29712 .cindex "DNS list" "keyed by explicit IP address"
29713 By default, the IP address that is used in a DNS list lookup is the IP address
29714 of the calling host. However, you can specify another IP address by listing it
29715 after the domain name, introduced by a slash. For example:
29716 .code
29717 deny dnslists = black.list.tld/192.168.1.2
29718 .endd
29719 This feature is not very helpful with explicit IP addresses; it is intended for
29720 use with IP addresses that are looked up, for example, the IP addresses of the
29721 MX hosts or nameservers of an email sender address. For an example, see section
29722 &<<SECTmulkeyfor>>& below.
29723
29724
29725
29726
29727 .section "DNS lists keyed on domain names" "SECID202"
29728 .cindex "DNS list" "keyed by domain name"
29729 There are some lists that are keyed on domain names rather than inverted IP
29730 addresses (see for example the &'domain based zones'& link at
29731 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29732 with these lists. You can change the name that is looked up in a DNS list by
29733 listing it after the domain name, introduced by a slash. For example,
29734 .code
29735 deny  message  = Sender's domain is listed at $dnslist_domain
29736       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29737 .endd
29738 This particular example is useful only in ACLs that are obeyed after the
29739 RCPT or DATA commands, when a sender address is available. If (for
29740 example) the message's sender is &'user@tld.example'& the name that is looked
29741 up by this example is
29742 .code
29743 tld.example.dsn.rfc-ignorant.org
29744 .endd
29745 A single &%dnslists%& condition can contain entries for both names and IP
29746 addresses. For example:
29747 .code
29748 deny dnslists = sbl.spamhaus.org : \
29749                 dsn.rfc-ignorant.org/$sender_address_domain
29750 .endd
29751 The first item checks the sending host's IP address; the second checks a domain
29752 name. The whole condition is true if either of the DNS lookups succeeds.
29753
29754
29755
29756
29757 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29758 .cindex "DNS list" "multiple keys for"
29759 The syntax described above for looking up explicitly-defined values (either
29760 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29761 name for the DNS list, what follows the slash can in fact be a list of items.
29762 As with all lists in Exim, the default separator is a colon. However, because
29763 this is a sublist within the list of DNS blacklist domains, it is necessary
29764 either to double the separators like this:
29765 .code
29766 dnslists = black.list.tld/name.1::name.2
29767 .endd
29768 or to change the separator character, like this:
29769 .code
29770 dnslists = black.list.tld/<;name.1;name.2
29771 .endd
29772 If an item in the list is an IP address, it is inverted before the DNS
29773 blacklist domain is appended. If it is not an IP address, no inversion
29774 occurs. Consider this condition:
29775 .code
29776 dnslists = black.list.tld/<;192.168.1.2;a.domain
29777 .endd
29778 The DNS lookups that occur are:
29779 .code
29780 2.1.168.192.black.list.tld
29781 a.domain.black.list.tld
29782 .endd
29783 Once a DNS record has been found (that matches a specific IP return
29784 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29785 are done. If there is a temporary DNS error, the rest of the sublist of domains
29786 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29787 only if no other DNS lookup in this sublist succeeds. In other words, a
29788 successful lookup for any of the items in the sublist overrides a temporary
29789 error for a previous item.
29790
29791 The ability to supply a list of items after the slash is in some sense just a
29792 syntactic convenience. These two examples have the same effect:
29793 .code
29794 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29795 dnslists = black.list.tld/a.domain::b.domain
29796 .endd
29797 However, when the data for the list is obtained from a lookup, the second form
29798 is usually much more convenient. Consider this example:
29799 .code
29800 deny message  = The mail servers for the domain \
29801                 $sender_address_domain \
29802                 are listed at $dnslist_domain ($dnslist_value); \
29803                 see $dnslist_text.
29804      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29805                                    ${lookup dnsdb {>|mxh=\
29806                                    $sender_address_domain} }} }
29807 .endd
29808 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29809 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29810 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29811 of expanding the condition might be something like this:
29812 .code
29813 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29814 .endd
29815 Thus, this example checks whether or not the IP addresses of the sender
29816 domain's mail servers are on the Spamhaus black list.
29817
29818 The key that was used for a successful DNS list lookup is put into the variable
29819 &$dnslist_matched$& (see section &<<SECID204>>&).
29820
29821
29822
29823
29824 .section "Data returned by DNS lists" "SECID203"
29825 .cindex "DNS list" "data returned from"
29826 DNS lists are constructed using address records in the DNS. The original RBL
29827 just used the address 127.0.0.1 on the right hand side of each record, but the
29828 RBL+ list and some other lists use a number of values with different meanings.
29829 The values used on the RBL+ list are:
29830 .display
29831 127.1.0.1  RBL
29832 127.1.0.2  DUL
29833 127.1.0.3  DUL and RBL
29834 127.1.0.4  RSS
29835 127.1.0.5  RSS and RBL
29836 127.1.0.6  RSS and DUL
29837 127.1.0.7  RSS and DUL and RBL
29838 .endd
29839 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29840 different values. Some DNS lists may return more than one address record;
29841 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29842
29843
29844 .section "Variables set from DNS lists" "SECID204"
29845 .cindex "expansion" "variables, set from DNS list"
29846 .cindex "DNS list" "variables set from"
29847 .vindex "&$dnslist_domain$&"
29848 .vindex "&$dnslist_matched$&"
29849 .vindex "&$dnslist_text$&"
29850 .vindex "&$dnslist_value$&"
29851 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29852 the name of the overall domain that matched (for example,
29853 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29854 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29855 the DNS record. When the key is an IP address, it is not reversed in
29856 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29857 cases, for example:
29858 .code
29859 deny dnslists = spamhaus.example
29860 .endd
29861 the key is also available in another variable (in this case,
29862 &$sender_host_address$&). In more complicated cases, however, this is not true.
29863 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29864 might generate a dnslists lookup like this:
29865 .code
29866 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29867 .endd
29868 If this condition succeeds, the value in &$dnslist_matched$& might be
29869 &`192.168.6.7`& (for example).
29870
29871 If more than one address record is returned by the DNS lookup, all the IP
29872 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29873 The variable &$dnslist_text$& contains the contents of any associated TXT
29874 record. For lists such as RBL+ the TXT record for a merged entry is often not
29875 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29876 information.
29877
29878 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29879 &-- although these appear before the condition in the ACL, they are not
29880 expanded until after it has failed. For example:
29881 .code
29882 deny    hosts = !+local_networks
29883         message = $sender_host_address is listed \
29884                   at $dnslist_domain
29885         dnslists = rbl-plus.mail-abuse.example
29886 .endd
29887
29888
29889
29890 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29891 .cindex "DNS list" "matching specific returned data"
29892 You can add an equals sign and an IP address after a &%dnslists%& domain name
29893 in order to restrict its action to DNS records with a matching right hand side.
29894 For example,
29895 .code
29896 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29897 .endd
29898 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29899 any address record is considered to be a match. For the moment, we assume
29900 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29901 describes how multiple records are handled.
29902
29903 More than one IP address may be given for checking, using a comma as a
29904 separator. These are alternatives &-- if any one of them matches, the
29905 &%dnslists%& condition is true. For example:
29906 .code
29907 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29908 .endd
29909 If you want to specify a constraining address list and also specify names or IP
29910 addresses to be looked up, the constraining address list must be specified
29911 first. For example:
29912 .code
29913 deny dnslists = dsn.rfc-ignorant.org\
29914                 =127.0.0.2/$sender_address_domain
29915 .endd
29916
29917 If the character &`&&`& is used instead of &`=`&, the comparison for each
29918 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29919 In other words, the listed addresses are used as bit masks. The comparison is
29920 true if all the bits in the mask are present in the address that is being
29921 tested. For example:
29922 .code
29923 dnslists = a.b.c&0.0.0.3
29924 .endd
29925 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29926 want to test whether one bit or another bit is present (as opposed to both
29927 being present), you must use multiple values. For example:
29928 .code
29929 dnslists = a.b.c&0.0.0.1,0.0.0.2
29930 .endd
29931 matches if the final component of the address is an odd number or two times
29932 an odd number.
29933
29934
29935
29936 .section "Negated DNS matching conditions" "SECID205"
29937 You can supply a negative list of IP addresses as part of a &%dnslists%&
29938 condition. Whereas
29939 .code
29940 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29941 .endd
29942 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29943 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29944 .code
29945 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29946 .endd
29947 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29948 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29949 words, the result of the test is inverted if an exclamation mark appears before
29950 the &`=`& (or the &`&&`&) sign.
29951
29952 &*Note*&: This kind of negation is not the same as negation in a domain,
29953 host, or address list (which is why the syntax is different).
29954
29955 If you are using just one list, the negation syntax does not gain you much. The
29956 previous example is precisely equivalent to
29957 .code
29958 deny  dnslists = a.b.c
29959      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29960 .endd
29961 However, if you are using multiple lists, the negation syntax is clearer.
29962 Consider this example:
29963 .code
29964 deny  dnslists = sbl.spamhaus.org : \
29965                  list.dsbl.org : \
29966                  dnsbl.njabl.org!=127.0.0.3 : \
29967                  relays.ordb.org
29968 .endd
29969 Using only positive lists, this would have to be:
29970 .code
29971 deny  dnslists = sbl.spamhaus.org : \
29972                  list.dsbl.org
29973 deny  dnslists = dnsbl.njabl.org
29974      !dnslists = dnsbl.njabl.org=127.0.0.3
29975 deny  dnslists = relays.ordb.org
29976 .endd
29977 which is less clear, and harder to maintain.
29978
29979
29980
29981
29982 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29983 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29984 thereby providing more than one IP address. When an item in a &%dnslists%& list
29985 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29986 the match to specific results from the DNS lookup, there are two ways in which
29987 the checking can be handled. For example, consider the condition:
29988 .code
29989 dnslists = a.b.c=127.0.0.1
29990 .endd
29991 What happens if the DNS lookup for the incoming IP address yields both
29992 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29993 condition true because at least one given value was found, or is it false
29994 because at least one of the found values was not listed? And how does this
29995 affect negated conditions? Both possibilities are provided for with the help of
29996 additional separators &`==`& and &`=&&`&.
29997
29998 .ilist
29999 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30000 IP addresses matches one of the listed addresses. For the example above, the
30001 condition is true because 127.0.0.1 matches.
30002 .next
30003 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30004 looked up IP addresses matches one of the listed addresses. If the condition is
30005 changed to:
30006 .code
30007 dnslists = a.b.c==127.0.0.1
30008 .endd
30009 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30010 false because 127.0.0.2 is not listed. You would need to have:
30011 .code
30012 dnslists = a.b.c==127.0.0.1,127.0.0.2
30013 .endd
30014 for the condition to be true.
30015 .endlist
30016
30017 When &`!`& is used to negate IP address matching, it inverts the result, giving
30018 the precise opposite of the behaviour above. Thus:
30019 .ilist
30020 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30021 addresses matches one of the listed addresses. Consider:
30022 .code
30023 dnslists = a.b.c!&0.0.0.1
30024 .endd
30025 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30026 false because 127.0.0.1 matches.
30027 .next
30028 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30029 looked up IP address that does not match. Consider:
30030 .code
30031 dnslists = a.b.c!=&0.0.0.1
30032 .endd
30033 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30034 true, because 127.0.0.2 does not match. You would need to have:
30035 .code
30036 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30037 .endd
30038 for the condition to be false.
30039 .endlist
30040 When the DNS lookup yields only a single IP address, there is no difference
30041 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30042
30043
30044
30045
30046 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30047 .cindex "DNS list" "information from merged"
30048 When the facility for restricting the matching IP values in a DNS list is used,
30049 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30050 the true reason for rejection. This happens when lists are merged and the IP
30051 address in the A record is used to distinguish them; unfortunately there is
30052 only one TXT record. One way round this is not to use merged lists, but that
30053 can be inefficient because it requires multiple DNS lookups where one would do
30054 in the vast majority of cases when the host of interest is not on any of the
30055 lists.
30056
30057 A less inefficient way of solving this problem is available. If
30058 two domain names, comma-separated, are given, the second is used first to
30059 do an initial check, making use of any IP value restrictions that are set.
30060 If there is a match, the first domain is used, without any IP value
30061 restrictions, to get the TXT record. As a byproduct of this, there is also
30062 a check that the IP being tested is indeed on the first list. The first
30063 domain is the one that is put in &$dnslist_domain$&. For example:
30064 .code
30065 reject message  = \
30066          rejected because $sender_host_address is blacklisted \
30067          at $dnslist_domain\n$dnslist_text
30068        dnslists = \
30069          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30070          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30071 .endd
30072 For the first blacklist item, this starts by doing a lookup in
30073 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30074 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30075 value, and as long as something is found, it looks for the corresponding TXT
30076 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30077 The second blacklist item is processed similarly.
30078
30079 If you are interested in more than one merged list, the same list must be
30080 given several times, but because the results of the DNS lookups are cached,
30081 the DNS calls themselves are not repeated. For example:
30082 .code
30083 reject dnslists = \
30084          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30085          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30086          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30087          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30088 .endd
30089 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30090 values matches (or if no record is found), this is the only lookup that is
30091 done. Only if there is a match is one of the more specific lists consulted.
30092
30093
30094
30095 .section "DNS lists and IPv6" "SECTmorednslistslast"
30096 .cindex "IPv6" "DNS black lists"
30097 .cindex "DNS list" "IPv6 usage"
30098 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30099 nibble by nibble. For example, if the calling host's IP address is
30100 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30101 .code
30102 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30103   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30104 .endd
30105 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30106 lists contain wildcard records, intended for IPv4, that interact badly with
30107 IPv6. For example, the DNS entry
30108 .code
30109 *.3.some.list.example.    A    127.0.0.1
30110 .endd
30111 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30112 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30113
30114 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30115 &%condition%& condition, as in this example:
30116 .code
30117 deny   condition = ${if isip4{$sender_host_address}}
30118        dnslists  = some.list.example
30119 .endd
30120
30121 If an explicit key is being used for a DNS lookup and it may be an IPv6
30122 address you should specify alternate list separators for both the outer
30123 (DNS list name) list and inner (lookup keys) list:
30124 .code
30125        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30126 .endd
30127
30128 .section "Rate limiting incoming messages" "SECTratelimiting"
30129 .cindex "rate limiting" "client sending"
30130 .cindex "limiting client sending rates"
30131 .oindex "&%smtp_ratelimit_*%&"
30132 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30133 which clients can send email. This is more powerful than the
30134 &%smtp_ratelimit_*%& options, because those options control the rate of
30135 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30136 works across all connections (concurrent and sequential) from the same client
30137 host. The syntax of the &%ratelimit%& condition is:
30138 .display
30139 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30140 .endd
30141 If the average client sending rate is less than &'m'& messages per time
30142 period &'p'& then the condition is false; otherwise it is true.
30143
30144 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30145 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30146 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30147 of &'p'&.
30148
30149 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30150 time interval, for example, &`8h`& for eight hours. A larger time constant
30151 means that it takes Exim longer to forget a client's past behaviour. The
30152 parameter &'m'& is the maximum number of messages that a client is permitted to
30153 send in each time interval. It also specifies the number of messages permitted
30154 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30155 constant, you can allow a client to send more messages in a burst without
30156 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30157 both small, messages must be sent at an even rate.
30158
30159 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30160 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30161 when deploying the &%ratelimit%& ACL condition. The script prints usage
30162 instructions when it is run with no arguments.
30163
30164 The key is used to look up the data for calculating the client's average
30165 sending rate. This data is stored in Exim's spool directory, alongside the
30166 retry and other hints databases. The default key is &$sender_host_address$&,
30167 which means Exim computes the sending rate of each client host IP address.
30168 By changing the key you can change how Exim identifies clients for the purpose
30169 of ratelimiting. For example, to limit the sending rate of each authenticated
30170 user, independent of the computer they are sending from, set the key to
30171 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30172 example, &$authenticated_id$& is only meaningful if the client has
30173 authenticated (which you can check with the &%authenticated%& ACL condition).
30174
30175 The lookup key does not have to identify clients: If you want to limit the
30176 rate at which a recipient receives messages, you can use the key
30177 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30178 ACL.
30179
30180 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30181 specifies what Exim measures the rate of, for example messages or recipients
30182 or bytes. You can adjust the measurement using the &%unique=%& and/or
30183 &%count=%& options. You can also control when Exim updates the recorded rate
30184 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30185 separated by a slash, like the other parameters. They may appear in any order.
30186
30187 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30188 any options that alter the meaning of the stored data. The limit &'m'& is not
30189 stored, so you can alter the configured maximum rate and Exim will still
30190 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30191 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30192 behaviour. The lookup key is not affected by changes to the update mode and
30193 the &%count=%& option.
30194
30195
30196 .section "Ratelimit options for what is being measured" "ratoptmea"
30197 .cindex "rate limiting" "per_* options"
30198 The &%per_conn%& option limits the client's connection rate. It is not
30199 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30200 &%acl_not_smtp_start%& ACLs.
30201
30202 The &%per_mail%& option limits the client's rate of sending messages. This is
30203 the default if none of the &%per_*%& options is specified. It can be used in
30204 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30205 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30206
30207 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30208 the same ACLs as the &%per_mail%& option, though it is best to use this option
30209 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30210 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30211 in its MAIL command, which may be inaccurate or completely missing. You can
30212 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30213 in kilobytes, megabytes, or gigabytes, respectively.
30214
30215 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30216 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30217 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30218 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30219 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30220 in either case the rate limiting engine will see a message with many
30221 recipients as a large high-speed burst.
30222
30223 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30224 number of different recipients that the client has sent messages to in the
30225 last time period. That is, if the client repeatedly sends messages to the same
30226 recipient, its measured rate is not increased. This option can only be used in
30227 &%acl_smtp_rcpt%&.
30228
30229 The &%per_cmd%& option causes Exim to recompute the rate every time the
30230 condition is processed. This can be used to limit the rate of any SMTP
30231 command. If it is used in multiple ACLs it can limit the aggregate rate of
30232 multiple different commands.
30233
30234 The &%count=%& option can be used to alter how much Exim adds to the client's
30235 measured rate. For example, the &%per_byte%& option is equivalent to
30236 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30237 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30238 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30239
30240 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30241
30242
30243 .section "Ratelimit update modes" "ratoptupd"
30244 .cindex "rate limiting" "reading data without updating"
30245 You can specify one of three options with the &%ratelimit%& condition to
30246 control when its database is updated. This section describes the &%readonly%&
30247 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30248
30249 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30250 previously-computed rate to check against the limit.
30251
30252 For example, you can test the client's sending rate and deny it access (when
30253 it is too fast) in the connect ACL. If the client passes this check then it
30254 can go on to send a message, in which case its recorded rate will be updated
30255 in the MAIL ACL. Subsequent connections from the same client will check this
30256 new rate.
30257 .code
30258 acl_check_connect:
30259  deny ratelimit = 100 / 5m / readonly
30260     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30261                   (max $sender_rate_limit)
30262 # ...
30263 acl_check_mail:
30264  warn ratelimit = 100 / 5m / strict
30265     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30266                   (max $sender_rate_limit)
30267 .endd
30268
30269 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30270 processing a message then it may increase the client's measured rate more than
30271 it should. For example, this will happen if you check the &%per_rcpt%& option
30272 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30273 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30274 multiple update problems by using the &%readonly%& option on later ratelimit
30275 checks.
30276
30277 The &%per_*%& options described above do not make sense in some ACLs. If you
30278 use a &%per_*%& option in an ACL where it is not normally permitted then the
30279 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30280 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30281 next section) so you must specify the &%readonly%& option explicitly.
30282
30283
30284 .section "Ratelimit options for handling fast clients" "ratoptfast"
30285 .cindex "rate limiting" "strict and leaky modes"
30286 If a client's average rate is greater than the maximum, the rate limiting
30287 engine can react in two possible ways, depending on the presence of the
30288 &%strict%& or &%leaky%& update modes. This is independent of the other
30289 counter-measures (such as rejecting the message) that may be specified by the
30290 rest of the ACL.
30291
30292 The &%leaky%& (default) option means that the client's recorded rate is not
30293 updated if it is above the limit. The effect of this is that Exim measures the
30294 client's average rate of successfully sent email, which cannot be greater than
30295 the maximum allowed. If the client is over the limit it may suffer some
30296 counter-measures (as specified in the ACL), but it will still be able to send
30297 email at the configured maximum rate, whatever the rate of its attempts. This
30298 is generally the better choice if you have clients that retry automatically.
30299 For example, it does not prevent a sender with an over-aggressive retry rate
30300 from getting any email through.
30301
30302 The &%strict%& option means that the client's recorded rate is always
30303 updated. The effect of this is that Exim measures the client's average rate
30304 of attempts to send email, which can be much higher than the maximum it is
30305 actually allowed. If the client is over the limit it may be subjected to
30306 counter-measures by the ACL. It must slow down and allow sufficient time to
30307 pass that its computed rate falls below the maximum before it can send email
30308 again. The time (the number of smoothing periods) it must wait and not
30309 attempt to send mail can be calculated with this formula:
30310 .code
30311         ln(peakrate/maxrate)
30312 .endd
30313
30314
30315 .section "Limiting the rate of different events" "ratoptuniq"
30316 .cindex "rate limiting" "counting unique events"
30317 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30318 rate of different events. For example, the &%per_addr%& option uses this
30319 mechanism to count the number of different recipients that the client has
30320 sent messages to in the last time period; it is equivalent to
30321 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30322 measure the rate that a client uses different sender addresses with the
30323 options &`per_mail/unique=$sender_address`&.
30324
30325 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30326 has seen for that key. The whole set is thrown away when it is older than the
30327 rate smoothing period &'p'&, so each different event is counted at most once
30328 per period. In the &%leaky%& update mode, an event that causes the client to
30329 go over the limit is not added to the set, in the same way that the client's
30330 recorded rate is not updated in the same situation.
30331
30332 When you combine the &%unique=%& and &%readonly%& options, the specific
30333 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30334 rate.
30335
30336 The &%unique=%& mechanism needs more space in the ratelimit database than the
30337 other &%ratelimit%& options in order to store the event set. The number of
30338 unique values is potentially as large as the rate limit, so the extra space
30339 required increases with larger limits.
30340
30341 The uniqueification is not perfect: there is a small probability that Exim
30342 will think a new event has happened before. If the sender's rate is less than
30343 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30344 the measured rate can go above the limit, in which case Exim may under-count
30345 events by a significant margin. Fortunately, if the rate is high enough (2.7
30346 times the limit) that the false positive rate goes above 9%, then Exim will
30347 throw away the over-full event set before the measured rate falls below the
30348 limit. Therefore the only harm should be that exceptionally high sending rates
30349 are logged incorrectly; any countermeasures you configure will be as effective
30350 as intended.
30351
30352
30353 .section "Using rate limiting" "useratlim"
30354 Exim's other ACL facilities are used to define what counter-measures are taken
30355 when the rate limit is exceeded. This might be anything from logging a warning
30356 (for example, while measuring existing sending rates in order to define
30357 policy), through time delays to slow down fast senders, up to rejecting the
30358 message. For example:
30359 .code
30360 # Log all senders' rates
30361 warn ratelimit = 0 / 1h / strict
30362      log_message = Sender rate $sender_rate / $sender_rate_period
30363
30364 # Slow down fast senders; note the need to truncate $sender_rate
30365 # at the decimal point.
30366 warn ratelimit = 100 / 1h / per_rcpt / strict
30367      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30368                    $sender_rate_limit }s
30369
30370 # Keep authenticated users under control
30371 deny authenticated = *
30372      ratelimit = 100 / 1d / strict / $authenticated_id
30373
30374 # System-wide rate limit
30375 defer message = Sorry, too busy. Try again later.
30376      ratelimit = 10 / 1s / $primary_hostname
30377
30378 # Restrict incoming rate from each host, with a default
30379 # set using a macro and special cases looked up in a table.
30380 defer message = Sender rate exceeds $sender_rate_limit \
30381                messages per $sender_rate_period
30382      ratelimit = ${lookup {$sender_host_address} \
30383                    cdb {DB/ratelimits.cdb} \
30384                    {$value} {RATELIMIT} }
30385 .endd
30386 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30387 especially with the &%per_rcpt%& option, you may suffer from a performance
30388 bottleneck caused by locking on the ratelimit hints database. Apart from
30389 making your ACLs less complicated, you can reduce the problem by using a
30390 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30391 this means that Exim will lose its hints data after a reboot (including retry
30392 hints, the callout cache, and ratelimit data).
30393
30394
30395
30396 .section "Address verification" "SECTaddressverification"
30397 .cindex "verifying address" "options for"
30398 .cindex "policy control" "address verification"
30399 Several of the &%verify%& conditions described in section
30400 &<<SECTaclconditions>>& cause addresses to be verified. Section
30401 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30402 The verification conditions can be followed by options that modify the
30403 verification process. The options are separated from the keyword and from each
30404 other by slashes, and some of them contain parameters. For example:
30405 .code
30406 verify = sender/callout
30407 verify = recipient/defer_ok/callout=10s,defer_ok
30408 .endd
30409 The first stage of address verification, which always happens, is to run the
30410 address through the routers, in &"verify mode"&. Routers can detect the
30411 difference between verification and routing for delivery, and their actions can
30412 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30413 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30414 The available options are as follows:
30415
30416 .ilist
30417 If the &%callout%& option is specified, successful routing to one or more
30418 remote hosts is followed by a &"callout"& to those hosts as an additional
30419 check. Callouts and their sub-options are discussed in the next section.
30420 .next
30421 If there is a defer error while doing verification routing, the ACL
30422 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30423 options, the condition is forced to be true instead. Note that this is a main
30424 verification option as well as a suboption for callouts.
30425 .next
30426 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30427 discusses the reporting of sender address verification failures.
30428 .next
30429 The &%success_on_redirect%& option causes verification always to succeed
30430 immediately after a successful redirection. By default, if a redirection
30431 generates just one address, that address is also verified. See further
30432 discussion in section &<<SECTredirwhilveri>>&.
30433 .endlist
30434
30435 .cindex "verifying address" "differentiating failures"
30436 .vindex "&$recipient_verify_failure$&"
30437 .vindex "&$sender_verify_failure$&"
30438 .vindex "&$acl_verify_message$&"
30439 After an address verification failure, &$acl_verify_message$& contains the
30440 error message that is associated with the failure. It can be preserved by
30441 coding like this:
30442 .code
30443 warn  !verify = sender
30444        set acl_m0 = $acl_verify_message
30445 .endd
30446 If you are writing your own custom rejection message or log message when
30447 denying access, you can use this variable to include information about the
30448 verification failure.
30449
30450 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30451 appropriate) contains one of the following words:
30452
30453 .ilist
30454 &%qualify%&: The address was unqualified (no domain), and the message
30455 was neither local nor came from an exempted host.
30456 .next
30457 &%route%&: Routing failed.
30458 .next
30459 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30460 occurred at or before the MAIL command (that is, on initial
30461 connection, HELO, or MAIL).
30462 .next
30463 &%recipient%&: The RCPT command in a callout was rejected.
30464 .next
30465 &%postmaster%&: The postmaster check in a callout was rejected.
30466 .endlist
30467
30468 The main use of these variables is expected to be to distinguish between
30469 rejections of MAIL and rejections of RCPT in callouts.
30470
30471
30472
30473
30474 .section "Callout verification" "SECTcallver"
30475 .cindex "verifying address" "by callout"
30476 .cindex "callout" "verification"
30477 .cindex "SMTP" "callout verification"
30478 For non-local addresses, routing verifies the domain, but is unable to do any
30479 checking of the local part. There are situations where some means of verifying
30480 the local part is desirable. One way this can be done is to make an SMTP
30481 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30482 a subsequent host for a recipient address, to see if the host accepts the
30483 address. We use the term &'callout'& to cover both cases. Note that for a
30484 sender address, the callback is not to the client host that is trying to
30485 deliver the message, but to one of the hosts that accepts incoming mail for the
30486 sender's domain.
30487
30488 Exim does not do callouts by default. If you want them to happen, you must
30489 request them by setting appropriate options on the &%verify%& condition, as
30490 described below. This facility should be used with care, because it can add a
30491 lot of resource usage to the cost of verifying an address. However, Exim does
30492 cache the results of callouts, which helps to reduce the cost. Details of
30493 caching are in section &<<SECTcallvercache>>&.
30494
30495 Recipient callouts are usually used only between hosts that are controlled by
30496 the same administration. For example, a corporate gateway host could use
30497 callouts to check for valid recipients on an internal mailserver. A successful
30498 callout does not guarantee that a real delivery to the address would succeed;
30499 on the other hand, a failing callout does guarantee that a delivery would fail.
30500
30501 If the &%callout%& option is present on a condition that verifies an address, a
30502 second stage of verification occurs if the address is successfully routed to
30503 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30504 &(manualroute)& router, where the router specifies the hosts. However, if a
30505 router that does not set up hosts routes to an &(smtp)& transport with a
30506 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30507 &%hosts_override%& set, its hosts are always used, whether or not the router
30508 supplies a host list.
30509 Callouts are only supported on &(smtp)& transports.
30510
30511 The port that is used is taken from the transport, if it is specified and is a
30512 remote transport. (For routers that do verification only, no transport need be
30513 specified.) Otherwise, the default SMTP port is used. If a remote transport
30514 specifies an outgoing interface, this is used; otherwise the interface is not
30515 specified. Likewise, the text that is used for the HELO command is taken from
30516 the transport's &%helo_data%& option; if there is no transport, the value of
30517 &$smtp_active_hostname$& is used.
30518
30519 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30520 test whether a bounce message could be delivered to the sender address. The
30521 following SMTP commands are sent:
30522 .display
30523 &`HELO `&<&'local host name'&>
30524 &`MAIL FROM:<>`&
30525 &`RCPT TO:`&<&'the address to be tested'&>
30526 &`QUIT`&
30527 .endd
30528 LHLO is used instead of HELO if the transport's &%protocol%& option is
30529 set to &"lmtp"&.
30530
30531 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30532 settings.
30533
30534 A recipient callout check is similar. By default, it also uses an empty address
30535 for the sender. This default is chosen because most hosts do not make use of
30536 the sender address when verifying a recipient. Using the same address means
30537 that a single cache entry can be used for each recipient. Some sites, however,
30538 do make use of the sender address when verifying. These are catered for by the
30539 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30540
30541 If the response to the RCPT command is a 2&'xx'& code, the verification
30542 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30543 Exim tries the next host, if any. If there is a problem with all the remote
30544 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30545 &%callout%& option is given, in which case the condition is forced to succeed.
30546
30547 .cindex "SMTP" "output flushing, disabling for callout"
30548 A callout may take a little time. For this reason, Exim normally flushes SMTP
30549 output before performing a callout in an ACL, to avoid unexpected timeouts in
30550 clients when the SMTP PIPELINING extension is in use. The flushing can be
30551 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30552
30553
30554
30555
30556 .section "Additional parameters for callouts" "CALLaddparcall"
30557 .cindex "callout" "additional parameters for"
30558 The &%callout%& option can be followed by an equals sign and a number of
30559 optional parameters, separated by commas. For example:
30560 .code
30561 verify = recipient/callout=10s,defer_ok
30562 .endd
30563 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30564 separate verify options, is retained for backwards compatibility, but is now
30565 deprecated. The additional parameters for &%callout%& are as follows:
30566
30567
30568 .vlist
30569 .vitem <&'a&~time&~interval'&>
30570 .cindex "callout" "timeout, specifying"
30571 This specifies the timeout that applies for the callout attempt to each host.
30572 For example:
30573 .code
30574 verify = sender/callout=5s
30575 .endd
30576 The default is 30 seconds. The timeout is used for each response from the
30577 remote host. It is also used for the initial connection, unless overridden by
30578 the &%connect%& parameter.
30579
30580
30581 .vitem &*connect&~=&~*&<&'time&~interval'&>
30582 .cindex "callout" "connection timeout, specifying"
30583 This parameter makes it possible to set a different (usually smaller) timeout
30584 for making the SMTP connection. For example:
30585 .code
30586 verify = sender/callout=5s,connect=1s
30587 .endd
30588 If not specified, this timeout defaults to the general timeout value.
30589
30590 .vitem &*defer_ok*&
30591 .cindex "callout" "defer, action on"
30592 When this parameter is present, failure to contact any host, or any other kind
30593 of temporary error, is treated as success by the ACL. However, the cache is not
30594 updated in this circumstance.
30595
30596 .vitem &*fullpostmaster*&
30597 .cindex "callout" "full postmaster check"
30598 This operates like the &%postmaster%& option (see below), but if the check for
30599 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30600 accordance with the specification in RFC 2821. The RFC states that the
30601 unqualified address &'postmaster'& should be accepted.
30602
30603
30604 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30605 .cindex "callout" "sender when verifying header"
30606 When verifying addresses in header lines using the &%header_sender%&
30607 verification option, Exim behaves by default as if the addresses are envelope
30608 sender addresses from a message. Callout verification therefore tests to see
30609 whether a bounce message could be delivered, by using an empty address in the
30610 MAIL command. However, it is arguable that these addresses might never be used
30611 as envelope senders, and could therefore justifiably reject bounce messages
30612 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30613 address to use in the MAIL command. For example:
30614 .code
30615 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30616 .endd
30617 This parameter is available only for the &%header_sender%& verification option.
30618
30619
30620 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30621 .cindex "callout" "overall timeout, specifying"
30622 This parameter sets an overall timeout for performing a callout verification.
30623 For example:
30624 .code
30625 verify = sender/callout=5s,maxwait=30s
30626 .endd
30627 This timeout defaults to four times the callout timeout for individual SMTP
30628 commands. The overall timeout applies when there is more than one host that can
30629 be tried. The timeout is checked before trying the next host. This prevents
30630 very long delays if there are a large number of hosts and all are timing out
30631 (for example, when network connections are timing out).
30632
30633
30634 .vitem &*no_cache*&
30635 .cindex "callout" "cache, suppressing"
30636 .cindex "caching callout, suppressing"
30637 When this parameter is given, the callout cache is neither read nor updated.
30638
30639 .vitem &*postmaster*&
30640 .cindex "callout" "postmaster; checking"
30641 When this parameter is set, a successful callout check is followed by a similar
30642 check for the local part &'postmaster'& at the same domain. If this address is
30643 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30644 the postmaster check is recorded in a cache record; if it is a failure, this is
30645 used to fail subsequent callouts for the domain without a connection being
30646 made, until the cache record expires.
30647
30648 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30649 The postmaster check uses an empty sender in the MAIL command by default.
30650 You can use this parameter to do a postmaster check using a different address.
30651 For example:
30652 .code
30653 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30654 .endd
30655 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30656 one overrides. The &%postmaster%& parameter is equivalent to this example:
30657 .code
30658 require  verify = sender/callout=postmaster_mailfrom=
30659 .endd
30660 &*Warning*&: The caching arrangements for postmaster checking do not take
30661 account of the sender address. It is assumed that either the empty address or
30662 a fixed non-empty address will be used. All that Exim remembers is that the
30663 postmaster check for the domain succeeded or failed.
30664
30665
30666 .vitem &*random*&
30667 .cindex "callout" "&""random""& check"
30668 When this parameter is set, before doing the normal callout check, Exim does a
30669 check for a &"random"& local part at the same domain. The local part is not
30670 really random &-- it is defined by the expansion of the option
30671 &%callout_random_local_part%&, which defaults to
30672 .code
30673 $primary_hostname-$tod_epoch-testing
30674 .endd
30675 The idea here is to try to determine whether the remote host accepts all local
30676 parts without checking. If it does, there is no point in doing callouts for
30677 specific local parts. If the &"random"& check succeeds, the result is saved in
30678 a cache record, and used to force the current and subsequent callout checks to
30679 succeed without a connection being made, until the cache record expires.
30680
30681 .vitem &*use_postmaster*&
30682 .cindex "callout" "sender for recipient check"
30683 This parameter applies to recipient callouts only. For example:
30684 .code
30685 deny  !verify = recipient/callout=use_postmaster
30686 .endd
30687 .vindex "&$qualify_domain$&"
30688 It causes a non-empty postmaster address to be used in the MAIL command when
30689 performing the callout for the recipient, and also for a &"random"& check if
30690 that is configured. The local part of the address is &`postmaster`& and the
30691 domain is the contents of &$qualify_domain$&.
30692
30693 .vitem &*use_sender*&
30694 This option applies to recipient callouts only. For example:
30695 .code
30696 require  verify = recipient/callout=use_sender
30697 .endd
30698 It causes the message's actual sender address to be used in the MAIL
30699 command when performing the callout, instead of an empty address. There is no
30700 need to use this option unless you know that the called hosts make use of the
30701 sender when checking recipients. If used indiscriminately, it reduces the
30702 usefulness of callout caching.
30703 .endlist
30704
30705 If you use any of the parameters that set a non-empty sender for the MAIL
30706 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30707 &%use_sender%&), you should think about possible loops. Recipient checking is
30708 usually done between two hosts that are under the same management, and the host
30709 that receives the callouts is not normally configured to do callouts itself.
30710 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30711 these circumstances.
30712
30713 However, if you use a non-empty sender address for a callout to an arbitrary
30714 host, there is the likelihood that the remote host will itself initiate a
30715 callout check back to your host. As it is checking what appears to be a message
30716 sender, it is likely to use an empty address in MAIL, thus avoiding a
30717 callout loop. However, to be on the safe side it would be best to set up your
30718 own ACLs so that they do not do sender verification checks when the recipient
30719 is the address you use for header sender or postmaster callout checking.
30720
30721 Another issue to think about when using non-empty senders for callouts is
30722 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30723 by the sender/recipient combination; thus, for any given recipient, many more
30724 actual callouts are performed than when an empty sender or postmaster is used.
30725
30726
30727
30728
30729 .section "Callout caching" "SECTcallvercache"
30730 .cindex "hints database" "callout cache"
30731 .cindex "callout" "cache, description of"
30732 .cindex "caching" "callout"
30733 Exim caches the results of callouts in order to reduce the amount of resources
30734 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30735 option. A hints database called &"callout"& is used for the cache. Two
30736 different record types are used: one records the result of a callout check for
30737 a specific address, and the other records information that applies to the
30738 entire domain (for example, that it accepts the local part &'postmaster'&).
30739
30740 When an original callout fails, a detailed SMTP error message is given about
30741 the failure. However, for subsequent failures use the cache data, this message
30742 is not available.
30743
30744 The expiry times for negative and positive address cache records are
30745 independent, and can be set by the global options &%callout_negative_expire%&
30746 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30747
30748 If a host gives a negative response to an SMTP connection, or rejects any
30749 commands up to and including
30750 .code
30751 MAIL FROM:<>
30752 .endd
30753 (but not including the MAIL command with a non-empty address),
30754 any callout attempt is bound to fail. Exim remembers such failures in a
30755 domain cache record, which it uses to fail callouts for the domain without
30756 making new connections, until the domain record times out. There are two
30757 separate expiry times for domain cache records:
30758 &%callout_domain_negative_expire%& (default 3h) and
30759 &%callout_domain_positive_expire%& (default 7d).
30760
30761 Domain records expire when the negative expiry time is reached if callouts
30762 cannot be made for the domain, or if the postmaster check failed.
30763 Otherwise, they expire when the positive expiry time is reached. This
30764 ensures that, for example, a host that stops accepting &"random"& local parts
30765 will eventually be noticed.
30766
30767 The callout caching mechanism is based on the domain of the address that is
30768 being tested. If the domain routes to several hosts, it is assumed that their
30769 behaviour will be the same.
30770
30771
30772
30773 .section "Sender address verification reporting" "SECTsenaddver"
30774 .cindex "verifying" "suppressing error details"
30775 See section &<<SECTaddressverification>>& for a general discussion of
30776 verification. When sender verification fails in an ACL, the details of the
30777 failure are given as additional output lines before the 550 response to the
30778 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30779 you might see:
30780 .code
30781 MAIL FROM:<xyz@abc.example>
30782 250 OK
30783 RCPT TO:<pqr@def.example>
30784 550-Verification failed for <xyz@abc.example>
30785 550-Called:   192.168.34.43
30786 550-Sent:     RCPT TO:<xyz@abc.example>
30787 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30788 550 Sender verification failed
30789 .endd
30790 If more than one RCPT command fails in the same way, the details are given
30791 only for the first of them. However, some administrators do not want to send
30792 out this much information. You can suppress the details by adding
30793 &`/no_details`& to the ACL statement that requests sender verification. For
30794 example:
30795 .code
30796 verify = sender/no_details
30797 .endd
30798
30799 .section "Redirection while verifying" "SECTredirwhilveri"
30800 .cindex "verifying" "redirection while"
30801 .cindex "address redirection" "while verifying"
30802 A dilemma arises when a local address is redirected by aliasing or forwarding
30803 during verification: should the generated addresses themselves be verified,
30804 or should the successful expansion of the original address be enough to verify
30805 it? By default, Exim takes the following pragmatic approach:
30806
30807 .ilist
30808 When an incoming address is redirected to just one child address, verification
30809 continues with the child address, and if that fails to verify, the original
30810 verification also fails.
30811 .next
30812 When an incoming address is redirected to more than one child address,
30813 verification does not continue. A success result is returned.
30814 .endlist
30815
30816 This seems the most reasonable behaviour for the common use of aliasing as a
30817 way of redirecting different local parts to the same mailbox. It means, for
30818 example, that a pair of alias entries of the form
30819 .code
30820 A.Wol:   aw123
30821 aw123:   :fail: Gone away, no forwarding address
30822 .endd
30823 work as expected, with both local parts causing verification failure. When a
30824 redirection generates more than one address, the behaviour is more like a
30825 mailing list, where the existence of the alias itself is sufficient for
30826 verification to succeed.
30827
30828 It is possible, however, to change the default behaviour so that all successful
30829 redirections count as successful verifications, however many new addresses are
30830 generated. This is specified by the &%success_on_redirect%& verification
30831 option. For example:
30832 .code
30833 require verify = recipient/success_on_redirect/callout=10s
30834 .endd
30835 In this example, verification succeeds if a router generates a new address, and
30836 the callout does not occur, because no address was routed to a remote host.
30837
30838 When verification is being tested via the &%-bv%& option, the treatment of
30839 redirections is as just described, unless the &%-v%& or any debugging option is
30840 also specified. In that case, full verification is done for every generated
30841 address and a report is output for each of them.
30842
30843
30844
30845 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30846 .cindex "CSA" "verifying"
30847 Client SMTP Authorization is a system that allows a site to advertise
30848 which machines are and are not permitted to send email. This is done by placing
30849 special SRV records in the DNS; these are looked up using the client's HELO
30850 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30851 Authorization checks in Exim are performed by the ACL condition:
30852 .code
30853 verify = csa
30854 .endd
30855 This fails if the client is not authorized. If there is a DNS problem, or if no
30856 valid CSA SRV record is found, or if the client is authorized, the condition
30857 succeeds. These three cases can be distinguished using the expansion variable
30858 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30859 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30860 be likely to cause problems for legitimate email.
30861
30862 The error messages produced by the CSA code include slightly more
30863 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30864 looking up the CSA SRV record, or problems looking up the CSA target
30865 address record. There are four reasons for &$csa_status$& being &"fail"&:
30866
30867 .ilist
30868 The client's host name is explicitly not authorized.
30869 .next
30870 The client's IP address does not match any of the CSA target IP addresses.
30871 .next
30872 The client's host name is authorized but it has no valid target IP addresses
30873 (for example, the target's addresses are IPv6 and the client is using IPv4).
30874 .next
30875 The client's host name has no CSA SRV record but a parent domain has asserted
30876 that all subdomains must be explicitly authorized.
30877 .endlist
30878
30879 The &%csa%& verification condition can take an argument which is the domain to
30880 use for the DNS query. The default is:
30881 .code
30882 verify = csa/$sender_helo_name
30883 .endd
30884 This implementation includes an extension to CSA. If the query domain
30885 is an address literal such as [192.0.2.95], or if it is a bare IP
30886 address, Exim searches for CSA SRV records in the reverse DNS as if
30887 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30888 meaningful to say:
30889 .code
30890 verify = csa/$sender_host_address
30891 .endd
30892 In fact, this is the check that Exim performs if the client does not say HELO.
30893 This extension can be turned off by setting the main configuration option
30894 &%dns_csa_use_reverse%& to be false.
30895
30896 If a CSA SRV record is not found for the domain itself, a search
30897 is performed through its parent domains for a record which might be
30898 making assertions about subdomains. The maximum depth of this search is limited
30899 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30900 default. Exim does not look for CSA SRV records in a top level domain, so the
30901 default settings handle HELO domains as long as seven
30902 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30903 of legitimate HELO domains.
30904
30905 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30906 direct SRV lookups, this is not sufficient because of the extra parent domain
30907 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30908 addresses into lookups in the reverse DNS space. The result of a successful
30909 lookup such as:
30910 .code
30911 ${lookup dnsdb {csa=$sender_helo_name}}
30912 .endd
30913 has two space-separated fields: an authorization code and a target host name.
30914 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30915 authorization required but absent, or &"?"& for unknown.
30916
30917
30918
30919
30920 .section "Bounce address tag validation" "SECTverifyPRVS"
30921 .cindex "BATV, verifying"
30922 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30923 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30924 Genuine incoming bounce messages should therefore always be addressed to
30925 recipients that have a valid tag. This scheme is a way of detecting unwanted
30926 bounce messages caused by sender address forgeries (often called &"collateral
30927 spam"&), because the recipients of such messages do not include valid tags.
30928
30929 There are two expansion items to help with the implementation of the BATV
30930 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30931 the original envelope sender address by using a simple key to add a hash of the
30932 address and some time-based randomizing information. The &%prvs%& expansion
30933 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30934 The syntax of these expansion items is described in section
30935 &<<SECTexpansionitems>>&.
30936
30937 As an example, suppose the secret per-address keys are stored in an MySQL
30938 database. A query to look up the key for an address could be defined as a macro
30939 like this:
30940 .code
30941 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30942                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30943                 }{$value}}
30944 .endd
30945 Suppose also that the senders who make use of BATV are defined by an address
30946 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30947 use this:
30948 .code
30949 # Bounces: drop unsigned addresses for BATV senders
30950 deny message = This address does not send an unsigned reverse path
30951      senders = :
30952      recipients = +batv_senders
30953
30954 # Bounces: In case of prvs-signed address, check signature.
30955 deny message = Invalid reverse path signature.
30956      senders = :
30957      condition  = ${prvscheck {$local_part@$domain}\
30958                   {PRVSCHECK_SQL}{1}}
30959      !condition = $prvscheck_result
30960 .endd
30961 The first statement rejects recipients for bounce messages that are addressed
30962 to plain BATV sender addresses, because it is known that BATV senders do not
30963 send out messages with plain sender addresses. The second statement rejects
30964 recipients that are prvs-signed, but with invalid signatures (either because
30965 the key is wrong, or the signature has timed out).
30966
30967 A non-prvs-signed address is not rejected by the second statement, because the
30968 &%prvscheck%& expansion yields an empty string if its first argument is not a
30969 prvs-signed address, thus causing the &%condition%& condition to be false. If
30970 the first argument is a syntactically valid prvs-signed address, the yield is
30971 the third string (in this case &"1"&), whether or not the cryptographic and
30972 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30973 of the checks (empty for failure, &"1"& for success).
30974
30975 There is one more issue you must consider when implementing prvs-signing:
30976 you have to ensure that the routers accept prvs-signed addresses and
30977 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30978 router to remove the signature with a configuration along these lines:
30979 .code
30980 batv_redirect:
30981   driver = redirect
30982   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30983 .endd
30984 This works because, if the third argument of &%prvscheck%& is empty, the result
30985 of the expansion of a prvs-signed address is the decoded value of the original
30986 address. This router should probably be the first of your routers that handles
30987 local addresses.
30988
30989 To create BATV-signed addresses in the first place, a transport of this form
30990 can be used:
30991 .code
30992 external_smtp_batv:
30993   driver = smtp
30994   return_path = ${prvs {$return_path} \
30995                        {${lookup mysql{SELECT \
30996                        secret FROM batv_prvs WHERE \
30997                        sender='${quote_mysql:$sender_address}'} \
30998                        {$value}fail}}}
30999 .endd
31000 If no key can be found for the existing return path, no signing takes place.
31001
31002
31003
31004 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31005 .cindex "&ACL;" "relay control"
31006 .cindex "relaying" "control by ACL"
31007 .cindex "policy control" "relay control"
31008 An MTA is said to &'relay'& a message if it receives it from some host and
31009 delivers it directly to another host as a result of a remote address contained
31010 within it. Redirecting a local address via an alias or forward file and then
31011 passing the message on to another host is not relaying,
31012 .cindex "&""percent hack""&"
31013 but a redirection as a result of the &"percent hack"& is.
31014
31015 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31016 A host which is acting as a gateway or an MX backup is concerned with incoming
31017 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31018 a host which is acting as a smart host for a number of clients is concerned
31019 with outgoing relaying from those clients to the Internet at large. Often the
31020 same host is fulfilling both functions,
31021 . ///
31022 . as illustrated in the diagram below,
31023 . ///
31024 but in principle these two kinds of relaying are entirely independent. What is
31025 not wanted is the transmission of mail from arbitrary remote hosts through your
31026 system to arbitrary domains.
31027
31028
31029 You can implement relay control by means of suitable statements in the ACL that
31030 runs for each RCPT command. For convenience, it is often easiest to use
31031 Exim's named list facility to define the domains and hosts involved. For
31032 example, suppose you want to do the following:
31033
31034 .ilist
31035 Deliver a number of domains to mailboxes on the local host (or process them
31036 locally in some other way). Let's say these are &'my.dom1.example'& and
31037 &'my.dom2.example'&.
31038 .next
31039 Relay mail for a number of other domains for which you are the secondary MX.
31040 These might be &'friend1.example'& and &'friend2.example'&.
31041 .next
31042 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31043 Suppose your LAN is 192.168.45.0/24.
31044 .endlist
31045
31046
31047 In the main part of the configuration, you put the following definitions:
31048 .code
31049 domainlist local_domains    = my.dom1.example : my.dom2.example
31050 domainlist relay_to_domains = friend1.example : friend2.example
31051 hostlist   relay_from_hosts = 192.168.45.0/24
31052 .endd
31053 Now you can use these definitions in the ACL that is run for every RCPT
31054 command:
31055 .code
31056 acl_check_rcpt:
31057   accept domains = +local_domains : +relay_to_domains
31058   accept hosts   = +relay_from_hosts
31059 .endd
31060 The first statement accepts any RCPT command that contains an address in
31061 the local or relay domains. For any other domain, control passes to the second
31062 statement, which accepts the command only if it comes from one of the relay
31063 hosts. In practice, you will probably want to make your ACL more sophisticated
31064 than this, for example, by including sender and recipient verification. The
31065 default configuration includes a more comprehensive example, which is described
31066 in chapter &<<CHAPdefconfil>>&.
31067
31068
31069
31070 .section "Checking a relay configuration" "SECTcheralcon"
31071 .cindex "relaying" "checking control of"
31072 You can check the relay characteristics of your configuration in the same way
31073 that you can test any ACL behaviour for an incoming SMTP connection, by using
31074 the &%-bh%& option to run a fake SMTP session with which you interact.
31075 .ecindex IIDacl
31076
31077
31078
31079 . ////////////////////////////////////////////////////////////////////////////
31080 . ////////////////////////////////////////////////////////////////////////////
31081
31082 .chapter "Content scanning at ACL time" "CHAPexiscan"
31083 .scindex IIDcosca "content scanning" "at ACL time"
31084 The extension of Exim to include content scanning at ACL time, formerly known
31085 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31086 was integrated into the main source for Exim release 4.50, and Tom continues to
31087 maintain it. Most of the wording of this chapter is taken from Tom's
31088 specification.
31089
31090 It is also possible to scan the content of messages at other times. The
31091 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31092 scanning after all the ACLs have run. A transport filter can be used to scan
31093 messages at delivery time (see the &%transport_filter%& option, described in
31094 chapter &<<CHAPtransportgeneric>>&).
31095
31096 If you want to include the ACL-time content-scanning features when you compile
31097 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31098 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31099
31100 .ilist
31101 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31102 for all MIME parts for SMTP and non-SMTP messages, respectively.
31103 .next
31104 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31105 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31106 run at the end of message reception (the &%acl_smtp_data%& ACL).
31107 .next
31108 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31109 of messages, or parts of messages, for debugging purposes.
31110 .next
31111 Additional expansion variables that are set in the new ACL and by the new
31112 conditions.
31113 .next
31114 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31115 .endlist
31116
31117 Content-scanning is continually evolving, and new features are still being
31118 added. While such features are still unstable and liable to incompatible
31119 changes, they are made available in Exim by setting options whose names begin
31120 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31121 this manual. You can find out about them by reading the file called
31122 &_doc/experimental.txt_&.
31123
31124 All the content-scanning facilities work on a MBOX copy of the message that is
31125 temporarily created in a file called:
31126 .display
31127 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31128 .endd
31129 The &_.eml_& extension is a friendly hint to virus scanners that they can
31130 expect an MBOX-like structure inside that file. The file is created when the
31131 first content scanning facility is called. Subsequent calls to content
31132 scanning conditions open the same file again. The directory is recursively
31133 removed when the &%acl_smtp_data%& ACL has finished running, unless
31134 .code
31135 control = no_mbox_unspool
31136 .endd
31137 has been encountered. When the MIME ACL decodes files, they are put into the
31138 same directory by default.
31139
31140
31141
31142 .section "Scanning for viruses" "SECTscanvirus"
31143 .cindex "virus scanning"
31144 .cindex "content scanning" "for viruses"
31145 .cindex "content scanning" "the &%malware%& condition"
31146 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31147 It supports a &"generic"& interface to scanners called via the shell, and
31148 specialized interfaces for &"daemon"& type virus scanners, which are resident
31149 in memory and thus are much faster.
31150
31151 A timeout of 2 minutes is applied to a scanner call (by default);
31152 if it expires then a defer action is taken.
31153
31154 .oindex "&%av_scanner%&"
31155 You can set the &%av_scanner%& option in the main part of the configuration
31156 to specify which scanner to use, together with any additional options that
31157 are needed. The basic syntax is as follows:
31158 .display
31159 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31160 .endd
31161 If you do not set &%av_scanner%&, it defaults to
31162 .code
31163 av_scanner = sophie:/var/run/sophie
31164 .endd
31165 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31166 before use.
31167 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31168 The following scanner types are supported in this release:
31169
31170 .vlist
31171 .vitem &%avast%&
31172 .cindex "virus scanners" "avast"
31173 This is the scanner daemon of Avast. It has been tested with Avast Core
31174 Security (currently at version 1.1.7).
31175 You can get a trial version at &url(http://www.avast.com) or for Linux
31176 at &url(http://www.avast.com/linux-server-antivirus).
31177 This scanner type takes one option,
31178 which can be either a full path to a UNIX socket,
31179 or host and port specifiers separated by white space.
31180 The host may be a name or an IP address; the port is either a
31181 single number or a pair of numbers with a dash between.
31182 Any further options are given, on separate lines,
31183 to the daemon as options before the main scan command.
31184 For example:
31185 .code
31186 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31187 av_scanner = avast:192.168.2.22 5036
31188 .endd
31189 If you omit the argument, the default path
31190 &_/var/run/avast/scan.sock_&
31191 is used.
31192 If you use a remote host,
31193 you need to make Exim's spool directory available to it,
31194 as the scanner is passed a file path, not file contents.
31195 For information about available commands and their options you may use
31196 .code
31197 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31198     FLAGS
31199     SENSITIVITY
31200     PACK
31201 .endd
31202
31203
31204 .vitem &%aveserver%&
31205 .cindex "virus scanners" "Kaspersky"
31206 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31207 at &url(http://www.kaspersky.com). This scanner type takes one option,
31208 which is the path to the daemon's UNIX socket. The default is shown in this
31209 example:
31210 .code
31211 av_scanner = aveserver:/var/run/aveserver
31212 .endd
31213
31214
31215 .vitem &%clamd%&
31216 .cindex "virus scanners" "clamd"
31217 This daemon-type scanner is GPL and free. You can get it at
31218 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31219 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31220 in the MIME ACL. This is no longer believed to be necessary.
31221
31222 The options are a list of server specifiers, which may be
31223 a UNIX socket specification,
31224 a TCP socket specification,
31225 or a (global) option.
31226
31227 A socket specification consists of a space-separated list.
31228 For a Unix socket the first element is a full path for the socket,
31229 for a TCP socket the first element is the IP address
31230 and the second a port number,
31231 Any further elements are per-server (non-global) options.
31232 These per-server options are supported:
31233 .code
31234 retry=<timespec>        Retry on connect fail
31235 .endd
31236
31237 The &`retry`& option specifies a time after which a single retry for
31238 a failed connect is made.  The default is to not retry.
31239
31240 If a Unix socket file is specified, only one server is supported.
31241
31242 Examples:
31243 .code
31244 av_scanner = clamd:/opt/clamd/socket
31245 av_scanner = clamd:192.0.2.3 1234
31246 av_scanner = clamd:192.0.2.3 1234:local
31247 av_scanner = clamd:192.0.2.3 1234 retry=10s
31248 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31249 .endd
31250 If the value of av_scanner points to a UNIX socket file or contains the
31251 &`local`&
31252 option, then the ClamAV interface will pass a filename containing the data
31253 to be scanned, which will should normally result in less I/O happening and be
31254 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31255 Exim does not assume that there is a common filesystem with the remote host.
31256 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31257 you be running a version of ClamAV prior to 0.95.
31258
31259 The final example shows that multiple TCP targets can be specified.  Exim will
31260 randomly use one for each incoming email (i.e. it load balances them).  Note
31261 that only TCP targets may be used if specifying a list of scanners; a UNIX
31262 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31263 unavailable, Exim will try the remaining one(s) until it finds one that works.
31264 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31265 not keep track of scanner state between multiple messages, and the scanner
31266 selection is random, so the message will get logged in the mainlog for each
31267 email that the down scanner gets chosen first (message wrapped to be readable):
31268 .code
31269 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31270    clamd: connection to localhost, port 3310 failed
31271    (Connection refused)
31272 .endd
31273
31274 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31275 contributing the code for this scanner.
31276
31277 .vitem &%cmdline%&
31278 .cindex "virus scanners" "command line interface"
31279 This is the keyword for the generic command line scanner interface. It can be
31280 used to attach virus scanners that are invoked from the shell. This scanner
31281 type takes 3 mandatory options:
31282
31283 .olist
31284 The full path and name of the scanner binary, with all command line options,
31285 and a placeholder (&`%s`&) for the directory to scan.
31286
31287 .next
31288 A regular expression to match against the STDOUT and STDERR output of the
31289 virus scanner. If the expression matches, a virus was found. You must make
31290 absolutely sure that this expression matches on &"virus found"&. This is called
31291 the &"trigger"& expression.
31292
31293 .next
31294 Another regular expression, containing exactly one pair of parentheses, to
31295 match the name of the virus found in the scanners output. This is called the
31296 &"name"& expression.
31297 .endlist olist
31298
31299 For example, Sophos Sweep reports a virus on a line like this:
31300 .code
31301 Virus 'W32/Magistr-B' found in file ./those.bat
31302 .endd
31303 For the trigger expression, we can match the phrase &"found in file"&. For the
31304 name expression, we want to extract the W32/Magistr-B string, so we can match
31305 for the single quotes left and right of it. Altogether, this makes the
31306 configuration setting:
31307 .code
31308 av_scanner = cmdline:\
31309              /path/to/sweep -ss -all -rec -archive %s:\
31310              found in file:'(.+)'
31311 .endd
31312 .vitem &%drweb%&
31313 .cindex "virus scanners" "DrWeb"
31314 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31315 takes one option,
31316 either a full path to a UNIX socket,
31317 or host and port specifiers separated by white space.
31318 The host may be a name or an IP address; the port is either a
31319 single number or a pair of numbers with a dash between.
31320 For example:
31321 .code
31322 av_scanner = drweb:/var/run/drwebd.sock
31323 av_scanner = drweb:192.168.2.20 31337
31324 .endd
31325 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31326 is used. Thanks to Alex Miller for contributing the code for this scanner.
31327
31328 .vitem &%f-protd%&
31329 .cindex "virus scanners" "f-protd"
31330 The f-protd scanner is accessed via HTTP over TCP.
31331 One argument is taken, being a space-separated hostname and port number
31332 (or port-range).
31333 For example:
31334 .code
31335 av_scanner = f-protd:localhost 10200-10204
31336 .endd
31337 If you omit the argument, the default values show above are used.
31338
31339 .vitem &%fsecure%&
31340 .cindex "virus scanners" "F-Secure"
31341 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31342 argument which is the path to a UNIX socket. For example:
31343 .code
31344 av_scanner = fsecure:/path/to/.fsav
31345 .endd
31346 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31347 Thelmen for contributing the code for this scanner.
31348
31349 .vitem &%kavdaemon%&
31350 .cindex "virus scanners" "Kaspersky"
31351 This is the scanner daemon of Kaspersky Version 4. This version of the
31352 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31353 scanner type takes one option, which is the path to the daemon's UNIX socket.
31354 For example:
31355 .code
31356 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31357 .endd
31358 The default path is &_/var/run/AvpCtl_&.
31359
31360 .vitem &%mksd%&
31361 .cindex "virus scanners" "mksd"
31362 This is a daemon type scanner that is aimed mainly at Polish users, though some
31363 parts of documentation are now available in English. You can get it at
31364 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31365 the maximum number of processes used simultaneously to scan the attachments,
31366 provided that mksd has
31367 been run with at least the same number of child processes. For example:
31368 .code
31369 av_scanner = mksd:2
31370 .endd
31371 You can safely omit this option (the default value is 1).
31372
31373 .vitem &%sock%&
31374 .cindex "virus scanners" "simple socket-connected"
31375 This is a general-purpose way of talking to simple scanner daemons
31376 running on the local machine.
31377 There are four options:
31378 an address (which may be an IP address and port, or the path of a Unix socket),
31379 a commandline to send (may include a single %s which will be replaced with
31380 the path to the mail file to be scanned),
31381 an RE to trigger on from the returned data,
31382 an RE to extract malware_name from the returned data.
31383 For example:
31384 .code
31385 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31386 .endd
31387 Default for the socket specifier is &_/tmp/malware.sock_&.
31388 Default for the commandline is &_%s\n_&.
31389 Both regular-expressions are required.
31390
31391 .vitem &%sophie%&
31392 .cindex "virus scanners" "Sophos and Sophie"
31393 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31394 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31395 for this scanner type is the path to the UNIX socket that Sophie uses for
31396 client communication. For example:
31397 .code
31398 av_scanner = sophie:/tmp/sophie
31399 .endd
31400 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31401 the option.
31402 .endlist
31403
31404 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31405 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31406 ACL.
31407
31408 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31409 makes it possible to use different scanners. See further below for an example.
31410 The &%malware%& condition caches its results, so when you use it multiple times
31411 for the same message, the actual scanning process is only carried out once.
31412 However, using expandable items in &%av_scanner%& disables this caching, in
31413 which case each use of the &%malware%& condition causes a new scan of the
31414 message.
31415
31416 The &%malware%& condition takes a right-hand argument that is expanded before
31417 use and taken as a list, slash-separated by default.
31418 The first element can then be one of
31419
31420 .ilist
31421 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31422 The condition succeeds if a virus was found, and fail otherwise. This is the
31423 recommended usage.
31424 .next
31425 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31426 the condition fails immediately.
31427 .next
31428 A regular expression, in which case the message is scanned for viruses. The
31429 condition succeeds if a virus is found and its name matches the regular
31430 expression. This allows you to take special actions on certain types of virus.
31431 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31432 unless the separator is changed (in the usual way).
31433 .endlist
31434
31435 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31436 messages even if there is a problem with the virus scanner.
31437 Otherwise, such a problem causes the ACL to defer.
31438
31439 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31440 specify a non-default timeout.  The default is two minutes.
31441 For example:
31442 .code
31443 malware = * / defer_ok / tmo=10s
31444 .endd
31445 A timeout causes the ACL to defer.
31446
31447 .vindex "&$callout_address$&"
31448 When a connection is made to the scanner the expansion variable &$callout_address$&
31449 is set to record the actual address used.
31450
31451 .vindex "&$malware_name$&"
31452 When a virus is found, the condition sets up an expansion variable called
31453 &$malware_name$& that contains the name of the virus. You can use it in a
31454 &%message%& modifier that specifies the error returned to the sender, and/or in
31455 logging data.
31456
31457 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31458 imposed by your anti-virus scanner.
31459
31460 Here is a very simple scanning example:
31461 .code
31462 deny message = This message contains malware ($malware_name)
31463      malware = *
31464 .endd
31465 The next example accepts messages when there is a problem with the scanner:
31466 .code
31467 deny message = This message contains malware ($malware_name)
31468      malware = */defer_ok
31469 .endd
31470 The next example shows how to use an ACL variable to scan with both sophie and
31471 aveserver. It assumes you have set:
31472 .code
31473 av_scanner = $acl_m0
31474 .endd
31475 in the main Exim configuration.
31476 .code
31477 deny message = This message contains malware ($malware_name)
31478      set acl_m0 = sophie
31479      malware = *
31480
31481 deny message = This message contains malware ($malware_name)
31482      set acl_m0 = aveserver
31483      malware = *
31484 .endd
31485
31486
31487 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31488 .cindex "content scanning" "for spam"
31489 .cindex "spam scanning"
31490 .cindex "SpamAssassin"
31491 .cindex "Rspamd"
31492 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31493 score and a report for the message.
31494 Support is also provided for Rspamd.
31495
31496 For more information about installation and configuration of SpamAssassin or
31497 Rspamd refer to their respective websites at
31498 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31499
31500 SpamAssassin can be installed with CPAN by running:
31501 .code
31502 perl -MCPAN -e 'install Mail::SpamAssassin'
31503 .endd
31504 SpamAssassin has its own set of configuration files. Please review its
31505 documentation to see how you can tweak it. The default installation should work
31506 nicely, however.
31507
31508 .oindex "&%spamd_address%&"
31509 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31510 intend to use an instance running on the local host you do not need to set
31511 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31512 you must set the &%spamd_address%& option in the global part of the Exim
31513 configuration as follows (example):
31514 .code
31515 spamd_address = 192.168.99.45 387
31516 .endd
31517
31518 To use Rspamd (which by default listens on all local addresses
31519 on TCP port 11333)
31520 you should add &%variant=rspamd%& after the address/port pair, for example:
31521 .code
31522 spamd_address = 127.0.0.1 11333 variant=rspamd
31523 .endd
31524
31525 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31526 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31527 file name instead of an address/port pair:
31528 .code
31529 spamd_address = /var/run/spamd_socket
31530 .endd
31531 You can have multiple &%spamd%& servers to improve scalability. These can
31532 reside on other hardware reachable over the network. To specify multiple
31533 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31534 option, separated with colons (the separator can be changed in the usual way):
31535 .code
31536 spamd_address = 192.168.2.10 783 : \
31537                 192.168.2.11 783 : \
31538                 192.168.2.12 783
31539 .endd
31540 Up to 32 &%spamd%& servers are supported.
31541 When a server fails to respond to the connection attempt, all other
31542 servers are tried until one succeeds. If no server responds, the &%spam%&
31543 condition defers.
31544
31545 Unix and TCP socket specifications may be mixed in any order.
31546 Each element of the list is a list itself, space-separated by default
31547 and changeable in the usual way; take care to not double the separator.
31548
31549 For TCP socket specifications a host name or IP (v4 or v6, but
31550 subject to list-separator quoting rules) address can be used,
31551 and the port can be one or a dash-separated pair.
31552 In the latter case, the range is tried in strict order.
31553
31554 Elements after the first for Unix sockets, or second for TCP socket,
31555 are options.
31556 The supported options are:
31557 .code
31558 pri=<priority>      Selection priority
31559 weight=<value>      Selection bias
31560 time=<start>-<end>  Use only between these times of day
31561 retry=<timespec>    Retry on connect fail
31562 tmo=<timespec>      Connection time limit
31563 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31564 .endd
31565
31566 The &`pri`& option specifies a priority for the server within the list,
31567 higher values being tried first.
31568 The default priority is 1.
31569
31570 The &`weight`& option specifies a selection bias.
31571 Within a priority set
31572 servers are queried in a random fashion, weighted by this value.
31573 The default value for selection bias is 1.
31574
31575 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31576 in the local time zone; each element being one or more digits.
31577 Either the seconds or both minutes and seconds, plus the leading &`.`&
31578 characters, may be omitted and will be taken as zero.
31579
31580 Timeout specifications for the &`retry`& and &`tmo`& options
31581 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31582
31583 The &`tmo`& option specifies an overall timeout for communication.
31584 The default value is two minutes.
31585
31586 The &`retry`& option specifies a time after which a single retry for
31587 a failed connect is made.
31588 The default is to not retry.
31589
31590 The &%spamd_address%& variable is expanded before use if it starts with
31591 a dollar sign. In this case, the expansion may return a string that is
31592 used as the list so that multiple spamd servers can be the result of an
31593 expansion.
31594
31595 .vindex "&$callout_address$&"
31596 When a connection is made to the server the expansion variable &$callout_address$&
31597 is set to record the actual address used.
31598
31599 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31600 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31601 .code
31602 deny message = This message was classified as SPAM
31603      spam = joe
31604 .endd
31605 The right-hand side of the &%spam%& condition specifies a name. This is
31606 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31607 to scan using a specific profile, but rather use the SpamAssassin system-wide
31608 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31609 Rspamd does not use this setting. However, you must put something on the
31610 right-hand side.
31611
31612 The name allows you to use per-domain or per-user antispam profiles in
31613 principle, but this is not straightforward in practice, because a message may
31614 have multiple recipients, not necessarily all in the same domain. Because the
31615 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31616 read the contents of the message, the variables &$local_part$& and &$domain$&
31617 are not set.
31618 Careful enforcement of single-recipient messages
31619 (e.g. by responding with defer in the recipient ACL for all recipients
31620 after the first),
31621 or the use of PRDR,
31622 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31623 are needed to use this feature.
31624
31625 The right-hand side of the &%spam%& condition is expanded before being used, so
31626 you can put lookups or conditions there. When the right-hand side evaluates to
31627 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31628
31629
31630 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31631 large ones may cause significant performance degradation. As most spam messages
31632 are quite small, it is recommended that you do not scan the big ones. For
31633 example:
31634 .code
31635 deny message = This message was classified as SPAM
31636      condition = ${if < {$message_size}{10K}}
31637      spam = nobody
31638 .endd
31639
31640 The &%spam%& condition returns true if the threshold specified in the user's
31641 SpamAssassin profile has been matched or exceeded. If you want to use the
31642 &%spam%& condition for its side effects (see the variables below), you can make
31643 it always return &"true"& by appending &`:true`& to the username.
31644
31645 .cindex "spam scanning" "returned variables"
31646 When the &%spam%& condition is run, it sets up a number of expansion
31647 variables.
31648 Except for &$spam_report$&,
31649 these variables are saved with the received message so are
31650 available for use at delivery time.
31651
31652 .vlist
31653 .vitem &$spam_score$&
31654 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31655 for inclusion in log or reject messages.
31656
31657 .vitem &$spam_score_int$&
31658 The spam score of the message, multiplied by ten, as an integer value. For
31659 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31660 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31661 The integer value is useful for numeric comparisons in conditions.
31662
31663 .vitem &$spam_bar$&
31664 A string consisting of a number of &"+"& or &"-"& characters, representing the
31665 integer part of the spam score value. A spam score of 4.4 would have a
31666 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31667 headers, since MUAs can match on such strings. The maximum length of the
31668 spam bar is 50 characters.
31669
31670 .vitem &$spam_report$&
31671 A multiline text table, containing the full SpamAssassin report for the
31672 message. Useful for inclusion in headers or reject messages.
31673 This variable is only usable in a DATA-time ACL.
31674
31675 .vitem &$spam_action$&
31676 For SpamAssassin either 'reject' or 'no action' depending on the
31677 spam score versus threshold.
31678 For Rspamd, the recommended action.
31679
31680 .endlist
31681
31682 The &%spam%& condition caches its results unless expansion in
31683 spamd_address was used. If you call it again with the same user name, it
31684 does not scan again, but rather returns the same values as before.
31685
31686 The &%spam%& condition returns DEFER if there is any error while running
31687 the message through SpamAssassin or if the expansion of spamd_address
31688 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31689 statement block), append &`/defer_ok`& to the right-hand side of the
31690 spam condition, like this:
31691 .code
31692 deny message = This message was classified as SPAM
31693      spam    = joe/defer_ok
31694 .endd
31695 This causes messages to be accepted even if there is a problem with &%spamd%&.
31696
31697 Here is a longer, commented example of the use of the &%spam%&
31698 condition:
31699 .code
31700 # put headers in all messages (no matter if spam or not)
31701 warn  spam = nobody:true
31702       add_header = X-Spam-Score: $spam_score ($spam_bar)
31703       add_header = X-Spam-Report: $spam_report
31704
31705 # add second subject line with *SPAM* marker when message
31706 # is over threshold
31707 warn  spam = nobody
31708       add_header = Subject: *SPAM* $h_Subject:
31709
31710 # reject spam at high scores (> 12)
31711 deny  message = This message scored $spam_score spam points.
31712       spam = nobody:true
31713       condition = ${if >{$spam_score_int}{120}{1}{0}}
31714 .endd
31715
31716
31717
31718 .section "Scanning MIME parts" "SECTscanmimepart"
31719 .cindex "content scanning" "MIME parts"
31720 .cindex "MIME content scanning"
31721 .oindex "&%acl_smtp_mime%&"
31722 .oindex "&%acl_not_smtp_mime%&"
31723 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31724 each MIME part of an SMTP message, including multipart types, in the sequence
31725 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31726 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31727 options may both refer to the same ACL if you want the same processing in both
31728 cases.
31729
31730 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31731 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31732 the case of a non-SMTP message. However, a MIME ACL is called only if the
31733 message contains a &'Content-Type:'& header line. When a call to a MIME
31734 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31735 result code is sent to the client. In the case of an SMTP message, the
31736 &%acl_smtp_data%& ACL is not called when this happens.
31737
31738 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31739 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31740 condition to match against the raw MIME part. You can also use the
31741 &%mime_regex%& condition to match against the decoded MIME part (see section
31742 &<<SECTscanregex>>&).
31743
31744 At the start of a MIME ACL, a number of variables are set from the header
31745 information for the relevant MIME part. These are described below. The contents
31746 of the MIME part are not by default decoded into a disk file except for MIME
31747 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31748 part into a disk file, you can use the &%decode%& condition. The general
31749 syntax is:
31750 .display
31751 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31752 .endd
31753 The right hand side is expanded before use. After expansion,
31754 the value can be:
31755
31756 .olist
31757 &"0"& or &"false"&, in which case no decoding is done.
31758 .next
31759 The string &"default"&. In that case, the file is put in the temporary
31760 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31761 a sequential file name consisting of the message id and a sequence number. The
31762 full path and name is available in &$mime_decoded_filename$& after decoding.
31763 .next
31764 A full path name starting with a slash. If the full name is an existing
31765 directory, it is used as a replacement for the default directory. The filename
31766 is then sequentially assigned. If the path does not exist, it is used as
31767 the full path and file name.
31768 .next
31769 If the string does not start with a slash, it is used as the
31770 filename, and the default path is then used.
31771 .endlist
31772 The &%decode%& condition normally succeeds. It is only false for syntax
31773 errors or unusual circumstances such as memory shortages. You can easily decode
31774 a file with its original, proposed filename using
31775 .code
31776 decode = $mime_filename
31777 .endd
31778 However, you should keep in mind that &$mime_filename$& might contain
31779 anything. If you place files outside of the default path, they are not
31780 automatically unlinked.
31781
31782 For RFC822 attachments (these are messages attached to messages, with a
31783 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31784 as for the primary message, only that the &$mime_is_rfc822$& expansion
31785 variable is set (see below). Attached messages are always decoded to disk
31786 before being checked, and the files are unlinked once the check is done.
31787
31788 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31789 used to match regular expressions against raw and decoded MIME parts,
31790 respectively. They are described in section &<<SECTscanregex>>&.
31791
31792 .cindex "MIME content scanning" "returned variables"
31793 The following list describes all expansion variables that are
31794 available in the MIME ACL:
31795
31796 .vlist
31797 .vitem &$mime_boundary$&
31798 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31799 have a boundary string, which is stored in this variable. If the current part
31800 has no boundary parameter in the &'Content-Type:'& header, this variable
31801 contains the empty string.
31802
31803 .vitem &$mime_charset$&
31804 This variable contains the character set identifier, if one was found in the
31805 &'Content-Type:'& header. Examples for charset identifiers are:
31806 .code
31807 us-ascii
31808 gb2312 (Chinese)
31809 iso-8859-1
31810 .endd
31811 Please note that this value is not normalized, so you should do matches
31812 case-insensitively.
31813
31814 .vitem &$mime_content_description$&
31815 This variable contains the normalized content of the &'Content-Description:'&
31816 header. It can contain a human-readable description of the parts content. Some
31817 implementations repeat the filename for attachments here, but they are usually
31818 only used for display purposes.
31819
31820 .vitem &$mime_content_disposition$&
31821 This variable contains the normalized content of the &'Content-Disposition:'&
31822 header. You can expect strings like &"attachment"& or &"inline"& here.
31823
31824 .vitem &$mime_content_id$&
31825 This variable contains the normalized content of the &'Content-ID:'& header.
31826 This is a unique ID that can be used to reference a part from another part.
31827
31828 .vitem &$mime_content_size$&
31829 This variable is set only after the &%decode%& modifier (see above) has been
31830 successfully run. It contains the size of the decoded part in kilobytes. The
31831 size is always rounded up to full kilobytes, so only a completely empty part
31832 has a &$mime_content_size$& of zero.
31833
31834 .vitem &$mime_content_transfer_encoding$&
31835 This variable contains the normalized content of the
31836 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31837 type. Typical values are &"base64"& and &"quoted-printable"&.
31838
31839 .vitem &$mime_content_type$&
31840 If the MIME part has a &'Content-Type:'& header, this variable contains its
31841 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31842 are some examples of popular MIME types, as they may appear in this variable:
31843 .code
31844 text/plain
31845 text/html
31846 application/octet-stream
31847 image/jpeg
31848 audio/midi
31849 .endd
31850 If the MIME part has no &'Content-Type:'& header, this variable contains the
31851 empty string.
31852
31853 .vitem &$mime_decoded_filename$&
31854 This variable is set only after the &%decode%& modifier (see above) has been
31855 successfully run. It contains the full path and file name of the file
31856 containing the decoded data.
31857 .endlist
31858
31859 .cindex "RFC 2047"
31860 .vlist
31861 .vitem &$mime_filename$&
31862 This is perhaps the most important of the MIME variables. It contains a
31863 proposed filename for an attachment, if one was found in either the
31864 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31865 RFC2047
31866 or RFC2231
31867 decoded, but no additional sanity checks are done.
31868  If no filename was
31869 found, this variable contains the empty string.
31870
31871 .vitem &$mime_is_coverletter$&
31872 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31873 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31874 content in the cover letter, while not restricting attachments at all.
31875
31876 The variable contains 1 (true) for a MIME part believed to be part of the
31877 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31878 follows:
31879
31880 .olist
31881 The outermost MIME part of a message is always a cover letter.
31882
31883 .next
31884 If a multipart/alternative or multipart/related MIME part is a cover letter,
31885 so are all MIME subparts within that multipart.
31886
31887 .next
31888 If any other multipart is a cover letter, the first subpart is a cover letter,
31889 and the rest are attachments.
31890
31891 .next
31892 All parts contained within an attachment multipart are attachments.
31893 .endlist olist
31894
31895 As an example, the following will ban &"HTML mail"& (including that sent with
31896 alternative plain text), while allowing HTML files to be attached. HTML
31897 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31898 .code
31899 deny message = HTML mail is not accepted here
31900 !condition = $mime_is_rfc822
31901 condition = $mime_is_coverletter
31902 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31903 .endd
31904 .vitem &$mime_is_multipart$&
31905 This variable has the value 1 (true) when the current part has the main type
31906 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31907 Since multipart entities only serve as containers for other parts, you may not
31908 want to carry out specific actions on them.
31909
31910 .vitem &$mime_is_rfc822$&
31911 This variable has the value 1 (true) if the current part is not a part of the
31912 checked message itself, but part of an attached message. Attached message
31913 decoding is fully recursive.
31914
31915 .vitem &$mime_part_count$&
31916 This variable is a counter that is raised for each processed MIME part. It
31917 starts at zero for the very first part (which is usually a multipart). The
31918 counter is per-message, so it is reset when processing RFC822 attachments (see
31919 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31920 complete, so you can use it in the DATA ACL to determine the number of MIME
31921 parts of a message. For non-MIME messages, this variable contains the value -1.
31922 .endlist
31923
31924
31925
31926 .section "Scanning with regular expressions" "SECTscanregex"
31927 .cindex "content scanning" "with regular expressions"
31928 .cindex "regular expressions" "content scanning with"
31929 You can specify your own custom regular expression matches on the full body of
31930 the message, or on individual MIME parts.
31931
31932 The &%regex%& condition takes one or more regular expressions as arguments and
31933 matches them against the full message (when called in the DATA ACL) or a raw
31934 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31935 linewise, with a maximum line length of 32K characters. That means you cannot
31936 have multiline matches with the &%regex%& condition.
31937
31938 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31939 to 32K of decoded content (the whole content at once, not linewise). If the
31940 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31941 is decoded automatically when &%mime_regex%& is executed (using default path
31942 and filename values). If the decoded data is larger than  32K, only the first
31943 32K characters are checked.
31944
31945 The regular expressions are passed as a colon-separated list. To include a
31946 literal colon, you must double it. Since the whole right-hand side string is
31947 expanded before being used, you must also escape dollar signs and backslashes
31948 with more backslashes, or use the &`\N`& facility to disable expansion.
31949 Here is a simple example that contains two regular expressions:
31950 .code
31951 deny message = contains blacklisted regex ($regex_match_string)
31952      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31953 .endd
31954 The conditions returns true if any one of the regular expressions matches. The
31955 &$regex_match_string$& expansion variable is then set up and contains the
31956 matching regular expression.
31957 The expansion variables &$regex1$& &$regex2$& etc
31958 are set to any substrings captured by the regular expression.
31959
31960 &*Warning*&: With large messages, these conditions can be fairly
31961 CPU-intensive.
31962
31963 .ecindex IIDcosca
31964
31965
31966
31967
31968 . ////////////////////////////////////////////////////////////////////////////
31969 . ////////////////////////////////////////////////////////////////////////////
31970
31971 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31972          "Local scan function"
31973 .scindex IIDlosca "&[local_scan()]& function" "description of"
31974 .cindex "customizing" "input scan using C function"
31975 .cindex "policy control" "by local scan function"
31976 In these days of email worms, viruses, and ever-increasing spam, some sites
31977 want to apply a lot of checking to messages before accepting them.
31978
31979 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31980 passing messages to external virus and spam scanning software. You can also do
31981 a certain amount in Exim itself through string expansions and the &%condition%&
31982 condition in the ACL that runs after the SMTP DATA command or the ACL for
31983 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31984
31985 To allow for further customization to a site's own requirements, there is the
31986 possibility of linking Exim with a private message scanning function, written
31987 in C. If you want to run code that is written in something other than C, you
31988 can of course use a little C stub to call it.
31989
31990 The local scan function is run once for every incoming message, at the point
31991 when Exim is just about to accept the message.
31992 It can therefore be used to control non-SMTP messages from local processes as
31993 well as messages arriving via SMTP.
31994
31995 Exim applies a timeout to calls of the local scan function, and there is an
31996 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31997 Zero means &"no timeout"&.
31998 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31999 before calling the local scan function, so that the most common types of crash
32000 are caught. If the timeout is exceeded or one of those signals is caught, the
32001 incoming message is rejected with a temporary error if it is an SMTP message.
32002 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32003 code. The incident is logged on the main and reject logs.
32004
32005
32006
32007 .section "Building Exim to use a local scan function" "SECID207"
32008 .cindex "&[local_scan()]& function" "building Exim to use"
32009 To make use of the local scan function feature, you must tell Exim where your
32010 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32011 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32012 directory, so you might set
32013 .code
32014 LOCAL_SCAN_SOURCE=Local/local_scan.c
32015 .endd
32016 for example. The function must be called &[local_scan()]&. It is called by
32017 Exim after it has received a message, when the success return code is about to
32018 be sent. This is after all the ACLs have been run. The return code from your
32019 function controls whether the message is actually accepted or not. There is a
32020 commented template function (that just accepts the message) in the file
32021 _src/local_scan.c_.
32022
32023 If you want to make use of Exim's run time configuration file to set options
32024 for your &[local_scan()]& function, you must also set
32025 .code
32026 LOCAL_SCAN_HAS_OPTIONS=yes
32027 .endd
32028 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32029
32030
32031
32032
32033 .section "API for local_scan()" "SECTapiforloc"
32034 .cindex "&[local_scan()]& function" "API description"
32035 You must include this line near the start of your code:
32036 .code
32037 #include "local_scan.h"
32038 .endd
32039 This header file defines a number of variables and other values, and the
32040 prototype for the function itself. Exim is coded to use unsigned char values
32041 almost exclusively, and one of the things this header defines is a shorthand
32042 for &`unsigned char`& called &`uschar`&.
32043 It also contains the following macro definitions, to simplify casting character
32044 strings and pointers to character strings:
32045 .code
32046 #define CS   (char *)
32047 #define CCS  (const char *)
32048 #define CSS  (char **)
32049 #define US   (unsigned char *)
32050 #define CUS  (const unsigned char *)
32051 #define USS  (unsigned char **)
32052 .endd
32053 The function prototype for &[local_scan()]& is:
32054 .code
32055 extern int local_scan(int fd, uschar **return_text);
32056 .endd
32057 The arguments are as follows:
32058
32059 .ilist
32060 &%fd%& is a file descriptor for the file that contains the body of the message
32061 (the -D file). The file is open for reading and writing, but updating it is not
32062 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32063
32064 The descriptor is positioned at character 19 of the file, which is the first
32065 character of the body itself, because the first 19 characters are the message
32066 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32067 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32068 case this changes in some future version.
32069 .next
32070 &%return_text%& is an address which you can use to return a pointer to a text
32071 string at the end of the function. The value it points to on entry is NULL.
32072 .endlist
32073
32074 The function must return an &%int%& value which is one of the following macros:
32075
32076 .vlist
32077 .vitem &`LOCAL_SCAN_ACCEPT`&
32078 .vindex "&$local_scan_data$&"
32079 The message is accepted. If you pass back a string of text, it is saved with
32080 the message, and made available in the variable &$local_scan_data$&. No
32081 newlines are permitted (if there are any, they are turned into spaces) and the
32082 maximum length of text is 1000 characters.
32083
32084 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32085 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32086 queued without immediate delivery, and is frozen.
32087
32088 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32089 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32090 queued without immediate delivery.
32091
32092 .vitem &`LOCAL_SCAN_REJECT`&
32093 The message is rejected; the returned text is used as an error message which is
32094 passed back to the sender and which is also logged. Newlines are permitted &--
32095 they cause a multiline response for SMTP rejections, but are converted to
32096 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32097 used.
32098
32099 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32100 The message is temporarily rejected; the returned text is used as an error
32101 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32102 problem"& is used.
32103
32104 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32105 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32106 message is not written to the reject log. It has the effect of unsetting the
32107 &%rejected_header%& log selector for just this rejection. If
32108 &%rejected_header%& is already unset (see the discussion of the
32109 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32110 same as LOCAL_SCAN_REJECT.
32111
32112 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32113 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32114 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32115 .endlist
32116
32117 If the message is not being received by interactive SMTP, rejections are
32118 reported by writing to &%stderr%& or by sending an email, as configured by the
32119 &%-oe%& command line options.
32120
32121
32122
32123 .section "Configuration options for local_scan()" "SECTconoptloc"
32124 .cindex "&[local_scan()]& function" "configuration options"
32125 It is possible to have option settings in the main configuration file
32126 that set values in static variables in the &[local_scan()]& module. If you
32127 want to do this, you must have the line
32128 .code
32129 LOCAL_SCAN_HAS_OPTIONS=yes
32130 .endd
32131 in your &_Local/Makefile_& when you build Exim. (This line is in
32132 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32133 file, you must define static variables to hold the option values, and a table
32134 to define them.
32135
32136 The table must be a vector called &%local_scan_options%&, of type
32137 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32138 and a pointer to the variable that holds the value. The entries must appear in
32139 alphabetical order. Following &%local_scan_options%& you must also define a
32140 variable called &%local_scan_options_count%& that contains the number of
32141 entries in the table. Here is a short example, showing two kinds of option:
32142 .code
32143 static int my_integer_option = 42;
32144 static uschar *my_string_option = US"a default string";
32145
32146 optionlist local_scan_options[] = {
32147   { "my_integer", opt_int,       &my_integer_option },
32148   { "my_string",  opt_stringptr, &my_string_option }
32149 };
32150
32151 int local_scan_options_count =
32152   sizeof(local_scan_options)/sizeof(optionlist);
32153 .endd
32154 The values of the variables can now be changed from Exim's runtime
32155 configuration file by including a local scan section as in this example:
32156 .code
32157 begin local_scan
32158 my_integer = 99
32159 my_string = some string of text...
32160 .endd
32161 The available types of option data are as follows:
32162
32163 .vlist
32164 .vitem &*opt_bool*&
32165 This specifies a boolean (true/false) option. The address should point to a
32166 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32167 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32168 whether such a variable has been set at all, you can initialize it to
32169 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32170 values.)
32171
32172 .vitem &*opt_fixed*&
32173 This specifies a fixed point number, such as is used for load averages.
32174 The address should point to a variable of type &`int`&. The value is stored
32175 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32176
32177 .vitem &*opt_int*&
32178 This specifies an integer; the address should point to a variable of type
32179 &`int`&. The value may be specified in any of the integer formats accepted by
32180 Exim.
32181
32182 .vitem &*opt_mkint*&
32183 This is the same as &%opt_int%&, except that when such a value is output in a
32184 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32185 printed with the suffix K or M.
32186
32187 .vitem &*opt_octint*&
32188 This also specifies an integer, but the value is always interpreted as an
32189 octal integer, whether or not it starts with the digit zero, and it is
32190 always output in octal.
32191
32192 .vitem &*opt_stringptr*&
32193 This specifies a string value; the address must be a pointer to a
32194 variable that points to a string (for example, of type &`uschar *`&).
32195
32196 .vitem &*opt_time*&
32197 This specifies a time interval value. The address must point to a variable of
32198 type &`int`&. The value that is placed there is a number of seconds.
32199 .endlist
32200
32201 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32202 out the values of all the &[local_scan()]& options.
32203
32204
32205
32206 .section "Available Exim variables" "SECID208"
32207 .cindex "&[local_scan()]& function" "available Exim variables"
32208 The header &_local_scan.h_& gives you access to a number of C variables. These
32209 are the only ones that are guaranteed to be maintained from release to release.
32210 Note, however, that you can obtain the value of any Exim expansion variable,
32211 including &$recipients$&, by calling &'expand_string()'&. The exported
32212 C variables are as follows:
32213
32214 .vlist
32215 .vitem &*int&~body_linecount*&
32216 This variable contains the number of lines in the message's body.
32217
32218 .vitem &*int&~body_zerocount*&
32219 This variable contains the number of binary zero bytes in the message's body.
32220
32221 .vitem &*unsigned&~int&~debug_selector*&
32222 This variable is set to zero when no debugging is taking place. Otherwise, it
32223 is a bitmap of debugging selectors. Two bits are identified for use in
32224 &[local_scan()]&; they are defined as macros:
32225
32226 .ilist
32227 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32228 testing option that is not privileged &-- any caller may set it. All the
32229 other selector bits can be set only by admin users.
32230
32231 .next
32232 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32233 by the &`+local_scan`& debug selector. It is not included in the default set
32234 of debugging bits.
32235 .endlist ilist
32236
32237 Thus, to write to the debugging output only when &`+local_scan`& has been
32238 selected, you should use code like this:
32239 .code
32240 if ((debug_selector & D_local_scan) != 0)
32241   debug_printf("xxx", ...);
32242 .endd
32243 .vitem &*uschar&~*expand_string_message*&
32244 After a failing call to &'expand_string()'& (returned value NULL), the
32245 variable &%expand_string_message%& contains the error message, zero-terminated.
32246
32247 .vitem &*header_line&~*header_list*&
32248 A pointer to a chain of header lines. The &%header_line%& structure is
32249 discussed below.
32250
32251 .vitem &*header_line&~*header_last*&
32252 A pointer to the last of the header lines.
32253
32254 .vitem &*uschar&~*headers_charset*&
32255 The value of the &%headers_charset%& configuration option.
32256
32257 .vitem &*BOOL&~host_checking*&
32258 This variable is TRUE during a host checking session that is initiated by the
32259 &%-bh%& command line option.
32260
32261 .vitem &*uschar&~*interface_address*&
32262 The IP address of the interface that received the message, as a string. This
32263 is NULL for locally submitted messages.
32264
32265 .vitem &*int&~interface_port*&
32266 The port on which this message was received. When testing with the &%-bh%&
32267 command line option, the value of this variable is -1 unless a port has been
32268 specified via the &%-oMi%& option.
32269
32270 .vitem &*uschar&~*message_id*&
32271 This variable contains Exim's message id for the incoming message (the value of
32272 &$message_exim_id$&) as a zero-terminated string.
32273
32274 .vitem &*uschar&~*received_protocol*&
32275 The name of the protocol by which the message was received.
32276
32277 .vitem &*int&~recipients_count*&
32278 The number of accepted recipients.
32279
32280 .vitem &*recipient_item&~*recipients_list*&
32281 .cindex "recipient" "adding in local scan"
32282 .cindex "recipient" "removing in local scan"
32283 The list of accepted recipients, held in a vector of length
32284 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32285 can add additional recipients by calling &'receive_add_recipient()'& (see
32286 below). You can delete recipients by removing them from the vector and
32287 adjusting the value in &%recipients_count%&. In particular, by setting
32288 &%recipients_count%& to zero you remove all recipients. If you then return the
32289 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32290 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32291 and then call &'receive_add_recipient()'& as often as needed.
32292
32293 .vitem &*uschar&~*sender_address*&
32294 The envelope sender address. For bounce messages this is the empty string.
32295
32296 .vitem &*uschar&~*sender_host_address*&
32297 The IP address of the sending host, as a string. This is NULL for
32298 locally-submitted messages.
32299
32300 .vitem &*uschar&~*sender_host_authenticated*&
32301 The name of the authentication mechanism that was used, or NULL if the message
32302 was not received over an authenticated SMTP connection.
32303
32304 .vitem &*uschar&~*sender_host_name*&
32305 The name of the sending host, if known.
32306
32307 .vitem &*int&~sender_host_port*&
32308 The port on the sending host.
32309
32310 .vitem &*BOOL&~smtp_input*&
32311 This variable is TRUE for all SMTP input, including BSMTP.
32312
32313 .vitem &*BOOL&~smtp_batched_input*&
32314 This variable is TRUE for BSMTP input.
32315
32316 .vitem &*int&~store_pool*&
32317 The contents of this variable control which pool of memory is used for new
32318 requests. See section &<<SECTmemhanloc>>& for details.
32319 .endlist
32320
32321
32322 .section "Structure of header lines" "SECID209"
32323 The &%header_line%& structure contains the members listed below.
32324 You can add additional header lines by calling the &'header_add()'& function
32325 (see below). You can cause header lines to be ignored (deleted) by setting
32326 their type to *.
32327
32328
32329 .vlist
32330 .vitem &*struct&~header_line&~*next*&
32331 A pointer to the next header line, or NULL for the last line.
32332
32333 .vitem &*int&~type*&
32334 A code identifying certain headers that Exim recognizes. The codes are printing
32335 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32336 Notice in particular that any header line whose type is * is not transmitted
32337 with the message. This flagging is used for header lines that have been
32338 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32339 lines.) Effectively, * means &"deleted"&.
32340
32341 .vitem &*int&~slen*&
32342 The number of characters in the header line, including the terminating and any
32343 internal newlines.
32344
32345 .vitem &*uschar&~*text*&
32346 A pointer to the text of the header. It always ends with a newline, followed by
32347 a zero byte. Internal newlines are preserved.
32348 .endlist
32349
32350
32351
32352 .section "Structure of recipient items" "SECID210"
32353 The &%recipient_item%& structure contains these members:
32354
32355 .vlist
32356 .vitem &*uschar&~*address*&
32357 This is a pointer to the recipient address as it was received.
32358
32359 .vitem &*int&~pno*&
32360 This is used in later Exim processing when top level addresses are created by
32361 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32362 and must always contain -1 at this stage.
32363
32364 .vitem &*uschar&~*errors_to*&
32365 If this value is not NULL, bounce messages caused by failing to deliver to the
32366 recipient are sent to the address it contains. In other words, it overrides the
32367 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32368 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32369 an unqualified address, Exim qualifies it using the domain from
32370 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32371 is NULL for all recipients.
32372 .endlist
32373
32374
32375
32376 .section "Available Exim functions" "SECID211"
32377 .cindex "&[local_scan()]& function" "available Exim functions"
32378 The header &_local_scan.h_& gives you access to a number of Exim functions.
32379 These are the only ones that are guaranteed to be maintained from release to
32380 release:
32381
32382 .vlist
32383 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32384        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32385
32386 This function creates a child process that runs the command specified by
32387 &%argv%&. The environment for the process is specified by &%envp%&, which can
32388 be NULL if no environment variables are to be passed. A new umask is supplied
32389 for the process in &%newumask%&.
32390
32391 Pipes to the standard input and output of the new process are set up
32392 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32393 standard error is cloned to the standard output. If there are any file
32394 descriptors &"in the way"& in the new process, they are closed. If the final
32395 argument is TRUE, the new process is made into a process group leader.
32396
32397 The function returns the pid of the new process, or -1 if things go wrong.
32398
32399 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32400 This function waits for a child process to terminate, or for a timeout (in
32401 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32402 return value is as follows:
32403
32404 .ilist
32405 >= 0
32406
32407 The process terminated by a normal exit and the value is the process
32408 ending status.
32409
32410 .next
32411 < 0 and > &--256
32412
32413 The process was terminated by a signal and the value is the negation of the
32414 signal number.
32415
32416 .next
32417 &--256
32418
32419 The process timed out.
32420 .next
32421 &--257
32422
32423 The was some other error in wait(); &%errno%& is still set.
32424 .endlist
32425
32426 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32427 This function provide you with a means of submitting a new message to
32428 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32429 want, but this packages it all up for you.) The function creates a pipe,
32430 forks a subprocess that is running
32431 .code
32432 exim -t -oem -oi -f <>
32433 .endd
32434 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32435 that is connected to the standard input. The yield of the function is the PID
32436 of the subprocess. You can then write a message to the file descriptor, with
32437 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32438
32439 When you have finished, call &'child_close()'& to wait for the process to
32440 finish and to collect its ending status. A timeout value of zero is usually
32441 fine in this circumstance. Unless you have made a mistake with the recipient
32442 addresses, you should get a return code of zero.
32443
32444
32445 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32446        *sender_authentication)*&
32447 This function is a more sophisticated version of &'child_open()'&. The command
32448 that it runs is:
32449 .display
32450 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32451 .endd
32452 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32453
32454
32455 .vitem &*void&~debug_printf(char&~*,&~...)*&
32456 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32457 output is written to the standard error stream. If no debugging is selected,
32458 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32459 conditional on the &`local_scan`& debug selector by coding like this:
32460 .code
32461 if ((debug_selector & D_local_scan) != 0)
32462   debug_printf("xxx", ...);
32463 .endd
32464
32465 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32466 This is an interface to Exim's string expansion code. The return value is the
32467 expanded string, or NULL if there was an expansion failure.
32468 The C variable &%expand_string_message%& contains an error message after an
32469 expansion failure. If expansion does not change the string, the return value is
32470 the pointer to the input string. Otherwise, the return value points to a new
32471 block of memory that was obtained by a call to &'store_get()'&. See section
32472 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32473
32474 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32475 This function allows you to an add additional header line at the end of the
32476 existing ones. The first argument is the type, and should normally be a space
32477 character. The second argument is a format string and any number of
32478 substitution arguments as for &[sprintf()]&. You may include internal newlines
32479 if you want, and you must ensure that the string ends with a newline.
32480
32481 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32482         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32483 This function adds a new header line at a specified point in the header
32484 chain. The header itself is specified as for &'header_add()'&.
32485
32486 If &%name%& is NULL, the new header is added at the end of the chain if
32487 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32488 NULL, the header lines are searched for the first non-deleted header that
32489 matches the name. If one is found, the new header is added before it if
32490 &%after%& is false. If &%after%& is true, the new header is added after the
32491 found header and any adjacent subsequent ones with the same name (even if
32492 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32493 option controls where the header is added. If it is true, addition is at the
32494 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32495 headers, or at the top if there are no &'Received:'& headers, you could use
32496 .code
32497 header_add_at_position(TRUE, US"Received", TRUE,
32498   ' ', "X-xxx: ...");
32499 .endd
32500 Normally, there is always at least one non-deleted &'Received:'& header, but
32501 there may not be if &%received_header_text%& expands to an empty string.
32502
32503
32504 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32505 This function removes header lines. If &%occurrence%& is zero or negative, all
32506 occurrences of the header are removed. If occurrence is greater than zero, that
32507 particular instance of the header is removed. If no header(s) can be found that
32508 match the specification, the function does nothing.
32509
32510
32511 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32512         int&~length,&~BOOL&~notdel)*&"
32513 This function tests whether the given header has the given name. It is not just
32514 a string comparison, because white space is permitted between the name and the
32515 colon. If the &%notdel%& argument is true, a false return is forced for all
32516 &"deleted"& headers; otherwise they are not treated specially. For example:
32517 .code
32518 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32519 .endd
32520 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32521 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32522 This function base64-encodes a string, which is passed by address and length.
32523 The text may contain bytes of any value, including zero. The result is passed
32524 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32525 zero-terminated.
32526
32527 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32528 This function decodes a base64-encoded string. Its arguments are a
32529 zero-terminated base64-encoded string and the address of a variable that is set
32530 to point to the result, which is in dynamic memory. The length of the decoded
32531 string is the yield of the function. If the input is invalid base64 data, the
32532 yield is -1. A zero byte is added to the end of the output string to make it
32533 easy to interpret as a C string (assuming it contains no zeros of its own). The
32534 added zero byte is not included in the returned count.
32535
32536 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32537 This function checks for a match in a domain list. Domains are always
32538 matched caselessly. The return value is one of the following:
32539 .display
32540 &`OK     `& match succeeded
32541 &`FAIL   `& match failed
32542 &`DEFER  `& match deferred
32543 .endd
32544 DEFER is usually caused by some kind of lookup defer, such as the
32545 inability to contact a database.
32546
32547 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32548         BOOL&~caseless)*&"
32549 This function checks for a match in a local part list. The third argument
32550 controls case-sensitivity. The return values are as for
32551 &'lss_match_domain()'&.
32552
32553 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32554         BOOL&~caseless)*&"
32555 This function checks for a match in an address list. The third argument
32556 controls the case-sensitivity of the local part match. The domain is always
32557 matched caselessly. The return values are as for &'lss_match_domain()'&.
32558
32559 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32560         uschar&~*list)*&"
32561 This function checks for a match in a host list. The most common usage is
32562 expected to be
32563 .code
32564 lss_match_host(sender_host_name, sender_host_address, ...)
32565 .endd
32566 .vindex "&$sender_host_address$&"
32567 An empty address field matches an empty item in the host list. If the host name
32568 is NULL, the name corresponding to &$sender_host_address$& is automatically
32569 looked up if a host name is required to match an item in the list. The return
32570 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32571 returns ERROR in the case when it had to look up a host name, but the lookup
32572 failed.
32573
32574 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32575         *format,&~...)*&"
32576 This function writes to Exim's log files. The first argument should be zero (it
32577 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32578 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32579 them. It specifies to which log or logs the message is written. The remaining
32580 arguments are a format and relevant insertion arguments. The string should not
32581 contain any newlines, not even at the end.
32582
32583
32584 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32585 This function adds an additional recipient to the message. The first argument
32586 is the recipient address. If it is unqualified (has no domain), it is qualified
32587 with the &%qualify_recipient%& domain. The second argument must always be -1.
32588
32589 This function does not allow you to specify a private &%errors_to%& address (as
32590 described with the structure of &%recipient_item%& above), because it pre-dates
32591 the addition of that field to the structure. However, it is easy to add such a
32592 value afterwards. For example:
32593 .code
32594  receive_add_recipient(US"monitor@mydom.example", -1);
32595  recipients_list[recipients_count-1].errors_to =
32596    US"postmaster@mydom.example";
32597 .endd
32598
32599 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32600 This is a convenience function to remove a named recipient from the list of
32601 recipients. It returns true if a recipient was removed, and false if no
32602 matching recipient could be found. The argument must be a complete email
32603 address.
32604 .endlist
32605
32606
32607 .cindex "RFC 2047"
32608 .vlist
32609 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32610   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32611 This function decodes strings that are encoded according to RFC 2047. Typically
32612 these are the contents of header lines. First, each &"encoded word"& is decoded
32613 from the Q or B encoding into a byte-string. Then, if provided with the name of
32614 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32615 made  to translate the result to the named character set. If this fails, the
32616 binary string is returned with an error message.
32617
32618 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32619 maximum MIME word length is enforced. The third argument is the target
32620 encoding, or NULL if no translation is wanted.
32621
32622 .cindex "binary zero" "in RFC 2047 decoding"
32623 .cindex "RFC 2047" "binary zero in"
32624 If a binary zero is encountered in the decoded string, it is replaced by the
32625 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32626 not be 0 because header lines are handled as zero-terminated strings.
32627
32628 The function returns the result of processing the string, zero-terminated; if
32629 &%lenptr%& is not NULL, the length of the result is set in the variable to
32630 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32631
32632 If an error is encountered, the function returns NULL and uses the &%error%&
32633 argument to return an error message. The variable pointed to by &%error%& is
32634 set to NULL if there is no error; it may be set non-NULL even when the function
32635 returns a non-NULL value if decoding was successful, but there was a problem
32636 with translation.
32637
32638
32639 .vitem &*int&~smtp_fflush(void)*&
32640 This function is used in conjunction with &'smtp_printf()'&, as described
32641 below.
32642
32643 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32644 The arguments of this function are like &[printf()]&; it writes to the SMTP
32645 output stream. You should use this function only when there is an SMTP output
32646 stream, that is, when the incoming message is being received via interactive
32647 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32648 is FALSE. If you want to test for an incoming message from another host (as
32649 opposed to a local process that used the &%-bs%& command line option), you can
32650 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32651 is involved.
32652
32653 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32654 output function, so it can be used for all forms of SMTP connection.
32655
32656 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32657 must start with an appropriate response code: 550 if you are going to return
32658 LOCAL_SCAN_REJECT, 451 if you are going to return
32659 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32660 initial lines of a multi-line response, the code must be followed by a hyphen
32661 to indicate that the line is not the final response line. You must also ensure
32662 that the lines you write terminate with CRLF. For example:
32663 .code
32664 smtp_printf("550-this is some extra info\r\n");
32665 return LOCAL_SCAN_REJECT;
32666 .endd
32667 Note that you can also create multi-line responses by including newlines in
32668 the data returned via the &%return_text%& argument. The added value of using
32669 &'smtp_printf()'& is that, for instance, you could introduce delays between
32670 multiple output lines.
32671
32672 The &'smtp_printf()'& function does not return any error indication, because it
32673 does not automatically flush pending output, and therefore does not test
32674 the state of the stream. (In the main code of Exim, flushing and error
32675 detection is done when Exim is ready for the next SMTP input command.) If
32676 you want to flush the output and check for an error (for example, the
32677 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32678 arguments. It flushes the output stream, and returns a non-zero value if there
32679 is an error.
32680
32681 .vitem &*void&~*store_get(int)*&
32682 This function accesses Exim's internal store (memory) manager. It gets a new
32683 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32684 runs out of memory. See the next section for a discussion of memory handling.
32685
32686 .vitem &*void&~*store_get_perm(int)*&
32687 This function is like &'store_get()'&, but it always gets memory from the
32688 permanent pool. See the next section for a discussion of memory handling.
32689
32690 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32691 See below.
32692
32693 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32694 See below.
32695
32696 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32697 These three functions create strings using Exim's dynamic memory facilities.
32698 The first makes a copy of an entire string. The second copies up to a maximum
32699 number of characters, indicated by the second argument. The third uses a format
32700 and insertion arguments to create a new string. In each case, the result is a
32701 pointer to a new string in the current memory pool. See the next section for
32702 more discussion.
32703 .endlist
32704
32705
32706
32707 .section "More about Exim's memory handling" "SECTmemhanloc"
32708 .cindex "&[local_scan()]& function" "memory handling"
32709 No function is provided for freeing memory, because that is never needed.
32710 The dynamic memory that Exim uses when receiving a message is automatically
32711 recycled if another message is received by the same process (this applies only
32712 to incoming SMTP connections &-- other input methods can supply only one
32713 message at a time). After receiving the last message, a reception process
32714 terminates.
32715
32716 Because it is recycled, the normal dynamic memory cannot be used for holding
32717 data that must be preserved over a number of incoming messages on the same SMTP
32718 connection. However, Exim in fact uses two pools of dynamic memory; the second
32719 one is not recycled, and can be used for this purpose.
32720
32721 If you want to allocate memory that remains available for subsequent messages
32722 in the same SMTP connection, you should set
32723 .code
32724 store_pool = POOL_PERM
32725 .endd
32726 before calling the function that does the allocation. There is no need to
32727 restore the value if you do not need to; however, if you do want to revert to
32728 the normal pool, you can either restore the previous value of &%store_pool%& or
32729 set it explicitly to POOL_MAIN.
32730
32731 The pool setting applies to all functions that get dynamic memory, including
32732 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32733 There is also a convenience function called &'store_get_perm()'& that gets a
32734 block of memory from the permanent pool while preserving the value of
32735 &%store_pool%&.
32736 .ecindex IIDlosca
32737
32738
32739
32740
32741 . ////////////////////////////////////////////////////////////////////////////
32742 . ////////////////////////////////////////////////////////////////////////////
32743
32744 .chapter "System-wide message filtering" "CHAPsystemfilter"
32745 .scindex IIDsysfil1 "filter" "system filter"
32746 .scindex IIDsysfil2 "filtering all mail"
32747 .scindex IIDsysfil3 "system filter"
32748 The previous chapters (on ACLs and the local scan function) describe checks
32749 that can be applied to messages before they are accepted by a host. There is
32750 also a mechanism for checking messages once they have been received, but before
32751 they are delivered. This is called the &'system filter'&.
32752
32753 The system filter operates in a similar manner to users' filter files, but it
32754 is run just once per message (however many recipients the message has).
32755 It should not normally be used as a substitute for routing, because &%deliver%&
32756 commands in a system router provide new envelope recipient addresses.
32757 The system filter must be an Exim filter. It cannot be a Sieve filter.
32758
32759 The system filter is run at the start of a delivery attempt, before any routing
32760 is done. If a message fails to be completely delivered at the first attempt,
32761 the system filter is run again at the start of every retry.
32762 If you want your filter to do something only once per message, you can make use
32763 of the &%first_delivery%& condition in an &%if%& command in the filter to
32764 prevent it happening on retries.
32765
32766 .vindex "&$domain$&"
32767 .vindex "&$local_part$&"
32768 &*Warning*&: Because the system filter runs just once, variables that are
32769 specific to individual recipient addresses, such as &$local_part$& and
32770 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32771 you want to run a centrally-specified filter for each recipient address
32772 independently, you can do so by setting up a suitable &(redirect)& router, as
32773 described in section &<<SECTperaddfil>>& below.
32774
32775
32776 .section "Specifying a system filter" "SECID212"
32777 .cindex "uid (user id)" "system filter"
32778 .cindex "gid (group id)" "system filter"
32779 The name of the file that contains the system filter must be specified by
32780 setting &%system_filter%&. If you want the filter to run under a uid and gid
32781 other than root, you must also set &%system_filter_user%& and
32782 &%system_filter_group%& as appropriate. For example:
32783 .code
32784 system_filter = /etc/mail/exim.filter
32785 system_filter_user = exim
32786 .endd
32787 If a system filter generates any deliveries directly to files or pipes (via the
32788 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32789 specified by setting &%system_filter_file_transport%& and
32790 &%system_filter_pipe_transport%&, respectively. Similarly,
32791 &%system_filter_reply_transport%& must be set to handle any messages generated
32792 by the &%reply%& command.
32793
32794
32795 .section "Testing a system filter" "SECID213"
32796 You can run simple tests of a system filter in the same way as for a user
32797 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32798 are permitted only in system filters are recognized.
32799
32800 If you want to test the combined effect of a system filter and a user filter,
32801 you can use both &%-bF%& and &%-bf%& on the same command line.
32802
32803
32804
32805 .section "Contents of a system filter" "SECID214"
32806 The language used to specify system filters is the same as for users' filter
32807 files. It is described in the separate end-user document &'Exim's interface to
32808 mail filtering'&. However, there are some additional features that are
32809 available only in system filters; these are described in subsequent sections.
32810 If they are encountered in a user's filter file or when testing with &%-bf%&,
32811 they cause errors.
32812
32813 .cindex "frozen messages" "manual thaw; testing in filter"
32814 There are two special conditions which, though available in users' filter
32815 files, are designed for use in system filters. The condition &%first_delivery%&
32816 is true only for the first attempt at delivering a message, and
32817 &%manually_thawed%& is true only if the message has been frozen, and
32818 subsequently thawed by an admin user. An explicit forced delivery counts as a
32819 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32820
32821 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32822 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32823 succeed, it will not be tried again.
32824 If you want Exim to retry an unseen delivery until it succeeds, you should
32825 arrange to set it up every time the filter runs.
32826
32827 When a system filter finishes running, the values of the variables &$n0$& &--
32828 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32829 users' filter files. Thus a system filter can, for example, set up &"scores"&
32830 to which users' filter files can refer.
32831
32832
32833
32834 .section "Additional variable for system filters" "SECID215"
32835 .vindex "&$recipients$&"
32836 The expansion variable &$recipients$&, containing a list of all the recipients
32837 of the message (separated by commas and white space), is available in system
32838 filters. It is not available in users' filters for privacy reasons.
32839
32840
32841
32842 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32843 .cindex "freezing messages"
32844 .cindex "message" "freezing"
32845 .cindex "message" "forced failure"
32846 .cindex "&%fail%&" "in system filter"
32847 .cindex "&%freeze%& in system filter"
32848 .cindex "&%defer%& in system filter"
32849 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32850 always available in system filters, but are not normally enabled in users'
32851 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32852 for the &(redirect)& router.) These commands can optionally be followed by the
32853 word &%text%& and a string containing an error message, for example:
32854 .code
32855 fail text "this message looks like spam to me"
32856 .endd
32857 The keyword &%text%& is optional if the next character is a double quote.
32858
32859 The &%defer%& command defers delivery of the original recipients of the
32860 message. The &%fail%& command causes all the original recipients to be failed,
32861 and a bounce message to be created. The &%freeze%& command suspends all
32862 delivery attempts for the original recipients. In all cases, any new deliveries
32863 that are specified by the filter are attempted as normal after the filter has
32864 run.
32865
32866 The &%freeze%& command is ignored if the message has been manually unfrozen and
32867 not manually frozen since. This means that automatic freezing by a system
32868 filter can be used as a way of checking out suspicious messages. If a message
32869 is found to be all right, manually unfreezing it allows it to be delivered.
32870
32871 .cindex "log" "&%fail%& command log line"
32872 .cindex "&%fail%&" "log line; reducing"
32873 The text given with a fail command is used as part of the bounce message as
32874 well as being written to the log. If the message is quite long, this can fill
32875 up a lot of log space when such failures are common. To reduce the size of the
32876 log message, Exim interprets the text in a special way if it starts with the
32877 two characters &`<<`& and contains &`>>`& later. The text between these two
32878 strings is written to the log, and the rest of the text is used in the bounce
32879 message. For example:
32880 .code
32881 fail "<<filter test 1>>Your message is rejected \
32882      because it contains attachments that we are \
32883      not prepared to receive."
32884 .endd
32885
32886 .cindex "loop" "caused by &%fail%&"
32887 Take great care with the &%fail%& command when basing the decision to fail on
32888 the contents of the message, because the bounce message will of course include
32889 the contents of the original message and will therefore trigger the &%fail%&
32890 command again (causing a mail loop) unless steps are taken to prevent this.
32891 Testing the &%error_message%& condition is one way to prevent this. You could
32892 use, for example
32893 .code
32894 if $message_body contains "this is spam" and not error_message
32895 then fail text "spam is not wanted here" endif
32896 .endd
32897 though of course that might let through unwanted bounce messages. The
32898 alternative is clever checking of the body and/or headers to detect bounces
32899 generated by the filter.
32900
32901 The interpretation of a system filter file ceases after a
32902 &%defer%&,
32903 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32904 set up earlier in the filter file are honoured, so you can use a sequence such
32905 as
32906 .code
32907 mail ...
32908 freeze
32909 .endd
32910 to send a specified message when the system filter is freezing (or deferring or
32911 failing) a message. The normal deliveries for the message do not, of course,
32912 take place.
32913
32914
32915
32916 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32917 .cindex "header lines" "adding; in system filter"
32918 .cindex "header lines" "removing; in system filter"
32919 .cindex "filter" "header lines; adding/removing"
32920 Two filter commands that are available only in system filters are:
32921 .code
32922 headers add <string>
32923 headers remove <string>
32924 .endd
32925 The argument for the &%headers add%& is a string that is expanded and then
32926 added to the end of the message's headers. It is the responsibility of the
32927 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32928 space is ignored, and if the string is otherwise empty, or if the expansion is
32929 forced to fail, the command has no effect.
32930
32931 You can use &"\n"& within the string, followed by white space, to specify
32932 continued header lines. More than one header may be added in one command by
32933 including &"\n"& within the string without any following white space. For
32934 example:
32935 .code
32936 headers add "X-header-1: ....\n  \
32937              continuation of X-header-1 ...\n\
32938              X-header-2: ...."
32939 .endd
32940 Note that the header line continuation white space after the first newline must
32941 be placed before the backslash that continues the input string, because white
32942 space after input continuations is ignored.
32943
32944 The argument for &%headers remove%& is a colon-separated list of header names.
32945 This command applies only to those headers that are stored with the message;
32946 those that are added at delivery time (such as &'Envelope-To:'& and
32947 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32948 header with the same name, they are all removed.
32949
32950 The &%headers%& command in a system filter makes an immediate change to the set
32951 of header lines that was received with the message (with possible additions
32952 from ACL processing). Subsequent commands in the system filter operate on the
32953 modified set, which also forms the basis for subsequent message delivery.
32954 Unless further modified during routing or transporting, this set of headers is
32955 used for all recipients of the message.
32956
32957 During routing and transporting, the variables that refer to the contents of
32958 header lines refer only to those lines that are in this set. Thus, header lines
32959 that are added by a system filter are visible to users' filter files and to all
32960 routers and transports. This contrasts with the manipulation of header lines by
32961 routers and transports, which is not immediate, but which instead is saved up
32962 until the message is actually being written (see section
32963 &<<SECTheadersaddrem>>&).
32964
32965 If the message is not delivered at the first attempt, header lines that were
32966 added by the system filter are stored with the message, and so are still
32967 present at the next delivery attempt. Header lines that were removed are still
32968 present, but marked &"deleted"& so that they are not transported with the
32969 message. For this reason, it is usual to make the &%headers%& command
32970 conditional on &%first_delivery%& so that the set of header lines is not
32971 modified more than once.
32972
32973 Because header modification in a system filter acts immediately, you have to
32974 use an indirect approach if you want to modify the contents of a header line.
32975 For example:
32976 .code
32977 headers add "Old-Subject: $h_subject:"
32978 headers remove "Subject"
32979 headers add "Subject: new subject (was: $h_old-subject:)"
32980 headers remove "Old-Subject"
32981 .endd
32982
32983
32984
32985 .section "Setting an errors address in a system filter" "SECID217"
32986 .cindex "envelope sender"
32987 In a system filter, if a &%deliver%& command is followed by
32988 .code
32989 errors_to <some address>
32990 .endd
32991 in order to change the envelope sender (and hence the error reporting) for that
32992 delivery, any address may be specified. (In a user filter, only the current
32993 user's address can be set.) For example, if some mail is being monitored, you
32994 might use
32995 .code
32996 unseen deliver monitor@spying.example errors_to root@local.example
32997 .endd
32998 to take a copy which would not be sent back to the normal error reporting
32999 address if its delivery failed.
33000
33001
33002
33003 .section "Per-address filtering" "SECTperaddfil"
33004 .vindex "&$domain$&"
33005 .vindex "&$local_part$&"
33006 In contrast to the system filter, which is run just once per message for each
33007 delivery attempt, it is also possible to set up a system-wide filtering
33008 operation that runs once for each recipient address. In this case, variables
33009 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33010 filter file could be made dependent on them. This is an example of a router
33011 which implements such a filter:
33012 .code
33013 central_filter:
33014   check_local_user
33015   driver = redirect
33016   domains = +local_domains
33017   file = /central/filters/$local_part
33018   no_verify
33019   allow_filter
33020   allow_freeze
33021 .endd
33022 The filter is run in a separate process under its own uid. Therefore, either
33023 &%check_local_user%& must be set (as above), in which case the filter is run as
33024 the local user, or the &%user%& option must be used to specify which user to
33025 use. If both are set, &%user%& overrides.
33026
33027 Care should be taken to ensure that none of the commands in the filter file
33028 specify a significant delivery if the message is to go on to be delivered to
33029 its intended recipient. The router will not then claim to have dealt with the
33030 address, so it will be passed on to subsequent routers to be delivered in the
33031 normal way.
33032 .ecindex IIDsysfil1
33033 .ecindex IIDsysfil2
33034 .ecindex IIDsysfil3
33035
33036
33037
33038
33039
33040
33041 . ////////////////////////////////////////////////////////////////////////////
33042 . ////////////////////////////////////////////////////////////////////////////
33043
33044 .chapter "Message processing" "CHAPmsgproc"
33045 .scindex IIDmesproc "message" "general processing"
33046 Exim performs various transformations on the sender and recipient addresses of
33047 all messages that it handles, and also on the messages' header lines. Some of
33048 these are optional and configurable, while others always take place. All of
33049 this processing, except rewriting as a result of routing, and the addition or
33050 removal of header lines while delivering, happens when a message is received,
33051 before it is placed on Exim's queue.
33052
33053 Some of the automatic processing takes place by default only for
33054 &"locally-originated"& messages. This adjective is used to describe messages
33055 that are not received over TCP/IP, but instead are passed to an Exim process on
33056 its standard input. This includes the interactive &"local SMTP"& case that is
33057 set up by the &%-bs%& command line option.
33058
33059 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33060 or ::1) are not considered to be locally-originated. Exim does not treat the
33061 loopback interface specially in any way.
33062
33063 If you want the loopback interface to be treated specially, you must ensure
33064 that there are appropriate entries in your ACLs.
33065
33066
33067
33068
33069 .section "Submission mode for non-local messages" "SECTsubmodnon"
33070 .cindex "message" "submission"
33071 .cindex "submission mode"
33072 Processing that happens automatically for locally-originated messages (unless
33073 &%suppress_local_fixups%& is set) can also be requested for messages that are
33074 received over TCP/IP. The term &"submission mode"& is used to describe this
33075 state. Submission mode is set by the modifier
33076 .code
33077 control = submission
33078 .endd
33079 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33080 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33081 a local submission, and is normally used when the source of the message is
33082 known to be an MUA running on a client host (as opposed to an MTA). For
33083 example, to set submission mode for messages originating on the IPv4 loopback
33084 interface, you could include the following in the MAIL ACL:
33085 .code
33086 warn  hosts = 127.0.0.1
33087       control = submission
33088 .endd
33089 .cindex "&%sender_retain%& submission option"
33090 There are some options that can be used when setting submission mode. A slash
33091 is used to separate options. For example:
33092 .code
33093 control = submission/sender_retain
33094 .endd
33095 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33096 true and &%local_from_check%& false for the current incoming message. The first
33097 of these allows an existing &'Sender:'& header in the message to remain, and
33098 the second suppresses the check to ensure that &'From:'& matches the
33099 authenticated sender. With this setting, Exim still fixes up messages by adding
33100 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33101 attempt to check sender authenticity in header lines.
33102
33103 When &%sender_retain%& is not set, a submission mode setting may specify a
33104 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33105 example:
33106 .code
33107 control = submission/domain=some.domain
33108 .endd
33109 The domain may be empty. How this value is used is described in sections
33110 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33111 that allows you to specify the user's full name for inclusion in a created
33112 &'Sender:'& or &'From:'& header line. For example:
33113 .code
33114 accept authenticated = *
33115        control = submission/domain=wonderland.example/\
33116                             name=${lookup {$authenticated_id} \
33117                                    lsearch {/etc/exim/namelist}}
33118 .endd
33119 Because the name may contain any characters, including slashes, the &%name%&
33120 option must be given last. The remainder of the string is used as the name. For
33121 the example above, if &_/etc/exim/namelist_& contains:
33122 .code
33123 bigegg:  Humpty Dumpty
33124 .endd
33125 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33126 line would be:
33127 .code
33128 Sender: Humpty Dumpty <bigegg@wonderland.example>
33129 .endd
33130 .cindex "return path" "in submission mode"
33131 By default, submission mode forces the return path to the same address as is
33132 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33133 specified, the return path is also left unchanged.
33134
33135 &*Note*&: The changes caused by submission mode take effect after the predata
33136 ACL. This means that any sender checks performed before the fix-ups use the
33137 untrusted sender address specified by the user, not the trusted sender address
33138 specified by submission mode. Although this might be slightly unexpected, it
33139 does mean that you can configure ACL checks to spot that a user is trying to
33140 spoof another's address.
33141
33142 .section "Line endings" "SECTlineendings"
33143 .cindex "line endings"
33144 .cindex "carriage return"
33145 .cindex "linefeed"
33146 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33147 linefeed) is the line ending for messages transmitted over the Internet using
33148 SMTP over TCP/IP. However, within individual operating systems, different
33149 conventions are used. For example, Unix-like systems use just LF, but others
33150 use CRLF or just CR.
33151
33152 Exim was designed for Unix-like systems, and internally, it stores messages
33153 using the system's convention of a single LF as a line terminator. When
33154 receiving a message, all line endings are translated to this standard format.
33155 Originally, it was thought that programs that passed messages directly to an
33156 MTA within an operating system would use that system's convention. Experience
33157 has shown that this is not the case; for example, there are Unix applications
33158 that use CRLF in this circumstance. For this reason, and for compatibility with
33159 other MTAs, the way Exim handles line endings for all messages is now as
33160 follows:
33161
33162 .ilist
33163 LF not preceded by CR is treated as a line ending.
33164 .next
33165 CR is treated as a line ending; if it is immediately followed by LF, the LF
33166 is ignored.
33167 .next
33168 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33169 nor a local message in the state where a line containing only a dot is a
33170 terminator.
33171 .next
33172 If a bare CR is encountered within a header line, an extra space is added after
33173 the line terminator so as not to end the header line. The reasoning behind this
33174 is that bare CRs in header lines are most likely either to be mistakes, or
33175 people trying to play silly games.
33176 .next
33177 If the first header line received in a message ends with CRLF, a subsequent
33178 bare LF in a header line is treated in the same way as a bare CR in a header
33179 line.
33180 .endlist
33181
33182
33183
33184
33185
33186 .section "Unqualified addresses" "SECID218"
33187 .cindex "unqualified addresses"
33188 .cindex "address" "qualification"
33189 By default, Exim expects every envelope address it receives from an external
33190 host to be fully qualified. Unqualified addresses cause negative responses to
33191 SMTP commands. However, because SMTP is used as a means of transporting
33192 messages from MUAs running on personal workstations, there is sometimes a
33193 requirement to accept unqualified addresses from specific hosts or IP networks.
33194
33195 Exim has two options that separately control which hosts may send unqualified
33196 sender or recipient addresses in SMTP commands, namely
33197 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33198 cases, if an unqualified address is accepted, it is qualified by adding the
33199 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33200
33201 .oindex "&%qualify_domain%&"
33202 .oindex "&%qualify_recipient%&"
33203 Unqualified addresses in header lines are automatically qualified for messages
33204 that are locally originated, unless the &%-bnq%& option is given on the command
33205 line. For messages received over SMTP, unqualified addresses in header lines
33206 are qualified only if unqualified addresses are permitted in SMTP commands. In
33207 other words, such qualification is also controlled by
33208 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33209
33210
33211
33212
33213 .section "The UUCP From line" "SECID219"
33214 .cindex "&""From""& line"
33215 .cindex "UUCP" "&""From""& line"
33216 .cindex "sender" "address"
33217 .oindex "&%uucp_from_pattern%&"
33218 .oindex "&%uucp_from_sender%&"
33219 .cindex "envelope sender"
33220 .cindex "Sendmail compatibility" "&""From""& line"
33221 Messages that have come from UUCP (and some other applications) often begin
33222 with a line containing the envelope sender and a timestamp, following the word
33223 &"From"&. Examples of two common formats are:
33224 .code
33225 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33226 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33227 .endd
33228 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33229 Exim recognizes such lines at the start of messages that are submitted to it
33230 via the command line (that is, on the standard input). It does not recognize
33231 such lines in incoming SMTP messages, unless the sending host matches
33232 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33233 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33234 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33235 default value matches the two common cases shown above and puts the address
33236 that follows &"From"& into &$1$&.
33237
33238 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33239 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33240 a trusted user, the message's sender address is constructed by expanding the
33241 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33242 then parsed as an RFC 2822 address. If there is no domain, the local part is
33243 qualified with &%qualify_domain%& unless it is the empty string. However, if
33244 the command line &%-f%& option is used, it overrides the &"From"& line.
33245
33246 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33247 sender address is not changed. This is also the case for incoming SMTP messages
33248 that are permitted to contain &"From"& lines.
33249
33250 Only one &"From"& line is recognized. If there is more than one, the second is
33251 treated as a data line that starts the body of the message, as it is not valid
33252 as a header line. This also happens if a &"From"& line is present in an
33253 incoming SMTP message from a source that is not permitted to send them.
33254
33255
33256
33257 .section "Resent- header lines" "SECID220"
33258 .cindex "&%Resent-%& header lines"
33259 RFC 2822 makes provision for sets of header lines starting with the string
33260 &`Resent-`& to be added to a message when it is resent by the original
33261 recipient to somebody else. These headers are &'Resent-Date:'&,
33262 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33263 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33264
33265 .blockquote
33266 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33267 processing of replies or other such automatic actions on messages.'&
33268 .endblockquote
33269
33270 This leaves things a bit vague as far as other processing actions such as
33271 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33272 follows:
33273
33274 .ilist
33275 A &'Resent-From:'& line that just contains the login id of the submitting user
33276 is automatically rewritten in the same way as &'From:'& (see below).
33277 .next
33278 If there's a rewriting rule for a particular header line, it is also applied to
33279 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33280 &'From:'& also rewrites &'Resent-From:'&.
33281 .next
33282 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33283 also removed.
33284 .next
33285 For a locally-submitted message,
33286 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33287 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33288 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33289 included in log lines in this case.
33290 .next
33291 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33292 &%Resent-%& header lines are present.
33293 .endlist
33294
33295
33296
33297
33298 .section "The Auto-Submitted: header line" "SECID221"
33299 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33300 includes the header line:
33301 .code
33302 Auto-Submitted: auto-replied
33303 .endd
33304
33305 .section "The Bcc: header line" "SECID222"
33306 .cindex "&'Bcc:'& header line"
33307 If Exim is called with the &%-t%& option, to take recipient addresses from a
33308 message's header, it removes any &'Bcc:'& header line that may exist (after
33309 extracting its addresses). If &%-t%& is not present on the command line, any
33310 existing &'Bcc:'& is not removed.
33311
33312
33313 .section "The Date: header line" "SECID223"
33314 .cindex "&'Date:'& header line"
33315 If a locally-generated or submission-mode message has no &'Date:'& header line,
33316 Exim adds one, using the current date and time, unless the
33317 &%suppress_local_fixups%& control has been specified.
33318
33319 .section "The Delivery-date: header line" "SECID224"
33320 .cindex "&'Delivery-date:'& header line"
33321 .oindex "&%delivery_date_remove%&"
33322 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33323 set. Exim can be configured to add them to the final delivery of messages. (See
33324 the generic &%delivery_date_add%& transport option.) They should not be present
33325 in messages in transit. If the &%delivery_date_remove%& configuration option is
33326 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33327 messages.
33328
33329
33330 .section "The Envelope-to: header line" "SECID225"
33331 .cindex "&'Envelope-to:'& header line"
33332 .oindex "&%envelope_to_remove%&"
33333 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33334 Exim can be configured to add them to the final delivery of messages. (See the
33335 generic &%envelope_to_add%& transport option.) They should not be present in
33336 messages in transit. If the &%envelope_to_remove%& configuration option is set
33337 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33338 messages.
33339
33340
33341 .section "The From: header line" "SECTthefrohea"
33342 .cindex "&'From:'& header line"
33343 .cindex "Sendmail compatibility" "&""From""& line"
33344 .cindex "message" "submission"
33345 .cindex "submission mode"
33346 If a submission-mode message does not contain a &'From:'& header line, Exim
33347 adds one if either of the following conditions is true:
33348
33349 .ilist
33350 The envelope sender address is not empty (that is, this is not a bounce
33351 message). The added header line copies the envelope sender address.
33352 .next
33353 .vindex "&$authenticated_id$&"
33354 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33355 .olist
33356 .vindex "&$qualify_domain$&"
33357 If no domain is specified by the submission control, the local part is
33358 &$authenticated_id$& and the domain is &$qualify_domain$&.
33359 .next
33360 If a non-empty domain is specified by the submission control, the local
33361 part is &$authenticated_id$&, and the domain is the specified domain.
33362 .next
33363 If an empty domain is specified by the submission control,
33364 &$authenticated_id$& is assumed to be the complete address.
33365 .endlist
33366 .endlist
33367
33368 A non-empty envelope sender takes precedence.
33369
33370 If a locally-generated incoming message does not contain a &'From:'& header
33371 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33372 containing the sender's address. The calling user's login name and full name
33373 are used to construct the address, as described in section &<<SECTconstr>>&.
33374 They are obtained from the password data by calling &[getpwuid()]& (but see the
33375 &%unknown_login%& configuration option). The address is qualified with
33376 &%qualify_domain%&.
33377
33378 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33379 &'From:'& header line containing just the unqualified login name of the calling
33380 user, this is replaced by an address containing the user's login name and full
33381 name as described in section &<<SECTconstr>>&.
33382
33383
33384 .section "The Message-ID: header line" "SECID226"
33385 .cindex "&'Message-ID:'& header line"
33386 .cindex "message" "submission"
33387 .oindex "&%message_id_header_text%&"
33388 If a locally-generated or submission-mode incoming message does not contain a
33389 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33390 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33391 to the message. If there are any &'Resent-:'& headers in the message, it
33392 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33393 message id, preceded by the letter E to ensure it starts with a letter, and
33394 followed by @ and the primary host name. Additional information can be included
33395 in this header line by setting the &%message_id_header_text%& and/or
33396 &%message_id_header_domain%& options.
33397
33398
33399 .section "The Received: header line" "SECID227"
33400 .cindex "&'Received:'& header line"
33401 A &'Received:'& header line is added at the start of every message. The
33402 contents are defined by the &%received_header_text%& configuration option, and
33403 Exim automatically adds a semicolon and a timestamp to the configured string.
33404
33405 The &'Received:'& header is generated as soon as the message's header lines
33406 have been received. At this stage, the timestamp in the &'Received:'& header
33407 line is the time that the message started to be received. This is the value
33408 that is seen by the DATA ACL and by the &[local_scan()]& function.
33409
33410 Once a message is accepted, the timestamp in the &'Received:'& header line is
33411 changed to the time of acceptance, which is (apart from a small delay while the
33412 -H spool file is written) the earliest time at which delivery could start.
33413
33414
33415 .section "The References: header line" "SECID228"
33416 .cindex "&'References:'& header line"
33417 Messages created by the &(autoreply)& transport include a &'References:'&
33418 header line. This is constructed according to the rules that are described in
33419 section 3.64 of RFC 2822 (which states that replies should contain such a
33420 header line), and section 3.14 of RFC 3834 (which states that automatic
33421 responses are not different in this respect). However, because some mail
33422 processing software does not cope well with very long header lines, no more
33423 than 12 message IDs are copied from the &'References:'& header line in the
33424 incoming message. If there are more than 12, the first one and then the final
33425 11 are copied, before adding the message ID of the incoming message.
33426
33427
33428
33429 .section "The Return-path: header line" "SECID229"
33430 .cindex "&'Return-path:'& header line"
33431 .oindex "&%return_path_remove%&"
33432 &'Return-path:'& header lines are defined as something an MTA may insert when
33433 it does the final delivery of messages. (See the generic &%return_path_add%&
33434 transport option.) Therefore, they should not be present in messages in
33435 transit. If the &%return_path_remove%& configuration option is set (the
33436 default), Exim removes &'Return-path:'& header lines from incoming messages.
33437
33438
33439
33440 .section "The Sender: header line" "SECTthesenhea"
33441 .cindex "&'Sender:'& header line"
33442 .cindex "message" "submission"
33443 For a locally-originated message from an untrusted user, Exim may remove an
33444 existing &'Sender:'& header line, and it may add a new one. You can modify
33445 these actions by setting the &%local_sender_retain%& option true, the
33446 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33447 control setting.
33448
33449 When a local message is received from an untrusted user and
33450 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33451 control has not been set, a check is made to see if the address given in the
33452 &'From:'& header line is the correct (local) sender of the message. The address
33453 that is expected has the login name as the local part and the value of
33454 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33455 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33456 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33457 line is added to the message.
33458
33459 If you set &%local_from_check%& false, this checking does not occur. However,
33460 the removal of an existing &'Sender:'& line still happens, unless you also set
33461 &%local_sender_retain%& to be true. It is not possible to set both of these
33462 options true at the same time.
33463
33464 .cindex "submission mode"
33465 By default, no processing of &'Sender:'& header lines is done for messages
33466 received over TCP/IP or for messages submitted by trusted users. However, when
33467 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33468 not specified on the submission control, the following processing takes place:
33469
33470 .vindex "&$authenticated_id$&"
33471 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33472 authenticated, and &$authenticated_id$& is not empty, a sender address is
33473 created as follows:
33474
33475 .ilist
33476 .vindex "&$qualify_domain$&"
33477 If no domain is specified by the submission control, the local part is
33478 &$authenticated_id$& and the domain is &$qualify_domain$&.
33479 .next
33480 If a non-empty domain is specified by the submission control, the local part
33481 is &$authenticated_id$&, and the domain is the specified domain.
33482 .next
33483 If an empty domain is specified by the submission control,
33484 &$authenticated_id$& is assumed to be the complete address.
33485 .endlist
33486
33487 This address is compared with the address in the &'From:'& header line. If they
33488 are different, a &'Sender:'& header line containing the created address is
33489 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33490 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33491
33492 .cindex "return path" "created from &'Sender:'&"
33493 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33494 the message (the envelope sender address) is changed to be the same address,
33495 except in the case of submission mode when &%sender_retain%& is specified.
33496
33497
33498
33499 .section "Adding and removing header lines in routers and transports" &&&
33500          "SECTheadersaddrem"
33501 .cindex "header lines" "adding; in router or transport"
33502 .cindex "header lines" "removing; in router or transport"
33503 When a message is delivered, the addition and removal of header lines can be
33504 specified in a system filter, or on any of the routers and transports that
33505 process the message. Section &<<SECTaddremheasys>>& contains details about
33506 modifying headers in a system filter. Header lines can also be added in an ACL
33507 as a message is received (see section &<<SECTaddheadacl>>&).
33508
33509 In contrast to what happens in a system filter, header modifications that are
33510 specified on routers and transports apply only to the particular recipient
33511 addresses that are being processed by those routers and transports. These
33512 changes do not actually take place until a copy of the message is being
33513 transported. Therefore, they do not affect the basic set of header lines, and
33514 they do not affect the values of the variables that refer to header lines.
33515
33516 &*Note*&: In particular, this means that any expansions in the configuration of
33517 the transport cannot refer to the modified header lines, because such
33518 expansions all occur before the message is actually transported.
33519
33520 For both routers and transports, the argument of a &%headers_add%&
33521 option must be in the form of one or more RFC 2822 header lines, separated by
33522 newlines (coded as &"\n"&). For example:
33523 .code
33524 headers_add = X-added-header: added by $primary_hostname\n\
33525               X-added-second: another added header line
33526 .endd
33527 Exim does not check the syntax of these added header lines.
33528
33529 Multiple &%headers_add%& options for a single router or transport can be
33530 specified; the values will append to a single list of header lines.
33531 Each header-line is separately expanded.
33532
33533 The argument of a &%headers_remove%& option must consist of a colon-separated
33534 list of header names. This is confusing, because header names themselves are
33535 often terminated by colons. In this case, the colons are the list separators,
33536 not part of the names. For example:
33537 .code
33538 headers_remove = return-receipt-to:acknowledge-to
33539 .endd
33540
33541 Multiple &%headers_remove%& options for a single router or transport can be
33542 specified; the arguments will append to a single header-names list.
33543 Each item is separately expanded.
33544 Note that colons in complex expansions which are used to
33545 form all or part of a &%headers_remove%& list
33546 will act as list separators.
33547
33548 When &%headers_add%& or &%headers_remove%& is specified on a router,
33549 items are expanded at routing time,
33550 and then associated with all addresses that are
33551 accepted by that router, and also with any new addresses that it generates. If
33552 an address passes through several routers as a result of aliasing or
33553 forwarding, the changes are cumulative.
33554
33555 .oindex "&%unseen%&"
33556 However, this does not apply to multiple routers that result from the use of
33557 the &%unseen%& option. Any header modifications that were specified by the
33558 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33559
33560 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33561 settings cannot be delivered together in a batch, so a transport is always
33562 dealing with a set of addresses that have the same header-processing
33563 requirements.
33564
33565 The transport starts by writing the original set of header lines that arrived
33566 with the message, possibly modified by the system filter. As it writes out
33567 these lines, it consults the list of header names that were attached to the
33568 recipient address(es) by &%headers_remove%& options in routers, and it also
33569 consults the transport's own &%headers_remove%& option. Header lines whose
33570 names are on either of these lists are not written out. If there are multiple
33571 instances of any listed header, they are all skipped.
33572
33573 After the remaining original header lines have been written, new header
33574 lines that were specified by routers' &%headers_add%& options are written, in
33575 the order in which they were attached to the address. These are followed by any
33576 header lines specified by the transport's &%headers_add%& option.
33577
33578 This way of handling header line modifications in routers and transports has
33579 the following consequences:
33580
33581 .ilist
33582 The original set of header lines, possibly modified by the system filter,
33583 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33584 to it, at all times.
33585 .next
33586 Header lines that are added by a router's
33587 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33588 expansion syntax in subsequent routers or the transport.
33589 .next
33590 Conversely, header lines that are specified for removal by &%headers_remove%&
33591 in a router remain visible to subsequent routers and the transport.
33592 .next
33593 Headers added to an address by &%headers_add%& in a router cannot be removed by
33594 a later router or by a transport.
33595 .next
33596 An added header can refer to the contents of an original header that is to be
33597 removed, even it has the same name as the added header. For example:
33598 .code
33599 headers_remove = subject
33600 headers_add = Subject: new subject (was: $h_subject:)
33601 .endd
33602 .endlist
33603
33604 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33605 for a &(redirect)& router that has the &%one_time%& option set.
33606
33607
33608
33609
33610
33611 .section "Constructed addresses" "SECTconstr"
33612 .cindex "address" "constructed"
33613 .cindex "constructed address"
33614 When Exim constructs a sender address for a locally-generated message, it uses
33615 the form
33616 .display
33617 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33618 .endd
33619 For example:
33620 .code
33621 Zaphod Beeblebrox <zaphod@end.univ.example>
33622 .endd
33623 The user name is obtained from the &%-F%& command line option if set, or
33624 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33625 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33626 ampersand character, this is replaced by the login name with the first letter
33627 upper cased, as is conventional in a number of operating systems. See the
33628 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33629 The &%unknown_username%& option can be used to specify user names in cases when
33630 there is no password file entry.
33631
33632 .cindex "RFC 2047"
33633 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33634 parts of it if necessary. In addition, if it contains any non-printing
33635 characters, it is encoded as described in RFC 2047, which defines a way of
33636 including non-ASCII characters in header lines. The value of the
33637 &%headers_charset%& option specifies the name of the encoding that is used (the
33638 characters are assumed to be in this encoding). The setting of
33639 &%print_topbitchars%& controls whether characters with the top bit set (that
33640 is, with codes greater than 127) count as printing characters or not.
33641
33642
33643
33644 .section "Case of local parts" "SECID230"
33645 .cindex "case of local parts"
33646 .cindex "local part" "case of"
33647 RFC 2822 states that the case of letters in the local parts of addresses cannot
33648 be assumed to be non-significant. Exim preserves the case of local parts of
33649 addresses, but by default it uses a lower-cased form when it is routing,
33650 because on most Unix systems, usernames are in lower case and case-insensitive
33651 routing is required. However, any particular router can be made to use the
33652 original case for local parts by setting the &%caseful_local_part%& generic
33653 router option.
33654
33655 .cindex "mixed-case login names"
33656 If you must have mixed-case user names on your system, the best way to proceed,
33657 assuming you want case-independent handling of incoming email, is to set up
33658 your first router to convert incoming local parts in your domains to the
33659 correct case by means of a file lookup. For example:
33660 .code
33661 correct_case:
33662   driver = redirect
33663   domains = +local_domains
33664   data = ${lookup{$local_part}cdb\
33665               {/etc/usercased.cdb}{$value}fail}\
33666               @$domain
33667 .endd
33668 For this router, the local part is forced to lower case by the default action
33669 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33670 up a new local part in the correct case. If you then set &%caseful_local_part%&
33671 on any subsequent routers which process your domains, they will operate on
33672 local parts with the correct case in a case-sensitive manner.
33673
33674
33675
33676 .section "Dots in local parts" "SECID231"
33677 .cindex "dot" "in local part"
33678 .cindex "local part" "dots in"
33679 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33680 part may not begin or end with a dot, nor have two consecutive dots in the
33681 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33682 empty components for compatibility.
33683
33684
33685
33686 .section "Rewriting addresses" "SECID232"
33687 .cindex "rewriting" "addresses"
33688 Rewriting of sender and recipient addresses, and addresses in headers, can
33689 happen automatically, or as the result of configuration options, as described
33690 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33691 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33692
33693 Automatic rewriting includes qualification, as mentioned above. The other case
33694 in which it can happen is when an incomplete non-local domain is given. The
33695 routing process may cause this to be expanded into the full domain name. For
33696 example, a header such as
33697 .code
33698 To: hare@teaparty
33699 .endd
33700 might get rewritten as
33701 .code
33702 To: hare@teaparty.wonderland.fict.example
33703 .endd
33704 Rewriting as a result of routing is the one kind of message processing that
33705 does not happen at input time, as it cannot be done until the address has
33706 been routed.
33707
33708 Strictly, one should not do &'any'& deliveries of a message until all its
33709 addresses have been routed, in case any of the headers get changed as a
33710 result of routing. However, doing this in practice would hold up many
33711 deliveries for unreasonable amounts of time, just because one address could not
33712 immediately be routed. Exim therefore does not delay other deliveries when
33713 routing of one or more addresses is deferred.
33714 .ecindex IIDmesproc
33715
33716
33717
33718 . ////////////////////////////////////////////////////////////////////////////
33719 . ////////////////////////////////////////////////////////////////////////////
33720
33721 .chapter "SMTP processing" "CHAPSMTP"
33722 .scindex IIDsmtpproc1 "SMTP" "processing details"
33723 .scindex IIDsmtpproc2 "LMTP" "processing details"
33724 Exim supports a number of different ways of using the SMTP protocol, and its
33725 LMTP variant, which is an interactive protocol for transferring messages into a
33726 closed mail store application. This chapter contains details of how SMTP is
33727 processed. For incoming mail, the following are available:
33728
33729 .ilist
33730 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33731 .next
33732 SMTP over the standard input and output (the &%-bs%& option);
33733 .next
33734 Batched SMTP on the standard input (the &%-bS%& option).
33735 .endlist
33736
33737 For mail delivery, the following are available:
33738
33739 .ilist
33740 SMTP over TCP/IP (the &(smtp)& transport);
33741 .next
33742 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33743 &"lmtp"&);
33744 .next
33745 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33746 transport);
33747 .next
33748 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33749 the &%use_bsmtp%& option set).
33750 .endlist
33751
33752 &'Batched SMTP'& is the name for a process in which batches of messages are
33753 stored in or read from files (or pipes), in a format in which SMTP commands are
33754 used to contain the envelope information.
33755
33756
33757
33758 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33759 .cindex "SMTP" "outgoing over TCP/IP"
33760 .cindex "outgoing SMTP over TCP/IP"
33761 .cindex "LMTP" "over TCP/IP"
33762 .cindex "outgoing LMTP over TCP/IP"
33763 .cindex "EHLO"
33764 .cindex "HELO"
33765 .cindex "SIZE option on MAIL command"
33766 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33767 The &%protocol%& option selects which protocol is to be used, but the actual
33768 processing is the same in both cases.
33769
33770 If, in response to its EHLO command, Exim is told that the SIZE
33771 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33772 command. The value of <&'n'&> is the message size plus the value of the
33773 &%size_addition%& option (default 1024) to allow for additions to the message
33774 such as per-transport header lines, or changes made in a
33775 .cindex "transport" "filter"
33776 .cindex "filter" "transport filter"
33777 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33778 suppressed.
33779
33780 If the remote server advertises support for PIPELINING, Exim uses the
33781 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33782 required for the transaction.
33783
33784 If the remote server advertises support for the STARTTLS command, and Exim
33785 was built to support TLS encryption, it tries to start a TLS session unless the
33786 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33787 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33788 is called for verification.
33789
33790 If the remote server advertises support for the AUTH command, Exim scans
33791 the authenticators configuration for any suitable client settings, as described
33792 in chapter &<<CHAPSMTPAUTH>>&.
33793
33794 .cindex "carriage return"
33795 .cindex "linefeed"
33796 Responses from the remote host are supposed to be terminated by CR followed by
33797 LF. However, there are known to be hosts that do not send CR characters, so in
33798 order to be able to interwork with such hosts, Exim treats LF on its own as a
33799 line terminator.
33800
33801 If a message contains a number of different addresses, all those with the same
33802 characteristics (for example, the same envelope sender) that resolve to the
33803 same set of hosts, in the same order, are sent in a single SMTP transaction,
33804 even if they are for different domains, unless there are more than the setting
33805 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33806 they are split into groups containing no more than &%max_rcpt%&s addresses
33807 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33808 in parallel sessions. The order of hosts with identical MX values is not
33809 significant when checking whether addresses can be batched in this way.
33810
33811 When the &(smtp)& transport suffers a temporary failure that is not
33812 message-related, Exim updates its transport-specific database, which contains
33813 records indexed by host name that remember which messages are waiting for each
33814 particular host. It also updates the retry database with new retry times.
33815
33816 .cindex "hints database" "retry keys"
33817 Exim's retry hints are based on host name plus IP address, so if one address of
33818 a multi-homed host is broken, it will soon be skipped most of the time.
33819 See the next section for more detail about error handling.
33820
33821 .cindex "SMTP" "passed connection"
33822 .cindex "SMTP" "batching over TCP/IP"
33823 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33824 looks in the hints database for the transport to see if there are any queued
33825 messages waiting for the host to which it is connected. If it finds one, it
33826 creates a new Exim process using the &%-MC%& option (which can only be used by
33827 a process running as root or the Exim user) and passes the TCP/IP socket to it
33828 so that it can deliver another message using the same socket. The new process
33829 does only those deliveries that are routed to the connected host, and may in
33830 turn pass the socket on to a third process, and so on.
33831
33832 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33833 limit the number of messages sent down a single TCP/IP connection.
33834
33835 .cindex "asterisk" "after IP address"
33836 The second and subsequent messages delivered down an existing connection are
33837 identified in the main log by the addition of an asterisk after the closing
33838 square bracket of the IP address.
33839
33840
33841
33842
33843 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33844 .cindex "error" "in outgoing SMTP"
33845 .cindex "SMTP" "errors in outgoing"
33846 .cindex "host" "error"
33847 Three different kinds of error are recognized for outgoing SMTP: host errors,
33848 message errors, and recipient errors.
33849
33850 .vlist
33851 .vitem "&*Host errors*&"
33852 A host error is not associated with a particular message or with a
33853 particular recipient of a message. The host errors are:
33854
33855 .ilist
33856 Connection refused or timed out,
33857 .next
33858 Any error response code on connection,
33859 .next
33860 Any error response code to EHLO or HELO,
33861 .next
33862 Loss of connection at any time, except after &"."&,
33863 .next
33864 I/O errors at any time,
33865 .next
33866 Timeouts during the session, other than in response to MAIL, RCPT or
33867 the &"."& at the end of the data.
33868 .endlist ilist
33869
33870 For a host error, a permanent error response on connection, or in response to
33871 EHLO, causes all addresses routed to the host to be failed. Any other host
33872 error causes all addresses to be deferred, and retry data to be created for the
33873 host. It is not tried again, for any message, until its retry time arrives. If
33874 the current set of addresses are not all delivered in this run (to some
33875 alternative host), the message is added to the list of those waiting for this
33876 host, so if it is still undelivered when a subsequent successful delivery is
33877 made to the host, it will be sent down the same SMTP connection.
33878
33879 .vitem "&*Message errors*&"
33880 .cindex "message" "error"
33881 A message error is associated with a particular message when sent to a
33882 particular host, but not with a particular recipient of the message. The
33883 message errors are:
33884
33885 .ilist
33886 Any error response code to MAIL, DATA, or the &"."& that terminates
33887 the data,
33888 .next
33889 Timeout after MAIL,
33890 .next
33891 Timeout or loss of connection after the &"."& that terminates the data. A
33892 timeout after the DATA command itself is treated as a host error, as is loss of
33893 connection at any other time.
33894 .endlist ilist
33895
33896 For a message error, a permanent error response (5&'xx'&) causes all addresses
33897 to be failed, and a delivery error report to be returned to the sender. A
33898 temporary error response (4&'xx'&), or one of the timeouts, causes all
33899 addresses to be deferred. Retry data is not created for the host, but instead,
33900 a retry record for the combination of host plus message id is created. The
33901 message is not added to the list of those waiting for this host. This ensures
33902 that the failing message will not be sent to this host again until the retry
33903 time arrives. However, other messages that are routed to the host are not
33904 affected, so if it is some property of the message that is causing the error,
33905 it will not stop the delivery of other mail.
33906
33907 If the remote host specified support for the SIZE parameter in its response
33908 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33909 over-large message will cause a message error because the error arrives as a
33910 response to MAIL.
33911
33912 .vitem "&*Recipient errors*&"
33913 .cindex "recipient" "error"
33914 A recipient error is associated with a particular recipient of a message. The
33915 recipient errors are:
33916
33917 .ilist
33918 Any error response to RCPT,
33919 .next
33920 Timeout after RCPT.
33921 .endlist
33922
33923 For a recipient error, a permanent error response (5&'xx'&) causes the
33924 recipient address to be failed, and a bounce message to be returned to the
33925 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33926 address to be deferred, and routing retry data to be created for it. This is
33927 used to delay processing of the address in subsequent queue runs, until its
33928 routing retry time arrives. This applies to all messages, but because it
33929 operates only in queue runs, one attempt will be made to deliver a new message
33930 to the failing address before the delay starts to operate. This ensures that,
33931 if the failure is really related to the message rather than the recipient
33932 (&"message too big for this recipient"& is a possible example), other messages
33933 have a chance of getting delivered. If a delivery to the address does succeed,
33934 the retry information gets cleared, so all stuck messages get tried again, and
33935 the retry clock is reset.
33936
33937 The message is not added to the list of those waiting for this host. Use of the
33938 host for other messages is unaffected, and except in the case of a timeout,
33939 other recipients are processed independently, and may be successfully delivered
33940 in the current SMTP session. After a timeout it is of course impossible to
33941 proceed with the session, so all addresses get deferred. However, those other
33942 than the one that failed do not suffer any subsequent retry delays. Therefore,
33943 if one recipient is causing trouble, the others have a chance of getting
33944 through when a subsequent delivery attempt occurs before the failing
33945 recipient's retry time.
33946 .endlist
33947
33948 In all cases, if there are other hosts (or IP addresses) available for the
33949 current set of addresses (for example, from multiple MX records), they are
33950 tried in this run for any undelivered addresses, subject of course to their
33951 own retry data. In other words, recipient error retry data does not take effect
33952 until the next delivery attempt.
33953
33954 Some hosts have been observed to give temporary error responses to every
33955 MAIL command at certain times (&"insufficient space"& has been seen). It
33956 would be nice if such circumstances could be recognized, and defer data for the
33957 host itself created, but this is not possible within the current Exim design.
33958 What actually happens is that retry data for every (host, message) combination
33959 is created.
33960
33961 The reason that timeouts after MAIL and RCPT are treated specially is that
33962 these can sometimes arise as a result of the remote host's verification
33963 procedures. Exim makes this assumption, and treats them as if a temporary error
33964 response had been received. A timeout after &"."& is treated specially because
33965 it is known that some broken implementations fail to recognize the end of the
33966 message if the last character of the last line is a binary zero. Thus, it is
33967 helpful to treat this case as a message error.
33968
33969 Timeouts at other times are treated as host errors, assuming a problem with the
33970 host, or the connection to it. If a timeout after MAIL, RCPT,
33971 or &"."& is really a connection problem, the assumption is that at the next try
33972 the timeout is likely to occur at some other point in the dialogue, causing it
33973 then to be treated as a host error.
33974
33975 There is experimental evidence that some MTAs drop the connection after the
33976 terminating &"."& if they do not like the contents of the message for some
33977 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33978 should be given. That is why Exim treats this case as a message rather than a
33979 host error, in order not to delay other messages to the same host.
33980
33981
33982
33983
33984 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33985 .cindex "SMTP" "incoming over TCP/IP"
33986 .cindex "incoming SMTP over TCP/IP"
33987 .cindex "inetd"
33988 .cindex "daemon"
33989 Incoming SMTP messages can be accepted in one of two ways: by running a
33990 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33991 &_/etc/inetd.conf_& should be like this:
33992 .code
33993 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33994 .endd
33995 Exim distinguishes between this case and the case of a locally running user
33996 agent using the &%-bs%& option by checking whether or not the standard input is
33997 a socket. When it is, either the port must be privileged (less than 1024), or
33998 the caller must be root or the Exim user. If any other user passes a socket
33999 with an unprivileged port number, Exim prints a message on the standard error
34000 stream and exits with an error code.
34001
34002 By default, Exim does not make a log entry when a remote host connects or
34003 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34004 unexpected. It can be made to write such log entries by setting the
34005 &%smtp_connection%& log selector.
34006
34007 .cindex "carriage return"
34008 .cindex "linefeed"
34009 Commands from the remote host are supposed to be terminated by CR followed by
34010 LF. However, there are known to be hosts that do not send CR characters. In
34011 order to be able to interwork with such hosts, Exim treats LF on its own as a
34012 line terminator.
34013 Furthermore, because common code is used for receiving messages from all
34014 sources, a CR on its own is also interpreted as a line terminator. However, the
34015 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34016
34017 .cindex "EHLO" "invalid data"
34018 .cindex "HELO" "invalid data"
34019 One area that sometimes gives rise to problems concerns the EHLO or
34020 HELO commands. Some clients send syntactically invalid versions of these
34021 commands, which Exim rejects by default. (This is nothing to do with verifying
34022 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34023 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34024 match the broken hosts that send invalid commands.
34025
34026 .cindex "SIZE option on MAIL command"
34027 .cindex "MAIL" "SIZE option"
34028 The amount of disk space available is checked whenever SIZE is received on
34029 a MAIL command, independently of whether &%message_size_limit%& or
34030 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34031 false. A temporary error is given if there is not enough space. If
34032 &%check_spool_space%& is set, the check is for that amount of space plus the
34033 value given with SIZE, that is, it checks that the addition of the incoming
34034 message will not reduce the space below the threshold.
34035
34036 When a message is successfully received, Exim includes the local message id in
34037 its response to the final &"."& that terminates the data. If the remote host
34038 logs this text it can help with tracing what has happened to a message.
34039
34040 The Exim daemon can limit the number of simultaneous incoming connections it is
34041 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34042 number of simultaneous incoming connections from a single remote host (see the
34043 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34044 rejected using the SMTP temporary error code 421.
34045
34046 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34047 subprocess has finished, as this can get lost at busy times. Instead, it looks
34048 for completed subprocesses every time it wakes up. Provided there are other
34049 things happening (new incoming calls, starts of queue runs), completed
34050 processes will be noticed and tidied away. On very quiet systems you may
34051 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34052 it will be noticed when the daemon next wakes up.
34053
34054 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34055 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34056 high system load &-- for details see the &%smtp_accept_reserve%&,
34057 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34058 applies in both the daemon and &'inetd'& cases.
34059
34060 Exim normally starts a delivery process for each message received, though this
34061 can be varied by means of the &%-odq%& command line option and the
34062 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34063 number of simultaneously running delivery processes started in this way from
34064 SMTP input can be limited by the &%smtp_accept_queue%& and
34065 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34066 subsequently received messages are just put on the input queue without starting
34067 a delivery process.
34068
34069 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34070 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34071 started up from the &'inetd'& daemon, because in that case each connection is
34072 handled by an entirely independent Exim process. Control by load average is,
34073 however, available with &'inetd'&.
34074
34075 Exim can be configured to verify addresses in incoming SMTP commands as they
34076 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34077 to rewrite addresses at this time &-- before any syntax checking is done. See
34078 section &<<SECTrewriteS>>&.
34079
34080 Exim can also be configured to limit the rate at which a client host submits
34081 MAIL and RCPT commands in a single SMTP session. See the
34082 &%smtp_ratelimit_hosts%& option.
34083
34084
34085
34086 .section "Unrecognized SMTP commands" "SECID234"
34087 .cindex "SMTP" "unrecognized commands"
34088 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34089 commands during a single SMTP connection, it drops the connection after sending
34090 the error response to the last command. The default value for
34091 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34092 abuse that subvert web servers into making connections to SMTP ports; in these
34093 circumstances, a number of non-SMTP lines are sent first.
34094
34095
34096 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34097 .cindex "SMTP" "syntax errors"
34098 .cindex "SMTP" "protocol errors"
34099 A syntax error is detected if an SMTP command is recognized, but there is
34100 something syntactically wrong with its data, for example, a malformed email
34101 address in a RCPT command. Protocol errors include invalid command
34102 sequencing such as RCPT before MAIL. If Exim receives more than
34103 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34104 drops the connection after sending the error response to the last command. The
34105 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34106 broken clients that loop sending bad commands (yes, it has been seen).
34107
34108
34109
34110 .section "Use of non-mail SMTP commands" "SECID236"
34111 .cindex "SMTP" "non-mail commands"
34112 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34113 DATA. Exim counts such commands, and drops the connection if there are too
34114 many of them in a single SMTP session. This action catches some
34115 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34116 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34117 defines what &"too many"& means. Its default value is 10.
34118
34119 When a new message is expected, one occurrence of RSET is not counted. This
34120 allows a client to send one RSET between messages (this is not necessary,
34121 but some clients do it). Exim also allows one uncounted occurrence of HELO
34122 or EHLO, and one occurrence of STARTTLS between messages. After
34123 starting up a TLS session, another EHLO is expected, and so it too is not
34124 counted.
34125
34126 The first occurrence of AUTH in a connection, or immediately following
34127 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34128 RCPT, DATA, and QUIT are counted.
34129
34130 You can control which hosts are subject to the limit set by
34131 &%smtp_accept_max_nonmail%& by setting
34132 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34133 the limit apply to all hosts. This option means that you can exclude any
34134 specific badly-behaved hosts that you have to live with.
34135
34136
34137
34138
34139 .section "The VRFY and EXPN commands" "SECID237"
34140 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34141 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34142 appropriate) in order to decide whether the command should be accepted or not.
34143
34144 .cindex "VRFY" "processing"
34145 When no ACL is defined for VRFY, or if it rejects without
34146 setting an explicit response code, the command is accepted
34147 (with a 252 SMTP response code)
34148 in order to support awkward clients that do a VRFY before every RCPT.
34149 When VRFY is accepted, it runs exactly the same code as when Exim is
34150 called with the &%-bv%& option, and returns 250/451/550
34151 SMTP response codes.
34152
34153 .cindex "EXPN" "processing"
34154 If no ACL for EXPN is defined, the command is rejected.
34155 When EXPN is accepted, a single-level expansion of the address is done.
34156 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34157 than a verification (the &%-bv%& option). If an unqualified local part is given
34158 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34159 of VRFY and EXPN commands are logged on the main and reject logs, and
34160 VRFY verification failures are logged on the main log for consistency with
34161 RCPT failures.
34162
34163
34164
34165 .section "The ETRN command" "SECTETRN"
34166 .cindex "ETRN" "processing"
34167 RFC 1985 describes an SMTP command called ETRN that is designed to
34168 overcome the security problems of the TURN command (which has fallen into
34169 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34170 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34171 should be accepted or not. If no ACL is defined, the command is rejected.
34172
34173 The ETRN command is concerned with &"releasing"& messages that are awaiting
34174 delivery to certain hosts. As Exim does not organize its message queue by host,
34175 the only form of ETRN that is supported by default is the one where the
34176 text starts with the &"#"& prefix, in which case the remainder of the text is
34177 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34178 the &%-R%& option to happen, with the remainder of the ETRN text as its
34179 argument. For example,
34180 .code
34181 ETRN #brigadoon
34182 .endd
34183 runs the command
34184 .code
34185 exim -R brigadoon
34186 .endd
34187 which causes a delivery attempt on all messages with undelivered addresses
34188 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34189 default), Exim prevents the simultaneous execution of more than one queue run
34190 for the same argument string as a result of an ETRN command. This stops
34191 a misbehaving client from starting more than one queue runner at once.
34192
34193 .cindex "hints database" "ETRN serialization"
34194 Exim implements the serialization by means of a hints database in which a
34195 record is written whenever a process is started by ETRN, and deleted when
34196 the process completes. However, Exim does not keep the SMTP session waiting for
34197 the ETRN process to complete. Once ETRN is accepted, the client is sent
34198 a &"success"& return code. Obviously there is scope for hints records to get
34199 left lying around if there is a system or program crash. To guard against this,
34200 Exim ignores any records that are more than six hours old.
34201
34202 .oindex "&%smtp_etrn_command%&"
34203 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34204 used. This specifies a command that is run whenever ETRN is received,
34205 whatever the form of its argument. For
34206 example:
34207 .code
34208 smtp_etrn_command = /etc/etrn_command $domain \
34209                     $sender_host_address
34210 .endd
34211 .vindex "&$domain$&"
34212 The string is split up into arguments which are independently expanded. The
34213 expansion variable &$domain$& is set to the argument of the ETRN command,
34214 and no syntax checking is done on the contents of this argument. Exim does not
34215 wait for the command to complete, so its status code is not checked. Exim runs
34216 under its own uid and gid when receiving incoming SMTP, so it is not possible
34217 for it to change them before running the command.
34218
34219
34220
34221 .section "Incoming local SMTP" "SECID238"
34222 .cindex "SMTP" "local incoming"
34223 Some user agents use SMTP to pass messages to their local MTA using the
34224 standard input and output, as opposed to passing the envelope on the command
34225 line and writing the message to the standard input. This is supported by the
34226 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34227 messages over TCP/IP (including the use of ACLs), except that the envelope
34228 sender given in a MAIL command is ignored unless the caller is trusted. In
34229 an ACL you can detect this form of SMTP input by testing for an empty host
34230 identification. It is common to have this as the first line in the ACL that
34231 runs for RCPT commands:
34232 .code
34233 accept hosts = :
34234 .endd
34235 This accepts SMTP messages from local processes without doing any other tests.
34236
34237
34238
34239 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34240 .cindex "SMTP" "batched outgoing"
34241 .cindex "batched SMTP output"
34242 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34243 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34244 be output in BSMTP format. No SMTP responses are possible for this form of
34245 delivery. All it is doing is using SMTP commands as a way of transmitting the
34246 envelope along with the message.
34247
34248 The message is written to the file or pipe preceded by the SMTP commands
34249 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34250 the message that start with a dot have an extra dot added. The SMTP command
34251 HELO is not normally used. If it is required, the &%message_prefix%& option
34252 can be used to specify it.
34253
34254 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34255 one recipient address at a time by default. However, you can arrange for them
34256 to handle several addresses at once by setting the &%batch_max%& option. When
34257 this is done for BSMTP, messages may contain multiple RCPT commands. See
34258 chapter &<<CHAPbatching>>& for more details.
34259
34260 .vindex "&$host$&"
34261 When one or more addresses are routed to a BSMTP transport by a router that
34262 sets up a host list, the name of the first host on the list is available to the
34263 transport in the variable &$host$&. Here is an example of such a transport and
34264 router:
34265 .code
34266 begin routers
34267 route_append:
34268   driver = manualroute
34269   transport = smtp_appendfile
34270   route_list = domain.example  batch.host.example
34271
34272 begin transports
34273 smtp_appendfile:
34274   driver = appendfile
34275   directory = /var/bsmtp/$host
34276   batch_max = 1000
34277   use_bsmtp
34278   user = exim
34279 .endd
34280 This causes messages addressed to &'domain.example'& to be written in BSMTP
34281 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34282 message (unless there are more than 1000 recipients).
34283
34284
34285
34286 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34287 .cindex "SMTP" "batched incoming"
34288 .cindex "batched SMTP input"
34289 The &%-bS%& command line option causes Exim to accept one or more messages by
34290 reading SMTP on the standard input, but to generate no responses. If the caller
34291 is trusted, the senders in the MAIL commands are believed; otherwise the
34292 sender is always the caller of Exim. Unqualified senders and receivers are not
34293 rejected (there seems little point) but instead just get qualified. HELO
34294 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34295 as NOOP; QUIT quits.
34296
34297 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34298 ACL is run in the same way as for non-SMTP local input.
34299
34300 If an error is detected while reading a message, including a missing &"."& at
34301 the end, Exim gives up immediately. It writes details of the error to the
34302 standard output in a stylized way that the calling program should be able to
34303 make some use of automatically, for example:
34304 .code
34305 554 Unexpected end of file
34306 Transaction started in line 10
34307 Error detected in line 14
34308 .endd
34309 It writes a more verbose version, for human consumption, to the standard error
34310 file, for example:
34311 .code
34312 An error was detected while processing a file of BSMTP input.
34313 The error message was:
34314
34315 501 '>' missing at end of address
34316
34317 The SMTP transaction started in line 10.
34318 The error was detected in line 12.
34319 The SMTP command at fault was:
34320
34321 rcpt to:<malformed@in.com.plete
34322
34323 1 previous message was successfully processed.
34324 The rest of the batch was abandoned.
34325 .endd
34326 The return code from Exim is zero only if there were no errors. It is 1 if some
34327 messages were accepted before an error was detected, and 2 if no messages were
34328 accepted.
34329 .ecindex IIDsmtpproc1
34330 .ecindex IIDsmtpproc2
34331
34332
34333
34334 . ////////////////////////////////////////////////////////////////////////////
34335 . ////////////////////////////////////////////////////////////////////////////
34336
34337 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34338          "Customizing messages"
34339 When a message fails to be delivered, or remains on the queue for more than a
34340 configured amount of time, Exim sends a message to the original sender, or
34341 to an alternative configured address. The text of these messages is built into
34342 the code of Exim, but it is possible to change it, either by adding a single
34343 string, or by replacing each of the paragraphs by text supplied in a file.
34344
34345 The &'From:'& and &'To:'& header lines are automatically generated; you can
34346 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34347 option. Exim also adds the line
34348 .code
34349 Auto-Submitted: auto-generated
34350 .endd
34351 to all warning and bounce messages,
34352
34353
34354 .section "Customizing bounce messages" "SECID239"
34355 .cindex "customizing" "bounce message"
34356 .cindex "bounce message" "customizing"
34357 If &%bounce_message_text%& is set, its contents are included in the default
34358 message immediately after &"This message was created automatically by mail
34359 delivery software."& The string is not expanded. It is not used if
34360 &%bounce_message_file%& is set.
34361
34362 When &%bounce_message_file%& is set, it must point to a template file for
34363 constructing error messages. The file consists of a series of text items,
34364 separated by lines consisting of exactly four asterisks. If the file cannot be
34365 opened, default text is used and a message is written to the main and panic
34366 logs. If any text item in the file is empty, default text is used for that
34367 item.
34368
34369 .vindex "&$bounce_recipient$&"
34370 .vindex "&$bounce_return_size_limit$&"
34371 Each item of text that is read from the file is expanded, and there are two
34372 expansion variables which can be of use here: &$bounce_recipient$& is set to
34373 the recipient of an error message while it is being created, and
34374 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34375 option, rounded to a whole number.
34376
34377 The items must appear in the file in the following order:
34378
34379 .ilist
34380 The first item is included in the headers, and should include at least a
34381 &'Subject:'& header. Exim does not check the syntax of these headers.
34382 .next
34383 The second item forms the start of the error message. After it, Exim lists the
34384 failing addresses with their error messages.
34385 .next
34386 The third item is used to introduce any text from pipe transports that is to be
34387 returned to the sender. It is omitted if there is no such text.
34388 .next
34389 The fourth, fifth and sixth items will be ignored and may be empty.
34390 The fields exist for back-compatibility
34391 .endlist
34392
34393 The default state (&%bounce_message_file%& unset) is equivalent to the
34394 following file, in which the sixth item is empty. The &'Subject:'& and some
34395 other lines have been split in order to fit them on the page:
34396 .code
34397 Subject: Mail delivery failed
34398   ${if eq{$sender_address}{$bounce_recipient}
34399   {: returning message to sender}}
34400 ****
34401 This message was created automatically by mail delivery software.
34402
34403 A message ${if eq{$sender_address}{$bounce_recipient}
34404   {that you sent }{sent by
34405
34406 <$sender_address>
34407
34408 }}could not be delivered to all of its recipients.
34409 This is a permanent error. The following address(es) failed:
34410 ****
34411 The following text was generated during the delivery attempt(s):
34412 ****
34413 ------ This is a copy of the message, including all the headers.
34414   ------
34415 ****
34416 ------ The body of the message is $message_size characters long;
34417   only the first
34418 ------ $bounce_return_size_limit or so are included here.
34419 ****
34420 .endd
34421 .section "Customizing warning messages" "SECTcustwarn"
34422 .cindex "customizing" "warning message"
34423 .cindex "warning of delay" "customizing the message"
34424 The option &%warn_message_file%& can be pointed at a template file for use when
34425 warnings about message delays are created. In this case there are only three
34426 text sections:
34427
34428 .ilist
34429 The first item is included in the headers, and should include at least a
34430 &'Subject:'& header. Exim does not check the syntax of these headers.
34431 .next
34432 The second item forms the start of the warning message. After it, Exim lists
34433 the delayed addresses.
34434 .next
34435 The third item then ends the message.
34436 .endlist
34437
34438 The default state is equivalent to the following file, except that some lines
34439 have been split here, in order to fit them on the page:
34440 .code
34441 Subject: Warning: message $message_exim_id delayed
34442   $warn_message_delay
34443 ****
34444 This message was created automatically by mail delivery software.
34445
34446 A message ${if eq{$sender_address}{$warn_message_recipients}
34447 {that you sent }{sent by
34448
34449 <$sender_address>
34450
34451 }}has not been delivered to all of its recipients after
34452 more than $warn_message_delay on the queue on $primary_hostname.
34453
34454 The message identifier is:     $message_exim_id
34455 The subject of the message is: $h_subject
34456 The date of the message is:    $h_date
34457
34458 The following address(es) have not yet been delivered:
34459 ****
34460 No action is required on your part. Delivery attempts will
34461 continue for some time, and this warning may be repeated at
34462 intervals if the message remains undelivered. Eventually the
34463 mail delivery software will give up, and when that happens,
34464 the message will be returned to you.
34465 .endd
34466 .vindex "&$warn_message_delay$&"
34467 .vindex "&$warn_message_recipients$&"
34468 However, in the default state the subject and date lines are omitted if no
34469 appropriate headers exist. During the expansion of this file,
34470 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34471 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34472 of recipients for the warning message. There may be more than one if there are
34473 multiple addresses with different &%errors_to%& settings on the routers that
34474 handled them.
34475
34476
34477
34478
34479 . ////////////////////////////////////////////////////////////////////////////
34480 . ////////////////////////////////////////////////////////////////////////////
34481
34482 .chapter "Some common configuration settings" "CHAPcomconreq"
34483 This chapter discusses some configuration settings that seem to be fairly
34484 common. More examples and discussion can be found in the Exim book.
34485
34486
34487
34488 .section "Sending mail to a smart host" "SECID240"
34489 .cindex "smart host" "example router"
34490 If you want to send all mail for non-local domains to a &"smart host"&, you
34491 should replace the default &(dnslookup)& router with a router which does the
34492 routing explicitly:
34493 .code
34494 send_to_smart_host:
34495   driver = manualroute
34496   route_list = !+local_domains smart.host.name
34497   transport = remote_smtp
34498 .endd
34499 You can use the smart host's IP address instead of the name if you wish.
34500 If you are using Exim only to submit messages to a smart host, and not for
34501 receiving incoming messages, you can arrange for it to do the submission
34502 synchronously by setting the &%mua_wrapper%& option (see chapter
34503 &<<CHAPnonqueueing>>&).
34504
34505
34506
34507
34508 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34509 .cindex "mailing lists"
34510 Exim can be used to run simple mailing lists, but for large and/or complicated
34511 requirements, the use of additional specialized mailing list software such as
34512 Majordomo or Mailman is recommended.
34513
34514 The &(redirect)& router can be used to handle mailing lists where each list
34515 is maintained in a separate file, which can therefore be managed by an
34516 independent manager. The &%domains%& router option can be used to run these
34517 lists in a separate domain from normal mail. For example:
34518 .code
34519 lists:
34520   driver = redirect
34521   domains = lists.example
34522   file = /usr/lists/$local_part
34523   forbid_pipe
34524   forbid_file
34525   errors_to = $local_part-request@lists.example
34526   no_more
34527 .endd
34528 This router is skipped for domains other than &'lists.example'&. For addresses
34529 in that domain, it looks for a file that matches the local part. If there is no
34530 such file, the router declines, but because &%no_more%& is set, no subsequent
34531 routers are tried, and so the whole delivery fails.
34532
34533 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34534 expanded into a file name or a pipe delivery, which is usually inappropriate in
34535 a mailing list.
34536
34537 .oindex "&%errors_to%&"
34538 The &%errors_to%& option specifies that any delivery errors caused by addresses
34539 taken from a mailing list are to be sent to the given address rather than the
34540 original sender of the message. However, before acting on this, Exim verifies
34541 the error address, and ignores it if verification fails.
34542
34543 For example, using the configuration above, mail sent to
34544 &'dicts@lists.example'& is passed on to those addresses contained in
34545 &_/usr/lists/dicts_&, with error reports directed to
34546 &'dicts-request@lists.example'&, provided that this address can be verified.
34547 There could be a file called &_/usr/lists/dicts-request_& containing
34548 the address(es) of this particular list's manager(s), but other approaches,
34549 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34550 or &%local_part_suffix%& options) to handle addresses of the form
34551 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34552
34553
34554
34555 .section "Syntax errors in mailing lists" "SECID241"
34556 .cindex "mailing lists" "syntax errors in"
34557 If an entry in redirection data contains a syntax error, Exim normally defers
34558 delivery of the original address. That means that a syntax error in a mailing
34559 list holds up all deliveries to the list. This may not be appropriate when a
34560 list is being maintained automatically from data supplied by users, and the
34561 addresses are not rigorously checked.
34562
34563 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34564 entries that fail to parse, noting the incident in the log. If in addition
34565 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34566 whenever a broken address is skipped. It is usually appropriate to set
34567 &%syntax_errors_to%& to the same address as &%errors_to%&.
34568
34569
34570
34571 .section "Re-expansion of mailing lists" "SECID242"
34572 .cindex "mailing lists" "re-expansion of"
34573 Exim remembers every individual address to which a message has been delivered,
34574 in order to avoid duplication, but it normally stores only the original
34575 recipient addresses with a message. If all the deliveries to a mailing list
34576 cannot be done at the first attempt, the mailing list is re-expanded when the
34577 delivery is next tried. This means that alterations to the list are taken into
34578 account at each delivery attempt, so addresses that have been added to
34579 the list since the message arrived will therefore receive a copy of the
34580 message, even though it pre-dates their subscription.
34581
34582 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34583 on the &(redirect)& router. If this is done, any addresses generated by the
34584 router that fail to deliver at the first attempt are added to the message as
34585 &"top level"& addresses, and the parent address that generated them is marked
34586 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34587 subsequent delivery attempts. The disadvantage of this is that if any of the
34588 failing addresses are incorrect, correcting them in the file has no effect on
34589 pre-existing messages.
34590
34591 The original top-level address is remembered with each of the generated
34592 addresses, and is output in any log messages. However, any intermediate parent
34593 addresses are not recorded. This makes a difference to the log only if the
34594 &%all_parents%& selector is set, but for mailing lists there is normally only
34595 one level of expansion anyway.
34596
34597
34598
34599 .section "Closed mailing lists" "SECID243"
34600 .cindex "mailing lists" "closed"
34601 The examples so far have assumed open mailing lists, to which anybody may
34602 send mail. It is also possible to set up closed lists, where mail is accepted
34603 from specified senders only. This is done by making use of the generic
34604 &%senders%& option to restrict the router that handles the list.
34605
34606 The following example uses the same file as a list of recipients and as a list
34607 of permitted senders. It requires three routers:
34608 .code
34609 lists_request:
34610   driver = redirect
34611   domains = lists.example
34612   local_part_suffix = -request
34613   file = /usr/lists/$local_part$local_part_suffix
34614   no_more
34615
34616 lists_post:
34617   driver = redirect
34618   domains = lists.example
34619   senders = ${if exists {/usr/lists/$local_part}\
34620              {lsearch;/usr/lists/$local_part}{*}}
34621   file = /usr/lists/$local_part
34622   forbid_pipe
34623   forbid_file
34624   errors_to = $local_part-request@lists.example
34625   no_more
34626
34627 lists_closed:
34628   driver = redirect
34629   domains = lists.example
34630   allow_fail
34631   data = :fail: $local_part@lists.example is a closed mailing list
34632 .endd
34633 All three routers have the same &%domains%& setting, so for any other domains,
34634 they are all skipped. The first router runs only if the local part ends in
34635 &%-request%&. It handles messages to the list manager(s) by means of an open
34636 mailing list.
34637
34638 The second router runs only if the &%senders%& precondition is satisfied. It
34639 checks for the existence of a list that corresponds to the local part, and then
34640 checks that the sender is on the list by means of a linear search. It is
34641 necessary to check for the existence of the file before trying to search it,
34642 because otherwise Exim thinks there is a configuration error. If the file does
34643 not exist, the expansion of &%senders%& is *, which matches all senders. This
34644 means that the router runs, but because there is no list, declines, and
34645 &%no_more%& ensures that no further routers are run. The address fails with an
34646 &"unrouteable address"& error.
34647
34648 The third router runs only if the second router is skipped, which happens when
34649 a mailing list exists, but the sender is not on it. This router forcibly fails
34650 the address, giving a suitable error message.
34651
34652
34653
34654
34655 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34656 .cindex "VERP"
34657 .cindex "Variable Envelope Return Paths"
34658 .cindex "envelope sender"
34659 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34660 are a way of helping mailing list administrators discover which subscription
34661 address is the cause of a particular delivery failure. The idea is to encode
34662 the original recipient address in the outgoing envelope sender address, so that
34663 if the message is forwarded by another host and then subsequently bounces, the
34664 original recipient can be extracted from the recipient address of the bounce.
34665
34666 .oindex &%errors_to%&
34667 .oindex &%return_path%&
34668 Envelope sender addresses can be modified by Exim using two different
34669 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34670 list examples), or the &%return_path%& option on a transport. The second of
34671 these is effective only if the message is successfully delivered to another
34672 host; it is not used for errors detected on the local host (see the description
34673 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34674 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34675 .code
34676 verp_smtp:
34677   driver = smtp
34678   max_rcpt = 1
34679   return_path = \
34680     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34681       {$1-request+$local_part=$domain@your.dom.example}fail}
34682 .endd
34683 This has the effect of rewriting the return path (envelope sender) on outgoing
34684 SMTP messages, if the local part of the original return path ends in
34685 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34686 local part and domain of the recipient into the return path. Suppose, for
34687 example, that a message whose return path has been set to
34688 &'somelist-request@your.dom.example'& is sent to
34689 &'subscriber@other.dom.example'&. In the transport, the return path is
34690 rewritten as
34691 .code
34692 somelist-request+subscriber=other.dom.example@your.dom.example
34693 .endd
34694 .vindex "&$local_part$&"
34695 For this to work, you must tell Exim to send multiple copies of messages that
34696 have more than one recipient, so that each copy has just one recipient. This is
34697 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34698 might be sent to several different recipients in the same domain, in which case
34699 &$local_part$& is not available in the transport, because it is not unique.
34700
34701 Unless your host is doing nothing but mailing list deliveries, you should
34702 probably use a separate transport for the VERP deliveries, so as not to use
34703 extra resources in making one-per-recipient copies for other deliveries. This
34704 can easily be done by expanding the &%transport%& option in the router:
34705 .code
34706 dnslookup:
34707   driver = dnslookup
34708   domains = ! +local_domains
34709   transport = \
34710     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34711       {verp_smtp}{remote_smtp}}
34712   no_more
34713 .endd
34714 If you want to change the return path using &%errors_to%& in a router instead
34715 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34716 routers that handle mailing list addresses. This will ensure that all delivery
34717 errors, including those detected on the local host, are sent to the VERP
34718 address.
34719
34720 On a host that does no local deliveries and has no manual routing, only the
34721 &(dnslookup)& router needs to be changed. A special transport is not needed for
34722 SMTP deliveries. Every mailing list recipient has its own return path value,
34723 and so Exim must hand them to the transport one at a time. Here is an example
34724 of a &(dnslookup)& router that implements VERP:
34725 .code
34726 verp_dnslookup:
34727   driver = dnslookup
34728   domains = ! +local_domains
34729   transport = remote_smtp
34730   errors_to = \
34731     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34732      {$1-request+$local_part=$domain@your.dom.example}fail}
34733   no_more
34734 .endd
34735 Before you start sending out messages with VERPed return paths, you must also
34736 configure Exim to accept the bounce messages that come back to those paths.
34737 Typically this is done by setting a &%local_part_suffix%& option for a
34738 router, and using this to route the messages to wherever you want to handle
34739 them.
34740
34741 The overhead incurred in using VERP depends very much on the size of the
34742 message, the number of recipient addresses that resolve to the same remote
34743 host, and the speed of the connection over which the message is being sent. If
34744 a lot of addresses resolve to the same host and the connection is slow, sending
34745 a separate copy of the message for each address may take substantially longer
34746 than sending a single copy with many recipients (for which VERP cannot be
34747 used).
34748
34749
34750
34751
34752
34753
34754 .section "Virtual domains" "SECTvirtualdomains"
34755 .cindex "virtual domains"
34756 .cindex "domain" "virtual"
34757 The phrase &'virtual domain'& is unfortunately used with two rather different
34758 meanings:
34759
34760 .ilist
34761 A domain for which there are no real mailboxes; all valid local parts are
34762 aliases for other email addresses. Common examples are organizational
34763 top-level domains and &"vanity"& domains.
34764 .next
34765 One of a number of independent domains that are all handled by the same host,
34766 with mailboxes on that host, but where the mailbox owners do not necessarily
34767 have login accounts on that host.
34768 .endlist
34769
34770 The first usage is probably more common, and does seem more &"virtual"& than
34771 the second. This kind of domain can be handled in Exim with a straightforward
34772 aliasing router. One approach is to create a separate alias file for each
34773 virtual domain. Exim can test for the existence of the alias file to determine
34774 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34775 to a router of this form:
34776 .code
34777 virtual:
34778   driver = redirect
34779   domains = dsearch;/etc/mail/virtual
34780   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34781   no_more
34782 .endd
34783 The &%domains%& option specifies that the router is to be skipped, unless there
34784 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34785 domain that is being processed. When the router runs, it looks up the local
34786 part in the file to find a new address (or list of addresses). The &%no_more%&
34787 setting ensures that if the lookup fails (leading to &%data%& being an empty
34788 string), Exim gives up on the address without trying any subsequent routers.
34789
34790 This one router can handle all the virtual domains because the alias file names
34791 follow a fixed pattern. Permissions can be arranged so that appropriate people
34792 can edit the different alias files. A successful aliasing operation results in
34793 a new envelope recipient address, which is then routed from scratch.
34794
34795 The other kind of &"virtual"& domain can also be handled in a straightforward
34796 way. One approach is to create a file for each domain containing a list of
34797 valid local parts, and use it in a router like this:
34798 .code
34799 my_domains:
34800   driver = accept
34801   domains = dsearch;/etc/mail/domains
34802   local_parts = lsearch;/etc/mail/domains/$domain
34803   transport = my_mailboxes
34804 .endd
34805 The address is accepted if there is a file for the domain, and the local part
34806 can be found in the file. The &%domains%& option is used to check for the
34807 file's existence because &%domains%& is tested before the &%local_parts%&
34808 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34809 because that option is tested after &%local_parts%&. The transport is as
34810 follows:
34811 .code
34812 my_mailboxes:
34813   driver = appendfile
34814   file = /var/mail/$domain/$local_part
34815   user = mail
34816 .endd
34817 This uses a directory of mailboxes for each domain. The &%user%& setting is
34818 required, to specify which uid is to be used for writing to the mailboxes.
34819
34820 The configuration shown here is just one example of how you might support this
34821 requirement. There are many other ways this kind of configuration can be set
34822 up, for example, by using a database instead of separate files to hold all the
34823 information about the domains.
34824
34825
34826
34827 .section "Multiple user mailboxes" "SECTmulbox"
34828 .cindex "multiple mailboxes"
34829 .cindex "mailbox" "multiple"
34830 .cindex "local part" "prefix"
34831 .cindex "local part" "suffix"
34832 Heavy email users often want to operate with multiple mailboxes, into which
34833 incoming mail is automatically sorted. A popular way of handling this is to
34834 allow users to use multiple sender addresses, so that replies can easily be
34835 identified. Users are permitted to add prefixes or suffixes to their local
34836 parts for this purpose. The wildcard facility of the generic router options
34837 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34838 example, consider this router:
34839 .code
34840 userforward:
34841   driver = redirect
34842   check_local_user
34843   file = $home/.forward
34844   local_part_suffix = -*
34845   local_part_suffix_optional
34846   allow_filter
34847 .endd
34848 .vindex "&$local_part_suffix$&"
34849 It runs a user's &_.forward_& file for all local parts of the form
34850 &'username-*'&. Within the filter file the user can distinguish different
34851 cases by testing the variable &$local_part_suffix$&. For example:
34852 .code
34853 if $local_part_suffix contains -special then
34854 save /home/$local_part/Mail/special
34855 endif
34856 .endd
34857 If the filter file does not exist, or does not deal with such addresses, they
34858 fall through to subsequent routers, and, assuming no subsequent use of the
34859 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34860 control over which suffixes are valid.
34861
34862 Alternatively, a suffix can be used to trigger the use of a different
34863 &_.forward_& file &-- which is the way a similar facility is implemented in
34864 another MTA:
34865 .code
34866 userforward:
34867   driver = redirect
34868   check_local_user
34869   file = $home/.forward$local_part_suffix
34870   local_part_suffix = -*
34871   local_part_suffix_optional
34872   allow_filter
34873 .endd
34874 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34875 example, &_.forward-special_& is used. Once again, if the appropriate file
34876 does not exist, or does not deal with the address, it is passed on to
34877 subsequent routers, which could, if required, look for an unqualified
34878 &_.forward_& file to use as a default.
34879
34880
34881
34882 .section "Simplified vacation processing" "SECID244"
34883 .cindex "vacation processing"
34884 The traditional way of running the &'vacation'& program is for a user to set up
34885 a pipe command in a &_.forward_& file
34886 (see section &<<SECTspecitredli>>& for syntax details).
34887 This is prone to error by inexperienced users. There are two features of Exim
34888 that can be used to make this process simpler for users:
34889
34890 .ilist
34891 A local part prefix such as &"vacation-"& can be specified on a router which
34892 can cause the message to be delivered directly to the &'vacation'& program, or
34893 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34894 &_.forward_& file are then much simpler. For example:
34895 .code
34896 spqr, vacation-spqr
34897 .endd
34898 .next
34899 The &%require_files%& generic router option can be used to trigger a
34900 vacation delivery by checking for the existence of a certain file in the
34901 user's home directory. The &%unseen%& generic option should also be used, to
34902 ensure that the original delivery also proceeds. In this case, all the user has
34903 to do is to create a file called, say, &_.vacation_&, containing a vacation
34904 message.
34905 .endlist
34906
34907 Another advantage of both these methods is that they both work even when the
34908 use of arbitrary pipes by users is locked out.
34909
34910
34911
34912 .section "Taking copies of mail" "SECID245"
34913 .cindex "message" "copying every"
34914 Some installations have policies that require archive copies of all messages to
34915 be made. A single copy of each message can easily be taken by an appropriate
34916 command in a system filter, which could, for example, use a different file for
34917 each day's messages.
34918
34919 There is also a shadow transport mechanism that can be used to take copies of
34920 messages that are successfully delivered by local transports, one copy per
34921 delivery. This could be used, &'inter alia'&, to implement automatic
34922 notification of delivery by sites that insist on doing such things.
34923
34924
34925
34926 .section "Intermittently connected hosts" "SECID246"
34927 .cindex "intermittently connected hosts"
34928 It has become quite common (because it is cheaper) for hosts to connect to the
34929 Internet periodically rather than remain connected all the time. The normal
34930 arrangement is that mail for such hosts accumulates on a system that is
34931 permanently connected.
34932
34933 Exim was designed for use on permanently connected hosts, and so it is not
34934 particularly well-suited to use in an intermittently connected environment.
34935 Nevertheless there are some features that can be used.
34936
34937
34938 .section "Exim on the upstream server host" "SECID247"
34939 It is tempting to arrange for incoming mail for the intermittently connected
34940 host to remain on Exim's queue until the client connects. However, this
34941 approach does not scale very well. Two different kinds of waiting message are
34942 being mixed up in the same queue &-- those that cannot be delivered because of
34943 some temporary problem, and those that are waiting for their destination host
34944 to connect. This makes it hard to manage the queue, as well as wasting
34945 resources, because each queue runner scans the entire queue.
34946
34947 A better approach is to separate off those messages that are waiting for an
34948 intermittently connected host. This can be done by delivering these messages
34949 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34950 format, from where they are transmitted by other software when their
34951 destination connects. This makes it easy to collect all the mail for one host
34952 in a single directory, and to apply local timeout rules on a per-message basis
34953 if required.
34954
34955 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34956 you are doing this, you should configure Exim with a long retry period for the
34957 intermittent host. For example:
34958 .code
34959 cheshire.wonderland.fict.example    *   F,5d,24h
34960 .endd
34961 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34962 which messages it has queued up for that host. Once the intermittent host comes
34963 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34964 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34965 causes all the queued up messages to be delivered, often down a single SMTP
34966 connection. While the host remains connected, any new messages get delivered
34967 immediately.
34968
34969 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34970 issued with a different IP address each time it connects, Exim's retry
34971 mechanisms on the holding host get confused, because the IP address is normally
34972 used as part of the key string for holding retry information. This can be
34973 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34974 Since this has disadvantages for permanently connected hosts, it is best to
34975 arrange a separate transport for the intermittently connected ones.
34976
34977
34978
34979 .section "Exim on the intermittently connected client host" "SECID248"
34980 The value of &%smtp_accept_queue_per_connection%& should probably be
34981 increased, or even set to zero (that is, disabled) on the intermittently
34982 connected host, so that all incoming messages down a single connection get
34983 delivered immediately.
34984
34985 .cindex "SMTP" "passed connection"
34986 .cindex "SMTP" "multiple deliveries"
34987 .cindex "multiple SMTP deliveries"
34988 Mail waiting to be sent from an intermittently connected host will probably
34989 not have been routed, because without a connection DNS lookups are not
34990 possible. This means that if a normal queue run is done at connection time,
34991 each message is likely to be sent in a separate SMTP session. This can be
34992 avoided by starting the queue run with a command line option beginning with
34993 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34994 first pass, routing is done but no deliveries take place. The second pass is a
34995 normal queue run; since all the messages have been previously routed, those
34996 destined for the same host are likely to get sent as multiple deliveries in a
34997 single SMTP connection.
34998
34999
35000
35001 . ////////////////////////////////////////////////////////////////////////////
35002 . ////////////////////////////////////////////////////////////////////////////
35003
35004 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35005          "Exim as a non-queueing client"
35006 .cindex "client, non-queueing"
35007 .cindex "smart host" "suppressing queueing"
35008 On a personal computer, it is a common requirement for all
35009 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35010 configured to operate that way, for all the popular operating systems.
35011 However, there are some MUAs for Unix-like systems that cannot be so
35012 configured: they submit messages using the command line interface of
35013 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35014 messages this way.
35015
35016 If the personal computer runs continuously, there is no problem, because it can
35017 run a conventional MTA that handles delivery to the smart host, and deal with
35018 any delays via its queueing mechanism. However, if the computer does not run
35019 continuously or runs different operating systems at different times, queueing
35020 email is not desirable.
35021
35022 There is therefore a requirement for something that can provide the
35023 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35024 any queueing or retrying facilities. Furthermore, the delivery to the smart
35025 host should be synchronous, so that if it fails, the sending MUA is immediately
35026 informed. In other words, we want something that extends an MUA that submits
35027 to a local MTA via the command line so that it behaves like one that submits
35028 to a remote smart host using TCP/SMTP.
35029
35030 There are a number of applications (for example, there is one called &'ssmtp'&)
35031 that do this job. However, people have found them to be lacking in various
35032 ways. For instance, you might want to allow aliasing and forwarding to be done
35033 before sending a message to the smart host.
35034
35035 Exim already had the necessary infrastructure for doing this job. Just a few
35036 tweaks were needed to make it behave as required, though it is somewhat of an
35037 overkill to use a fully-featured MTA for this purpose.
35038
35039 .oindex "&%mua_wrapper%&"
35040 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35041 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35042 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35043 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35044 compatible router and transport configuration. Typically there will be just one
35045 router and one transport, sending everything to a smart host.
35046
35047 When run in MUA wrapping mode, the behaviour of Exim changes in the
35048 following ways:
35049
35050 .ilist
35051 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35052 In other words, the only way to submit messages is via the command line.
35053 .next
35054 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35055 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35056 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35057 does not finish until the delivery attempt is complete. If the delivery is
35058 successful, a zero return code is given.
35059 .next
35060 Address redirection is permitted, but the final routing for all addresses must
35061 be to the same remote transport, and to the same list of hosts. Furthermore,
35062 the return address (envelope sender) must be the same for all recipients, as
35063 must any added or deleted header lines. In other words, it must be possible to
35064 deliver the message in a single SMTP transaction, however many recipients there
35065 are.
35066 .next
35067 If these conditions are not met, or if routing any address results in a
35068 failure or defer status, or if Exim is unable to deliver all the recipients
35069 successfully to one of the smart hosts, delivery of the entire message fails.
35070 .next
35071 Because no queueing is allowed, all failures are treated as permanent; there
35072 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35073 smart host. Furthermore, because only a single yes/no response can be given to
35074 the caller, it is not possible to deliver to some recipients and not others. If
35075 there is an error (temporary or permanent) for any recipient, all are failed.
35076 .next
35077 If more than one smart host is listed, Exim will try another host after a
35078 connection failure or a timeout, in the normal way. However, if this kind of
35079 failure happens for all the hosts, the delivery fails.
35080 .next
35081 When delivery fails, an error message is written to the standard error stream
35082 (as well as to Exim's log), and Exim exits to the caller with a return code
35083 value 1. The message is expunged from Exim's spool files. No bounce messages
35084 are ever generated.
35085 .next
35086 No retry data is maintained, and any retry rules are ignored.
35087 .next
35088 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35089 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35090 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35091 .endlist
35092
35093 The overall effect is that Exim makes a single synchronous attempt to deliver
35094 the message, failing if there is any kind of problem. Because no local
35095 deliveries are done and no daemon can be run, Exim does not need root
35096 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35097 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35098 the advantages and disadvantages of running without root privilege.
35099
35100
35101
35102
35103 . ////////////////////////////////////////////////////////////////////////////
35104 . ////////////////////////////////////////////////////////////////////////////
35105
35106 .chapter "Log files" "CHAPlog"
35107 .scindex IIDloggen "log" "general description"
35108 .cindex "log" "types of"
35109 Exim writes three different logs, referred to as the main log, the reject log,
35110 and the panic log:
35111
35112 .ilist
35113 .cindex "main log"
35114 The main log records the arrival of each message and each delivery in a single
35115 line in each case. The format is as compact as possible, in an attempt to keep
35116 down the size of log files. Two-character flag sequences make it easy to pick
35117 out these lines. A number of other events are recorded in the main log. Some of
35118 them are optional, in which case the &%log_selector%& option controls whether
35119 they are included or not. A Perl script called &'eximstats'&, which does simple
35120 analysis of main log files, is provided in the Exim distribution (see section
35121 &<<SECTmailstat>>&).
35122 .next
35123 .cindex "reject log"
35124 The reject log records information from messages that are rejected as a result
35125 of a configuration option (that is, for policy reasons).
35126 The first line of each rejection is a copy of the line that is also written to
35127 the main log. Then, if the message's header has been read at the time the log
35128 is written, its contents are written to this log. Only the original header
35129 lines are available; header lines added by ACLs are not logged. You can use the
35130 reject log to check that your policy controls are working correctly; on a busy
35131 host this may be easier than scanning the main log for rejection messages. You
35132 can suppress the writing of the reject log by setting &%write_rejectlog%&
35133 false.
35134 .next
35135 .cindex "panic log"
35136 .cindex "system log"
35137 When certain serious errors occur, Exim writes entries to its panic log. If the
35138 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35139 are usually written to the main log as well, but can get lost amid the mass of
35140 other entries. The panic log should be empty under normal circumstances. It is
35141 therefore a good idea to check it (or to have a &'cron'& script check it)
35142 regularly, in order to become aware of any problems. When Exim cannot open its
35143 panic log, it tries as a last resort to write to the system log (syslog). This
35144 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35145 message itself is written at priority LOG_CRIT.
35146 .endlist
35147
35148 Every log line starts with a timestamp, in the format shown in the following
35149 example. Note that many of the examples shown in this chapter are line-wrapped.
35150 In the log file, this would be all on one line:
35151 .code
35152 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35153   by QUIT
35154 .endd
35155 By default, the timestamps are in the local timezone. There are two
35156 ways of changing this:
35157
35158 .ilist
35159 You can set the &%timezone%& option to a different time zone; in particular, if
35160 you set
35161 .code
35162 timezone = UTC
35163 .endd
35164 the timestamps will be in UTC (aka GMT).
35165 .next
35166 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35167 example:
35168 .code
35169 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35170 .endd
35171 .endlist
35172
35173 .cindex "log" "process ids in"
35174 .cindex "pid (process id)" "in log lines"
35175 Exim does not include its process id in log lines by default, but you can
35176 request that it does so by specifying the &`pid`& log selector (see section
35177 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35178 brackets, immediately after the time and date.
35179
35180
35181
35182
35183 .section "Where the logs are written" "SECTwhelogwri"
35184 .cindex "log" "destination"
35185 .cindex "log" "to file"
35186 .cindex "log" "to syslog"
35187 .cindex "syslog"
35188 The logs may be written to local files, or to syslog, or both. However, it
35189 should be noted that many syslog implementations use UDP as a transport, and
35190 are therefore unreliable in the sense that messages are not guaranteed to
35191 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35192 It has also been reported that on large log files (tens of megabytes) you may
35193 need to tweak syslog to prevent it syncing the file with each write &-- on
35194 Linux this has been seen to make syslog take 90% plus of CPU time.
35195
35196 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35197 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35198 configuration. This latter string is expanded, so it can contain, for example,
35199 references to the host name:
35200 .code
35201 log_file_path = /var/log/$primary_hostname/exim_%slog
35202 .endd
35203 It is generally advisable, however, to set the string in &_Local/Makefile_&
35204 rather than at run time, because then the setting is available right from the
35205 start of Exim's execution. Otherwise, if there's something it wants to log
35206 before it has read the configuration file (for example, an error in the
35207 configuration file) it will not use the path you want, and may not be able to
35208 log at all.
35209
35210 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35211 list, currently limited to at most two items. This is one option where the
35212 facility for changing a list separator may not be used. The list must always be
35213 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35214 otherwise the item must either be an absolute path, containing &`%s`& at the
35215 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35216 implying the use of a default path.
35217
35218 When Exim encounters an empty item in the list, it searches the list defined by
35219 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35220 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35221 mean &"use the path specified at build time"&. It no such item exists, log
35222 files are written in the &_log_& subdirectory of the spool directory. This is
35223 equivalent to the setting:
35224 .code
35225 log_file_path = $spool_directory/log/%slog
35226 .endd
35227 If you do not specify anything at build time or run time,
35228 or if you unset the option at run time (i.e. &`log_file_path = `&),
35229 that is where the logs are written.
35230
35231 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35232 are in use &-- see section &<<SECTdatlogfil>>& below.
35233
35234 Here are some examples of possible settings:
35235 .display
35236 &`LOG_FILE_PATH=syslog                    `& syslog only
35237 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35238 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35239 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35240 .endd
35241 If there are more than two paths in the list, the first is used and a panic
35242 error is logged.
35243
35244
35245
35246 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35247 .cindex "log" "cycling local files"
35248 .cindex "cycling logs"
35249 .cindex "&'exicyclog'&"
35250 .cindex "log" "local files; writing to"
35251 Some operating systems provide centralized and standardized methods for cycling
35252 log files. For those that do not, a utility script called &'exicyclog'& is
35253 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35254 main and reject logs each time it is called. The maximum number of old logs to
35255 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35256
35257 An Exim delivery process opens the main log when it first needs to write to it,
35258 and it keeps the file open in case subsequent entries are required &-- for
35259 example, if a number of different deliveries are being done for the same
35260 message. However, remote SMTP deliveries can take a long time, and this means
35261 that the file may be kept open long after it is renamed if &'exicyclog'& or
35262 something similar is being used to rename log files on a regular basis. To
35263 ensure that a switch of log files is noticed as soon as possible, Exim calls
35264 &[stat()]& on the main log's name before reusing an open file, and if the file
35265 does not exist, or its inode has changed, the old file is closed and Exim
35266 tries to open the main log from scratch. Thus, an old log file may remain open
35267 for quite some time, but no Exim processes should write to it once it has been
35268 renamed.
35269
35270
35271
35272 .section "Datestamped log files" "SECTdatlogfil"
35273 .cindex "log" "datestamped files"
35274 Instead of cycling the main and reject log files by renaming them
35275 periodically, some sites like to use files whose names contain a datestamp,
35276 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35277 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35278 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35279 point where the datestamp is required. For example:
35280 .code
35281 log_file_path = /var/spool/exim/log/%slog-%D
35282 log_file_path = /var/log/exim-%s-%D.log
35283 log_file_path = /var/spool/exim/log/%D-%slog
35284 log_file_path = /var/log/exim/%s.%M
35285 .endd
35286 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35287 examples of names generated by the above examples:
35288 .code
35289 /var/spool/exim/log/mainlog-20021225
35290 /var/log/exim-reject-20021225.log
35291 /var/spool/exim/log/20021225-mainlog
35292 /var/log/exim/main.200212
35293 .endd
35294 When this form of log file is specified, Exim automatically switches to new
35295 files at midnight. It does not make any attempt to compress old logs; you
35296 will need to write your own script if you require this. You should not
35297 run &'exicyclog'& with this form of logging.
35298
35299 The location of the panic log is also determined by &%log_file_path%&, but it
35300 is not datestamped, because rotation of the panic log does not make sense.
35301 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35302 the string. In addition, if it immediately follows a slash, a following
35303 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35304 character is removed. Thus, the four examples above would give these panic
35305 log names:
35306 .code
35307 /var/spool/exim/log/paniclog
35308 /var/log/exim-panic.log
35309 /var/spool/exim/log/paniclog
35310 /var/log/exim/panic
35311 .endd
35312
35313
35314 .section "Logging to syslog" "SECID249"
35315 .cindex "log" "syslog; writing to"
35316 The use of syslog does not change what Exim logs or the format of its messages,
35317 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35318 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35319 that, the same strings are written to syslog as to log files. The syslog
35320 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35321 by default, but you can change these by setting the &%syslog_facility%& and
35322 &%syslog_processname%& options, respectively. If Exim was compiled with
35323 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35324 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35325 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35326 the time and host name to each line.
35327 The three log streams are mapped onto syslog priorities as follows:
35328
35329 .ilist
35330 &'mainlog'& is mapped to LOG_INFO
35331 .next
35332 &'rejectlog'& is mapped to LOG_NOTICE
35333 .next
35334 &'paniclog'& is mapped to LOG_ALERT
35335 .endlist
35336
35337 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35338 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35339 these are routed by syslog to the same place. You can suppress this duplication
35340 by setting &%syslog_duplication%& false.
35341
35342 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35343 entries contain multiple lines when headers are included. To cope with both
35344 these cases, entries written to syslog are split into separate &[syslog()]&
35345 calls at each internal newline, and also after a maximum of
35346 870 data characters. (This allows for a total syslog line length of 1024, when
35347 additions such as timestamps are added.) If you are running a syslog
35348 replacement that can handle lines longer than the 1024 characters allowed by
35349 RFC 3164, you should set
35350 .code
35351 SYSLOG_LONG_LINES=yes
35352 .endd
35353 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35354 lines, but it still splits at internal newlines in &'reject'& log entries.
35355
35356 To make it easy to re-assemble split lines later, each component of a split
35357 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35358 where <&'n'&> is the component number and <&'m'&> is the total number of
35359 components in the entry. The / delimiter is used when the line was split
35360 because it was too long; if it was split because of an internal newline, the \
35361 delimiter is used. For example, supposing the length limit to be 50 instead of
35362 870, the following would be the result of a typical rejection message to
35363 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35364 name, and pid as added by syslog:
35365 .code
35366 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35367 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35368 [3/5]  when scanning for sender: missing or malformed lo
35369 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35370 [5/5] mple>)
35371 .endd
35372 The same error might cause the following lines to be written to &"rejectlog"&
35373 (LOG_NOTICE):
35374 .code
35375 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35376 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35377 [3/18] er when scanning for sender: missing or malformed
35378 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35379 [5\18] .example>)
35380 [6\18] Recipients: ph10@some.domain.cam.example
35381 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35382 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35383 [9\18]        id 16RdAL-0006pc-00
35384 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35385 [11\18] 09:43 +0100
35386 [12\18] F From: <>
35387 [13\18]   Subject: this is a test header
35388 [18\18]   X-something: this is another header
35389 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35390 [16\18] le>
35391 [17\18] B Bcc:
35392 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35393 .endd
35394 Log lines that are neither too long nor contain newlines are written to syslog
35395 without modification.
35396
35397 If only syslog is being used, the Exim monitor is unable to provide a log tail
35398 display, unless syslog is routing &'mainlog'& to a file on the local host and
35399 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35400 where it is.
35401
35402
35403
35404 .section "Log line flags" "SECID250"
35405 One line is written to the main log for each message received, and for each
35406 successful, unsuccessful, and delayed delivery. These lines can readily be
35407 picked out by the distinctive two-character flags that immediately follow the
35408 timestamp. The flags are:
35409 .display
35410 &`<=`&     message arrival
35411 &`=>`&     normal message delivery
35412 &`->`&     additional address in same delivery
35413 &`>>`&     cutthrough message delivery
35414 &`*>`&     delivery suppressed by &%-N%&
35415 &`**`&     delivery failed; address bounced
35416 &`==`&     delivery deferred; temporary problem
35417 .endd
35418
35419
35420 .section "Logging message reception" "SECID251"
35421 .cindex "log" "reception line"
35422 The format of the single-line entry in the main log that is written for every
35423 message received is shown in the basic example below, which is split over
35424 several lines in order to fit it on the page:
35425 .code
35426 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35427   H=mailer.fict.example [192.168.123.123] U=exim
35428   P=smtp S=5678 id=<incoming message id>
35429 .endd
35430 The address immediately following &"<="& is the envelope sender address. A
35431 bounce message is shown with the sender address &"<>"&, and if it is locally
35432 generated, this is followed by an item of the form
35433 .code
35434 R=<message id>
35435 .endd
35436 which is a reference to the message that caused the bounce to be sent.
35437
35438 .cindex "HELO"
35439 .cindex "EHLO"
35440 For messages from other hosts, the H and U fields identify the remote host and
35441 record the RFC 1413 identity of the user that sent the message, if one was
35442 received. The number given in square brackets is the IP address of the sending
35443 host. If there is a single, unparenthesized  host name in the H field, as
35444 above, it has been verified to correspond to the IP address (see the
35445 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35446 by the remote host in the SMTP HELO or EHLO command, and has not been
35447 verified. If verification yields a different name to that given for HELO or
35448 EHLO, the verified name appears first, followed by the HELO or EHLO
35449 name in parentheses.
35450
35451 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35452 without brackets, in the HELO or EHLO command, leading to entries in
35453 the log containing text like these examples:
35454 .code
35455 H=(10.21.32.43) [192.168.8.34]
35456 H=([10.21.32.43]) [192.168.8.34]
35457 .endd
35458 This can be confusing. Only the final address in square brackets can be relied
35459 on.
35460
35461 For locally generated messages (that is, messages not received over TCP/IP),
35462 the H field is omitted, and the U field contains the login name of the caller
35463 of Exim.
35464
35465 .cindex "authentication" "logging"
35466 .cindex "AUTH" "logging"
35467 For all messages, the P field specifies the protocol used to receive the
35468 message. This is the value that is stored in &$received_protocol$&. In the case
35469 of incoming SMTP messages, the value indicates whether or not any SMTP
35470 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35471 session was encrypted, there is an additional X field that records the cipher
35472 suite that was used.
35473
35474 .cindex log protocol
35475 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35476 hosts that have authenticated themselves using the SMTP AUTH command. The first
35477 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35478 there is an additional item A= followed by the name of the authenticator that
35479 was used. If an authenticated identification was set up by the authenticator's
35480 &%server_set_id%& option, this is logged too, separated by a colon from the
35481 authenticator name.
35482
35483 .cindex "size" "of message"
35484 The id field records the existing message id, if present. The size of the
35485 received message is given by the S field. When the message is delivered,
35486 headers may be removed or added, so that the size of delivered copies of the
35487 message may not correspond with this value (and indeed may be different to each
35488 other).
35489
35490 The &%log_selector%& option can be used to request the logging of additional
35491 data when a message is received. See section &<<SECTlogselector>>& below.
35492
35493
35494
35495 .section "Logging deliveries" "SECID252"
35496 .cindex "log" "delivery line"
35497 The format of the single-line entry in the main log that is written for every
35498 delivery is shown in one of the examples below, for local and remote
35499 deliveries, respectively. Each example has been split into multiple lines in order
35500 to fit it on the page:
35501 .code
35502 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35503   <marv@hitch.fict.example> R=localuser T=local_delivery
35504 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35505   monk@holistic.fict.example R=dnslookup T=remote_smtp
35506   H=holistic.fict.example [192.168.234.234]
35507 .endd
35508 For ordinary local deliveries, the original address is given in angle brackets
35509 after the final delivery address, which might be a pipe or a file. If
35510 intermediate address(es) exist between the original and the final address, the
35511 last of these is given in parentheses after the final address. The R and T
35512 fields record the router and transport that were used to process the address.
35513
35514 If SMTP AUTH was used for the delivery there is an additional item A=
35515 followed by the name of the authenticator that was used.
35516 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35517 option, this is logged too, separated by a colon from the authenticator name.
35518
35519 If a shadow transport was run after a successful local delivery, the log line
35520 for the successful delivery has an item added on the end, of the form
35521 .display
35522 &`ST=<`&&'shadow transport name'&&`>`&
35523 .endd
35524 If the shadow transport did not succeed, the error message is put in
35525 parentheses afterwards.
35526
35527 .cindex "asterisk" "after IP address"
35528 When more than one address is included in a single delivery (for example, two
35529 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35530 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35531 down a single SMTP connection, an asterisk follows the IP address in the log
35532 lines for the second and subsequent messages.
35533
35534 .cindex "delivery" "cutthrough; logging"
35535 .cindex "cutthrough" "logging"
35536 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35537 line precedes the reception line, since cutthrough waits for a possible
35538 rejection from the destination in case it can reject the sourced item.
35539
35540 The generation of a reply message by a filter file gets logged as a
35541 &"delivery"& to the addressee, preceded by &">"&.
35542
35543 The &%log_selector%& option can be used to request the logging of additional
35544 data when a message is delivered. See section &<<SECTlogselector>>& below.
35545
35546
35547 .section "Discarded deliveries" "SECID253"
35548 .cindex "discarded messages"
35549 .cindex "message" "discarded"
35550 .cindex "delivery" "discarded; logging"
35551 When a message is discarded as a result of the command &"seen finish"& being
35552 obeyed in a filter file which generates no deliveries, a log entry of the form
35553 .code
35554 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35555   <low.club@bridge.example> R=userforward
35556 .endd
35557 is written, to record why no deliveries are logged. When a message is discarded
35558 because it is aliased to &":blackhole:"& the log line is like this:
35559 .code
35560 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35561   <hole@nowhere.example> R=blackhole_router
35562 .endd
35563
35564
35565 .section "Deferred deliveries" "SECID254"
35566 When a delivery is deferred, a line of the following form is logged:
35567 .code
35568 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35569   R=dnslookup T=smtp defer (146): Connection refused
35570 .endd
35571 In the case of remote deliveries, the error is the one that was given for the
35572 last IP address that was tried. Details of individual SMTP failures are also
35573 written to the log, so the above line would be preceded by something like
35574 .code
35575 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35576   mail1.endrest.example [192.168.239.239]: Connection refused
35577 .endd
35578 When a deferred address is skipped because its retry time has not been reached,
35579 a message is written to the log, but this can be suppressed by setting an
35580 appropriate value in &%log_selector%&.
35581
35582
35583
35584 .section "Delivery failures" "SECID255"
35585 .cindex "delivery" "failure; logging"
35586 If a delivery fails because an address cannot be routed, a line of the
35587 following form is logged:
35588 .code
35589 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35590   <jim@trek99.example>: unknown mail domain
35591 .endd
35592 If a delivery fails at transport time, the router and transport are shown, and
35593 the response from the remote host is included, as in this example:
35594 .code
35595 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35596   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35597   after pipelined RCPT TO:<ace400@pb.example>: host
35598   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35599   <ace400@pb.example>...Addressee unknown
35600 .endd
35601 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35602 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35603 disabling PIPELINING. The log lines for all forms of delivery failure are
35604 flagged with &`**`&.
35605
35606
35607
35608 .section "Fake deliveries" "SECID256"
35609 .cindex "delivery" "fake; logging"
35610 If a delivery does not actually take place because the &%-N%& option has been
35611 used to suppress it, a normal delivery line is written to the log, except that
35612 &"=>"& is replaced by &"*>"&.
35613
35614
35615
35616 .section "Completion" "SECID257"
35617 A line of the form
35618 .code
35619 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35620 .endd
35621 is written to the main log when a message is about to be removed from the spool
35622 at the end of its processing.
35623
35624
35625
35626
35627 .section "Summary of Fields in Log Lines" "SECID258"
35628 .cindex "log" "summary of fields"
35629 A summary of the field identifiers that are used in log lines is shown in
35630 the following table:
35631 .display
35632 &`A   `&        authenticator name (and optional id and sender)
35633 &`C   `&        SMTP confirmation on delivery
35634 &`    `&        command list for &"no mail in SMTP session"&
35635 &`CV  `&        certificate verification status
35636 &`D   `&        duration of &"no mail in SMTP session"&
35637 &`DN  `&        distinguished name from peer certificate
35638 &`DS  `&        DNSSEC secured lookups
35639 &`DT  `&        on &`=>`& lines: time taken for a delivery
35640 &`F   `&        sender address (on delivery lines)
35641 &`H   `&        host name and IP address
35642 &`I   `&        local interface used
35643 &`id  `&        message id for incoming message
35644 &`P   `&        on &`<=`& lines: protocol used
35645 &`    `&        on &`=>`& and &`**`& lines: return path
35646 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35647 &`Q   `&        alternate queue name
35648 &`QT  `&        on &`=>`& lines: time spent on queue so far
35649 &`    `&        on &"Completed"& lines: time spent on queue
35650 &`R   `&        on &`<=`& lines: reference for local bounce
35651 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35652 &`S   `&        size of message in bytes
35653 &`SNI `&        server name indication from TLS client hello
35654 &`ST  `&        shadow transport name
35655 &`T   `&        on &`<=`& lines: message subject (topic)
35656 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35657 &`U   `&        local user or RFC 1413 identity
35658 &`X   `&        TLS cipher suite
35659 .endd
35660
35661
35662 .section "Other log entries" "SECID259"
35663 Various other types of log entry are written from time to time. Most should be
35664 self-explanatory. Among the more common are:
35665
35666 .ilist
35667 .cindex "retry" "time not reached"
35668 &'retry time not reached'&&~&~An address previously suffered a temporary error
35669 during routing or local delivery, and the time to retry has not yet arrived.
35670 This message is not written to an individual message log file unless it happens
35671 during the first delivery attempt.
35672 .next
35673 &'retry time not reached for any host'&&~&~An address previously suffered
35674 temporary errors during remote delivery, and the retry time has not yet arrived
35675 for any of the hosts to which it is routed.
35676 .next
35677 .cindex "spool directory" "file locked"
35678 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35679 some other Exim process is already working on the message. This can be quite
35680 common if queue running processes are started at frequent intervals. The
35681 &'exiwhat'& utility script can be used to find out what Exim processes are
35682 doing.
35683 .next
35684 .cindex "error" "ignored"
35685 &'error ignored'&&~&~There are several circumstances that give rise to this
35686 message:
35687 .olist
35688 Exim failed to deliver a bounce message whose age was greater than
35689 &%ignore_bounce_errors_after%&. The bounce was discarded.
35690 .next
35691 A filter file set up a delivery using the &"noerror"& option, and the delivery
35692 failed. The delivery was discarded.
35693 .next
35694 A delivery set up by a router configured with
35695 . ==== As this is a nested list, any displays it contains must be indented
35696 . ==== as otherwise they are too far to the left.
35697 .code
35698     errors_to = <>
35699 .endd
35700 failed. The delivery was discarded.
35701 .endlist olist
35702 .endlist ilist
35703
35704
35705
35706
35707
35708 .section "Reducing or increasing what is logged" "SECTlogselector"
35709 .cindex "log" "selectors"
35710 By setting the &%log_selector%& global option, you can disable some of Exim's
35711 default logging, or you can request additional logging. The value of
35712 &%log_selector%& is made up of names preceded by plus or minus characters. For
35713 example:
35714 .code
35715 log_selector = +arguments -retry_defer
35716 .endd
35717 The list of optional log items is in the following table, with the default
35718 selection marked by asterisks:
35719 .display
35720 &` 8bitmime                   `&  received 8BITMIME status
35721 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35722 &` address_rewrite            `&  address rewriting
35723 &` all_parents                `&  all parents in => lines
35724 &` arguments                  `&  command line arguments
35725 &`*connection_reject          `&  connection rejections
35726 &`*delay_delivery             `&  immediate delivery delayed
35727 &` deliver_time               `&  time taken to perform delivery
35728 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35729 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35730 &` dnssec                     `&  DNSSEC secured lookups
35731 &`*etrn                       `&  ETRN commands
35732 &`*host_lookup_failed         `&  as it says
35733 &` ident_timeout              `&  timeout for ident connection
35734 &` incoming_interface         `&  local interface on <= and => lines
35735 &` incoming_port              `&  remote port on <= lines
35736 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35737 &` outgoing_interface         `&  local interface on => lines
35738 &` outgoing_port              `&  add remote port to => lines
35739 &`*queue_run                  `&  start and end queue runs
35740 &` queue_time                 `&  time on queue for one recipient
35741 &` queue_time_overall         `&  time on queue for whole message
35742 &` pid                        `&  Exim process id
35743 &` proxy                      `&  proxy address on <= and => lines
35744 &` received_recipients        `&  recipients on <= lines
35745 &` received_sender            `&  sender on <= lines
35746 &`*rejected_header            `&  header contents on reject log
35747 &`*retry_defer                `&  &"retry time not reached"&
35748 &` return_path_on_delivery    `&  put return path on => and ** lines
35749 &` sender_on_delivery         `&  add sender to => lines
35750 &`*sender_verify_fail         `&  sender verification failures
35751 &`*size_reject                `&  rejection because too big
35752 &`*skip_delivery              `&  delivery skipped in a queue run
35753 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35754 &` smtp_connection            `&  incoming SMTP connections
35755 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35756 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35757 &` smtp_no_mail               `&  session with no MAIL commands
35758 &` smtp_protocol_error        `&  SMTP protocol errors
35759 &` smtp_syntax_error          `&  SMTP syntax errors
35760 &` subject                    `&  contents of &'Subject:'& on <= lines
35761 &`*tls_certificate_verified   `&  certificate verification status
35762 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35763 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35764 &` tls_sni                    `&  TLS SNI on <= lines
35765 &` unknown_in_list            `&  DNS lookup failed in list match
35766
35767 &` all                        `&  all of the above
35768 .endd
35769 See also the &%slow_lookup_log%& main configuration option,
35770 section &<<SECID99>>&
35771
35772 More details on each of these items follows:
35773
35774 .ilist
35775 .cindex "8BITMIME"
35776 .cindex "log" "8BITMIME"
35777 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35778 which may help in tracking down interoperability issues with ancient MTAs
35779 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35780 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35781 &`7BIT`& and &`8BITMIME`& respectively.
35782 .next
35783 .cindex "&%warn%& ACL verb" "log when skipping"
35784 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35785 its conditions cannot be evaluated, a log line to this effect is written if
35786 this log selector is set.
35787 .next
35788 .cindex "log" "rewriting"
35789 .cindex "rewriting" "logging"
35790 &%address_rewrite%&: This applies both to global rewrites and per-transport
35791 rewrites, but not to rewrites in filters run as an unprivileged user (because
35792 such users cannot access the log).
35793 .next
35794 .cindex "log" "full parentage"
35795 &%all_parents%&: Normally only the original and final addresses are logged on
35796 delivery lines; with this selector, intermediate parents are given in
35797 parentheses between them.
35798 .next
35799 .cindex "log" "Exim arguments"
35800 .cindex "Exim arguments, logging"
35801 &%arguments%&: This causes Exim to write the arguments with which it was called
35802 to the main log, preceded by the current working directory. This is a debugging
35803 feature, added to make it easier to find out how certain MUAs call
35804 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35805 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35806 that are empty or that contain white space are quoted. Non-printing characters
35807 are shown as escape sequences. This facility cannot log unrecognized arguments,
35808 because the arguments are checked before the configuration file is read. The
35809 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35810 between the caller and Exim.
35811 .next
35812 .cindex "log" "connection rejections"
35813 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35814 connection is rejected, for whatever reason.
35815 .next
35816 .cindex "log" "delayed delivery"
35817 .cindex "delayed delivery, logging"
35818 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35819 started for an incoming message because the load is too high or too many
35820 messages were received on one connection. Logging does not occur if no delivery
35821 process is started because &%queue_only%& is set or &%-odq%& was used.
35822 .next
35823 .cindex "log" "delivery duration"
35824 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35825 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35826 .next
35827 .cindex "log" "message size on delivery"
35828 .cindex "size" "of message"
35829 &%delivery_size%&: For each delivery, the size of message delivered is added to
35830 the &"=>"& line, tagged with S=.
35831 .next
35832 .cindex "log" "dnslist defer"
35833 .cindex "DNS list" "logging defer"
35834 .cindex "black list (DNS)"
35835 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35836 DNS black list suffers a temporary error.
35837 .next
35838 .cindex log dnssec
35839 .cindex dnssec logging
35840 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35841 dns lookups gave secure results a tag of DS is added.
35842 For acceptance this covers the reverse and forward lookups for host name verification.
35843 It does not cover helo-name verification.
35844 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35845 .next
35846 .cindex "log" "ETRN commands"
35847 .cindex "ETRN" "logging"
35848 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35849 is run to determine whether or not it is actually accepted. An invalid ETRN
35850 command, or one received within a message transaction is not logged by this
35851 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35852 .next
35853 .cindex "log" "host lookup failure"
35854 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35855 any addresses, or when a lookup of an IP address fails to find a host name, a
35856 log line is written. This logging does not apply to direct DNS lookups when
35857 routing email addresses, but it does apply to &"byname"& lookups.
35858 .next
35859 .cindex "log" "ident timeout"
35860 .cindex "RFC 1413" "logging timeout"
35861 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35862 client's ident port times out.
35863 .next
35864 .cindex "log" "incoming interface"
35865 .cindex "log" "local interface"
35866 .cindex "log" "local address and port"
35867 .cindex "TCP/IP" "logging local address and port"
35868 .cindex "interface" "logging"
35869 &%incoming_interface%&: The interface on which a message was received is added
35870 to the &"<="& line as an IP address in square brackets, tagged by I= and
35871 followed by a colon and the port number. The local interface and port are also
35872 added to other SMTP log lines, for example &"SMTP connection from"&, to
35873 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35874 The latter can be disabled by turning off the &%outgoing_interface%& option.
35875 .next
35876 .cindex log "incoming proxy address"
35877 .cindex proxy "logging proxy address"
35878 .cindex "TCP/IP" "logging proxy address"
35879 &%proxy%&: The internal (closest to the system running Exim) IP address
35880 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35881 on a proxied connection
35882 or the &"=>"& line for a message delivered on a proxied connection..
35883 See &<<SECTproxyInbound>>& for more information.
35884 .next
35885 .cindex "log" "incoming remote port"
35886 .cindex "port" "logging remote"
35887 .cindex "TCP/IP" "logging incoming remote port"
35888 .vindex "&$sender_fullhost$&"
35889 .vindex "&$sender_rcvhost$&"
35890 &%incoming_port%&: The remote port number from which a message was received is
35891 added to log entries and &'Received:'& header lines, following the IP address
35892 in square brackets, and separated from it by a colon. This is implemented by
35893 changing the value that is put in the &$sender_fullhost$& and
35894 &$sender_rcvhost$& variables. Recording the remote port number has become more
35895 important with the widening use of NAT (see RFC 2505).
35896 .next
35897 .cindex "log" "dropped connection"
35898 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35899 connection is unexpectedly dropped.
35900 .next
35901 .cindex "log" "outgoing interface"
35902 .cindex "log" "local interface"
35903 .cindex "log" "local address and port"
35904 .cindex "TCP/IP" "logging local address and port"
35905 .cindex "interface" "logging"
35906 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35907 interface on which a message was sent is added to delivery lines as an I= tag
35908 followed by IP address in square brackets. You can disable this by turning
35909 off the &%outgoing_interface%& option.
35910 .next
35911 .cindex "log" "outgoing remote port"
35912 .cindex "port" "logging outgoint remote"
35913 .cindex "TCP/IP" "logging ougtoing remote port"
35914 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35915 containing => tags) following the IP address.
35916 The local port is also added if &%incoming_interface%& and
35917 &%outgoing_interface%& are both enabled.
35918 This option is not included in the default setting, because for most ordinary
35919 configurations, the remote port number is always 25 (the SMTP port), and the
35920 local port is a random ephemeral port.
35921 .next
35922 .cindex "log" "process ids in"
35923 .cindex "pid (process id)" "in log lines"
35924 &%pid%&: The current process id is added to every log line, in square brackets,
35925 immediately after the time and date.
35926 .next
35927 .cindex "log" "queue run"
35928 .cindex "queue runner" "logging"
35929 &%queue_run%&: The start and end of every queue run are logged.
35930 .next
35931 .cindex "log" "queue time"
35932 &%queue_time%&: The amount of time the message has been in the queue on the
35933 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35934 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35935 includes reception time as well as the delivery time for the current address.
35936 This means that it may be longer than the difference between the arrival and
35937 delivery log line times, because the arrival log line is not written until the
35938 message has been successfully received.
35939 .next
35940 &%queue_time_overall%&: The amount of time the message has been in the queue on
35941 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35942 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35943 message, so it includes reception time as well as the total delivery time.
35944 .next
35945 .cindex "log" "recipients"
35946 &%received_recipients%&: The recipients of a message are listed in the main log
35947 as soon as the message is received. The list appears at the end of the log line
35948 that is written when a message is received, preceded by the word &"for"&. The
35949 addresses are listed after they have been qualified, but before any rewriting
35950 has taken place.
35951 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35952 in the list.
35953 .next
35954 .cindex "log" "sender reception"
35955 &%received_sender%&: The unrewritten original sender of a message is added to
35956 the end of the log line that records the message's arrival, after the word
35957 &"from"& (before the recipients if &%received_recipients%& is also set).
35958 .next
35959 .cindex "log" "header lines for rejection"
35960 &%rejected_header%&: If a message's header has been received at the time a
35961 rejection is written to the reject log, the complete header is added to the
35962 log. Header logging can be turned off individually for messages that are
35963 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35964 .next
35965 .cindex "log" "retry defer"
35966 &%retry_defer%&: A log line is written if a delivery is deferred because a
35967 retry time has not yet been reached. However, this &"retry time not reached"&
35968 message is always omitted from individual message logs after the first delivery
35969 attempt.
35970 .next
35971 .cindex "log" "return path"
35972 &%return_path_on_delivery%&: The return path that is being transmitted with
35973 the message is included in delivery and bounce lines, using the tag P=.
35974 This is omitted if no delivery actually happens, for example, if routing fails,
35975 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35976 .next
35977 .cindex "log" "sender on delivery"
35978 &%sender_on_delivery%&: The message's sender address is added to every delivery
35979 and bounce line, tagged by F= (for &"from"&).
35980 This is the original sender that was received with the message; it is not
35981 necessarily the same as the outgoing return path.
35982 .next
35983 .cindex "log" "sender verify failure"
35984 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35985 gives details of a sender verification failure is not written. Log lines for
35986 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35987 detail is lost.
35988 .next
35989 .cindex "log" "size rejection"
35990 &%size_reject%&: A log line is written whenever a message is rejected because
35991 it is too big.
35992 .next
35993 .cindex "log" "frozen messages; skipped"
35994 .cindex "frozen messages" "logging skipping"
35995 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35996 queue run because it is frozen or because another process is already delivering
35997 it.
35998 .cindex "&""spool file is locked""&"
35999 The message that is written is &"spool file is locked"&.
36000 .next
36001 .cindex "log" "smtp confirmation"
36002 .cindex "SMTP" "logging confirmation"
36003 .cindex "LMTP" "logging confirmation"
36004 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36005 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36006 A number of MTAs (including Exim) return an identifying string in this
36007 response.
36008 .next
36009 .cindex "log" "SMTP connections"
36010 .cindex "SMTP" "logging connections"
36011 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36012 established or closed, unless the connection is from a host that matches
36013 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36014 only when the closure is unexpected.) This applies to connections from local
36015 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36016 dropped in the middle of a message, a log line is always written, whether or
36017 not this selector is set, but otherwise nothing is written at the start and end
36018 of connections unless this selector is enabled.
36019
36020 For TCP/IP connections to an Exim daemon, the current number of connections is
36021 included in the log message for each new connection, but note that the count is
36022 reset if the daemon is restarted.
36023 Also, because connections are closed (and the closure is logged) in
36024 subprocesses, the count may not include connections that have been closed but
36025 whose termination the daemon has not yet noticed. Thus, while it is possible to
36026 match up the opening and closing of connections in the log, the value of the
36027 logged counts may not be entirely accurate.
36028 .next
36029 .cindex "log" "SMTP transaction; incomplete"
36030 .cindex "SMTP" "logging incomplete transactions"
36031 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36032 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36033 and the message sender plus any accepted recipients are included in the log
36034 line. This can provide evidence of dictionary attacks.
36035 .next
36036 .cindex "log" "non-MAIL SMTP sessions"
36037 .cindex "MAIL" "logging session without"
36038 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36039 connection terminates without having issued a MAIL command. This includes both
36040 the case when the connection is dropped, and the case when QUIT is used. It
36041 does not include cases where the connection is rejected right at the start (by
36042 an ACL, or because there are too many connections, or whatever). These cases
36043 already have their own log lines.
36044
36045 The log line that is written contains the identity of the client in the usual
36046 way, followed by D= and a time, which records the duration of the connection.
36047 If the connection was authenticated, this fact is logged exactly as it is for
36048 an incoming message, with an A= item. If the connection was encrypted, CV=,
36049 DN=, and X= items may appear as they do for an incoming message, controlled by
36050 the same logging options.
36051
36052 Finally, if any SMTP commands were issued during the connection, a C= item
36053 is added to the line, listing the commands that were used. For example,
36054 .code
36055 C=EHLO,QUIT
36056 .endd
36057 shows that the client issued QUIT straight after EHLO. If there were fewer
36058 than 20 commands, they are all listed. If there were more than 20 commands,
36059 the last 20 are listed, preceded by &"..."&. However, with the default
36060 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36061 have been aborted before 20 non-mail commands are processed.
36062 .next
36063 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36064 colon-separated, is appended to the A= item for a message arrival or delivery
36065 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36066 was accepted or used.
36067 .next
36068 .cindex "log" "SMTP protocol error"
36069 .cindex "SMTP" "logging protocol error"
36070 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36071 encountered. Exim does not have perfect detection of all protocol errors
36072 because of transmission delays and the use of pipelining. If PIPELINING has
36073 been advertised to a client, an Exim server assumes that the client will use
36074 it, and therefore it does not count &"expected"& errors (for example, RCPT
36075 received after rejecting MAIL) as protocol errors.
36076 .next
36077 .cindex "SMTP" "logging syntax errors"
36078 .cindex "SMTP" "syntax errors; logging"
36079 .cindex "SMTP" "unknown command; logging"
36080 .cindex "log" "unknown SMTP command"
36081 .cindex "log" "SMTP syntax error"
36082 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36083 encountered. An unrecognized command is treated as a syntax error. For an
36084 external connection, the host identity is given; for an internal connection
36085 using &%-bs%& the sender identification (normally the calling user) is given.
36086 .next
36087 .cindex "log" "subject"
36088 .cindex "subject, logging"
36089 &%subject%&: The subject of the message is added to the arrival log line,
36090 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36091 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36092 specifies whether characters with values greater than 127 should be logged
36093 unchanged, or whether they should be rendered as escape sequences.
36094 .next
36095 .cindex "log" "certificate verification"
36096 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36097 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36098 verified, and &`CV=no`& if not.
36099 .next
36100 .cindex "log" "TLS cipher"
36101 .cindex "TLS" "logging cipher"
36102 &%tls_cipher%&: When a message is sent or received over an encrypted
36103 connection, the cipher suite used is added to the log line, preceded by X=.
36104 .next
36105 .cindex "log" "TLS peer DN"
36106 .cindex "TLS" "logging peer DN"
36107 &%tls_peerdn%&: When a message is sent or received over an encrypted
36108 connection, and a certificate is supplied by the remote host, the peer DN is
36109 added to the log line, preceded by DN=.
36110 .next
36111 .cindex "log" "TLS SNI"
36112 .cindex "TLS" "logging SNI"
36113 &%tls_sni%&: When a message is received over an encrypted connection, and
36114 the remote host provided the Server Name Indication extension, the SNI is
36115 added to the log line, preceded by SNI=.
36116 .next
36117 .cindex "log" "DNS failure in list"
36118 &%unknown_in_list%&: This setting causes a log entry to be written when the
36119 result of a list match is failure because a DNS lookup failed.
36120 .endlist
36121
36122
36123 .section "Message log" "SECID260"
36124 .cindex "message" "log file for"
36125 .cindex "log" "message log; description of"
36126 .cindex "&_msglog_& directory"
36127 .oindex "&%preserve_message_logs%&"
36128 In addition to the general log files, Exim writes a log file for each message
36129 that it handles. The names of these per-message logs are the message ids, and
36130 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36131 message log contains copies of the log lines that apply to the message. This
36132 makes it easier to inspect the status of an individual message without having
36133 to search the main log. A message log is deleted when processing of the message
36134 is complete, unless &%preserve_message_logs%& is set, but this should be used
36135 only with great care because they can fill up your disk very quickly.
36136
36137 On a heavily loaded system, it may be desirable to disable the use of
36138 per-message logs, in order to reduce disk I/O. This can be done by setting the
36139 &%message_logs%& option false.
36140 .ecindex IIDloggen
36141
36142
36143
36144
36145 . ////////////////////////////////////////////////////////////////////////////
36146 . ////////////////////////////////////////////////////////////////////////////
36147
36148 .chapter "Exim utilities" "CHAPutils"
36149 .scindex IIDutils "utilities"
36150 A number of utility scripts and programs are supplied with Exim and are
36151 described in this chapter. There is also the Exim Monitor, which is covered in
36152 the next chapter. The utilities described here are:
36153
36154 .itable none 0 0 3  7* left  15* left  40* left
36155 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36156   "list what Exim processes are doing"
36157 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36158 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36159 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36160 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36161                                                 various criteria"
36162 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36163 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36164   "extract statistics from the log"
36165 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36166   "check address acceptance from given IP"
36167 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36168 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36169 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36170 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36171 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36172 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36173 .endtable
36174
36175 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36176 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36177 &url(http://duncanthrax.net/exilog/) for details.
36178
36179
36180
36181
36182 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36183 .cindex "&'exiwhat'&"
36184 .cindex "process, querying"
36185 .cindex "SIGUSR1"
36186 On operating systems that can restart a system call after receiving a signal
36187 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36188 a line describing what it is doing to the file &_exim-process.info_& in the
36189 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36190 processes it can find, having first emptied the file. It then waits for one
36191 second to allow the Exim processes to react before displaying the results. In
36192 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36193 send the signal to the Exim processes, so it is normally run as root.
36194
36195 &*Warning*&: This is not an efficient process. It is intended for occasional
36196 use by system administrators. It is not sensible, for example, to set up a
36197 script that sends SIGUSR1 signals to Exim processes at short intervals.
36198
36199
36200 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36201 varies in different operating systems. Not only are different options used,
36202 but the format of the output is different. For this reason, there are some
36203 system configuration options that configure exactly how &'exiwhat'& works. If
36204 it doesn't seem to be working for you, check the following compile-time
36205 options:
36206 .display
36207 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36208 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36209 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36210 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36211 .endd
36212 An example of typical output from &'exiwhat'& is
36213 .code
36214 164 daemon: -q1h, listening on port 25
36215 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36216 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36217   [10.19.42.42] (editor@ref.example)
36218 10592 handling incoming call from [192.168.243.242]
36219 10628 accepting a local non-SMTP message
36220 .endd
36221 The first number in the output line is the process number. The third line has
36222 been split here, in order to fit it on the page.
36223
36224
36225
36226 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36227 .cindex "&'exiqgrep'&"
36228 .cindex "queue" "grepping"
36229 This utility is a Perl script contributed by Matt Hubbard. It runs
36230 .code
36231 exim -bpu
36232 .endd
36233 or (in case &*-a*& switch is specified)
36234 .code
36235 exim -bp
36236 .endd
36237 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36238 contain alternate exim configuration the queue management might be using.
36239
36240 to obtain a queue listing, and then greps the output to select messages
36241 that match given criteria. The following selection options are available:
36242
36243 .vlist
36244 .vitem &*-f*&&~<&'regex'&>
36245 Match the sender address using a case-insensitive search. The field that is
36246 tested is enclosed in angle brackets, so you can test for bounce messages with
36247 .code
36248 exiqgrep -f '^<>$'
36249 .endd
36250 .vitem &*-r*&&~<&'regex'&>
36251 Match a recipient address using a case-insensitive search. The field that is
36252 tested is not enclosed in angle brackets.
36253
36254 .vitem &*-s*&&~<&'regex'&>
36255 Match against the size field.
36256
36257 .vitem &*-y*&&~<&'seconds'&>
36258 Match messages that are younger than the given time.
36259
36260 .vitem &*-o*&&~<&'seconds'&>
36261 Match messages that are older than the given time.
36262
36263 .vitem &*-z*&
36264 Match only frozen messages.
36265
36266 .vitem &*-x*&
36267 Match only non-frozen messages.
36268 .endlist
36269
36270 The following options control the format of the output:
36271
36272 .vlist
36273 .vitem &*-c*&
36274 Display only the count of matching messages.
36275
36276 .vitem &*-l*&
36277 Long format &-- display the full message information as output by Exim. This is
36278 the default.
36279
36280 .vitem &*-i*&
36281 Display message ids only.
36282
36283 .vitem &*-b*&
36284 Brief format &-- one line per message.
36285
36286 .vitem &*-R*&
36287 Display messages in reverse order.
36288
36289 .vitem &*-a*&
36290 Include delivered recipients in queue listing.
36291 .endlist
36292
36293 There is one more option, &%-h%&, which outputs a list of options.
36294
36295
36296
36297 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36298 .cindex "&'exiqsumm'&"
36299 .cindex "queue" "summary"
36300 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36301 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36302 running a command such as
36303 .code
36304 exim -bp | exiqsumm
36305 .endd
36306 The output consists of one line for each domain that has messages waiting for
36307 it, as in the following example:
36308 .code
36309 3   2322   74m   66m  msn.com.example
36310 .endd
36311 Each line lists the number of pending deliveries for a domain, their total
36312 volume, and the length of time that the oldest and the newest messages have
36313 been waiting. Note that the number of pending deliveries is greater than the
36314 number of messages when messages have more than one recipient.
36315
36316 A summary line is output at the end. By default the output is sorted on the
36317 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36318 the output to be sorted by oldest message and by count of messages,
36319 respectively. There are also three options that split the messages for each
36320 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36321 separates frozen messages, and &%-s%& separates messages according to their
36322 sender.
36323
36324 The output of &'exim -bp'& contains the original addresses in the message, so
36325 this also applies to the output from &'exiqsumm'&. No domains from addresses
36326 generated by aliasing or forwarding are included (unless the &%one_time%&
36327 option of the &(redirect)& router has been used to convert them into &"top
36328 level"& addresses).
36329
36330
36331
36332
36333 .section "Extracting specific information from the log (exigrep)" &&&
36334          "SECTextspeinf"
36335 .cindex "&'exigrep'&"
36336 .cindex "log" "extracts; grepping for"
36337 The &'exigrep'& utility is a Perl script that searches one or more main log
36338 files for entries that match a given pattern. When it finds a match, it
36339 extracts all the log entries for the relevant message, not just those that
36340 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36341 given message, or all mail for a given user, or for a given host, for example.
36342 The input files can be in Exim log format or syslog format.
36343 If a matching log line is not associated with a specific message, it is
36344 included in &'exigrep'&'s output without any additional lines. The usage is:
36345 .display
36346 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36347 .endd
36348 If no log file names are given on the command line, the standard input is read.
36349
36350 The &%-t%& argument specifies a number of seconds. It adds an additional
36351 condition for message selection. Messages that are complete are shown only if
36352 they spent more than <&'n'&> seconds on the queue.
36353
36354 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36355 makes it case-sensitive. This may give a performance improvement when searching
36356 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36357 option; with &%-I%& they do not. In both cases it is possible to change the
36358 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36359
36360 The &%-l%& option means &"literal"&, that is, treat all characters in the
36361 pattern as standing for themselves. Otherwise the pattern must be a Perl
36362 regular expression.
36363
36364 The &%-v%& option inverts the matching condition. That is, a line is selected
36365 if it does &'not'& match the pattern.
36366
36367 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36368 that are generated as a result/response to a message that &'exigrep'& matched
36369 normally.
36370
36371 Example of &%-M%&:
36372 user_a sends a message to user_b, which generates a bounce back to user_b. If
36373 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36374 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36375 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36376 when searching for &"user_a"& will show both messages since the bounce is
36377 &"related"& to or a &"result"& of the first message that was found by the
36378 search term.
36379
36380 If the location of a &'zcat'& command is known from the definition of
36381 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36382 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36383 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36384 autodetection of some well known compression extensions.
36385
36386
36387 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36388 .cindex "&'exipick'&"
36389 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36390 lists messages from the queue according to a variety of criteria. For details
36391 of &'exipick'&'s facilities, visit the web page at
36392 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36393 the &%--help%& option.
36394
36395
36396 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36397 .cindex "log" "cycling local files"
36398 .cindex "cycling logs"
36399 .cindex "&'exicyclog'&"
36400 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36401 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36402 you are using log files with datestamps in their names (see section
36403 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36404 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36405 There are two command line options for &'exicyclog'&:
36406 .ilist
36407 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36408 default that is set when Exim is built. The default default is 10.
36409 .next
36410 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36411 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36412 overriding the script's default, which is to find the setting from Exim's
36413 configuration.
36414 .endlist
36415
36416 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36417 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36418 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36419 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36420 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36421 logs are handled similarly.
36422
36423 If the limit is greater than 99, the script uses 3-digit numbers such as
36424 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36425 to one that is greater, or &'vice versa'&, you will have to fix the names of
36426 any existing log files.
36427
36428 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36429 the end are deleted. All files with numbers greater than 01 are compressed,
36430 using a compression command which is configured by the COMPRESS_COMMAND
36431 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36432 root &%crontab%& entry of the form
36433 .code
36434 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36435 .endd
36436 assuming you have used the name &"exim"& for the Exim user. You can run
36437 &'exicyclog'& as root if you wish, but there is no need.
36438
36439
36440
36441 .section "Mail statistics (eximstats)" "SECTmailstat"
36442 .cindex "statistics"
36443 .cindex "&'eximstats'&"
36444 A Perl script called &'eximstats'& is provided for extracting statistical
36445 information from log files. The output is either plain text, or HTML.
36446 Exim log files are also supported by the &'Lire'& system produced by the
36447 LogReport Foundation &url(http://www.logreport.org).
36448
36449 The &'eximstats'& script has been hacked about quite a bit over time. The
36450 latest version is the result of some extensive revision by Steve Campbell. A
36451 lot of information is given by default, but there are options for suppressing
36452 various parts of it. Following any options, the arguments to the script are a
36453 list of files, which should be main log files. For example:
36454 .code
36455 eximstats -nr /var/spool/exim/log/mainlog.01
36456 .endd
36457 By default, &'eximstats'& extracts information about the number and volume of
36458 messages received from or delivered to various hosts. The information is sorted
36459 both by message count and by volume, and the top fifty hosts in each category
36460 are listed on the standard output. Similar information, based on email
36461 addresses or domains instead of hosts can be requested by means of various
36462 options. For messages delivered and received locally, similar statistics are
36463 also produced per user.
36464
36465 The output also includes total counts and statistics about delivery errors, and
36466 histograms showing the number of messages received and deliveries made in each
36467 hour of the day. A delivery with more than one address in its envelope (for
36468 example, an SMTP transaction with more than one RCPT command) is counted
36469 as a single delivery by &'eximstats'&.
36470
36471 Though normally more deliveries than receipts are reported (as messages may
36472 have multiple recipients), it is possible for &'eximstats'& to report more
36473 messages received than delivered, even though the queue is empty at the start
36474 and end of the period in question. If an incoming message contains no valid
36475 recipients, no deliveries are recorded for it. A bounce message is handled as
36476 an entirely separate message.
36477
36478 &'eximstats'& always outputs a grand total summary giving the volume and number
36479 of messages received and deliveries made, and the number of hosts involved in
36480 each case. It also outputs the number of messages that were delayed (that is,
36481 not completely delivered at the first attempt), and the number that had at
36482 least one address that failed.
36483
36484 The remainder of the output is in sections that can be independently disabled
36485 or modified by various options. It consists of a summary of deliveries by
36486 transport, histograms of messages received and delivered per time interval
36487 (default per hour), information about the time messages spent on the queue,
36488 a list of relayed messages, lists of the top fifty sending hosts, local
36489 senders, destination hosts, and destination local users by count and by volume,
36490 and a list of delivery errors that occurred.
36491
36492 The relay information lists messages that were actually relayed, that is, they
36493 came from a remote host and were directly delivered to some other remote host,
36494 without being processed (for example, for aliasing or forwarding) locally.
36495
36496 There are quite a few options for &'eximstats'& to control exactly what it
36497 outputs. These are documented in the Perl script itself, and can be extracted
36498 by running the command &(perldoc)& on the script. For example:
36499 .code
36500 perldoc /usr/exim/bin/eximstats
36501 .endd
36502
36503 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36504 .cindex "&'exim_checkaccess'&"
36505 .cindex "policy control" "checking access"
36506 .cindex "checking access"
36507 The &%-bh%& command line argument allows you to run a fake SMTP session with
36508 debugging output, in order to check what Exim is doing when it is applying
36509 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36510 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36511 sometimes you just want to answer the question &"Does this address have
36512 access?"& without bothering with any further details.
36513
36514 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36515 two arguments, an IP address and an email address:
36516 .code
36517 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36518 .endd
36519 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36520 given email address would be accepted in a RCPT command in a TCP/IP
36521 connection from the host with the given IP address. The output of the utility
36522 is either the word &"accepted"&, or the SMTP error response, for example:
36523 .code
36524 Rejected:
36525 550 Relay not permitted
36526 .endd
36527 When running this test, the utility uses &`<>`& as the envelope sender address
36528 for the MAIL command, but you can change this by providing additional
36529 options. These are passed directly to the Exim command. For example, to specify
36530 that the test is to be run with the sender address &'himself@there.example'&
36531 you can use:
36532 .code
36533 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36534                  -f himself@there.example
36535 .endd
36536 Note that these additional Exim command line items must be given after the two
36537 mandatory arguments.
36538
36539 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36540 while running its checks. You can run checks that include callouts by using
36541 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36542
36543
36544
36545 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36546 .cindex "DBM" "building dbm files"
36547 .cindex "building DBM files"
36548 .cindex "&'exim_dbmbuild'&"
36549 .cindex "lower casing"
36550 .cindex "binary zero" "in lookup key"
36551 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36552 the format used by the &(lsearch)& lookup (see section
36553 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36554 names as keys and the remainder of the information as data. The lower-casing
36555 can be prevented by calling the program with the &%-nolc%& option.
36556
36557 A terminating zero is included as part of the key string. This is expected by
36558 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36559 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36560 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36561 files.
36562
36563 The program requires two arguments: the name of the input file (which can be a
36564 single hyphen to indicate the standard input), and the name of the output file.
36565 It creates the output under a temporary name, and then renames it if all went
36566 well.
36567
36568 .cindex "USE_DB"
36569 If the native DB interface is in use (USE_DB is set in a compile-time
36570 configuration file &-- this is common in free versions of Unix) the two file
36571 names must be different, because in this mode the Berkeley DB functions create
36572 a single output file using exactly the name given. For example,
36573 .code
36574 exim_dbmbuild /etc/aliases /etc/aliases.db
36575 .endd
36576 reads the system alias file and creates a DBM version of it in
36577 &_/etc/aliases.db_&.
36578
36579 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36580 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36581 environment, the suffixes are added to the second argument of
36582 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36583 when the Berkeley functions are used in compatibility mode (though this is not
36584 recommended), because in that case it adds a &_.db_& suffix to the file name.
36585
36586 If a duplicate key is encountered, the program outputs a warning, and when it
36587 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36588 option is used. By default, only the first of a set of duplicates is used &--
36589 this makes it compatible with &(lsearch)& lookups. There is an option
36590 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36591 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36592 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36593 return code is 2.
36594
36595
36596
36597
36598 .section "Finding individual retry times (exinext)" "SECTfinindret"
36599 .cindex "retry" "times"
36600 .cindex "&'exinext'&"
36601 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36602 fish specific information out of the retry database. Given a mail domain (or a
36603 complete address), it looks up the hosts for that domain, and outputs any retry
36604 information for the hosts or for the domain. At present, the retry information
36605 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36606 output. For example:
36607 .code
36608 $ exinext piglet@milne.fict.example
36609 kanga.milne.example:192.168.8.1 error 146: Connection refused
36610   first failed: 21-Feb-1996 14:57:34
36611   last tried:   21-Feb-1996 14:57:34
36612   next try at:  21-Feb-1996 15:02:34
36613 roo.milne.example:192.168.8.3 error 146: Connection refused
36614   first failed: 20-Jan-1996 13:12:08
36615   last tried:   21-Feb-1996 11:42:03
36616   next try at:  21-Feb-1996 19:42:03
36617   past final cutoff time
36618 .endd
36619 You can also give &'exinext'& a local part, without a domain, and it
36620 will give any retry information for that local part in your default domain.
36621 A message id can be used to obtain retry information pertaining to a specific
36622 message. This exists only when an attempt to deliver a message to a remote host
36623 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36624 &'exinext'& is not particularly efficient, but then it is not expected to be
36625 run very often.
36626
36627 The &'exinext'& utility calls Exim to find out information such as the location
36628 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36629 passed on to the &'exim'& commands. The first specifies an alternate Exim
36630 configuration file, and the second sets macros for use within the configuration
36631 file. These features are mainly to help in testing, but might also be useful in
36632 environments where more than one configuration file is in use.
36633
36634
36635
36636 .section "Hints database maintenance" "SECThindatmai"
36637 .cindex "hints database" "maintenance"
36638 .cindex "maintaining Exim's hints database"
36639 Three utility programs are provided for maintaining the DBM files that Exim
36640 uses to contain its delivery hint information. Each program requires two
36641 arguments. The first specifies the name of Exim's spool directory, and the
36642 second is the name of the database it is to operate on. These are as follows:
36643
36644 .ilist
36645 &'retry'&: the database of retry information
36646 .next
36647 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36648 for remote hosts
36649 .next
36650 &'callout'&: the callout cache
36651 .next
36652 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36653 .next
36654 &'misc'&: other hints data
36655 .endlist
36656
36657 The &'misc'& database is used for
36658
36659 .ilist
36660 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36661 .next
36662 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36663 &(smtp)& transport)
36664 .next
36665 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36666 in a transport)
36667 .endlist
36668
36669
36670
36671 .section "exim_dumpdb" "SECID261"
36672 .cindex "&'exim_dumpdb'&"
36673 The entire contents of a database are written to the standard output by the
36674 &'exim_dumpdb'& program, which has no options or arguments other than the
36675 spool and database names. For example, to dump the retry database:
36676 .code
36677 exim_dumpdb /var/spool/exim retry
36678 .endd
36679 Two lines of output are produced for each entry:
36680 .code
36681 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36682 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36683 .endd
36684 The first item on the first line is the key of the record. It starts with one
36685 of the letters R, or T, depending on whether it refers to a routing or
36686 transport retry. For a local delivery, the next part is the local address; for
36687 a remote delivery it is the name of the remote host, followed by its failing IP
36688 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36689 transport). If the remote port is not the standard one (port 25), it is added
36690 to the IP address. Then there follows an error code, an additional error code,
36691 and a textual description of the error.
36692
36693 The three times on the second line are the time of first failure, the time of
36694 the last delivery attempt, and the computed time for the next attempt. The line
36695 ends with an asterisk if the cutoff time for the last retry rule has been
36696 exceeded.
36697
36698 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36699 consists of a host name followed by a list of ids for messages that are or were
36700 waiting to be delivered to that host. If there are a very large number for any
36701 one host, continuation records, with a sequence number added to the host name,
36702 may be seen. The data in these records is often out of date, because a message
36703 may be routed to several alternative hosts, and Exim makes no effort to keep
36704 cross-references.
36705
36706
36707
36708 .section "exim_tidydb" "SECID262"
36709 .cindex "&'exim_tidydb'&"
36710 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36711 database. If run with no options, it removes all records that are more than 30
36712 days old. The age is calculated from the date and time that the record was last
36713 updated. Note that, in the case of the retry database, it is &'not'& the time
36714 since the first delivery failure. Information about a host that has been down
36715 for more than 30 days will remain in the database, provided that the record is
36716 updated sufficiently often.
36717
36718 The cutoff date can be altered by means of the &%-t%& option, which must be
36719 followed by a time. For example, to remove all records older than a week from
36720 the retry database:
36721 .code
36722 exim_tidydb -t 7d /var/spool/exim retry
36723 .endd
36724 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36725 message ids. In the former these appear as data in records keyed by host &--
36726 they were messages that were waiting for that host &-- and in the latter they
36727 are the keys for retry information for messages that have suffered certain
36728 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36729 message ids in database records are those of messages that are still on the
36730 queue. Message ids for messages that no longer exist are removed from
36731 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36732 For the &'retry'& database, records whose keys are non-existent message ids are
36733 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36734 whenever it removes information from the database.
36735
36736 Certain records are automatically removed by Exim when they are no longer
36737 needed, but others are not. For example, if all the MX hosts for a domain are
36738 down, a retry record is created for each one. If the primary MX host comes back
36739 first, its record is removed when Exim successfully delivers to it, but the
36740 records for the others remain because Exim has not tried to use those hosts.
36741
36742 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36743 hints databases. You should do this at a quiet time of day, because it requires
36744 a database to be locked (and therefore inaccessible to Exim) while it does its
36745 work. Removing records from a DBM file does not normally make the file smaller,
36746 but all the common DBM libraries are able to re-use the space that is released.
36747 After an initial phase of increasing in size, the databases normally reach a
36748 point at which they no longer get any bigger, as long as they are regularly
36749 tidied.
36750
36751 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36752 databases is likely to keep on increasing.
36753
36754
36755
36756
36757 .section "exim_fixdb" "SECID263"
36758 .cindex "&'exim_fixdb'&"
36759 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36760 Its main use is for testing Exim, but it might also be occasionally useful for
36761 getting round problems in a live system. It has no options, and its interface
36762 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36763 key of a database record can then be entered, and the data for that record is
36764 displayed.
36765
36766 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36767 except the &'retry'& database, that is the only operation that can be carried
36768 out. For the &'retry'& database, each field is output preceded by a number, and
36769 data for individual fields can be changed by typing the field number followed
36770 by new data, for example:
36771 .code
36772 > 4 951102:1000
36773 .endd
36774 resets the time of the next delivery attempt. Time values are given as a
36775 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36776 used as optional separators.
36777
36778
36779
36780
36781 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36782 .cindex "mailbox" "maintenance"
36783 .cindex "&'exim_lock'&"
36784 .cindex "locking mailboxes"
36785 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36786 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36787 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36788 a user agent while investigating a problem. The utility requires the name of
36789 the file as its first argument. If the locking is successful, the second
36790 argument is run as a command (using C's &[system()]& function); if there is no
36791 second argument, the value of the SHELL environment variable is used; if this
36792 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36793 is unlocked and the utility ends. The following options are available:
36794
36795 .vlist
36796 .vitem &%-fcntl%&
36797 Use &[fcntl()]& locking on the open mailbox.
36798
36799 .vitem &%-flock%&
36800 Use &[flock()]& locking on the open mailbox, provided the operating system
36801 supports it.
36802
36803 .vitem &%-interval%&
36804 This must be followed by a number, which is a number of seconds; it sets the
36805 interval to sleep between retries (default 3).
36806
36807 .vitem &%-lockfile%&
36808 Create a lock file before opening the mailbox.
36809
36810 .vitem &%-mbx%&
36811 Lock the mailbox using MBX rules.
36812
36813 .vitem &%-q%&
36814 Suppress verification output.
36815
36816 .vitem &%-retries%&
36817 This must be followed by a number; it sets the number of times to try to get
36818 the lock (default 10).
36819
36820 .vitem &%-restore_time%&
36821 This option causes &%exim_lock%& to restore the modified and read times to the
36822 locked file before exiting. This allows you to access a locked mailbox (for
36823 example, to take a backup copy) without disturbing the times that the user
36824 subsequently sees.
36825
36826 .vitem &%-timeout%&
36827 This must be followed by a number, which is a number of seconds; it sets a
36828 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36829 default), a non-blocking call is used.
36830
36831 .vitem &%-v%&
36832 Generate verbose output.
36833 .endlist
36834
36835 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36836 default is to create a lock file and also to use &[fcntl()]& locking on the
36837 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36838 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36839 requires that the directory containing the file be writeable. Locking by lock
36840 file does not last for ever; Exim assumes that a lock file is expired if it is
36841 more than 30 minutes old.
36842
36843 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36844 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36845 to be taken out on the open mailbox, and an exclusive lock on the file
36846 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36847 number of the mailbox file. When the locking is released, if an exclusive lock
36848 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36849
36850 The default output contains verification of the locking that takes place. The
36851 &%-v%& option causes some additional information to be given. The &%-q%& option
36852 suppresses all output except error messages.
36853
36854 A command such as
36855 .code
36856 exim_lock /var/spool/mail/spqr
36857 .endd
36858 runs an interactive shell while the file is locked, whereas
36859 .display
36860 &`exim_lock -q /var/spool/mail/spqr <<End`&
36861 <&'some commands'&>
36862 &`End`&
36863 .endd
36864 runs a specific non-interactive sequence of commands while the file is locked,
36865 suppressing all verification output. A single command can be run by a command
36866 such as
36867 .code
36868 exim_lock -q /var/spool/mail/spqr \
36869   "cp /var/spool/mail/spqr /some/where"
36870 .endd
36871 Note that if a command is supplied, it must be entirely contained within the
36872 second argument &-- hence the quotes.
36873 .ecindex IIDutils
36874
36875
36876 . ////////////////////////////////////////////////////////////////////////////
36877 . ////////////////////////////////////////////////////////////////////////////
36878
36879 .chapter "The Exim monitor" "CHAPeximon"
36880 .scindex IIDeximon "Exim monitor" "description"
36881 .cindex "X-windows"
36882 .cindex "&'eximon'&"
36883 .cindex "Local/eximon.conf"
36884 .cindex "&_exim_monitor/EDITME_&"
36885 The Exim monitor is an application which displays in an X window information
36886 about the state of Exim's queue and what Exim is doing. An admin user can
36887 perform certain operations on messages from this GUI interface; however all
36888 such facilities are also available from the command line, and indeed, the
36889 monitor itself makes use of the command line to perform any actions requested.
36890
36891
36892
36893 .section "Running the monitor" "SECID264"
36894 The monitor is started by running the script called &'eximon'&. This is a shell
36895 script that sets up a number of environment variables, and then runs the
36896 binary called &_eximon.bin_&. The default appearance of the monitor window can
36897 be changed by editing the &_Local/eximon.conf_& file created by editing
36898 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36899 parameters are for.
36900
36901 The parameters that get built into the &'eximon'& script can be overridden for
36902 a particular invocation by setting up environment variables of the same names,
36903 preceded by &`EXIMON_`&. For example, a shell command such as
36904 .code
36905 EXIMON_LOG_DEPTH=400 eximon
36906 .endd
36907 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36908 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36909 overrides the Exim log file configuration. This makes it possible to have
36910 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36911 syslog messages are routed to a file on the local host.
36912
36913 X resources can be used to change the appearance of the window in the normal
36914 way. For example, a resource setting of the form
36915 .code
36916 Eximon*background: gray94
36917 .endd
36918 changes the colour of the background to light grey rather than white. The
36919 stripcharts are drawn with both the data lines and the reference lines in
36920 black. This means that the reference lines are not visible when on top of the
36921 data. However, their colour can be changed by setting a resource called
36922 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36923 For example, if your X server is running Unix, you could set up lighter
36924 reference lines in the stripcharts by obeying
36925 .code
36926 xrdb -merge <<End
36927 Eximon*highlight: gray
36928 End
36929 .endd
36930 .cindex "admin user"
36931 In order to see the contents of messages on the queue, and to operate on them,
36932 &'eximon'& must either be run as root or by an admin user.
36933
36934 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36935 contain X11 resource parameters interpreted by the X11 library.  In addition,
36936 if the first parameter starts with the string "gdb" then it is removed and the
36937 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36938 versioned variants of gdb can be invoked).
36939
36940 The monitor's window is divided into three parts. The first contains one or
36941 more stripcharts and two action buttons, the second contains a &"tail"& of the
36942 main log file, and the third is a display of the queue of messages awaiting
36943 delivery, with two more action buttons. The following sections describe these
36944 different parts of the display.
36945
36946
36947
36948
36949 .section "The stripcharts" "SECID265"
36950 .cindex "stripchart"
36951 The first stripchart is always a count of messages on the queue. Its name can
36952 be configured by setting QUEUE_STRIPCHART_NAME in the
36953 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36954 configuration script by regular expression matches on log file entries, making
36955 it possible to display, for example, counts of messages delivered to certain
36956 hosts or using certain transports. The supplied defaults display counts of
36957 received and delivered messages, and of local and SMTP deliveries. The default
36958 period between stripchart updates is one minute; this can be adjusted by a
36959 parameter in the &_Local/eximon.conf_& file.
36960
36961 The stripchart displays rescale themselves automatically as the value they are
36962 displaying changes. There are always 10 horizontal lines in each chart; the
36963 title string indicates the value of each division when it is greater than one.
36964 For example, &"x2"& means that each division represents a value of 2.
36965
36966 It is also possible to have a stripchart which shows the percentage fullness of
36967 a particular disk partition, which is useful when local deliveries are confined
36968 to a single partition.
36969
36970 .cindex "&%statvfs%& function"
36971 This relies on the availability of the &[statvfs()]& function or equivalent in
36972 the operating system. Most, but not all versions of Unix that support Exim have
36973 this. For this particular stripchart, the top of the chart always represents
36974 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36975 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36976 &_Local/eximon.conf_& file.
36977
36978
36979
36980
36981 .section "Main action buttons" "SECID266"
36982 .cindex "size" "of monitor window"
36983 .cindex "Exim monitor" "window size"
36984 .cindex "window size"
36985 Below the stripcharts there is an action button for quitting the monitor. Next
36986 to this is another button marked &"Size"&. They are placed here so that
36987 shrinking the window to its default minimum size leaves just the queue count
36988 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36989 the window to expand to its maximum size, unless it is already at the maximum,
36990 in which case it is reduced to its minimum.
36991
36992 When expanding to the maximum, if the window cannot be fully seen where it
36993 currently is, it is moved back to where it was the last time it was at full
36994 size. When it is expanding from its minimum size, the old position is
36995 remembered, and next time it is reduced to the minimum it is moved back there.
36996
36997 The idea is that you can keep a reduced window just showing one or two
36998 stripcharts at a convenient place on your screen, easily expand it to show
36999 the full window when required, and just as easily put it back to what it was.
37000 The idea is copied from what the &'twm'& window manager does for its
37001 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37002 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37003
37004 Normally, the monitor starts up with the window at its full size, but it can be
37005 built so that it starts up with the window at its smallest size, by setting
37006 START_SMALL=yes in &_Local/eximon.conf_&.
37007
37008
37009
37010 .section "The log display" "SECID267"
37011 .cindex "log" "tail of; in monitor"
37012 The second section of the window is an area in which a display of the tail of
37013 the main log is maintained.
37014 To save space on the screen, the timestamp on each log line is shortened by
37015 removing the date and, if &%log_timezone%& is set, the timezone.
37016 The log tail is not available when the only destination for logging data is
37017 syslog, unless the syslog lines are routed to a local file whose name is passed
37018 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37019
37020 The log sub-window has a scroll bar at its lefthand side which can be used to
37021 move back to look at earlier text, and the up and down arrow keys also have a
37022 scrolling effect. The amount of log that is kept depends on the setting of
37023 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37024 to use. When this is full, the earlier 50% of data is discarded &-- this is
37025 much more efficient than throwing it away line by line. The sub-window also has
37026 a horizontal scroll bar for accessing the ends of long log lines. This is the
37027 only means of horizontal scrolling; the right and left arrow keys are not
37028 available. Text can be cut from this part of the window using the mouse in the
37029 normal way. The size of this subwindow is controlled by parameters in the
37030 configuration file &_Local/eximon.conf_&.
37031
37032 Searches of the text in the log window can be carried out by means of the ^R
37033 and ^S keystrokes, which default to a reverse and a forward search,
37034 respectively. The search covers only the text that is displayed in the window.
37035 It cannot go further back up the log.
37036
37037 The point from which the search starts is indicated by a caret marker. This is
37038 normally at the end of the text in the window, but can be positioned explicitly
37039 by pointing and clicking with the left mouse button, and is moved automatically
37040 by a successful search. If new text arrives in the window when it is scrolled
37041 back, the caret remains where it is, but if the window is not scrolled back,
37042 the caret is moved to the end of the new text.
37043
37044 Pressing ^R or ^S pops up a window into which the search text can be typed.
37045 There are buttons for selecting forward or reverse searching, for carrying out
37046 the search, and for cancelling. If the &"Search"& button is pressed, the search
37047 happens and the window remains so that further searches can be done. If the
37048 &"Return"& key is pressed, a single search is done and the window is closed. If
37049 ^C is typed the search is cancelled.
37050
37051 The searching facility is implemented using the facilities of the Athena text
37052 widget. By default this pops up a window containing both &"search"& and
37053 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37054 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37055 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37056 provided version of &%TextPop%& when the remaining parts of the text widget
37057 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37058 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37059 on these systems, at the expense of having unwanted items in the search popup
37060 window.
37061
37062
37063
37064 .section "The queue display" "SECID268"
37065 .cindex "queue" "display in monitor"
37066 The bottom section of the monitor window contains a list of all messages that
37067 are on the queue, which includes those currently being received or delivered,
37068 as well as those awaiting delivery. The size of this subwindow is controlled by
37069 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37070 at which it is updated is controlled by another parameter in the same file &--
37071 the default is 5 minutes, since queue scans can be quite expensive. However,
37072 there is an &"Update"& action button just above the display which can be used
37073 to force an update of the queue display at any time.
37074
37075 When a host is down for some time, a lot of pending mail can build up for it,
37076 and this can make it hard to deal with other messages on the queue. To help
37077 with this situation there is a button next to &"Update"& called &"Hide"&. If
37078 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37079 type anything in here and press &"Return"&, the text is added to a chain of
37080 such texts, and if every undelivered address in a message matches at least one
37081 of the texts, the message is not displayed.
37082
37083 If there is an address that does not match any of the texts, all the addresses
37084 are displayed as normal. The matching happens on the ends of addresses so, for
37085 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37086 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37087 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37088 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37089 a hide request is automatically cancelled after one hour.
37090
37091 While the dialogue box is displayed, you can't press any buttons or do anything
37092 else to the monitor window. For this reason, if you want to cut text from the
37093 queue display to use in the dialogue box, you have to do the cutting before
37094 pressing the &"Hide"& button.
37095
37096 The queue display contains, for each unhidden queued message, the length of
37097 time it has been on the queue, the size of the message, the message id, the
37098 message sender, and the first undelivered recipient, all on one line. If it is
37099 a bounce message, the sender is shown as &"<>"&. If there is more than one
37100 recipient to which the message has not yet been delivered, subsequent ones are
37101 listed on additional lines, up to a maximum configured number, following which
37102 an ellipsis is displayed. Recipients that have already received the message are
37103 not shown.
37104
37105 .cindex "frozen messages" "display"
37106 If a message is frozen, an asterisk is displayed at the left-hand side.
37107
37108 The queue display has a vertical scroll bar, and can also be scrolled by means
37109 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37110 The text searching facilities, as described above for the log window, are also
37111 available, but the caret is always moved to the end of the text when the queue
37112 display is updated.
37113
37114
37115
37116 .section "The queue menu" "SECID269"
37117 .cindex "queue" "menu in monitor"
37118 If the &%shift%& key is held down and the left button is clicked when the mouse
37119 pointer is over the text for any message, an action menu pops up, and the first
37120 line of the queue display for the message is highlighted. This does not affect
37121 any selected text.
37122
37123 If you want to use some other event for popping up the menu, you can set the
37124 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37125 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37126 value set in this parameter is a standard X event description. For example, to
37127 run eximon using &%ctrl%& rather than &%shift%& you could use
37128 .code
37129 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37130 .endd
37131 The title of the menu is the message id, and it contains entries which act as
37132 follows:
37133
37134 .ilist
37135 &'message log'&: The contents of the message log for the message are displayed
37136 in a new text window.
37137 .next
37138 &'headers'&: Information from the spool file that contains the envelope
37139 information and headers is displayed in a new text window. See chapter
37140 &<<CHAPspool>>& for a description of the format of spool files.
37141 .next
37142 &'body'&: The contents of the spool file containing the body of the message are
37143 displayed in a new text window. There is a default limit of 20,000 bytes to the
37144 amount of data displayed. This can be changed by setting the BODY_MAX
37145 option at compile time, or the EXIMON_BODY_MAX option at run time.
37146 .next
37147 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37148 delivery of the message. This causes an automatic thaw if the message is
37149 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37150 a new text window. The delivery is run in a separate process, to avoid holding
37151 up the monitor while the delivery proceeds.
37152 .next
37153 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37154 that the message be frozen.
37155 .next
37156 .cindex "thawing messages"
37157 .cindex "unfreezing messages"
37158 .cindex "frozen messages" "thawing"
37159 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37160 that the message be thawed.
37161 .next
37162 .cindex "delivery" "forcing failure"
37163 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37164 that Exim gives up trying to deliver the message. A bounce message is generated
37165 for any remaining undelivered addresses.
37166 .next
37167 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37168 that the message be deleted from the system without generating a bounce
37169 message.
37170 .next
37171 &'add recipient'&: A dialog box is displayed into which a recipient address can
37172 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37173 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37174 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37175 causes a call to Exim to be made using the &%-Mar%& option to request that an
37176 additional recipient be added to the message, unless the entry box is empty, in
37177 which case no action is taken.
37178 .next
37179 &'mark delivered'&: A dialog box is displayed into which a recipient address
37180 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37181 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37182 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37183 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37184 recipient address as already delivered, unless the entry box is empty, in which
37185 case no action is taken.
37186 .next
37187 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37188 mark all recipient addresses as already delivered.
37189 .next
37190 &'edit sender'&: A dialog box is displayed initialized with the current
37191 sender's address. Pressing RETURN causes a call to Exim to be made using the
37192 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37193 in which case no action is taken. If you want to set an empty sender (as in
37194 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37195 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37196 the address is qualified with that domain.
37197 .endlist
37198
37199 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37200 other cases when a call to Exim is made, if there is any output from Exim (in
37201 particular, if the command fails) a window containing the command and the
37202 output is displayed. Otherwise, the results of the action are normally apparent
37203 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37204 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37205 if no output is generated.
37206
37207 The queue display is automatically updated for actions such as freezing and
37208 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37209 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37210 force an update of the display after one of these actions.
37211
37212 In any text window that is displayed as result of a menu action, the normal
37213 cut-and-paste facility is available, and searching can be carried out using ^R
37214 and ^S, as described above for the log tail window.
37215 .ecindex IIDeximon
37216
37217
37218
37219
37220
37221 . ////////////////////////////////////////////////////////////////////////////
37222 . ////////////////////////////////////////////////////////////////////////////
37223
37224 .chapter "Security considerations" "CHAPsecurity"
37225 .scindex IIDsecurcon "security" "discussion of"
37226 This chapter discusses a number of issues concerned with security, some of
37227 which are also covered in other parts of this manual.
37228
37229 For reasons that this author does not understand, some people have promoted
37230 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37231 existence of this chapter in the documentation. However, the intent of the
37232 chapter is simply to describe the way Exim works in relation to certain
37233 security concerns, not to make any specific claims about the effectiveness of
37234 its security as compared with other MTAs.
37235
37236 What follows is a description of the way Exim is supposed to be. Best efforts
37237 have been made to try to ensure that the code agrees with the theory, but an
37238 absence of bugs can never be guaranteed. Any that are reported will get fixed
37239 as soon as possible.
37240
37241
37242 .section "Building a more &""hardened""& Exim" "SECID286"
37243 .cindex "security" "build-time features"
37244 There are a number of build-time options that can be set in &_Local/Makefile_&
37245 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37246 Exim administrator who does not have the root password, or by someone who has
37247 penetrated the Exim (but not the root) account. These options are as follows:
37248
37249 .ilist
37250 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37251 start of any file names used with the &%-C%& option. When it is set, these file
37252 names are also not allowed to contain the sequence &"/../"&. (However, if the
37253 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37254 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37255 default setting for &%ALT_CONFIG_PREFIX%&.
37256
37257 If the permitted configuration files are confined to a directory to
37258 which only root has access, this guards against someone who has broken
37259 into the Exim account from running a privileged Exim with an arbitrary
37260 configuration file, and using it to break into other accounts.
37261 .next
37262
37263 If a non-trusted configuration file (i.e. not the default configuration file
37264 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37265 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37266 the next item), then root privilege is retained only if the caller of Exim is
37267 root. This locks out the possibility of testing a configuration using &%-C%&
37268 right through message reception and delivery, even if the caller is root. The
37269 reception works, but by that time, Exim is running as the Exim user, so when
37270 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37271 privilege to be lost. However, root can test reception and delivery using two
37272 separate commands.
37273
37274 .next
37275 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37276 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37277 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37278 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37279 the restrictive side.  Requiring build-time selection of safe macros is onerous
37280 but this option is intended solely as a transition mechanism to permit
37281 previously-working configurations to continue to work after release 4.73.
37282 .next
37283 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37284 is disabled.
37285 .next
37286 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37287 never to be used for any deliveries. This is like the &%never_users%& runtime
37288 option, but it cannot be overridden; the runtime option adds additional users
37289 to the list. The default setting is &"root"&; this prevents a non-root user who
37290 is permitted to modify the runtime file from using Exim as a way to get root.
37291 .endlist
37292
37293
37294
37295 .section "Root privilege" "SECID270"
37296 .cindex "setuid"
37297 .cindex "root privilege"
37298 The Exim binary is normally setuid to root, which means that it gains root
37299 privilege (runs as root) when it starts execution. In some special cases (for
37300 example, when the daemon is not in use and there are no local deliveries), it
37301 may be possible to run Exim setuid to some user other than root. This is
37302 discussed in the next section. However, in most installations, root privilege
37303 is required for two things:
37304
37305 .ilist
37306 To set up a socket connected to the standard SMTP port (25) when initialising
37307 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37308 not required.
37309 .next
37310 To be able to change uid and gid in order to read users' &_.forward_& files and
37311 perform local deliveries as the receiving user or as specified in the
37312 configuration.
37313 .endlist
37314
37315 It is not necessary to be root to do any of the other things Exim does, such as
37316 receiving messages and delivering them externally over SMTP, and it is
37317 obviously more secure if Exim does not run as root except when necessary.
37318 For this reason, a user and group for Exim to use must be defined in
37319 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37320 group"&. Their values can be changed by the run time configuration, though this
37321 is not recommended. Often a user called &'exim'& is used, but some sites use
37322 &'mail'& or another user name altogether.
37323
37324 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37325 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37326 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37327
37328 After a new Exim process has interpreted its command line options, it changes
37329 uid and gid in the following cases:
37330
37331 .ilist
37332 .oindex "&%-C%&"
37333 .oindex "&%-D%&"
37334 If the &%-C%& option is used to specify an alternate configuration file, or if
37335 the &%-D%& option is used to define macro values for the configuration, and the
37336 calling process is not running as root, the uid and gid are changed to those of
37337 the calling process.
37338 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37339 option may not be used at all.
37340 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37341 can be supplied if the calling process is running as root, the Exim run-time
37342 user or CONFIGURE_OWNER, if defined.
37343 .next
37344 .oindex "&%-be%&"
37345 .oindex "&%-bf%&"
37346 .oindex "&%-bF%&"
37347 If the expansion test option (&%-be%&) or one of the filter testing options
37348 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37349 calling process.
37350 .next
37351 If the process is not a daemon process or a queue runner process or a delivery
37352 process or a process for testing address routing (started with &%-bt%&), the
37353 uid and gid are changed to the Exim user and group. This means that Exim always
37354 runs under its own uid and gid when receiving messages. This also applies when
37355 testing address verification
37356 .oindex "&%-bv%&"
37357 .oindex "&%-bh%&"
37358 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37359 option).
37360 .next
37361 For a daemon, queue runner, delivery, or address testing process, the uid
37362 remains as root at this stage, but the gid is changed to the Exim group.
37363 .endlist
37364
37365 The processes that initially retain root privilege behave as follows:
37366
37367 .ilist
37368 A daemon process changes the gid to the Exim group and the uid to the Exim
37369 user after setting up one or more listening sockets. The &[initgroups()]&
37370 function is called, so that if the Exim user is in any additional groups, they
37371 will be used during message reception.
37372 .next
37373 A queue runner process retains root privilege throughout its execution. Its
37374 job is to fork a controlled sequence of delivery processes.
37375 .next
37376 A delivery process retains root privilege throughout most of its execution,
37377 but any actual deliveries (that is, the transports themselves) are run in
37378 subprocesses which always change to a non-root uid and gid. For local
37379 deliveries this is typically the uid and gid of the owner of the mailbox; for
37380 remote deliveries, the Exim uid and gid are used. Once all the delivery
37381 subprocesses have been run, a delivery process changes to the Exim uid and gid
37382 while doing post-delivery tidying up such as updating the retry database and
37383 generating bounce and warning messages.
37384
37385 While the recipient addresses in a message are being routed, the delivery
37386 process runs as root. However, if a user's filter file has to be processed,
37387 this is done in a subprocess that runs under the individual user's uid and
37388 gid. A system filter is run as root unless &%system_filter_user%& is set.
37389 .next
37390 A process that is testing addresses (the &%-bt%& option) runs as root so that
37391 the routing is done in the same environment as a message delivery.
37392 .endlist
37393
37394
37395
37396
37397 .section "Running Exim without privilege" "SECTrunexiwitpri"
37398 .cindex "privilege, running without"
37399 .cindex "unprivileged running"
37400 .cindex "root privilege" "running without"
37401 Some installations like to run Exim in an unprivileged state for more of its
37402 operation, for added security. Support for this mode of operation is provided
37403 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37404 gid are changed to the Exim user and group at the start of a delivery process
37405 (and also queue runner and address testing processes). This means that address
37406 routing is no longer run as root, and the deliveries themselves cannot change
37407 to any other uid.
37408
37409 .cindex SIGHUP
37410 .cindex "daemon" "restarting"
37411 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37412 that the daemon can still be started in the usual way, and it can respond
37413 correctly to SIGHUP because the re-invocation regains root privilege.
37414
37415 An alternative approach is to make Exim setuid to the Exim user and also setgid
37416 to the Exim group. If you do this, the daemon must be started from a root
37417 process. (Calling Exim from a root process makes it behave in the way it does
37418 when it is setuid root.) However, the daemon cannot restart itself after a
37419 SIGHUP signal because it cannot regain privilege.
37420
37421 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37422 stops Exim from trying to re-invoke itself to do a delivery after a message has
37423 been received. Such a re-invocation is a waste of resources because it has no
37424 effect.
37425
37426 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37427 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37428 to the Exim user seems a clean approach, but there is one complication:
37429
37430 In this style of operation, Exim is running with the real uid and gid set to
37431 those of the calling process, and the effective uid/gid set to Exim's values.
37432 Ideally, any association with the calling process' uid/gid should be dropped,
37433 that is, the real uid/gid should be reset to the effective values so as to
37434 discard any privileges that the caller may have. While some operating systems
37435 have a function that permits this action for a non-root effective uid, quite a
37436 number of them do not. Because of this lack of standardization, Exim does not
37437 address this problem at this time.
37438
37439 For this reason, the recommended approach for &"mostly unprivileged"& running
37440 is to keep the Exim binary setuid to root, and to set
37441 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37442 be used in the most straightforward way.
37443
37444 If you configure Exim not to run delivery processes as root, there are a
37445 number of restrictions on what you can do:
37446
37447 .ilist
37448 You can deliver only as the Exim user/group. You should  explicitly use the
37449 &%user%& and &%group%& options to override routers or local transports that
37450 normally deliver as the recipient. This makes sure that configurations that
37451 work in this mode function the same way in normal mode. Any implicit or
37452 explicit specification of another user causes an error.
37453 .next
37454 Use of &_.forward_& files is severely restricted, such that it is usually
37455 not worthwhile to include them in the configuration.
37456 .next
37457 Users who wish to use &_.forward_& would have to make their home directory and
37458 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37459 and their equivalents in Exim filters, cannot be used. While they could be
37460 enabled in the Exim user's name, that would be insecure and not very useful.
37461 .next
37462 Unless the local user mailboxes are all owned by the Exim user (possible in
37463 some POP3 or IMAP-only environments):
37464
37465 .olist
37466 They must be owned by the Exim group and be writeable by that group. This
37467 implies you must set &%mode%& in the appendfile configuration, as well as the
37468 mode of the mailbox files themselves.
37469 .next
37470 You must set &%no_check_owner%&, since most or all of the files will not be
37471 owned by the Exim user.
37472 .next
37473 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37474 on a newly created mailbox when unprivileged. This also implies that new
37475 mailboxes need to be created manually.
37476 .endlist olist
37477 .endlist ilist
37478
37479
37480 These restrictions severely restrict what can be done in local deliveries.
37481 However, there are no restrictions on remote deliveries. If you are running a
37482 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37483 gives more security at essentially no cost.
37484
37485 If you are using the &%mua_wrapper%& facility (see chapter
37486 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37487
37488
37489
37490
37491 .section "Delivering to local files" "SECID271"
37492 Full details of the checks applied by &(appendfile)& before it writes to a file
37493 are given in chapter &<<CHAPappendfile>>&.
37494
37495
37496
37497 .section "Running local commands" "SECTsecconslocalcmds"
37498 .cindex "security" "local commands"
37499 .cindex "security" "command injection attacks"
37500 There are a number of ways in which an administrator can configure Exim to run
37501 commands based upon received, untrustworthy, data. Further, in some
37502 configurations a user who can control a &_.forward_& file can also arrange to
37503 run commands. Configuration to check includes, but is not limited to:
37504
37505 .ilist
37506 Use of &%use_shell%& in the pipe transport: various forms of shell command
37507 injection may be possible with this option present. It is dangerous and should
37508 be used only with considerable caution. Consider constraints which whitelist
37509 allowed characters in a variable which is to be used in a pipe transport that
37510 has &%use_shell%& enabled.
37511 .next
37512 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37513 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37514 &_.forward_& files in a redirect router. If Exim is running on a central mail
37515 hub to which ordinary users do not have shell access, but home directories are
37516 NFS mounted (for instance) then administrators should review the list of these
37517 forbid options available, and should bear in mind that the options that may
37518 need forbidding can change as new features are added between releases.
37519 .next
37520 The &%${run...}%& expansion item does not use a shell by default, but
37521 administrators can configure use of &_/bin/sh_& as part of the command.
37522 Such invocations should be viewed with prejudicial suspicion.
37523 .next
37524 Administrators who use embedded Perl are advised to explore how Perl's
37525 taint checking might apply to their usage.
37526 .next
37527 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37528 administrators are well advised to view its use with suspicion, in case (for
37529 instance) it allows a local-part to contain embedded Exim directives.
37530 .next
37531 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37532 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37533 each can reference arbitrary lists and files, rather than just being a list
37534 of opaque strings.
37535 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37536 real-world security vulnerabilities caused by its use with untrustworthy data
37537 injected in, for SQL injection attacks.
37538 Consider the use of the &%inlisti%& expansion condition instead.
37539 .endlist
37540
37541
37542
37543
37544 .section "Trust in configuration data" "SECTsecconfdata"
37545 .cindex "security" "data sources"
37546 .cindex "security" "regular expressions"
37547 .cindex "regular expressions" "security"
37548 .cindex "PCRE" "security"
37549 If configuration data for Exim can come from untrustworthy sources, there
37550 are some issues to be aware of:
37551
37552 .ilist
37553 Use of &%${expand...}%& may provide a path for shell injection attacks.
37554 .next
37555 Letting untrusted data provide a regular expression is unwise.
37556 .next
37557 Using &%${match...}%& to apply a fixed regular expression against untrusted
37558 data may result in pathological behaviour within PCRE.  Be aware of what
37559 "backtracking" means and consider options for being more strict with a regular
37560 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37561 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37562 possessive quantifiers or just not using regular expressions against untrusted
37563 data.
37564 .next
37565 It can be important to correctly use &%${quote:...}%&,
37566 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37567 items to ensure that data is correctly constructed.
37568 .next
37569 Some lookups might return multiple results, even though normal usage is only
37570 expected to yield one result.
37571 .endlist
37572
37573
37574
37575
37576 .section "IPv4 source routing" "SECID272"
37577 .cindex "source routing" "in IP packets"
37578 .cindex "IP source routing"
37579 Many operating systems suppress IP source-routed packets in the kernel, but
37580 some cannot be made to do this, so Exim does its own check. It logs incoming
37581 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37582 IPv6. No special checking is currently done.
37583
37584
37585
37586 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37587 Support for these SMTP commands is disabled by default. If required, they can
37588 be enabled by defining suitable ACLs.
37589
37590
37591
37592
37593 .section "Privileged users" "SECID274"
37594 .cindex "trusted users"
37595 .cindex "admin user"
37596 .cindex "privileged user"
37597 .cindex "user" "trusted"
37598 .cindex "user" "admin"
37599 Exim recognizes two sets of users with special privileges. Trusted users are
37600 able to submit new messages to Exim locally, but supply their own sender
37601 addresses and information about a sending host. For other users submitting
37602 local messages, Exim sets up the sender address from the uid, and doesn't
37603 permit a remote host to be specified.
37604
37605 .oindex "&%-f%&"
37606 However, an untrusted user is permitted to use the &%-f%& command line option
37607 in the special form &%-f <>%& to indicate that a delivery failure for the
37608 message should not cause an error report. This affects the message's envelope,
37609 but it does not affect the &'Sender:'& header. Untrusted users may also be
37610 permitted to use specific forms of address with the &%-f%& option by setting
37611 the &%untrusted_set_sender%& option.
37612
37613 Trusted users are used to run processes that receive mail messages from some
37614 other mail domain and pass them on to Exim for delivery either locally, or over
37615 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37616 as any user listed in the &%trusted_users%& configuration option, or under any
37617 group listed in the &%trusted_groups%& option.
37618
37619 Admin users are permitted to do things to the messages on Exim's queue. They
37620 can freeze or thaw messages, cause them to be returned to their senders, remove
37621 them entirely, or modify them in various ways. In addition, admin users can run
37622 the Exim monitor and see all the information it is capable of providing, which
37623 includes the contents of files on the spool.
37624
37625 .oindex "&%-M%&"
37626 .oindex "&%-q%&"
37627 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37628 delivery of messages on its queue is restricted to admin users. This
37629 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37630 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37631 queue is also restricted to admin users. This restriction can be relaxed by
37632 setting &%no_queue_list_requires_admin%&.
37633
37634 Exim recognizes an admin user if the calling process is running as root or as
37635 the Exim user or if any of the groups associated with the calling process is
37636 the Exim group. It is not necessary actually to be running under the Exim
37637 group. However, if admin users who are not root or the Exim user are to access
37638 the contents of files on the spool via the Exim monitor (which runs
37639 unprivileged), Exim must be built to allow group read access to its spool
37640 files.
37641
37642
37643
37644 .section "Spool files" "SECID275"
37645 .cindex "spool directory" "files"
37646 Exim's spool directory and everything it contains is owned by the Exim user and
37647 set to the Exim group. The mode for spool files is defined in the
37648 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37649 any user who is a member of the Exim group can access these files.
37650
37651
37652
37653 .section "Use of argv[0]" "SECID276"
37654 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37655 of specific strings, Exim assumes certain options. For example, calling Exim
37656 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37657 to calling it with the option &%-bS%&. There are no security implications in
37658 this.
37659
37660
37661
37662 .section "Use of %f formatting" "SECID277"
37663 The only use made of &"%f"& by Exim is in formatting load average values. These
37664 are actually stored in integer variables as 1000 times the load average.
37665 Consequently, their range is limited and so therefore is the length of the
37666 converted output.
37667
37668
37669
37670 .section "Embedded Exim path" "SECID278"
37671 Exim uses its own path name, which is embedded in the code, only when it needs
37672 to re-exec in order to regain root privilege. Therefore, it is not root when it
37673 does so. If some bug allowed the path to get overwritten, it would lead to an
37674 arbitrary program's being run as exim, not as root.
37675
37676
37677
37678 .section "Dynamic module directory" "SECTdynmoddir"
37679 Any dynamically loadable modules must be installed into the directory
37680 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37681 loading it.
37682
37683
37684 .section "Use of sprintf()" "SECID279"
37685 .cindex "&[sprintf()]&"
37686 A large number of occurrences of &"sprintf"& in the code are actually calls to
37687 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37688 The intermediate formatting is done into a large fixed buffer by a function
37689 that runs through the format string itself, and checks the length of each
37690 conversion before performing it, thus preventing buffer overruns.
37691
37692 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37693 the output buffer is known to be sufficiently long to contain the converted
37694 string.
37695
37696
37697
37698 .section "Use of debug_printf() and log_write()" "SECID280"
37699 Arbitrary strings are passed to both these functions, but they do their
37700 formatting by calling the function &'string_vformat()'&, which runs through
37701 the format string itself, and checks the length of each conversion.
37702
37703
37704
37705 .section "Use of strcat() and strcpy()" "SECID281"
37706 These are used only in cases where the output buffer is known to be large
37707 enough to hold the result.
37708 .ecindex IIDsecurcon
37709
37710
37711
37712
37713 . ////////////////////////////////////////////////////////////////////////////
37714 . ////////////////////////////////////////////////////////////////////////////
37715
37716 .chapter "Format of spool files" "CHAPspool"
37717 .scindex IIDforspo1 "format" "spool files"
37718 .scindex IIDforspo2 "spool directory" "format of files"
37719 .scindex IIDforspo3 "spool files" "format of"
37720 .cindex "spool files" "editing"
37721 A message on Exim's queue consists of two files, whose names are the message id
37722 followed by -D and -H, respectively. The data portion of the message is kept in
37723 the -D file on its own. The message's envelope, status, and headers are all
37724 kept in the -H file, whose format is described in this chapter. Each of these
37725 two files contains the final component of its own name as its first line. This
37726 is insurance against disk crashes where the directory is lost but the files
37727 themselves are recoverable.
37728
37729 Some people are tempted into editing -D files in order to modify messages. You
37730 need to be extremely careful if you do this; it is not recommended and you are
37731 on your own if you do it. Here are some of the pitfalls:
37732
37733 .ilist
37734 You must ensure that Exim does not try to deliver the message while you are
37735 fiddling with it. The safest way is to take out a write lock on the -D file,
37736 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37737 place, the lock will be retained. If you write a new file and rename it, the
37738 lock will be lost at the instant of rename.
37739 .next
37740 .vindex "&$body_linecount$&"
37741 If you change the number of lines in the file, the value of
37742 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37743 present, this value is not used by Exim, but there is no guarantee that this
37744 will always be the case.
37745 .next
37746 If the message is in MIME format, you must take care not to break it.
37747 .next
37748 If the message is cryptographically signed, any change will invalidate the
37749 signature.
37750 .endlist
37751 All in all, modifying -D files is fraught with danger.
37752
37753 Files whose names end with -J may also be seen in the &_input_& directory (or
37754 its subdirectories when &%split_spool_directory%& is set). These are journal
37755 files, used to record addresses to which the message has been delivered during
37756 the course of a delivery attempt. If there are still undelivered recipients at
37757 the end, the -H file is updated, and the -J file is deleted. If, however, there
37758 is some kind of crash (for example, a power outage) before this happens, the -J
37759 file remains in existence. When Exim next processes the message, it notices the
37760 -J file and uses it to update the -H file before starting the next delivery
37761 attempt.
37762
37763 .section "Format of the -H file" "SECID282"
37764 .cindex "uid (user id)" "in spool file"
37765 .cindex "gid (group id)" "in spool file"
37766 The second line of the -H file contains the login name for the uid of the
37767 process that called Exim to read the message, followed by the numerical uid and
37768 gid. For a locally generated message, this is normally the user who sent the
37769 message. For a message received over TCP/IP via the daemon, it is
37770 normally the Exim user.
37771
37772 The third line of the file contains the address of the message's sender as
37773 transmitted in the envelope, contained in angle brackets. The sender address is
37774 empty for bounce messages. For incoming SMTP mail, the sender address is given
37775 in the MAIL command. For locally generated mail, the sender address is
37776 created by Exim from the login name of the current user and the configured
37777 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37778 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37779 &"<>"& or an address that matches &%untrusted_set_senders%&.
37780
37781 The fourth line contains two numbers. The first is the time that the message
37782 was received, in the conventional Unix form &-- the number of seconds since the
37783 start of the epoch. The second number is a count of the number of messages
37784 warning of delayed delivery that have been sent to the sender.
37785
37786 There follow a number of lines starting with a hyphen. These can appear in any
37787 order, and are omitted when not relevant:
37788
37789 .vlist
37790 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37791 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37792 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37793 recognized, to provide backward compatibility. In the old format, a line of
37794 this form is present for every ACL variable that is not empty. The number
37795 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37796 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37797 the data string for the variable. The string itself starts at the beginning of
37798 the next line, and is followed by a newline character. It may contain internal
37799 newlines.
37800
37801 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37802 A line of this form is present for every ACL connection variable that is
37803 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37804 The length is the length of the data string for the variable. The string itself
37805 starts at the beginning of the next line, and is followed by a newline
37806 character. It may contain internal newlines.
37807
37808 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37809 A line of this form is present for every ACL message variable that is defined.
37810 Note that there is a space between &%-aclm%& and the rest of the name. The
37811 length is the length of the data string for the variable. The string itself
37812 starts at the beginning of the next line, and is followed by a newline
37813 character. It may contain internal newlines.
37814
37815 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37816 This is present if, when the message was received over SMTP, the value of
37817 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37818
37819 .vitem &%-allow_unqualified_recipient%&
37820 This is present if unqualified recipient addresses are permitted in header
37821 lines (to stop such addresses from being qualified if rewriting occurs at
37822 transport time). Local messages that were input using &%-bnq%& and remote
37823 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37824
37825 .vitem &%-allow_unqualified_sender%&
37826 This is present if unqualified sender addresses are permitted in header lines
37827 (to stop such addresses from being qualified if rewriting occurs at transport
37828 time). Local messages that were input using &%-bnq%& and remote messages from
37829 hosts that match &%sender_unqualified_hosts%& set this flag.
37830
37831 .vitem "&%-auth_id%&&~<&'text'&>"
37832 The id information for a message received on an authenticated SMTP connection
37833 &-- the value of the &$authenticated_id$& variable.
37834
37835 .vitem "&%-auth_sender%&&~<&'address'&>"
37836 The address of an authenticated sender &-- the value of the
37837 &$authenticated_sender$& variable.
37838
37839 .vitem "&%-body_linecount%&&~<&'number'&>"
37840 This records the number of lines in the body of the message, and is always
37841 present.
37842
37843 .vitem "&%-body_zerocount%&&~<&'number'&>"
37844 This records the number of binary zero bytes in the body of the message, and is
37845 present if the number is greater than zero.
37846
37847 .vitem &%-deliver_firsttime%&
37848 This is written when a new message is first added to the spool. When the spool
37849 file is updated after a deferral, it is omitted.
37850
37851 .vitem "&%-frozen%&&~<&'time'&>"
37852 .cindex "frozen messages" "spool data"
37853 The message is frozen, and the freezing happened at <&'time'&>.
37854
37855 .vitem "&%-helo_name%&&~<&'text'&>"
37856 This records the host name as specified by a remote host in a HELO or EHLO
37857 command.
37858
37859 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37860 This records the IP address of the host from which the message was received and
37861 the remote port number that was used. It is omitted for locally generated
37862 messages.
37863
37864 .vitem "&%-host_auth%&&~<&'text'&>"
37865 If the message was received on an authenticated SMTP connection, this records
37866 the name of the authenticator &-- the value of the
37867 &$sender_host_authenticated$& variable.
37868
37869 .vitem &%-host_lookup_failed%&
37870 This is present if an attempt to look up the sending host's name from its IP
37871 address failed. It corresponds to the &$host_lookup_failed$& variable.
37872
37873 .vitem "&%-host_name%&&~<&'text'&>"
37874 .cindex "reverse DNS lookup"
37875 .cindex "DNS" "reverse lookup"
37876 This records the name of the remote host from which the message was received,
37877 if the host name was looked up from the IP address when the message was being
37878 received. It is not present if no reverse lookup was done.
37879
37880 .vitem "&%-ident%&&~<&'text'&>"
37881 For locally submitted messages, this records the login of the originating user,
37882 unless it was a trusted user and the &%-oMt%& option was used to specify an
37883 ident value. For messages received over TCP/IP, this records the ident string
37884 supplied by the remote host, if any.
37885
37886 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37887 This records the IP address of the local interface and the port number through
37888 which a message was received from a remote host. It is omitted for locally
37889 generated messages.
37890
37891 .vitem &%-local%&
37892 The message is from a local sender.
37893
37894 .vitem &%-localerror%&
37895 The message is a locally-generated bounce message.
37896
37897 .vitem "&%-local_scan%&&~<&'string'&>"
37898 This records the data string that was returned by the &[local_scan()]& function
37899 when the message was received &-- the value of the &$local_scan_data$&
37900 variable. It is omitted if no data was returned.
37901
37902 .vitem &%-manual_thaw%&
37903 The message was frozen but has been thawed manually, that is, by an explicit
37904 Exim command rather than via the auto-thaw process.
37905
37906 .vitem &%-N%&
37907 A testing delivery process was started using the &%-N%& option to suppress any
37908 actual deliveries, but delivery was deferred. At any further delivery attempts,
37909 &%-N%& is assumed.
37910
37911 .vitem &%-received_protocol%&
37912 This records the value of the &$received_protocol$& variable, which contains
37913 the name of the protocol by which the message was received.
37914
37915 .vitem &%-sender_set_untrusted%&
37916 The envelope sender of this message was set by an untrusted local caller (used
37917 to ensure that the caller is displayed in queue listings).
37918
37919 .vitem "&%-spam_score_int%&&~<&'number'&>"
37920 If a message was scanned by SpamAssassin, this is present. It records the value
37921 of &$spam_score_int$&.
37922
37923 .vitem &%-tls_certificate_verified%&
37924 A TLS certificate was received from the client that sent this message, and the
37925 certificate was verified by the server.
37926
37927 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37928 When the message was received over an encrypted connection, this records the
37929 name of the cipher suite that was used.
37930
37931 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37932 When the message was received over an encrypted connection, and a certificate
37933 was received from the client, this records the Distinguished Name from that
37934 certificate.
37935 .endlist
37936
37937 Following the options there is a list of those addresses to which the message
37938 is not to be delivered. This set of addresses is initialized from the command
37939 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37940 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37941 the address is added to this set. The addresses are kept internally as a
37942 balanced binary tree, and it is a representation of that tree which is written
37943 to the spool file. If an address is expanded via an alias or forward file, the
37944 original address is added to the tree when deliveries to all its child
37945 addresses are complete.
37946
37947 If the tree is empty, there is a single line in the spool file containing just
37948 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37949 Y or N, followed by an address. The address is the value for the node of the
37950 tree, and the letters indicate whether the node has a left branch and/or a
37951 right branch attached to it, respectively. If branches exist, they immediately
37952 follow. Here is an example of a three-node tree:
37953 .code
37954 YY darcy@austen.fict.example
37955 NN alice@wonderland.fict.example
37956 NN editor@thesaurus.ref.example
37957 .endd
37958 After the non-recipients tree, there is a list of the message's recipients.
37959 This is a simple list, preceded by a count. It includes all the original
37960 recipients of the message, including those to whom the message has already been
37961 delivered. In the simplest case, the list contains one address per line. For
37962 example:
37963 .code
37964 4
37965 editor@thesaurus.ref.example
37966 darcy@austen.fict.example
37967 rdo@foundation
37968 alice@wonderland.fict.example
37969 .endd
37970 However, when a child address has been added to the top-level addresses as a
37971 result of the use of the &%one_time%& option on a &(redirect)& router, each
37972 line is of the following form:
37973 .display
37974 <&'top-level address'&> <&'errors_to address'&> &&&
37975   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37976 .endd
37977 The 01 flag bit indicates the presence of the three other fields that follow
37978 the top-level address. Other bits may be used in future to support additional
37979 fields. The <&'parent number'&> is the offset in the recipients list of the
37980 original parent of the &"one time"& address. The first two fields are the
37981 envelope sender that is associated with this address and its length. If the
37982 length is zero, there is no special envelope sender (there are then two space
37983 characters in the line). A non-empty field can arise from a &(redirect)& router
37984 that has an &%errors_to%& setting.
37985
37986
37987 A blank line separates the envelope and status information from the headers
37988 which follow. A header may occupy several lines of the file, and to save effort
37989 when reading it in, each header is preceded by a number and an identifying
37990 character. The number is the number of characters in the header, including any
37991 embedded newlines and the terminating newline. The character is one of the
37992 following:
37993
37994 .table2 50pt
37995 .row <&'blank'&>         "header in which Exim has no special interest"
37996 .row &`B`&               "&'Bcc:'& header"
37997 .row &`C`&               "&'Cc:'& header"
37998 .row &`F`&               "&'From:'& header"
37999 .row &`I`&               "&'Message-id:'& header"
38000 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38001 .row &`R`&               "&'Reply-To:'& header"
38002 .row &`S`&               "&'Sender:'& header"
38003 .row &`T`&               "&'To:'& header"
38004 .row &`*`&               "replaced or deleted header"
38005 .endtable
38006
38007 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38008 purposes. They are not transmitted when the message is delivered. Here is a
38009 typical set of headers:
38010 .code
38011 111P Received: by hobbit.fict.example with local (Exim 4.00)
38012 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38013 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38014 038* X-rewrote-sender: bb@hobbit.fict.example
38015 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38016 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38017 099* To: alice@wonderland.fict.example, rdo@foundation,
38018 darcy@austen.fict.example, editor@thesaurus.ref.example
38019 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38020 darcy@austen.fict.example, editor@thesaurus.ref.example
38021 038  Date: Fri, 11 May 2001 10:28:59 +0100
38022 .endd
38023 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38024 &'To:'& header have been rewritten, the last one because routing expanded the
38025 unqualified domain &'foundation'&.
38026 .ecindex IIDforspo1
38027 .ecindex IIDforspo2
38028 .ecindex IIDforspo3
38029
38030 . ////////////////////////////////////////////////////////////////////////////
38031 . ////////////////////////////////////////////////////////////////////////////
38032
38033 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38034          "DKIM Support"
38035 .cindex "DKIM"
38036
38037 DKIM is a mechanism by which messages sent by some entity can be provably
38038 linked to a domain which that entity controls.  It permits reputation to
38039 be tracked on a per-domain basis, rather than merely upon source IP address.
38040 DKIM is documented in RFC 4871.
38041
38042 DKIM support is compiled into Exim by default if TLS support is present.
38043 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38044
38045 Exim's DKIM implementation allows to
38046 .olist
38047 Sign outgoing messages: This function is implemented in the SMTP transport.
38048 It can co-exist with all other Exim features
38049 (including transport filters)
38050 except cutthrough delivery.
38051 .next
38052 Verify signatures in incoming messages: This is implemented by an additional
38053 ACL (acl_smtp_dkim), which can be called several times per message, with
38054 different signature contexts.
38055 .endlist
38056
38057 In typical Exim style, the verification implementation does not include any
38058 default "policy". Instead it enables you to build your own policy using
38059 Exim's standard controls.
38060
38061 Please note that verification of DKIM signatures in incoming mail is turned
38062 on by default for logging purposes. For each signature in incoming email,
38063 exim will log a line displaying the most important signature details, and the
38064 signature status. Here is an example (with line-breaks added for clarity):
38065 .code
38066 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38067     d=facebookmail.com s=q1-2009b
38068     c=relaxed/relaxed a=rsa-sha1
38069     i=@facebookmail.com t=1252484542 [verification succeeded]
38070 .endd
38071 You might want to turn off DKIM verification processing entirely for internal
38072 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38073 control modifier. This should typically be done in the RCPT ACL, at points
38074 where you accept mail from relay sources (internal hosts or authenticated
38075 senders).
38076
38077
38078 .section "Signing outgoing messages" "SECDKIMSIGN"
38079 .cindex "DKIM" "signing"
38080
38081 Signing is enabled by setting private options on the SMTP transport.
38082 These options take (expandable) strings as arguments.
38083
38084 .option dkim_domain smtp string&!! unset
38085 MANDATORY:
38086 The domain you want to sign with. The result of this expanded
38087 option is put into the &%$dkim_domain%& expansion variable.
38088
38089 .option dkim_selector smtp string&!! unset
38090 MANDATORY:
38091 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38092 variable to look up a matching selector. The result is put in the expansion
38093 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38094 option along with &%$dkim_domain%&.
38095
38096 .option dkim_private_key smtp string&!! unset
38097 MANDATORY:
38098 This sets the private key to use. You can use the &%$dkim_domain%& and
38099 &%$dkim_selector%& expansion variables to determine the private key to use.
38100 The result can either
38101 .ilist
38102 be a valid RSA private key in ASCII armor, including line breaks.
38103 .next
38104 start with a slash, in which case it is treated as a file that contains
38105 the private key.
38106 .next
38107 be "0", "false" or the empty string, in which case the message will not
38108 be signed. This case will not result in an error, even if &%dkim_strict%&
38109 is set.
38110 .endlist
38111
38112 .option dkim_canon smtp string&!! unset
38113 OPTIONAL:
38114 This option sets the canonicalization method used when signing a message.
38115 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38116 The option defaults to "relaxed" when unset. Note: the current implementation
38117 only supports using the same canonicalization method for both headers and body.
38118
38119 .option dkim_strict smtp string&!! unset
38120 OPTIONAL:
38121 This  option  defines  how  Exim  behaves  when  signing a message that
38122 should be signed fails for some reason.  When the expansion evaluates to
38123 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38124 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38125 variables here.
38126
38127 .option dkim_sign_headers smtp string&!! unset
38128 OPTIONAL:
38129 When set, this option must expand to (or be specified as) a colon-separated
38130 list of header names. Headers with these names will be included in the message
38131 signature. When unspecified, the header names recommended in RFC4871 will be
38132 used.
38133
38134
38135 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38136 .cindex "DKIM" "verification"
38137
38138 Verification of DKIM signatures in SMTP incoming email is implemented via the
38139 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38140 syntactically(!) correct signature in the incoming message.
38141 A missing ACL definition defaults to accept.
38142 If any ACL call does not accept, the message is not accepted.
38143 If a cutthrough delivery was in progress for the message it is
38144 summarily dropped (having wasted the transmission effort).
38145
38146 To evaluate the signature in the ACL a large number of expansion variables
38147 containing the signature status and its details are set up during the
38148 runtime of the ACL.
38149
38150 Calling the ACL only for existing signatures is not sufficient to build
38151 more advanced policies. For that reason, the global option
38152 &%dkim_verify_signers%&, and a global expansion variable
38153 &%$dkim_signers%& exist.
38154
38155 The global option &%dkim_verify_signers%& can be set to a colon-separated
38156 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38157 called. It is expanded when the message has been received. At this point,
38158 the expansion variable &%$dkim_signers%& already contains a colon-separated
38159 list of signer domains and identities for the message. When
38160 &%dkim_verify_signers%& is not specified in the main configuration,
38161 it defaults as:
38162 .code
38163 dkim_verify_signers = $dkim_signers
38164 .endd
38165 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38166 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38167 call the ACL for known domains or identities. This would be achieved as follows:
38168 .code
38169 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38170 .endd
38171 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38172 and "ebay.com", plus all domains and identities that have signatures in the message.
38173 You can also be more creative in constructing your policy. For example:
38174 .code
38175 dkim_verify_signers = $sender_address_domain:$dkim_signers
38176 .endd
38177
38178 If a domain or identity is listed several times in the (expanded) value of
38179 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38180
38181
38182 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38183 available (from most to least important):
38184
38185
38186 .vlist
38187 .vitem &%$dkim_cur_signer%&
38188 The signer that is being evaluated in this ACL run. This can be a domain or
38189 an identity. This is one of the list items from the expanded main option
38190 &%dkim_verify_signers%& (see above).
38191 .vitem &%$dkim_verify_status%&
38192 A string describing the general status of the signature. One of
38193 .ilist
38194 &%none%&: There is no signature in the message for the current domain or
38195 identity (as reflected by &%$dkim_cur_signer%&).
38196 .next
38197 &%invalid%&: The signature could not be verified due to a processing error.
38198 More detail is available in &%$dkim_verify_reason%&.
38199 .next
38200 &%fail%&: Verification of the signature failed.  More detail is
38201 available in &%$dkim_verify_reason%&.
38202 .next
38203 &%pass%&: The signature passed verification. It is valid.
38204 .endlist
38205 .vitem &%$dkim_verify_reason%&
38206 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38207 "fail" or "invalid". One of
38208 .ilist
38209 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38210 key for the domain could not be retrieved. This may be a temporary problem.
38211 .next
38212 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38213 record for the domain is syntactically invalid.
38214 .next
38215 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38216 body hash does not match the one specified in the signature header. This
38217 means that the message body was modified in transit.
38218 .next
38219 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38220 could not be verified. This may mean that headers were modified,
38221 re-written or otherwise changed in a way which is incompatible with
38222 DKIM verification. It may of course also mean that the signature is forged.
38223 .endlist
38224 .vitem &%$dkim_domain%&
38225 The signing domain. IMPORTANT: This variable is only populated if there is
38226 an actual signature in the message for the current domain or identity (as
38227 reflected by &%$dkim_cur_signer%&).
38228 .vitem &%$dkim_identity%&
38229 The signing identity, if present. IMPORTANT: This variable is only populated
38230 if there is an actual signature in the message for the current domain or
38231 identity (as reflected by &%$dkim_cur_signer%&).
38232 .vitem &%$dkim_selector%&
38233 The key record selector string.
38234 .vitem &%$dkim_algo%&
38235 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38236 .vitem &%$dkim_canon_body%&
38237 The body canonicalization method. One of 'relaxed' or 'simple'.
38238 .vitem &%dkim_canon_headers%&
38239 The header canonicalization method. One of 'relaxed' or 'simple'.
38240 .vitem &%$dkim_copiedheaders%&
38241 A transcript of headers and their values which are included in the signature
38242 (copied from the 'z=' tag of the signature).
38243 .vitem &%$dkim_bodylength%&
38244 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38245 limit was set by the signer, "9999999999999" is returned. This makes sure
38246 that this variable always expands to an integer value.
38247 .vitem &%$dkim_created%&
38248 UNIX timestamp reflecting the date and time when the signature was created.
38249 When this was not specified by the signer, "0" is returned.
38250 .vitem &%$dkim_expires%&
38251 UNIX timestamp reflecting the date and time when the signer wants the
38252 signature to be treated as "expired". When this was not specified by the
38253 signer, "9999999999999" is returned. This makes it possible to do useful
38254 integer size comparisons against this value.
38255 .vitem &%$dkim_headernames%&
38256 A colon-separated list of names of headers included in the signature.
38257 .vitem &%$dkim_key_testing%&
38258 "1" if the key record has the "testing" flag set, "0" if not.
38259 .vitem &%$dkim_key_nosubdomains%&
38260 "1" if the key record forbids subdomaining, "0" otherwise.
38261 .vitem &%$dkim_key_srvtype%&
38262 Service type (tag s=) from the key record. Defaults to "*" if not specified
38263 in the key record.
38264 .vitem &%$dkim_key_granularity%&
38265 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38266 in the key record.
38267 .vitem &%$dkim_key_notes%&
38268 Notes from the key record (tag n=).
38269 .vitem &%$dkim_key_length%&
38270 Number of bits in the key.
38271 .endlist
38272
38273 In addition, two ACL conditions are provided:
38274
38275 .vlist
38276 .vitem &%dkim_signers%&
38277 ACL condition that checks a colon-separated list of domains or identities
38278 for a match against the domain or identity that the ACL is currently verifying
38279 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38280 verb to a group of domains or identities. For example:
38281
38282 .code
38283 # Warn when Mail purportedly from GMail has no signature at all
38284 warn log_message = GMail sender without DKIM signature
38285      sender_domains = gmail.com
38286      dkim_signers = gmail.com
38287      dkim_status = none
38288 .endd
38289
38290 .vitem &%dkim_status%&
38291 ACL condition that checks a colon-separated list of possible DKIM verification
38292 results against the actual result of verification. This is typically used
38293 to restrict an ACL verb to a list of verification outcomes, for example:
38294
38295 .code
38296 deny message = Mail from Paypal with invalid/missing signature
38297      sender_domains = paypal.com:paypal.de
38298      dkim_signers = paypal.com:paypal.de
38299      dkim_status = none:invalid:fail
38300 .endd
38301
38302 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38303 see the documentation of the &%$dkim_verify_status%& expansion variable above
38304 for more information of what they mean.
38305 .endlist
38306
38307 . ////////////////////////////////////////////////////////////////////////////
38308 . ////////////////////////////////////////////////////////////////////////////
38309
38310 .chapter "Proxies" "CHAPproxies" &&&
38311          "Proxy support"
38312 .cindex "proxy support"
38313 .cindex "proxy" "access via"
38314
38315 A proxy is an intermediate system through which communication is passed.
38316 Proxies may provide a security, availability or load-distribution function.
38317
38318
38319 .section "Inbound proxies" SECTproxyInbound
38320 .cindex proxy inbound
38321 .cindex proxy "server side"
38322 .cindex proxy "Proxy protocol"
38323 .cindex "Proxy protocol" proxy
38324
38325 Exim has support for receiving inbound SMTP connections via a proxy
38326 that uses &"Proxy Protocol"& to speak to it.
38327 To include this support, include &"SUPPORT_PROXY=yes"&
38328 in Local/Makefile.
38329
38330 It was built on specifications from:
38331 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38332 That URL was revised in May 2014 to version 2 spec:
38333 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38334
38335 The purpose of this facility is so that an application load balancer,
38336 such as HAProxy, can sit in front of several Exim servers
38337 to distribute load.
38338 Exim uses the local protocol communication with the proxy to obtain
38339 the remote SMTP system IP address and port information.
38340 There is no logging if a host passes or
38341 fails Proxy Protocol negotiation, but it can easily be determined and
38342 recorded in an ACL (example is below).
38343
38344 Use of a proxy is enabled by setting the &%hosts_proxy%&
38345 main configuration option to a hostlist; connections from these
38346 hosts will use Proxy Protocol.
38347
38348 .new
38349 The following expansion variables are usable
38350 (&"internal"& and &"external"& here refer to the interfaces
38351 of the proxy):
38352 .display
38353 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38354 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38355 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38356 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38357 &'proxy_session        '& boolean: SMTP connection via proxy
38358 .endd
38359 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38360 there was a protocol error.
38361 .wen
38362
38363 Since the real connections are all coming from the proxy, and the
38364 per host connection tracking is done before Proxy Protocol is
38365 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38366 handle all of the parallel volume you expect per inbound proxy.
38367 With the option set so high, you lose the ability
38368 to protect your server from many connections from one IP.
38369 In order to prevent your server from overload, you
38370 need to add a per connection ratelimit to your connect ACL.
38371 A possible solution is:
38372 .display
38373   # Set max number of connections per host
38374   LIMIT   = 5
38375   # Or do some kind of IP lookup in a flat file or database
38376   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38377
38378   defer   message        = Too many connections from this IP right now
38379           ratelimit      = LIMIT / 5s / per_conn / strict
38380 .endd
38381
38382
38383
38384 .section "Outbound proxies" SECTproxySOCKS
38385 .cindex proxy outbound
38386 .cindex proxy "client side"
38387 .cindex proxy SOCKS
38388 .cindex SOCKS proxy
38389 Exim has support for sending outbound SMTP via a proxy
38390 using a protocol called SOCKS5 (defined by RFC1928).
38391 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38392 Local/Makefile.
38393
38394 Use of a proxy is enabled by setting the &%socks_proxy%& option
38395 on an smtp transport.
38396 The option value is expanded and should then be a list
38397 (colon-separated by default) of proxy specifiers.
38398 Each proxy specifier is a list
38399 (space-separated by default) where the initial element
38400 is an IP address and any subsequent elements are options.
38401
38402 Options are a string <name>=<value>.
38403 The list of options is in the following table:
38404 .display
38405 &'auth   '& authentication method
38406 &'name   '& authentication username
38407 &'pass   '& authentication password
38408 &'port   '& tcp port
38409 &'tmo    '& connection timeout
38410 &'pri    '& priority
38411 &'weight '& selection bias
38412 .endd
38413
38414 More details on each of these options follows:
38415
38416 .ilist
38417 .cindex authentication "to proxy"
38418 .cindex proxy authentication
38419 &%auth%&: Either &"none"& (default) or &"name"&.
38420 Using &"name"& selects username/password authentication per RFC 1929
38421 for access to the proxy.
38422 Default is &"none"&.
38423 .next
38424 &%name%&: sets the username for the &"name"& authentication method.
38425 Default is empty.
38426 .next
38427 &%pass%&: sets the password for the &"name"& authentication method.
38428 Default is empty.
38429 .next
38430 &%port%&: the TCP port number to use for the connection to the proxy.
38431 Default is 1080.
38432 .next
38433 &%tmo%&: sets a connection timeout in seconds for this proxy.
38434 Default is 5.
38435 .next
38436 &%pri%&: specifies a priority for the proxy within the list,
38437 higher values being tried first.
38438 The default priority is 1.
38439 .next
38440 &%weight%&: specifies a selection bias.
38441 Within a priority set servers are queried in a random fashion,
38442 weighted by this value.
38443 The default value for selection bias is 1.
38444 .endlist
38445
38446 Proxies from the list are tried according to their priority
38447 and weight settings until one responds.  The timeout for the
38448 overall connection applies to the set of proxied attempts.
38449
38450 .section Logging SECTproxyLog
38451 To log the (local) IP of a proxy in the incoming or delivery logline,
38452 add &"+proxy"& to the &%log_selector%& option.
38453 This will add a component tagged with &"PRX="& to the line.
38454
38455 . ////////////////////////////////////////////////////////////////////////////
38456 . ////////////////////////////////////////////////////////////////////////////
38457
38458 .chapter "Internationalisation" "CHAPi18n" &&&
38459          "Internationalisation""
38460 .cindex internationalisation "email address"
38461 .cindex EAI
38462 .cindex i18n
38463 .cindex UTF-8 "mail name handling"
38464
38465 Exim has support for Internationalised mail names.
38466 To include this it must be built with SUPPORT_I18N and the libidn library.
38467 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38468
38469 .section "MTA operations" SECTi18nMTA
38470 .cindex SMTPUTF8 "ESMTP option"
38471 The main configuration option &%smtputf8_advertise_hosts%& specifies
38472 a host list.  If this matches the sending host and
38473 accept_8bitmime is true (the default) then the ESMTP option
38474 SMTPUTF8 will be advertised.
38475
38476 If the sender specifies the SMTPUTF8 option on a MAIL command
38477 international handling for the message is enabled and
38478 the expansion variable &$message_smtputf8$& will have value TRUE.
38479
38480 The option &%allow_utf8_domains%& is set to true for this
38481 message. All DNS lookups are converted to a-label form
38482 whatever the setting of &%allow_utf8_domains%&
38483 when Exim is built with SUPPORT_I18N.
38484
38485 Both localparts and domain are maintained as the original
38486 UTF-8 form internally; any comparison or regular-expression use will
38487 require appropriate care.  Filenames created, eg. by
38488 the appendfile transport, will have UTF-8 names.
38489
38490 HELO names sent by the smtp transport will have any UTF-8
38491 components expanded to a-label form,
38492 and any certificate name checks will be done using the a-label
38493 form of the name.
38494
38495 .cindex log protocol
38496 .cindex SMTPUTF8 logging
38497 Log lines and Received-by: header lines will acquire a "utf8"
38498 prefix on the protocol element, eg. utf8esmtp.
38499
38500 The following expansion operators can be used:
38501 .code
38502 ${utf8_domain_to_alabel:str}
38503 ${utf8_domain_from_alabel:str}
38504 ${utf8_localpart_to_alabel:str}
38505 ${utf8_localpart_from_alabel:str}
38506 .endd
38507
38508 ACLs may use the following modifier:
38509 .display
38510 control = utf8_downconvert
38511 control = utf8_downconvert/<value>
38512 .endd
38513 This sets a flag requiring that addresses are converted to
38514 a-label form before smtp delivery, for use in a
38515 Message Submission Agent context.
38516 If a value is appended it may be:
38517 .display
38518 &`1  `& (default) mandatory downconversion
38519 &`0  `& no downconversion
38520 &`-1 `& if SMTPUTF8 not supported by destination host
38521 .endd
38522
38523 If mua_wrapper is set, the utf8_downconvert control
38524 is initially set to -1.
38525
38526
38527 There is no explicit support for VRFY and EXPN.
38528 Configurations supporting these should inspect
38529 &$smtp_command_argument$& for an SMTPUTF8 argument.
38530
38531 There is no support for LMTP on Unix sockets.
38532 Using the "lmtp" protocol option on an smtp transport,
38533 for LMTP over TCP, should work as expected.
38534
38535 There is no support for DSN unitext handling,
38536 and no provision for converting logging from or to UTF-8.
38537
38538
38539
38540 .section "MDA operations" SECTi18nMDA
38541 To aid in constructing names suitable for IMAP folders
38542 the following expansion operator can be used:
38543 .code
38544 ${imapfolder {<string>} {<sep>} {<specials>}}
38545 .endd
38546
38547 The string is converted from the charset specified by
38548 the "headers charset" command (in a filter file)
38549 or &%headers_charset%& main configuration option (otherwise),
38550 to the
38551 modified UTF-7 encoding specified by RFC 2060,
38552 with the following exception: All occurences of <sep>
38553 (which has to be a single character)
38554 are replaced with periods ("."), and all periods and slashes that are not
38555 <sep> and are not in the <specials> string are BASE64 encoded.
38556
38557 The third argument can be omitted, defaulting to an empty string.
38558 The second argument can be omitted, defaulting to "/".
38559
38560 This is the encoding used by Courier for Maildir names on disk, and followed
38561 by many other IMAP servers.
38562
38563 Examples:
38564 .display
38565 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38566 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38567 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38568 .endd
38569
38570 Note that the source charset setting is vital, and also that characters
38571 must be representable in UTF-16.
38572
38573
38574 . ////////////////////////////////////////////////////////////////////////////
38575 . ////////////////////////////////////////////////////////////////////////////
38576
38577 .chapter "Events" "CHAPevents" &&&
38578          "Events"
38579 .cindex events
38580
38581 The events mechanism in Exim can be used to intercept processing at a number
38582 of points.  It was originally invented to giave a way to do customised logging
38583 actions (for example, to a database) but can also be used to modify some
38584 processing actions.
38585
38586 Most installations will never need to use Events.
38587 The support can be left out of a build by defining DISABLE_EVENT=yes
38588 in &_Local/Makefile_&.
38589
38590 There are two major classes of events: main and transport.
38591 The main configuration option &%event_action%& controls reception events;
38592 a transport option &%event_action%& controls delivery events.
38593
38594 Both options are a string which is expanded when the event fires.
38595 An example might look like:
38596 .cindex logging custom
38597 .code
38598 event_action = ${if eq {msg:delivery}{$event_name} \
38599 {${lookup pgsql {SELECT * FROM record_Delivery( \
38600     '${quote_pgsql:$sender_address_domain}',\
38601     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38602     '${quote_pgsql:$domain}', \
38603     '${quote_pgsql:${lc:$local_part}}', \
38604     '${quote_pgsql:$host_address}', \
38605     '${quote_pgsql:${lc:$host}}', \
38606     '${quote_pgsql:$message_exim_id}')}} \
38607 } {}}
38608 .endd
38609
38610 Events have names which correspond to the point in process at which they fire.
38611 The name is placed in the variable &$event_name$& and the event action
38612 expansion must check this, as it will be called for every possible event type.
38613
38614 The current list of events is:
38615 .display
38616 &`msg:complete           after    main       `& per message
38617 &`msg:delivery           after    transport  `& per recipient
38618 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38619 &`msg:rcpt:defer         after    transport  `& per recipient
38620 &`msg:host:defer         after    transport  `& per attempt
38621 &`msg:fail:delivery      after    main       `& per recipient
38622 &`msg:fail:internal      after    main       `& per recipient
38623 &`tcp:connect            before   transport  `& per connection
38624 &`tcp:close              after    transport  `& per connection
38625 &`tls:cert               before   both       `& per certificate in verification chain
38626 &`smtp:connect           after    transport  `& per connection
38627 .endd
38628 New event types may be added in future.
38629
38630 The event name is a colon-separated list, defining the type of
38631 event in a tree of possibilities.  It may be used as a list
38632 or just matched on as a whole.  There will be no spaces in the name.
38633
38634 The second column in the table above describes whether the event fires
38635 before or after the action is associates with.  Those which fire before
38636 can be used to affect that action (more on this below).
38637
38638 An additional variable, &$event_data$&, is filled with information varying
38639 with the event type:
38640 .display
38641 &`msg:delivery         `& smtp confirmation mssage
38642 &`msg:rcpt:host:defer  `& error string
38643 &`msg:rcpt:defer       `& error string
38644 &`msg:host:defer       `& error string
38645 &`tls:cert             `& verification chain depth
38646 &`smtp:connect         `& smtp banner
38647 .endd
38648
38649 The :defer events populate one extra variable: &$event_defer_errno$&.
38650
38651 For complex operations an ACL expansion can be used in &%event_action%&
38652 however due to the multiple contextx that Exim operates in during
38653 the course of its processing:
38654 .ilist
38655 variables set in transport events will not be visible outside that
38656 transport call
38657 .next
38658 acl_m variables in a server context are lost on a new connection,
38659 and after smtp helo/ehlo/mail/starttls/rset commands
38660 .endlist
38661 Using an ACL expansion with the logwrite modifier can be
38662 a useful way of writing to the main log.
38663
38664 The expansion of the event_action option should normally
38665 return an empty string.  Should it return anything else the
38666 following will be forced:
38667 .display
38668 &`msg:delivery     `&  (ignored)
38669 &`msg:host:defer   `&  (ignored)
38670 &`msg:fail:delivery`&  (ignored)
38671 &`tcp:connect      `&  do not connect
38672 &`tcp:close        `&  (ignored)
38673 &`tls:cert         `&  refuse verification
38674 &`smtp:connect     `&  close connection
38675 .endd
38676 No other use is made of the result string.
38677
38678 For a tcp:connect event, if the connection is being made to a proxy
38679 then the address and port variables will be that of the proxy and not
38680 the target system.
38681
38682 For tls:cert events, if GnuTLS is in use this will trigger only per
38683 chain element received on the connection.
38684 For OpenSSL it will trigger for every chain element including those
38685 loaded locally.
38686
38687 . ////////////////////////////////////////////////////////////////////////////
38688 . ////////////////////////////////////////////////////////////////////////////
38689
38690 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38691          "Adding drivers or lookups"
38692 .cindex "adding drivers"
38693 .cindex "new drivers, adding"
38694 .cindex "drivers" "adding new"
38695 The following actions have to be taken in order to add a new router, transport,
38696 authenticator, or lookup type to Exim:
38697
38698 .olist
38699 Choose a name for the driver or lookup type that does not conflict with any
38700 existing name; I will use &"newdriver"& in what follows.
38701 .next
38702 Add to &_src/EDITME_& the line:
38703 .display
38704 <&'type'&>&`_NEWDRIVER=yes`&
38705 .endd
38706 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38707 code is not to be included in the binary by default, comment this line out. You
38708 should also add any relevant comments about the driver or lookup type.
38709 .next
38710 Add to &_src/config.h.defaults_& the line:
38711 .code
38712 #define <type>_NEWDRIVER
38713 .endd
38714 .next
38715 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38716 and create a table entry as is done for all the other drivers and lookup types.
38717 .next
38718 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38719 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38720 Add your &`NEWDRIVER`& to that list.
38721 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38722 simple form that most lookups have.
38723 .next
38724 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38725 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38726 driver or lookup type and add it to the definition of OBJ.
38727 .next
38728 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38729 &_src_&.
38730 .next
38731 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38732 as for other drivers and lookups.
38733 .endlist
38734
38735 Then all you need to do is write the code! A good way to start is to make a
38736 proforma by copying an existing module of the same type, globally changing all
38737 occurrences of the name, and cutting out most of the code. Note that any
38738 options you create must be listed in alphabetical order, because the tables are
38739 searched using a binary chop procedure.
38740
38741 There is a &_README_& file in each of the sub-directories of &_src_& describing
38742 the interface that is expected.
38743
38744
38745
38746
38747 . ////////////////////////////////////////////////////////////////////////////
38748 . ////////////////////////////////////////////////////////////////////////////
38749
38750 . /////////////////////////////////////////////////////////////////////////////
38751 . These lines are processing instructions for the Simple DocBook Processor that
38752 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38753 . PDFs than using xmlto and fop. They will be ignored by all other XML
38754 . processors.
38755 . /////////////////////////////////////////////////////////////////////////////
38756
38757 .literal xml
38758 <?sdop
38759   format="newpage"
38760   foot_right_recto="&chaptertitle;"
38761   foot_right_verso="&chaptertitle;"
38762 ?>
38763 .literal off
38764
38765 .makeindex "Options index"   "option"
38766 .makeindex "Variables index" "variable"
38767 .makeindex "Concept index"   "concept"
38768
38769
38770 . /////////////////////////////////////////////////////////////////////////////
38771 . /////////////////////////////////////////////////////////////////////////////