Docs: fix URL
[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,
3053 using the malware scanning framework.  The option of &%av_scanner%& influences
3054 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3055 the expansion should have defaults which apply to this invocation.  ACLs are
3056 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3057 will never be populated and &%-bmalware%& will fail.
3058
3059 Exim will have changed working directory before resolving the filename, so
3060 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3061 user when it tries to open the file, rather than as the invoking user.
3062 This option requires admin privileges.
3063
3064 The &%-bmalware%& option will not be extended to be more generally useful,
3065 there are better tools for file-scanning.  This option exists to help
3066 administrators verify their Exim and AV scanner configuration.
3067
3068 .vitem &%-bnq%&
3069 .oindex "&%-bnq%&"
3070 .cindex "address qualification, suppressing"
3071 By default, Exim automatically qualifies unqualified addresses (those
3072 without domains) that appear in messages that are submitted locally (that
3073 is, not over TCP/IP). This qualification applies both to addresses in
3074 envelopes, and addresses in header lines. Sender addresses are qualified using
3075 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3076 defaults to the value of &%qualify_domain%&).
3077
3078 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3079 being used to re-submit messages that originally came from remote hosts after
3080 content scanning, you probably do not want to qualify unqualified addresses in
3081 header lines. (Such lines will be present only if you have not enabled a header
3082 syntax check in the appropriate ACL.)
3083
3084 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3085 messages that originate on the local host. When this is used, unqualified
3086 addresses in the envelope provoke errors (causing message rejection) and
3087 unqualified addresses in header lines are left alone.
3088
3089
3090 .vitem &%-bP%&
3091 .oindex "&%-bP%&"
3092 .cindex "configuration options" "extracting"
3093 .cindex "options" "configuration &-- extracting"
3094 If this option is given with no arguments, it causes the values of all Exim's
3095 main configuration options to be written to the standard output. The values
3096 of one or more specific options can be requested by giving their names as
3097 arguments, for example:
3098 .code
3099 exim -bP qualify_domain hold_domains
3100 .endd
3101 .cindex "hiding configuration option values"
3102 .cindex "configuration options" "hiding value of"
3103 .cindex "options" "hiding value of"
3104 However, any option setting that is preceded by the word &"hide"& in the
3105 configuration file is not shown in full, except to an admin user. For other
3106 users, the output is as in this example:
3107 .code
3108 mysql_servers = <value not displayable>
3109 .endd
3110 If &%config%& is given as an argument, the config is
3111 output, as it was parsed, any include file resolved, any comment removed.
3112
3113 If &%config_file%& is given as an argument, the name of the run time
3114 configuration file is output. (&%configure_file%& works too, for
3115 backward compatibility.)
3116 If a list of configuration files was supplied, the value that is output here
3117 is the name of the file that was actually used.
3118
3119 .cindex "options" "hiding name of"
3120 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3121 name will not be output.
3122
3123 .cindex "daemon" "process id (pid)"
3124 .cindex "pid (process id)" "of daemon"
3125 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3126 directories where log files and daemon pid files are written are output,
3127 respectively. If these values are unset, log files are written in a
3128 sub-directory of the spool directory called &%log%&, and the pid file is
3129 written directly into the spool directory.
3130
3131 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3132 .code
3133 exim -bP +local_domains
3134 .endd
3135 it searches for a matching named list of any type (domain, host, address, or
3136 local part) and outputs what it finds.
3137
3138 .cindex "options" "router &-- extracting"
3139 .cindex "options" "transport &-- extracting"
3140 .cindex "options" "authenticator &-- extracting"
3141 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3142 followed by the name of an appropriate driver instance, the option settings for
3143 that driver are output. For example:
3144 .code
3145 exim -bP transport local_delivery
3146 .endd
3147 The generic driver options are output first, followed by the driver's private
3148 options. A list of the names of drivers of a particular type can be obtained by
3149 using one of the words &%router_list%&, &%transport_list%&, or
3150 &%authenticator_list%&, and a complete list of all drivers with their option
3151 settings can be obtained by using &%routers%&, &%transports%&, or
3152 &%authenticators%&.
3153
3154 .cindex "environment"
3155 If &%environment%& is given as an argument, the set of environment
3156 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3157 variables.
3158
3159 .cindex "options" "macro &-- extracting"
3160 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3161 are available, similarly to the drivers.  Because macros are sometimes used
3162 for storing passwords, this option is restricted.
3163 The output format is one item per line.
3164
3165 .vitem &%-bp%&
3166 .oindex "&%-bp%&"
3167 .cindex "queue" "listing messages on"
3168 .cindex "listing" "messages on the queue"
3169 This option requests a listing of the contents of the mail queue on the
3170 standard output. If the &%-bp%& option is followed by a list of message ids,
3171 just those messages are listed. By default, this option can be used only by an
3172 admin user. However, the &%queue_list_requires_admin%& option can be set false
3173 to allow any user to see the queue.
3174
3175 Each message on the queue is displayed as in the following example:
3176 .code
3177 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3178           red.king@looking-glass.fict.example
3179           <other addresses>
3180 .endd
3181 .cindex "message" "size in queue listing"
3182 .cindex "size" "of message"
3183 The first line contains the length of time the message has been on the queue
3184 (in this case 25 minutes), the size of the message (2.9K), the unique local
3185 identifier for the message, and the message sender, as contained in the
3186 envelope. For bounce messages, the sender address is empty, and appears as
3187 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3188 the default sender address, the user's login name is shown in parentheses
3189 before the sender address.
3190
3191 .cindex "frozen messages" "in queue listing"
3192 If the message is frozen (attempts to deliver it are suspended) then the text
3193 &"*** frozen ***"& is displayed at the end of this line.
3194
3195 The recipients of the message (taken from the envelope, not the headers) are
3196 displayed on subsequent lines. Those addresses to which the message has already
3197 been delivered are marked with the letter D. If an original address gets
3198 expanded into several addresses via an alias or forward file, the original is
3199 displayed with a D only when deliveries for all of its child addresses are
3200 complete.
3201
3202
3203 .vitem &%-bpa%&
3204 .oindex "&%-bpa%&"
3205 This option operates like &%-bp%&, but in addition it shows delivered addresses
3206 that were generated from the original top level address(es) in each message by
3207 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3208 of just &"D"&.
3209
3210
3211 .vitem &%-bpc%&
3212 .oindex "&%-bpc%&"
3213 .cindex "queue" "count of messages on"
3214 This option counts the number of messages on the queue, and writes the total
3215 to the standard output. It is restricted to admin users, unless
3216 &%queue_list_requires_admin%& is set false.
3217
3218
3219 .vitem &%-bpr%&
3220 .oindex "&%-bpr%&"
3221 This option operates like &%-bp%&, but the output is not sorted into
3222 chronological order of message arrival. This can speed it up when there are
3223 lots of messages on the queue, and is particularly useful if the output is
3224 going to be post-processed in a way that doesn't need the sorting.
3225
3226 .vitem &%-bpra%&
3227 .oindex "&%-bpra%&"
3228 This option is a combination of &%-bpr%& and &%-bpa%&.
3229
3230 .vitem &%-bpru%&
3231 .oindex "&%-bpru%&"
3232 This option is a combination of &%-bpr%& and &%-bpu%&.
3233
3234
3235 .vitem &%-bpu%&
3236 .oindex "&%-bpu%&"
3237 This option operates like &%-bp%& but shows only undelivered top-level
3238 addresses for each message displayed. Addresses generated by aliasing or
3239 forwarding are not shown, unless the message was deferred after processing by a
3240 router with the &%one_time%& option set.
3241
3242
3243 .vitem &%-brt%&
3244 .oindex "&%-brt%&"
3245 .cindex "testing" "retry configuration"
3246 .cindex "retry" "configuration testing"
3247 This option is for testing retry rules, and it must be followed by up to three
3248 arguments. It causes Exim to look for a retry rule that matches the values
3249 and to write it to the standard output. For example:
3250 .code
3251 exim -brt bach.comp.mus.example
3252 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3253 .endd
3254 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3255 argument, which is required, can be a complete address in the form
3256 &'local_part@domain'&, or it can be just a domain name. If the second argument
3257 contains a dot, it is interpreted as an optional second domain name; if no
3258 retry rule is found for the first argument, the second is tried. This ties in
3259 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3260 rule is found that matches the host, one that matches the mail domain is
3261 sought. Finally, an argument that is the name of a specific delivery error, as
3262 used in setting up retry rules, can be given. For example:
3263 .code
3264 exim -brt haydn.comp.mus.example quota_3d
3265 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3266 .endd
3267
3268 .vitem &%-brw%&
3269 .oindex "&%-brw%&"
3270 .cindex "testing" "rewriting"
3271 .cindex "rewriting" "testing"
3272 This option is for testing address rewriting rules, and it must be followed by
3273 a single argument, consisting of either a local part without a domain, or a
3274 complete address with a fully qualified domain. Exim outputs how this address
3275 would be rewritten for each possible place it might appear. See chapter
3276 &<<CHAPrewrite>>& for further details.
3277
3278 .vitem &%-bS%&
3279 .oindex "&%-bS%&"
3280 .cindex "SMTP" "batched incoming"
3281 .cindex "batched SMTP input"
3282 This option is used for batched SMTP input, which is an alternative interface
3283 for non-interactive local message submission. A number of messages can be
3284 submitted in a single run. However, despite its name, this is not really SMTP
3285 input. Exim reads each message's envelope from SMTP commands on the standard
3286 input, but generates no responses. If the caller is trusted, or
3287 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3288 believed; otherwise the sender is always the caller of Exim.
3289
3290 The message itself is read from the standard input, in SMTP format (leading
3291 dots doubled), terminated by a line containing just a single dot. An error is
3292 provoked if the terminating dot is missing. A further message may then follow.
3293
3294 As for other local message submissions, the contents of incoming batch SMTP
3295 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3296 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3297 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3298
3299 Some other SMTP commands are recognized in the input. HELO and EHLO act
3300 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3301 QUIT quits, ignoring the rest of the standard input.
3302
3303 .cindex "return code" "for &%-bS%&"
3304 If any error is encountered, reports are written to the standard output and
3305 error streams, and Exim gives up immediately. The return code is 0 if no error
3306 was detected; it is 1 if one or more messages were accepted before the error
3307 was detected; otherwise it is 2.
3308
3309 More details of input using batched SMTP are given in section
3310 &<<SECTincomingbatchedSMTP>>&.
3311
3312 .vitem &%-bs%&
3313 .oindex "&%-bs%&"
3314 .cindex "SMTP" "local input"
3315 .cindex "local SMTP input"
3316 This option causes Exim to accept one or more messages by reading SMTP commands
3317 on the standard input, and producing SMTP replies on the standard output. SMTP
3318 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3319 Some user agents use this interface as a way of passing locally-generated
3320 messages to the MTA.
3321
3322 In
3323 .cindex "sender" "source of"
3324 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3325 set, the senders of messages are taken from the SMTP MAIL commands.
3326 Otherwise the content of these commands is ignored and the sender is set up as
3327 the calling user. Unqualified addresses are automatically qualified using
3328 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3329 &%-bnq%& option is used.
3330
3331 .cindex "inetd"
3332 The
3333 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3334 using a listening daemon. Exim can distinguish the two cases by checking
3335 whether the standard input is a TCP/IP socket. When Exim is called from
3336 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3337 above concerning senders and qualification do not apply. In this situation,
3338 Exim behaves in exactly the same way as it does when receiving a message via
3339 the listening daemon.
3340
3341 .vitem &%-bt%&
3342 .oindex "&%-bt%&"
3343 .cindex "testing" "addresses"
3344 .cindex "address" "testing"
3345 This option runs Exim in address testing mode, in which each argument is taken
3346 as a recipient address to be tested for deliverability. The results are
3347 written to the standard output. If a test fails, and the caller is not an admin
3348 user, no details of the failure are output, because these might contain
3349 sensitive information such as usernames and passwords for database lookups.
3350
3351 If no arguments are given, Exim runs in an interactive manner, prompting with a
3352 right angle bracket for addresses to be tested.
3353
3354 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3355 &[readline()]& function, because it is running as &'root'& and there are
3356 security issues.
3357
3358 Each address is handled as if it were the recipient address of a message
3359 (compare the &%-bv%& option). It is passed to the routers and the result is
3360 written to the standard output. However, any router that has
3361 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3362 genuine routing tests if your first router passes everything to a scanner
3363 program.
3364
3365 .cindex "return code" "for &%-bt%&"
3366 The return code is 2 if any address failed outright; it is 1 if no address
3367 failed outright but at least one could not be resolved for some reason. Return
3368 code 0 is given only when all addresses succeed.
3369
3370 .cindex "duplicate addresses"
3371 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3372 addresses after routing is complete, so that only one delivery takes place.
3373 This does not happen when testing with &%-bt%&; the full results of routing are
3374 always shown.
3375
3376 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3377 routers in the configuration makes any tests on the sender address of a
3378 message,
3379 .oindex "&%-f%&" "for address testing"
3380 you can use the &%-f%& option to set an appropriate sender when running
3381 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3382 default qualifying domain. However, if you have set up (for example) routers
3383 whose behaviour depends on the contents of an incoming message, you cannot test
3384 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3385 doing such tests.
3386
3387 .vitem &%-bV%&
3388 .oindex "&%-bV%&"
3389 .cindex "version number of Exim"
3390 This option causes Exim to write the current version number, compilation
3391 number, and compilation date of the &'exim'& binary to the standard output.
3392 It also lists the DBM library that is being used, the optional modules (such as
3393 specific lookup types), the drivers that are included in the binary, and the
3394 name of the run time configuration file that is in use.
3395
3396 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3397 configuration file. However, this is a static check only. It cannot check
3398 values that are to be expanded. For example, although a misspelt ACL verb is
3399 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3400 alone to discover (for example) all the typos in the configuration; some
3401 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3402 dynamic testing facilities.
3403
3404 .vitem &%-bv%&
3405 .oindex "&%-bv%&"
3406 .cindex "verifying address" "using &%-bv%&"
3407 .cindex "address" "verification"
3408 This option runs Exim in address verification mode, in which each argument is
3409 taken as a recipient address to be verified by the routers. (This does
3410 not involve any verification callouts). During normal operation, verification
3411 happens mostly as a consequence processing a &%verify%& condition in an ACL
3412 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3413 including callouts, see the &%-bh%& and &%-bhc%& options.
3414
3415 If verification fails, and the caller is not an admin user, no details of the
3416 failure are output, because these might contain sensitive information such as
3417 usernames and passwords for database lookups.
3418
3419 If no arguments are given, Exim runs in an interactive manner, prompting with a
3420 right angle bracket for addresses to be verified.
3421
3422 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3423 &[readline()]& function, because it is running as &'exim'& and there are
3424 security issues.
3425
3426 Verification differs from address testing (the &%-bt%& option) in that routers
3427 that have &%no_verify%& set are skipped, and if the address is accepted by a
3428 router that has &%fail_verify%& set, verification fails. The address is
3429 verified as a recipient if &%-bv%& is used; to test verification for a sender
3430 address, &%-bvs%& should be used.
3431
3432 If the &%-v%& option is not set, the output consists of a single line for each
3433 address, stating whether it was verified or not, and giving a reason in the
3434 latter case. Without &%-v%&, generating more than one address by redirection
3435 causes verification to end successfully, without considering the generated
3436 addresses. However, if just one address is generated, processing continues,
3437 and the generated address must verify successfully for the overall verification
3438 to succeed.
3439
3440 When &%-v%& is set, more details are given of how the address has been handled,
3441 and in the case of address redirection, all the generated addresses are also
3442 considered. Verification may succeed for some and fail for others.
3443
3444 The
3445 .cindex "return code" "for &%-bv%&"
3446 return code is 2 if any address failed outright; it is 1 if no address
3447 failed outright but at least one could not be resolved for some reason. Return
3448 code 0 is given only when all addresses succeed.
3449
3450 If any of the routers in the configuration makes any tests on the sender
3451 address of a message, you should use the &%-f%& option to set an appropriate
3452 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3453 calling user at the default qualifying domain.
3454
3455 .vitem &%-bvs%&
3456 .oindex "&%-bvs%&"
3457 This option acts like &%-bv%&, but verifies the address as a sender rather
3458 than a recipient address. This affects any rewriting and qualification that
3459 might happen.
3460
3461 .vitem &%-bw%&
3462 .oindex "&%-bw%&"
3463 .cindex "daemon"
3464 .cindex "inetd"
3465 .cindex "inetd" "wait mode"
3466 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3467 similarly to the &%-bd%& option.  All port specifications on the command-line
3468 and in the configuration file are ignored.  Queue-running may not be specified.
3469
3470 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3471 listening for connections.  This permits the system to start up and have
3472 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3473 each port only when the first connection is received.
3474
3475 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3476 which the daemon will exit, which should cause inetd to listen once more.
3477
3478 .vitem &%-C%&&~<&'filelist'&>
3479 .oindex "&%-C%&"
3480 .cindex "configuration file" "alternate"
3481 .cindex "CONFIGURE_FILE"
3482 .cindex "alternate configuration file"
3483 This option causes Exim to find the run time configuration file from the given
3484 list instead of from the list specified by the CONFIGURE_FILE
3485 compile-time setting. Usually, the list will consist of just a single file
3486 name, but it can be a colon-separated list of names. In this case, the first
3487 file that exists is used. Failure to open an existing file stops Exim from
3488 proceeding any further along the list, and an error is generated.
3489
3490 When this option is used by a caller other than root, and the list is different
3491 from the compiled-in list, Exim gives up its root privilege immediately, and
3492 runs with the real and effective uid and gid set to those of the caller.
3493 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3494 file contains a list of full pathnames, one per line, for configuration files
3495 which are trusted. Root privilege is retained for any configuration file so
3496 listed, as long as the caller is the Exim user (or the user specified in the
3497 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3498 not writeable by inappropriate users or groups.
3499
3500 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3501 configuration using &%-C%& right through message reception and delivery,
3502 even if the caller is root. The reception works, but by that time, Exim is
3503 running as the Exim user, so when it re-executes to regain privilege for the
3504 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3505 test reception and delivery using two separate commands (one to put a message
3506 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3507
3508 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3509 prefix string with which any file named in a &%-C%& command line option
3510 must start. In addition, the file name must not contain the sequence &`/../`&.
3511 However, if the value of the &%-C%& option is identical to the value of
3512 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3513 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3514 unset, any file name can be used with &%-C%&.
3515
3516 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3517 to a directory to which only root has access. This prevents someone who has
3518 broken into the Exim account from running a privileged Exim with an arbitrary
3519 configuration file.
3520
3521 The &%-C%& facility is useful for ensuring that configuration files are
3522 syntactically correct, but cannot be used for test deliveries, unless the
3523 caller is privileged, or unless it is an exotic configuration that does not
3524 require privilege. No check is made on the owner or group of the files
3525 specified by this option.
3526
3527
3528 .vitem &%-D%&<&'macro'&>=<&'value'&>
3529 .oindex "&%-D%&"
3530 .cindex "macro" "setting on command line"
3531 This option can be used to override macro definitions in the configuration file
3532 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3533 unprivileged caller, it causes Exim to give up its root privilege.
3534 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3535 completely disabled, and its use causes an immediate error exit.
3536
3537 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3538 colon-separated list of macros which are considered safe and, if &%-D%& only
3539 supplies macros from this list, and the values are acceptable, then Exim will
3540 not give up root privilege if the caller is root, the Exim run-time user, or
3541 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3542 to be removed in the future.  Acceptable values for the macros satisfy the
3543 regexp: &`^[A-Za-z0-9_/.-]*$`&
3544
3545 The entire option (including equals sign if present) must all be within one
3546 command line item. &%-D%& can be used to set the value of a macro to the empty
3547 string, in which case the equals sign is optional. These two commands are
3548 synonymous:
3549 .code
3550 exim -DABC  ...
3551 exim -DABC= ...
3552 .endd
3553 To include spaces in a macro definition item, quotes must be used. If you use
3554 quotes, spaces are permitted around the macro name and the equals sign. For
3555 example:
3556 .code
3557 exim '-D ABC = something' ...
3558 .endd
3559 &%-D%& may be repeated up to 10 times on a command line.
3560 Only macro names up to 22 letters long can be set.
3561
3562
3563 .vitem &%-d%&<&'debug&~options'&>
3564 .oindex "&%-d%&"
3565 .cindex "debugging" "list of selectors"
3566 .cindex "debugging" "&%-d%& option"
3567 This option causes debugging information to be written to the standard
3568 error stream. It is restricted to admin users because debugging output may show
3569 database queries that contain password information. Also, the details of users'
3570 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3571 writes an error message to the standard error stream and exits with a non-zero
3572 return code.
3573
3574 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3575 standard debugging data is output. This can be reduced, or increased to include
3576 some more rarely needed information, by directly following &%-d%& with a string
3577 made up of names preceded by plus or minus characters. These add or remove sets
3578 of debugging data, respectively. For example, &%-d+filter%& adds filter
3579 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3580 no spaces are allowed in the debug setting. The available debugging categories
3581 are:
3582 .display
3583 &`acl            `& ACL interpretation
3584 &`auth           `& authenticators
3585 &`deliver        `& general delivery logic
3586 &`dns            `& DNS lookups (see also resolver)
3587 &`dnsbl          `& DNS black list (aka RBL) code
3588 &`exec           `& arguments for &[execv()]& calls
3589 &`expand         `& detailed debugging for string expansions
3590 &`filter         `& filter handling
3591 &`hints_lookup   `& hints data lookups
3592 &`host_lookup    `& all types of name-to-IP address handling
3593 &`ident          `& ident lookup
3594 &`interface      `& lists of local interfaces
3595 &`lists          `& matching things in lists
3596 &`load           `& system load checks
3597 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3598                     &<<CHAPlocalscan>>&)
3599 &`lookup         `& general lookup code and all lookups
3600 &`memory         `& memory handling
3601 &`pid            `& add pid to debug output lines
3602 &`process_info   `& setting info for the process log
3603 &`queue_run      `& queue runs
3604 &`receive        `& general message reception logic
3605 &`resolver       `& turn on the DNS resolver's debugging output
3606 &`retry          `& retry handling
3607 &`rewrite        `& address rewriting
3608 &`route          `& address routing
3609 &`timestamp      `& add timestamp to debug output lines
3610 &`tls            `& TLS logic
3611 &`transport      `& transports
3612 &`uid            `& changes of uid/gid and looking up uid/gid
3613 &`verify         `& address verification logic
3614 &`all            `& almost all of the above (see below), and also &%-v%&
3615 .endd
3616 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3617 for &`-all`&. The reason for this is that &`+all`& is something that people
3618 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3619 is included, an awful lot of output that is very rarely of interest is
3620 generated, so it now has to be explicitly requested. However, &`-all`& does
3621 turn everything off.
3622
3623 .cindex "resolver, debugging output"
3624 .cindex "DNS resolver, debugging output"
3625 The &`resolver`& option produces output only if the DNS resolver was compiled
3626 with DEBUG enabled. This is not the case in some operating systems. Also,
3627 unfortunately, debugging output from the DNS resolver is written to stdout
3628 rather than stderr.
3629
3630 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3631 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3632 However, the &`pid`& selector is forced when debugging is turned on for a
3633 daemon, which then passes it on to any re-executed Exims. Exim also
3634 automatically adds the pid to debug lines when several remote deliveries are
3635 run in parallel.
3636
3637 The &`timestamp`& selector causes the current time to be inserted at the start
3638 of all debug output lines. This can be useful when trying to track down delays
3639 in processing.
3640
3641 If the &%debug_print%& option is set in any driver, it produces output whenever
3642 any debugging is selected, or if &%-v%& is used.
3643
3644 .vitem &%-dd%&<&'debug&~options'&>
3645 .oindex "&%-dd%&"
3646 This option behaves exactly like &%-d%& except when used on a command that
3647 starts a daemon process. In that case, debugging is turned off for the
3648 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3649 behaviour of the daemon without creating as much output as full debugging does.
3650
3651 .vitem &%-dropcr%&
3652 .oindex "&%-dropcr%&"
3653 This is an obsolete option that is now a no-op. It used to affect the way Exim
3654 handled CR and LF characters in incoming messages. What happens now is
3655 described in section &<<SECTlineendings>>&.
3656
3657 .vitem &%-E%&
3658 .oindex "&%-E%&"
3659 .cindex "bounce message" "generating"
3660 This option specifies that an incoming message is a locally-generated delivery
3661 failure report. It is used internally by Exim when handling delivery failures
3662 and is not intended for external use. Its only effect is to stop Exim
3663 generating certain messages to the postmaster, as otherwise message cascades
3664 could occur in some situations. As part of the same option, a message id may
3665 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3666 new message contains the id, following &"R="&, as a cross-reference.
3667
3668 .vitem &%-e%&&'x'&
3669 .oindex "&%-e%&&'x'&"
3670 There are a number of Sendmail options starting with &%-oe%& which seem to be
3671 called by various programs without the leading &%o%& in the option. For
3672 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3673 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3674
3675 .vitem &%-F%&&~<&'string'&>
3676 .oindex "&%-F%&"
3677 .cindex "sender" "name"
3678 .cindex "name" "of sender"
3679 This option sets the sender's full name for use when a locally-generated
3680 message is being accepted. In the absence of this option, the user's &'gecos'&
3681 entry from the password data is used. As users are generally permitted to alter
3682 their &'gecos'& entries, no security considerations are involved. White space
3683 between &%-F%& and the <&'string'&> is optional.
3684
3685 .vitem &%-f%&&~<&'address'&>
3686 .oindex "&%-f%&"
3687 .cindex "sender" "address"
3688 .cindex "address" "sender"
3689 .cindex "trusted users"
3690 .cindex "envelope sender"
3691 .cindex "user" "trusted"
3692 This option sets the address of the envelope sender of a locally-generated
3693 message (also known as the return path). The option can normally be used only
3694 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3695 users to use it.
3696
3697 Processes running as root or the Exim user are always trusted. Other
3698 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3699 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3700 of a local message is set to the caller's login name at the default qualify
3701 domain.
3702
3703 There is one exception to the restriction on the use of &%-f%&: an empty sender
3704 can be specified by any user, trusted or not, to create a message that can
3705 never provoke a bounce. An empty sender can be specified either as an empty
3706 string, or as a pair of angle brackets with nothing between them, as in these
3707 examples of shell commands:
3708 .code
3709 exim -f '<>' user@domain
3710 exim -f "" user@domain
3711 .endd
3712 In addition, the use of &%-f%& is not restricted when testing a filter file
3713 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3714 &%-bv%& options.
3715
3716 Allowing untrusted users to change the sender address does not of itself make
3717 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3718 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3719 though this can be overridden by setting &%no_local_from_check%&.
3720
3721 White
3722 .cindex "&""From""& line"
3723 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3724 given as two arguments or one combined argument). The sender of a
3725 locally-generated message can also be set (when permitted) by an initial
3726 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3727 if &%-f%& is also present, it overrides &"From&~"&.
3728
3729 .vitem &%-G%&
3730 .oindex "&%-G%&"
3731 .cindex "submission fixups, suppressing (command-line)"
3732 This option is equivalent to an ACL applying:
3733 .code
3734 control = suppress_local_fixups
3735 .endd
3736 for every message received.  Note that Sendmail will complain about such
3737 bad formatting, where Exim silently just does not fix it up.  This may change
3738 in future.
3739
3740 As this affects audit information, the caller must be a trusted user to use
3741 this option.
3742
3743 .vitem &%-h%&&~<&'number'&>
3744 .oindex "&%-h%&"
3745 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3746 This option is accepted for compatibility with Sendmail, but has no effect. (In
3747 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3748 headers.)
3749
3750 .vitem &%-i%&
3751 .oindex "&%-i%&"
3752 .cindex "Solaris" "&'mail'& command"
3753 .cindex "dot" "in incoming non-SMTP message"
3754 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3755 line by itself should not terminate an incoming, non-SMTP message. I can find
3756 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3757 command in Solaris 2.4 uses it. See also &%-ti%&.
3758
3759 .vitem &%-L%&&~<&'tag'&>
3760 .oindex "&%-L%&"
3761 .cindex "syslog" "process name; set with flag"
3762 This option is equivalent to setting &%syslog_processname%& in the config
3763 file and setting &%log_file_path%& to &`syslog`&.
3764 Its use is restricted to administrators.  The configuration file has to be
3765 read and parsed, to determine access rights, before this is set and takes
3766 effect, so early configuration file errors will not honour this flag.
3767
3768 The tag should not be longer than 32 characters.
3769
3770 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3771 .oindex "&%-M%&"
3772 .cindex "forcing delivery"
3773 .cindex "delivery" "forcing attempt"
3774 .cindex "frozen messages" "forcing delivery"
3775 This option requests Exim to run a delivery attempt on each message in turn. If
3776 any of the messages are frozen, they are automatically thawed before the
3777 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3778 and &%hold_domains%& are ignored.
3779
3780 Retry
3781 .cindex "hints database" "overriding retry hints"
3782 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3783 the normal retry time has not yet been reached. This option requires the caller
3784 to be an admin user. However, there is an option called &%prod_requires_admin%&
3785 which can be set false to relax this restriction (and also the same requirement
3786 for the &%-q%&, &%-R%&, and &%-S%& options).
3787
3788 The deliveries happen synchronously, that is, the original Exim process does
3789 not terminate until all the delivery attempts have finished. No output is
3790 produced unless there is a serious error. If you want to see what is happening,
3791 use the &%-v%& option as well, or inspect Exim's main log.
3792
3793 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3794 .oindex "&%-Mar%&"
3795 .cindex "message" "adding recipients"
3796 .cindex "recipient" "adding"
3797 This option requests Exim to add the addresses to the list of recipients of the
3798 message (&"ar"& for &"add recipients"&). The first argument must be a message
3799 id, and the remaining ones must be email addresses. However, if the message is
3800 active (in the middle of a delivery attempt), it is not altered. This option
3801 can be used only by an admin user.
3802
3803 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3804         &~<&'message&~id'&>"
3805 .oindex "&%-MC%&"
3806 .cindex "SMTP" "passed connection"
3807 .cindex "SMTP" "multiple deliveries"
3808 .cindex "multiple SMTP deliveries"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim to invoke another instance of itself to deliver a waiting message using
3811 an existing SMTP connection, which is passed as the standard input. Details are
3812 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3813 must be root or the Exim user in order to use it.
3814
3815 .vitem &%-MCA%&
3816 .oindex "&%-MCA%&"
3817 This option is not intended for use by external callers. It is used internally
3818 by Exim in conjunction with the &%-MC%& option. It signifies that the
3819 connection to the remote host has been authenticated.
3820
3821 .vitem &%-MCD%&
3822 .oindex "&%-MCD%&"
3823 This option is not intended for use by external callers. It is used internally
3824 by Exim in conjunction with the &%-MC%& option. It signifies that the
3825 remote host supports the ESMTP &_DSN_& extension.
3826
3827 .vitem &%-MCP%&
3828 .oindex "&%-MCP%&"
3829 This option is not intended for use by external callers. It is used internally
3830 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3831 which Exim is connected supports pipelining.
3832
3833 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3834 .oindex "&%-MCQ%&"
3835 This option is not intended for use by external callers. It is used internally
3836 by Exim in conjunction with the &%-MC%& option when the original delivery was
3837 started by a queue runner. It passes on the process id of the queue runner,
3838 together with the file descriptor number of an open pipe. Closure of the pipe
3839 signals the final completion of the sequence of processes that are passing
3840 messages through the same SMTP connection.
3841
3842 .vitem &%-MCS%&
3843 .oindex "&%-MCS%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3846 SMTP SIZE option should be used on messages delivered down the existing
3847 connection.
3848
3849 .vitem &%-MCT%&
3850 .oindex "&%-MCT%&"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3853 host to which Exim is connected supports TLS encryption.
3854
3855 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3856 .oindex "&%-Mc%&"
3857 .cindex "hints database" "not overridden by &%-Mc%&"
3858 .cindex "delivery" "manually started &-- not forced"
3859 This option requests Exim to run a delivery attempt on each message in turn,
3860 but unlike the &%-M%& option, it does check for retry hints, and respects any
3861 that are found. This option is not very useful to external callers. It is
3862 provided mainly for internal use by Exim when it needs to re-invoke itself in
3863 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3864 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3865 respects retry times and other options such as &%hold_domains%& that are
3866 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3867 If you want to run a specific delivery as if in a queue run, you should use
3868 &%-q%& with a message id argument. A distinction between queue run deliveries
3869 and other deliveries is made in one or two places.
3870
3871 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3872 .oindex "&%-Mes%&"
3873 .cindex "message" "changing sender"
3874 .cindex "sender" "changing"
3875 This option requests Exim to change the sender address in the message to the
3876 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3877 &"edit sender"&). There must be exactly two arguments. The first argument must
3878 be a message id, and the second one an email address. However, if the message
3879 is active (in the middle of a delivery attempt), its status is not altered.
3880 This option can be used only by an admin user.
3881
3882 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3883 .oindex "&%-Mf%&"
3884 .cindex "freezing messages"
3885 .cindex "message" "manually freezing"
3886 This option requests Exim to mark each listed message as &"frozen"&. This
3887 prevents any delivery attempts taking place until the message is &"thawed"&,
3888 either manually or as a result of the &%auto_thaw%& configuration option.
3889 However, if any of the messages are active (in the middle of a delivery
3890 attempt), their status is not altered. This option can be used only by an admin
3891 user.
3892
3893 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3894 .oindex "&%-Mg%&"
3895 .cindex "giving up on messages"
3896 .cindex "message" "abandoning delivery attempts"
3897 .cindex "delivery" "abandoning further attempts"
3898 This option requests Exim to give up trying to deliver the listed messages,
3899 including any that are frozen. However, if any of the messages are active,
3900 their status is not altered. For non-bounce messages, a delivery error message
3901 is sent to the sender, containing the text &"cancelled by administrator"&.
3902 Bounce messages are just discarded. This option can be used only by an admin
3903 user.
3904
3905 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3906 .oindex "&%-Mmad%&"
3907 .cindex "delivery" "cancelling all"
3908 This option requests Exim to mark all the recipient addresses in the messages
3909 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3910 message is active (in the middle of a delivery attempt), its status is not
3911 altered. This option can be used only by an admin user.
3912
3913 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3914 .oindex "&%-Mmd%&"
3915 .cindex "delivery" "cancelling by address"
3916 .cindex "recipient" "removing"
3917 .cindex "removing recipients"
3918 This option requests Exim to mark the given addresses as already delivered
3919 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3920 the remaining ones must be email addresses. These are matched to recipient
3921 addresses in the message in a case-sensitive manner. If the message is active
3922 (in the middle of a delivery attempt), its status is not altered. This option
3923 can be used only by an admin user.
3924
3925 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3926 .oindex "&%-Mrm%&"
3927 .cindex "removing messages"
3928 .cindex "abandoning mail"
3929 .cindex "message" "manually discarding"
3930 This option requests Exim to remove the given messages from the queue. No
3931 bounce messages are sent; each message is simply forgotten. However, if any of
3932 the messages are active, their status is not altered. This option can be used
3933 only by an admin user or by the user who originally caused the message to be
3934 placed on the queue.
3935
3936 .vitem &%-Mset%&&~<&'message&~id'&>
3937 .oindex "&%-Mset%&
3938 .cindex "testing" "string expansion"
3939 .cindex "expansion" "testing"
3940 This option is useful only in conjunction with &%-be%& (that is, when testing
3941 string expansions). Exim loads the given message from its spool before doing
3942 the test expansions, thus setting message-specific variables such as
3943 &$message_size$& and the header variables. The &$recipients$& variable is made
3944 available. This feature is provided to make it easier to test expansions that
3945 make use of these variables. However, this option can be used only by an admin
3946 user. See also &%-bem%&.
3947
3948 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3949 .oindex "&%-Mt%&"
3950 .cindex "thawing messages"
3951 .cindex "unfreezing messages"
3952 .cindex "frozen messages" "thawing"
3953 .cindex "message" "thawing frozen"
3954 This option requests Exim to &"thaw"& any of the listed messages that are
3955 &"frozen"&, so that delivery attempts can resume. However, if any of the
3956 messages are active, their status is not altered. This option can be used only
3957 by an admin user.
3958
3959 .vitem &%-Mvb%&&~<&'message&~id'&>
3960 .oindex "&%-Mvb%&"
3961 .cindex "listing" "message body"
3962 .cindex "message" "listing body of"
3963 This option causes the contents of the message body (-D) spool file to be
3964 written to the standard output. This option can be used only by an admin user.
3965
3966 .vitem &%-Mvc%&&~<&'message&~id'&>
3967 .oindex "&%-Mvc%&"
3968 .cindex "message" "listing in RFC 2822 format"
3969 .cindex "listing" "message in RFC 2822 format"
3970 This option causes a copy of the complete message (header lines plus body) to
3971 be written to the standard output in RFC 2822 format. This option can be used
3972 only by an admin user.
3973
3974 .vitem &%-Mvh%&&~<&'message&~id'&>
3975 .oindex "&%-Mvh%&"
3976 .cindex "listing" "message headers"
3977 .cindex "header lines" "listing"
3978 .cindex "message" "listing header lines"
3979 This option causes the contents of the message headers (-H) spool file to be
3980 written to the standard output. This option can be used only by an admin user.
3981
3982 .vitem &%-Mvl%&&~<&'message&~id'&>
3983 .oindex "&%-Mvl%&"
3984 .cindex "listing" "message log"
3985 .cindex "message" "listing message log"
3986 This option causes the contents of the message log spool file to be written to
3987 the standard output. This option can be used only by an admin user.
3988
3989 .vitem &%-m%&
3990 .oindex "&%-m%&"
3991 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3992 treats it that way too.
3993
3994 .vitem &%-N%&
3995 .oindex "&%-N%&"
3996 .cindex "debugging" "&%-N%& option"
3997 .cindex "debugging" "suppressing delivery"
3998 This is a debugging option that inhibits delivery of a message at the transport
3999 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4000 it just doesn't actually transport the message, but instead behaves as if it
4001 had successfully done so. However, it does not make any updates to the retry
4002 database, and the log entries for deliveries are flagged with &"*>"& rather
4003 than &"=>"&.
4004
4005 Because &%-N%& discards any message to which it applies, only root or the Exim
4006 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4007 words, an ordinary user can use it only when supplying an incoming message to
4008 which it will apply. Although transportation never fails when &%-N%& is set, an
4009 address may be deferred because of a configuration problem on a transport, or a
4010 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4011 the message, and applies to any subsequent delivery attempts that may happen
4012 for that message.
4013
4014 .vitem &%-n%&
4015 .oindex "&%-n%&"
4016 This option is interpreted by Sendmail to mean &"no aliasing"&.
4017 For normal modes of operation, it is ignored by Exim.
4018 When combined with &%-bP%& it makes the output more terse (suppresses
4019 option names, environment values and config pretty printing).
4020
4021 .vitem &%-O%&&~<&'data'&>
4022 .oindex "&%-O%&"
4023 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4024 Exim.
4025
4026 .vitem &%-oA%&&~<&'file&~name'&>
4027 .oindex "&%-oA%&"
4028 .cindex "Sendmail compatibility" "&%-oA%& option"
4029 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4030 alternative alias file name. Exim handles &%-bi%& differently; see the
4031 description above.
4032
4033 .vitem &%-oB%&&~<&'n'&>
4034 .oindex "&%-oB%&"
4035 .cindex "SMTP" "passed connection"
4036 .cindex "SMTP" "multiple deliveries"
4037 .cindex "multiple SMTP deliveries"
4038 This is a debugging option which limits the maximum number of messages that can
4039 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4040 transport. If <&'n'&> is omitted, the limit is set to 1.
4041
4042 .vitem &%-odb%&
4043 .oindex "&%-odb%&"
4044 .cindex "background delivery"
4045 .cindex "delivery" "in the background"
4046 This option applies to all modes in which Exim accepts incoming messages,
4047 including the listening daemon. It requests &"background"& delivery of such
4048 messages, which means that the accepting process automatically starts a
4049 delivery process for each message received, but does not wait for the delivery
4050 processes to finish.
4051
4052 When all the messages have been received, the reception process exits,
4053 leaving the delivery processes to finish in their own time. The standard output
4054 and error streams are closed at the start of each delivery process.
4055 This is the default action if none of the &%-od%& options are present.
4056
4057 If one of the queueing options in the configuration file
4058 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4059 overrides it if &%queue_only_override%& is set true, which is the default
4060 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4061
4062 .vitem &%-odf%&
4063 .oindex "&%-odf%&"
4064 .cindex "foreground delivery"
4065 .cindex "delivery" "in the foreground"
4066 This option requests &"foreground"& (synchronous) delivery when Exim has
4067 accepted a locally-generated message. (For the daemon it is exactly the same as
4068 &%-odb%&.) A delivery process is automatically started to deliver the message,
4069 and Exim waits for it to complete before proceeding.
4070
4071 The original Exim reception process does not finish until the delivery
4072 process for the final message has ended. The standard error stream is left open
4073 during deliveries.
4074
4075 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4076 false and one of the queueing options in the configuration file is in effect.
4077
4078 If there is a temporary delivery error during foreground delivery, the
4079 message is left on the queue for later delivery, and the original reception
4080 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4081 restricted configuration that never queues messages.
4082
4083
4084 .vitem &%-odi%&
4085 .oindex "&%-odi%&"
4086 This option is synonymous with &%-odf%&. It is provided for compatibility with
4087 Sendmail.
4088
4089 .vitem &%-odq%&
4090 .oindex "&%-odq%&"
4091 .cindex "non-immediate delivery"
4092 .cindex "delivery" "suppressing immediate"
4093 .cindex "queueing incoming messages"
4094 This option applies to all modes in which Exim accepts incoming messages,
4095 including the listening daemon. It specifies that the accepting process should
4096 not automatically start a delivery process for each message received. Messages
4097 are placed on the queue, and remain there until a subsequent queue runner
4098 process encounters them. There are several configuration options (such as
4099 &%queue_only%&) that can be used to queue incoming messages under certain
4100 conditions. This option overrides all of them and also &%-odqs%&. It always
4101 forces queueing.
4102
4103 .vitem &%-odqs%&
4104 .oindex "&%-odqs%&"
4105 .cindex "SMTP" "delaying delivery"
4106 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4107 However, like &%-odb%& and &%-odi%&, this option has no effect if
4108 &%queue_only_override%& is false and one of the queueing options in the
4109 configuration file is in effect.
4110
4111 When &%-odqs%& does operate, a delivery process is started for each incoming
4112 message, in the background by default, but in the foreground if &%-odi%& is
4113 also present. The recipient addresses are routed, and local deliveries are done
4114 in the normal way. However, if any SMTP deliveries are required, they are not
4115 done at this time, so the message remains on the queue until a subsequent queue
4116 runner process encounters it. Because routing was done, Exim knows which
4117 messages are waiting for which hosts, and so a number of messages for the same
4118 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4119 configuration option has the same effect for specific domains. See also the
4120 &%-qq%& option.
4121
4122 .vitem &%-oee%&
4123 .oindex "&%-oee%&"
4124 .cindex "error" "reporting"
4125 If an error is detected while a non-SMTP message is being received (for
4126 example, a malformed address), the error is reported to the sender in a mail
4127 message.
4128
4129 .cindex "return code" "for &%-oee%&"
4130 Provided
4131 this error message is successfully sent, the Exim receiving process
4132 exits with a return code of zero. If not, the return code is 2 if the problem
4133 is that the original message has no recipients, or 1 for any other error.
4134 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4135
4136 .vitem &%-oem%&
4137 .oindex "&%-oem%&"
4138 .cindex "error" "reporting"
4139 .cindex "return code" "for &%-oem%&"
4140 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4141 return code, whether or not the error message was successfully sent.
4142 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4143
4144 .vitem &%-oep%&
4145 .oindex "&%-oep%&"
4146 .cindex "error" "reporting"
4147 If an error is detected while a non-SMTP message is being received, the
4148 error is reported by writing a message to the standard error file (stderr).
4149 .cindex "return code" "for &%-oep%&"
4150 The return code is 1 for all errors.
4151
4152 .vitem &%-oeq%&
4153 .oindex "&%-oeq%&"
4154 .cindex "error" "reporting"
4155 This option is supported for compatibility with Sendmail, but has the same
4156 effect as &%-oep%&.
4157
4158 .vitem &%-oew%&
4159 .oindex "&%-oew%&"
4160 .cindex "error" "reporting"
4161 This option is supported for compatibility with Sendmail, but has the same
4162 effect as &%-oem%&.
4163
4164 .vitem &%-oi%&
4165 .oindex "&%-oi%&"
4166 .cindex "dot" "in incoming non-SMTP message"
4167 This option, which has the same effect as &%-i%&, specifies that a dot on a
4168 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4169 single dot does terminate, though Exim does no special processing for other
4170 lines that start with a dot. This option is set by default if Exim is called as
4171 &'rmail'&. See also &%-ti%&.
4172
4173 .vitem &%-oitrue%&
4174 .oindex "&%-oitrue%&"
4175 This option is treated as synonymous with &%-oi%&.
4176
4177 .vitem &%-oMa%&&~<&'host&~address'&>
4178 .oindex "&%-oMa%&"
4179 .cindex "sender" "host address, specifying for local message"
4180 A number of options starting with &%-oM%& can be used to set values associated
4181 with remote hosts on locally-submitted messages (that is, messages not received
4182 over TCP/IP). These options can be used by any caller in conjunction with the
4183 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4184 other circumstances, they are ignored unless the caller is trusted.
4185
4186 The &%-oMa%& option sets the sender host address. This may include a port
4187 number at the end, after a full stop (period). For example:
4188 .code
4189 exim -bs -oMa 10.9.8.7.1234
4190 .endd
4191 An alternative syntax is to enclose the IP address in square brackets,
4192 followed by a colon and the port number:
4193 .code
4194 exim -bs -oMa [10.9.8.7]:1234
4195 .endd
4196 The IP address is placed in the &$sender_host_address$& variable, and the
4197 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4198 are present on the command line, the sender host IP address is taken from
4199 whichever one is last.
4200
4201 .vitem &%-oMaa%&&~<&'name'&>
4202 .oindex "&%-oMaa%&"
4203 .cindex "authentication" "name, specifying for local message"
4204 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4205 option sets the value of &$sender_host_authenticated$& (the authenticator
4206 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4207 This option can be used with &%-bh%& and &%-bs%& to set up an
4208 authenticated SMTP session without actually using the SMTP AUTH command.
4209
4210 .vitem &%-oMai%&&~<&'string'&>
4211 .oindex "&%-oMai%&"
4212 .cindex "authentication" "id, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4214 option sets the value of &$authenticated_id$& (the id that was authenticated).
4215 This overrides the default value (the caller's login id, except with &%-bh%&,
4216 where there is no default) for messages from local sources. See chapter
4217 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4218
4219 .vitem &%-oMas%&&~<&'address'&>
4220 .oindex "&%-oMas%&"
4221 .cindex "authentication" "sender, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4223 option sets the authenticated sender value in &$authenticated_sender$&. It
4224 overrides the sender address that is created from the caller's login id for
4225 messages from local sources, except when &%-bh%& is used, when there is no
4226 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4227 specified on a MAIL command overrides this value. See chapter
4228 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4229
4230 .vitem &%-oMi%&&~<&'interface&~address'&>
4231 .oindex "&%-oMi%&"
4232 .cindex "interface" "address, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4234 option sets the IP interface address value. A port number may be included,
4235 using the same syntax as for &%-oMa%&. The interface address is placed in
4236 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4237
4238 .vitem &%-oMm%&&~<&'message&~reference'&>
4239 .oindex "&%-oMm%&"
4240 .cindex "message reference" "message reference, specifying for local message"
4241 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4242 option sets the message reference, e.g. message-id, and is logged during
4243 delivery. This is useful when some kind of audit trail is required to tie
4244 messages together. The format of the message reference is checked and will
4245 abort if the format is invalid. The option will only be accepted if exim is
4246 running in trusted mode, not as any regular user.
4247
4248 The best example of a message reference is when Exim sends a bounce message.
4249 The message reference is the message-id of the original message for which Exim
4250 is sending the bounce.
4251
4252 .vitem &%-oMr%&&~<&'protocol&~name'&>
4253 .oindex "&%-oMr%&"
4254 .cindex "protocol, specifying for local message"
4255 .vindex "&$received_protocol$&"
4256 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4257 option sets the received protocol value that is stored in
4258 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4259 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4260 SMTP protocol names (see the description of &$received_protocol$& in section
4261 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4262 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4263 be set by &%-oMr%&.
4264
4265 .vitem &%-oMs%&&~<&'host&~name'&>
4266 .oindex "&%-oMs%&"
4267 .cindex "sender" "host name, specifying for local message"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4269 option sets the sender host name in &$sender_host_name$&. When this option is
4270 present, Exim does not attempt to look up a host name from an IP address; it
4271 uses the name it is given.
4272
4273 .vitem &%-oMt%&&~<&'ident&~string'&>
4274 .oindex "&%-oMt%&"
4275 .cindex "sender" "ident string, specifying for local message"
4276 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4277 option sets the sender ident value in &$sender_ident$&. The default setting for
4278 local callers is the login id of the calling process, except when &%-bh%& is
4279 used, when there is no default.
4280
4281 .vitem &%-om%&
4282 .oindex "&%-om%&"
4283 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4284 In Sendmail, this option means &"me too"&, indicating that the sender of a
4285 message should receive a copy of the message if the sender appears in an alias
4286 expansion. Exim always does this, so the option does nothing.
4287
4288 .vitem &%-oo%&
4289 .oindex "&%-oo%&"
4290 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4291 This option is ignored. In Sendmail it specifies &"old style headers"&,
4292 whatever that means.
4293
4294 .vitem &%-oP%&&~<&'path'&>
4295 .oindex "&%-oP%&"
4296 .cindex "pid (process id)" "of daemon"
4297 .cindex "daemon" "process id (pid)"
4298 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4299 value. The option specifies the file to which the process id of the daemon is
4300 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4301 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4302 because in those cases, the normal pid file is not used.
4303
4304 .vitem &%-or%&&~<&'time'&>
4305 .oindex "&%-or%&"
4306 .cindex "timeout" "for non-SMTP input"
4307 This option sets a timeout value for incoming non-SMTP messages. If it is not
4308 set, Exim will wait forever for the standard input. The value can also be set
4309 by the &%receive_timeout%& option. The format used for specifying times is
4310 described in section &<<SECTtimeformat>>&.
4311
4312 .vitem &%-os%&&~<&'time'&>
4313 .oindex "&%-os%&"
4314 .cindex "timeout" "for SMTP input"
4315 .cindex "SMTP" "input timeout"
4316 This option sets a timeout value for incoming SMTP messages. The timeout
4317 applies to each SMTP command and block of data. The value can also be set by
4318 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4319 for specifying times is described in section &<<SECTtimeformat>>&.
4320
4321 .vitem &%-ov%&
4322 .oindex "&%-ov%&"
4323 This option has exactly the same effect as &%-v%&.
4324
4325 .vitem &%-oX%&&~<&'number&~or&~string'&>
4326 .oindex "&%-oX%&"
4327 .cindex "TCP/IP" "setting listening ports"
4328 .cindex "TCP/IP" "setting listening interfaces"
4329 .cindex "port" "receiving TCP/IP"
4330 This option is relevant only when the &%-bd%& (start listening daemon) option
4331 is also given. It controls which ports and interfaces the daemon uses. Details
4332 of the syntax, and how it interacts with configuration file options, are given
4333 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4334 file is written unless &%-oP%& is also present to specify a pid file name.
4335
4336 .vitem &%-pd%&
4337 .oindex "&%-pd%&"
4338 .cindex "Perl" "starting the interpreter"
4339 This option applies when an embedded Perl interpreter is linked with Exim (see
4340 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4341 option, forcing the starting of the interpreter to be delayed until it is
4342 needed.
4343
4344 .vitem &%-ps%&
4345 .oindex "&%-ps%&"
4346 .cindex "Perl" "starting the interpreter"
4347 This option applies when an embedded Perl interpreter is linked with Exim (see
4348 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4349 option, forcing the starting of the interpreter to occur as soon as Exim is
4350 started.
4351
4352 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4353 .oindex "&%-p%&"
4354 For compatibility with Sendmail, this option is equivalent to
4355 .display
4356 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4357 .endd
4358 It sets the incoming protocol and host name (for trusted callers). The
4359 host name and its colon can be omitted when only the protocol is to be set.
4360 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4361 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4362 or &`s`& using this option (but that does not seem a real limitation).
4363
4364 .vitem &%-q%&
4365 .oindex "&%-q%&"
4366 .cindex "queue runner" "starting manually"
4367 This option is normally restricted to admin users. However, there is a
4368 configuration option called &%prod_requires_admin%& which can be set false to
4369 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4370 and &%-S%& options).
4371
4372 .cindex "queue runner" "description of operation"
4373 The &%-q%& option starts one queue runner process. This scans the queue of
4374 waiting messages, and runs a delivery process for each one in turn. It waits
4375 for each delivery process to finish before starting the next one. A delivery
4376 process may not actually do any deliveries if the retry times for the addresses
4377 have not been reached. Use &%-qf%& (see below) if you want to override this.
4378
4379 If
4380 .cindex "SMTP" "passed connection"
4381 .cindex "SMTP" "multiple deliveries"
4382 .cindex "multiple SMTP deliveries"
4383 the delivery process spawns other processes to deliver other messages down
4384 passed SMTP connections, the queue runner waits for these to finish before
4385 proceeding.
4386
4387 When all the queued messages have been considered, the original queue runner
4388 process terminates. In other words, a single pass is made over the waiting
4389 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4390 this to be repeated periodically.
4391
4392 Exim processes the waiting messages in an unpredictable order. It isn't very
4393 random, but it is likely to be different each time, which is all that matters.
4394 If one particular message screws up a remote MTA, other messages to the same
4395 MTA have a chance of getting through if they get tried first.
4396
4397 It is possible to cause the messages to be processed in lexical message id
4398 order, which is essentially the order in which they arrived, by setting the
4399 &%queue_run_in_order%& option, but this is not recommended for normal use.
4400
4401 .vitem &%-q%&<&'qflags'&>
4402 The &%-q%& option may be followed by one or more flag letters that change its
4403 behaviour. They are all optional, but if more than one is present, they must
4404 appear in the correct order. Each flag is described in a separate item below.
4405
4406 .vitem &%-qq...%&
4407 .oindex "&%-qq%&"
4408 .cindex "queue" "double scanning"
4409 .cindex "queue" "routing"
4410 .cindex "routing" "whole queue before delivery"
4411 An option starting with &%-qq%& requests a two-stage queue run. In the first
4412 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4413 every domain. Addresses are routed, local deliveries happen, but no remote
4414 transports are run.
4415
4416 .cindex "hints database" "remembering routing"
4417 The hints database that remembers which messages are waiting for specific hosts
4418 is updated, as if delivery to those hosts had been deferred. After this is
4419 complete, a second, normal queue scan happens, with routing and delivery taking
4420 place as normal. Messages that are routed to the same host should mostly be
4421 delivered down a single SMTP
4422 .cindex "SMTP" "passed connection"
4423 .cindex "SMTP" "multiple deliveries"
4424 .cindex "multiple SMTP deliveries"
4425 connection because of the hints that were set up during the first queue scan.
4426 This option may be useful for hosts that are connected to the Internet
4427 intermittently.
4428
4429 .vitem &%-q[q]i...%&
4430 .oindex "&%-qi%&"
4431 .cindex "queue" "initial delivery"
4432 If the &'i'& flag is present, the queue runner runs delivery processes only for
4433 those messages that haven't previously been tried. (&'i'& stands for &"initial
4434 delivery"&.) This can be helpful if you are putting messages on the queue using
4435 &%-odq%& and want a queue runner just to process the new messages.
4436
4437 .vitem &%-q[q][i]f...%&
4438 .oindex "&%-qf%&"
4439 .cindex "queue" "forcing delivery"
4440 .cindex "delivery" "forcing in queue run"
4441 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4442 message, whereas without &'f'& only those non-frozen addresses that have passed
4443 their retry times are tried.
4444
4445 .vitem &%-q[q][i]ff...%&
4446 .oindex "&%-qff%&"
4447 .cindex "frozen messages" "forcing delivery"
4448 If &'ff'& is present, a delivery attempt is forced for every message, whether
4449 frozen or not.
4450
4451 .vitem &%-q[q][i][f[f]]l%&
4452 .oindex "&%-ql%&"
4453 .cindex "queue" "local deliveries only"
4454 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4455 be done. If a message requires any remote deliveries, it remains on the queue
4456 for later delivery.
4457
4458 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4459 .cindex "queue" "delivering specific messages"
4460 When scanning the queue, Exim can be made to skip over messages whose ids are
4461 lexically less than a given value by following the &%-q%& option with a
4462 starting message id. For example:
4463 .code
4464 exim -q 0t5C6f-0000c8-00
4465 .endd
4466 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4467 second message id is given, messages whose ids are lexically greater than it
4468 are also skipped. If the same id is given twice, for example,
4469 .code
4470 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4471 .endd
4472 just one delivery process is started, for that message. This differs from
4473 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4474 that it counts as a delivery from a queue run. Note that the selection
4475 mechanism does not affect the order in which the messages are scanned. There
4476 are also other ways of selecting specific sets of messages for delivery in a
4477 queue run &-- see &%-R%& and &%-S%&.
4478
4479 .vitem &%-q%&<&'qflags'&><&'time'&>
4480 .cindex "queue runner" "starting periodically"
4481 .cindex "periodic queue running"
4482 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4483 starting a queue runner process at intervals specified by the given time value
4484 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4485 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4486 single daemon process handles both functions. A common way of starting up a
4487 combined daemon at system boot time is to use a command such as
4488 .code
4489 /usr/exim/bin/exim -bd -q30m
4490 .endd
4491 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4492 process every 30 minutes.
4493
4494 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4495 pid file is written unless one is explicitly requested by the &%-oP%& option.
4496
4497 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4498 .oindex "&%-qR%&"
4499 This option is synonymous with &%-R%&. It is provided for Sendmail
4500 compatibility.
4501
4502 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4503 .oindex "&%-qS%&"
4504 This option is synonymous with &%-S%&.
4505
4506 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4507 .oindex "&%-R%&"
4508 .cindex "queue runner" "for specific recipients"
4509 .cindex "delivery" "to given domain"
4510 .cindex "domain" "delivery to"
4511 The <&'rsflags'&> may be empty, in which case the white space before the string
4512 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4513 which are the possible values for <&'rsflags'&>. White space is required if
4514 <&'rsflags'&> is not empty.
4515
4516 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4517 perform a single queue run, except that, when scanning the messages on the
4518 queue, Exim processes only those that have at least one undelivered recipient
4519 address containing the given string, which is checked in a case-independent
4520 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4521 regular expression; otherwise it is a literal string.
4522
4523 If you want to do periodic queue runs for messages with specific recipients,
4524 you can combine &%-R%& with &%-q%& and a time value. For example:
4525 .code
4526 exim -q25m -R @special.domain.example
4527 .endd
4528 This example does a queue run for messages with recipients in the given domain
4529 every 25 minutes. Any additional flags that are specified with &%-q%& are
4530 applied to each queue run.
4531
4532 Once a message is selected for delivery by this mechanism, all its addresses
4533 are processed. For the first selected message, Exim overrides any retry
4534 information and forces a delivery attempt for each undelivered address. This
4535 means that if delivery of any address in the first message is successful, any
4536 existing retry information is deleted, and so delivery attempts for that
4537 address in subsequently selected messages (which are processed without forcing)
4538 will run. However, if delivery of any address does not succeed, the retry
4539 information is updated, and in subsequently selected messages, the failing
4540 address will be skipped.
4541
4542 .cindex "frozen messages" "forcing delivery"
4543 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4544 all selected messages, not just the first; frozen messages are included when
4545 &'ff'& is present.
4546
4547 The &%-R%& option makes it straightforward to initiate delivery of all messages
4548 to a given domain after a host has been down for some time. When the SMTP
4549 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4550 effect is to run Exim with the &%-R%& option, but it can be configured to run
4551 an arbitrary command instead.
4552
4553 .vitem &%-r%&
4554 .oindex "&%-r%&"
4555 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4556
4557 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4558 .oindex "&%-S%&"
4559 .cindex "delivery" "from given sender"
4560 .cindex "queue runner" "for specific senders"
4561 This option acts like &%-R%& except that it checks the string against each
4562 message's sender instead of against the recipients. If &%-R%& is also set, both
4563 conditions must be met for a message to be selected. If either of the options
4564 has &'f'& or &'ff'& in its flags, the associated action is taken.
4565
4566 .vitem &%-Tqt%&&~<&'times'&>
4567 .oindex "&%-Tqt%&"
4568 This is an option that is exclusively for use by the Exim testing suite. It is not
4569 recognized when Exim is run normally. It allows for the setting up of explicit
4570 &"queue times"& so that various warning/retry features can be tested.
4571
4572 .vitem &%-t%&
4573 .oindex "&%-t%&"
4574 .cindex "recipient" "extracting from header lines"
4575 .cindex "&'Bcc:'& header line"
4576 .cindex "&'Cc:'& header line"
4577 .cindex "&'To:'& header line"
4578 When Exim is receiving a locally-generated, non-SMTP message on its standard
4579 input, the &%-t%& option causes the recipients of the message to be obtained
4580 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4581 from the command arguments. The addresses are extracted before any rewriting
4582 takes place and the &'Bcc:'& header line, if present, is then removed.
4583
4584 .cindex "Sendmail compatibility" "&%-t%& option"
4585 If the command has any arguments, they specify addresses to which the message
4586 is &'not'& to be delivered. That is, the argument addresses are removed from
4587 the recipients list obtained from the headers. This is compatible with Smail 3
4588 and in accordance with the documented behaviour of several versions of
4589 Sendmail, as described in man pages on a number of operating systems (e.g.
4590 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4591 argument addresses to those obtained from the headers, and the O'Reilly
4592 Sendmail book documents it that way. Exim can be made to add argument addresses
4593 instead of subtracting them by setting the option
4594 &%extract_addresses_remove_arguments%& false.
4595
4596 .cindex "&%Resent-%& header lines" "with &%-t%&"
4597 If there are any &%Resent-%& header lines in the message, Exim extracts
4598 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4599 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4600 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4601 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4602
4603 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4604 message is resent several times). The RFC also specifies that they should be
4605 added at the front of the message, and separated by &'Received:'& lines. It is
4606 not at all clear how &%-t%& should operate in the present of multiple sets,
4607 nor indeed exactly what constitutes a &"set"&.
4608 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4609 are often added at the end of the header, and if a message is resent more than
4610 once, it is common for the original set of &%Resent-%& headers to be renamed as
4611 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4612
4613 .vitem &%-ti%&
4614 .oindex "&%-ti%&"
4615 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4616 compatibility with Sendmail.
4617
4618 .vitem &%-tls-on-connect%&
4619 .oindex "&%-tls-on-connect%&"
4620 .cindex "TLS" "use without STARTTLS"
4621 .cindex "TLS" "automatic start"
4622 This option is available when Exim is compiled with TLS support. It forces all
4623 incoming SMTP connections to behave as if the incoming port is listed in the
4624 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4625 &<<CHAPTLS>>& for further details.
4626
4627
4628 .vitem &%-U%&
4629 .oindex "&%-U%&"
4630 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4631 Sendmail uses this option for &"initial message submission"&, and its
4632 documentation states that in future releases, it may complain about
4633 syntactically invalid messages rather than fixing them when this flag is not
4634 set. Exim ignores this option.
4635
4636 .vitem &%-v%&
4637 .oindex "&%-v%&"
4638 This option causes Exim to write information to the standard error stream,
4639 describing what it is doing. In particular, it shows the log lines for
4640 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4641 dialogue is shown. Some of the log lines shown may not actually be written to
4642 the log if the setting of &%log_selector%& discards them. Any relevant
4643 selectors are shown with each log line. If none are shown, the logging is
4644 unconditional.
4645
4646 .vitem &%-x%&
4647 .oindex "&%-x%&"
4648 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4649 National Language Support extended characters in the body of the mail item"&).
4650 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4651 this option.
4652
4653 .vitem &%-X%&&~<&'logfile'&>
4654 .oindex "&%-X%&"
4655 This option is interpreted by Sendmail to cause debug information to be sent
4656 to the named file.  It is ignored by Exim.
4657
4658 .vitem &%-z%&&~<&'log-line'&>
4659 .oindex "&%-z%&"
4660 This option writes its argument to Exim's logfile.
4661 Use is restricted to administrators; the intent is for operational notes.
4662 Quotes should be used to maintain a multi-word item as a single argument,
4663 under most shells.
4664 .endlist
4665
4666 .ecindex IIDclo1
4667 .ecindex IIDclo2
4668
4669
4670 . ////////////////////////////////////////////////////////////////////////////
4671 . Insert a stylized DocBook comment here, to identify the end of the command
4672 . line options. This is for the benefit of the Perl script that automatically
4673 . creates a man page for the options.
4674 . ////////////////////////////////////////////////////////////////////////////
4675
4676 .literal xml
4677 <!-- === End of command line options === -->
4678 .literal off
4679
4680
4681
4682
4683
4684 . ////////////////////////////////////////////////////////////////////////////
4685 . ////////////////////////////////////////////////////////////////////////////
4686
4687
4688 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4689          "The runtime configuration file"
4690
4691 .cindex "run time configuration"
4692 .cindex "configuration file" "general description"
4693 .cindex "CONFIGURE_FILE"
4694 .cindex "configuration file" "errors in"
4695 .cindex "error" "in configuration file"
4696 .cindex "return code" "for bad configuration"
4697 Exim uses a single run time configuration file that is read whenever an Exim
4698 binary is executed. Note that in normal operation, this happens frequently,
4699 because Exim is designed to operate in a distributed manner, without central
4700 control.
4701
4702 If a syntax error is detected while reading the configuration file, Exim
4703 writes a message on the standard error, and exits with a non-zero return code.
4704 The message is also written to the panic log. &*Note*&: Only simple syntax
4705 errors can be detected at this time. The values of any expanded options are
4706 not checked until the expansion happens, even when the expansion does not
4707 actually alter the string.
4708
4709 The name of the configuration file is compiled into the binary for security
4710 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4711 most configurations, this specifies a single file. However, it is permitted to
4712 give a colon-separated list of file names, in which case Exim uses the first
4713 existing file in the list.
4714
4715 .cindex "EXIM_USER"
4716 .cindex "EXIM_GROUP"
4717 .cindex "CONFIGURE_OWNER"
4718 .cindex "CONFIGURE_GROUP"
4719 .cindex "configuration file" "ownership"
4720 .cindex "ownership" "configuration file"
4721 The run time configuration file must be owned by root or by the user that is
4722 specified at compile time by the CONFIGURE_OWNER option (if set). The
4723 configuration file must not be world-writeable, or group-writeable unless its
4724 group is the root group or the one specified at compile time by the
4725 CONFIGURE_GROUP option.
4726
4727 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4728 to root, anybody who is able to edit the run time configuration file has an
4729 easy way to run commands as root. If you specify a user or group in the
4730 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4731 who are members of that group will trivially be able to obtain root privileges.
4732
4733 Up to Exim version 4.72, the run time configuration file was also permitted to
4734 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4735 since it offered a simple privilege escalation for any attacker who managed to
4736 compromise the Exim user account.
4737
4738 A default configuration file, which will work correctly in simple situations,
4739 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4740 defines just one file name, the installation process copies the default
4741 configuration to a new file of that name if it did not previously exist. If
4742 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4743 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4744 configuration.
4745
4746
4747
4748 .section "Using a different configuration file" "SECID40"
4749 .cindex "configuration file" "alternate"
4750 A one-off alternate configuration can be specified by the &%-C%& command line
4751 option, which may specify a single file or a list of files. However, when
4752 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4753 unless the argument for &%-C%& is identical to the built-in value from
4754 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4755 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4756 is useful mainly for checking the syntax of configuration files before
4757 installing them. No owner or group checks are done on a configuration file
4758 specified by &%-C%&, if root privilege has been dropped.
4759
4760 Even the Exim user is not trusted to specify an arbitrary configuration file
4761 with the &%-C%& option to be used with root privileges, unless that file is
4762 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4763 testing a configuration using &%-C%& right through message reception and
4764 delivery, even if the caller is root. The reception works, but by that time,
4765 Exim is running as the Exim user, so when it re-execs to regain privilege for
4766 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4767 can test reception and delivery using two separate commands (one to put a
4768 message on the queue, using &%-odq%&, and another to do the delivery, using
4769 &%-M%&).
4770
4771 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4772 prefix string with which any file named in a &%-C%& command line option must
4773 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4774 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4775 name can be used with &%-C%&.
4776
4777 One-off changes to a configuration can be specified by the &%-D%& command line
4778 option, which defines and overrides values for macros used inside the
4779 configuration file. However, like &%-C%&, the use of this option by a
4780 non-privileged user causes Exim to discard its root privilege.
4781 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4782 completely disabled, and its use causes an immediate error exit.
4783
4784 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4785 to declare certain macro names trusted, such that root privilege will not
4786 necessarily be discarded.
4787 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4788 considered safe and, if &%-D%& only supplies macros from this list, and the
4789 values are acceptable, then Exim will not give up root privilege if the caller
4790 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4791 transition mechanism and is expected to be removed in the future.  Acceptable
4792 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4793
4794 Some sites may wish to use the same Exim binary on different machines that
4795 share a file system, but to use different configuration files on each machine.
4796 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4797 looks for a file whose name is the configuration file name followed by a dot
4798 and the machine's node name, as obtained from the &[uname()]& function. If this
4799 file does not exist, the standard name is tried. This processing occurs for
4800 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4801
4802 In some esoteric situations different versions of Exim may be run under
4803 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4804 help with this. See the comments in &_src/EDITME_& for details.
4805
4806
4807
4808 .section "Configuration file format" "SECTconffilfor"
4809 .cindex "configuration file" "format of"
4810 .cindex "format" "configuration file"
4811 Exim's configuration file is divided into a number of different parts. General
4812 option settings must always appear at the start of the file. The other parts
4813 are all optional, and may appear in any order. Each part other than the first
4814 is introduced by the word &"begin"& followed by at least one literal
4815 space, and the name of the part. The optional parts are:
4816
4817 .ilist
4818 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4819 &<<CHAPACL>>&).
4820 .next
4821 .cindex "AUTH" "configuration"
4822 &'authenticators'&: Configuration settings for the authenticator drivers. These
4823 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4824 .next
4825 &'routers'&: Configuration settings for the router drivers. Routers process
4826 addresses and determine how the message is to be delivered (see chapters
4827 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4828 .next
4829 &'transports'&: Configuration settings for the transport drivers. Transports
4830 define mechanisms for copying messages to destinations (see chapters
4831 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4832 .next
4833 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4834 If there is no retry section, or if it is empty (that is, no retry rules are
4835 defined), Exim will not retry deliveries. In this situation, temporary errors
4836 are treated the same as permanent errors. Retry rules are discussed in chapter
4837 &<<CHAPretry>>&.
4838 .next
4839 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4840 when new addresses are generated during delivery. Rewriting is discussed in
4841 chapter &<<CHAPrewrite>>&.
4842 .next
4843 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4844 want to use this feature, you must set
4845 .code
4846 LOCAL_SCAN_HAS_OPTIONS=yes
4847 .endd
4848 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4849 facility are given in chapter &<<CHAPlocalscan>>&.
4850 .endlist
4851
4852 .cindex "configuration file" "leading white space in"
4853 .cindex "configuration file" "trailing white space in"
4854 .cindex "white space" "in configuration file"
4855 Leading and trailing white space in configuration lines is always ignored.
4856
4857 Blank lines in the file, and lines starting with a # character (ignoring
4858 leading white space) are treated as comments and are ignored. &*Note*&: A
4859 # character other than at the beginning of a line is not treated specially,
4860 and does not introduce a comment.
4861
4862 Any non-comment line can be continued by ending it with a backslash. Note that
4863 the general rule for white space means that trailing white space after the
4864 backslash and leading white space at the start of continuation
4865 lines is ignored. Comment lines beginning with # (but not empty lines) may
4866 appear in the middle of a sequence of continuation lines.
4867
4868 A convenient way to create a configuration file is to start from the
4869 default, which is supplied in &_src/configure.default_&, and add, delete, or
4870 change settings as required.
4871
4872 The ACLs, retry rules, and rewriting rules have their own syntax which is
4873 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4874 respectively. The other parts of the configuration file have some syntactic
4875 items in common, and these are described below, from section &<<SECTcos>>&
4876 onwards. Before that, the inclusion, macro, and conditional facilities are
4877 described.
4878
4879
4880
4881 .section "File inclusions in the configuration file" "SECID41"
4882 .cindex "inclusions in configuration file"
4883 .cindex "configuration file" "including other files"
4884 .cindex "&`.include`& in configuration file"
4885 .cindex "&`.include_if_exists`& in configuration file"
4886 You can include other files inside Exim's run time configuration file by
4887 using this syntax:
4888 .display
4889 &`.include`& <&'file name'&>
4890 &`.include_if_exists`& <&'file name'&>
4891 .endd
4892 on a line by itself. Double quotes round the file name are optional. If you use
4893 the first form, a configuration error occurs if the file does not exist; the
4894 second form does nothing for non-existent files. In all cases, an absolute file
4895 name is required.
4896
4897 Includes may be nested to any depth, but remember that Exim reads its
4898 configuration file often, so it is a good idea to keep them to a minimum.
4899 If you change the contents of an included file, you must HUP the daemon,
4900 because an included file is read only when the configuration itself is read.
4901
4902 The processing of inclusions happens early, at a physical line level, so, like
4903 comment lines, an inclusion can be used in the middle of an option setting,
4904 for example:
4905 .code
4906 hosts_lookup = a.b.c \
4907                .include /some/file
4908 .endd
4909 Include processing happens after macro processing (see below). Its effect is to
4910 process the lines of the included file as if they occurred inline where the
4911 inclusion appears.
4912
4913
4914
4915 .section "Macros in the configuration file" "SECTmacrodefs"
4916 .cindex "macro" "description of"
4917 .cindex "configuration file" "macros"
4918 If a line in the main part of the configuration (that is, before the first
4919 &"begin"& line) begins with an upper case letter, it is taken as a macro
4920 definition, and must be of the form
4921 .display
4922 <&'name'&> = <&'rest of line'&>
4923 .endd
4924 The name must consist of letters, digits, and underscores, and need not all be
4925 in upper case, though that is recommended. The rest of the line, including any
4926 continuations, is the replacement text, and has leading and trailing white
4927 space removed. Quotes are not removed. The replacement text can never end with
4928 a backslash character, but this doesn't seem to be a serious limitation.
4929
4930 Macros may also be defined between router, transport, authenticator, or ACL
4931 definitions. They may not, however, be defined within an individual driver or
4932 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4933
4934 .section "Macro substitution" "SECID42"
4935 Once a macro is defined, all subsequent lines in the file (and any included
4936 files) are scanned for the macro name; if there are several macros, the line is
4937 scanned for each in turn, in the order in which the macros are defined. The
4938 replacement text is not re-scanned for the current macro, though it is scanned
4939 for subsequently defined macros. For this reason, a macro name may not contain
4940 the name of a previously defined macro as a substring. You could, for example,
4941 define
4942 .display
4943 &`ABCD_XYZ = `&<&'something'&>
4944 &`ABCD = `&<&'something else'&>
4945 .endd
4946 but putting the definitions in the opposite order would provoke a configuration
4947 error. Macro expansion is applied to individual physical lines from the file,
4948 before checking for line continuation or file inclusion (see above). If a line
4949 consists solely of a macro name, and the expansion of the macro is empty, the
4950 line is ignored. A macro at the start of a line may turn the line into a
4951 comment line or a &`.include`& line.
4952
4953
4954 .section "Redefining macros" "SECID43"
4955 Once defined, the value of a macro can be redefined later in the configuration
4956 (or in an included file). Redefinition is specified by using &'=='& instead of
4957 &'='&. For example:
4958 .code
4959 MAC =  initial value
4960 ...
4961 MAC == updated value
4962 .endd
4963 Redefinition does not alter the order in which the macros are applied to the
4964 subsequent lines of the configuration file. It is still the same order in which
4965 the macros were originally defined. All that changes is the macro's value.
4966 Redefinition makes it possible to accumulate values. For example:
4967 .code
4968 MAC =  initial value
4969 ...
4970 MAC == MAC and something added
4971 .endd
4972 This can be helpful in situations where the configuration file is built
4973 from a number of other files.
4974
4975 .section "Overriding macro values" "SECID44"
4976 The values set for macros in the configuration file can be overridden by the
4977 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4978 used, unless called by root or the Exim user. A definition on the command line
4979 using the &%-D%& option causes all definitions and redefinitions within the
4980 file to be ignored.
4981
4982
4983
4984 .section "Example of macro usage" "SECID45"
4985 As an example of macro usage, consider a configuration where aliases are looked
4986 up in a MySQL database. It helps to keep the file less cluttered if long
4987 strings such as SQL statements are defined separately as macros, for example:
4988 .code
4989 ALIAS_QUERY = select mailbox from user where \
4990               login='${quote_mysql:$local_part}';
4991 .endd
4992 This can then be used in a &(redirect)& router setting like this:
4993 .code
4994 data = ${lookup mysql{ALIAS_QUERY}}
4995 .endd
4996 In earlier versions of Exim macros were sometimes used for domain, host, or
4997 address lists. In Exim 4 these are handled better by named lists &-- see
4998 section &<<SECTnamedlists>>&.
4999
5000
5001 .section "Conditional skips in the configuration file" "SECID46"
5002 .cindex "configuration file" "conditional skips"
5003 .cindex "&`.ifdef`&"
5004 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5005 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5006 portions of the configuration file. The processing happens whenever the file is
5007 read (that is, when an Exim binary starts to run).
5008
5009 The implementation is very simple. Instances of the first four directives must
5010 be followed by text that includes the names of one or macros. The condition
5011 that is tested is whether or not any macro substitution has taken place in the
5012 line. Thus:
5013 .code
5014 .ifdef AAA
5015 message_size_limit = 50M
5016 .else
5017 message_size_limit = 100M
5018 .endif
5019 .endd
5020 sets a message size limit of 50M if the macro &`AAA`& is defined
5021 (or &`A`& or &`AA`&), and 100M
5022 otherwise. If there is more than one macro named on the line, the condition
5023 is true if any of them are defined. That is, it is an &"or"& condition. To
5024 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5025
5026 Although you can use a macro expansion to generate one of these directives,
5027 it is not very useful, because the condition &"there was a macro substitution
5028 in this line"& will always be true.
5029
5030 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5031 to clarify complicated nestings.
5032
5033
5034
5035 .section "Common option syntax" "SECTcos"
5036 .cindex "common option syntax"
5037 .cindex "syntax of common options"
5038 .cindex "configuration file" "common option syntax"
5039 For the main set of options, driver options, and &[local_scan()]& options,
5040 each setting is on a line by itself, and starts with a name consisting of
5041 lower-case letters and underscores. Many options require a data value, and in
5042 these cases the name must be followed by an equals sign (with optional white
5043 space) and then the value. For example:
5044 .code
5045 qualify_domain = mydomain.example.com
5046 .endd
5047 .cindex "hiding configuration option values"
5048 .cindex "configuration options" "hiding value of"
5049 .cindex "options" "hiding value of"
5050 Some option settings may contain sensitive data, for example, passwords for
5051 accessing databases. To stop non-admin users from using the &%-bP%& command
5052 line option to read these values, you can precede the option settings with the
5053 word &"hide"&. For example:
5054 .code
5055 hide mysql_servers = localhost/users/admin/secret-password
5056 .endd
5057 For non-admin users, such options are displayed like this:
5058 .code
5059 mysql_servers = <value not displayable>
5060 .endd
5061 If &"hide"& is used on a driver option, it hides the value of that option on
5062 all instances of the same driver.
5063
5064 The following sections describe the syntax used for the different data types
5065 that are found in option settings.
5066
5067
5068 .section "Boolean options" "SECID47"
5069 .cindex "format" "boolean"
5070 .cindex "boolean configuration values"
5071 .oindex "&%no_%&&'xxx'&"
5072 .oindex "&%not_%&&'xxx'&"
5073 Options whose type is given as boolean are on/off switches. There are two
5074 different ways of specifying such options: with and without a data value. If
5075 the option name is specified on its own without data, the switch is turned on;
5076 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5077 boolean options may be followed by an equals sign and one of the words
5078 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5079 the following two settings have exactly the same effect:
5080 .code
5081 queue_only
5082 queue_only = true
5083 .endd
5084 The following two lines also have the same (opposite) effect:
5085 .code
5086 no_queue_only
5087 queue_only = false
5088 .endd
5089 You can use whichever syntax you prefer.
5090
5091
5092
5093
5094 .section "Integer values" "SECID48"
5095 .cindex "integer configuration values"
5096 .cindex "format" "integer"
5097 If an option's type is given as &"integer"&, the value can be given in decimal,
5098 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5099 number is assumed. Otherwise, it is treated as an octal number unless it starts
5100 with the characters &"0x"&, in which case the remainder is interpreted as a
5101 hexadecimal number.
5102
5103 If an integer value is followed by the letter K, it is multiplied by 1024; if
5104 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5105 of integer option settings are output, values which are an exact multiple of
5106 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5107 and M. The printing style is independent of the actual input format that was
5108 used.
5109
5110
5111 .section "Octal integer values" "SECID49"
5112 .cindex "integer format"
5113 .cindex "format" "octal integer"
5114 If an option's type is given as &"octal integer"&, its value is always
5115 interpreted as an octal number, whether or not it starts with the digit zero.
5116 Such options are always output in octal.
5117
5118
5119 .section "Fixed point numbers" "SECID50"
5120 .cindex "fixed point configuration values"
5121 .cindex "format" "fixed point"
5122 If an option's type is given as &"fixed-point"&, its value must be a decimal
5123 integer, optionally followed by a decimal point and up to three further digits.
5124
5125
5126
5127 .section "Time intervals" "SECTtimeformat"
5128 .cindex "time interval" "specifying in configuration"
5129 .cindex "format" "time interval"
5130 A time interval is specified as a sequence of numbers, each followed by one of
5131 the following letters, with no intervening white space:
5132
5133 .table2 30pt
5134 .irow &%s%& seconds
5135 .irow &%m%& minutes
5136 .irow &%h%& hours
5137 .irow &%d%& days
5138 .irow &%w%& weeks
5139 .endtable
5140
5141 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5142 intervals are output in the same format. Exim does not restrict the values; it
5143 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5144
5145
5146
5147 .section "String values" "SECTstrings"
5148 .cindex "string" "format of configuration values"
5149 .cindex "format" "string"
5150 If an option's type is specified as &"string"&, the value can be specified with
5151 or without double-quotes. If it does not start with a double-quote, the value
5152 consists of the remainder of the line plus any continuation lines, starting at
5153 the first character after any leading white space, with trailing white space
5154 removed, and with no interpretation of the characters in the string. Because
5155 Exim removes comment lines (those beginning with #) at an early stage, they can
5156 appear in the middle of a multi-line string. The following two settings are
5157 therefore equivalent:
5158 .code
5159 trusted_users = uucp:mail
5160 trusted_users = uucp:\
5161                 # This comment line is ignored
5162                 mail
5163 .endd
5164 .cindex "string" "quoted"
5165 .cindex "escape characters in quoted strings"
5166 If a string does start with a double-quote, it must end with a closing
5167 double-quote, and any backslash characters other than those used for line
5168 continuation are interpreted as escape characters, as follows:
5169
5170 .table2 100pt
5171 .irow &`\\`&                     "single backslash"
5172 .irow &`\n`&                     "newline"
5173 .irow &`\r`&                     "carriage return"
5174 .irow &`\t`&                     "tab"
5175 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5176 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5177                                    character"
5178 .endtable
5179
5180 If a backslash is followed by some other character, including a double-quote
5181 character, that character replaces the pair.
5182
5183 Quoting is necessary only if you want to make use of the backslash escapes to
5184 insert special characters, or if you need to specify a value with leading or
5185 trailing spaces. These cases are rare, so quoting is almost never needed in
5186 current versions of Exim. In versions of Exim before 3.14, quoting was required
5187 in order to continue lines, so you may come across older configuration files
5188 and examples that apparently quote unnecessarily.
5189
5190
5191 .section "Expanded strings" "SECID51"
5192 .cindex "expansion" "definition of"
5193 Some strings in the configuration file are subjected to &'string expansion'&,
5194 by which means various parts of the string may be changed according to the
5195 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5196 is as just described; in particular, the handling of backslashes in quoted
5197 strings is done as part of the input process, before expansion takes place.
5198 However, backslash is also an escape character for the expander, so any
5199 backslashes that are required for that reason must be doubled if they are
5200 within a quoted configuration string.
5201
5202
5203 .section "User and group names" "SECID52"
5204 .cindex "user name" "format of"
5205 .cindex "format" "user name"
5206 .cindex "groups" "name format"
5207 .cindex "format" "group name"
5208 User and group names are specified as strings, using the syntax described
5209 above, but the strings are interpreted specially. A user or group name must
5210 either consist entirely of digits, or be a name that can be looked up using the
5211 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5212
5213
5214 .section "List construction" "SECTlistconstruct"
5215 .cindex "list" "syntax of in configuration"
5216 .cindex "format" "list item in configuration"
5217 .cindex "string" "list, definition of"
5218 The data for some configuration options is a list of items, with colon as the
5219 default separator. Many of these options are shown with type &"string list"& in
5220 the descriptions later in this document. Others are listed as &"domain list"&,
5221 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5222 are all the same; however, those other than &"string list"& are subject to
5223 particular kinds of interpretation, as described in chapter
5224 &<<CHAPdomhosaddlists>>&.
5225
5226 In all these cases, the entire list is treated as a single string as far as the
5227 input syntax is concerned. The &%trusted_users%& setting in section
5228 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5229 in a list, it must be entered as two colons. Leading and trailing white space
5230 on each item in a list is ignored. This makes it possible to include items that
5231 start with a colon, and in particular, certain forms of IPv6 address. For
5232 example, the list
5233 .code
5234 local_interfaces = 127.0.0.1 : ::::1
5235 .endd
5236 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5237
5238 &*Note*&: Although leading and trailing white space is ignored in individual
5239 list items, it is not ignored when parsing the list. The space after the first
5240 colon in the example above is necessary. If it were not there, the list would
5241 be interpreted as the two items 127.0.0.1:: and 1.
5242
5243 .section "Changing list separators" "SECTlistsepchange"
5244 .cindex "list separator" "changing"
5245 .cindex "IPv6" "addresses in lists"
5246 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5247 introduced to allow the separator character to be changed. If a list begins
5248 with a left angle bracket, followed by any punctuation character, that
5249 character is used instead of colon as the list separator. For example, the list
5250 above can be rewritten to use a semicolon separator like this:
5251 .code
5252 local_interfaces = <; 127.0.0.1 ; ::1
5253 .endd
5254 This facility applies to all lists, with the exception of the list in
5255 &%log_file_path%&. It is recommended that the use of non-colon separators be
5256 confined to circumstances where they really are needed.
5257
5258 .cindex "list separator" "newline as"
5259 .cindex "newline" "as list separator"
5260 It is also possible to use newline and other control characters (those with
5261 code values less than 32, plus DEL) as separators in lists. Such separators
5262 must be provided literally at the time the list is processed. For options that
5263 are string-expanded, you can write the separator using a normal escape
5264 sequence. This will be processed by the expander before the string is
5265 interpreted as a list. For example, if a newline-separated list of domains is
5266 generated by a lookup, you can process it directly by a line such as this:
5267 .code
5268 domains = <\n ${lookup mysql{.....}}
5269 .endd
5270 This avoids having to change the list separator in such data. You are unlikely
5271 to want to use a control character as a separator in an option that is not
5272 expanded, because the value is literal text. However, it can be done by giving
5273 the value in quotes. For example:
5274 .code
5275 local_interfaces = "<\n 127.0.0.1 \n ::1"
5276 .endd
5277 Unlike printing character separators, which can be included in list items by
5278 doubling, it is not possible to include a control character as data when it is
5279 set as the separator. Two such characters in succession are interpreted as
5280 enclosing an empty list item.
5281
5282
5283
5284 .section "Empty items in lists" "SECTempitelis"
5285 .cindex "list" "empty item in"
5286 An empty item at the end of a list is always ignored. In other words, trailing
5287 separator characters are ignored. Thus, the list in
5288 .code
5289 senders = user@domain :
5290 .endd
5291 contains only a single item. If you want to include an empty string as one item
5292 in a list, it must not be the last item. For example, this list contains three
5293 items, the second of which is empty:
5294 .code
5295 senders = user1@domain : : user2@domain
5296 .endd
5297 &*Note*&: There must be white space between the two colons, as otherwise they
5298 are interpreted as representing a single colon data character (and the list
5299 would then contain just one item). If you want to specify a list that contains
5300 just one, empty item, you can do it as in this example:
5301 .code
5302 senders = :
5303 .endd
5304 In this case, the first item is empty, and the second is discarded because it
5305 is at the end of the list.
5306
5307
5308
5309
5310 .section "Format of driver configurations" "SECTfordricon"
5311 .cindex "drivers" "configuration format"
5312 There are separate parts in the configuration for defining routers, transports,
5313 and authenticators. In each part, you are defining a number of driver
5314 instances, each with its own set of options. Each driver instance is defined by
5315 a sequence of lines like this:
5316 .display
5317 <&'instance name'&>:
5318   <&'option'&>
5319   ...
5320   <&'option'&>
5321 .endd
5322 In the following example, the instance name is &(localuser)&, and it is
5323 followed by three options settings:
5324 .code
5325 localuser:
5326   driver = accept
5327   check_local_user
5328   transport = local_delivery
5329 .endd
5330 For each driver instance, you specify which Exim code module it uses &-- by the
5331 setting of the &%driver%& option &-- and (optionally) some configuration
5332 settings. For example, in the case of transports, if you want a transport to
5333 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5334 a local file you would use the &(appendfile)& driver. Each of the drivers is
5335 described in detail in its own separate chapter later in this manual.
5336
5337 You can have several routers, transports, or authenticators that are based on
5338 the same underlying driver (each must have a different instance name).
5339
5340 The order in which routers are defined is important, because addresses are
5341 passed to individual routers one by one, in order. The order in which
5342 transports are defined does not matter at all. The order in which
5343 authenticators are defined is used only when Exim, as a client, is searching
5344 them to find one that matches an authentication mechanism offered by the
5345 server.
5346
5347 .cindex "generic options"
5348 .cindex "options" "generic &-- definition of"
5349 Within a driver instance definition, there are two kinds of option: &'generic'&
5350 and &'private'&. The generic options are those that apply to all drivers of the
5351 same type (that is, all routers, all transports or all authenticators). The
5352 &%driver%& option is a generic option that must appear in every definition.
5353 .cindex "private options"
5354 The private options are special for each driver, and none need appear, because
5355 they all have default values.
5356
5357 The options may appear in any order, except that the &%driver%& option must
5358 precede any private options, since these depend on the particular driver. For
5359 this reason, it is recommended that &%driver%& always be the first option.
5360
5361 Driver instance names, which are used for reference in log entries and
5362 elsewhere, can be any sequence of letters, digits, and underscores (starting
5363 with a letter) and must be unique among drivers of the same type. A router and
5364 a transport (for example) can each have the same name, but no two router
5365 instances can have the same name. The name of a driver instance should not be
5366 confused with the name of the underlying driver module. For example, the
5367 configuration lines:
5368 .code
5369 remote_smtp:
5370   driver = smtp
5371 .endd
5372 create an instance of the &(smtp)& transport driver whose name is
5373 &(remote_smtp)&. The same driver code can be used more than once, with
5374 different instance names and different option settings each time. A second
5375 instance of the &(smtp)& transport, with different options, might be defined
5376 thus:
5377 .code
5378 special_smtp:
5379   driver = smtp
5380   port = 1234
5381   command_timeout = 10s
5382 .endd
5383 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5384 these transport instances from routers, and these names would appear in log
5385 lines.
5386
5387 Comment lines may be present in the middle of driver specifications. The full
5388 list of option settings for any particular driver instance, including all the
5389 defaulted values, can be extracted by making use of the &%-bP%& command line
5390 option.
5391
5392
5393
5394
5395
5396
5397 . ////////////////////////////////////////////////////////////////////////////
5398 . ////////////////////////////////////////////////////////////////////////////
5399
5400 .chapter "The default configuration file" "CHAPdefconfil"
5401 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5402 .cindex "default" "configuration file &""walk through""&"
5403 The default configuration file supplied with Exim as &_src/configure.default_&
5404 is sufficient for a host with simple mail requirements. As an introduction to
5405 the way Exim is configured, this chapter &"walks through"& the default
5406 configuration, giving brief explanations of the settings. Detailed descriptions
5407 of the options are given in subsequent chapters. The default configuration file
5408 itself contains extensive comments about ways you might want to modify the
5409 initial settings. However, note that there are many options that are not
5410 mentioned at all in the default configuration.
5411
5412
5413
5414 .section "Main configuration settings" "SECTdefconfmain"
5415 The main (global) configuration option settings must always come first in the
5416 file. The first thing you'll see in the file, after some initial comments, is
5417 the line
5418 .code
5419 # primary_hostname =
5420 .endd
5421 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5422 to know the official, fully qualified name of your host, and this is where you
5423 can specify it. However, in most cases you do not need to set this option. When
5424 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5425
5426 The first three non-comment configuration lines are as follows:
5427 .code
5428 domainlist local_domains    = @
5429 domainlist relay_to_domains =
5430 hostlist   relay_from_hosts = 127.0.0.1
5431 .endd
5432 These are not, in fact, option settings. They are definitions of two named
5433 domain lists and one named host list. Exim allows you to give names to lists of
5434 domains, hosts, and email addresses, in order to make it easier to manage the
5435 configuration file (see section &<<SECTnamedlists>>&).
5436
5437 The first line defines a domain list called &'local_domains'&; this is used
5438 later in the configuration to identify domains that are to be delivered
5439 on the local host.
5440
5441 .cindex "@ in a domain list"
5442 There is just one item in this list, the string &"@"&. This is a special form
5443 of entry which means &"the name of the local host"&. Thus, if the local host is
5444 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5445 be delivered locally. Because the local host's name is referenced indirectly,
5446 the same configuration file can be used on different hosts.
5447
5448 The second line defines a domain list called &'relay_to_domains'&, but the
5449 list itself is empty. Later in the configuration we will come to the part that
5450 controls mail relaying through the local host; it allows relaying to any
5451 domains in this list. By default, therefore, no relaying on the basis of a mail
5452 domain is permitted.
5453
5454 The third line defines a host list called &'relay_from_hosts'&. This list is
5455 used later in the configuration to permit relaying from any host or IP address
5456 that matches the list. The default contains just the IP address of the IPv4
5457 loopback interface, which means that processes on the local host are able to
5458 submit mail for relaying by sending it over TCP/IP to that interface. No other
5459 hosts are permitted to submit messages for relaying.
5460
5461 Just to be sure there's no misunderstanding: at this point in the configuration
5462 we aren't actually setting up any controls. We are just defining some domains
5463 and hosts that will be used in the controls that are specified later.
5464
5465 The next two configuration lines are genuine option settings:
5466 .code
5467 acl_smtp_rcpt = acl_check_rcpt
5468 acl_smtp_data = acl_check_data
5469 .endd
5470 These options specify &'Access Control Lists'& (ACLs) that are to be used
5471 during an incoming SMTP session for every recipient of a message (every RCPT
5472 command), and after the contents of the message have been received,
5473 respectively. The names of the lists are &'acl_check_rcpt'& and
5474 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5475 section of the configuration. The RCPT ACL controls which recipients are
5476 accepted for an incoming message &-- if a configuration does not provide an ACL
5477 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5478 contents of a message to be checked.
5479
5480 Two commented-out option settings are next:
5481 .code
5482 # av_scanner = clamd:/tmp/clamd
5483 # spamd_address = 127.0.0.1 783
5484 .endd
5485 These are example settings that can be used when Exim is compiled with the
5486 content-scanning extension. The first specifies the interface to the virus
5487 scanner, and the second specifies the interface to SpamAssassin. Further
5488 details are given in chapter &<<CHAPexiscan>>&.
5489
5490 Three more commented-out option settings follow:
5491 .code
5492 # tls_advertise_hosts = *
5493 # tls_certificate = /etc/ssl/exim.crt
5494 # tls_privatekey = /etc/ssl/exim.pem
5495 .endd
5496 These are example settings that can be used when Exim is compiled with
5497 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5498 first one specifies the list of clients that are allowed to use TLS when
5499 connecting to this server; in this case the wildcard means all clients. The
5500 other options specify where Exim should find its TLS certificate and private
5501 key, which together prove the server's identity to any clients that connect.
5502 More details are given in chapter &<<CHAPTLS>>&.
5503
5504 Another two commented-out option settings follow:
5505 .code
5506 # daemon_smtp_ports = 25 : 465 : 587
5507 # tls_on_connect_ports = 465
5508 .endd
5509 .cindex "port" "465 and 587"
5510 .cindex "port" "for message submission"
5511 .cindex "message" "submission, ports for"
5512 .cindex "ssmtp protocol"
5513 .cindex "smtps protocol"
5514 .cindex "SMTP" "ssmtp protocol"
5515 .cindex "SMTP" "smtps protocol"
5516 These options provide better support for roaming users who wish to use this
5517 server for message submission. They are not much use unless you have turned on
5518 TLS (as described in the previous paragraph) and authentication (about which
5519 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5520 on end-user networks, so RFC 4409 specifies that message submission should use
5521 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5522 configured to use port 587 correctly, so these settings also enable the
5523 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5524 &<<SECTsupobssmt>>&).
5525
5526 Two more commented-out options settings follow:
5527 .code
5528 # qualify_domain =
5529 # qualify_recipient =
5530 .endd
5531 The first of these specifies a domain that Exim uses when it constructs a
5532 complete email address from a local login name. This is often needed when Exim
5533 receives a message from a local process. If you do not set &%qualify_domain%&,
5534 the value of &%primary_hostname%& is used. If you set both of these options,
5535 you can have different qualification domains for sender and recipient
5536 addresses. If you set only the first one, its value is used in both cases.
5537
5538 .cindex "domain literal" "recognizing format"
5539 The following line must be uncommented if you want Exim to recognize
5540 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5541 (an IP address within square brackets) instead of a named domain.
5542 .code
5543 # allow_domain_literals
5544 .endd
5545 The RFCs still require this form, but many people think that in the modern
5546 Internet it makes little sense to permit mail to be sent to specific hosts by
5547 quoting their IP addresses. This ancient format has been used by people who
5548 try to abuse hosts by using them for unwanted relaying. However, some
5549 people believe there are circumstances (for example, messages addressed to
5550 &'postmaster'&) where domain literals are still useful.
5551
5552 The next configuration line is a kind of trigger guard:
5553 .code
5554 never_users = root
5555 .endd
5556 It specifies that no delivery must ever be run as the root user. The normal
5557 convention is to set up &'root'& as an alias for the system administrator. This
5558 setting is a guard against slips in the configuration.
5559 The list of users specified by &%never_users%& is not, however, the complete
5560 list; the build-time configuration in &_Local/Makefile_& has an option called
5561 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5562 contents of &%never_users%& are added to this list. By default
5563 FIXED_NEVER_USERS also specifies root.
5564
5565 When a remote host connects to Exim in order to send mail, the only information
5566 Exim has about the host's identity is its IP address. The next configuration
5567 line,
5568 .code
5569 host_lookup = *
5570 .endd
5571 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5572 in order to get a host name. This improves the quality of the logging
5573 information, but if you feel it is too expensive, you can remove it entirely,
5574 or restrict the lookup to hosts on &"nearby"& networks.
5575 Note that it is not always possible to find a host name from an IP address,
5576 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5577 unreachable.
5578
5579 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5580 1413 (hence their names):
5581 .code
5582 rfc1413_hosts = *
5583 rfc1413_query_timeout = 0s
5584 .endd
5585 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5586 Few hosts offer RFC1413 service these days; calls have to be
5587 terminated by a timeout and this needlessly delays the startup
5588 of an incoming SMTP connection.
5589 If you have hosts for which you trust RFC1413 and need this
5590 information, you can change this.
5591
5592 This line enables an efficiency SMTP option.  It is negotiated by clients
5593 and not expected to cause problems but can be disabled if needed.
5594 .code
5595 prdr_enable = true
5596 .endd
5597
5598 When Exim receives messages over SMTP connections, it expects all addresses to
5599 be fully qualified with a domain, as required by the SMTP definition. However,
5600 if you are running a server to which simple clients submit messages, you may
5601 find that they send unqualified addresses. The two commented-out options:
5602 .code
5603 # sender_unqualified_hosts =
5604 # recipient_unqualified_hosts =
5605 .endd
5606 show how you can specify hosts that are permitted to send unqualified sender
5607 and recipient addresses, respectively.
5608
5609 The &%log_selector%& option is used to increase the detail of logging
5610 over the default:
5611 .code
5612 log_selector = +smtp_protocol_error +smtp_syntax_error \
5613                +tls_certificate_verified
5614 .endd
5615
5616 The &%percent_hack_domains%& option is also commented out:
5617 .code
5618 # percent_hack_domains =
5619 .endd
5620 It provides a list of domains for which the &"percent hack"& is to operate.
5621 This is an almost obsolete form of explicit email routing. If you do not know
5622 anything about it, you can safely ignore this topic.
5623
5624 The next two settings in the main part of the default configuration are
5625 concerned with messages that have been &"frozen"& on Exim's queue. When a
5626 message is frozen, Exim no longer continues to try to deliver it. Freezing
5627 occurs when a bounce message encounters a permanent failure because the sender
5628 address of the original message that caused the bounce is invalid, so the
5629 bounce cannot be delivered. This is probably the most common case, but there
5630 are also other conditions that cause freezing, and frozen messages are not
5631 always bounce messages.
5632 .code
5633 ignore_bounce_errors_after = 2d
5634 timeout_frozen_after = 7d
5635 .endd
5636 The first of these options specifies that failing bounce messages are to be
5637 discarded after 2 days on the queue. The second specifies that any frozen
5638 message (whether a bounce message or not) is to be timed out (and discarded)
5639 after a week. In this configuration, the first setting ensures that no failing
5640 bounce message ever lasts a week.
5641
5642 Exim queues it's messages in a spool directory. If you expect to have
5643 large queues, you may consider using this option. It splits the spool
5644 directory into subdirectories to avoid file system degradation from
5645 many files in a single directory, resulting in better performance.
5646 Manual manipulation of queued messages becomes more complex (though fortunately
5647 not often needed).
5648 .code
5649 # split_spool_directory = true
5650 .endd
5651
5652 In an ideal world everybody follows the standards. For non-ASCII
5653 messages RFC 2047 is a standard, allowing a maximum line length of 76
5654 characters. Exim adheres that standard and won't process messages which
5655 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5656 In particular, the Exim maintainers have had multiple reports of
5657 problems from Russian administrators of issues until they disable this
5658 check, because of some popular, yet buggy, mail composition software.
5659 .code
5660 # check_rfc2047_length = false
5661 .endd
5662
5663 If you need to be strictly RFC compliant you may wish to disable the
5664 8BITMIME advertisement. Use this, if you exchange mails with systems
5665 that are not 8-bit clean.
5666 .code
5667 # accept_8bitmime = false
5668 .endd
5669
5670 Libraries you use may depend on specific environment settings.  This
5671 imposes a security risk (e.g. PATH). There are two lists:
5672 &%keep_environment%& for the variables to import as they are, and
5673 &%add_environment%& for variables we want to set to a fixed value.
5674 Note that TZ is handled separately, by the $%timezone%$ runtime
5675 option and by the TIMEZONE_DEFAULT buildtime option.
5676 .code
5677 # keep_environment = ^LDAP
5678 # add_environment = PATH=/usr/bin::/bin
5679 .endd
5680
5681
5682 .section "ACL configuration" "SECID54"
5683 .cindex "default" "ACLs"
5684 .cindex "&ACL;" "default configuration"
5685 In the default configuration, the ACL section follows the main configuration.
5686 It starts with the line
5687 .code
5688 begin acl
5689 .endd
5690 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5691 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5692 and &%acl_smtp_data%& above.
5693
5694 .cindex "RCPT" "ACL for"
5695 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5696 RCPT command specifies one of the message's recipients. The ACL statements
5697 are considered in order, until the recipient address is either accepted or
5698 rejected. The RCPT command is then accepted or rejected, according to the
5699 result of the ACL processing.
5700 .code
5701 acl_check_rcpt:
5702 .endd
5703 This line, consisting of a name terminated by a colon, marks the start of the
5704 ACL, and names it.
5705 .code
5706 accept  hosts = :
5707 .endd
5708 This ACL statement accepts the recipient if the sending host matches the list.
5709 But what does that strange list mean? It doesn't actually contain any host
5710 names or IP addresses. The presence of the colon puts an empty item in the
5711 list; Exim matches this only if the incoming message did not come from a remote
5712 host, because in that case, the remote hostname is empty. The colon is
5713 important. Without it, the list itself is empty, and can never match anything.
5714
5715 What this statement is doing is to accept unconditionally all recipients in
5716 messages that are submitted by SMTP from local processes using the standard
5717 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5718 manner.
5719 .code
5720 deny    message       = Restricted characters in address
5721         domains       = +local_domains
5722         local_parts   = ^[.] : ^.*[@%!/|]
5723
5724 deny    message       = Restricted characters in address
5725         domains       = !+local_domains
5726         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5727 .endd
5728 These statements are concerned with local parts that contain any of the
5729 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5730 Although these characters are entirely legal in local parts (in the case of
5731 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5732 in Internet mail addresses.
5733
5734 The first three have in the past been associated with explicitly routed
5735 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5736 option). Addresses containing these characters are regularly tried by spammers
5737 in an attempt to bypass relaying restrictions, and also by open relay testing
5738 programs. Unless you really need them it is safest to reject these characters
5739 at this early stage. This configuration is heavy-handed in rejecting these
5740 characters for all messages it accepts from remote hosts. This is a deliberate
5741 policy of being as safe as possible.
5742
5743 The first rule above is stricter, and is applied to messages that are addressed
5744 to one of the local domains handled by this host. This is implemented by the
5745 first condition, which restricts it to domains that are listed in the
5746 &'local_domains'& domain list. The &"+"& character is used to indicate a
5747 reference to a named list. In this configuration, there is just one domain in
5748 &'local_domains'&, but in general there may be many.
5749
5750 The second condition on the first statement uses two regular expressions to
5751 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5752 or &"|"&. If you have local accounts that include these characters, you will
5753 have to modify this rule.
5754
5755 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5756 allows them because they have been encountered in practice. (Consider the
5757 common convention of local parts constructed as
5758 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5759 the author of Exim, who has no second initial.) However, a local part starting
5760 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5761 file name (for example, for a mailing list). This is also true for local parts
5762 that contain slashes. A pipe symbol can also be troublesome if the local part
5763 is incorporated unthinkingly into a shell command line.
5764
5765 The second rule above applies to all other domains, and is less strict. This
5766 allows your own users to send outgoing messages to sites that use slashes
5767 and vertical bars in their local parts. It blocks local parts that begin
5768 with a dot, slash, or vertical bar, but allows these characters within the
5769 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5770 and &"!"& is blocked, as before. The motivation here is to prevent your users
5771 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5772 .code
5773 accept  local_parts   = postmaster
5774         domains       = +local_domains
5775 .endd
5776 This statement, which has two conditions, accepts an incoming address if the
5777 local part is &'postmaster'& and the domain is one of those listed in the
5778 &'local_domains'& domain list. The &"+"& character is used to indicate a
5779 reference to a named list. In this configuration, there is just one domain in
5780 &'local_domains'&, but in general there may be many.
5781
5782 The presence of this statement means that mail to postmaster is never blocked
5783 by any of the subsequent tests. This can be helpful while sorting out problems
5784 in cases where the subsequent tests are incorrectly denying access.
5785 .code
5786 require verify        = sender
5787 .endd
5788 This statement requires the sender address to be verified before any subsequent
5789 ACL statement can be used. If verification fails, the incoming recipient
5790 address is refused. Verification consists of trying to route the address, to
5791 see if a bounce message could be delivered to it. In the case of remote
5792 addresses, basic verification checks only the domain, but &'callouts'& can be
5793 used for more verification if required. Section &<<SECTaddressverification>>&
5794 discusses the details of address verification.
5795 .code
5796 accept  hosts         = +relay_from_hosts
5797         control       = submission
5798 .endd
5799 This statement accepts the address if the message is coming from one of the
5800 hosts that are defined as being allowed to relay through this host. Recipient
5801 verification is omitted here, because in many cases the clients are dumb MUAs
5802 that do not cope well with SMTP error responses. For the same reason, the
5803 second line specifies &"submission mode"& for messages that are accepted. This
5804 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5805 messages that are deficient in some way, for example, because they lack a
5806 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5807 probably add recipient verification here, and disable submission mode.
5808 .code
5809 accept  authenticated = *
5810         control       = submission
5811 .endd
5812 This statement accepts the address if the client host has authenticated itself.
5813 Submission mode is again specified, on the grounds that such messages are most
5814 likely to come from MUAs. The default configuration does not define any
5815 authenticators, though it does include some nearly complete commented-out
5816 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5817 fact authenticate until you complete the authenticator definitions.
5818 .code
5819 require message = relay not permitted
5820         domains = +local_domains : +relay_to_domains
5821 .endd
5822 This statement rejects the address if its domain is neither a local domain nor
5823 one of the domains for which this host is a relay.
5824 .code
5825 require verify = recipient
5826 .endd
5827 This statement requires the recipient address to be verified; if verification
5828 fails, the address is rejected.
5829 .code
5830 # deny    message     = rejected because $sender_host_address \
5831 #                       is in a black list at $dnslist_domain\n\
5832 #                       $dnslist_text
5833 #         dnslists    = black.list.example
5834 #
5835 # warn    dnslists    = black.list.example
5836 #         add_header  = X-Warning: $sender_host_address is in \
5837 #                       a black list at $dnslist_domain
5838 #         log_message = found in $dnslist_domain
5839 .endd
5840 These commented-out lines are examples of how you could configure Exim to check
5841 sending hosts against a DNS black list. The first statement rejects messages
5842 from blacklisted hosts, whereas the second just inserts a warning header
5843 line.
5844 .code
5845 # require verify = csa
5846 .endd
5847 This commented-out line is an example of how you could turn on client SMTP
5848 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5849 records.
5850 .code
5851 accept
5852 .endd
5853 The final statement in the first ACL unconditionally accepts any recipient
5854 address that has successfully passed all the previous tests.
5855 .code
5856 acl_check_data:
5857 .endd
5858 This line marks the start of the second ACL, and names it. Most of the contents
5859 of this ACL are commented out:
5860 .code
5861 # deny    malware   = *
5862 #         message   = This message contains a virus \
5863 #                     ($malware_name).
5864 .endd
5865 These lines are examples of how to arrange for messages to be scanned for
5866 viruses when Exim has been compiled with the content-scanning extension, and a
5867 suitable virus scanner is installed. If the message is found to contain a
5868 virus, it is rejected with the given custom error message.
5869 .code
5870 # warn    spam      = nobody
5871 #         message   = X-Spam_score: $spam_score\n\
5872 #                     X-Spam_score_int: $spam_score_int\n\
5873 #                     X-Spam_bar: $spam_bar\n\
5874 #                     X-Spam_report: $spam_report
5875 .endd
5876 These lines are an example of how to arrange for messages to be scanned by
5877 SpamAssassin when Exim has been compiled with the content-scanning extension,
5878 and SpamAssassin has been installed. The SpamAssassin check is run with
5879 &`nobody`& as its user parameter, and the results are added to the message as a
5880 series of extra header line. In this case, the message is not rejected,
5881 whatever the spam score.
5882 .code
5883 accept
5884 .endd
5885 This final line in the DATA ACL accepts the message unconditionally.
5886
5887
5888 .section "Router configuration" "SECID55"
5889 .cindex "default" "routers"
5890 .cindex "routers" "default"
5891 The router configuration comes next in the default configuration, introduced
5892 by the line
5893 .code
5894 begin routers
5895 .endd
5896 Routers are the modules in Exim that make decisions about where to send
5897 messages. An address is passed to each router in turn, until it is either
5898 accepted, or failed. This means that the order in which you define the routers
5899 matters. Each router is fully described in its own chapter later in this
5900 manual. Here we give only brief overviews.
5901 .code
5902 # domain_literal:
5903 #   driver = ipliteral
5904 #   domains = !+local_domains
5905 #   transport = remote_smtp
5906 .endd
5907 .cindex "domain literal" "default router"
5908 This router is commented out because the majority of sites do not want to
5909 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5910 you uncomment this router, you also need to uncomment the setting of
5911 &%allow_domain_literals%& in the main part of the configuration.
5912 .code
5913 dnslookup:
5914   driver = dnslookup
5915   domains = ! +local_domains
5916   transport = remote_smtp
5917   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5918   no_more
5919 .endd
5920 The first uncommented router handles addresses that do not involve any local
5921 domains. This is specified by the line
5922 .code
5923 domains = ! +local_domains
5924 .endd
5925 The &%domains%& option lists the domains to which this router applies, but the
5926 exclamation mark is a negation sign, so the router is used only for domains
5927 that are not in the domain list called &'local_domains'& (which was defined at
5928 the start of the configuration). The plus sign before &'local_domains'&
5929 indicates that it is referring to a named list. Addresses in other domains are
5930 passed on to the following routers.
5931
5932 The name of the router driver is &(dnslookup)&,
5933 and is specified by the &%driver%& option. Do not be confused by the fact that
5934 the name of this router instance is the same as the name of the driver. The
5935 instance name is arbitrary, but the name set in the &%driver%& option must be
5936 one of the driver modules that is in the Exim binary.
5937
5938 The &(dnslookup)& router routes addresses by looking up their domains in the
5939 DNS in order to obtain a list of hosts to which the address is routed. If the
5940 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5941 specified by the &%transport%& option. If the router does not find the domain
5942 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5943 the address fails and is bounced.
5944
5945 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5946 be entirely ignored. This option is present because a number of cases have been
5947 encountered where MX records in the DNS point to host names
5948 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5949 Completely ignoring these IP addresses causes Exim to fail to route the
5950 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5951 continue to try to deliver the message periodically until the address timed
5952 out.
5953 .code
5954 system_aliases:
5955   driver = redirect
5956   allow_fail
5957   allow_defer
5958   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5959 # user = exim
5960   file_transport = address_file
5961   pipe_transport = address_pipe
5962 .endd
5963 Control reaches this and subsequent routers only for addresses in the local
5964 domains. This router checks to see whether the local part is defined as an
5965 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5966 data that it looks up from that file. If no data is found for the local part,
5967 the value of the &%data%& option is empty, causing the address to be passed to
5968 the next router.
5969
5970 &_/etc/aliases_& is a conventional name for the system aliases file that is
5971 often used. That is why it is referenced by from the default configuration
5972 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5973 &_Local/Makefile_& before building Exim.
5974 .code
5975 userforward:
5976   driver = redirect
5977   check_local_user
5978 # local_part_suffix = +* : -*
5979 # local_part_suffix_optional
5980   file = $home/.forward
5981 # allow_filter
5982   no_verify
5983   no_expn
5984   check_ancestor
5985   file_transport = address_file
5986   pipe_transport = address_pipe
5987   reply_transport = address_reply
5988 .endd
5989 This is the most complicated router in the default configuration. It is another
5990 redirection router, but this time it is looking for forwarding data set up by
5991 individual users. The &%check_local_user%& setting specifies a check that the
5992 local part of the address is the login name of a local user. If it is not, the
5993 router is skipped. The two commented options that follow &%check_local_user%&,
5994 namely:
5995 .code
5996 # local_part_suffix = +* : -*
5997 # local_part_suffix_optional
5998 .endd
5999 .vindex "&$local_part_suffix$&"
6000 show how you can specify the recognition of local part suffixes. If the first
6001 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6002 by any sequence of characters, is removed from the local part and placed in the
6003 variable &$local_part_suffix$&. The second suffix option specifies that the
6004 presence of a suffix in the local part is optional. When a suffix is present,
6005 the check for a local login uses the local part with the suffix removed.
6006
6007 When a local user account is found, the file called &_.forward_& in the user's
6008 home directory is consulted. If it does not exist, or is empty, the router
6009 declines. Otherwise, the contents of &_.forward_& are interpreted as
6010 redirection data (see chapter &<<CHAPredirect>>& for more details).
6011
6012 .cindex "Sieve filter" "enabling in default router"
6013 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6014 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6015 is commented out by default), the contents of the file are interpreted as a set
6016 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6017 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6018 separate document entitled &'Exim's interfaces to mail filtering'&.
6019
6020 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6021 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6022 There are two reasons for doing this:
6023
6024 .olist
6025 Whether or not a local user has a &_.forward_& file is not really relevant when
6026 checking an address for validity; it makes sense not to waste resources doing
6027 unnecessary work.
6028 .next
6029 More importantly, when Exim is verifying addresses or handling an EXPN
6030 command during an SMTP session, it is running as the Exim user, not as root.
6031 The group is the Exim group, and no additional groups are set up.
6032 It may therefore not be possible for Exim to read users' &_.forward_& files at
6033 this time.
6034 .endlist
6035
6036 The setting of &%check_ancestor%& prevents the router from generating a new
6037 address that is the same as any previous address that was redirected. (This
6038 works round a problem concerning a bad interaction between aliasing and
6039 forwarding &-- see section &<<SECTredlocmai>>&).
6040
6041 The final three option settings specify the transports that are to be used when
6042 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6043 auto-reply, respectively. For example, if a &_.forward_& file contains
6044 .code
6045 a.nother@elsewhere.example, /home/spqr/archive
6046 .endd
6047 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6048 transport.
6049 .code
6050 localuser:
6051   driver = accept
6052   check_local_user
6053 # local_part_suffix = +* : -*
6054 # local_part_suffix_optional
6055   transport = local_delivery
6056 .endd
6057 The final router sets up delivery into local mailboxes, provided that the local
6058 part is the name of a local login, by accepting the address and assigning it to
6059 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6060 routers, so the address is bounced. The commented suffix settings fulfil the
6061 same purpose as they do for the &(userforward)& router.
6062
6063
6064 .section "Transport configuration" "SECID56"
6065 .cindex "default" "transports"
6066 .cindex "transports" "default"
6067 Transports define mechanisms for actually delivering messages. They operate
6068 only when referenced from routers, so the order in which they are defined does
6069 not matter. The transports section of the configuration starts with
6070 .code
6071 begin transports
6072 .endd
6073 One remote transport and four local transports are defined.
6074 .code
6075 remote_smtp:
6076   driver = smtp
6077   hosts_try_prdr = *
6078 .endd
6079 This transport is used for delivering messages over SMTP connections.
6080 The list of remote hosts comes from the router.
6081 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6082 It is negotiated between client and server
6083 and not expected to cause problems but can be disabled if needed.
6084 All other options are defaulted.
6085 .code
6086 local_delivery:
6087   driver = appendfile
6088   file = /var/mail/$local_part
6089   delivery_date_add
6090   envelope_to_add
6091   return_path_add
6092 # group = mail
6093 # mode = 0660
6094 .endd
6095 This &(appendfile)& transport is used for local delivery to user mailboxes in
6096 traditional BSD mailbox format. By default it runs under the uid and gid of the
6097 local user, which requires the sticky bit to be set on the &_/var/mail_&
6098 directory. Some systems use the alternative approach of running mail deliveries
6099 under a particular group instead of using the sticky bit. The commented options
6100 show how this can be done.
6101
6102 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6103 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6104 similarly-named options above.
6105 .code
6106 address_pipe:
6107   driver = pipe
6108   return_output
6109 .endd
6110 This transport is used for handling deliveries to pipes that are generated by
6111 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6112 option specifies that any output on stdout or stderr generated by the pipe is to
6113 be returned to the sender.
6114 .code
6115 address_file:
6116   driver = appendfile
6117   delivery_date_add
6118   envelope_to_add
6119   return_path_add
6120 .endd
6121 This transport is used for handling deliveries to files that are generated by
6122 redirection. The name of the file is not specified in this instance of
6123 &(appendfile)&, because it comes from the &(redirect)& router.
6124 .code
6125 address_reply:
6126   driver = autoreply
6127 .endd
6128 This transport is used for handling automatic replies generated by users'
6129 filter files.
6130
6131
6132
6133 .section "Default retry rule" "SECID57"
6134 .cindex "retry" "default rule"
6135 .cindex "default" "retry rule"
6136 The retry section of the configuration file contains rules which affect the way
6137 Exim retries deliveries that cannot be completed at the first attempt. It is
6138 introduced by the line
6139 .code
6140 begin retry
6141 .endd
6142 In the default configuration, there is just one rule, which applies to all
6143 errors:
6144 .code
6145 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6146 .endd
6147 This causes any temporarily failing address to be retried every 15 minutes for
6148 2 hours, then at intervals starting at one hour and increasing by a factor of
6149 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6150 is not delivered after 4 days of temporary failure, it is bounced.
6151
6152 If the retry section is removed from the configuration, or is empty (that is,
6153 if no retry rules are defined), Exim will not retry deliveries. This turns
6154 temporary errors into permanent errors.
6155
6156
6157 .section "Rewriting configuration" "SECID58"
6158 The rewriting section of the configuration, introduced by
6159 .code
6160 begin rewrite
6161 .endd
6162 contains rules for rewriting addresses in messages as they arrive. There are no
6163 rewriting rules in the default configuration file.
6164
6165
6166
6167 .section "Authenticators configuration" "SECTdefconfauth"
6168 .cindex "AUTH" "configuration"
6169 The authenticators section of the configuration, introduced by
6170 .code
6171 begin authenticators
6172 .endd
6173 defines mechanisms for the use of the SMTP AUTH command. The default
6174 configuration file contains two commented-out example authenticators
6175 which support plaintext username/password authentication using the
6176 standard PLAIN mechanism and the traditional but non-standard LOGIN
6177 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6178 to support most MUA software.
6179
6180 The example PLAIN authenticator looks like this:
6181 .code
6182 #PLAIN:
6183 #  driver                  = plaintext
6184 #  server_set_id           = $auth2
6185 #  server_prompts          = :
6186 #  server_condition        = Authentication is not yet configured
6187 #  server_advertise_condition = ${if def:tls_in_cipher }
6188 .endd
6189 And the example LOGIN authenticator looks like this:
6190 .code
6191 #LOGIN:
6192 #  driver                  = plaintext
6193 #  server_set_id           = $auth1
6194 #  server_prompts          = <| Username: | Password:
6195 #  server_condition        = Authentication is not yet configured
6196 #  server_advertise_condition = ${if def:tls_in_cipher }
6197 .endd
6198
6199 The &%server_set_id%& option makes Exim remember the authenticated username
6200 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6201 &%server_prompts%& option configures the &(plaintext)& authenticator so
6202 that it implements the details of the specific authentication mechanism,
6203 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6204 when Exim offers authentication to clients; in the examples, this is only
6205 when TLS or SSL has been started, so to enable the authenticators you also
6206 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6207
6208 The &%server_condition%& setting defines how to verify that the username and
6209 password are correct. In the examples it just produces an error message.
6210 To make the authenticators work, you can use a string expansion
6211 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6212
6213 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6214 usercode and password are in different positions.
6215 Chapter &<<CHAPplaintext>>& covers both.
6216
6217 .ecindex IIDconfiwal
6218
6219
6220
6221 . ////////////////////////////////////////////////////////////////////////////
6222 . ////////////////////////////////////////////////////////////////////////////
6223
6224 .chapter "Regular expressions" "CHAPregexp"
6225
6226 .cindex "regular expressions" "library"
6227 .cindex "PCRE"
6228 Exim supports the use of regular expressions in many of its options. It
6229 uses the PCRE regular expression library; this provides regular expression
6230 matching that is compatible with Perl 5. The syntax and semantics of
6231 regular expressions is discussed in many Perl reference books, and also in
6232 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6233 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6234
6235 The documentation for the syntax and semantics of the regular expressions that
6236 are supported by PCRE is included in the PCRE distribution, and no further
6237 description is included here. The PCRE functions are called from Exim using
6238 the default option settings (that is, with no PCRE options set), except that
6239 the PCRE_CASELESS option is set when the matching is required to be
6240 case-insensitive.
6241
6242 In most cases, when a regular expression is required in an Exim configuration,
6243 it has to start with a circumflex, in order to distinguish it from plain text
6244 or an &"ends with"& wildcard. In this example of a configuration setting, the
6245 second item in the colon-separated list is a regular expression.
6246 .code
6247 domains = a.b.c : ^\\d{3} : *.y.z : ...
6248 .endd
6249 The doubling of the backslash is required because of string expansion that
6250 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6251 of this issue, and a way of avoiding the need for doubling backslashes. The
6252 regular expression that is eventually used in this example contains just one
6253 backslash. The circumflex is included in the regular expression, and has the
6254 normal effect of &"anchoring"& it to the start of the string that is being
6255 matched.
6256
6257 There are, however, two cases where a circumflex is not required for the
6258 recognition of a regular expression: these are the &%match%& condition in a
6259 string expansion, and the &%matches%& condition in an Exim filter file. In
6260 these cases, the relevant string is always treated as a regular expression; if
6261 it does not start with a circumflex, the expression is not anchored, and can
6262 match anywhere in the subject string.
6263
6264 In all cases, if you want a regular expression to match at the end of a string,
6265 you must code the $ metacharacter to indicate this. For example:
6266 .code
6267 domains = ^\\d{3}\\.example
6268 .endd
6269 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6270 You need to use:
6271 .code
6272 domains = ^\\d{3}\\.example\$
6273 .endd
6274 if you want &'example'& to be the top-level domain. The backslash before the
6275 $ is needed because string expansion also interprets dollar characters.
6276
6277
6278
6279 . ////////////////////////////////////////////////////////////////////////////
6280 . ////////////////////////////////////////////////////////////////////////////
6281
6282 .chapter "File and database lookups" "CHAPfdlookup"
6283 .scindex IIDfidalo1 "file" "lookups"
6284 .scindex IIDfidalo2 "database" "lookups"
6285 .cindex "lookup" "description of"
6286 Exim can be configured to look up data in files or databases as it processes
6287 messages. Two different kinds of syntax are used:
6288
6289 .olist
6290 A string that is to be expanded may contain explicit lookup requests. These
6291 cause parts of the string to be replaced by data that is obtained from the
6292 lookup. Lookups of this type are conditional expansion items. Different results
6293 can be defined for the cases of lookup success and failure. See chapter
6294 &<<CHAPexpand>>&, where string expansions are described in detail.
6295 The key for the lookup is specified as part of the string expansion.
6296 .next
6297 Lists of domains, hosts, and email addresses can contain lookup requests as a
6298 way of avoiding excessively long linear lists. In this case, the data that is
6299 returned by the lookup is often (but not always) discarded; whether the lookup
6300 succeeds or fails is what really counts. These kinds of list are described in
6301 chapter &<<CHAPdomhosaddlists>>&.
6302 The key for the lookup is given by the context in which the list is expanded.
6303 .endlist
6304
6305 String expansions, lists, and lookups interact with each other in such a way
6306 that there is no order in which to describe any one of them that does not
6307 involve references to the others. Each of these three chapters makes more sense
6308 if you have read the other two first. If you are reading this for the first
6309 time, be aware that some of it will make a lot more sense after you have read
6310 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6311
6312 .section "Examples of different lookup syntax" "SECID60"
6313 It is easy to confuse the two different kinds of lookup, especially as the
6314 lists that may contain the second kind are always expanded before being
6315 processed as lists. Therefore, they may also contain lookups of the first kind.
6316 Be careful to distinguish between the following two examples:
6317 .code
6318 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6319 domains = lsearch;/some/file
6320 .endd
6321 The first uses a string expansion, the result of which must be a domain list.
6322 No strings have been specified for a successful or a failing lookup; the
6323 defaults in this case are the looked-up data and an empty string, respectively.
6324 The expansion takes place before the string is processed as a list, and the
6325 file that is searched could contain lines like this:
6326 .code
6327 192.168.3.4: domain1:domain2:...
6328 192.168.1.9: domain3:domain4:...
6329 .endd
6330 When the lookup succeeds, the result of the expansion is a list of domains (and
6331 possibly other types of item that are allowed in domain lists).
6332
6333 In the second example, the lookup is a single item in a domain list. It causes
6334 Exim to use a lookup to see if the domain that is being processed can be found
6335 in the file. The file could contains lines like this:
6336 .code
6337 domain1:
6338 domain2:
6339 .endd
6340 Any data that follows the keys is not relevant when checking that the domain
6341 matches the list item.
6342
6343 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6344 Consider a file containing lines like this:
6345 .code
6346 192.168.5.6: lsearch;/another/file
6347 .endd
6348 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6349 first &%domains%& setting above generates the second setting, which therefore
6350 causes a second lookup to occur.
6351
6352 The rest of this chapter describes the different lookup types that are
6353 available. Any of them can be used in any part of the configuration where a
6354 lookup is permitted.
6355
6356
6357 .section "Lookup types" "SECID61"
6358 .cindex "lookup" "types of"
6359 .cindex "single-key lookup" "definition of"
6360 Two different types of data lookup are implemented:
6361
6362 .ilist
6363 The &'single-key'& type requires the specification of a file in which to look,
6364 and a single key to search for. The key must be a non-empty string for the
6365 lookup to succeed. The lookup type determines how the file is searched.
6366 .next
6367 .cindex "query-style lookup" "definition of"
6368 The &'query-style'& type accepts a generalized database query. No particular
6369 key value is assumed by Exim for query-style lookups. You can use whichever
6370 Exim variables you need to construct the database query.
6371 .endlist
6372
6373 The code for each lookup type is in a separate source file that is included in
6374 the binary of Exim only if the corresponding compile-time option is set. The
6375 default settings in &_src/EDITME_& are:
6376 .code
6377 LOOKUP_DBM=yes
6378 LOOKUP_LSEARCH=yes
6379 .endd
6380 which means that only linear searching and DBM lookups are included by default.
6381 For some types of lookup (e.g. SQL databases), you need to install appropriate
6382 libraries and header files before building Exim.
6383
6384
6385
6386
6387 .section "Single-key lookup types" "SECTsinglekeylookups"
6388 .cindex "lookup" "single-key types"
6389 .cindex "single-key lookup" "list of types"
6390 The following single-key lookup types are implemented:
6391
6392 .ilist
6393 .cindex "cdb" "description of"
6394 .cindex "lookup" "cdb"
6395 .cindex "binary zero" "in lookup key"
6396 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6397 string without a terminating binary zero. The cdb format is designed for
6398 indexed files that are read frequently and never updated, except by total
6399 re-creation. As such, it is particularly suitable for large files containing
6400 aliases or other indexed data referenced by an MTA. Information about cdb can
6401 be found in several places:
6402 .display
6403 &url(http://www.pobox.com/~djb/cdb.html)
6404 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6405 &url(http://packages.debian.org/stable/utils/freecdb.html)
6406 .endd
6407 A cdb distribution is not needed in order to build Exim with cdb support,
6408 because the code for reading cdb files is included directly in Exim itself.
6409 However, no means of building or testing cdb files is provided with Exim, so
6410 you need to obtain a cdb distribution in order to do this.
6411 .next
6412 .cindex "DBM" "lookup type"
6413 .cindex "lookup" "dbm"
6414 .cindex "binary zero" "in lookup key"
6415 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6416 DBM file by looking up the record with the given key. A terminating binary
6417 zero is included in the key that is passed to the DBM library. See section
6418 &<<SECTdb>>& for a discussion of DBM libraries.
6419
6420 .cindex "Berkeley DB library" "file format"
6421 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6422 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6423 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6424 the DB_UNKNOWN option. This enables it to handle any of the types of database
6425 that the library supports, and can be useful for accessing DBM files created by
6426 other applications. (For earlier DB versions, DB_HASH is always used.)
6427 .next
6428 .cindex "lookup" "dbmjz"
6429 .cindex "lookup" "dbm &-- embedded NULs"
6430 .cindex "sasldb2"
6431 .cindex "dbmjz lookup type"
6432 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6433 interpreted as an Exim list; the elements of the list are joined together with
6434 ASCII NUL characters to form the lookup key.  An example usage would be to
6435 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6436 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6437 &(cram_md5)& authenticator.
6438 .next
6439 .cindex "lookup" "dbmnz"
6440 .cindex "lookup" "dbm &-- terminating zero"
6441 .cindex "binary zero" "in lookup key"
6442 .cindex "Courier"
6443 .cindex "&_/etc/userdbshadow.dat_&"
6444 .cindex "dbmnz lookup type"
6445 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6446 is not included in the key that is passed to the DBM library. You may need this
6447 if you want to look up data in files that are created by or shared with some
6448 other application that does not use terminating zeros. For example, you need to
6449 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6450 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6451 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6452 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6453 .next
6454 .cindex "lookup" "dsearch"
6455 .cindex "dsearch lookup type"
6456 &(dsearch)&: The given file must be a directory; this is searched for an entry
6457 whose name is the key by calling the &[lstat()]& function. The key may not
6458 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6459 the lookup is the name of the entry, which may be a file, directory,
6460 symbolic link, or any other kind of directory entry. An example of how this
6461 lookup can be used to support virtual domains is given in section
6462 &<<SECTvirtualdomains>>&.
6463 .next
6464 .cindex "lookup" "iplsearch"
6465 .cindex "iplsearch lookup type"
6466 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6467 terminated by a colon or white space or the end of the line. The keys in the
6468 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6469 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6470 being interpreted as a key terminator. For example:
6471 .code
6472 1.2.3.4:           data for 1.2.3.4
6473 192.168.0.0/16:    data for 192.168.0.0/16
6474 "abcd::cdab":      data for abcd::cdab
6475 "abcd:abcd::/32"   data for abcd:abcd::/32
6476 .endd
6477 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6478 file is searched linearly, using the CIDR masks where present, until a matching
6479 key is found. The first key that matches is used; there is no attempt to find a
6480 &"best"& match. Apart from the way the keys are matched, the processing for
6481 &(iplsearch)& is the same as for &(lsearch)&.
6482
6483 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6484 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6485 lookup types support only literal keys.
6486
6487 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6488 the implicit key is the host's IP address rather than its name (see section
6489 &<<SECThoslispatsikey>>&).
6490 .next
6491 .cindex "linear search"
6492 .cindex "lookup" "lsearch"
6493 .cindex "lsearch lookup type"
6494 .cindex "case sensitivity" "in lsearch lookup"
6495 &(lsearch)&: The given file is a text file that is searched linearly for a
6496 line beginning with the search key, terminated by a colon or white space or the
6497 end of the line. The search is case-insensitive; that is, upper and lower case
6498 letters are treated as the same. The first occurrence of the key that is found
6499 in the file is used.
6500
6501 White space between the key and the colon is permitted. The remainder of the
6502 line, with leading and trailing white space removed, is the data. This can be
6503 continued onto subsequent lines by starting them with any amount of white
6504 space, but only a single space character is included in the data at such a
6505 junction. If the data begins with a colon, the key must be terminated by a
6506 colon, for example:
6507 .code
6508 baduser:  :fail:
6509 .endd
6510 Empty lines and lines beginning with # are ignored, even if they occur in the
6511 middle of an item. This is the traditional textual format of alias files. Note
6512 that the keys in an &(lsearch)& file are literal strings. There is no
6513 wildcarding of any kind.
6514
6515 .cindex "lookup" "lsearch &-- colons in keys"
6516 .cindex "white space" "in lsearch key"
6517 In most &(lsearch)& files, keys are not required to contain colons or #
6518 characters, or white space. However, if you need this feature, it is available.
6519 If a key begins with a doublequote character, it is terminated only by a
6520 matching quote (or end of line), and the normal escaping rules apply to its
6521 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6522 quoted keys (exactly as for unquoted keys). There is no special handling of
6523 quotes for the data part of an &(lsearch)& line.
6524
6525 .next
6526 .cindex "NIS lookup type"
6527 .cindex "lookup" "NIS"
6528 .cindex "binary zero" "in lookup key"
6529 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6530 the given key, without a terminating binary zero. There is a variant called
6531 &(nis0)& which does include the terminating binary zero in the key. This is
6532 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6533 aliases; the full map names must be used.
6534
6535 .next
6536 .cindex "wildlsearch lookup type"
6537 .cindex "lookup" "wildlsearch"
6538 .cindex "nwildlsearch lookup type"
6539 .cindex "lookup" "nwildlsearch"
6540 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6541 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6542 the file may be wildcarded. The difference between these two lookup types is
6543 that for &(wildlsearch)&, each key in the file is string-expanded before being
6544 used, whereas for &(nwildlsearch)&, no expansion takes place.
6545
6546 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6547 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6548 file that are regular expressions can be made case-sensitive by the use of
6549 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6550
6551 . ==== As this is a nested list, any displays it contains must be indented
6552 . ==== as otherwise they are too far to the left.
6553
6554 .olist
6555 The string may begin with an asterisk to mean &"ends with"&. For example:
6556 .code
6557     *.a.b.c       data for anything.a.b.c
6558     *fish         data for anythingfish
6559 .endd
6560 .next
6561 The string may begin with a circumflex to indicate a regular expression. For
6562 example, for &(wildlsearch)&:
6563 .code
6564     ^\N\d+\.a\.b\N    data for <digits>.a.b
6565 .endd
6566 Note the use of &`\N`& to disable expansion of the contents of the regular
6567 expression. If you are using &(nwildlsearch)&, where the keys are not
6568 string-expanded, the equivalent entry is:
6569 .code
6570     ^\d+\.a\.b        data for <digits>.a.b
6571 .endd
6572 The case-insensitive flag is set at the start of compiling the regular
6573 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6574 For example, to make the entire pattern case-sensitive:
6575 .code
6576     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6577 .endd
6578
6579 If the regular expression contains white space or colon characters, you must
6580 either quote it (see &(lsearch)& above), or represent these characters in other
6581 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6582 colon. This may be easier than quoting, because if you quote, you have to
6583 escape all the backslashes inside the quotes.
6584
6585 &*Note*&: It is not possible to capture substrings in a regular expression
6586 match for later use, because the results of all lookups are cached. If a lookup
6587 is repeated, the result is taken from the cache, and no actual pattern matching
6588 takes place. The values of all the numeric variables are unset after a
6589 &((n)wildlsearch)& match.
6590
6591 .next
6592 Although I cannot see it being of much use, the general matching function that
6593 is used to implement &((n)wildlsearch)& means that the string may begin with a
6594 lookup name terminated by a semicolon, and followed by lookup data. For
6595 example:
6596 .code
6597     cdb;/some/file  data for keys that match the file
6598 .endd
6599 The data that is obtained from the nested lookup is discarded.
6600 .endlist olist
6601
6602 Keys that do not match any of these patterns are interpreted literally. The
6603 continuation rules for the data are the same as for &(lsearch)&, and keys may
6604 be followed by optional colons.
6605
6606 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6607 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6608 lookup types support only literal keys.
6609 .endlist ilist
6610
6611
6612 .section "Query-style lookup types" "SECID62"
6613 .cindex "lookup" "query-style types"
6614 .cindex "query-style lookup" "list of types"
6615 The supported query-style lookup types are listed below. Further details about
6616 many of them are given in later sections.
6617
6618 .ilist
6619 .cindex "DNS" "as a lookup type"
6620 .cindex "lookup" "DNS"
6621 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6622 are given in the supplied query. The resulting data is the contents of the
6623 records. See section &<<SECTdnsdb>>&.
6624 .next
6625 .cindex "InterBase lookup type"
6626 .cindex "lookup" "InterBase"
6627 &(ibase)&: This does a lookup in an InterBase database.
6628 .next
6629 .cindex "LDAP" "lookup type"
6630 .cindex "lookup" "LDAP"
6631 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6632 returns attributes from a single entry. There is a variant called &(ldapm)&
6633 that permits values from multiple entries to be returned. A third variant
6634 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6635 any attribute values. See section &<<SECTldap>>&.
6636 .next
6637 .cindex "MySQL" "lookup type"
6638 .cindex "lookup" "MySQL"
6639 &(mysql)&: The format of the query is an SQL statement that is passed to a
6640 MySQL database. See section &<<SECTsql>>&.
6641 .next
6642 .cindex "NIS+ lookup type"
6643 .cindex "lookup" "NIS+"
6644 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6645 the field to be returned. See section &<<SECTnisplus>>&.
6646 .next
6647 .cindex "Oracle" "lookup type"
6648 .cindex "lookup" "Oracle"
6649 &(oracle)&: The format of the query is an SQL statement that is passed to an
6650 Oracle database. See section &<<SECTsql>>&.
6651 .next
6652 .cindex "lookup" "passwd"
6653 .cindex "passwd lookup type"
6654 .cindex "&_/etc/passwd_&"
6655 &(passwd)& is a query-style lookup with queries that are just user names. The
6656 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6657 success, the result string is the same as you would get from an &(lsearch)&
6658 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6659 password value. For example:
6660 .code
6661 *:42:42:King Rat:/home/kr:/bin/bash
6662 .endd
6663 .next
6664 .cindex "PostgreSQL lookup type"
6665 .cindex "lookup" "PostgreSQL"
6666 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6667 PostgreSQL database. See section &<<SECTsql>>&.
6668
6669 .next
6670 .cindex "Redis lookup type"
6671 .cindex lookup Redis
6672 &(redis)&: The format of the query is an SQL statement that is passed to a
6673 Redis database. See section &<<SECTsql>>&.
6674
6675 .next
6676 .cindex "sqlite lookup type"
6677 .cindex "lookup" "sqlite"
6678 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6679 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6680
6681 .next
6682 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6683 not likely to be useful in normal operation.
6684 .next
6685 .cindex "whoson lookup type"
6686 .cindex "lookup" "whoson"
6687 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6688 allows a server to check whether a particular (dynamically allocated) IP
6689 address is currently allocated to a known (trusted) user and, optionally, to
6690 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6691 at one time for &"POP before SMTP"& authentication, but that approach has been
6692 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6693 &"POP before SMTP"& checking using ACL statements such as
6694 .code
6695 require condition = \
6696   ${lookup whoson {$sender_host_address}{yes}{no}}
6697 .endd
6698 The query consists of a single IP address. The value returned is the name of
6699 the authenticated user, which is stored in the variable &$value$&. However, in
6700 this example, the data in &$value$& is not used; the result of the lookup is
6701 one of the fixed strings &"yes"& or &"no"&.
6702 .endlist
6703
6704
6705
6706 .section "Temporary errors in lookups" "SECID63"
6707 .cindex "lookup" "temporary error in"
6708 Lookup functions can return temporary error codes if the lookup cannot be
6709 completed. For example, an SQL or LDAP database might be unavailable. For this
6710 reason, it is not advisable to use a lookup that might do this for critical
6711 options such as a list of local domains.
6712
6713 When a lookup cannot be completed in a router or transport, delivery
6714 of the message (to the relevant address) is deferred, as for any other
6715 temporary error. In other circumstances Exim may assume the lookup has failed,
6716 or may give up altogether.
6717
6718
6719
6720 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6721 .cindex "wildcard lookups"
6722 .cindex "lookup" "default values"
6723 .cindex "lookup" "wildcard"
6724 .cindex "lookup" "* added to type"
6725 .cindex "default" "in single-key lookups"
6726 In this context, a &"default value"& is a value specified by the administrator
6727 that is to be used if a lookup fails.
6728
6729 &*Note:*& This section applies only to single-key lookups. For query-style
6730 lookups, the facilities of the query language must be used. An attempt to
6731 specify a default for a query-style lookup provokes an error.
6732
6733 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6734 and the initial lookup fails, the key &"*"& is looked up in the file to
6735 provide a default value. See also the section on partial matching below.
6736
6737 .cindex "*@ with single-key lookup"
6738 .cindex "lookup" "*@ added to type"
6739 .cindex "alias file" "per-domain default"
6740 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6741 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6742 character, a second lookup is done with everything before the last @ replaced
6743 by *. This makes it possible to provide per-domain defaults in alias files
6744 that include the domains in the keys. If the second lookup fails (or doesn't
6745 take place because there is no @ in the key), &"*"& is looked up.
6746 For example, a &(redirect)& router might contain:
6747 .code
6748 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6749 .endd
6750 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6751 looks up these keys, in this order:
6752 .code
6753 jane@eyre.example
6754 *@eyre.example
6755 *
6756 .endd
6757 The data is taken from whichever key it finds first. &*Note*&: In an
6758 &(lsearch)& file, this does not mean the first of these keys in the file. A
6759 complete scan is done for each key, and only if it is not found at all does
6760 Exim move on to try the next key.
6761
6762
6763
6764 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6765 .cindex "partial matching"
6766 .cindex "wildcard lookups"
6767 .cindex "lookup" "partial matching"
6768 .cindex "lookup" "wildcard"
6769 .cindex "asterisk" "in search type"
6770 The normal operation of a single-key lookup is to search the file for an exact
6771 match with the given key. However, in a number of situations where domains are
6772 being looked up, it is useful to be able to do partial matching. In this case,
6773 information in the file that has a key starting with &"*."& is matched by any
6774 domain that ends with the components that follow the full stop. For example, if
6775 a key in a DBM file is
6776 .code
6777 *.dates.fict.example
6778 .endd
6779 then when partial matching is enabled this is matched by (amongst others)
6780 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6781 by &'dates.fict.example'&, if that does not appear as a separate key in the
6782 file.
6783
6784 &*Note*&: Partial matching is not available for query-style lookups. It is
6785 also not available for any lookup items in address lists (see section
6786 &<<SECTaddresslist>>&).
6787
6788 Partial matching is implemented by doing a series of separate lookups using
6789 keys constructed by modifying the original subject key. This means that it can
6790 be used with any of the single-key lookup types, provided that
6791 partial matching keys
6792 beginning with a special prefix (default &"*."&) are included in the data file.
6793 Keys in the file that do not begin with the prefix are matched only by
6794 unmodified subject keys when partial matching is in use.
6795
6796 Partial matching is requested by adding the string &"partial-"& to the front of
6797 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6798 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6799 is added at the start of the subject key, and it is looked up again. If that
6800 fails, further lookups are tried with dot-separated components removed from the
6801 start of the subject key, one-by-one, and &"*."& added on the front of what
6802 remains.
6803
6804 A minimum number of two non-* components are required. This can be adjusted
6805 by including a number before the hyphen in the search type. For example,
6806 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6807 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6808 subject key is &'2250.dates.fict.example'& then the following keys are looked
6809 up when the minimum number of non-* components is two:
6810 .code
6811 2250.dates.fict.example
6812 *.2250.dates.fict.example
6813 *.dates.fict.example
6814 *.fict.example
6815 .endd
6816 As soon as one key in the sequence is successfully looked up, the lookup
6817 finishes.
6818
6819 .cindex "lookup" "partial matching &-- changing prefix"
6820 .cindex "prefix" "for partial matching"
6821 The use of &"*."& as the partial matching prefix is a default that can be
6822 changed. The motivation for this feature is to allow Exim to operate with file
6823 formats that are used by other MTAs. A different prefix can be supplied in
6824 parentheses instead of the hyphen after &"partial"&. For example:
6825 .code
6826 domains = partial(.)lsearch;/some/file
6827 .endd
6828 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6829 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6830 components is unchanged). The prefix may consist of any punctuation characters
6831 other than a closing parenthesis. It may be empty, for example:
6832 .code
6833 domains = partial1()cdb;/some/file
6834 .endd
6835 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6836 &`a.b.c`&, &`b.c`&, and &`c`&.
6837
6838 If &"partial0"& is specified, what happens at the end (when the lookup with
6839 just one non-wild component has failed, and the original key is shortened right
6840 down to the null string) depends on the prefix:
6841
6842 .ilist
6843 If the prefix has zero length, the whole lookup fails.
6844 .next
6845 If the prefix has length 1, a lookup for just the prefix is done. For
6846 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6847 .next
6848 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6849 remainder is looked up. With the default prefix, therefore, the final lookup is
6850 for &"*"& on its own.
6851 .next
6852 Otherwise, the whole prefix is looked up.
6853 .endlist
6854
6855
6856 If the search type ends in &"*"& or &"*@"& (see section
6857 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6858 this implies happens after all partial lookups have failed. If &"partial0"& is
6859 specified, adding &"*"& to the search type has no effect with the default
6860 prefix, because the &"*"& key is already included in the sequence of partial
6861 lookups. However, there might be a use for lookup types such as
6862 &"partial0(.)lsearch*"&.
6863
6864 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6865 in domain lists and the like. Partial matching works only in terms of
6866 dot-separated components; a key such as &`*fict.example`&
6867 in a database file is useless, because the asterisk in a partial matching
6868 subject key is always followed by a dot.
6869
6870
6871
6872
6873 .section "Lookup caching" "SECID64"
6874 .cindex "lookup" "caching"
6875 .cindex "caching" "lookup data"
6876 Exim caches all lookup results in order to avoid needless repetition of
6877 lookups. However, because (apart from the daemon) Exim operates as a collection
6878 of independent, short-lived processes, this caching applies only within a
6879 single Exim process. There is no inter-process lookup caching facility.
6880
6881 For single-key lookups, Exim keeps the relevant files open in case there is
6882 another lookup that needs them. In some types of configuration this can lead to
6883 many files being kept open for messages with many recipients. To avoid hitting
6884 the operating system limit on the number of simultaneously open files, Exim
6885 closes the least recently used file when it needs to open more files than its
6886 own internal limit, which can be changed via the &%lookup_open_max%& option.
6887
6888 The single-key lookup files are closed and the lookup caches are flushed at
6889 strategic points during delivery &-- for example, after all routing is
6890 complete.
6891
6892
6893
6894
6895 .section "Quoting lookup data" "SECID65"
6896 .cindex "lookup" "quoting"
6897 .cindex "quoting" "in lookups"
6898 When data from an incoming message is included in a query-style lookup, there
6899 is the possibility of special characters in the data messing up the syntax of
6900 the query. For example, a NIS+ query that contains
6901 .code
6902 [name=$local_part]
6903 .endd
6904 will be broken if the local part happens to contain a closing square bracket.
6905 For NIS+, data can be enclosed in double quotes like this:
6906 .code
6907 [name="$local_part"]
6908 .endd
6909 but this still leaves the problem of a double quote in the data. The rule for
6910 NIS+ is that double quotes must be doubled. Other lookup types have different
6911 rules, and to cope with the differing requirements, an expansion operator
6912 of the following form is provided:
6913 .code
6914 ${quote_<lookup-type>:<string>}
6915 .endd
6916 For example, the safest way to write the NIS+ query is
6917 .code
6918 [name="${quote_nisplus:$local_part}"]
6919 .endd
6920 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6921 operator can be used for all lookup types, but has no effect for single-key
6922 lookups, since no quoting is ever needed in their key strings.
6923
6924
6925
6926
6927 .section "More about dnsdb" "SECTdnsdb"
6928 .cindex "dnsdb lookup"
6929 .cindex "lookup" "dnsdb"
6930 .cindex "DNS" "as a lookup type"
6931 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6932 of a record type and a domain name, separated by an equals sign. For example,
6933 an expansion string could contain:
6934 .code
6935 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6936 .endd
6937 If the lookup succeeds, the result is placed in &$value$&, which in this case
6938 is used on its own as the result. If the lookup does not succeed, the
6939 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6940 &<<SECTforexpfai>>& for an explanation of what this means.
6941
6942 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6943 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6944 If no type is given, TXT is assumed.
6945
6946 For any record type, if multiple records are found, the data is returned as a
6947 concatenation, with newline as the default separator. The order, of course,
6948 depends on the DNS resolver. You can specify a different separator character
6949 between multiple records by putting a right angle-bracket followed immediately
6950 by the new separator at the start of the query. For example:
6951 .code
6952 ${lookup dnsdb{>: a=host1.example}}
6953 .endd
6954 It is permitted to specify a space as the separator character. Further
6955 white space is ignored.
6956 For lookup types that return multiple fields per record,
6957 an alternate field separator can be specified using a comma after the main
6958 separator character, followed immediately by the field separator.
6959
6960 .cindex "PTR record" "in &(dnsdb)& lookup"
6961 When the type is PTR,
6962 the data can be an IP address, written as normal; inversion and the addition of
6963 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6964 .code
6965 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6966 .endd
6967 If the data for a PTR record is not a syntactically valid IP address, it is not
6968 altered and nothing is added.
6969
6970 .cindex "MX record" "in &(dnsdb)& lookup"
6971 .cindex "SRV record" "in &(dnsdb)& lookup"
6972 For an MX lookup, both the preference value and the host name are returned for
6973 each record, separated by a space. For an SRV lookup, the priority, weight,
6974 port, and host name are returned for each record, separated by spaces.
6975 The field separator can be modified as above.
6976
6977 .cindex "TXT record" "in &(dnsdb)& lookup"
6978 .cindex "SPF record" "in &(dnsdb)& lookup"
6979 For TXT records with multiple items of data, only the first item is returned,
6980 unless a field separator is specified.
6981 To concatenate items without a separator, use a semicolon instead.
6982 For SPF records the
6983 default behaviour is to concatenate multiple items without using a separator.
6984 .code
6985 ${lookup dnsdb{>\n,: txt=a.b.example}}
6986 ${lookup dnsdb{>\n; txt=a.b.example}}
6987 ${lookup dnsdb{spf=example.org}}
6988 .endd
6989 It is permitted to specify a space as the separator character. Further
6990 white space is ignored.
6991
6992 .cindex "SOA record" "in &(dnsdb)& lookup"
6993 For an SOA lookup, while no result is obtained the lookup is redone with
6994 successively more leading components dropped from the given domain.
6995 Only the primary-nameserver field is returned unless a field separator is
6996 specified.
6997 .code
6998 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6999 .endd
7000
7001 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7002 .cindex "dnsdb modifiers"
7003 .cindex "modifiers" "dnsdb"
7004 .cindex "options" "dnsdb"
7005 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7006 each followed by a comma,
7007 that may appear before the record type.
7008
7009 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7010 temporary DNS error for any of them, the behaviour is controlled by
7011 a defer-option modifier.
7012 The possible keywords are
7013 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7014 With &"strict"& behaviour, any temporary DNS error causes the
7015 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7016 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7017 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7018 error causes the whole lookup to defer only if none of the other lookups
7019 succeed. The default is &"lax"&, so the following lookups are equivalent:
7020 .code
7021 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7022 ${lookup dnsdb{a=one.host.com:two.host.com}}
7023 .endd
7024 Thus, in the default case, as long as at least one of the DNS lookups
7025 yields some data, the lookup succeeds.
7026
7027 .cindex "DNSSEC" "dns lookup"
7028 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7029 The possible keywords are
7030 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7031 With &"strict"& or &"lax"& DNSSEC information is requested
7032 with the lookup.
7033 With &"strict"& a response from the DNS resolver that
7034 is not labelled as authenticated data
7035 is treated as equivalent to a temporary DNS error.
7036 The default is &"never"&.
7037
7038 See also the &$lookup_dnssec_authenticated$& variable.
7039
7040 .cindex timeout "dns lookup"
7041 .cindex "DNS" timeout
7042 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7043 The form is &"retrans_VAL"& where VAL is an Exim time specification
7044 (e.g. &"5s"&).
7045 The default value is set by the main configuration option &%dns_retrans%&.
7046
7047 Retries for the dnsdb lookup can be controlled by a retry modifier.
7048 The form if &"retry_VAL"& where VAL is an integer.
7049 The default count is set by the main configuration option &%dns_retry%&.
7050
7051 .cindex cacheing "of dns lookup"
7052 .cindex TTL "of dns lookup"
7053 .cindex DNS TTL
7054 Dnsdb lookup results are cached within a single process (and its children).
7055 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7056 value of the set of returned DNS records.
7057
7058
7059 .section "Pseudo dnsdb record types" "SECID66"
7060 .cindex "MX record" "in &(dnsdb)& lookup"
7061 By default, both the preference value and the host name are returned for
7062 each MX record, separated by a space. If you want only host names, you can use
7063 the pseudo-type MXH:
7064 .code
7065 ${lookup dnsdb{mxh=a.b.example}}
7066 .endd
7067 In this case, the preference values are omitted, and just the host names are
7068 returned.
7069
7070 .cindex "name server for enclosing domain"
7071 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7072 records on the given domain, but if none are found, it removes the first
7073 component of the domain name, and tries again. This process continues until NS
7074 records are found or there are no more components left (or there is a DNS
7075 error). In other words, it may return the name servers for a top-level domain,
7076 but it never returns the root name servers. If there are no NS records for the
7077 top-level domain, the lookup fails. Consider these examples:
7078 .code
7079 ${lookup dnsdb{zns=xxx.quercite.com}}
7080 ${lookup dnsdb{zns=xxx.edu}}
7081 .endd
7082 Assuming that in each case there are no NS records for the full domain name,
7083 the first returns the name servers for &%quercite.com%&, and the second returns
7084 the name servers for &%edu%&.
7085
7086 You should be careful about how you use this lookup because, unless the
7087 top-level domain does not exist, the lookup always returns some host names. The
7088 sort of use to which this might be put is for seeing if the name servers for a
7089 given domain are on a blacklist. You can probably assume that the name servers
7090 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7091 such a list.
7092
7093 .cindex "CSA" "in &(dnsdb)& lookup"
7094 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7095 records according to the CSA rules, which are described in section
7096 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7097 not sufficient because of the extra parent domain search behaviour of CSA. The
7098 result of a successful lookup such as:
7099 .code
7100 ${lookup dnsdb {csa=$sender_helo_name}}
7101 .endd
7102 has two space-separated fields: an authorization code and a target host name.
7103 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7104 authorization required but absent, or &"?"& for unknown.
7105
7106 .cindex "A+" "in &(dnsdb)& lookup"
7107 The pseudo-type A+ performs an AAAA
7108 and then an A lookup.  All results are returned; defer processing
7109 (see below) is handled separately for each lookup.  Example:
7110 .code
7111 ${lookup dnsdb {>; a+=$sender_helo_name}}
7112 .endd
7113
7114
7115 .section "Multiple dnsdb lookups" "SECID67"
7116 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7117 However, you can specify a list of domains or IP addresses in a single
7118 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7119 the default separator, but with the ability to change this. For example:
7120 .code
7121 ${lookup dnsdb{one.domain.com:two.domain.com}}
7122 ${lookup dnsdb{a=one.host.com:two.host.com}}
7123 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7124 .endd
7125 In order to retain backwards compatibility, there is one special case: if
7126 the lookup type is PTR and no change of separator is specified, Exim looks
7127 to see if the rest of the string is precisely one IPv6 address. In this
7128 case, it does not treat it as a list.
7129
7130 The data from each lookup is concatenated, with newline separators by default,
7131 in the same way that multiple DNS records for a single item are handled. A
7132 different separator can be specified, as described above.
7133
7134
7135
7136
7137 .section "More about LDAP" "SECTldap"
7138 .cindex "LDAP" "lookup, more about"
7139 .cindex "lookup" "LDAP"
7140 .cindex "Solaris" "LDAP"
7141 The original LDAP implementation came from the University of Michigan; this has
7142 become &"Open LDAP"&, and there are now two different releases. Another
7143 implementation comes from Netscape, and Solaris 7 and subsequent releases
7144 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7145 the lookup function level, their error handling is different. For this reason
7146 it is necessary to set a compile-time variable when building Exim with LDAP, to
7147 indicate which LDAP library is in use. One of the following should appear in
7148 your &_Local/Makefile_&:
7149 .code
7150 LDAP_LIB_TYPE=UMICHIGAN
7151 LDAP_LIB_TYPE=OPENLDAP1
7152 LDAP_LIB_TYPE=OPENLDAP2
7153 LDAP_LIB_TYPE=NETSCAPE
7154 LDAP_LIB_TYPE=SOLARIS
7155 .endd
7156 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7157 same interface as the University of Michigan version.
7158
7159 There are three LDAP lookup types in Exim. These behave slightly differently in
7160 the way they handle the results of a query:
7161
7162 .ilist
7163 &(ldap)& requires the result to contain just one entry; if there are more, it
7164 gives an error.
7165 .next
7166 &(ldapdn)& also requires the result to contain just one entry, but it is the
7167 Distinguished Name that is returned rather than any attribute values.
7168 .next
7169 &(ldapm)& permits the result to contain more than one entry; the attributes
7170 from all of them are returned.
7171 .endlist
7172
7173
7174 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7175 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7176 the data returned by a successful lookup is described in the next section.
7177 First we explain how LDAP queries are coded.
7178
7179
7180 .section "Format of LDAP queries" "SECTforldaque"
7181 .cindex "LDAP" "query format"
7182 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7183 the configuration of a &(redirect)& router one might have this setting:
7184 .code
7185 data = ${lookup ldap \
7186   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7187   c=UK?mailbox?base?}}
7188 .endd
7189 .cindex "LDAP" "with TLS"
7190 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7191 secure (encrypted) LDAP connections. The second of these ensures that an
7192 encrypted TLS connection is used.
7193
7194 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7195 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7196 See the &%ldap_start_tls%& option.
7197
7198 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7199 controlled. Every part of the TLS configuration can be configured by settings in
7200 &_exim.conf_&. Depending on the version of the client libraries installed on
7201 your system, some of the initialization may have required setting options in
7202 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7203 certificates. This revealed a nuance where the current UID that exim was
7204 running as could affect which config files it read. With Exim 4.83, these
7205 methods become optional, only taking effect if not specifically set in
7206 &_exim.conf_&.
7207
7208
7209 .section "LDAP quoting" "SECID68"
7210 .cindex "LDAP" "quoting"
7211 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7212 and the second because the LDAP query is represented as a URL. Furthermore,
7213 within an LDAP query, two different kinds of quoting are required. For this
7214 reason, there are two different LDAP-specific quoting operators.
7215
7216 The &%quote_ldap%& operator is designed for use on strings that are part of
7217 filter specifications. Conceptually, it first does the following conversions on
7218 the string:
7219 .code
7220 *   =>   \2A
7221 (   =>   \28
7222 )   =>   \29
7223 \   =>   \5C
7224 .endd
7225 in accordance with RFC 2254. The resulting string is then quoted according
7226 to the rules for URLs, that is, all non-alphanumeric characters except
7227 .code
7228 ! $ ' - . _ ( ) * +
7229 .endd
7230 are converted to their hex values, preceded by a percent sign. For example:
7231 .code
7232 ${quote_ldap: a(bc)*, a<yz>; }
7233 .endd
7234 yields
7235 .code
7236 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7237 .endd
7238 Removing the URL quoting, this is (with a leading and a trailing space):
7239 .code
7240 a\28bc\29\2A, a<yz>;
7241 .endd
7242 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7243 base DN specifications in queries. Conceptually, it first converts the string
7244 by inserting a backslash in front of any of the following characters:
7245 .code
7246 , + " \ < > ;
7247 .endd
7248 It also inserts a backslash before any leading spaces or # characters, and
7249 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7250 is then quoted according to the rules for URLs. For example:
7251 .code
7252 ${quote_ldap_dn: a(bc)*, a<yz>; }
7253 .endd
7254 yields
7255 .code
7256 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7257 .endd
7258 Removing the URL quoting, this is (with a trailing space):
7259 .code
7260 \ a(bc)*\, a\<yz\>\;\
7261 .endd
7262 There are some further comments about quoting in the section on LDAP
7263 authentication below.
7264
7265
7266 .section "LDAP connections" "SECID69"
7267 .cindex "LDAP" "connections"
7268 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7269 is in use, via a Unix domain socket. The example given above does not specify
7270 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7271 by starting it with
7272 .code
7273 ldap://<hostname>:<port>/...
7274 .endd
7275 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7276 used. When no server is specified in a query, a list of default servers is
7277 taken from the &%ldap_default_servers%& configuration option. This supplies a
7278 colon-separated list of servers which are tried in turn until one successfully
7279 handles a query, or there is a serious error. Successful handling either
7280 returns the requested data, or indicates that it does not exist. Serious errors
7281 are syntactical, or multiple values when only a single value is expected.
7282 Errors which cause the next server to be tried are connection failures, bind
7283 failures, and timeouts.
7284
7285 For each server name in the list, a port number can be given. The standard way
7286 of specifying a host and port is to use a colon separator (RFC 1738). Because
7287 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7288 doubled. For example
7289 .code
7290 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7291 .endd
7292 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7293 to the LDAP library with no server name, and the library's default (normally
7294 the local host) is used.
7295
7296 If you are using the OpenLDAP library, you can connect to an LDAP server using
7297 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7298 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7299 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7300 not available.
7301
7302 For this type of connection, instead of a host name for the server, a pathname
7303 for the socket is required, and the port number is not relevant. The pathname
7304 can be specified either as an item in &%ldap_default_servers%&, or inline in
7305 the query. In the former case, you can have settings such as
7306 .code
7307 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7308 .endd
7309 When the pathname is given in the query, you have to escape the slashes as
7310 &`%2F`& to fit in with the LDAP URL syntax. For example:
7311 .code
7312 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7313 .endd
7314 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7315 a pathname, it uses the Unix domain socket code, even if the query actually
7316 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7317 socket connection. This behaviour means that you can use a setting of
7318 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7319 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7320 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7321 backup host.
7322
7323 If an explicit &`ldapi`& type is given in a query when a host name is
7324 specified, an error is diagnosed. However, if there are more items in
7325 &%ldap_default_servers%&, they are tried. In other words:
7326
7327 .ilist
7328 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7329 interface.
7330 .next
7331 Using &`ldapi`& with a host name causes an error.
7332 .endlist
7333
7334
7335 Using &`ldapi`& with no host or path in the query, and no setting of
7336 &%ldap_default_servers%&, does whatever the library does by default.
7337
7338
7339
7340 .section "LDAP authentication and control information" "SECID70"
7341 .cindex "LDAP" "authentication"
7342 The LDAP URL syntax provides no way of passing authentication and other control
7343 information to the server. To make this possible, the URL in an LDAP query may
7344 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7345 spaces. If a value contains spaces it must be enclosed in double quotes, and
7346 when double quotes are used, backslash is interpreted in the usual way inside
7347 them. The following names are recognized:
7348 .display
7349 &`DEREFERENCE`&  set the dereferencing parameter
7350 &`NETTIME    `&  set a timeout for a network operation
7351 &`USER       `&  set the DN, for authenticating the LDAP bind
7352 &`PASS       `&  set the password, likewise
7353 &`REFERRALS  `&  set the referrals parameter
7354 &`SERVERS    `&  set alternate server list for this query only
7355 &`SIZE       `&  set the limit for the number of entries returned
7356 &`TIME       `&  set the maximum waiting time for a query
7357 .endd
7358 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7359 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7360 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7361 library from trying to follow referrals issued by the LDAP server.
7362
7363 .cindex LDAP timeout
7364 .cindex timeout "LDAP lookup"
7365 The name CONNECT is an obsolete name for NETTIME, retained for
7366 backwards compatibility. This timeout (specified as a number of seconds) is
7367 enforced from the client end for operations that can be carried out over a
7368 network. Specifically, it applies to network connections and calls to the
7369 &'ldap_result()'& function. If the value is greater than zero, it is used if
7370 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7371 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7372 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7373 Netscape SDK; for OpenLDAP no action is taken.
7374
7375 The TIME parameter (also a number of seconds) is passed to the server to
7376 set a server-side limit on the time taken to complete a search.
7377
7378 The SERVERS parameter allows you to specify an alternate list of ldap servers
7379 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7380 default list of ldap servers, and a single lookup can specify a single ldap
7381 server to use.  But when you need to do a lookup with a list of servers that is
7382 different than the default list (maybe different order, maybe a completely
7383 different set of servers), the SERVERS parameter allows you to specify this
7384 alternate list (colon-separated).
7385
7386 Here is an example of an LDAP query in an Exim lookup that uses some of these
7387 values. This is a single line, folded to fit on the page:
7388 .code
7389 ${lookup ldap
7390   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7391   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7392   {$value}fail}
7393 .endd
7394 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7395 any of the auxiliary data. Exim configuration settings that include lookups
7396 which contain password information should be preceded by &"hide"& to prevent
7397 non-admin users from using the &%-bP%& option to see their values.
7398
7399 The auxiliary data items may be given in any order. The default is no
7400 connection timeout (the system timeout is used), no user or password, no limit
7401 on the number of entries returned, and no time limit on queries.
7402
7403 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7404 removes any URL quoting that it may contain before passing it LDAP. Apparently
7405 some libraries do this for themselves, but some do not. Removing the URL
7406 quoting has two advantages:
7407
7408 .ilist
7409 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7410 DNs as with DNs inside actual queries.
7411 .next
7412 It permits spaces inside USER= DNs.
7413 .endlist
7414
7415 For example, a setting such as
7416 .code
7417 USER=cn=${quote_ldap_dn:$1}
7418 .endd
7419 should work even if &$1$& contains spaces.
7420
7421 Expanded data for the PASS= value should be quoted using the &%quote%&
7422 expansion operator, rather than the LDAP quote operators. The only reason this
7423 field needs quoting is to ensure that it conforms to the Exim syntax, which
7424 does not allow unquoted spaces. For example:
7425 .code
7426 PASS=${quote:$3}
7427 .endd
7428 The LDAP authentication mechanism can be used to check passwords as part of
7429 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7430 &<<CHAPexpand>>&.
7431
7432
7433
7434 .section "Format of data returned by LDAP" "SECID71"
7435 .cindex "LDAP" "returned data formats"
7436 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7437 as a sequence of values, for example
7438 .code
7439 cn=manager,o=University of Cambridge,c=UK
7440 .endd
7441 The &(ldap)& lookup type generates an error if more than one entry matches the
7442 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7443 the result between the data from different entries. It is possible for multiple
7444 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7445 you know that whatever values are returned all came from a single entry in the
7446 directory.
7447
7448 In the common case where you specify a single attribute in your LDAP query, the
7449 result is not quoted, and does not contain the attribute name. If the attribute
7450 has multiple values, they are separated by commas. Any comma that is
7451 part of an attribute's value is doubled.
7452
7453 If you specify multiple attributes, the result contains space-separated, quoted
7454 strings, each preceded by the attribute name and an equals sign. Within the
7455 quotes, the quote character, backslash, and newline are escaped with
7456 backslashes, and commas are used to separate multiple values for the attribute.
7457 Any commas in attribute values are doubled
7458 (permitting treatment of the values as a comma-separated list).
7459 Apart from the escaping, the string within quotes takes the same form as the
7460 output when a single attribute is requested. Specifying no attributes is the
7461 same as specifying all of an entry's attributes.
7462
7463 Here are some examples of the output format. The first line of each pair is an
7464 LDAP query, and the second is the data that is returned. The attribute called
7465 &%attr1%& has two values, one of them with an embedded comma, whereas
7466 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7467 (they have SUP &%attr%& in their schema definitions).
7468
7469 .code
7470 ldap:///o=base?attr1?sub?(uid=fred)
7471 value1.1,value1,,2
7472
7473 ldap:///o=base?attr2?sub?(uid=fred)
7474 value two
7475
7476 ldap:///o=base?attr?sub?(uid=fred)
7477 value1.1,value1,,2,value two
7478
7479 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7480 attr1="value1.1,value1,,2" attr2="value two"
7481
7482 ldap:///o=base??sub?(uid=fred)
7483 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7484 .endd
7485 You can
7486 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7487 results of LDAP lookups.
7488 The &%extract%& operator in string expansions can be used to pick out
7489 individual fields from data that consists of &'key'&=&'value'& pairs.
7490 The &%listextract%& operator should be used to pick out individual values
7491 of attributes, even when only a single value is expected.
7492 The doubling of embedded commas allows you to use the returned data as a
7493 comma separated list (using the "<," syntax for changing the input list separator).
7494
7495
7496
7497
7498 .section "More about NIS+" "SECTnisplus"
7499 .cindex "NIS+ lookup type"
7500 .cindex "lookup" "NIS+"
7501 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7502 and field name. If this is given, the result of a successful query is the
7503 contents of the named field; otherwise the result consists of a concatenation
7504 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7505 values containing spaces are quoted. For example, the query
7506 .code
7507 [name=mg1456],passwd.org_dir
7508 .endd
7509 might return the string
7510 .code
7511 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7512 home=/home/mg1456 shell=/bin/bash shadow=""
7513 .endd
7514 (split over two lines here to fit on the page), whereas
7515 .code
7516 [name=mg1456],passwd.org_dir:gcos
7517 .endd
7518 would just return
7519 .code
7520 Martin Guerre
7521 .endd
7522 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7523 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7524 operator is to double any quote characters within the text.
7525
7526
7527
7528 .section "SQL lookups" "SECTsql"
7529 .cindex "SQL lookup types"
7530 .cindex "MySQL" "lookup type"
7531 .cindex "PostgreSQL lookup type"
7532 .cindex "lookup" "MySQL"
7533 .cindex "lookup" "PostgreSQL"
7534 .cindex "Oracle" "lookup type"
7535 .cindex "lookup" "Oracle"
7536 .cindex "InterBase lookup type"
7537 .cindex "lookup" "InterBase"
7538 .cindex "Redis lookup type"
7539 .cindex lookup Redis
7540 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7541 and SQLite
7542 databases. Queries for these databases contain SQL statements, so an example
7543 might be
7544 .code
7545 ${lookup mysql{select mailbox from users where id='userx'}\
7546   {$value}fail}
7547 .endd
7548 If the result of the query contains more than one field, the data for each
7549 field in the row is returned, preceded by its name, so the result of
7550 .code
7551 ${lookup pgsql{select home,name from users where id='userx'}\
7552   {$value}}
7553 .endd
7554 might be
7555 .code
7556 home=/home/userx name="Mister X"
7557 .endd
7558 Empty values and values containing spaces are double quoted, with embedded
7559 quotes escaped by a backslash. If the result of the query contains just one
7560 field, the value is passed back verbatim, without a field name, for example:
7561 .code
7562 Mister X
7563 .endd
7564 If the result of the query yields more than one row, it is all concatenated,
7565 with a newline between the data for each row.
7566
7567
7568 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7569 .cindex "MySQL" "lookup type"
7570 .cindex "PostgreSQL lookup type"
7571 .cindex "lookup" "MySQL"
7572 .cindex "lookup" "PostgreSQL"
7573 .cindex "Oracle" "lookup type"
7574 .cindex "lookup" "Oracle"
7575 .cindex "InterBase lookup type"
7576 .cindex "lookup" "InterBase"
7577 .cindex "Redis lookup type"
7578 .cindex lookup Redis
7579 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7580 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7581 or &%redis_servers%&
7582 option (as appropriate) must be set to a colon-separated list of server
7583 information.
7584 (For MySQL and PostgreSQL, the global option need not be set if all
7585 queries contain their own server information &-- see section
7586 &<<SECTspeserque>>&.)
7587 For all but Redis
7588 each item in the list is a slash-separated list of four
7589 items: host name, database name, user name, and password. In the case of
7590 Oracle, the host name field is used for the &"service name"&, and the database
7591 name field is not used and should be empty. For example:
7592 .code
7593 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7594 .endd
7595 Because password data is sensitive, you should always precede the setting with
7596 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7597 option. Here is an example where two MySQL servers are listed:
7598 .code
7599 hide mysql_servers = localhost/users/root/secret:\
7600                      otherhost/users/root/othersecret
7601 .endd
7602 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7603 because this is a colon-separated list, the colon has to be doubled. For each
7604 query, these parameter groups are tried in order until a connection is made and
7605 a query is successfully processed. The result of a query may be that no data is
7606 found, but that is still a successful query. In other words, the list of
7607 servers provides a backup facility, not a list of different places to look.
7608
7609 For Redis the global option need not be specified if all queries contain their
7610 own server information &-- see section &<<SECTspeserque>>&.
7611 If specified, the option must be set to a colon-separated list of server
7612 information.
7613 Each item in the list is a slash-separated list of three items:
7614 host, database number, and password.
7615 .olist
7616 The host is required and may be either an IPv4 address and optional
7617 port number (separated by a colon, which needs doubling due to the
7618 higher-level list), or a Unix socket pathname enclosed in parentheses
7619 .next
7620 The database number is optional; if present that number is selected in the backend
7621 .next
7622 The password is optional; if present it is used to authenticate to the backend
7623 .endlist
7624
7625 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7626 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7627 respectively, and the characters single-quote, double-quote, and backslash
7628 itself are escaped with backslashes.
7629
7630 The &%quote_redis%& expansion operator
7631 escapes whitespace and backslash characters with a backslash.
7632
7633 .section "Specifying the server in the query" "SECTspeserque"
7634 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7635 it is possible to specify a list of servers with an individual query. This is
7636 done by starting the query with
7637 .display
7638 &`servers=`&&'server1:server2:server3:...'&&`;`&
7639 .endd
7640 Each item in the list may take one of two forms:
7641 .olist
7642 If it contains no slashes it is assumed to be just a host name. The appropriate
7643 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7644 of the same name, and the remaining parameters (database, user, password) are
7645 taken from there.
7646 .next
7647 If it contains any slashes, it is taken as a complete parameter set.
7648 .endlist
7649 The list of servers is used in exactly the same way as the global list.
7650 Once a connection to a server has happened and a query has been
7651 successfully executed, processing of the lookup ceases.
7652
7653 This feature is intended for use in master/slave situations where updates
7654 are occurring and you want to update the master rather than a slave. If the
7655 master is in the list as a backup for reading, you might have a global setting
7656 like this:
7657 .code
7658 mysql_servers = slave1/db/name/pw:\
7659                 slave2/db/name/pw:\
7660                 master/db/name/pw
7661 .endd
7662 In an updating lookup, you could then write:
7663 .code
7664 ${lookup mysql{servers=master; UPDATE ...} }
7665 .endd
7666 That query would then be sent only to the master server. If, on the other hand,
7667 the master is not to be used for reading, and so is not present in the global
7668 option, you can still update it by a query of this form:
7669 .code
7670 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7671 .endd
7672
7673
7674 .section "Special MySQL features" "SECID73"
7675 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7676 causes a connection to the server on the local host by means of a Unix domain
7677 socket. An alternate socket can be specified in parentheses.
7678 An option group name for MySQL option files can be specified in square brackets;
7679 the default value is &"exim"&.
7680 The full syntax of each item in &%mysql_servers%& is:
7681 .display
7682 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7683   <&'database'&>/<&'user'&>/<&'password'&>
7684 .endd
7685 Any of the four sub-parts of the first field can be omitted. For normal use on
7686 the local host it can be left blank or set to just &"localhost"&.
7687
7688 No database need be supplied &-- but if it is absent here, it must be given in
7689 the queries.
7690
7691 If a MySQL query is issued that does not request any data (an insert, update,
7692 or delete command), the result of the lookup is the number of rows affected.
7693
7694 &*Warning*&: This can be misleading. If an update does not actually change
7695 anything (for example, setting a field to the value it already has), the result
7696 is zero because no rows are affected.
7697
7698
7699 .section "Special PostgreSQL features" "SECID74"
7700 PostgreSQL lookups can also use Unix domain socket connections to the database.
7701 This is usually faster and costs less CPU time than a TCP/IP connection.
7702 However it can be used only if the mail server runs on the same machine as the
7703 database server. A configuration line for PostgreSQL via Unix domain sockets
7704 looks like this:
7705 .code
7706 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7707 .endd
7708 In other words, instead of supplying a host name, a path to the socket is
7709 given. The path name is enclosed in parentheses so that its slashes aren't
7710 visually confused with the delimiters for the other server parameters.
7711
7712 If a PostgreSQL query is issued that does not request any data (an insert,
7713 update, or delete command), the result of the lookup is the number of rows
7714 affected.
7715
7716 .section "More about SQLite" "SECTsqlite"
7717 .cindex "lookup" "SQLite"
7718 .cindex "sqlite lookup type"
7719 SQLite is different to the other SQL lookups because a file name is required in
7720 addition to the SQL query. An SQLite database is a single file, and there is no
7721 daemon as in the other SQL databases. The interface to Exim requires the name
7722 of the file, as an absolute path, to be given at the start of the query. It is
7723 separated from the query by white space. This means that the path name cannot
7724 contain white space. Here is a lookup expansion example:
7725 .code
7726 ${lookup sqlite {/some/thing/sqlitedb \
7727   select name from aliases where id='userx';}}
7728 .endd
7729 In a list, the syntax is similar. For example:
7730 .code
7731 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7732    select * from relays where ip='$sender_host_address';
7733 .endd
7734 The only character affected by the &%quote_sqlite%& operator is a single
7735 quote, which it doubles.
7736
7737 .cindex timeout SQLite
7738 .cindex sqlite "lookup timeout"
7739 The SQLite library handles multiple simultaneous accesses to the database
7740 internally. Multiple readers are permitted, but only one process can
7741 update at once. Attempts to access the database while it is being updated
7742 are rejected after a timeout period, during which the SQLite library
7743 waits for the lock to be released. In Exim, the default timeout is set
7744 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7745 option.
7746 .ecindex IIDfidalo1
7747 .ecindex IIDfidalo2
7748
7749
7750 . ////////////////////////////////////////////////////////////////////////////
7751 . ////////////////////////////////////////////////////////////////////////////
7752
7753 .chapter "Domain, host, address, and local part lists" &&&
7754          "CHAPdomhosaddlists" &&&
7755          "Domain, host, and address lists"
7756 .scindex IIDdohoadli "lists of domains; hosts; etc."
7757 A number of Exim configuration options contain lists of domains, hosts,
7758 email addresses, or local parts. For example, the &%hold_domains%& option
7759 contains a list of domains whose delivery is currently suspended. These lists
7760 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7761 arguments to expansion conditions such as &%match_domain%&.
7762
7763 Each item in one of these lists is a pattern to be matched against a domain,
7764 host, email address, or local part, respectively. In the sections below, the
7765 different types of pattern for each case are described, but first we cover some
7766 general facilities that apply to all four kinds of list.
7767
7768 Note that other parts of Exim use a &'string list'& which does not
7769 support all the complexity available in
7770 domain, host, address and local part lists.
7771
7772
7773
7774 .section "Expansion of lists" "SECTlistexpand"
7775 .cindex "expansion" "of lists"
7776 Each list is expanded as a single string before it is used. The result of
7777 expansion must be a list, possibly containing empty items, which is split up
7778 into separate items for matching. By default, colon is the separator character,
7779 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7780 &<<SECTempitelis>>& for details of the list syntax; the second of these
7781 discusses the way to specify empty list items.
7782
7783
7784 If the string expansion is forced to fail, Exim behaves as if the item it is
7785 testing (domain, host, address, or local part) is not in the list. Other
7786 expansion failures cause temporary errors.
7787
7788 If an item in a list is a regular expression, backslashes, dollars and possibly
7789 other special characters in the expression must be protected against
7790 misinterpretation by the string expander. The easiest way to do this is to use
7791 the &`\N`& expansion feature to indicate that the contents of the regular
7792 expression should not be expanded. For example, in an ACL you might have:
7793 .code
7794 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7795                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7796 .endd
7797 The first item is a regular expression that is protected from expansion by
7798 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7799 senders based on the receiving domain.
7800
7801
7802
7803
7804 .section "Negated items in lists" "SECID76"
7805 .cindex "list" "negation"
7806 .cindex "negation" "in lists"
7807 Items in a list may be positive or negative. Negative items are indicated by a
7808 leading exclamation mark, which may be followed by optional white space. A list
7809 defines a set of items (domains, etc). When Exim processes one of these lists,
7810 it is trying to find out whether a domain, host, address, or local part
7811 (respectively) is in the set that is defined by the list. It works like this:
7812
7813 The list is scanned from left to right. If a positive item is matched, the
7814 subject that is being checked is in the set; if a negative item is matched, the
7815 subject is not in the set. If the end of the list is reached without the
7816 subject having matched any of the patterns, it is in the set if the last item
7817 was a negative one, but not if it was a positive one. For example, the list in
7818 .code
7819 domainlist relay_to_domains = !a.b.c : *.b.c
7820 .endd
7821 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7822 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7823 list is positive. However, if the setting were
7824 .code
7825 domainlist relay_to_domains = !a.b.c
7826 .endd
7827 then all domains other than &'a.b.c'& would match because the last item in the
7828 list is negative. In other words, a list that ends with a negative item behaves
7829 as if it had an extra item &`:*`& on the end.
7830
7831 Another way of thinking about positive and negative items in lists is to read
7832 the connector as &"or"& after a positive item and as &"and"& after a negative
7833 item.
7834
7835
7836
7837 .section "File names in lists" "SECTfilnamlis"
7838 .cindex "list" "file name in"
7839 If an item in a domain, host, address, or local part list is an absolute file
7840 name (beginning with a slash character), each line of the file is read and
7841 processed as if it were an independent item in the list, except that further
7842 file names are not allowed,
7843 and no expansion of the data from the file takes place.
7844 Empty lines in the file are ignored, and the file may also contain comment
7845 lines:
7846
7847 .ilist
7848 For domain and host lists, if a # character appears anywhere in a line of the
7849 file, it and all following characters are ignored.
7850 .next
7851 Because local parts may legitimately contain # characters, a comment in an
7852 address list or local part list file is recognized only if # is preceded by
7853 white space or the start of the line. For example:
7854 .code
7855 not#comment@x.y.z   # but this is a comment
7856 .endd
7857 .endlist
7858
7859 Putting a file name in a list has the same effect as inserting each line of the
7860 file as an item in the list (blank lines and comments excepted). However, there
7861 is one important difference: the file is read each time the list is processed,
7862 so if its contents vary over time, Exim's behaviour changes.
7863
7864 If a file name is preceded by an exclamation mark, the sense of any match
7865 within the file is inverted. For example, if
7866 .code
7867 hold_domains = !/etc/nohold-domains
7868 .endd
7869 and the file contains the lines
7870 .code
7871 !a.b.c
7872 *.b.c
7873 .endd
7874 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7875 any domain matching &`*.b.c`& is not.
7876
7877
7878
7879 .section "An lsearch file is not an out-of-line list" "SECID77"
7880 As will be described in the sections that follow, lookups can be used in lists
7881 to provide indexed methods of checking list membership. There has been some
7882 confusion about the way &(lsearch)& lookups work in lists. Because
7883 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7884 sometimes thought that it is allowed to contain wild cards and other kinds of
7885 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7886 always fixed strings, just as for any other single-key lookup type.
7887
7888 If you want to use a file to contain wild-card patterns that form part of a
7889 list, just give the file name on its own, without a search type, as described
7890 in the previous section. You could also use the &(wildlsearch)& or
7891 &(nwildlsearch)&, but there is no advantage in doing this.
7892
7893
7894
7895
7896 .section "Named lists" "SECTnamedlists"
7897 .cindex "named lists"
7898 .cindex "list" "named"
7899 A list of domains, hosts, email addresses, or local parts can be given a name
7900 which is then used to refer to the list elsewhere in the configuration. This is
7901 particularly convenient if the same list is required in several different
7902 places. It also allows lists to be given meaningful names, which can improve
7903 the readability of the configuration. For example, it is conventional to define
7904 a domain list called &'local_domains'& for all the domains that are handled
7905 locally on a host, using a configuration line such as
7906 .code
7907 domainlist local_domains = localhost:my.dom.example
7908 .endd
7909 Named lists are referenced by giving their name preceded by a plus sign, so,
7910 for example, a router that is intended to handle local domains would be
7911 configured with the line
7912 .code
7913 domains = +local_domains
7914 .endd
7915 The first router in a configuration is often one that handles all domains
7916 except the local ones, using a configuration with a negated item like this:
7917 .code
7918 dnslookup:
7919   driver = dnslookup
7920   domains = ! +local_domains
7921   transport = remote_smtp
7922   no_more
7923 .endd
7924 The four kinds of named list are created by configuration lines starting with
7925 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7926 respectively. Then there follows the name that you are defining, followed by an
7927 equals sign and the list itself. For example:
7928 .code
7929 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7930 addresslist bad_senders = cdb;/etc/badsenders
7931 .endd
7932 A named list may refer to other named lists:
7933 .code
7934 domainlist  dom1 = first.example : second.example
7935 domainlist  dom2 = +dom1 : third.example
7936 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7937 .endd
7938 &*Warning*&: If the last item in a referenced list is a negative one, the
7939 effect may not be what you intended, because the negation does not propagate
7940 out to the higher level. For example, consider:
7941 .code
7942 domainlist  dom1 = !a.b
7943 domainlist  dom2 = +dom1 : *.b
7944 .endd
7945 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7946 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7947 means it matches the second list as well. The effect is not the same as
7948 .code
7949 domainlist  dom2 = !a.b : *.b
7950 .endd
7951 where &'x.y'& does not match. It's best to avoid negation altogether in
7952 referenced lists if you can.
7953
7954 Named lists may have a performance advantage. When Exim is routing an
7955 address or checking an incoming message, it caches the result of tests on named
7956 lists. So, if you have a setting such as
7957 .code
7958 domains = +local_domains
7959 .endd
7960 on several of your routers
7961 or in several ACL statements,
7962 the actual test is done only for the first one. However, the caching works only
7963 if there are no expansions within the list itself or any sublists that it
7964 references. In other words, caching happens only for lists that are known to be
7965 the same each time they are referenced.
7966
7967 By default, there may be up to 16 named lists of each type. This limit can be
7968 extended by changing a compile-time variable. The use of domain and host lists
7969 is recommended for concepts such as local domains, relay domains, and relay
7970 hosts. The default configuration is set up like this.
7971
7972
7973
7974 .section "Named lists compared with macros" "SECID78"
7975 .cindex "list" "named compared with macro"
7976 .cindex "macro" "compared with named list"
7977 At first sight, named lists might seem to be no different from macros in the
7978 configuration file. However, macros are just textual substitutions. If you
7979 write
7980 .code
7981 ALIST = host1 : host2
7982 auth_advertise_hosts = !ALIST
7983 .endd
7984 it probably won't do what you want, because that is exactly the same as
7985 .code
7986 auth_advertise_hosts = !host1 : host2
7987 .endd
7988 Notice that the second host name is not negated. However, if you use a host
7989 list, and write
7990 .code
7991 hostlist alist = host1 : host2
7992 auth_advertise_hosts = ! +alist
7993 .endd
7994 the negation applies to the whole list, and so that is equivalent to
7995 .code
7996 auth_advertise_hosts = !host1 : !host2
7997 .endd
7998
7999
8000 .section "Named list caching" "SECID79"
8001 .cindex "list" "caching of named"
8002 .cindex "caching" "named lists"
8003 While processing a message, Exim caches the result of checking a named list if
8004 it is sure that the list is the same each time. In practice, this means that
8005 the cache operates only if the list contains no $ characters, which guarantees
8006 that it will not change when it is expanded. Sometimes, however, you may have
8007 an expanded list that you know will be the same each time within a given
8008 message. For example:
8009 .code
8010 domainlist special_domains = \
8011            ${lookup{$sender_host_address}cdb{/some/file}}
8012 .endd
8013 This provides a list of domains that depends only on the sending host's IP
8014 address. If this domain list is referenced a number of times (for example,
8015 in several ACL lines, or in several routers) the result of the check is not
8016 cached by default, because Exim does not know that it is going to be the
8017 same list each time.
8018
8019 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8020 cache the result anyway. For example:
8021 .code
8022 domainlist_cache special_domains = ${lookup{...
8023 .endd
8024 If you do this, you should be absolutely sure that caching is going to do
8025 the right thing in all cases. When in doubt, leave it out.
8026
8027
8028
8029 .section "Domain lists" "SECTdomainlist"
8030 .cindex "domain list" "patterns for"
8031 .cindex "list" "domain list"
8032 Domain lists contain patterns that are to be matched against a mail domain.
8033 The following types of item may appear in domain lists:
8034
8035 .ilist
8036 .cindex "primary host name"
8037 .cindex "host name" "matched in domain list"
8038 .oindex "&%primary_hostname%&"
8039 .cindex "domain list" "matching primary host name"
8040 .cindex "@ in a domain list"
8041 If a pattern consists of a single @ character, it matches the local host name,
8042 as set by the &%primary_hostname%& option (or defaulted). This makes it
8043 possible to use the same configuration file on several different hosts that
8044 differ only in their names.
8045 .next
8046 .cindex "@[] in a domain list"
8047 .cindex "domain list" "matching local IP interfaces"
8048 .cindex "domain literal"
8049 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8050 in square brackets (as in an email address that contains a domain literal), but
8051 only if that IP address is recognized as local for email routing purposes. The
8052 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8053 control which of a host's several IP addresses are treated as local.
8054 In today's Internet, the use of domain literals is controversial.
8055 .next
8056 .cindex "@mx_any"
8057 .cindex "@mx_primary"
8058 .cindex "@mx_secondary"
8059 .cindex "domain list" "matching MX pointers to local host"
8060 If a pattern consists of the string &`@mx_any`& it matches any domain that
8061 has an MX record pointing to the local host or to any host that is listed in
8062 .oindex "&%hosts_treat_as_local%&"
8063 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8064 are similar, except that the first matches only when a primary MX target is the
8065 local host, and the second only when no primary MX target is the local host,
8066 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8067 preference value &-- there may of course be more than one of them.
8068
8069 The MX lookup that takes place when matching a pattern of this type is
8070 performed with the resolver options for widening names turned off. Thus, for
8071 example, a single-component domain will &'not'& be expanded by adding the
8072 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8073 options of the &(dnslookup)& router for a discussion of domain widening.
8074
8075 Sometimes you may want to ignore certain IP addresses when using one of these
8076 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8077 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8078 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8079 on a router). For example:
8080 .code
8081 domains = @mx_any/ignore=127.0.0.1
8082 .endd
8083 This example matches any domain that has an MX record pointing to one of
8084 the local host's IP addresses other than 127.0.0.1.
8085
8086 The list of IP addresses is in fact processed by the same code that processes
8087 host lists, so it may contain CIDR-coded network specifications and it may also
8088 contain negative items.
8089
8090 Because the list of IP addresses is a sublist within a domain list, you have to
8091 be careful about delimiters if there is more than one address. Like any other
8092 list, the default delimiter can be changed. Thus, you might have:
8093 .code
8094 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8095           an.other.domain : ...
8096 .endd
8097 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8098 involved, it is easiest to change the delimiter for the main list as well:
8099 .code
8100 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8101           an.other.domain ? ...
8102 .endd
8103 .next
8104 .cindex "asterisk" "in domain list"
8105 .cindex "domain list" "asterisk in"
8106 .cindex "domain list" "matching &""ends with""&"
8107 If a pattern starts with an asterisk, the remaining characters of the pattern
8108 are compared with the terminating characters of the domain. The use of &"*"& in
8109 domain lists differs from its use in partial matching lookups. In a domain
8110 list, the character following the asterisk need not be a dot, whereas partial
8111 matching works only in terms of dot-separated components. For example, a domain
8112 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8113 &'cipher.key.ex'&.
8114
8115 .next
8116 .cindex "regular expressions" "in domain list"
8117 .cindex "domain list" "matching regular expression"
8118 If a pattern starts with a circumflex character, it is treated as a regular
8119 expression, and matched against the domain using a regular expression matching
8120 function. The circumflex is treated as part of the regular expression.
8121 Email domains are case-independent, so this regular expression match is by
8122 default case-independent, but you can make it case-dependent by starting it
8123 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8124 are given in chapter &<<CHAPregexp>>&.
8125
8126 &*Warning*&: Because domain lists are expanded before being processed, you
8127 must escape any backslash and dollar characters in the regular expression, or
8128 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8129 it is not to be expanded (unless you really do want to build a regular
8130 expression by expansion, of course).
8131 .next
8132 .cindex "lookup" "in domain list"
8133 .cindex "domain list" "matching by lookup"
8134 If a pattern starts with the name of a single-key lookup type followed by a
8135 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8136 must be a file name in a suitable format for the lookup type. For example, for
8137 &"cdb;"& it must be an absolute path:
8138 .code
8139 domains = cdb;/etc/mail/local_domains.cdb
8140 .endd
8141 The appropriate type of lookup is done on the file using the domain name as the
8142 key. In most cases, the data that is looked up is not used; Exim is interested
8143 only in whether or not the key is present in the file. However, when a lookup
8144 is used for the &%domains%& option on a router
8145 or a &%domains%& condition in an ACL statement, the data is preserved in the
8146 &$domain_data$& variable and can be referred to in other router options or
8147 other statements in the same ACL.
8148
8149 .next
8150 Any of the single-key lookup type names may be preceded by
8151 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8152 .code
8153 domains = partial-dbm;/partial/domains
8154 .endd
8155 This causes partial matching logic to be invoked; a description of how this
8156 works is given in section &<<SECTpartiallookup>>&.
8157
8158 .next
8159 .cindex "asterisk" "in lookup type"
8160 Any of the single-key lookup types may be followed by an asterisk. This causes
8161 a default lookup for a key consisting of a single asterisk to be done if the
8162 original lookup fails. This is not a useful feature when using a domain list to
8163 select particular domains (because any domain would match), but it might have
8164 value if the result of the lookup is being used via the &$domain_data$&
8165 expansion variable.
8166 .next
8167 If the pattern starts with the name of a query-style lookup type followed by a
8168 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8169 pattern must be an appropriate query for the lookup type, as described in
8170 chapter &<<CHAPfdlookup>>&. For example:
8171 .code
8172 hold_domains = mysql;select domain from holdlist \
8173   where domain = '${quote_mysql:$domain}';
8174 .endd
8175 In most cases, the data that is looked up is not used (so for an SQL query, for
8176 example, it doesn't matter what field you select). Exim is interested only in
8177 whether or not the query succeeds. However, when a lookup is used for the
8178 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8179 variable and can be referred to in other options.
8180 .next
8181 .cindex "domain list" "matching literal domain name"
8182 If none of the above cases apply, a caseless textual comparison is made
8183 between the pattern and the domain.
8184 .endlist
8185
8186 Here is an example that uses several different kinds of pattern:
8187 .code
8188 domainlist funny_domains = \
8189   @ : \
8190   lib.unseen.edu : \
8191   *.foundation.fict.example : \
8192   \N^[1-2]\d{3}\.fict\.example$\N : \
8193   partial-dbm;/opt/data/penguin/book : \
8194   nis;domains.byname : \
8195   nisplus;[name=$domain,status=local],domains.org_dir
8196 .endd
8197 There are obvious processing trade-offs among the various matching modes. Using
8198 an asterisk is faster than a regular expression, and listing a few names
8199 explicitly probably is too. The use of a file or database lookup is expensive,
8200 but may be the only option if hundreds of names are required. Because the
8201 patterns are tested in order, it makes sense to put the most commonly matched
8202 patterns earlier.
8203
8204
8205
8206 .section "Host lists" "SECThostlist"
8207 .cindex "host list" "patterns in"
8208 .cindex "list" "host list"
8209 Host lists are used to control what remote hosts are allowed to do. For
8210 example, some hosts may be allowed to use the local host as a relay, and some
8211 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8212 two different ways, by name or by IP address. In a host list, some types of
8213 pattern are matched to a host name, and some are matched to an IP address.
8214 You need to be particularly careful with this when single-key lookups are
8215 involved, to ensure that the right value is being used as the key.
8216
8217
8218 .section "Special host list patterns" "SECID80"
8219 .cindex "empty item in hosts list"
8220 .cindex "host list" "empty string in"
8221 If a host list item is the empty string, it matches only when no remote host is
8222 involved. This is the case when a message is being received from a local
8223 process using SMTP on the standard input, that is, when a TCP/IP connection is
8224 not used.
8225
8226 .cindex "asterisk" "in host list"
8227 The special pattern &"*"& in a host list matches any host or no host. Neither
8228 the IP address nor the name is actually inspected.
8229
8230
8231
8232 .section "Host list patterns that match by IP address" "SECThoslispatip"
8233 .cindex "host list" "matching IP addresses"
8234 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8235 the incoming address actually appears in the IPv6 host as
8236 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8237 list, it is converted into a traditional IPv4 address first. (Not all operating
8238 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8239 concerns.)
8240
8241 The following types of pattern in a host list check the remote host by
8242 inspecting its IP address:
8243
8244 .ilist
8245 If the pattern is a plain domain name (not a regular expression, not starting
8246 with *, not a lookup of any kind), Exim calls the operating system function
8247 to find the associated IP address(es). Exim uses the newer
8248 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8249 This typically causes a forward DNS lookup of the name. The result is compared
8250 with the IP address of the subject host.
8251
8252 If there is a temporary problem (such as a DNS timeout) with the host name
8253 lookup, a temporary error occurs. For example, if the list is being used in an
8254 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8255 temporary SMTP error code. If no IP address can be found for the host name,
8256 what happens is described in section &<<SECTbehipnot>>& below.
8257
8258 .next
8259 .cindex "@ in a host list"
8260 If the pattern is &"@"&, the primary host name is substituted and used as a
8261 domain name, as just described.
8262
8263 .next
8264 If the pattern is an IP address, it is matched against the IP address of the
8265 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8266 IPv6 addresses can be given in colon-separated format, but the colons have to
8267 be doubled so as not to be taken as item separators when the default list
8268 separator is used. IPv6 addresses are recognized even when Exim is compiled
8269 without IPv6 support. This means that if they appear in a host list on an
8270 IPv4-only host, Exim will not treat them as host names. They are just addresses
8271 that can never match a client host.
8272
8273 .next
8274 .cindex "@[] in a host list"
8275 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8276 the local host. For example, if the local host is an IPv4 host with one
8277 interface address 10.45.23.56, these two ACL statements have the same effect:
8278 .code
8279 accept hosts = 127.0.0.1 : 10.45.23.56
8280 accept hosts = @[]
8281 .endd
8282 .next
8283 .cindex "CIDR notation"
8284 If the pattern is an IP address followed by a slash and a mask length (for
8285 example 10.11.42.0/24), it is matched against the IP address of the subject
8286 host under the given mask. This allows, an entire network of hosts to be
8287 included (or excluded) by a single item. The mask uses CIDR notation; it
8288 specifies the number of address bits that must match, starting from the most
8289 significant end of the address.
8290
8291 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8292 of a range of addresses. It is the number of bits in the network portion of the
8293 address. The above example specifies a 24-bit netmask, so it matches all 256
8294 addresses in the 10.11.42.0 network. An item such as
8295 .code
8296 192.168.23.236/31
8297 .endd
8298 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8299 32 for an IPv4 address is the same as no mask at all; just a single address
8300 matches.
8301
8302 Here is another example which shows an IPv4 and an IPv6 network:
8303 .code
8304 recipient_unqualified_hosts = 192.168.0.0/16: \
8305                               3ffe::ffff::836f::::/48
8306 .endd
8307 The doubling of list separator characters applies only when these items
8308 appear inline in a host list. It is not required when indirecting via a file.
8309 For example:
8310 .code
8311 recipient_unqualified_hosts = /opt/exim/unqualnets
8312 .endd
8313 could make use of a file containing
8314 .code
8315 172.16.0.0/12
8316 3ffe:ffff:836f::/48
8317 .endd
8318 to have exactly the same effect as the previous example. When listing IPv6
8319 addresses inline, it is usually more convenient to use the facility for
8320 changing separator characters. This list contains the same two networks:
8321 .code
8322 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8323                                  3ffe:ffff:836f::/48
8324 .endd
8325 The separator is changed to semicolon by the leading &"<;"& at the start of the
8326 list.
8327 .endlist
8328
8329
8330
8331 .section "Host list patterns for single-key lookups by host address" &&&
8332          "SECThoslispatsikey"
8333 .cindex "host list" "lookup of IP address"
8334 When a host is to be identified by a single-key lookup of its complete IP
8335 address, the pattern takes this form:
8336 .display
8337 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8338 .endd
8339 For example:
8340 .code
8341 hosts_lookup = net-cdb;/hosts-by-ip.db
8342 .endd
8343 The text form of the IP address of the subject host is used as the lookup key.
8344 IPv6 addresses are converted to an unabbreviated form, using lower case
8345 letters, with dots as separators because colon is the key terminator in
8346 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8347 quoting the keys, but this is a facility that was added later.] The data
8348 returned by the lookup is not used.
8349
8350 .cindex "IP address" "masking"
8351 .cindex "host list" "masked IP address"
8352 Single-key lookups can also be performed using masked IP addresses, using
8353 patterns of this form:
8354 .display
8355 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8356 .endd
8357 For example:
8358 .code
8359 net24-dbm;/networks.db
8360 .endd
8361 The IP address of the subject host is masked using <&'number'&> as the mask
8362 length. A textual string is constructed from the masked value, followed by the
8363 mask, and this is used as the lookup key. For example, if the host's IP address
8364 is 192.168.34.6, the key that is looked up for the above example is
8365 &"192.168.34.0/24"&.
8366
8367 When an IPv6 address is converted to a string, dots are normally used instead
8368 of colons, so that keys in &(lsearch)& files need not contain colons (which
8369 terminate &(lsearch)& keys). This was implemented some time before the ability
8370 to quote keys was made available in &(lsearch)& files. However, the more
8371 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8372 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8373 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8374 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8375 addresses are always used.
8376
8377 Ideally, it would be nice to tidy up this anomalous situation by changing to
8378 colons in all cases, given that quoting is now available for &(lsearch)&.
8379 However, this would be an incompatible change that might break some existing
8380 configurations.
8381
8382 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8383 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8384 the former case the key strings include the mask value, whereas in the latter
8385 case the IP address is used on its own.
8386
8387
8388
8389 .section "Host list patterns that match by host name" "SECThoslispatnam"
8390 .cindex "host" "lookup failures"
8391 .cindex "unknown host name"
8392 .cindex "host list" "matching host name"
8393 There are several types of pattern that require Exim to know the name of the
8394 remote host. These are either wildcard patterns or lookups by name. (If a
8395 complete hostname is given without any wildcarding, it is used to find an IP
8396 address to match against, as described in section &<<SECThoslispatip>>&
8397 above.)
8398
8399 If the remote host name is not already known when Exim encounters one of these
8400 patterns, it has to be found from the IP address.
8401 Although many sites on the Internet are conscientious about maintaining reverse
8402 DNS data for their hosts, there are also many that do not do this.
8403 Consequently, a name cannot always be found, and this may lead to unwanted
8404 effects. Take care when configuring host lists with wildcarded name patterns.
8405 Consider what will happen if a name cannot be found.
8406
8407 Because of the problems of determining host names from IP addresses, matching
8408 against host names is not as common as matching against IP addresses.
8409
8410 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8411 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8412 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8413 are done can be changed by setting the &%host_lookup_order%& option. For
8414 security, once Exim has found one or more names, it looks up the IP addresses
8415 for these names and compares them with the IP address that it started with.
8416 Only those names whose IP addresses match are accepted. Any other names are
8417 discarded. If no names are left, Exim behaves as if the host name cannot be
8418 found. In the most common case there is only one name and one IP address.
8419
8420 There are some options that control what happens if a host name cannot be
8421 found. These are described in section &<<SECTbehipnot>>& below.
8422
8423 .cindex "host" "alias for"
8424 .cindex "alias for host"
8425 As a result of aliasing, hosts may have more than one name. When processing any
8426 of the following types of pattern, all the host's names are checked:
8427
8428 .ilist
8429 .cindex "asterisk" "in host list"
8430 If a pattern starts with &"*"& the remainder of the item must match the end of
8431 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8432 &'.b.c'&. This special simple form is provided because this is a very common
8433 requirement. Other kinds of wildcarding require the use of a regular
8434 expression.
8435 .next
8436 .cindex "regular expressions" "in host list"
8437 .cindex "host list" "regular expression in"
8438 If the item starts with &"^"& it is taken to be a regular expression which is
8439 matched against the host name. Host names are case-independent, so this regular
8440 expression match is by default case-independent, but you can make it
8441 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8442 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8443 example,
8444 .code
8445 ^(a|b)\.c\.d$
8446 .endd
8447 is a regular expression that matches either of the two hosts &'a.c.d'& or
8448 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8449 that backslash and dollar characters are not misinterpreted as part of the
8450 string expansion. The simplest way to do this is to use &`\N`& to mark that
8451 part of the string as non-expandable. For example:
8452 .code
8453 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8454 .endd
8455 &*Warning*&: If you want to match a complete host name, you must include the
8456 &`$`& terminating metacharacter in the regular expression, as in the above
8457 example. Without it, a match at the start of the host name is all that is
8458 required.
8459 .endlist
8460
8461
8462
8463
8464 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8465 .cindex "host" "lookup failures, permanent"
8466 While processing a host list, Exim may need to look up an IP address from a
8467 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8468 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8469 behaviour when it fails to find the information it is seeking is the same.
8470
8471 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8472 apply to temporary DNS errors, whose handling is described in the next section.
8473
8474 .cindex "&`+include_unknown`&"
8475 .cindex "&`+ignore_unknown`&"
8476 Exim parses a host list from left to right. If it encounters a permanent
8477 lookup failure in any item in the host list before it has found a match,
8478 Exim treats it as a failure and the default behavior is as if the host
8479 does not match the list. This may not always be what you want to happen.
8480 To change Exim's behaviour, the special items &`+include_unknown`& or
8481 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8482 not recognized in an indirected file).
8483
8484 .ilist
8485 If any item that follows &`+include_unknown`& requires information that
8486 cannot found, Exim behaves as if the host does match the list. For example,
8487 .code
8488 host_reject_connection = +include_unknown:*.enemy.ex
8489 .endd
8490 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8491 any hosts whose name it cannot find.
8492
8493 .next
8494 If any item that follows &`+ignore_unknown`& requires information that cannot
8495 be found, Exim ignores that item and proceeds to the rest of the list. For
8496 example:
8497 .code
8498 accept hosts = +ignore_unknown : friend.example : \
8499                192.168.4.5
8500 .endd
8501 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8502 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8503 name can be found for 192.168.4.5, it is rejected.
8504 .endlist
8505
8506 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8507 list. The effect of each one lasts until the next, or until the end of the
8508 list.
8509
8510 .section "Mixing wildcarded host names and addresses in host lists" &&&
8511          "SECTmixwilhos"
8512 .cindex "host list" "mixing names and addresses in"
8513
8514 This section explains the host/ip processing logic with the same concepts
8515 as the previous section, but specifically addresses what happens when a
8516 wildcarded hostname is one of the items in the hostlist.
8517
8518 .ilist
8519 If you have name lookups or wildcarded host names and
8520 IP addresses in the same host list, you should normally put the IP
8521 addresses first. For example, in an ACL you could have:
8522 .code
8523 accept hosts = 10.9.8.7 : *.friend.example
8524 .endd
8525 The reason you normally would order it this way lies in the
8526 left-to-right way that Exim processes lists.  It can test IP addresses
8527 without doing any DNS lookups, but when it reaches an item that requires
8528 a host name, it fails if it cannot find a host name to compare with the
8529 pattern. If the above list is given in the opposite order, the
8530 &%accept%& statement fails for a host whose name cannot be found, even
8531 if its IP address is 10.9.8.7.
8532
8533 .next
8534 If you really do want to do the name check first, and still recognize the IP
8535 address, you can rewrite the ACL like this:
8536 .code
8537 accept hosts = *.friend.example
8538 accept hosts = 10.9.8.7
8539 .endd
8540 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8541 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8542 &`+ignore_unknown`&, which was discussed in depth in the first example in
8543 this section.
8544 .endlist
8545
8546
8547 .section "Temporary DNS errors when looking up host information" &&&
8548          "SECTtemdnserr"
8549 .cindex "host" "lookup failures, temporary"
8550 .cindex "&`+include_defer`&"
8551 .cindex "&`+ignore_defer`&"
8552 A temporary DNS lookup failure normally causes a defer action (except when
8553 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8554 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8555 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8556 section. These options should be used with care, probably only in non-critical
8557 host lists such as whitelists.
8558
8559
8560
8561 .section "Host list patterns for single-key lookups by host name" &&&
8562          "SECThoslispatnamsk"
8563 .cindex "unknown host name"
8564 .cindex "host list" "matching host name"
8565 If a pattern is of the form
8566 .display
8567 <&'single-key-search-type'&>;<&'search-data'&>
8568 .endd
8569 for example
8570 .code
8571 dbm;/host/accept/list
8572 .endd
8573 a single-key lookup is performed, using the host name as its key. If the
8574 lookup succeeds, the host matches the item. The actual data that is looked up
8575 is not used.
8576
8577 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8578 keys in the file, not IP addresses. If you want to do lookups based on IP
8579 addresses, you must precede the search type with &"net-"& (see section
8580 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8581 two items in the same list, one doing an address lookup and one doing a name
8582 lookup, both using the same file.
8583
8584
8585
8586 .section "Host list patterns for query-style lookups" "SECID81"
8587 If a pattern is of the form
8588 .display
8589 <&'query-style-search-type'&>;<&'query'&>
8590 .endd
8591 the query is obeyed, and if it succeeds, the host matches the item. The actual
8592 data that is looked up is not used. The variables &$sender_host_address$& and
8593 &$sender_host_name$& can be used in the query. For example:
8594 .code
8595 hosts_lookup = pgsql;\
8596   select ip from hostlist where ip='$sender_host_address'
8597 .endd
8598 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8599 can use the &%sg%& expansion item to change this if you need to. If you want to
8600 use masked IP addresses in database queries, you can use the &%mask%& expansion
8601 operator.
8602
8603 If the query contains a reference to &$sender_host_name$&, Exim automatically
8604 looks up the host name if it has not already done so. (See section
8605 &<<SECThoslispatnam>>& for comments on finding host names.)
8606
8607 Historical note: prior to release 4.30, Exim would always attempt to find a
8608 host name before running the query, unless the search type was preceded by
8609 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8610 still recognized for query-style lookups, but its presence or absence has no
8611 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8612 See section &<<SECThoslispatsikey>>&.)
8613
8614
8615
8616
8617
8618 .section "Address lists" "SECTaddresslist"
8619 .cindex "list" "address list"
8620 .cindex "address list" "empty item"
8621 .cindex "address list" "patterns"
8622 Address lists contain patterns that are matched against mail addresses. There
8623 is one special case to be considered: the sender address of a bounce message is
8624 always empty. You can test for this by providing an empty item in an address
8625 list. For example, you can set up a router to process bounce messages by
8626 using this option setting:
8627 .code
8628 senders = :
8629 .endd
8630 The presence of the colon creates an empty item. If you do not provide any
8631 data, the list is empty and matches nothing. The empty sender can also be
8632 detected by a regular expression that matches an empty string,
8633 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8634
8635 Non-empty items in an address list can be straightforward email addresses. For
8636 example:
8637 .code
8638 senders = jbc@askone.example : hs@anacreon.example
8639 .endd
8640 A certain amount of wildcarding is permitted. If a pattern contains an @
8641 character, but is not a regular expression and does not begin with a
8642 semicolon-terminated lookup type (described below), the local part of the
8643 subject address is compared with the local part of the pattern, which may start
8644 with an asterisk. If the local parts match, the domain is checked in exactly
8645 the same way as for a pattern in a domain list. For example, the domain can be
8646 wildcarded, refer to a named list, or be a lookup:
8647 .code
8648 deny senders = *@*.spamming.site:\
8649                *@+hostile_domains:\
8650                bozo@partial-lsearch;/list/of/dodgy/sites:\
8651                *@dbm;/bad/domains.db
8652 .endd
8653 .cindex "local part" "starting with !"
8654 .cindex "address list" "local part starting with !"
8655 If a local part that begins with an exclamation mark is required, it has to be
8656 specified using a regular expression, because otherwise the exclamation mark is
8657 treated as a sign of negation, as is standard in lists.
8658
8659 If a non-empty pattern that is not a regular expression or a lookup does not
8660 contain an @ character, it is matched against the domain part of the subject
8661 address. The only two formats that are recognized this way are a literal
8662 domain, or a domain pattern that starts with *. In both these cases, the effect
8663 is the same as if &`*@`& preceded the pattern. For example:
8664 .code
8665 deny senders = enemy.domain : *.enemy.domain
8666 .endd
8667
8668 The following kinds of more complicated address list pattern can match any
8669 address, including the empty address that is characteristic of bounce message
8670 senders:
8671
8672 .ilist
8673 .cindex "regular expressions" "in address list"
8674 .cindex "address list" "regular expression in"
8675 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8676 done against the complete address, with the pattern as the regular expression.
8677 You must take care that backslash and dollar characters are not misinterpreted
8678 as part of the string expansion. The simplest way to do this is to use &`\N`&
8679 to mark that part of the string as non-expandable. For example:
8680 .code
8681 deny senders = \N^.*this.*@example\.com$\N : \
8682                \N^\d{8}.+@spamhaus.example$\N : ...
8683 .endd
8684 The &`\N`& sequences are removed by the expansion, so these items do indeed
8685 start with &"^"& by the time they are being interpreted as address patterns.
8686
8687 .next
8688 .cindex "address list" "lookup for complete address"
8689 Complete addresses can be looked up by using a pattern that starts with a
8690 lookup type terminated by a semicolon, followed by the data for the lookup. For
8691 example:
8692 .code
8693 deny senders = cdb;/etc/blocked.senders : \
8694   mysql;select address from blocked where \
8695   address='${quote_mysql:$sender_address}'
8696 .endd
8697 Both query-style and single-key lookup types can be used. For a single-key
8698 lookup type, Exim uses the complete address as the key. However, empty keys are
8699 not supported for single-key lookups, so a match against the empty address
8700 always fails. This restriction does not apply to query-style lookups.
8701
8702 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8703 cannot be used, and is ignored if specified, with an entry being written to the
8704 panic log.
8705 .cindex "*@ with single-key lookup"
8706 However, you can configure lookup defaults, as described in section
8707 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8708 default. For example, with this lookup:
8709 .code
8710 accept senders = lsearch*@;/some/file
8711 .endd
8712 the file could contains lines like this:
8713 .code
8714 user1@domain1.example
8715 *@domain2.example
8716 .endd
8717 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8718 that are tried is:
8719 .code
8720 nimrod@jaeger.example
8721 *@jaeger.example
8722 *
8723 .endd
8724 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8725 would mean that every address matches, thus rendering the test useless.
8726
8727 &*Warning 2*&: Do not confuse these two kinds of item:
8728 .code
8729 deny recipients = dbm*@;/some/file
8730 deny recipients = *@dbm;/some/file
8731 .endd
8732 The first does a whole address lookup, with defaulting, as just described,
8733 because it starts with a lookup type. The second matches the local part and
8734 domain independently, as described in a bullet point below.
8735 .endlist
8736
8737
8738 The following kinds of address list pattern can match only non-empty addresses.
8739 If the subject address is empty, a match against any of these pattern types
8740 always fails.
8741
8742
8743 .ilist
8744 .cindex "@@ with single-key lookup"
8745 .cindex "address list" "@@ lookup type"
8746 .cindex "address list" "split local part and domain"
8747 If a pattern starts with &"@@"& followed by a single-key lookup item
8748 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8749 split into a local part and a domain. The domain is looked up in the file. If
8750 it is not found, there is no match. If it is found, the data that is looked up
8751 from the file is treated as a colon-separated list of local part patterns, each
8752 of which is matched against the subject local part in turn.
8753
8754 .cindex "asterisk" "in address list"
8755 The lookup may be a partial one, and/or one involving a search for a default
8756 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8757 patterns that are looked up can be regular expressions or begin with &"*"&, or
8758 even be further lookups. They may also be independently negated. For example,
8759 with
8760 .code
8761 deny senders = @@dbm;/etc/reject-by-domain
8762 .endd
8763 the data from which the DBM file is built could contain lines like
8764 .code
8765 baddomain.com:  !postmaster : *
8766 .endd
8767 to reject all senders except &%postmaster%& from that domain.
8768
8769 .cindex "local part" "starting with !"
8770 If a local part that actually begins with an exclamation mark is required, it
8771 has to be specified using a regular expression. In &(lsearch)& files, an entry
8772 may be split over several lines by indenting the second and subsequent lines,
8773 but the separating colon must still be included at line breaks. White space
8774 surrounding the colons is ignored. For example:
8775 .code
8776 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8777   spammer3 : spammer4
8778 .endd
8779 As in all colon-separated lists in Exim, a colon can be included in an item by
8780 doubling.
8781
8782 If the last item in the list starts with a right angle-bracket, the remainder
8783 of the item is taken as a new key to look up in order to obtain a continuation
8784 list of local parts. The new key can be any sequence of characters. Thus one
8785 might have entries like
8786 .code
8787 aol.com: spammer1 : spammer 2 : >*
8788 xyz.com: spammer3 : >*
8789 *:       ^\d{8}$
8790 .endd
8791 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8792 local parts for all domains, in addition to the specific local parts listed for
8793 each domain. Of course, using this feature costs another lookup each time a
8794 chain is followed, but the effort needed to maintain the data is reduced.
8795
8796 .cindex "loop" "in lookups"
8797 It is possible to construct loops using this facility, and in order to catch
8798 them, the chains may be no more than fifty items long.
8799
8800 .next
8801 The @@<&'lookup'&> style of item can also be used with a query-style
8802 lookup, but in this case, the chaining facility is not available. The lookup
8803 can only return a single list of local parts.
8804 .endlist
8805
8806 &*Warning*&: There is an important difference between the address list items
8807 in these two examples:
8808 .code
8809 senders = +my_list
8810 senders = *@+my_list
8811 .endd
8812 In the first one, &`my_list`& is a named address list, whereas in the second
8813 example it is a named domain list.
8814
8815
8816
8817
8818 .section "Case of letters in address lists" "SECTcasletadd"
8819 .cindex "case of local parts"
8820 .cindex "address list" "case forcing"
8821 .cindex "case forcing in address lists"
8822 Domains in email addresses are always handled caselessly, but for local parts
8823 case may be significant on some systems (see &%caseful_local_part%& for how
8824 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8825 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8826 blocking lists should be done in a case-independent manner. Since most address
8827 lists in Exim are used for this kind of control, Exim attempts to do this by
8828 default.
8829
8830 The domain portion of an address is always lowercased before matching it to an
8831 address list. The local part is lowercased by default, and any string
8832 comparisons that take place are done caselessly. This means that the data in
8833 the address list itself, in files included as plain file names, and in any file
8834 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8835 keys in files that are looked up by a search type other than &(lsearch)& (which
8836 works caselessly) must be in lower case, because these lookups are not
8837 case-independent.
8838
8839 .cindex "&`+caseful`&"
8840 To allow for the possibility of caseful address list matching, if an item in
8841 an address list is the string &"+caseful"&, the original case of the local
8842 part is restored for any comparisons that follow, and string comparisons are no
8843 longer case-independent. This does not affect the domain, which remains in
8844 lower case. However, although independent matches on the domain alone are still
8845 performed caselessly, regular expressions that match against an entire address
8846 become case-sensitive after &"+caseful"& has been seen.
8847
8848
8849
8850 .section "Local part lists" "SECTlocparlis"
8851 .cindex "list" "local part list"
8852 .cindex "local part" "list"
8853 Case-sensitivity in local part lists is handled in the same way as for address
8854 lists, as just described. The &"+caseful"& item can be used if required. In a
8855 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8856 set false, the subject is lowercased and the matching is initially
8857 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8858 matching in the local part list, but not elsewhere in the router. If
8859 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8860 option is case-sensitive from the start.
8861
8862 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8863 comments are handled in the same way as address lists &-- they are recognized
8864 only if the # is preceded by white space or the start of the line.
8865 Otherwise, local part lists are matched in the same way as domain lists, except
8866 that the special items that refer to the local host (&`@`&, &`@[]`&,
8867 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8868 Refer to section &<<SECTdomainlist>>& for details of the other available item
8869 types.
8870 .ecindex IIDdohoadli
8871
8872
8873
8874
8875 . ////////////////////////////////////////////////////////////////////////////
8876 . ////////////////////////////////////////////////////////////////////////////
8877
8878 .chapter "String expansions" "CHAPexpand"
8879 .scindex IIDstrexp "expansion" "of strings"
8880 Many strings in Exim's run time configuration are expanded before use. Some of
8881 them are expanded every time they are used; others are expanded only once.
8882
8883 When a string is being expanded it is copied verbatim from left to right except
8884 when a dollar or backslash character is encountered. A dollar specifies the
8885 start of a portion of the string that is interpreted and replaced as described
8886 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8887 escape character, as described in the following section.
8888
8889 Whether a string is expanded depends upon the context.  Usually this is solely
8890 dependent upon the option for which a value is sought; in this documentation,
8891 options for which string expansion is performed are marked with &dagger; after
8892 the data type.  ACL rules always expand strings.  A couple of expansion
8893 conditions do not expand some of the brace-delimited branches, for security
8894 reasons.
8895
8896
8897
8898 .section "Literal text in expanded strings" "SECTlittext"
8899 .cindex "expansion" "including literal text"
8900 An uninterpreted dollar can be included in an expanded string by putting a
8901 backslash in front of it. A backslash can be used to prevent any special
8902 character being treated specially in an expansion, including backslash itself.
8903 If the string appears in quotes in the configuration file, two backslashes are
8904 required because the quotes themselves cause interpretation of backslashes when
8905 the string is read in (see section &<<SECTstrings>>&).
8906
8907 .cindex "expansion" "non-expandable substrings"
8908 A portion of the string can specified as non-expandable by placing it between
8909 two occurrences of &`\N`&. This is particularly useful for protecting regular
8910 expressions, which often contain backslashes and dollar signs. For example:
8911 .code
8912 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8913 .endd
8914 On encountering the first &`\N`&, the expander copies subsequent characters
8915 without interpretation until it reaches the next &`\N`& or the end of the
8916 string.
8917
8918
8919
8920 .section "Character escape sequences in expanded strings" "SECID82"
8921 .cindex "expansion" "escape sequences"
8922 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8923 expanded string is recognized as an escape sequence for the character newline,
8924 carriage return, or tab, respectively. A backslash followed by up to three
8925 octal digits is recognized as an octal encoding for a single character, and a
8926 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8927 encoding.
8928
8929 These escape sequences are also recognized in quoted strings when they are read
8930 in. Their interpretation in expansions as well is useful for unquoted strings,
8931 and for other cases such as looked-up strings that are then expanded.
8932
8933
8934 .section "Testing string expansions" "SECID83"
8935 .cindex "expansion" "testing"
8936 .cindex "testing" "string expansion"
8937 .oindex "&%-be%&"
8938 Many expansions can be tested by calling Exim with the &%-be%& option. This
8939 takes the command arguments, or lines from the standard input if there are no
8940 arguments, runs them through the string expansion code, and writes the results
8941 to the standard output. Variables based on configuration values are set up, but
8942 since no message is being processed, variables such as &$local_part$& have no
8943 value. Nevertheless the &%-be%& option can be useful for checking out file and
8944 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8945 and &%nhash%&.
8946
8947 Exim gives up its root privilege when it is called with the &%-be%& option, and
8948 instead runs under the uid and gid it was called with, to prevent users from
8949 using &%-be%& for reading files to which they do not have access.
8950
8951 .oindex "&%-bem%&"
8952 If you want to test expansions that include variables whose values are taken
8953 from a message, there are two other options that can be used. The &%-bem%&
8954 option is like &%-be%& except that it is followed by a file name. The file is
8955 read as a message before doing the test expansions. For example:
8956 .code
8957 exim -bem /tmp/test.message '$h_subject:'
8958 .endd
8959 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8960 Exim message identifier. For example:
8961 .code
8962 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8963 .endd
8964 This loads the message from Exim's spool before doing the test expansions, and
8965 is therefore restricted to admin users.
8966
8967
8968 .section "Forced expansion failure" "SECTforexpfai"
8969 .cindex "expansion" "forced failure"
8970 A number of expansions that are described in the following section have
8971 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8972 (which are sometimes called &"curly brackets"&). Which of the two strings is
8973 used depends on some condition that is evaluated as part of the expansion. If,
8974 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8975 the entire string expansion fails in a way that can be detected by the code
8976 that requested the expansion. This is called &"forced expansion failure"&, and
8977 its consequences depend on the circumstances. In some cases it is no different
8978 from any other expansion failure, but in others a different action may be
8979 taken. Such variations are mentioned in the documentation of the option that is
8980 being expanded.
8981
8982
8983
8984
8985 .section "Expansion items" "SECTexpansionitems"
8986 The following items are recognized in expanded strings. White space may be used
8987 between sub-items that are keywords or substrings enclosed in braces inside an
8988 outer set of braces, to improve readability. &*Warning*&: Within braces,
8989 white space is significant.
8990
8991 .vlist
8992 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8993 .cindex "expansion" "variables"
8994 Substitute the contents of the named variable, for example:
8995 .code
8996 $local_part
8997 ${domain}
8998 .endd
8999 The second form can be used to separate the name from subsequent alphanumeric
9000 characters. This form (using braces) is available only for variables; it does
9001 &'not'& apply to message headers. The names of the variables are given in
9002 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9003 given, the expansion fails.
9004
9005 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9006 .cindex "expansion" "operators"
9007 The string is first itself expanded, and then the operation specified by
9008 <&'op'&> is applied to it. For example:
9009 .code
9010 ${lc:$local_part}
9011 .endd
9012 The string starts with the first character after the colon, which may be
9013 leading white space. A list of operators is given in section &<<SECTexpop>>&
9014 below. The operator notation is used for simple expansion items that have just
9015 one argument, because it reduces the number of braces and therefore makes the
9016 string easier to understand.
9017
9018 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9019 This item inserts &"basic"& header lines. It is described with the &%header%&
9020 expansion item below.
9021
9022
9023 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9024 .cindex "expansion" "calling an acl"
9025 .cindex "&%acl%&" "call from expansion"
9026 The name and zero to nine argument strings are first expanded separately.  The expanded
9027 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9028 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9029 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9030 and may use the variables; if another acl expansion is used the values
9031 are restored after it returns.  If the ACL sets
9032 a value using a "message =" modifier and returns accept or deny, the value becomes
9033 the result of the expansion.
9034 If no message is set and the ACL returns accept or deny
9035 the expansion result is an empty string.
9036 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9037
9038
9039 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9040        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9041 .cindex "expansion" "extracting cerificate fields"
9042 .cindex "&%certextract%&" "certificate fields"
9043 .cindex "certificate" "extracting fields"
9044 The <&'certificate'&> must be a variable of type certificate.
9045 The field name is expanded and used to retrieve the relevant field from
9046 the certificate.  Supported fields are:
9047 .display
9048 &`version        `&
9049 &`serial_number  `&
9050 &`subject        `& RFC4514 DN
9051 &`issuer         `& RFC4514 DN
9052 &`notbefore      `& time
9053 &`notafter       `& time
9054 &`sig_algorithm  `&
9055 &`signature      `&
9056 &`subj_altname   `& tagged list
9057 &`ocsp_uri       `& list
9058 &`crl_uri        `& list
9059 .endd
9060 If the field is found,
9061 <&'string2'&> is expanded, and replaces the whole item;
9062 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9063 variable &$value$& contains the value that has been extracted. Afterwards, it
9064 is restored to any previous value it might have had.
9065
9066 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9067 key is not found. If {<&'string2'&>} is also omitted, the value that was
9068 extracted is used.
9069
9070 Some field names take optional modifiers, appended and separated by commas.
9071
9072 The field selectors marked as "RFC4514" above
9073 output a Distinguished Name string which is
9074 not quite
9075 parseable by Exim as a comma-separated tagged list
9076 (the exceptions being elements containing commas).
9077 RDN elements of a single type may be selected by
9078 a modifier of the type label; if so the expansion
9079 result is a list (newline-separated by default).
9080 The separator may be changed by another modifier of
9081 a right angle-bracket followed immediately by the new separator.
9082 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9083
9084 The field selectors marked as "time" above
9085 take an optional modifier of "int"
9086 for which the result is the number of seconds since epoch.
9087 Otherwise the result is a human-readable string
9088 in the timezone selected by the main "timezone" option.
9089
9090 The field selectors marked as "list" above return a list,
9091 newline-separated by default,
9092 (embedded separator characters in elements are doubled).
9093 The separator may be changed by a modifier of
9094 a right angle-bracket followed immediately by the new separator.
9095
9096 The field selectors marked as "tagged" above
9097 prefix each list element with a type string and an equals sign.
9098 Elements of only one type may be selected by a modifier
9099 which is one of "dns", "uri" or "mail";
9100 if so the element tags are omitted.
9101
9102 If not otherwise noted field values are presented in human-readable form.
9103
9104 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9105        {*&<&'arg'&>&*}...}*&"
9106 .cindex &%dlfunc%&
9107 This expansion dynamically loads and then calls a locally-written C function.
9108 This functionality is available only if Exim is compiled with
9109 .code
9110 EXPAND_DLFUNC=yes
9111 .endd
9112 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9113 object so that it doesn't reload the same object file in the same Exim process
9114 (but of course Exim does start new processes frequently).
9115
9116 There may be from zero to eight arguments to the function. When compiling
9117 a local function that is to be called in this way, &_local_scan.h_& should be
9118 included. The Exim variables and functions that are defined by that API
9119 are also available for dynamically loaded functions. The function itself
9120 must have the following type:
9121 .code
9122 int dlfunction(uschar **yield, int argc, uschar *argv[])
9123 .endd
9124 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9125 function should return one of the following values:
9126
9127 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9128 into the expanded string that is being built.
9129
9130 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9131 from &'yield'&, if it is set.
9132
9133 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9134 taken from &'yield'& if it is set.
9135
9136 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9137
9138 When compiling a function that is to be used in this way with gcc,
9139 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9140 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9141
9142
9143 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9144 .cindex "expansion" "extracting value from environment"
9145 .cindex "environment" "values from"
9146 The key is first expanded separately, and leading and trailing white space
9147 removed.
9148 This is then searched for as a name in the environment.
9149 If a variable is found then its value is placed in &$value$&
9150 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9151
9152 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9153 appear, for example:
9154 .code
9155 ${env{USER}{$value} fail }
9156 .endd
9157 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9158 {<&'string1'&>} must be present for &"fail"& to be recognized.
9159
9160 If {<&'string2'&>} is omitted an empty string is substituted on
9161 search failure.
9162 If {<&'string1'&>} is omitted the search result is substituted on
9163 search success.
9164
9165 The environment is adjusted by the &%keep_environment%& and
9166 &%add_environment%& main section options.
9167
9168
9169 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9170        {*&<&'string3'&>&*}}*&"
9171 .cindex "expansion" "extracting substrings by key"
9172 .cindex "&%extract%&" "substrings by key"
9173 The key and <&'string1'&> are first expanded separately. Leading and trailing
9174 white space is removed from the key (but not from any of the strings). The key
9175 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9176 form:
9177 .display
9178 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9179 .endd
9180 .vindex "&$value$&"
9181 where the equals signs and spaces (but not both) are optional. If any of the
9182 values contain white space, they must be enclosed in double quotes, and any
9183 values that are enclosed in double quotes are subject to escape processing as
9184 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9185 for the value that corresponds to the key. The search is case-insensitive. If
9186 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9187 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9188 variable &$value$& contains the value that has been extracted. Afterwards, it
9189 is restored to any previous value it might have had.
9190
9191 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9192 key is not found. If {<&'string2'&>} is also omitted, the value that was
9193 extracted is used. Thus, for example, these two expansions are identical, and
9194 yield &"2001"&:
9195 .code
9196 ${extract{gid}{uid=1984 gid=2001}}
9197 ${extract{gid}{uid=1984 gid=2001}{$value}}
9198 .endd
9199 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9200 appear, for example:
9201 .code
9202 ${extract{Z}{A=... B=...}{$value} fail }
9203 .endd
9204 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9205 {<&'string2'&>} must be present for &"fail"& to be recognized.
9206
9207
9208 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9209         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9210 .cindex "expansion" "extracting substrings by number"
9211 .cindex "&%extract%&" "substrings by number"
9212 The <&'number'&> argument must consist entirely of decimal digits,
9213 apart from leading and trailing white space, which is ignored.
9214 This is what distinguishes this form of &%extract%& from the previous kind. It
9215 behaves in the same way, except that, instead of extracting a named field, it
9216 extracts from <&'string1'&> the field whose number is given as the first
9217 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9218 <&'string3'&> as before.
9219
9220 The fields in the string are separated by any one of the characters in the
9221 separator string. These may include space or tab characters.
9222 The first field is numbered one. If the number is negative, the fields are
9223 counted from the end of the string, with the rightmost one numbered -1. If the
9224 number given is zero, the entire string is returned. If the modulus of the
9225 number is greater than the number of fields in the string, the result is the
9226 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9227 provided. For example:
9228 .code
9229 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9230 .endd
9231 yields &"42"&, and
9232 .code
9233 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9234 .endd
9235 yields &"99"&. Two successive separators mean that the field between them is
9236 empty (for example, the fifth field above).
9237
9238
9239 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9240 .cindex "list" "selecting by condition"
9241 .cindex "expansion" "selecting from list by condition"
9242 .vindex "&$item$&"
9243 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9244 default, but the separator can be changed in the usual way. For each item
9245 in this list, its value is place in &$item$&, and then the condition is
9246 evaluated. If the condition is true, &$item$& is added to the output as an
9247 item in a new list; if the condition is false, the item is discarded. The
9248 separator used for the output list is the same as the one used for the
9249 input, but a separator setting is not included in the output. For example:
9250 .code
9251 ${filter{a:b:c}{!eq{$item}{b}}
9252 .endd
9253 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9254 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9255
9256
9257 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9258 .cindex "hash function" "textual"
9259 .cindex "expansion" "textual hash"
9260 This is a textual hashing function, and was the first to be implemented in
9261 early versions of Exim. In current releases, there are other hashing functions
9262 (numeric, MD5, and SHA-1), which are described below.
9263
9264 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9265 <&'n'&>. If you are using fixed values for these numbers, that is, if
9266 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9267 use the simpler operator notation that avoids some of the braces:
9268 .code
9269 ${hash_<n>_<m>:<string>}
9270 .endd
9271 The second number is optional (in both notations). If <&'n'&> is greater than
9272 or equal to the length of the string, the expansion item returns the string.
9273 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9274 function to the string. The new string consists of characters taken from the
9275 first <&'m'&> characters of the string
9276 .code
9277 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9278 .endd
9279 If <&'m'&> is not present the value 26 is used, so that only lower case
9280 letters appear. For example:
9281 .display
9282 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9283 &`$hash{5}{monty}}           `&   yields  &`monty`&
9284 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9285 .endd
9286
9287 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9288         &*$h_*&<&'header&~name'&>&*:*&" &&&
9289        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9290         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9291        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9292         &*$rh_*&<&'header&~name'&>&*:*&"
9293 .cindex "expansion" "header insertion"
9294 .vindex "&$header_$&"
9295 .vindex "&$bheader_$&"
9296 .vindex "&$rheader_$&"
9297 .cindex "header lines" "in expansion strings"
9298 .cindex "header lines" "character sets"
9299 .cindex "header lines" "decoding"
9300 Substitute the contents of the named message header line, for example
9301 .code
9302 $header_reply-to:
9303 .endd
9304 The newline that terminates a header line is not included in the expansion, but
9305 internal newlines (caused by splitting the header line over several physical
9306 lines) may be present.
9307
9308 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9309 the data in the header line is interpreted.
9310
9311 .ilist
9312 .cindex "white space" "in header lines"
9313 &%rheader%& gives the original &"raw"& content of the header line, with no
9314 processing at all, and without the removal of leading and trailing white space.
9315
9316 .next
9317 .cindex "base64 encoding" "in header lines"
9318 &%bheader%& removes leading and trailing white space, and then decodes base64
9319 or quoted-printable MIME &"words"& within the header text, but does no
9320 character set translation. If decoding of what looks superficially like a MIME
9321 &"word"& fails, the raw string is returned. If decoding
9322 .cindex "binary zero" "in header line"
9323 produces a binary zero character, it is replaced by a question mark &-- this is
9324 what Exim does for binary zeros that are actually received in header lines.
9325
9326 .next
9327 &%header%& tries to translate the string as decoded by &%bheader%& to a
9328 standard character set. This is an attempt to produce the same string as would
9329 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9330 returned. Translation is attempted only on operating systems that support the
9331 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9332 a system Makefile or in &_Local/Makefile_&.
9333 .endlist ilist
9334
9335 In a filter file, the target character set for &%header%& can be specified by a
9336 command of the following form:
9337 .code
9338 headers charset "UTF-8"
9339 .endd
9340 This command affects all references to &$h_$& (or &$header_$&) expansions in
9341 subsequently obeyed filter commands. In the absence of this command, the target
9342 character set in a filter is taken from the setting of the &%headers_charset%&
9343 option in the runtime configuration. The value of this option defaults to the
9344 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9345 ISO-8859-1.
9346
9347 Header names follow the syntax of RFC 2822, which states that they may contain
9348 any printing characters except space and colon. Consequently, curly brackets
9349 &'do not'& terminate header names, and should not be used to enclose them as
9350 if they were variables. Attempting to do so causes a syntax error.
9351
9352 Only header lines that are common to all copies of a message are visible to
9353 this mechanism. These are the original header lines that are received with the
9354 message, and any that are added by an ACL statement or by a system
9355 filter. Header lines that are added to a particular copy of a message by a
9356 router or transport are not accessible.
9357
9358 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9359 before the DATA ACL, because the header structure is not set up until the
9360 message is received. Header lines that are added in a RCPT ACL (for example)
9361 are saved until the message's incoming header lines are available, at which
9362 point they are added. When a DATA ACL is running, however, header lines added
9363 by earlier ACLs are visible.
9364
9365 Upper case and lower case letters are synonymous in header names. If the
9366 following character is white space, the terminating colon may be omitted, but
9367 this is not recommended, because you may then forget it when it is needed. When
9368 white space terminates the header name, this white space is included in the
9369 expanded string.  If the message does not contain the given header, the
9370 expansion item is replaced by an empty string. (See the &%def%& condition in
9371 section &<<SECTexpcond>>& for a means of testing for the existence of a
9372 header.)
9373
9374 If there is more than one header with the same name, they are all concatenated
9375 to form the substitution string, up to a maximum length of 64K. Unless
9376 &%rheader%& is being used, leading and trailing white space is removed from
9377 each header before concatenation, and a completely empty header is ignored. A
9378 newline character is then inserted between non-empty headers, but there is no
9379 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9380 those headers that contain lists of addresses, a comma is also inserted at the
9381 junctions between headers. This does not happen for the &%rheader%& expansion.
9382
9383
9384 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9385 .cindex "expansion" "hmac hashing"
9386 .cindex &%hmac%&
9387 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9388 shared secret and some text into a message authentication code, as specified in
9389 RFC 2104. This differs from &`${md5:secret_text...}`& or
9390 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9391 cryptographic hash, allowing for authentication that is not possible with MD5
9392 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9393 present. For example:
9394 .code
9395 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9396 .endd
9397 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9398 produces:
9399 .code
9400 dd97e3ba5d1a61b5006108f8c8252953
9401 .endd
9402 As an example of how this might be used, you might put in the main part of
9403 an Exim configuration:
9404 .code
9405 SPAMSCAN_SECRET=cohgheeLei2thahw
9406 .endd
9407 In a router or a transport you could then have:
9408 .code
9409 headers_add = \
9410   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9411   ${hmac{md5}{SPAMSCAN_SECRET}\
9412   {${primary_hostname},${message_exim_id},$h_message-id:}}
9413 .endd
9414 Then given a message, you can check where it was scanned by looking at the
9415 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9416 this header line is authentic by recomputing the authentication code from the
9417 host name, message ID and the &'Message-id:'& header line. This can be done
9418 using Exim's &%-be%& option, or by other means, for example by using the
9419 &'hmac_md5_hex()'& function in Perl.
9420
9421
9422 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9423 .cindex "expansion" "conditional"
9424 .cindex "&%if%&, expansion item"
9425 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9426 item; otherwise <&'string2'&> is used. The available conditions are described
9427 in section &<<SECTexpcond>>& below. For example:
9428 .code
9429 ${if eq {$local_part}{postmaster} {yes}{no} }
9430 .endd
9431 The second string need not be present; if it is not and the condition is not
9432 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9433 be present instead of the second string (without any curly brackets). In this
9434 case, the expansion is forced to fail if the condition is not true (see section
9435 &<<SECTforexpfai>>&).
9436
9437 If both strings are omitted, the result is the string &`true`& if the condition
9438 is true, and the empty string if the condition is false. This makes it less
9439 cumbersome to write custom ACL and router conditions. For example, instead of
9440 .code
9441 condition = ${if >{$acl_m4}{3}{true}{false}}
9442 .endd
9443 you can use
9444 .code
9445 condition = ${if >{$acl_m4}{3}}
9446 .endd
9447
9448
9449
9450 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9451 .cindex expansion "imap folder"
9452 .cindex "&%imapfolder%& expansion item"
9453 This item converts a (possibly multilevel, or with non-ASCII characters)
9454 folder specification to a Maildir name for filesystem use.
9455 For information on internationalisation support see &<<SECTi18nMDA>>&.
9456
9457
9458
9459 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9460 .cindex "expansion" "string truncation"
9461 .cindex "&%length%& expansion item"
9462 The &%length%& item is used to extract the initial portion of a string. Both
9463 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9464 you are using a fixed value for the number, that is, if <&'string1'&> does not
9465 change when expanded, you can use the simpler operator notation that avoids
9466 some of the braces:
9467 .code
9468 ${length_<n>:<string>}
9469 .endd
9470 The result of this item is either the first <&'n'&> characters or the whole
9471 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9472 &%strlen%&, which gives the length of a string.
9473
9474
9475 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9476         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9477 .cindex "expansion" "extracting list elements by number"
9478 .cindex "&%listextract%&" "extract list elements by number"
9479 .cindex "list" "extracting elements by number"
9480 The <&'number'&> argument must consist entirely of decimal digits,
9481 apart from an optional leading minus,
9482 and leading and trailing white space (which is ignored).
9483
9484 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9485 default, but the separator can be changed in the usual way.
9486
9487 The first field of the list is numbered one.
9488 If the number is negative, the fields are
9489 counted from the end of the list, with the rightmost one numbered -1.
9490 The numbered element of the list is extracted and placed in &$value$&,
9491 then <&'string2'&> is expanded as the result.
9492
9493 If the modulus of the
9494 number is zero or greater than the number of fields in the string,
9495 the result is the expansion of <&'string3'&>.
9496
9497 For example:
9498 .code
9499 ${listextract{2}{x:42:99}}
9500 .endd
9501 yields &"42"&, and
9502 .code
9503 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9504 .endd
9505 yields &"result: 42"&.
9506
9507 If {<&'string3'&>} is omitted, an empty string is used for string3.
9508 If {<&'string2'&>} is also omitted, the value that was
9509 extracted is used.
9510 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9511
9512
9513 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9514         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9515 This is the first of one of two different types of lookup item, which are both
9516 described in the next item.
9517
9518 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9519         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9520 .cindex "expansion" "lookup in"
9521 .cindex "file" "lookups"
9522 .cindex "lookup" "in expanded string"
9523 The two forms of lookup item specify data lookups in files and databases, as
9524 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9525 lookups, and the second is used for query-style lookups. The <&'key'&>,
9526 <&'file'&>, and <&'query'&> strings are expanded before use.
9527
9528 If there is any white space in a lookup item which is part of a filter command,
9529 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9530 other place where white space is significant, the lookup item must be enclosed
9531 in double quotes. The use of data lookups in users' filter files may be locked
9532 out by the system administrator.
9533
9534 .vindex "&$value$&"
9535 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9536 During its expansion, the variable &$value$& contains the data returned by the
9537 lookup. Afterwards it reverts to the value it had previously (at the outer
9538 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9539 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9540 string on failure. If <&'string2'&> is provided, it can itself be a nested
9541 lookup, thus providing a mechanism for looking up a default value when the
9542 original lookup fails.
9543
9544 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9545 data for the outer lookup while the parameters of the second lookup are
9546 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9547 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9548 appear, and in this case, if the lookup fails, the entire expansion is forced
9549 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9550 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9551 successful lookup, and nothing in the case of failure.
9552
9553 For single-key lookups, the string &"partial"& is permitted to precede the
9554 search type in order to do partial matching, and * or *@ may follow a search
9555 type to request default lookups if the key does not match (see sections
9556 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9557
9558 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9559 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9560 and non-wild parts of the key during the expansion of the replacement text.
9561 They return to their previous values at the end of the lookup item.
9562
9563 This example looks up the postmaster alias in the conventional alias file:
9564 .code
9565 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9566 .endd
9567 This example uses NIS+ to look up the full name of the user corresponding to
9568 the local part of an address, forcing the expansion to fail if it is not found:
9569 .code
9570 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9571   {$value}fail}
9572 .endd
9573
9574
9575 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9576 .cindex "expansion" "list creation"
9577 .vindex "&$item$&"
9578 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9579 default, but the separator can be changed in the usual way. For each item
9580 in this list, its value is place in &$item$&, and then <&'string2'&> is
9581 expanded and added to the output as an item in a new list. The separator used
9582 for the output list is the same as the one used for the input, but a separator
9583 setting is not included in the output. For example:
9584 .code
9585 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9586 .endd
9587 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9588 value of &$item$& is restored to what it was before. See also the &*filter*&
9589 and &*reduce*& expansion items.
9590
9591 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9592 .cindex "expansion" "numeric hash"
9593 .cindex "hash function" "numeric"
9594 The three strings are expanded; the first two must yield numbers. Call them
9595 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9596 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9597 can use the simpler operator notation that avoids some of the braces:
9598 .code
9599 ${nhash_<n>_<m>:<string>}
9600 .endd
9601 The second number is optional (in both notations). If there is only one number,
9602 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9603 processed by a div/mod hash function that returns two numbers, separated by a
9604 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9605 example,
9606 .code
9607 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9608 .endd
9609 returns the string &"6/33"&.
9610
9611
9612
9613 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9614 .cindex "Perl" "use in expanded string"
9615 .cindex "expansion" "calling Perl from"
9616 This item is available only if Exim has been built to include an embedded Perl
9617 interpreter. The subroutine name and the arguments are first separately
9618 expanded, and then the Perl subroutine is called with those arguments. No
9619 additional arguments need be given; the maximum number permitted, including the
9620 name of the subroutine, is nine.
9621
9622 The return value of the subroutine is inserted into the expanded string, unless
9623 the return value is &%undef%&. In that case, the expansion fails in the same
9624 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9625 Whatever you return is evaluated in a scalar context. For example, if you
9626 return the name of a Perl vector, the return value is the size of the vector,
9627 not its contents.
9628
9629 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9630 with the error message that was passed to &%die%&. More details of the embedded
9631 Perl facility are given in chapter &<<CHAPperl>>&.
9632
9633 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9634 out the use of this expansion item in filter files.
9635
9636
9637 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9638 .cindex "&%prvs%& expansion item"
9639 The first argument is a complete email address and the second is secret
9640 keystring. The third argument, specifying a key number, is optional. If absent,
9641 it defaults to 0. The result of the expansion is a prvs-signed email address,
9642 to be typically used with the &%return_path%& option on an &(smtp)& transport
9643 as part of a bounce address tag validation (BATV) scheme. For more discussion
9644 and an example, see section &<<SECTverifyPRVS>>&.
9645
9646 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9647         {*&<&'string'&>&*}}*&"
9648 .cindex "&%prvscheck%& expansion item"
9649 This expansion item is the complement of the &%prvs%& item. It is used for
9650 checking prvs-signed addresses. If the expansion of the first argument does not
9651 yield a syntactically valid prvs-signed address, the whole item expands to the
9652 empty string. When the first argument does expand to a syntactically valid
9653 prvs-signed address, the second argument is expanded, with the prvs-decoded
9654 version of the address and the key number extracted from the address in the
9655 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9656
9657 These two variables can be used in the expansion of the second argument to
9658 retrieve the secret. The validity of the prvs-signed address is then checked
9659 against the secret. The result is stored in the variable &$prvscheck_result$&,
9660 which is empty for failure or &"1"& for success.
9661
9662 The third argument is optional; if it is missing, it defaults to an empty
9663 string. This argument is now expanded. If the result is an empty string, the
9664 result of the expansion is the decoded version of the address. This is the case
9665 whether or not the signature was valid. Otherwise, the result of the expansion
9666 is the expansion of the third argument.
9667
9668 All three variables can be used in the expansion of the third argument.
9669 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9670 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9671
9672 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9673 .cindex "expansion" "inserting an entire file"
9674 .cindex "file" "inserting into expansion"
9675 .cindex "&%readfile%& expansion item"
9676 The file name and end-of-line string are first expanded separately. The file is
9677 then read, and its contents replace the entire item. All newline characters in
9678 the file are replaced by the end-of-line string if it is present. Otherwise,
9679 newlines are left in the string.
9680 String expansion is not applied to the contents of the file. If you want this,
9681 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9682 the string expansion fails.
9683
9684 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9685 locks out the use of this expansion item in filter files.
9686
9687
9688
9689 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9690         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9691 .cindex "expansion" "inserting from a socket"
9692 .cindex "socket, use of in expansion"
9693 .cindex "&%readsocket%& expansion item"
9694 This item inserts data from a Unix domain or TCP socket into the expanded
9695 string. The minimal way of using it uses just two arguments, as in these
9696 examples:
9697 .code
9698 ${readsocket{/socket/name}{request string}}
9699 ${readsocket{inet:some.host:1234}{request string}}
9700 .endd
9701 For a Unix domain socket, the first substring must be the path to the socket.
9702 For an Internet socket, the first substring must contain &`inet:`& followed by
9703 a host name or IP address, followed by a colon and a port, which can be a
9704 number or the name of a TCP port in &_/etc/services_&. An IP address may
9705 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9706 example:
9707 .code
9708 ${readsocket{inet:[::1]:1234}{request string}}
9709 .endd
9710 Only a single host name may be given, but if looking it up yields more than
9711 one IP address, they are each tried in turn until a connection is made. For
9712 both kinds of socket, Exim makes a connection, writes the request string
9713 unless it is an empty string; and no terminating NUL is ever sent)
9714 and reads from the socket until an end-of-file
9715 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9716 extend what can be done. Firstly, you can vary the timeout. For example:
9717 .code
9718 ${readsocket{/socket/name}{request string}{3s}}
9719 .endd
9720 A fourth argument allows you to change any newlines that are in the data
9721 that is read, in the same way as for &%readfile%& (see above). This example
9722 turns them into spaces:
9723 .code
9724 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9725 .endd
9726 As with all expansions, the substrings are expanded before the processing
9727 happens. Errors in these sub-expansions cause the expansion to fail. In
9728 addition, the following errors can occur:
9729
9730 .ilist
9731 Failure to create a socket file descriptor;
9732 .next
9733 Failure to connect the socket;
9734 .next
9735 Failure to write the request string;
9736 .next
9737 Timeout on reading from the socket.
9738 .endlist
9739
9740 By default, any of these errors causes the expansion to fail. However, if
9741 you supply a fifth substring, it is expanded and used when any of the above
9742 errors occurs. For example:
9743 .code
9744 ${readsocket{/socket/name}{request string}{3s}{\n}\
9745   {socket failure}}
9746 .endd
9747 You can test for the existence of a Unix domain socket by wrapping this
9748 expansion in &`${if exists`&, but there is a race condition between that test
9749 and the actual opening of the socket, so it is safer to use the fifth argument
9750 if you want to be absolutely sure of avoiding an expansion error for a
9751 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9752
9753 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9754 locks out the use of this expansion item in filter files.
9755
9756
9757 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9758 .cindex "expansion" "reducing a list to a scalar"
9759 .cindex "list" "reducing to a scalar"
9760 .vindex "&$value$&"
9761 .vindex "&$item$&"
9762 This operation reduces a list to a single, scalar string. After expansion,
9763 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9764 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9765 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9766 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9767 them. The result of that expansion is assigned to &$value$& before the next
9768 iteration. When the end of the list is reached, the final value of &$value$& is
9769 added to the expansion output. The &*reduce*& expansion item can be used in a
9770 number of ways. For example, to add up a list of numbers:
9771 .code
9772 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9773 .endd
9774 The result of that expansion would be &`6`&. The maximum of a list of numbers
9775 can be found:
9776 .code
9777 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9778 .endd
9779 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9780 restored to what they were before. See also the &*filter*& and &*map*&
9781 expansion items.
9782
9783 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9784 This item inserts &"raw"& header lines. It is described with the &%header%&
9785 expansion item above.
9786
9787 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9788         {*&<&'string2'&>&*}}*&"
9789 .cindex "expansion" "running a command"
9790 .cindex "&%run%& expansion item"
9791 The command and its arguments are first expanded as one string. The string is
9792 split apart into individual arguments by spaces, and then the command is run
9793 in a separate process, but under the same uid and gid.  As in other command
9794 executions from Exim, a shell is not used by default. If the command requires
9795 a shell, you must explicitly code it.
9796
9797 Since the arguments are split by spaces, when there is a variable expansion
9798 which has an empty result, it will cause the situation that the argument will
9799 simply be omitted when the program is actually executed by Exim. If the
9800 script/program requires a specific number of arguments and the expanded
9801 variable could possibly result in this empty expansion, the variable must be
9802 quoted. This is more difficult if the expanded variable itself could result
9803 in a string containing quotes, because it would interfere with the quotes
9804 around the command arguments. A possible guard against this is to wrap the
9805 variable in the &%sg%& operator to change any quote marks to some other
9806 character.
9807
9808 The standard input for the command exists, but is empty. The standard output
9809 and standard error are set to the same file descriptor.
9810 .cindex "return code" "from &%run%& expansion"
9811 .vindex "&$value$&"
9812 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9813 and replaces the entire item; during this expansion, the standard output/error
9814 from the command is in the variable &$value$&. If the command fails,
9815 <&'string2'&>, if present, is expanded and used. Once again, during the
9816 expansion, the standard output/error from the command is in the variable
9817 &$value$&.
9818
9819 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9820 can be the word &"fail"& (not in braces) to force expansion failure if the
9821 command does not succeed. If both strings are omitted, the result is contents
9822 of the standard output/error on success, and nothing on failure.
9823
9824 .vindex "&$run_in_acl$&"
9825 The standard output/error of the command is put in the variable &$value$&.
9826 In this ACL example, the output of a command is logged for the admin to
9827 troubleshoot:
9828 .code
9829 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9830       log_message  = Output of id: $value
9831 .endd
9832 If the command requires shell idioms, such as the > redirect operator, the
9833 shell must be invoked directly, such as with:
9834 .code
9835 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9836 .endd
9837
9838 .vindex "&$runrc$&"
9839 The return code from the command is put in the variable &$runrc$&, and this
9840 remains set afterwards, so in a filter file you can do things like this:
9841 .code
9842 if "${run{x y z}{}}$runrc" is 1 then ...
9843   elif $runrc is 2 then ...
9844   ...
9845 endif
9846 .endd
9847 If execution of the command fails (for example, the command does not exist),
9848 the return code is 127 &-- the same code that shells use for non-existent
9849 commands.
9850
9851 &*Warning*&: In a router or transport, you cannot assume the order in which
9852 option values are expanded, except for those preconditions whose order of
9853 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9854 by the expansion of one option, and use it in another.
9855
9856 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9857 out the use of this expansion item in filter files.
9858
9859
9860 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9861 .cindex "expansion" "string substitution"
9862 .cindex "&%sg%& expansion item"
9863 This item works like Perl's substitution operator (s) with the global (/g)
9864 option; hence its name. However, unlike the Perl equivalent, Exim does not
9865 modify the subject string; instead it returns the modified string for insertion
9866 into the overall expansion. The item takes three arguments: the subject string,
9867 a regular expression, and a substitution string. For example:
9868 .code
9869 ${sg{abcdefabcdef}{abc}{xyz}}
9870 .endd
9871 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9872 if any $ or \ characters are required in the regular expression or in the
9873 substitution string, they have to be escaped. For example:
9874 .code
9875 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9876 .endd
9877 yields &"defabc"&, and
9878 .code
9879 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9880 .endd
9881 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9882 the regular expression from string expansion.
9883
9884
9885
9886 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9887 .cindex sorting "a list"
9888 .cindex list sorting
9889 .cindex expansion "list sorting"
9890 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9891 default, but the separator can be changed in the usual way.
9892 The <&'comparator'&> argument is interpreted as the operator
9893 of a two-argument expansion condition.
9894 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9895 The comparison should return true when applied to two values
9896 if the first value should sort before the second value.
9897 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9898 the element being placed in &$item$&,
9899 to give values for comparison.
9900
9901 The item result is a sorted list,
9902 with the original list separator,
9903 of the list elements (in full) of the original.
9904
9905 Examples:
9906 .code
9907 ${sort{3:2:1:4}{<}{$item}}
9908 .endd
9909 sorts a list of numbers, and
9910 .code
9911 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9912 .endd
9913 will sort an MX lookup into priority order.
9914
9915
9916 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9917 .cindex "&%substr%& expansion item"
9918 .cindex "substring extraction"
9919 .cindex "expansion" "substring extraction"
9920 The three strings are expanded; the first two must yield numbers. Call them
9921 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9922 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9923 can use the simpler operator notation that avoids some of the braces:
9924 .code
9925 ${substr_<n>_<m>:<string>}
9926 .endd
9927 The second number is optional (in both notations).
9928 If it is absent in the simpler format, the preceding underscore must also be
9929 omitted.
9930
9931 The &%substr%& item can be used to extract more general substrings than
9932 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9933 length required. For example
9934 .code
9935 ${substr{3}{2}{$local_part}}
9936 .endd
9937 If the starting offset is greater than the string length the result is the
9938 null string; if the length plus starting offset is greater than the string
9939 length, the result is the right-hand part of the string, starting from the
9940 given offset. The first character in the string has offset zero.
9941
9942 The &%substr%& expansion item can take negative offset values to count
9943 from the right-hand end of its operand. The last character is offset -1, the
9944 second-last is offset -2, and so on. Thus, for example,
9945 .code
9946 ${substr{-5}{2}{1234567}}
9947 .endd
9948 yields &"34"&. If the absolute value of a negative offset is greater than the
9949 length of the string, the substring starts at the beginning of the string, and
9950 the length is reduced by the amount of overshoot. Thus, for example,
9951 .code
9952 ${substr{-5}{2}{12}}
9953 .endd
9954 yields an empty string, but
9955 .code
9956 ${substr{-3}{2}{12}}
9957 .endd
9958 yields &"1"&.
9959
9960 When the second number is omitted from &%substr%&, the remainder of the string
9961 is taken if the offset is positive. If it is negative, all characters in the
9962 string preceding the offset point are taken. For example, an offset of -1 and
9963 no length, as in these semantically identical examples:
9964 .code
9965 ${substr_-1:abcde}
9966 ${substr{-1}{abcde}}
9967 .endd
9968 yields all but the last character of the string, that is, &"abcd"&.
9969
9970
9971
9972 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9973         {*&<&'replacements'&>&*}}*&"
9974 .cindex "expansion" "character translation"
9975 .cindex "&%tr%& expansion item"
9976 This item does single-character translation on its subject string. The second
9977 argument is a list of characters to be translated in the subject string. Each
9978 matching character is replaced by the corresponding character from the
9979 replacement list. For example
9980 .code
9981 ${tr{abcdea}{ac}{13}}
9982 .endd
9983 yields &`1b3de1`&. If there are duplicates in the second character string, the
9984 last occurrence is used. If the third string is shorter than the second, its
9985 last character is replicated. However, if it is empty, no translation takes
9986 place.
9987 .endlist
9988
9989
9990
9991 .section "Expansion operators" "SECTexpop"
9992 .cindex "expansion" "operators"
9993 For expansion items that perform transformations on a single argument string,
9994 the &"operator"& notation is used because it is simpler and uses fewer braces.
9995 The substring is first expanded before the operation is applied to it. The
9996 following operations can be performed:
9997
9998 .vlist
9999 .vitem &*${address:*&<&'string'&>&*}*&
10000 .cindex "expansion" "RFC 2822 address handling"
10001 .cindex "&%address%& expansion item"
10002 The string is interpreted as an RFC 2822 address, as it might appear in a
10003 header line, and the effective address is extracted from it. If the string does
10004 not parse successfully, the result is empty.
10005
10006
10007 .vitem &*${addresses:*&<&'string'&>&*}*&
10008 .cindex "expansion" "RFC 2822 address handling"
10009 .cindex "&%addresses%& expansion item"
10010 The string (after expansion) is interpreted as a list of addresses in RFC
10011 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10012 operative address (&'local-part@domain'&) is extracted from each item, and the
10013 result of the expansion is a colon-separated list, with appropriate
10014 doubling of colons should any happen to be present in the email addresses.
10015 Syntactically invalid RFC2822 address items are omitted from the output.
10016
10017 It is possible to specify a character other than colon for the output
10018 separator by starting the string with > followed by the new separator
10019 character. For example:
10020 .code
10021 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10022 .endd
10023 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10024 expansion item, which extracts the working address from a single RFC2822
10025 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10026 processing lists.
10027
10028 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10029 a strict interpretation of header line formatting.  Exim parses the bare,
10030 unquoted portion of an email address and if it finds a comma, treats it as an
10031 email address separator. For the example header line:
10032 .code
10033 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10034 .endd
10035 The first example below demonstrates that Q-encoded email addresses are parsed
10036 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10037 It does not see the comma because it's still encoded as "=2C".  The second
10038 example below is passed the contents of &`$header_from:`&, meaning it gets
10039 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10040 The third example shows that the presence of a comma is skipped when it is
10041 quoted.
10042 .code
10043 # exim -be '${addresses:From: \
10044 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10045 user@example.com
10046 # exim -be '${addresses:From: Last, First <user@example.com>}'
10047 Last:user@example.com
10048 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10049 user@example.com
10050 .endd
10051
10052 .vitem &*${base62:*&<&'digits'&>&*}*&
10053 .cindex "&%base62%& expansion item"
10054 .cindex "expansion" "conversion to base 62"
10055 The string must consist entirely of decimal digits. The number is converted to
10056 base 62 and output as a string of six characters, including leading zeros. In
10057 the few operating environments where Exim uses base 36 instead of base 62 for
10058 its message identifiers (because those systems do not have case-sensitive file
10059 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10060 be absolutely clear: this is &'not'& base64 encoding.
10061
10062 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10063 .cindex "&%base62d%& expansion item"
10064 .cindex "expansion" "conversion to base 62"
10065 The string must consist entirely of base-62 digits, or, in operating
10066 environments where Exim uses base 36 instead of base 62 for its message
10067 identifiers, base-36 digits. The number is converted to decimal and output as a
10068 string.
10069
10070 .vitem &*${base64:*&<&'string'&>&*}*&
10071 .cindex "expansion" "base64 encoding"
10072 .cindex "base64 encoding" "in string expansion"
10073 .cindex "&%base64%& expansion item"
10074 .cindex certificate "base64 of DER"
10075 This operator converts a string into one that is base64 encoded.
10076
10077 If the string is a single variable of type certificate,
10078 returns the base64 encoding of the DER form of the certificate.
10079
10080
10081 .vitem &*${base64d:*&<&'string'&>&*}*&
10082 .cindex "expansion" "base64 decoding"
10083 .cindex "base64 decoding" "in string expansion"
10084 .cindex "&%base64d%& expansion item"
10085 This operator converts a base64-encoded string into the un-coded form.
10086
10087
10088 .vitem &*${domain:*&<&'string'&>&*}*&
10089 .cindex "domain" "extraction"
10090 .cindex "expansion" "domain extraction"
10091 The string is interpreted as an RFC 2822 address and the domain is extracted
10092 from it. If the string does not parse successfully, the result is empty.
10093
10094
10095 .vitem &*${escape:*&<&'string'&>&*}*&
10096 .cindex "expansion" "escaping non-printing characters"
10097 .cindex "&%escape%& expansion item"
10098 If the string contains any non-printing characters, they are converted to
10099 escape sequences starting with a backslash. Whether characters with the most
10100 significant bit set (so-called &"8-bit characters"&) count as printing or not
10101 is controlled by the &%print_topbitchars%& option.
10102
10103
10104 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10105 .cindex "expansion" "expression evaluation"
10106 .cindex "expansion" "arithmetic expression"
10107 .cindex "&%eval%& expansion item"
10108 These items supports simple arithmetic and bitwise logical operations in
10109 expansion strings. The string (after expansion) must be a conventional
10110 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10111 logical operators, and parentheses. All operations are carried out using
10112 integer arithmetic. The operator priorities are as follows (the same as in the
10113 C programming language):
10114 .table2 70pt 300pt
10115 .irow &'highest:'& "not (~), negate (-)"
10116 .irow ""   "multiply (*), divide (/), remainder (%)"
10117 .irow ""   "plus (+), minus (-)"
10118 .irow ""   "shift-left (<<), shift-right (>>)"
10119 .irow ""   "and (&&)"
10120 .irow ""   "xor (^)"
10121 .irow &'lowest:'&  "or (|)"
10122 .endtable
10123 Binary operators with the same priority are evaluated from left to right. White
10124 space is permitted before or after operators.
10125
10126 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10127 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10128 decimal, even if they start with a leading zero; hexadecimal numbers are not
10129 permitted. This can be useful when processing numbers extracted from dates or
10130 times, which often do have leading zeros.
10131
10132 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10133 or 1024*1024*1024,
10134 respectively. Negative numbers are supported. The result of the computation is
10135 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10136
10137 .display
10138 &`${eval:1+1}            `&  yields 2
10139 &`${eval:1+2*3}          `&  yields 7
10140 &`${eval:(1+2)*3}        `&  yields 9
10141 &`${eval:2+42%5}         `&  yields 4
10142 &`${eval:0xc&amp;5}          `&  yields 4
10143 &`${eval:0xc|5}          `&  yields 13
10144 &`${eval:0xc^5}          `&  yields 9
10145 &`${eval:0xc>>1}         `&  yields 6
10146 &`${eval:0xc<<1}         `&  yields 24
10147 &`${eval:~255&amp;0x1234}    `&  yields 4608
10148 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10149 .endd
10150
10151 As a more realistic example, in an ACL you might have
10152 .code
10153 deny   message = Too many bad recipients
10154        condition =                    \
10155          ${if and {                   \
10156            {>{$rcpt_count}{10}}       \
10157            {                          \
10158            <                          \
10159              {$recipients_count}      \
10160              {${eval:$rcpt_count/2}}  \
10161            }                          \
10162          }{yes}{no}}
10163 .endd
10164 The condition is true if there have been more than 10 RCPT commands and
10165 fewer than half of them have resulted in a valid recipient.
10166
10167
10168 .vitem &*${expand:*&<&'string'&>&*}*&
10169 .cindex "expansion" "re-expansion of substring"
10170 The &%expand%& operator causes a string to be expanded for a second time. For
10171 example,
10172 .code
10173 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10174 .endd
10175 first looks up a string in a file while expanding the operand for &%expand%&,
10176 and then re-expands what it has found.
10177
10178
10179 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10180 .cindex "Unicode"
10181 .cindex "UTF-8" "conversion from"
10182 .cindex "expansion" "UTF-8 conversion"
10183 .cindex "&%from_utf8%& expansion item"
10184 The world is slowly moving towards Unicode, although there are no standards for
10185 email yet. However, other applications (including some databases) are starting
10186 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10187 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10188 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10189 the result is an undefined sequence of bytes.
10190
10191 Unicode code points with values less than 256 are compatible with ASCII and
10192 ISO-8859-1 (also known as Latin-1).
10193 For example, character 169 is the copyright symbol in both cases, though the
10194 way it is encoded is different. In UTF-8, more than one byte is needed for
10195 characters with code values greater than 127, whereas ISO-8859-1 is a
10196 single-byte encoding (but thereby limited to 256 characters). This makes
10197 translation from UTF-8 to ISO-8859-1 straightforward.
10198
10199
10200 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10201 .cindex "hash function" "textual"
10202 .cindex "expansion" "textual hash"
10203 The &%hash%& operator is a simpler interface to the hashing function that can
10204 be used when the two parameters are fixed numbers (as opposed to strings that
10205 change when expanded). The effect is the same as
10206 .code
10207 ${hash{<n>}{<m>}{<string>}}
10208 .endd
10209 See the description of the general &%hash%& item above for details. The
10210 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10211
10212
10213
10214 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10215 .cindex "base64 encoding" "conversion from hex"
10216 .cindex "expansion" "hex to base64"
10217 .cindex "&%hex2b64%& expansion item"
10218 This operator converts a hex string into one that is base64 encoded. This can
10219 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10220
10221
10222
10223 .vitem &*${hexquote:*&<&'string'&>&*}*&
10224 .cindex "quoting" "hex-encoded unprintable characters"
10225 .cindex "&%hexquote%& expansion item"
10226 This operator converts non-printable characters in a string into a hex
10227 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10228 as is, and other byte values are converted to &`\xNN`&, for example a
10229 byte value 127 is converted to &`\x7f`&.
10230
10231
10232 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10233 .cindex "&%ipv6denorm%& expansion item"
10234 .cindex "IP address" normalisation
10235 This expands an IPv6 address to a full eight-element colon-separated set
10236 of hex digits including leading zeroes.
10237 A trailing ipv4-style dotted-decimal set is converted to hex.
10238 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10239
10240 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10241 .cindex "&%ipv6norm%& expansion item"
10242 .cindex "IP address" normalisation
10243 .cindex "IP address" "canonical form"
10244 This converts an IPv6 address to canonical form.
10245 Leading zeroes of groups are omitted, and the longest
10246 set of zero-valued groups is replaced with a double colon.
10247 A trailing ipv4-style dotted-decimal set is converted to hex.
10248 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10249
10250
10251 .vitem &*${lc:*&<&'string'&>&*}*&
10252 .cindex "case forcing in strings"
10253 .cindex "string" "case forcing"
10254 .cindex "lower casing"
10255 .cindex "expansion" "case forcing"
10256 .cindex "&%lc%& expansion item"
10257 This forces the letters in the string into lower-case, for example:
10258 .code
10259 ${lc:$local_part}
10260 .endd
10261
10262 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10263 .cindex "expansion" "string truncation"
10264 .cindex "&%length%& expansion item"
10265 The &%length%& operator is a simpler interface to the &%length%& function that
10266 can be used when the parameter is a fixed number (as opposed to a string that
10267 changes when expanded). The effect is the same as
10268 .code
10269 ${length{<number>}{<string>}}
10270 .endd
10271 See the description of the general &%length%& item above for details. Note that
10272 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10273 when &%length%& is used as an operator.
10274
10275
10276 .vitem &*${listcount:*&<&'string'&>&*}*&
10277 .cindex "expansion" "list item count"
10278 .cindex "list" "item count"
10279 .cindex "list" "count of items"
10280 .cindex "&%listcount%& expansion item"
10281 The string is interpreted as a list and the number of items is returned.
10282
10283
10284 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10285 .cindex "expansion" "named list"
10286 .cindex "&%listnamed%& expansion item"
10287 The name is interpreted as a named list and the content of the list is returned,
10288 expanding any referenced lists, re-quoting as needed for colon-separation.
10289 If the optional type is given it must be one of "a", "d", "h" or "l"
10290 and selects address-, domain-, host- or localpart- lists to search among respectively.
10291 Otherwise all types are searched in an undefined order and the first
10292 matching list is returned.
10293
10294
10295 .vitem &*${local_part:*&<&'string'&>&*}*&
10296 .cindex "expansion" "local part extraction"
10297 .cindex "&%local_part%& expansion item"
10298 The string is interpreted as an RFC 2822 address and the local part is
10299 extracted from it. If the string does not parse successfully, the result is
10300 empty.
10301
10302
10303 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10304 .cindex "masked IP address"
10305 .cindex "IP address" "masking"
10306 .cindex "CIDR notation"
10307 .cindex "expansion" "IP address masking"
10308 .cindex "&%mask%& expansion item"
10309 If the form of the string to be operated on is not an IP address followed by a
10310 slash and an integer (that is, a network address in CIDR notation), the
10311 expansion fails. Otherwise, this operator converts the IP address to binary,
10312 masks off the least significant bits according to the bit count, and converts
10313 the result back to text, with mask appended. For example,
10314 .code
10315 ${mask:10.111.131.206/28}
10316 .endd
10317 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10318 be mostly used for looking up masked addresses in files, the result for an IPv6
10319 address uses dots to separate components instead of colons, because colon
10320 terminates a key string in lsearch files. So, for example,
10321 .code
10322 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10323 .endd
10324 returns the string
10325 .code
10326 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10327 .endd
10328 Letters in IPv6 addresses are always output in lower case.
10329
10330
10331 .vitem &*${md5:*&<&'string'&>&*}*&
10332 .cindex "MD5 hash"
10333 .cindex "expansion" "MD5 hash"
10334 .cindex certificate fingerprint
10335 .cindex "&%md5%& expansion item"
10336 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10337 as a 32-digit hexadecimal number, in which any letters are in lower case.
10338
10339 If the string is a single variable of type certificate,
10340 returns the MD5 hash fingerprint of the certificate.
10341
10342
10343 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10344 .cindex "expansion" "numeric hash"
10345 .cindex "hash function" "numeric"
10346 The &%nhash%& operator is a simpler interface to the numeric hashing function
10347 that can be used when the two parameters are fixed numbers (as opposed to
10348 strings that change when expanded). The effect is the same as
10349 .code
10350 ${nhash{<n>}{<m>}{<string>}}
10351 .endd
10352 See the description of the general &%nhash%& item above for details.
10353
10354
10355 .vitem &*${quote:*&<&'string'&>&*}*&
10356 .cindex "quoting" "in string expansions"
10357 .cindex "expansion" "quoting"
10358 .cindex "&%quote%& expansion item"
10359 The &%quote%& operator puts its argument into double quotes if it
10360 is an empty string or
10361 contains anything other than letters, digits, underscores, dots, and hyphens.
10362 Any occurrences of double quotes and backslashes are escaped with a backslash.
10363 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10364 respectively For example,
10365 .code
10366 ${quote:ab"*"cd}
10367 .endd
10368 becomes
10369 .code
10370 "ab\"*\"cd"
10371 .endd
10372 The place where this is useful is when the argument is a substitution from a
10373 variable or a message header.
10374
10375 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10376 .cindex "&%quote_local_part%& expansion item"
10377 This operator is like &%quote%&, except that it quotes the string only if
10378 required to do so by the rules of RFC 2822 for quoting local parts. For
10379 example, a plus sign would not cause quoting (but it would for &%quote%&).
10380 If you are creating a new email address from the contents of &$local_part$&
10381 (or any other unknown data), you should always use this operator.
10382
10383
10384 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10385 .cindex "quoting" "lookup-specific"
10386 This operator applies lookup-specific quoting rules to the string. Each
10387 query-style lookup type has its own quoting rules which are described with
10388 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10389 .code
10390 ${quote_ldap:two * two}
10391 .endd
10392 returns
10393 .code
10394 two%20%5C2A%20two
10395 .endd
10396 For single-key lookup types, no quoting is ever necessary and this operator
10397 yields an unchanged string.
10398
10399
10400 .vitem &*${randint:*&<&'n'&>&*}*&
10401 .cindex "random number"
10402 This operator returns a somewhat random number which is less than the
10403 supplied number and is at least 0.  The quality of this randomness depends
10404 on how Exim was built; the values are not suitable for keying material.
10405 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10406 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10407 for versions of GnuTLS with that function.
10408 Otherwise, the implementation may be arc4random(), random() seeded by
10409 srandomdev() or srandom(), or a custom implementation even weaker than
10410 random().
10411
10412
10413 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10414 .cindex "expansion" "IP address"
10415 This operator reverses an IP address; for IPv4 addresses, the result is in
10416 dotted-quad decimal form, while for IPv6 addresses the result is in
10417 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10418 for DNS.  For example,
10419 .code
10420 ${reverse_ip:192.0.2.4}
10421 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10422 .endd
10423 returns
10424 .code
10425 4.2.0.192
10426 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
10427 .endd
10428
10429
10430 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10431 .cindex "expansion" "RFC 2047"
10432 .cindex "RFC 2047" "expansion operator"
10433 .cindex "&%rfc2047%& expansion item"
10434 This operator encodes text according to the rules of RFC 2047. This is an
10435 encoding that is used in header lines to encode non-ASCII characters. It is
10436 assumed that the input string is in the encoding specified by the
10437 &%headers_charset%& option, which gets its default at build time. If the string
10438 contains only characters in the range 33&--126, and no instances of the
10439 characters
10440 .code
10441 ? = ( ) < > @ , ; : \ " . [ ] _
10442 .endd
10443 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10444 string, using as many &"encoded words"& as necessary to encode all the
10445 characters.
10446
10447
10448 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10449 .cindex "expansion" "RFC 2047"
10450 .cindex "RFC 2047" "decoding"
10451 .cindex "&%rfc2047d%& expansion item"
10452 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10453 bytes are replaced by question marks. Characters are converted into the
10454 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10455 not recognized unless &%check_rfc2047_length%& is set false.
10456
10457 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10458 access a header line, RFC 2047 decoding is done automatically. You do not need
10459 to use this operator as well.
10460
10461
10462
10463 .vitem &*${rxquote:*&<&'string'&>&*}*&
10464 .cindex "quoting" "in regular expressions"
10465 .cindex "regular expressions" "quoting"
10466 .cindex "&%rxquote%& expansion item"
10467 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10468 characters in its argument. This is useful when substituting the values of
10469 variables or headers inside regular expressions.
10470
10471
10472 .vitem &*${sha1:*&<&'string'&>&*}*&
10473 .cindex "SHA-1 hash"
10474 .cindex "expansion" "SHA-1 hashing"
10475 .cindex certificate fingerprint
10476 .cindex "&%sha2%& expansion item"
10477 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10478 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10479
10480 If the string is a single variable of type certificate,
10481 returns the SHA-1 hash fingerprint of the certificate.
10482
10483
10484 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10485 .cindex "SHA-256 hash"
10486 .cindex certificate fingerprint
10487 .cindex "expansion" "SHA-256 hashing"
10488 .cindex "&%sha256%& expansion item"
10489 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10490 certificate,
10491 and returns
10492 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10493 Only arguments which are a single variable of certificate type are supported.
10494
10495
10496 .vitem &*${stat:*&<&'string'&>&*}*&
10497 .cindex "expansion" "statting a file"
10498 .cindex "file" "extracting characteristics"
10499 .cindex "&%stat%& expansion item"
10500 The string, after expansion, must be a file path. A call to the &[stat()]&
10501 function is made for this path. If &[stat()]& fails, an error occurs and the
10502 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10503 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10504 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10505 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10506 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10507 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10508 can extract individual fields using the &%extract%& expansion item.
10509
10510 The use of the &%stat%& expansion in users' filter files can be locked out by
10511 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10512 systems for files larger than 2GB.
10513
10514 .vitem &*${str2b64:*&<&'string'&>&*}*&
10515 .cindex "&%str2b64%& expansion item"
10516 Now deprecated, a synonym for the &%base64%& expansion operator.
10517
10518
10519
10520 .vitem &*${strlen:*&<&'string'&>&*}*&
10521 .cindex "expansion" "string length"
10522 .cindex "string" "length in expansion"
10523 .cindex "&%strlen%& expansion item"
10524 The item is replace by the length of the expanded string, expressed as a
10525 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10526
10527
10528 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10529 .cindex "&%substr%& expansion item"
10530 .cindex "substring extraction"
10531 .cindex "expansion" "substring expansion"
10532 The &%substr%& operator is a simpler interface to the &%substr%& function that
10533 can be used when the two parameters are fixed numbers (as opposed to strings
10534 that change when expanded). The effect is the same as
10535 .code
10536 ${substr{<start>}{<length>}{<string>}}
10537 .endd
10538 See the description of the general &%substr%& item above for details. The
10539 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10540
10541 .vitem &*${time_eval:*&<&'string'&>&*}*&
10542 .cindex "&%time_eval%& expansion item"
10543 .cindex "time interval" "decoding"
10544 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10545 seconds.
10546
10547 .vitem &*${time_interval:*&<&'string'&>&*}*&
10548 .cindex "&%time_interval%& expansion item"
10549 .cindex "time interval" "formatting"
10550 The argument (after sub-expansion) must be a sequence of decimal digits that
10551 represents an interval of time as a number of seconds. It is converted into a
10552 number of larger units and output in Exim's normal time format, for example,
10553 &`1w3d4h2m6s`&.
10554
10555 .vitem &*${uc:*&<&'string'&>&*}*&
10556 .cindex "case forcing in strings"
10557 .cindex "string" "case forcing"
10558 .cindex "upper casing"
10559 .cindex "expansion" "case forcing"
10560 .cindex "&%uc%& expansion item"
10561 This forces the letters in the string into upper-case.
10562
10563 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10564 .cindex "correction of invalid utf-8 sequences in strings"
10565 .cindex "utf-8" "utf-8 sequences"
10566 .cindex "incorrect utf-8"
10567 .cindex "expansion" "utf-8 forcing"
10568 .cindex "&%utf8clean%& expansion item"
10569 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10570
10571 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10572        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10573        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10574        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10575 .cindex expansion UTF-8
10576 .cindex UTF-8 expansion
10577 .cindex EAI
10578 .cindex internationalisation
10579 .cindex "&%utf8_domain_to_alabel%& expansion item"
10580 .cindex "&%utf8_domain_from_alabel%& expansion item"
10581 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10582 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10583 These convert EAI mail name components between UTF-8 and a-label forms.
10584 For information on internationalisation support see &<<SECTi18nMTA>>&.
10585 .endlist
10586
10587
10588
10589
10590
10591
10592 .section "Expansion conditions" "SECTexpcond"
10593 .scindex IIDexpcond "expansion" "conditions"
10594 The following conditions are available for testing by the &%${if%& construct
10595 while expanding strings:
10596
10597 .vlist
10598 .vitem &*!*&<&'condition'&>
10599 .cindex "expansion" "negating a condition"
10600 .cindex "negation" "in expansion condition"
10601 Preceding any condition with an exclamation mark negates the result of the
10602 condition.
10603
10604 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10605 .cindex "numeric comparison"
10606 .cindex "expansion" "numeric comparison"
10607 There are a number of symbolic operators for doing numeric comparisons. They
10608 are:
10609 .display
10610 &`=   `&   equal
10611 &`==  `&   equal
10612 &`>   `&   greater
10613 &`>=  `&   greater or equal
10614 &`<   `&   less
10615 &`<=  `&   less or equal
10616 .endd
10617 For example:
10618 .code
10619 ${if >{$message_size}{10M} ...
10620 .endd
10621 Note that the general negation operator provides for inequality testing. The
10622 two strings must take the form of optionally signed decimal integers,
10623 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10624 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10625 As a special case, the numerical value of an empty string is taken as
10626 zero.
10627
10628 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10629 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10630 10M, not if 10M is larger than &$message_size$&.
10631
10632
10633 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10634         {*&<&'arg2'&>&*}...}*&
10635 .cindex "expansion" "calling an acl"
10636 .cindex "&%acl%&" "expansion condition"
10637 The name and zero to nine argument strings are first expanded separately.  The expanded
10638 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10639 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10640 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10641 and may use the variables; if another acl expansion is used the values
10642 are restored after it returns.  If the ACL sets
10643 a value using a "message =" modifier the variable $value becomes
10644 the result of the expansion, otherwise it is empty.
10645 If the ACL returns accept the condition is true; if deny, false.
10646 If the ACL returns defer the result is a forced-fail.
10647
10648 .vitem &*bool&~{*&<&'string'&>&*}*&
10649 .cindex "expansion" "boolean parsing"
10650 .cindex "&%bool%& expansion condition"
10651 This condition turns a string holding a true or false representation into
10652 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10653 (case-insensitively); also integer numbers map to true if non-zero,
10654 false if zero.
10655 An empty string is treated as false.
10656 Leading and trailing whitespace is ignored;
10657 thus a string consisting only of whitespace is false.
10658 All other string values will result in expansion failure.
10659
10660 When combined with ACL variables, this expansion condition will let you
10661 make decisions in one place and act on those decisions in another place.
10662 For example:
10663 .code
10664 ${if bool{$acl_m_privileged_sender} ...
10665 .endd
10666
10667
10668 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10669 .cindex "expansion" "boolean parsing"
10670 .cindex "&%bool_lax%& expansion condition"
10671 Like &%bool%&, this condition turns a string into a boolean state.  But
10672 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10673 loose definition that the Router &%condition%& option uses.  The empty string
10674 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10675 true.  Leading and trailing whitespace is ignored.
10676
10677 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10678
10679 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10680 .cindex "expansion" "encrypted comparison"
10681 .cindex "encrypted strings, comparing"
10682 .cindex "&%crypteq%& expansion condition"
10683 This condition is included in the Exim binary if it is built to support any
10684 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10685 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10686 included in the binary.
10687
10688 The &%crypteq%& condition has two arguments. The first is encrypted and
10689 compared against the second, which is already encrypted. The second string may
10690 be in the LDAP form for storing encrypted strings, which starts with the
10691 encryption type in curly brackets, followed by the data. If the second string
10692 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10693 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10694 Typically this will be a field from a password file. An example of an encrypted
10695 string in LDAP form is:
10696 .code
10697 {md5}CY9rzUYh03PK3k6DJie09g==
10698 .endd
10699 If such a string appears directly in an expansion, the curly brackets have to
10700 be quoted, because they are part of the expansion syntax. For example:
10701 .code
10702 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10703 .endd
10704 The following encryption types (whose names are matched case-independently) are
10705 supported:
10706
10707 .ilist
10708 .cindex "MD5 hash"
10709 .cindex "base64 encoding" "in encrypted password"
10710 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10711 printable characters to compare with the remainder of the second string. If the
10712 length of the comparison string is 24, Exim assumes that it is base64 encoded
10713 (as in the above example). If the length is 32, Exim assumes that it is a
10714 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10715 comparison fails.
10716
10717 .next
10718 .cindex "SHA-1 hash"
10719 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10720 printable characters to compare with the remainder of the second string. If the
10721 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10722 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10723 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10724
10725 .next
10726 .cindex "&[crypt()]&"
10727 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10728 only the first eight characters of the password. However, in modern operating
10729 systems this is no longer true, and in many cases the entire password is used,
10730 whatever its length.
10731
10732 .next
10733 .cindex "&[crypt16()]&"
10734 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10735 use up to 16 characters of the password in some operating systems. Again, in
10736 modern operating systems, more characters may be used.
10737 .endlist
10738 Exim has its own version of &[crypt16()]&, which is just a double call to
10739 &[crypt()]&. For operating systems that have their own version, setting
10740 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10741 operating system version instead of its own. This option is set by default in
10742 the OS-dependent &_Makefile_& for those operating systems that are known to
10743 support &[crypt16()]&.
10744
10745 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10746 it was not using the same algorithm as some operating systems' versions. It
10747 turns out that as well as &[crypt16()]& there is a function called
10748 &[bigcrypt()]& in some operating systems. This may or may not use the same
10749 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10750
10751 However, since there is now a move away from the traditional &[crypt()]&
10752 functions towards using SHA1 and other algorithms, tidying up this area of
10753 Exim is seen as very low priority.
10754
10755 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10756 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10757 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10758 default is &`{crypt}`&. Whatever the default, you can always use either
10759 function by specifying it explicitly in curly brackets.
10760
10761 .vitem &*def:*&<&'variable&~name'&>
10762 .cindex "expansion" "checking for empty variable"
10763 .cindex "&%def%& expansion condition"
10764 The &%def%& condition must be followed by the name of one of the expansion
10765 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10766 variable does not contain the empty string. For example:
10767 .code
10768 ${if def:sender_ident {from $sender_ident}}
10769 .endd
10770 Note that the variable name is given without a leading &%$%& character. If the
10771 variable does not exist, the expansion fails.
10772
10773 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10774         &~&*def:h_*&<&'header&~name'&>&*:*&"
10775 .cindex "expansion" "checking header line existence"
10776 This condition is true if a message is being processed and the named header
10777 exists in the message. For example,
10778 .code
10779 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10780 .endd
10781 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10782 the header name must be terminated by a colon if white space does not follow.
10783
10784 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10785        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10786 .cindex "string" "comparison"
10787 .cindex "expansion" "string comparison"
10788 .cindex "&%eq%& expansion condition"
10789 .cindex "&%eqi%& expansion condition"
10790 The two substrings are first expanded. The condition is true if the two
10791 resulting strings are identical. For &%eq%& the comparison includes the case of
10792 letters, whereas for &%eqi%& the comparison is case-independent.
10793
10794 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10795 .cindex "expansion" "file existence test"
10796 .cindex "file" "existence test"
10797 .cindex "&%exists%&, expansion condition"
10798 The substring is first expanded and then interpreted as an absolute path. The
10799 condition is true if the named file (or directory) exists. The existence test
10800 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10801 users' filter files may be locked out by the system administrator.
10802
10803 .vitem &*first_delivery*&
10804 .cindex "delivery" "first"
10805 .cindex "first delivery"
10806 .cindex "expansion" "first delivery test"
10807 .cindex "&%first_delivery%& expansion condition"
10808 This condition, which has no data, is true during a message's first delivery
10809 attempt. It is false during any subsequent delivery attempts.
10810
10811
10812 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10813        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10814 .cindex "list" "iterative conditions"
10815 .cindex "expansion" "&*forall*& condition"
10816 .cindex "expansion" "&*forany*& condition"
10817 .vindex "&$item$&"
10818 These conditions iterate over a list. The first argument is expanded to form
10819 the list. By default, the list separator is a colon, but it can be changed by
10820 the normal method. The second argument is interpreted as a condition that is to
10821 be applied to each item in the list in turn. During the interpretation of the
10822 condition, the current list item is placed in a variable called &$item$&.
10823 .ilist
10824 For &*forany*&, interpretation stops if the condition is true for any item, and
10825 the result of the whole condition is true. If the condition is false for all
10826 items in the list, the overall condition is false.
10827 .next
10828 For &*forall*&, interpretation stops if the condition is false for any item,
10829 and the result of the whole condition is false. If the condition is true for
10830 all items in the list, the overall condition is true.
10831 .endlist
10832 Note that negation of &*forany*& means that the condition must be false for all
10833 items for the overall condition to succeed, and negation of &*forall*& means
10834 that the condition must be false for at least one item. In this example, the
10835 list separator is changed to a comma:
10836 .code
10837 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10838 .endd
10839 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10840 being processed, to enable these expansion items to be nested.
10841
10842 To scan a named list, expand it with the &*listnamed*& operator.
10843
10844
10845 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10846        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10847 .cindex "string" "comparison"
10848 .cindex "expansion" "string comparison"
10849 .cindex "&%ge%& expansion condition"
10850 .cindex "&%gei%& expansion condition"
10851 The two substrings are first expanded. The condition is true if the first
10852 string is lexically greater than or equal to the second string. For &%ge%& the
10853 comparison includes the case of letters, whereas for &%gei%& the comparison is
10854 case-independent.
10855
10856 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10857        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10858 .cindex "string" "comparison"
10859 .cindex "expansion" "string comparison"
10860 .cindex "&%gt%& expansion condition"
10861 .cindex "&%gti%& expansion condition"
10862 The two substrings are first expanded. The condition is true if the first
10863 string is lexically greater than the second string. For &%gt%& the comparison
10864 includes the case of letters, whereas for &%gti%& the comparison is
10865 case-independent.
10866
10867 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10868        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10869 .cindex "string" "comparison"
10870 .cindex "list" "iterative conditions"
10871 Both strings are expanded; the second string is treated as a list of simple
10872 strings; if the first string is a member of the second, then the condition
10873 is true.
10874
10875 These are simpler to use versions of the more powerful &*forany*& condition.
10876 Examples, and the &*forany*& equivalents:
10877 .code
10878 ${if inlist{needle}{foo:needle:bar}}
10879   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10880 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10881   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10882 .endd
10883
10884 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10885        &*isip4&~{*&<&'string'&>&*}*& &&&
10886        &*isip6&~{*&<&'string'&>&*}*&
10887 .cindex "IP address" "testing string format"
10888 .cindex "string" "testing for IP address"
10889 .cindex "&%isip%& expansion condition"
10890 .cindex "&%isip4%& expansion condition"
10891 .cindex "&%isip6%& expansion condition"
10892 The substring is first expanded, and then tested to see if it has the form of
10893 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10894 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10895
10896 For an IPv4 address, the test is for four dot-separated components, each of
10897 which consists of from one to three digits. For an IPv6 address, up to eight
10898 colon-separated components are permitted, each containing from one to four
10899 hexadecimal digits. There may be fewer than eight components if an empty
10900 component (adjacent colons) is present. Only one empty component is permitted.
10901
10902 &*Note*&: The checks are just on the form of the address; actual numerical
10903 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10904 check. The main use of these tests is to distinguish between IP addresses and
10905 host names, or between IPv4 and IPv6 addresses. For example, you could use
10906 .code
10907 ${if isip4{$sender_host_address}...
10908 .endd
10909 to test which IP version an incoming SMTP connection is using.
10910
10911 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10912 .cindex "LDAP" "use for authentication"
10913 .cindex "expansion" "LDAP authentication test"
10914 .cindex "&%ldapauth%& expansion condition"
10915 This condition supports user authentication using LDAP. See section
10916 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10917 queries. For this use, the query must contain a user name and password. The
10918 query itself is not used, and can be empty. The condition is true if the
10919 password is not empty, and the user name and password are accepted by the LDAP
10920 server. An empty password is rejected without calling LDAP because LDAP binds
10921 with an empty password are considered anonymous regardless of the username, and
10922 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10923 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10924 this can be used.
10925
10926
10927 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10928        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10929 .cindex "string" "comparison"
10930 .cindex "expansion" "string comparison"
10931 .cindex "&%le%& expansion condition"
10932 .cindex "&%lei%& expansion condition"
10933 The two substrings are first expanded. The condition is true if the first
10934 string is lexically less than or equal to the second string. For &%le%& the
10935 comparison includes the case of letters, whereas for &%lei%& the comparison is
10936 case-independent.
10937
10938 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10939        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10940 .cindex "string" "comparison"
10941 .cindex "expansion" "string comparison"
10942 .cindex "&%lt%& expansion condition"
10943 .cindex "&%lti%& expansion condition"
10944 The two substrings are first expanded. The condition is true if the first
10945 string is lexically less than the second string. For &%lt%& the comparison
10946 includes the case of letters, whereas for &%lti%& the comparison is
10947 case-independent.
10948
10949
10950 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10951 .cindex "expansion" "regular expression comparison"
10952 .cindex "regular expressions" "match in expanded string"
10953 .cindex "&%match%& expansion condition"
10954 The two substrings are first expanded. The second is then treated as a regular
10955 expression and applied to the first. Because of the pre-expansion, if the
10956 regular expression contains dollar, or backslash characters, they must be
10957 escaped. Care must also be taken if the regular expression contains braces
10958 (curly brackets). A closing brace must be escaped so that it is not taken as a
10959 premature termination of <&'string2'&>. The easiest approach is to use the
10960 &`\N`& feature to disable expansion of the regular expression.
10961 For example,
10962 .code
10963 ${if match {$local_part}{\N^\d{3}\N} ...
10964 .endd
10965 If the whole expansion string is in double quotes, further escaping of
10966 backslashes is also required.
10967
10968 The condition is true if the regular expression match succeeds.
10969 The regular expression is not required to begin with a circumflex
10970 metacharacter, but if there is no circumflex, the expression is not anchored,
10971 and it may match anywhere in the subject, not just at the start. If you want
10972 the pattern to match at the end of the subject, you must include the &`$`&
10973 metacharacter at an appropriate point.
10974
10975 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10976 At the start of an &%if%& expansion the values of the numeric variable
10977 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10978 succeeds causes them to be reset to the substrings of that condition and they
10979 will have these values during the expansion of the success string. At the end
10980 of the &%if%& expansion, the previous values are restored. After testing a
10981 combination of conditions using &%or%&, the subsequent values of the numeric
10982 variables are those of the condition that succeeded.
10983
10984 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10985 .cindex "&%match_address%& expansion condition"
10986 See &*match_local_part*&.
10987
10988 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10989 .cindex "&%match_domain%& expansion condition"
10990 See &*match_local_part*&.
10991
10992 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10993 .cindex "&%match_ip%& expansion condition"
10994 This condition matches an IP address to a list of IP address patterns. It must
10995 be followed by two argument strings. The first (after expansion) must be an IP
10996 address or an empty string. The second (not expanded) is a restricted host
10997 list that can match only an IP address, not a host name. For example:
10998 .code
10999 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11000 .endd
11001 The specific types of host list item that are permitted in the list are:
11002
11003 .ilist
11004 An IP address, optionally with a CIDR mask.
11005 .next
11006 A single asterisk, which matches any IP address.
11007 .next
11008 An empty item, which matches only if the IP address is empty. This could be
11009 useful for testing for a locally submitted message or one from specific hosts
11010 in a single test such as
11011 . ==== As this is a nested list, any displays it contains must be indented
11012 . ==== as otherwise they are too far to the left. This comment applies to
11013 . ==== the use of xmlto plus fop. There's no problem when formatting with
11014 . ==== sdop, with or without the extra indent.
11015 .code
11016   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11017 .endd
11018 where the first item in the list is the empty string.
11019 .next
11020 The item @[] matches any of the local host's interface addresses.
11021 .next
11022 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11023 even if &`net-`& is not specified. There is never any attempt to turn the IP
11024 address into a host name. The most common type of linear search for
11025 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11026 masks. For example:
11027 .code
11028   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11029 .endd
11030 It is of course possible to use other kinds of lookup, and in such a case, you
11031 do need to specify the &`net-`& prefix if you want to specify a specific
11032 address mask, for example:
11033 .code
11034   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11035 .endd
11036 However, unless you are combining a &%match_ip%& condition with others, it is
11037 just as easy to use the fact that a lookup is itself a condition, and write:
11038 .code
11039   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11040 .endd
11041 .endlist ilist
11042
11043 Note that <&'string2'&> is not itself subject to string expansion, unless
11044 Exim was built with the EXPAND_LISTMATCH_RHS option.
11045
11046 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11047
11048 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11049 .cindex "domain list" "in expansion condition"
11050 .cindex "address list" "in expansion condition"
11051 .cindex "local part" "list, in expansion condition"
11052 .cindex "&%match_local_part%& expansion condition"
11053 This condition, together with &%match_address%& and &%match_domain%&, make it
11054 possible to test domain, address, and local part lists within expansions. Each
11055 condition requires two arguments: an item and a list to match. A trivial
11056 example is:
11057 .code
11058 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11059 .endd
11060 In each case, the second argument may contain any of the allowable items for a
11061 list of the appropriate type. Also, because the second argument (after
11062 expansion) is a standard form of list, it is possible to refer to a named list.
11063 Thus, you can use conditions like this:
11064 .code
11065 ${if match_domain{$domain}{+local_domains}{...
11066 .endd
11067 .cindex "&`+caseful`&"
11068 For address lists, the matching starts off caselessly, but the &`+caseful`&
11069 item can be used, as in all address lists, to cause subsequent items to
11070 have their local parts matched casefully. Domains are always matched
11071 caselessly.
11072
11073 Note that <&'string2'&> is not itself subject to string expansion, unless
11074 Exim was built with the EXPAND_LISTMATCH_RHS option.
11075
11076 &*Note*&: Host lists are &'not'& supported in this way. This is because
11077 hosts have two identities: a name and an IP address, and it is not clear
11078 how to specify cleanly how such a test would work. However, IP addresses can be
11079 matched using &%match_ip%&.
11080
11081 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11082 .cindex "PAM authentication"
11083 .cindex "AUTH" "with PAM"
11084 .cindex "Solaris" "PAM support"
11085 .cindex "expansion" "PAM authentication test"
11086 .cindex "&%pam%& expansion condition"
11087 &'Pluggable Authentication Modules'&
11088 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11089 available in the latest releases of Solaris and in some GNU/Linux
11090 distributions. The Exim support, which is intended for use in conjunction with
11091 the SMTP AUTH command, is available only if Exim is compiled with
11092 .code
11093 SUPPORT_PAM=yes
11094 .endd
11095 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11096 in some releases of GNU/Linux &%-ldl%& is also needed.
11097
11098 The argument string is first expanded, and the result must be a
11099 colon-separated list of strings. Leading and trailing white space is ignored.
11100 The PAM module is initialized with the service name &"exim"& and the user name
11101 taken from the first item in the colon-separated data string (<&'string1'&>).
11102 The remaining items in the data string are passed over in response to requests
11103 from the authentication function. In the simple case there will only be one
11104 request, for a password, so the data consists of just two strings.
11105
11106 There can be problems if any of the strings are permitted to contain colon
11107 characters. In the usual way, these have to be doubled to avoid being taken as
11108 separators. If the data is being inserted from a variable, the &%sg%& expansion
11109 item can be used to double any existing colons. For example, the configuration
11110 of a LOGIN authenticator might contain this setting:
11111 .code
11112 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11113 .endd
11114 For a PLAIN authenticator you could use:
11115 .code
11116 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11117 .endd
11118 In some operating systems, PAM authentication can be done only from a process
11119 running as root. Since Exim is running as the Exim user when receiving
11120 messages, this means that PAM cannot be used directly in those systems.
11121 A patched version of the &'pam_unix'& module that comes with the
11122 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11123 The patched module allows one special uid/gid combination, in addition to root,
11124 to authenticate. If you build the patched module to allow the Exim user and
11125 group, PAM can then be used from an Exim authenticator.
11126
11127
11128 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11129 .cindex "&'pwcheck'& daemon"
11130 .cindex "Cyrus"
11131 .cindex "expansion" "&'pwcheck'& authentication test"
11132 .cindex "&%pwcheck%& expansion condition"
11133 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11134 This is one way of making it possible for passwords to be checked by a process
11135 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11136 deprecated. Its replacement is &'saslauthd'& (see below).
11137
11138 The pwcheck support is not included in Exim by default. You need to specify
11139 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11140 building Exim. For example:
11141 .code
11142 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11143 .endd
11144 You do not need to install the full Cyrus software suite in order to use
11145 the pwcheck daemon. You can compile and install just the daemon alone
11146 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11147 access to the &_/var/pwcheck_& directory.
11148
11149 The &%pwcheck%& condition takes one argument, which must be the user name and
11150 password, separated by a colon. For example, in a LOGIN authenticator
11151 configuration, you might have this:
11152 .code
11153 server_condition = ${if pwcheck{$auth1:$auth2}}
11154 .endd
11155 Again, for a PLAIN authenticator configuration, this would be:
11156 .code
11157 server_condition = ${if pwcheck{$auth2:$auth3}}
11158 .endd
11159 .vitem &*queue_running*&
11160 .cindex "queue runner" "detecting when delivering from"
11161 .cindex "expansion" "queue runner test"
11162 .cindex "&%queue_running%& expansion condition"
11163 This condition, which has no data, is true during delivery attempts that are
11164 initiated by queue runner processes, and false otherwise.
11165
11166
11167 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11168 .cindex "Radius"
11169 .cindex "expansion" "Radius authentication"
11170 .cindex "&%radius%& expansion condition"
11171 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11172 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11173 the Radius client configuration file in order to build Exim with Radius
11174 support.
11175
11176 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11177 library, using the original API. If you are using release 0.4.0 or later of
11178 this library, you need to set
11179 .code
11180 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11181 .endd
11182 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11183 &%libradius%& library that comes with FreeBSD. To do this, set
11184 .code
11185 RADIUS_LIB_TYPE=RADLIB
11186 .endd
11187 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11188 You may also have to supply a suitable setting in EXTRALIBS so that the
11189 Radius library can be found when Exim is linked.
11190
11191 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11192 Radius client library, which calls the Radius server. The condition is true if
11193 the authentication is successful. For example:
11194 .code
11195 server_condition = ${if radius{<arguments>}}
11196 .endd
11197
11198
11199 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11200         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11201 .cindex "&'saslauthd'& daemon"
11202 .cindex "Cyrus"
11203 .cindex "expansion" "&'saslauthd'& authentication test"
11204 .cindex "&%saslauthd%& expansion condition"
11205 This condition supports user authentication using the Cyrus &'saslauthd'&
11206 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11207 Using this daemon is one way of making it possible for passwords to be checked
11208 by a process that is not running as root.
11209
11210 The saslauthd support is not included in Exim by default. You need to specify
11211 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11212 building Exim. For example:
11213 .code
11214 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11215 .endd
11216 You do not need to install the full Cyrus software suite in order to use
11217 the saslauthd daemon. You can compile and install just the daemon alone
11218 from the Cyrus SASL library.
11219
11220 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11221 two are mandatory. For example:
11222 .code
11223 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11224 .endd
11225 The service and the realm are optional (which is why the arguments are enclosed
11226 in their own set of braces). For details of the meaning of the service and
11227 realm, and how to run the daemon, consult the Cyrus documentation.
11228 .endlist vlist
11229
11230
11231
11232 .section "Combining expansion conditions" "SECID84"
11233 .cindex "expansion" "combining conditions"
11234 Several conditions can be tested at once by combining them using the &%and%&
11235 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11236 conditions on their own, and precede their lists of sub-conditions. Each
11237 sub-condition must be enclosed in braces within the overall braces that contain
11238 the list. No repetition of &%if%& is used.
11239
11240
11241 .vlist
11242 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11243 .cindex "&""or""& expansion condition"
11244 .cindex "expansion" "&""or""& of conditions"
11245 The sub-conditions are evaluated from left to right. The condition is true if
11246 any one of the sub-conditions is true.
11247 For example,
11248 .code
11249 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11250 .endd
11251 When a true sub-condition is found, the following ones are parsed but not
11252 evaluated. If there are several &"match"& sub-conditions the values of the
11253 numeric variables afterwards are taken from the first one that succeeds.
11254
11255 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11256 .cindex "&""and""& expansion condition"
11257 .cindex "expansion" "&""and""& of conditions"
11258 The sub-conditions are evaluated from left to right. The condition is true if
11259 all of the sub-conditions are true. If there are several &"match"&
11260 sub-conditions, the values of the numeric variables afterwards are taken from
11261 the last one. When a false sub-condition is found, the following ones are
11262 parsed but not evaluated.
11263 .endlist
11264 .ecindex IIDexpcond
11265
11266
11267
11268
11269 .section "Expansion variables" "SECTexpvar"
11270 .cindex "expansion" "variables, list of"
11271 This section contains an alphabetical list of all the expansion variables. Some
11272 of them are available only when Exim is compiled with specific options such as
11273 support for TLS or the content scanning extension.
11274
11275 .vlist
11276 .vitem "&$0$&, &$1$&, etc"
11277 .cindex "numerical variables (&$1$& &$2$& etc)"
11278 When a &%match%& expansion condition succeeds, these variables contain the
11279 captured substrings identified by the regular expression during subsequent
11280 processing of the success string of the containing &%if%& expansion item.
11281 In the expansion condition case
11282 they do not retain their values afterwards; in fact, their previous
11283 values are restored at the end of processing an &%if%& item. The numerical
11284 variables may also be set externally by some other matching process which
11285 precedes the expansion of the string. For example, the commands available in
11286 Exim filter files include an &%if%& command with its own regular expression
11287 matching condition.
11288
11289 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11290 Within an acl condition, expansion condition or expansion item
11291 any arguments are copied to these variables,
11292 any unused variables being made empty.
11293
11294 .vitem "&$acl_c...$&"
11295 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11296 can be given any name that starts with &$acl_c$& and is at least six characters
11297 long, but the sixth character must be either a digit or an underscore. For
11298 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11299 variables persist throughout the lifetime of an SMTP connection. They can be
11300 used to pass information between ACLs and between different invocations of the
11301 same ACL. When a message is received, the values of these variables are saved
11302 with the message, and can be accessed by filters, routers, and transports
11303 during subsequent delivery.
11304
11305 .vitem "&$acl_m...$&"
11306 These variables are like the &$acl_c...$& variables, except that their values
11307 are reset after a message has been received. Thus, if several messages are
11308 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11309 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11310 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11311 message is received, the values of these variables are saved with the message,
11312 and can be accessed by filters, routers, and transports during subsequent
11313 delivery.
11314
11315 .vitem &$acl_narg$&
11316 Within an acl condition, expansion condition or expansion item
11317 this variable has the number of arguments.
11318
11319 .vitem &$acl_verify_message$&
11320 .vindex "&$acl_verify_message$&"
11321 After an address verification has failed, this variable contains the failure
11322 message. It retains its value for use in subsequent modifiers. The message can
11323 be preserved by coding like this:
11324 .code
11325 warn !verify = sender
11326      set acl_m0 = $acl_verify_message
11327 .endd
11328 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11329 &%log_message%& modifiers, to include information about the verification
11330 failure.
11331
11332 .vitem &$address_data$&
11333 .vindex "&$address_data$&"
11334 This variable is set by means of the &%address_data%& option in routers. The
11335 value then remains with the address while it is processed by subsequent routers
11336 and eventually a transport. If the transport is handling multiple addresses,
11337 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11338 for more details. &*Note*&: The contents of &$address_data$& are visible in
11339 user filter files.
11340
11341 If &$address_data$& is set when the routers are called from an ACL to verify
11342 a recipient address, the final value is still in the variable for subsequent
11343 conditions and modifiers of the ACL statement. If routing the address caused it
11344 to be redirected to just one address, the child address is also routed as part
11345 of the verification, and in this case the final value of &$address_data$& is
11346 from the child's routing.
11347
11348 If &$address_data$& is set when the routers are called from an ACL to verify a
11349 sender address, the final value is also preserved, but this time in
11350 &$sender_address_data$&, to distinguish it from data from a recipient
11351 address.
11352
11353 In both cases (recipient and sender verification), the value does not persist
11354 after the end of the current ACL statement. If you want to preserve
11355 these values for longer, you can save them in ACL variables.
11356
11357 .vitem &$address_file$&
11358 .vindex "&$address_file$&"
11359 When, as a result of aliasing, forwarding, or filtering, a message is directed
11360 to a specific file, this variable holds the name of the file when the transport
11361 is running. At other times, the variable is empty. For example, using the
11362 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11363 .code
11364 /home/r2d2/savemail
11365 .endd
11366 then when the &(address_file)& transport is running, &$address_file$&
11367 contains the text string &`/home/r2d2/savemail`&.
11368 .cindex "Sieve filter" "value of &$address_file$&"
11369 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11370 then up to the transport configuration to generate an appropriate absolute path
11371 to the relevant file.
11372
11373 .vitem &$address_pipe$&
11374 .vindex "&$address_pipe$&"
11375 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11376 this variable holds the pipe command when the transport is running.
11377
11378 .vitem "&$auth1$& &-- &$auth3$&"
11379 .vindex "&$auth1$&, &$auth2$&, etc"
11380 These variables are used in SMTP authenticators (see chapters
11381 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11382
11383 .vitem &$authenticated_id$&
11384 .cindex "authentication" "id"
11385 .vindex "&$authenticated_id$&"
11386 When a server successfully authenticates a client it may be configured to
11387 preserve some of the authentication information in the variable
11388 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11389 user/password authenticator configuration might preserve the user name for use
11390 in the routers. Note that this is not the same information that is saved in
11391 &$sender_host_authenticated$&.
11392 When a message is submitted locally (that is, not over a TCP connection)
11393 the value of &$authenticated_id$& is normally the login name of the calling
11394 process. However, a trusted user can override this by means of the &%-oMai%&
11395 command line option.
11396
11397 .vitem &$authenticated_fail_id$&
11398 .cindex "authentication" "fail" "id"
11399 .vindex "&$authenticated_fail_id$&"
11400 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11401 will contain the failed authentication id. If more than one authentication
11402 id is attempted, it will contain only the last one. The variable is
11403 available for processing in the ACL's, generally the quit or notquit ACL.
11404 A message to a local recipient could still be accepted without requiring
11405 authentication, which means this variable could also be visible in all of
11406 the ACL's as well.
11407
11408
11409 .vitem &$authenticated_sender$&
11410 .cindex "sender" "authenticated"
11411 .cindex "authentication" "sender"
11412 .cindex "AUTH" "on MAIL command"
11413 .vindex "&$authenticated_sender$&"
11414 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11415 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11416 described in section &<<SECTauthparamail>>&. Unless the data is the string
11417 &"<>"&, it is set as the authenticated sender of the message, and the value is
11418 available during delivery in the &$authenticated_sender$& variable. If the
11419 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11420
11421 .vindex "&$qualify_domain$&"
11422 When a message is submitted locally (that is, not over a TCP connection), the
11423 value of &$authenticated_sender$& is an address constructed from the login
11424 name of the calling process and &$qualify_domain$&, except that a trusted user
11425 can override this by means of the &%-oMas%& command line option.
11426
11427
11428 .vitem &$authentication_failed$&
11429 .cindex "authentication" "failure"
11430 .vindex "&$authentication_failed$&"
11431 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11432 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11433 possible to distinguish between &"did not try to authenticate"&
11434 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11435 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11436 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11437 negative response to an AUTH command, including (for example) an attempt to use
11438 an undefined mechanism.
11439
11440 .vitem &$av_failed$&
11441 .cindex "content scanning" "AV scanner failure"
11442 This variable is available when Exim is compiled with the content-scanning
11443 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11444 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11445 the ACL malware condition.
11446
11447 .vitem &$body_linecount$&
11448 .cindex "message body" "line count"
11449 .cindex "body of message" "line count"
11450 .vindex "&$body_linecount$&"
11451 When a message is being received or delivered, this variable contains the
11452 number of lines in the message's body. See also &$message_linecount$&.
11453
11454 .vitem &$body_zerocount$&
11455 .cindex "message body" "binary zero count"
11456 .cindex "body of message" "binary zero count"
11457 .cindex "binary zero" "in message body"
11458 .vindex "&$body_zerocount$&"
11459 When a message is being received or delivered, this variable contains the
11460 number of binary zero bytes (ASCII NULs) in the message's body.
11461
11462 .vitem &$bounce_recipient$&
11463 .vindex "&$bounce_recipient$&"
11464 This is set to the recipient address of a bounce message while Exim is creating
11465 it. It is useful if a customized bounce message text file is in use (see
11466 chapter &<<CHAPemsgcust>>&).
11467
11468 .vitem &$bounce_return_size_limit$&
11469 .vindex "&$bounce_return_size_limit$&"
11470 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11471 up to a multiple of 1000. It is useful when a customized error message text
11472 file is in use (see chapter &<<CHAPemsgcust>>&).
11473
11474 .vitem &$caller_gid$&
11475 .cindex "gid (group id)" "caller"
11476 .vindex "&$caller_gid$&"
11477 The real group id under which the process that called Exim was running. This is
11478 not the same as the group id of the originator of a message (see
11479 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11480 incarnation normally contains the Exim gid.
11481
11482 .vitem &$caller_uid$&
11483 .cindex "uid (user id)" "caller"
11484 .vindex "&$caller_uid$&"
11485 The real user id under which the process that called Exim was running. This is
11486 not the same as the user id of the originator of a message (see
11487 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11488 incarnation normally contains the Exim uid.
11489
11490 .vitem &$callout_address$&
11491 .vindex "&$callout_address$&"
11492 After a callout for verification, spamd or malware daemon service, the
11493 address that was connected to.
11494
11495 .vitem &$compile_number$&
11496 .vindex "&$compile_number$&"
11497 The building process for Exim keeps a count of the number
11498 of times it has been compiled. This serves to distinguish different
11499 compilations of the same version of the program.
11500
11501 .vitem &$config_dir$&
11502 .vindex "&$config_dir$&"
11503 The directory name of the main configuration file. That is, the content of
11504 &$config_file$& with the last component stripped. The value does not
11505 contain the trailing slash. If &$config_file$& does not contain a slash,
11506 &$config_dir$& is ".".
11507
11508 .vitem &$config_file$&
11509 .vindex "&$config_file$&"
11510 The name of the main configuration file Exim is using.
11511
11512 .vitem &$dkim_cur_signer$& &&&
11513        &$dkim_verify_status$& &&&
11514        &$dkim_verify_reason$& &&&
11515        &$dkim_domain$& &&&
11516        &$dkim_identity$& &&&
11517        &$dkim_selector$& &&&
11518        &$dkim_algo$& &&&
11519        &$dkim_canon_body$& &&&
11520        &$dkim_canon_headers$& &&&
11521        &$dkim_copiedheaders$& &&&
11522        &$dkim_bodylength$& &&&
11523        &$dkim_created$& &&&
11524        &$dkim_expires$& &&&
11525        &$dkim_headernames$& &&&
11526        &$dkim_key_testing$& &&&
11527        &$dkim_key_nosubdomains$& &&&
11528        &$dkim_key_srvtype$& &&&
11529        &$dkim_key_granularity$& &&&
11530        &$dkim_key_notes$& &&&
11531        &$dkim_key_length$&
11532 These variables are only available within the DKIM ACL.
11533 For details see chapter &<<CHAPdkim>>&.
11534
11535 .vitem &$dkim_signers$&
11536 .vindex &$dkim_signers$&
11537 When a message has been received this variable contains
11538 a colon-separated list of signer domains and identities for the message.
11539 For details see chapter &<<CHAPdkim>>&.
11540
11541 .vitem &$dnslist_domain$& &&&
11542        &$dnslist_matched$& &&&
11543        &$dnslist_text$& &&&
11544        &$dnslist_value$&
11545 .vindex "&$dnslist_domain$&"
11546 .vindex "&$dnslist_matched$&"
11547 .vindex "&$dnslist_text$&"
11548 .vindex "&$dnslist_value$&"
11549 .cindex "black list (DNS)"
11550 When a DNS (black) list lookup succeeds, these variables are set to contain
11551 the following data from the lookup: the list's domain name, the key that was
11552 looked up, the contents of any associated TXT record, and the value from the
11553 main A record. See section &<<SECID204>>& for more details.
11554
11555 .vitem &$domain$&
11556 .vindex "&$domain$&"
11557 When an address is being routed, or delivered on its own, this variable
11558 contains the domain. Uppercase letters in the domain are converted into lower
11559 case for &$domain$&.
11560
11561 Global address rewriting happens when a message is received, so the value of
11562 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11563 is set during user filtering, but not during system filtering, because a
11564 message may have many recipients and the system filter is called just once.
11565
11566 When more than one address is being delivered at once (for example, several
11567 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11568 have the same domain. Transports can be restricted to handling only one domain
11569 at a time if the value of &$domain$& is required at transport time &-- this is
11570 the default for local transports. For further details of the environment in
11571 which local transports are run, see chapter &<<CHAPenvironment>>&.
11572
11573 .oindex "&%delay_warning_condition%&"
11574 At the end of a delivery, if all deferred addresses have the same domain, it is
11575 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11576
11577 The &$domain$& variable is also used in some other circumstances:
11578
11579 .ilist
11580 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11581 the recipient address. The domain of the &'sender'& address is in
11582 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11583 normally set during the running of the MAIL ACL. However, if the sender address
11584 is verified with a callout during the MAIL ACL, the sender domain is placed in
11585 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11586 the &(smtp)& transport.
11587
11588 .next
11589 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11590 &$domain$& contains the domain portion of the address that is being rewritten;
11591 it can be used in the expansion of the replacement address, for example, to
11592 rewrite domains by file lookup.
11593
11594 .next
11595 With one important exception, whenever a domain list is being scanned,
11596 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11597 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11598 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11599 that, in a RCPT ACL, the sender domain list can be dependent on the
11600 recipient domain (which is what is in &$domain$& at this time).
11601
11602 .next
11603 .cindex "ETRN" "value of &$domain$&"
11604 .oindex "&%smtp_etrn_command%&"
11605 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11606 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11607 .endlist
11608
11609
11610 .vitem &$domain_data$&
11611 .vindex "&$domain_data$&"
11612 When the &%domains%& option on a router matches a domain by
11613 means of a lookup, the data read by the lookup is available during the running
11614 of the router as &$domain_data$&. In addition, if the driver routes the
11615 address to a transport, the value is available in that transport. If the
11616 transport is handling multiple addresses, the value from the first address is
11617 used.
11618
11619 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11620 domain by means of a lookup. The data read by the lookup is available during
11621 the rest of the ACL statement. In all other situations, this variable expands
11622 to nothing.
11623
11624 .vitem &$exim_gid$&
11625 .vindex "&$exim_gid$&"
11626 This variable contains the numerical value of the Exim group id.
11627
11628 .vitem &$exim_path$&
11629 .vindex "&$exim_path$&"
11630 This variable contains the path to the Exim binary.
11631
11632 .vitem &$exim_uid$&
11633 .vindex "&$exim_uid$&"
11634 This variable contains the numerical value of the Exim user id.
11635
11636 .vitem &$exim_version$&
11637 .vindex "&$exim_version$&"
11638 This variable contains the version string of the Exim build.
11639 The first character is a major version number, currently 4.
11640 Then after a dot, the next group of digits is a minor version number.
11641 There may be other characters following the minor version.
11642
11643 .vitem &$header_$&<&'name'&>
11644 This is not strictly an expansion variable. It is expansion syntax for
11645 inserting the message header line with the given name. Note that the name must
11646 be terminated by colon or white space, because it may contain a wide variety of
11647 characters. Note also that braces must &'not'& be used.
11648
11649 .vitem &$headers_added$&
11650 .vindex "&$headers_added$&"
11651 Within an ACL this variable contains the headers added so far by
11652 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11653 The headers are a newline-separated list.
11654
11655 .vitem &$home$&
11656 .vindex "&$home$&"
11657 When the &%check_local_user%& option is set for a router, the user's home
11658 directory is placed in &$home$& when the check succeeds. In particular, this
11659 means it is set during the running of users' filter files. A router may also
11660 explicitly set a home directory for use by a transport; this can be overridden
11661 by a setting on the transport itself.
11662
11663 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11664 of the environment variable HOME, which is subject to the
11665 &%keep_environment%& and &%add_environment%& main config options.
11666
11667 .vitem &$host$&
11668 .vindex "&$host$&"
11669 If a router assigns an address to a transport (any transport), and passes a
11670 list of hosts with the address, the value of &$host$& when the transport starts
11671 to run is the name of the first host on the list. Note that this applies both
11672 to local and remote transports.
11673
11674 .cindex "transport" "filter"
11675 .cindex "filter" "transport filter"
11676 For the &(smtp)& transport, if there is more than one host, the value of
11677 &$host$& changes as the transport works its way through the list. In
11678 particular, when the &(smtp)& transport is expanding its options for encryption
11679 using TLS, or for specifying a transport filter (see chapter
11680 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11681 is connected.
11682
11683 When used in the client part of an authenticator configuration (see chapter
11684 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11685 client is connected.
11686
11687
11688 .vitem &$host_address$&
11689 .vindex "&$host_address$&"
11690 This variable is set to the remote host's IP address whenever &$host$& is set
11691 for a remote connection. It is also set to the IP address that is being checked
11692 when the &%ignore_target_hosts%& option is being processed.
11693
11694 .vitem &$host_data$&
11695 .vindex "&$host_data$&"
11696 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11697 result of the lookup is made available in the &$host_data$& variable. This
11698 allows you, for example, to do things like this:
11699 .code
11700 deny  hosts = net-lsearch;/some/file
11701 message = $host_data
11702 .endd
11703 .vitem &$host_lookup_deferred$&
11704 .cindex "host name" "lookup, failure of"
11705 .vindex "&$host_lookup_deferred$&"
11706 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11707 message comes from a remote host and there is an attempt to look up the host's
11708 name from its IP address, and the attempt is not successful, one of these
11709 variables is set to &"1"&.
11710
11711 .ilist
11712 If the lookup receives a definite negative response (for example, a DNS lookup
11713 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11714
11715 .next
11716 If there is any kind of problem during the lookup, such that Exim cannot
11717 tell whether or not the host name is defined (for example, a timeout for a DNS
11718 lookup), &$host_lookup_deferred$& is set to &"1"&.
11719 .endlist ilist
11720
11721 Looking up a host's name from its IP address consists of more than just a
11722 single reverse lookup. Exim checks that a forward lookup of at least one of the
11723 names it receives from a reverse lookup yields the original IP address. If this
11724 is not the case, Exim does not accept the looked up name(s), and
11725 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11726 IP address (for example, the existence of a PTR record in the DNS) is not
11727 sufficient on its own for the success of a host name lookup. If the reverse
11728 lookup succeeds, but there is a lookup problem such as a timeout when checking
11729 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11730 &"1"&. See also &$sender_host_name$&.
11731
11732 .vitem &$host_lookup_failed$&
11733 .vindex "&$host_lookup_failed$&"
11734 See &$host_lookup_deferred$&.
11735
11736 .vitem &$host_port$&
11737 .vindex "&$host_port$&"
11738 This variable is set to the remote host's TCP port whenever &$host$& is set
11739 for an outbound connection.
11740
11741 .vitem &$initial_cwd$&
11742 .vindex "&$initial_cwd$&
11743 This variable contains the full path name of the initial working
11744 directory of the current Exim process. This may differ from the current
11745 working directory, as Exim changes this to "/" during early startup, and
11746 to &$spool_directory$& later.
11747
11748 .vitem &$inode$&
11749 .vindex "&$inode$&"
11750 The only time this variable is set is while expanding the &%directory_file%&
11751 option in the &(appendfile)& transport. The variable contains the inode number
11752 of the temporary file which is about to be renamed. It can be used to construct
11753 a unique name for the file.
11754
11755 .vitem &$interface_address$&
11756 .vindex "&$interface_address$&"
11757 This is an obsolete name for &$received_ip_address$&.
11758
11759 .vitem &$interface_port$&
11760 .vindex "&$interface_port$&"
11761 This is an obsolete name for &$received_port$&.
11762
11763 .vitem &$item$&
11764 .vindex "&$item$&"
11765 This variable is used during the expansion of &*forall*& and &*forany*&
11766 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11767 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11768 empty.
11769
11770 .vitem &$ldap_dn$&
11771 .vindex "&$ldap_dn$&"
11772 This variable, which is available only when Exim is compiled with LDAP support,
11773 contains the DN from the last entry in the most recently successful LDAP
11774 lookup.
11775
11776 .vitem &$load_average$&
11777 .vindex "&$load_average$&"
11778 This variable contains the system load average, multiplied by 1000 so that it
11779 is an integer. For example, if the load average is 0.21, the value of the
11780 variable is 210. The value is recomputed every time the variable is referenced.
11781
11782 .vitem &$local_part$&
11783 .vindex "&$local_part$&"
11784 When an address is being routed, or delivered on its own, this
11785 variable contains the local part. When a number of addresses are being
11786 delivered together (for example, multiple RCPT commands in an SMTP
11787 session), &$local_part$& is not set.
11788
11789 Global address rewriting happens when a message is received, so the value of
11790 &$local_part$& during routing and delivery is the value after rewriting.
11791 &$local_part$& is set during user filtering, but not during system filtering,
11792 because a message may have many recipients and the system filter is called just
11793 once.
11794
11795 .vindex "&$local_part_prefix$&"
11796 .vindex "&$local_part_suffix$&"
11797 If a local part prefix or suffix has been recognized, it is not included in the
11798 value of &$local_part$& during routing and subsequent delivery. The values of
11799 any prefix or suffix are in &$local_part_prefix$& and
11800 &$local_part_suffix$&, respectively.
11801
11802 When a message is being delivered to a file, pipe, or autoreply transport as a
11803 result of aliasing or forwarding, &$local_part$& is set to the local part of
11804 the parent address, not to the file name or command (see &$address_file$& and
11805 &$address_pipe$&).
11806
11807 When an ACL is running for a RCPT command, &$local_part$& contains the
11808 local part of the recipient address.
11809
11810 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11811 &$local_part$& contains the local part of the address that is being rewritten;
11812 it can be used in the expansion of the replacement address, for example.
11813
11814 In all cases, all quoting is removed from the local part. For example, for both
11815 the addresses
11816 .code
11817 "abc:xyz"@test.example
11818 abc\:xyz@test.example
11819 .endd
11820 the value of &$local_part$& is
11821 .code
11822 abc:xyz
11823 .endd
11824 If you use &$local_part$& to create another address, you should always wrap it
11825 inside a quoting operator. For example, in a &(redirect)& router you could
11826 have:
11827 .code
11828 data = ${quote_local_part:$local_part}@new.domain.example
11829 .endd
11830 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11831 to process local parts in a case-dependent manner in a router, you can set the
11832 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11833
11834 .vitem &$local_part_data$&
11835 .vindex "&$local_part_data$&"
11836 When the &%local_parts%& option on a router matches a local part by means of a
11837 lookup, the data read by the lookup is available during the running of the
11838 router as &$local_part_data$&. In addition, if the driver routes the address
11839 to a transport, the value is available in that transport. If the transport is
11840 handling multiple addresses, the value from the first address is used.
11841
11842 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11843 matches a local part by means of a lookup. The data read by the lookup is
11844 available during the rest of the ACL statement. In all other situations, this
11845 variable expands to nothing.
11846
11847 .vitem &$local_part_prefix$&
11848 .vindex "&$local_part_prefix$&"
11849 When an address is being routed or delivered, and a
11850 specific prefix for the local part was recognized, it is available in this
11851 variable, having been removed from &$local_part$&.
11852
11853 .vitem &$local_part_suffix$&
11854 .vindex "&$local_part_suffix$&"
11855 When an address is being routed or delivered, and a
11856 specific suffix for the local part was recognized, it is available in this
11857 variable, having been removed from &$local_part$&.
11858
11859 .vitem &$local_scan_data$&
11860 .vindex "&$local_scan_data$&"
11861 This variable contains the text returned by the &[local_scan()]& function when
11862 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11863
11864 .vitem &$local_user_gid$&
11865 .vindex "&$local_user_gid$&"
11866 See &$local_user_uid$&.
11867
11868 .vitem &$local_user_uid$&
11869 .vindex "&$local_user_uid$&"
11870 This variable and &$local_user_gid$& are set to the uid and gid after the
11871 &%check_local_user%& router precondition succeeds. This means that their values
11872 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11873 and &%condition%&), for the &%address_data%& expansion, and for any
11874 router-specific expansions. At all other times, the values in these variables
11875 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11876
11877 .vitem &$localhost_number$&
11878 .vindex "&$localhost_number$&"
11879 This contains the expanded value of the
11880 &%localhost_number%& option. The expansion happens after the main options have
11881 been read.
11882
11883 .vitem &$log_inodes$&
11884 .vindex "&$log_inodes$&"
11885 The number of free inodes in the disk partition where Exim's
11886 log files are being written. The value is recalculated whenever the variable is
11887 referenced. If the relevant file system does not have the concept of inodes,
11888 the value of is -1. See also the &%check_log_inodes%& option.
11889
11890 .vitem &$log_space$&
11891 .vindex "&$log_space$&"
11892 The amount of free space (as a number of kilobytes) in the disk
11893 partition where Exim's log files are being written. The value is recalculated
11894 whenever the variable is referenced. If the operating system does not have the
11895 ability to find the amount of free space (only true for experimental systems),
11896 the space value is -1. See also the &%check_log_space%& option.
11897
11898
11899 .vitem &$lookup_dnssec_authenticated$&
11900 .vindex "&$lookup_dnssec_authenticated$&"
11901 This variable is set after a DNS lookup done by
11902 a dnsdb lookup expansion, dnslookup router or smtp transport.
11903 .cindex "DNS" "DNSSEC"
11904 It will be empty if &(DNSSEC)& was not requested,
11905 &"no"& if the result was not labelled as authenticated data
11906 and &"yes"& if it was.
11907 Results that are labelled as authoritative answer that match
11908 the &%dns_trust_aa%& configuration variable count also
11909 as authenticated data.
11910
11911 .vitem &$mailstore_basename$&
11912 .vindex "&$mailstore_basename$&"
11913 This variable is set only when doing deliveries in &"mailstore"& format in the
11914 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11915 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11916 contains the basename of the files that are being written, that is, the name
11917 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11918 variable is empty.
11919
11920 .vitem &$malware_name$&
11921 .vindex "&$malware_name$&"
11922 This variable is available when Exim is compiled with the
11923 content-scanning extension. It is set to the name of the virus that was found
11924 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11925
11926 .vitem &$max_received_linelength$&
11927 .vindex "&$max_received_linelength$&"
11928 .cindex "maximum" "line length"
11929 .cindex "line length" "maximum"
11930 This variable contains the number of bytes in the longest line that was
11931 received as part of the message, not counting the line termination
11932 character(s).
11933
11934 .vitem &$message_age$&
11935 .cindex "message" "age of"
11936 .vindex "&$message_age$&"
11937 This variable is set at the start of a delivery attempt to contain the number
11938 of seconds since the message was received. It does not change during a single
11939 delivery attempt.
11940
11941 .vitem &$message_body$&
11942 .cindex "body of message" "expansion variable"
11943 .cindex "message body" "in expansion"
11944 .cindex "binary zero" "in message body"
11945 .vindex "&$message_body$&"
11946 .oindex "&%message_body_visible%&"
11947 This variable contains the initial portion of a message's body while it is
11948 being delivered, and is intended mainly for use in filter files. The maximum
11949 number of characters of the body that are put into the variable is set by the
11950 &%message_body_visible%& configuration option; the default is 500.
11951
11952 .oindex "&%message_body_newlines%&"
11953 By default, newlines are converted into spaces in &$message_body$&, to make it
11954 easier to search for phrases that might be split over a line break. However,
11955 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11956 zeros are always converted into spaces.
11957
11958 .vitem &$message_body_end$&
11959 .cindex "body of message" "expansion variable"
11960 .cindex "message body" "in expansion"
11961 .vindex "&$message_body_end$&"
11962 This variable contains the final portion of a message's
11963 body while it is being delivered. The format and maximum size are as for
11964 &$message_body$&.
11965
11966 .vitem &$message_body_size$&
11967 .cindex "body of message" "size"
11968 .cindex "message body" "size"
11969 .vindex "&$message_body_size$&"
11970 When a message is being delivered, this variable contains the size of the body
11971 in bytes. The count starts from the character after the blank line that
11972 separates the body from the header. Newlines are included in the count. See
11973 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11974
11975 .vitem &$message_exim_id$&
11976 .vindex "&$message_exim_id$&"
11977 When a message is being received or delivered, this variable contains the
11978 unique message id that is generated and used by Exim to identify the message.
11979 An id is not created for a message until after its header has been successfully
11980 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11981 line; it is the local id that Exim assigns to the message, for example:
11982 &`1BXTIK-0001yO-VA`&.
11983
11984 .vitem &$message_headers$&
11985 .vindex &$message_headers$&
11986 This variable contains a concatenation of all the header lines when a message
11987 is being processed, except for lines added by routers or transports. The header
11988 lines are separated by newline characters. Their contents are decoded in the
11989 same way as a header line that is inserted by &%bheader%&.
11990
11991 .vitem &$message_headers_raw$&
11992 .vindex &$message_headers_raw$&
11993 This variable is like &$message_headers$& except that no processing of the
11994 contents of header lines is done.
11995
11996 .vitem &$message_id$&
11997 This is an old name for &$message_exim_id$&. It is now deprecated.
11998
11999 .vitem &$message_linecount$&
12000 .vindex "&$message_linecount$&"
12001 This variable contains the total number of lines in the header and body of the
12002 message. Compare &$body_linecount$&, which is the count for the body only.
12003 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12004 number of lines received. Before delivery happens (that is, before filters,
12005 routers, and transports run) the count is increased to include the
12006 &'Received:'& header line that Exim standardly adds, and also any other header
12007 lines that are added by ACLs. The blank line that separates the message header
12008 from the body is not counted.
12009
12010 As with the special case of &$message_size$&, during the expansion of the
12011 appendfile transport's maildir_tag option in maildir format, the value of
12012 &$message_linecount$& is the precise size of the number of newlines in the
12013 file that has been written (minus one for the blank line between the
12014 header and the body).
12015
12016 Here is an example of the use of this variable in a DATA ACL:
12017 .code
12018 deny message   = Too many lines in message header
12019      condition = \
12020       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12021 .endd
12022 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12023 message has not yet been received.
12024
12025 .vitem &$message_size$&
12026 .cindex "size" "of message"
12027 .cindex "message" "size"
12028 .vindex "&$message_size$&"
12029 When a message is being processed, this variable contains its size in bytes. In
12030 most cases, the size includes those headers that were received with the
12031 message, but not those (such as &'Envelope-to:'&) that are added to individual
12032 deliveries as they are written. However, there is one special case: during the
12033 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12034 doing a delivery in maildir format, the value of &$message_size$& is the
12035 precise size of the file that has been written. See also
12036 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12037
12038 .cindex "RCPT" "value of &$message_size$&"
12039 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12040 contains the size supplied on the MAIL command, or -1 if no size was given. The
12041 value may not, of course, be truthful.
12042
12043 .vitem &$mime_$&&'xxx'&
12044 A number of variables whose names start with &$mime$& are
12045 available when Exim is compiled with the content-scanning extension. For
12046 details, see section &<<SECTscanmimepart>>&.
12047
12048 .vitem "&$n0$& &-- &$n9$&"
12049 These variables are counters that can be incremented by means
12050 of the &%add%& command in filter files.
12051
12052 .vitem &$original_domain$&
12053 .vindex "&$domain$&"
12054 .vindex "&$original_domain$&"
12055 When a top-level address is being processed for delivery, this contains the
12056 same value as &$domain$&. However, if a &"child"& address (for example,
12057 generated by an alias, forward, or filter file) is being processed, this
12058 variable contains the domain of the original address (lower cased). This
12059 differs from &$parent_domain$& only when there is more than one level of
12060 aliasing or forwarding. When more than one address is being delivered in a
12061 single transport run, &$original_domain$& is not set.
12062
12063 If a new address is created by means of a &%deliver%& command in a system
12064 filter, it is set up with an artificial &"parent"& address. This has the local
12065 part &'system-filter'& and the default qualify domain.
12066
12067 .vitem &$original_local_part$&
12068 .vindex "&$local_part$&"
12069 .vindex "&$original_local_part$&"
12070 When a top-level address is being processed for delivery, this contains the
12071 same value as &$local_part$&, unless a prefix or suffix was removed from the
12072 local part, because &$original_local_part$& always contains the full local
12073 part. When a &"child"& address (for example, generated by an alias, forward, or
12074 filter file) is being processed, this variable contains the full local part of
12075 the original address.
12076
12077 If the router that did the redirection processed the local part
12078 case-insensitively, the value in &$original_local_part$& is in lower case.
12079 This variable differs from &$parent_local_part$& only when there is more than
12080 one level of aliasing or forwarding. When more than one address is being
12081 delivered in a single transport run, &$original_local_part$& is not set.
12082
12083 If a new address is created by means of a &%deliver%& command in a system
12084 filter, it is set up with an artificial &"parent"& address. This has the local
12085 part &'system-filter'& and the default qualify domain.
12086
12087 .vitem &$originator_gid$&
12088 .cindex "gid (group id)" "of originating user"
12089 .cindex "sender" "gid"
12090 .vindex "&$caller_gid$&"
12091 .vindex "&$originator_gid$&"
12092 This variable contains the value of &$caller_gid$& that was set when the
12093 message was received. For messages received via the command line, this is the
12094 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12095 normally the gid of the Exim user.
12096
12097 .vitem &$originator_uid$&
12098 .cindex "uid (user id)" "of originating user"
12099 .cindex "sender" "uid"
12100 .vindex "&$caller_uid$&"
12101 .vindex "&$originaltor_uid$&"
12102 The value of &$caller_uid$& that was set when the message was received. For
12103 messages received via the command line, this is the uid of the sending user.
12104 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12105 user.
12106
12107 .vitem &$parent_domain$&
12108 .vindex "&$parent_domain$&"
12109 This variable is similar to &$original_domain$& (see
12110 above), except that it refers to the immediately preceding parent address.
12111
12112 .vitem &$parent_local_part$&
12113 .vindex "&$parent_local_part$&"
12114 This variable is similar to &$original_local_part$&
12115 (see above), except that it refers to the immediately preceding parent address.
12116
12117 .vitem &$pid$&
12118 .cindex "pid (process id)" "of current process"
12119 .vindex "&$pid$&"
12120 This variable contains the current process id.
12121
12122 .vitem &$pipe_addresses$&
12123 .cindex "filter" "transport filter"
12124 .cindex "transport" "filter"
12125 .vindex "&$pipe_addresses$&"
12126 This is not an expansion variable, but is mentioned here because the string
12127 &`$pipe_addresses`& is handled specially in the command specification for the
12128 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12129 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12130 It cannot be used in general expansion strings, and provokes an &"unknown
12131 variable"& error if encountered.
12132
12133 .vitem &$primary_hostname$&
12134 .vindex "&$primary_hostname$&"
12135 This variable contains the value set by &%primary_hostname%& in the
12136 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12137 a single-component name, Exim calls &[gethostbyname()]& (or
12138 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12139 qualified host name. See also &$smtp_active_hostname$&.
12140
12141
12142 .vitem &$proxy_external_address$& &&&
12143        &$proxy_external_port$& &&&
12144        &$proxy_local_address$& &&&
12145        &$proxy_local_port$& &&&
12146        &$proxy_session$&
12147 These variables are only available when built with Proxy Protocol
12148 or Socks5 support
12149 For details see chapter &<<SECTproxyInbound>>&.
12150
12151 .vitem &$prdr_requested$&
12152 .cindex "PRDR" "variable for"
12153 This variable is set to &"yes"& if PRDR was requested by the client for the
12154 current message, otherwise &"no"&.
12155
12156 .vitem &$prvscheck_address$&
12157 This variable is used in conjunction with the &%prvscheck%& expansion item,
12158 which is described in sections &<<SECTexpansionitems>>& and
12159 &<<SECTverifyPRVS>>&.
12160
12161 .vitem &$prvscheck_keynum$&
12162 This variable is used in conjunction with the &%prvscheck%& expansion item,
12163 which is described in sections &<<SECTexpansionitems>>& and
12164 &<<SECTverifyPRVS>>&.
12165
12166 .vitem &$prvscheck_result$&
12167 This variable is used in conjunction with the &%prvscheck%& expansion item,
12168 which is described in sections &<<SECTexpansionitems>>& and
12169 &<<SECTverifyPRVS>>&.
12170
12171 .vitem &$qualify_domain$&
12172 .vindex "&$qualify_domain$&"
12173 The value set for the &%qualify_domain%& option in the configuration file.
12174
12175 .vitem &$qualify_recipient$&
12176 .vindex "&$qualify_recipient$&"
12177 The value set for the &%qualify_recipient%& option in the configuration file,
12178 or if not set, the value of &$qualify_domain$&.
12179
12180 .vitem &$rcpt_count$&
12181 .vindex "&$rcpt_count$&"
12182 When a message is being received by SMTP, this variable contains the number of
12183 RCPT commands received for the current message. If this variable is used in a
12184 RCPT ACL, its value includes the current command.
12185
12186 .vitem &$rcpt_defer_count$&
12187 .vindex "&$rcpt_defer_count$&"
12188 .cindex "4&'xx'& responses" "count of"
12189 When a message is being received by SMTP, this variable contains the number of
12190 RCPT commands in the current message that have previously been rejected with a
12191 temporary (4&'xx'&) response.
12192
12193 .vitem &$rcpt_fail_count$&
12194 .vindex "&$rcpt_fail_count$&"
12195 When a message is being received by SMTP, this variable contains the number of
12196 RCPT commands in the current message that have previously been rejected with a
12197 permanent (5&'xx'&) response.
12198
12199 .vitem &$received_count$&
12200 .vindex "&$received_count$&"
12201 This variable contains the number of &'Received:'& header lines in the message,
12202 including the one added by Exim (so its value is always greater than zero). It
12203 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12204 delivering.
12205
12206 .vitem &$received_for$&
12207 .vindex "&$received_for$&"
12208 If there is only a single recipient address in an incoming message, this
12209 variable contains that address when the &'Received:'& header line is being
12210 built. The value is copied after recipient rewriting has happened, but before
12211 the &[local_scan()]& function is run.
12212
12213 .vitem &$received_ip_address$&
12214 .vindex "&$received_ip_address$&"
12215 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12216 variable is set to the address of the local IP interface, and &$received_port$&
12217 is set to the local port number. (The remote IP address and port are in
12218 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12219 the port value is -1 unless it has been set using the &%-oMi%& command line
12220 option.
12221
12222 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12223 could be used, for example, to make the file name for a TLS certificate depend
12224 on which interface and/or port is being used for the incoming connection. The
12225 values of &$received_ip_address$& and &$received_port$& are saved with any
12226 messages that are received, thus making these variables available at delivery
12227 time.
12228 For outbound connections see &$sending_ip_address$&.
12229
12230 .vitem &$received_port$&
12231 .vindex "&$received_port$&"
12232 See &$received_ip_address$&.
12233
12234 .vitem &$received_protocol$&
12235 .vindex "&$received_protocol$&"
12236 When a message is being processed, this variable contains the name of the
12237 protocol by which it was received. Most of the names used by Exim are defined
12238 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12239 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12240 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12241 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12242 connection and the client was successfully authenticated.
12243
12244 Exim uses the protocol name &"smtps"& for the case when encryption is
12245 automatically set up on connection without the use of STARTTLS (see
12246 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12247 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12248 where the client initially uses EHLO, sets up an encrypted connection using
12249 STARTTLS, and then uses HELO afterwards.
12250
12251 The &%-oMr%& option provides a way of specifying a custom protocol name for
12252 messages that are injected locally by trusted callers. This is commonly used to
12253 identify messages that are being re-injected after some kind of scanning.
12254
12255 .vitem &$received_time$&
12256 .vindex "&$received_time$&"
12257 This variable contains the date and time when the current message was received,
12258 as a number of seconds since the start of the Unix epoch.
12259
12260 .vitem &$recipient_data$&
12261 .vindex "&$recipient_data$&"
12262 This variable is set after an indexing lookup success in an ACL &%recipients%&
12263 condition. It contains the data from the lookup, and the value remains set
12264 until the next &%recipients%& test. Thus, you can do things like this:
12265 .display
12266 &`require recipients  = cdb*@;/some/file`&
12267 &`deny    `&&'some further test involving'& &`$recipient_data`&
12268 .endd
12269 &*Warning*&: This variable is set only when a lookup is used as an indexing
12270 method in the address list, using the semicolon syntax as in the example above.
12271 The variable is not set for a lookup that is used as part of the string
12272 expansion that all such lists undergo before being interpreted.
12273
12274 .vitem &$recipient_verify_failure$&
12275 .vindex "&$recipient_verify_failure$&"
12276 In an ACL, when a recipient verification fails, this variable contains
12277 information about the failure. It is set to one of the following words:
12278
12279 .ilist
12280 &"qualify"&: The address was unqualified (no domain), and the message
12281 was neither local nor came from an exempted host.
12282
12283 .next
12284 &"route"&: Routing failed.
12285
12286 .next
12287 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12288 or before the MAIL command (that is, on initial connection, HELO, or
12289 MAIL).
12290
12291 .next
12292 &"recipient"&: The RCPT command in a callout was rejected.
12293 .next
12294
12295 &"postmaster"&: The postmaster check in a callout was rejected.
12296 .endlist
12297
12298 The main use of this variable is expected to be to distinguish between
12299 rejections of MAIL and rejections of RCPT.
12300
12301 .vitem &$recipients$&
12302 .vindex "&$recipients$&"
12303 This variable contains a list of envelope recipients for a message. A comma and
12304 a space separate the addresses in the replacement text. However, the variable
12305 is not generally available, to prevent exposure of Bcc recipients in
12306 unprivileged users' filter files. You can use &$recipients$& only in these
12307 cases:
12308
12309 .olist
12310 In a system filter file.
12311 .next
12312 In the ACLs associated with the DATA command and with non-SMTP messages, that
12313 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12314 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12315 &%acl_not_smtp_mime%&.
12316 .next
12317 From within a &[local_scan()]& function.
12318 .endlist
12319
12320
12321 .vitem &$recipients_count$&
12322 .vindex "&$recipients_count$&"
12323 When a message is being processed, this variable contains the number of
12324 envelope recipients that came with the message. Duplicates are not excluded
12325 from the count. While a message is being received over SMTP, the number
12326 increases for each accepted recipient. It can be referenced in an ACL.
12327
12328
12329 .vitem &$regex_match_string$&
12330 .vindex "&$regex_match_string$&"
12331 This variable is set to contain the matching regular expression after a
12332 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12333
12334 .vitem "&$regex1$&, &$regex2$&, etc"
12335 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12336 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12337 these variables contain the
12338 captured substrings identified by the regular expression.
12339
12340
12341 .vitem &$reply_address$&
12342 .vindex "&$reply_address$&"
12343 When a message is being processed, this variable contains the contents of the
12344 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12345 contents of the &'From:'& header line. Apart from the removal of leading
12346 white space, the value is not processed in any way. In particular, no RFC 2047
12347 decoding or character code translation takes place.
12348
12349 .vitem &$return_path$&
12350 .vindex "&$return_path$&"
12351 When a message is being delivered, this variable contains the return path &--
12352 the sender field that will be sent as part of the envelope. It is not enclosed
12353 in <> characters. At the start of routing an address, &$return_path$& has the
12354 same value as &$sender_address$&, but if, for example, an incoming message to a
12355 mailing list has been expanded by a router which specifies a different address
12356 for bounce messages, &$return_path$& subsequently contains the new bounce
12357 address, whereas &$sender_address$& always contains the original sender address
12358 that was received with the message. In other words, &$sender_address$& contains
12359 the incoming envelope sender, and &$return_path$& contains the outgoing
12360 envelope sender.
12361
12362 .vitem &$return_size_limit$&
12363 .vindex "&$return_size_limit$&"
12364 This is an obsolete name for &$bounce_return_size_limit$&.
12365
12366 .vitem &$router_name$&
12367 .cindex "router" "name"
12368 .cindex "name" "of router"
12369 .vindex "&$router_name$&"
12370 During the running of a router this variable contains its name.
12371
12372 .vitem &$runrc$&
12373 .cindex "return code" "from &%run%& expansion"
12374 .vindex "&$runrc$&"
12375 This variable contains the return code from a command that is run by the
12376 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12377 assume the order in which option values are expanded, except for those
12378 preconditions whose order of testing is documented. Therefore, you cannot
12379 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12380 another.
12381
12382 .vitem &$self_hostname$&
12383 .oindex "&%self%&" "value of host name"
12384 .vindex "&$self_hostname$&"
12385 When an address is routed to a supposedly remote host that turns out to be the
12386 local host, what happens is controlled by the &%self%& generic router option.
12387 One of its values causes the address to be passed to another router. When this
12388 happens, &$self_hostname$& is set to the name of the local host that the
12389 original router encountered. In other circumstances its contents are null.
12390
12391 .vitem &$sender_address$&
12392 .vindex "&$sender_address$&"
12393 When a message is being processed, this variable contains the sender's address
12394 that was received in the message's envelope. The case of letters in the address
12395 is retained, in both the local part and the domain. For bounce messages, the
12396 value of this variable is the empty string. See also &$return_path$&.
12397
12398 .vitem &$sender_address_data$&
12399 .vindex "&$address_data$&"
12400 .vindex "&$sender_address_data$&"
12401 If &$address_data$& is set when the routers are called from an ACL to verify a
12402 sender address, the final value is preserved in &$sender_address_data$&, to
12403 distinguish it from data from a recipient address. The value does not persist
12404 after the end of the current ACL statement. If you want to preserve it for
12405 longer, you can save it in an ACL variable.
12406
12407 .vitem &$sender_address_domain$&
12408 .vindex "&$sender_address_domain$&"
12409 The domain portion of &$sender_address$&.
12410
12411 .vitem &$sender_address_local_part$&
12412 .vindex "&$sender_address_local_part$&"
12413 The local part portion of &$sender_address$&.
12414
12415 .vitem &$sender_data$&
12416 .vindex "&$sender_data$&"
12417 This variable is set after a lookup success in an ACL &%senders%& condition or
12418 in a router &%senders%& option. It contains the data from the lookup, and the
12419 value remains set until the next &%senders%& test. Thus, you can do things like
12420 this:
12421 .display
12422 &`require senders      = cdb*@;/some/file`&
12423 &`deny    `&&'some further test involving'& &`$sender_data`&
12424 .endd
12425 &*Warning*&: This variable is set only when a lookup is used as an indexing
12426 method in the address list, using the semicolon syntax as in the example above.
12427 The variable is not set for a lookup that is used as part of the string
12428 expansion that all such lists undergo before being interpreted.
12429
12430 .vitem &$sender_fullhost$&
12431 .vindex "&$sender_fullhost$&"
12432 When a message is received from a remote host, this variable contains the host
12433 name and IP address in a single string. It ends with the IP address in square
12434 brackets, followed by a colon and a port number if the logging of ports is
12435 enabled. The format of the rest of the string depends on whether the host
12436 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12437 looking up its IP address. (Looking up the IP address can be forced by the
12438 &%host_lookup%& option, independent of verification.) A plain host name at the
12439 start of the string is a verified host name; if this is not present,
12440 verification either failed or was not requested. A host name in parentheses is
12441 the argument of a HELO or EHLO command. This is omitted if it is identical to
12442 the verified host name or to the host's IP address in square brackets.
12443
12444 .vitem &$sender_helo_dnssec$&
12445 .vindex "&$sender_helo_dnssec$&"
12446 This boolean variable is true if a successful HELO verification was
12447 .cindex "DNS" "DNSSEC"
12448 done using DNS information the resolver library stated was authenticated data.
12449
12450 .vitem &$sender_helo_name$&
12451 .vindex "&$sender_helo_name$&"
12452 When a message is received from a remote host that has issued a HELO or EHLO
12453 command, the argument of that command is placed in this variable. It is also
12454 set if HELO or EHLO is used when a message is received using SMTP locally via
12455 the &%-bs%& or &%-bS%& options.
12456
12457 .vitem &$sender_host_address$&
12458 .vindex "&$sender_host_address$&"
12459 When a message is received from a remote host using SMTP,
12460 this variable contains that
12461 host's IP address. For locally non-SMTP submitted messages, it is empty.
12462
12463 .vitem &$sender_host_authenticated$&
12464 .vindex "&$sender_host_authenticated$&"
12465 This variable contains the name (not the public name) of the authenticator
12466 driver that successfully authenticated the client from which the message was
12467 received. It is empty if there was no successful authentication. See also
12468 &$authenticated_id$&.
12469
12470 .vitem &$sender_host_dnssec$&
12471 .vindex "&$sender_host_dnssec$&"
12472 If an attempt to populate &$sender_host_name$& has been made
12473 (by reference, &%hosts_lookup%& or
12474 otherwise) then this boolean will have been set true if, and only if, the
12475 resolver library states that both
12476 the reverse and forward DNS were authenticated data.  At all
12477 other times, this variable is false.
12478
12479 .cindex "DNS" "DNSSEC"
12480 It is likely that you will need to coerce DNSSEC support on in the resolver
12481 library, by setting:
12482 .code
12483 dns_dnssec_ok = 1
12484 .endd
12485
12486 Exim does not perform DNSSEC validation itself, instead leaving that to a
12487 validating resolver (e.g. unbound, or bind with suitable configuration).
12488
12489 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12490 mechanism in the list, then this variable will be false.
12491
12492
12493 .vitem &$sender_host_name$&
12494 .vindex "&$sender_host_name$&"
12495 When a message is received from a remote host, this variable contains the
12496 host's name as obtained by looking up its IP address. For messages received by
12497 other means, this variable is empty.
12498
12499 .vindex "&$host_lookup_failed$&"
12500 If the host name has not previously been looked up, a reference to
12501 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12502 A looked up name is accepted only if it leads back to the original IP address
12503 via a forward lookup. If either the reverse or the forward lookup fails to find
12504 any data, or if the forward lookup does not yield the original IP address,
12505 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12506
12507 .vindex "&$host_lookup_deferred$&"
12508 However, if either of the lookups cannot be completed (for example, there is a
12509 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12510 &$host_lookup_failed$& remains set to &"0"&.
12511
12512 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12513 host name again if there is a subsequent reference to &$sender_host_name$&
12514 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12515 is set to &"1"&.
12516
12517 Exim does not automatically look up every calling host's name. If you want
12518 maximum efficiency, you should arrange your configuration so that it avoids
12519 these lookups altogether. The lookup happens only if one or more of the
12520 following are true:
12521
12522 .ilist
12523 A string containing &$sender_host_name$& is expanded.
12524 .next
12525 The calling host matches the list in &%host_lookup%&. In the default
12526 configuration, this option is set to *, so it must be changed if lookups are
12527 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12528 .next
12529 Exim needs the host name in order to test an item in a host list. The items
12530 that require this are described in sections &<<SECThoslispatnam>>& and
12531 &<<SECThoslispatnamsk>>&.
12532 .next
12533 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12534 In this case, the host name is required to compare with the name quoted in any
12535 EHLO or HELO commands that the client issues.
12536 .next
12537 The remote host issues a EHLO or HELO command that quotes one of the
12538 domains in &%helo_lookup_domains%&. The default value of this option is
12539 . ==== As this is a nested list, any displays it contains must be indented
12540 . ==== as otherwise they are too far to the left.
12541 .code
12542   helo_lookup_domains = @ : @[]
12543 .endd
12544 which causes a lookup if a remote host (incorrectly) gives the server's name or
12545 IP address in an EHLO or HELO command.
12546 .endlist
12547
12548
12549 .vitem &$sender_host_port$&
12550 .vindex "&$sender_host_port$&"
12551 When a message is received from a remote host, this variable contains the port
12552 number that was used on the remote host.
12553
12554 .vitem &$sender_ident$&
12555 .vindex "&$sender_ident$&"
12556 When a message is received from a remote host, this variable contains the
12557 identification received in response to an RFC 1413 request. When a message has
12558 been received locally, this variable contains the login name of the user that
12559 called Exim.
12560
12561 .vitem &$sender_rate_$&&'xxx'&
12562 A number of variables whose names begin &$sender_rate_$& are set as part of the
12563 &%ratelimit%& ACL condition. Details are given in section
12564 &<<SECTratelimiting>>&.
12565
12566 .vitem &$sender_rcvhost$&
12567 .cindex "DNS" "reverse lookup"
12568 .cindex "reverse DNS lookup"
12569 .vindex "&$sender_rcvhost$&"
12570 This is provided specifically for use in &'Received:'& headers. It starts with
12571 either the verified host name (as obtained from a reverse DNS lookup) or, if
12572 there is no verified host name, the IP address in square brackets. After that
12573 there may be text in parentheses. When the first item is a verified host name,
12574 the first thing in the parentheses is the IP address in square brackets,
12575 followed by a colon and a port number if port logging is enabled. When the
12576 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12577 the parentheses.
12578
12579 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12580 was used and its argument was not identical to the real host name or IP
12581 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12582 all three items are present in the parentheses, a newline and tab are inserted
12583 into the string, to improve the formatting of the &'Received:'& header.
12584
12585 .vitem &$sender_verify_failure$&
12586 .vindex "&$sender_verify_failure$&"
12587 In an ACL, when a sender verification fails, this variable contains information
12588 about the failure. The details are the same as for
12589 &$recipient_verify_failure$&.
12590
12591 .vitem &$sending_ip_address$&
12592 .vindex "&$sending_ip_address$&"
12593 This variable is set whenever an outgoing SMTP connection to another host has
12594 been set up. It contains the IP address of the local interface that is being
12595 used. This is useful if a host that has more than one IP address wants to take
12596 on different personalities depending on which one is being used. For incoming
12597 connections, see &$received_ip_address$&.
12598
12599 .vitem &$sending_port$&
12600 .vindex "&$sending_port$&"
12601 This variable is set whenever an outgoing SMTP connection to another host has
12602 been set up. It contains the local port that is being used. For incoming
12603 connections, see &$received_port$&.
12604
12605 .vitem &$smtp_active_hostname$&
12606 .vindex "&$smtp_active_hostname$&"
12607 During an incoming SMTP session, this variable contains the value of the active
12608 host name, as specified by the &%smtp_active_hostname%& option. The value of
12609 &$smtp_active_hostname$& is saved with any message that is received, so its
12610 value can be consulted during routing and delivery.
12611
12612 .vitem &$smtp_command$&
12613 .vindex "&$smtp_command$&"
12614 During the processing of an incoming SMTP command, this variable contains the
12615 entire command. This makes it possible to distinguish between HELO and EHLO in
12616 the HELO ACL, and also to distinguish between commands such as these:
12617 .code
12618 MAIL FROM:<>
12619 MAIL FROM: <>
12620 .endd
12621 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12622 command, the address in &$smtp_command$& is the original address before any
12623 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12624 the address after SMTP-time rewriting.
12625
12626 .vitem &$smtp_command_argument$&
12627 .cindex "SMTP" "command, argument for"
12628 .vindex "&$smtp_command_argument$&"
12629 While an ACL is running to check an SMTP command, this variable contains the
12630 argument, that is, the text that follows the command name, with leading white
12631 space removed. Following the introduction of &$smtp_command$&, this variable is
12632 somewhat redundant, but is retained for backwards compatibility.
12633
12634 .vitem &$smtp_count_at_connection_start$&
12635 .vindex "&$smtp_count_at_connection_start$&"
12636 This variable is set greater than zero only in processes spawned by the Exim
12637 daemon for handling incoming SMTP connections. The name is deliberately long,
12638 in order to emphasize what the contents are. When the daemon accepts a new
12639 connection, it increments this variable. A copy of the variable is passed to
12640 the child process that handles the connection, but its value is fixed, and
12641 never changes. It is only an approximation of how many incoming connections
12642 there actually are, because many other connections may come and go while a
12643 single connection is being processed. When a child process terminates, the
12644 daemon decrements its copy of the variable.
12645
12646 .vitem "&$sn0$& &-- &$sn9$&"
12647 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12648 that were current at the end of the system filter file. This allows a system
12649 filter file to set values that can be tested in users' filter files. For
12650 example, a system filter could set a value indicating how likely it is that a
12651 message is junk mail.
12652
12653 .vitem &$spam_$&&'xxx'&
12654 A number of variables whose names start with &$spam$& are available when Exim
12655 is compiled with the content-scanning extension. For details, see section
12656 &<<SECTscanspamass>>&.
12657
12658
12659 .vitem &$spool_directory$&
12660 .vindex "&$spool_directory$&"
12661 The name of Exim's spool directory.
12662
12663 .vitem &$spool_inodes$&
12664 .vindex "&$spool_inodes$&"
12665 The number of free inodes in the disk partition where Exim's spool files are
12666 being written. The value is recalculated whenever the variable is referenced.
12667 If the relevant file system does not have the concept of inodes, the value of
12668 is -1. See also the &%check_spool_inodes%& option.
12669
12670 .vitem &$spool_space$&
12671 .vindex "&$spool_space$&"
12672 The amount of free space (as a number of kilobytes) in the disk partition where
12673 Exim's spool files are being written. The value is recalculated whenever the
12674 variable is referenced. If the operating system does not have the ability to
12675 find the amount of free space (only true for experimental systems), the space
12676 value is -1. For example, to check in an ACL that there is at least 50
12677 megabytes free on the spool, you could write:
12678 .code
12679 condition = ${if > {$spool_space}{50000}}
12680 .endd
12681 See also the &%check_spool_space%& option.
12682
12683
12684 .vitem &$thisaddress$&
12685 .vindex "&$thisaddress$&"
12686 This variable is set only during the processing of the &%foranyaddress%&
12687 command in a filter file. Its use is explained in the description of that
12688 command, which can be found in the separate document entitled &'Exim's
12689 interfaces to mail filtering'&.
12690
12691 .vitem &$tls_in_bits$&
12692 .vindex "&$tls_in_bits$&"
12693 Contains an approximation of the TLS cipher's bit-strength
12694 on the inbound connection; the meaning of
12695 this depends upon the TLS implementation used.
12696 If TLS has not been negotiated, the value will be 0.
12697 The value of this is automatically fed into the Cyrus SASL authenticator
12698 when acting as a server, to specify the "external SSF" (a SASL term).
12699
12700 The deprecated &$tls_bits$& variable refers to the inbound side
12701 except when used in the context of an outbound SMTP delivery, when it refers to
12702 the outbound.
12703
12704 .vitem &$tls_out_bits$&
12705 .vindex "&$tls_out_bits$&"
12706 Contains an approximation of the TLS cipher's bit-strength
12707 on an outbound SMTP connection; the meaning of
12708 this depends upon the TLS implementation used.
12709 If TLS has not been negotiated, the value will be 0.
12710
12711 .vitem &$tls_in_ourcert$&
12712 .vindex "&$tls_in_ourcert$&"
12713 .cindex certificate veriables
12714 This variable refers to the certificate presented to the peer of an
12715 inbound connection when the message was received.
12716 It is only useful as the argument of a
12717 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12718 or a &%def%& condition.
12719
12720 .vitem &$tls_in_peercert$&
12721 .vindex "&$tls_in_peercert$&"
12722 This variable refers to the certificate presented by the peer of an
12723 inbound connection when the message was received.
12724 It is only useful as the argument of a
12725 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12726 or a &%def%& condition.
12727 If certificate verification fails it may refer to a failing chain element
12728 which is not the leaf.
12729
12730 .vitem &$tls_out_ourcert$&
12731 .vindex "&$tls_out_ourcert$&"
12732 This variable refers to the certificate presented to the peer of an
12733 outbound connection.  It is only useful as the argument of a
12734 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12735 or a &%def%& condition.
12736
12737 .vitem &$tls_out_peercert$&
12738 .vindex "&$tls_out_peercert$&"
12739 This variable refers to the certificate presented by the peer of an
12740 outbound connection.  It is only useful as the argument of a
12741 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12742 or a &%def%& condition.
12743 If certificate verification fails it may refer to a failing chain element
12744 which is not the leaf.
12745
12746 .vitem &$tls_in_certificate_verified$&
12747 .vindex "&$tls_in_certificate_verified$&"
12748 This variable is set to &"1"& if a TLS certificate was verified when the
12749 message was received, and &"0"& otherwise.
12750
12751 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12752 except when used in the context of an outbound SMTP delivery, when it refers to
12753 the outbound.
12754
12755 .vitem &$tls_out_certificate_verified$&
12756 .vindex "&$tls_out_certificate_verified$&"
12757 This variable is set to &"1"& if a TLS certificate was verified when an
12758 outbound SMTP connection was made,
12759 and &"0"& otherwise.
12760
12761 .vitem &$tls_in_cipher$&
12762 .vindex "&$tls_in_cipher$&"
12763 .vindex "&$tls_cipher$&"
12764 When a message is received from a remote host over an encrypted SMTP
12765 connection, this variable is set to the cipher suite that was negotiated, for
12766 example DES-CBC3-SHA. In other circumstances, in particular, for message
12767 received over unencrypted connections, the variable is empty. Testing
12768 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12769 non-encrypted connections during ACL processing.
12770
12771 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12772 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12773 becomes the same as &$tls_out_cipher$&.
12774
12775 .vitem &$tls_out_cipher$&
12776 .vindex "&$tls_out_cipher$&"
12777 This variable is
12778 cleared before any outgoing SMTP connection is made,
12779 and then set to the outgoing cipher suite if one is negotiated. See chapter
12780 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12781 details of the &(smtp)& transport.
12782
12783 .vitem &$tls_in_ocsp$&
12784 .vindex "&$tls_in_ocsp$&"
12785 When a message is received from a remote client connection
12786 the result of any OCSP request from the client is encoded in this variable:
12787 .code
12788 0 OCSP proof was not requested (default value)
12789 1 No response to request
12790 2 Response not verified
12791 3 Verification failed
12792 4 Verification succeeded
12793 .endd
12794
12795 .vitem &$tls_out_ocsp$&
12796 .vindex "&$tls_out_ocsp$&"
12797 When a message is sent to a remote host connection
12798 the result of any OCSP request made is encoded in this variable.
12799 See &$tls_in_ocsp$& for values.
12800
12801 .vitem &$tls_in_peerdn$&
12802 .vindex "&$tls_in_peerdn$&"
12803 .vindex "&$tls_peerdn$&"
12804 .cindex certificate "extracting fields"
12805 When a message is received from a remote host over an encrypted SMTP
12806 connection, and Exim is configured to request a certificate from the client,
12807 the value of the Distinguished Name of the certificate is made available in the
12808 &$tls_in_peerdn$& during subsequent processing.
12809 If certificate verification fails it may refer to a failing chain element
12810 which is not the leaf.
12811
12812 The deprecated &$tls_peerdn$& variable refers to the inbound side
12813 except when used in the context of an outbound SMTP delivery, when it refers to
12814 the outbound.
12815
12816 .vitem &$tls_out_peerdn$&
12817 .vindex "&$tls_out_peerdn$&"
12818 When a message is being delivered to a remote host over an encrypted SMTP
12819 connection, and Exim is configured to request a certificate from the server,
12820 the value of the Distinguished Name of the certificate is made available in the
12821 &$tls_out_peerdn$& during subsequent processing.
12822 If certificate verification fails it may refer to a failing chain element
12823 which is not the leaf.
12824
12825 .vitem &$tls_in_sni$&
12826 .vindex "&$tls_in_sni$&"
12827 .vindex "&$tls_sni$&"
12828 .cindex "TLS" "Server Name Indication"
12829 When a TLS session is being established, if the client sends the Server
12830 Name Indication extension, the value will be placed in this variable.
12831 If the variable appears in &%tls_certificate%& then this option and
12832 some others, described in &<<SECTtlssni>>&,
12833 will be re-expanded early in the TLS session, to permit
12834 a different certificate to be presented (and optionally a different key to be
12835 used) to the client, based upon the value of the SNI extension.
12836
12837 The deprecated &$tls_sni$& variable refers to the inbound side
12838 except when used in the context of an outbound SMTP delivery, when it refers to
12839 the outbound.
12840
12841 .vitem &$tls_out_sni$&
12842 .vindex "&$tls_out_sni$&"
12843 .cindex "TLS" "Server Name Indication"
12844 During outbound
12845 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12846 the transport.
12847
12848 .vitem &$tod_bsdinbox$&
12849 .vindex "&$tod_bsdinbox$&"
12850 The time of day and the date, in the format required for BSD-style mailbox
12851 files, for example: Thu Oct 17 17:14:09 1995.
12852
12853 .vitem &$tod_epoch$&
12854 .vindex "&$tod_epoch$&"
12855 The time and date as a number of seconds since the start of the Unix epoch.
12856
12857 .vitem &$tod_epoch_l$&
12858 .vindex "&$tod_epoch_l$&"
12859 The time and date as a number of microseconds since the start of the Unix epoch.
12860
12861 .vitem &$tod_full$&
12862 .vindex "&$tod_full$&"
12863 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12864 +0100. The timezone is always given as a numerical offset from UTC, with
12865 positive values used for timezones that are ahead (east) of UTC, and negative
12866 values for those that are behind (west).
12867
12868 .vitem &$tod_log$&
12869 .vindex "&$tod_log$&"
12870 The time and date in the format used for writing Exim's log files, for example:
12871 1995-10-12 15:32:29, but without a timezone.
12872
12873 .vitem &$tod_logfile$&
12874 .vindex "&$tod_logfile$&"
12875 This variable contains the date in the format yyyymmdd. This is the format that
12876 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12877 flag.
12878
12879 .vitem &$tod_zone$&
12880 .vindex "&$tod_zone$&"
12881 This variable contains the numerical value of the local timezone, for example:
12882 -0500.
12883
12884 .vitem &$tod_zulu$&
12885 .vindex "&$tod_zulu$&"
12886 This variable contains the UTC date and time in &"Zulu"& format, as specified
12887 by ISO 8601, for example: 20030221154023Z.
12888
12889 .vitem &$transport_name$&
12890 .cindex "transport" "name"
12891 .cindex "name" "of transport"
12892 .vindex "&$transport_name$&"
12893 During the running of a transport, this variable contains its name.
12894
12895 .vitem &$value$&
12896 .vindex "&$value$&"
12897 This variable contains the result of an expansion lookup, extraction operation,
12898 or external command, as described above. It is also used during a
12899 &*reduce*& expansion.
12900
12901 .vitem &$verify_mode$&
12902 .vindex "&$verify_mode$&"
12903 While a router or transport is being run in verify mode
12904 or for cutthrough delivery,
12905 contains "S" for sender-verification or "R" for recipient-verification.
12906 Otherwise, empty.
12907
12908 .vitem &$version_number$&
12909 .vindex "&$version_number$&"
12910 The version number of Exim.
12911
12912 .vitem &$warn_message_delay$&
12913 .vindex "&$warn_message_delay$&"
12914 This variable is set only during the creation of a message warning about a
12915 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12916
12917 .vitem &$warn_message_recipients$&
12918 .vindex "&$warn_message_recipients$&"
12919 This variable is set only during the creation of a message warning about a
12920 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12921 .endlist
12922 .ecindex IIDstrexp
12923
12924
12925
12926 . ////////////////////////////////////////////////////////////////////////////
12927 . ////////////////////////////////////////////////////////////////////////////
12928
12929 .chapter "Embedded Perl" "CHAPperl"
12930 .scindex IIDperl "Perl" "calling from Exim"
12931 Exim can be built to include an embedded Perl interpreter. When this is done,
12932 Perl subroutines can be called as part of the string expansion process. To make
12933 use of the Perl support, you need version 5.004 or later of Perl installed on
12934 your system. To include the embedded interpreter in the Exim binary, include
12935 the line
12936 .code
12937 EXIM_PERL = perl.o
12938 .endd
12939 in your &_Local/Makefile_& and then build Exim in the normal way.
12940
12941
12942 .section "Setting up so Perl can be used" "SECID85"
12943 .oindex "&%perl_startup%&"
12944 Access to Perl subroutines is via a global configuration option called
12945 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12946 no &%perl_startup%& option in the Exim configuration file then no Perl
12947 interpreter is started and there is almost no overhead for Exim (since none of
12948 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12949 option then the associated value is taken to be Perl code which is executed in
12950 a newly created Perl interpreter.
12951
12952 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12953 need backslashes before any characters to escape special meanings. The option
12954 should usually be something like
12955 .code
12956 perl_startup = do '/etc/exim.pl'
12957 .endd
12958 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12959 use from Exim. Exim can be configured either to start up a Perl interpreter as
12960 soon as it is entered, or to wait until the first time it is needed. Starting
12961 the interpreter at the beginning ensures that it is done while Exim still has
12962 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12963 fact used in a particular run. Also, note that this does not mean that Exim is
12964 necessarily running as root when Perl is called at a later time. By default,
12965 the interpreter is started only when it is needed, but this can be changed in
12966 two ways:
12967
12968 .ilist
12969 .oindex "&%perl_at_start%&"
12970 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12971 a startup when Exim is entered.
12972 .next
12973 The command line option &%-ps%& also requests a startup when Exim is entered,
12974 overriding the setting of &%perl_at_start%&.
12975 .endlist
12976
12977 There is also a command line option &%-pd%& (for delay) which suppresses the
12978 initial startup, even if &%perl_at_start%& is set.
12979
12980 .new
12981 .ilist
12982 .oindex "&%perl_taintmode%&"
12983 .cindex "Perl" "taintmode"
12984 To provide more security executing Perl code via the embedded Perl
12985 interpeter, the &%perl_taintmode%& option can be set. This enables the
12986 taint mode of the Perl interpreter. You are encouraged to set this
12987 option to a true value. To avoid breaking existing installations, it
12988 defaults to false.
12989 .wen
12990
12991
12992 .section "Calling Perl subroutines" "SECID86"
12993 When the configuration file includes a &%perl_startup%& option you can make use
12994 of the string expansion item to call the Perl subroutines that are defined
12995 by the &%perl_startup%& code. The operator is used in any of the following
12996 forms:
12997 .code
12998 ${perl{foo}}
12999 ${perl{foo}{argument}}
13000 ${perl{foo}{argument1}{argument2} ... }
13001 .endd
13002 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13003 arguments may be passed. Passing more than this results in an expansion failure
13004 with an error message of the form
13005 .code
13006 Too many arguments passed to Perl subroutine "foo" (max is 8)
13007 .endd
13008 The return value of the Perl subroutine is evaluated in a scalar context before
13009 it is passed back to Exim to be inserted into the expanded string. If the
13010 return value is &'undef'&, the expansion is forced to fail in the same way as
13011 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13012 by obeying Perl's &%die%& function, the expansion fails with the error message
13013 that was passed to &%die%&.
13014
13015
13016 .section "Calling Exim functions from Perl" "SECID87"
13017 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13018 is available to call back into Exim's string expansion function. For example,
13019 the Perl code
13020 .code
13021 my $lp = Exim::expand_string('$local_part');
13022 .endd
13023 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13024 Note those are single quotes and not double quotes to protect against
13025 &$local_part$& being interpolated as a Perl variable.
13026
13027 If the string expansion is forced to fail by a &"fail"& item, the result of
13028 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13029 expansion string, the Perl call from the original expansion string fails with
13030 an appropriate error message, in the same way as if &%die%& were used.
13031
13032 .cindex "debugging" "from embedded Perl"
13033 .cindex "log" "writing from embedded Perl"
13034 Two other Exim functions are available for use from within Perl code.
13035 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13036 debugging is enabled. If you want a newline at the end, you must supply it.
13037 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13038 timestamp. In this case, you should not supply a terminating newline.
13039
13040
13041 .section "Use of standard output and error by Perl" "SECID88"
13042 .cindex "Perl" "standard output and error"
13043 You should not write to the standard error or output streams from within your
13044 Perl code, as it is not defined how these are set up. In versions of Exim
13045 before 4.50, it is possible for the standard output or error to refer to the
13046 SMTP connection during message reception via the daemon. Writing to this stream
13047 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13048 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13049 avoided, but the output is lost.
13050
13051 .cindex "Perl" "use of &%warn%&"
13052 The Perl &%warn%& statement writes to the standard error stream by default.
13053 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13054 you have no control. When Exim starts up the Perl interpreter, it arranges for
13055 output from the &%warn%& statement to be written to the Exim main log. You can
13056 change this by including appropriate Perl magic somewhere in your Perl code.
13057 For example, to discard &%warn%& output completely, you need this:
13058 .code
13059 $SIG{__WARN__} = sub { };
13060 .endd
13061 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13062 example, the code for the subroutine is empty, so it does nothing, but you can
13063 include any Perl code that you like. The text of the &%warn%& message is passed
13064 as the first subroutine argument.
13065 .ecindex IIDperl
13066
13067
13068 . ////////////////////////////////////////////////////////////////////////////
13069 . ////////////////////////////////////////////////////////////////////////////
13070
13071 .chapter "Starting the daemon and the use of network interfaces" &&&
13072          "CHAPinterfaces" &&&
13073          "Starting the daemon"
13074 .cindex "daemon" "starting"
13075 .cindex "interface" "listening"
13076 .cindex "network interface"
13077 .cindex "interface" "network"
13078 .cindex "IP address" "for listening"
13079 .cindex "daemon" "listening IP addresses"
13080 .cindex "TCP/IP" "setting listening interfaces"
13081 .cindex "TCP/IP" "setting listening ports"
13082 A host that is connected to a TCP/IP network may have one or more physical
13083 hardware network interfaces. Each of these interfaces may be configured as one
13084 or more &"logical"& interfaces, which are the entities that a program actually
13085 works with. Each of these logical interfaces is associated with an IP address.
13086 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13087 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13088 knowledge about the host's interfaces for use in three different circumstances:
13089
13090 .olist
13091 When a listening daemon is started, Exim needs to know which interfaces
13092 and ports to listen on.
13093 .next
13094 When Exim is routing an address, it needs to know which IP addresses
13095 are associated with local interfaces. This is required for the correct
13096 processing of MX lists by removing the local host and others with the
13097 same or higher priority values. Also, Exim needs to detect cases
13098 when an address is routed to an IP address that in fact belongs to the
13099 local host. Unless the &%self%& router option or the &%allow_localhost%&
13100 option of the smtp transport is set (as appropriate), this is treated
13101 as an error situation.
13102 .next
13103 When Exim connects to a remote host, it may need to know which interface to use
13104 for the outgoing connection.
13105 .endlist
13106
13107
13108 Exim's default behaviour is likely to be appropriate in the vast majority
13109 of cases. If your host has only one interface, and you want all its IP
13110 addresses to be treated in the same way, and you are using only the
13111 standard SMTP port, you should not need to take any special action. The
13112 rest of this chapter does not apply to you.
13113
13114 In a more complicated situation you may want to listen only on certain
13115 interfaces, or on different ports, and for this reason there are a number of
13116 options that can be used to influence Exim's behaviour. The rest of this
13117 chapter describes how they operate.
13118
13119 When a message is received over TCP/IP, the interface and port that were
13120 actually used are set in &$received_ip_address$& and &$received_port$&.
13121
13122
13123
13124 .section "Starting a listening daemon" "SECID89"
13125 When a listening daemon is started (by means of the &%-bd%& command line
13126 option), the interfaces and ports on which it listens are controlled by the
13127 following options:
13128
13129 .ilist
13130 &%daemon_smtp_ports%& contains a list of default ports
13131 or service names.
13132 (For backward compatibility, this option can also be specified in the singular.)
13133 .next
13134 &%local_interfaces%& contains list of interface IP addresses on which to
13135 listen. Each item may optionally also specify a port.
13136 .endlist
13137
13138 The default list separator in both cases is a colon, but this can be changed as
13139 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13140 it is usually best to change the separator to avoid having to double all the
13141 colons. For example:
13142 .code
13143 local_interfaces = <; 127.0.0.1 ; \
13144                       192.168.23.65 ; \
13145                       ::1 ; \
13146                       3ffe:ffff:836f::fe86:a061
13147 .endd
13148 There are two different formats for specifying a port along with an IP address
13149 in &%local_interfaces%&:
13150
13151 .olist
13152 The port is added onto the address with a dot separator. For example, to listen
13153 on port 1234 on two different IP addresses:
13154 .code
13155 local_interfaces = <; 192.168.23.65.1234 ; \
13156                       3ffe:ffff:836f::fe86:a061.1234
13157 .endd
13158 .next
13159 The IP address is enclosed in square brackets, and the port is added
13160 with a colon separator, for example:
13161 .code
13162 local_interfaces = <; [192.168.23.65]:1234 ; \
13163                       [3ffe:ffff:836f::fe86:a061]:1234
13164 .endd
13165 .endlist
13166
13167 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13168 default setting contains just one port:
13169 .code
13170 daemon_smtp_ports = smtp
13171 .endd
13172 If more than one port is listed, each interface that does not have its own port
13173 specified listens on all of them. Ports that are listed in
13174 &%daemon_smtp_ports%& can be identified either by name (defined in
13175 &_/etc/services_&) or by number. However, when ports are given with individual
13176 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13177
13178
13179
13180 .section "Special IP listening addresses" "SECID90"
13181 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13182 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13183 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13184 instead of setting up separate listening sockets for each interface. The
13185 default value of &%local_interfaces%& is
13186 .code
13187 local_interfaces = 0.0.0.0
13188 .endd
13189 when Exim is built without IPv6 support; otherwise it is:
13190 .code
13191 local_interfaces = <; ::0 ; 0.0.0.0
13192 .endd
13193 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13194
13195
13196
13197 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13198 The &%-oX%& command line option can be used to override the values of
13199 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13200 instance. Another way of doing this would be to use macros and the &%-D%&
13201 option. However, &%-oX%& can be used by any admin user, whereas modification of
13202 the runtime configuration by &%-D%& is allowed only when the caller is root or
13203 exim.
13204
13205 The value of &%-oX%& is a list of items. The default colon separator can be
13206 changed in the usual way if required. If there are any items that do not
13207 contain dots or colons (that is, are not IP addresses), the value of
13208 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13209 items that do contain dots or colons, the value of &%local_interfaces%& is
13210 replaced by those items. Thus, for example,
13211 .code
13212 -oX 1225
13213 .endd
13214 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13215 whereas
13216 .code
13217 -oX 192.168.34.5.1125
13218 .endd
13219 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13220 (However, since &%local_interfaces%& now contains no items without ports, the
13221 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13222
13223
13224
13225 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13226 .cindex "ssmtp protocol"
13227 .cindex "smtps protocol"
13228 .cindex "SMTP" "ssmtp protocol"
13229 .cindex "SMTP" "smtps protocol"
13230 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13231 before the STARTTLS command was standardized for SMTP. Some legacy clients
13232 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13233 list of port numbers or service names,
13234 connections to those ports must use SSMTP. The most
13235 common use of this option is expected to be
13236 .code
13237 tls_on_connect_ports = 465
13238 .endd
13239 because 465 is the usual port number used by the legacy clients. There is also
13240 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13241 this way when a daemon is started.
13242
13243 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13244 daemon to listen on those ports. You must still specify them in
13245 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13246 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13247 connections via the daemon.)
13248
13249
13250
13251
13252 .section "IPv6 address scopes" "SECID92"
13253 .cindex "IPv6" "address scopes"
13254 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13255 can, in principle, have the same link-local IPv6 address on different
13256 interfaces. Thus, additional information is needed, over and above the IP
13257 address, to distinguish individual interfaces. A convention of using a
13258 percent sign followed by something (often the interface name) has been
13259 adopted in some cases, leading to addresses like this:
13260 .code
13261 fe80::202:b3ff:fe03:45c1%eth0
13262 .endd
13263 To accommodate this usage, a percent sign followed by an arbitrary string is
13264 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13265 to convert a textual IPv6 address for actual use. This function recognizes the
13266 percent convention in operating systems that support it, and it processes the
13267 address appropriately. Unfortunately, some older libraries have problems with
13268 &[getaddrinfo()]&. If
13269 .code
13270 IPV6_USE_INET_PTON=yes
13271 .endd
13272 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13273 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13274 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13275 function.) Of course, this means that the additional functionality of
13276 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13277
13278 .section "Disabling IPv6" "SECID93"
13279 .cindex "IPv6" "disabling"
13280 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13281 run on a host whose kernel does not support IPv6. The binary will fall back to
13282 using IPv4, but it may waste resources looking up AAAA records, and trying to
13283 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13284 .oindex "&%disable_ipv6%&"
13285 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13286 activities take place. AAAA records are never looked up, and any IPv6 addresses
13287 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13288 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13289 to handle IPv6 literal addresses.
13290
13291 On the other hand, when IPv6 is in use, there may be times when you want to
13292 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13293 option to globally suppress the lookup of AAAA records for specified domains,
13294 and you can use the &%ignore_target_hosts%& generic router option to ignore
13295 IPv6 addresses in an individual router.
13296
13297
13298
13299 .section "Examples of starting a listening daemon" "SECID94"
13300 The default case in an IPv6 environment is
13301 .code
13302 daemon_smtp_ports = smtp
13303 local_interfaces = <; ::0 ; 0.0.0.0
13304 .endd
13305 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13306 Either one or two sockets may be used, depending on the characteristics of
13307 the TCP/IP stack. (This is complicated and messy; for more information,
13308 read the comments in the &_daemon.c_& source file.)
13309
13310 To specify listening on ports 25 and 26 on all interfaces:
13311 .code
13312 daemon_smtp_ports = 25 : 26
13313 .endd
13314 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13315 .code
13316 local_interfaces = <; ::0.25     ; ::0.26 \
13317                       0.0.0.0.25 ; 0.0.0.0.26
13318 .endd
13319 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13320 IPv4 loopback address only:
13321 .code
13322 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13323 .endd
13324 To specify listening on the default port on specific interfaces only:
13325 .code
13326 local_interfaces = 10.0.0.67 : 192.168.34.67
13327 .endd
13328 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13329
13330
13331
13332 .section "Recognizing the local host" "SECTreclocipadd"
13333 The &%local_interfaces%& option is also used when Exim needs to determine
13334 whether or not an IP address refers to the local host. That is, the IP
13335 addresses of all the interfaces on which a daemon is listening are always
13336 treated as local.
13337
13338 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13339 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13340 available interfaces from the operating system, and extracts the relevant
13341 (that is, IPv4 or IPv6) addresses to use for checking.
13342
13343 Some systems set up large numbers of virtual interfaces in order to provide
13344 many virtual web servers. In this situation, you may want to listen for
13345 email on only a few of the available interfaces, but nevertheless treat all
13346 interfaces as local when routing. You can do this by setting
13347 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13348 &"all"& wildcard values. These addresses are recognized as local, but are not
13349 used for listening. Consider this example:
13350 .code
13351 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13352                       192.168.53.235 ; \
13353                       3ffe:2101:12:1:a00:20ff:fe86:a061
13354
13355 extra_local_interfaces = <; ::0 ; 0.0.0.0
13356 .endd
13357 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13358 address, but all available interface addresses are treated as local when
13359 Exim is routing.
13360
13361 In some environments the local host name may be in an MX list, but with an IP
13362 address that is not assigned to any local interface. In other cases it may be
13363 desirable to treat other host names as if they referred to the local host. Both
13364 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13365 This contains host names rather than IP addresses. When a host is referenced
13366 during routing, either via an MX record or directly, it is treated as the local
13367 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13368 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13369
13370
13371
13372 .section "Delivering to a remote host" "SECID95"
13373 Delivery to a remote host is handled by the smtp transport. By default, it
13374 allows the system's TCP/IP functions to choose which interface to use (if
13375 there is more than one) when connecting to a remote host. However, the
13376 &%interface%& option can be set to specify which interface is used. See the
13377 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13378 details.
13379
13380
13381
13382
13383 . ////////////////////////////////////////////////////////////////////////////
13384 . ////////////////////////////////////////////////////////////////////////////
13385
13386 .chapter "Main configuration" "CHAPmainconfig"
13387 .scindex IIDconfima "configuration file" "main section"
13388 .scindex IIDmaiconf "main configuration"
13389 The first part of the run time configuration file contains three types of item:
13390
13391 .ilist
13392 Macro definitions: These lines start with an upper case letter. See section
13393 &<<SECTmacrodefs>>& for details of macro processing.
13394 .next
13395 Named list definitions: These lines start with one of the words &"domainlist"&,
13396 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13397 section &<<SECTnamedlists>>&.
13398 .next
13399 Main configuration settings: Each setting occupies one line of the file
13400 (with possible continuations). If any setting is preceded by the word
13401 &"hide"&, the &%-bP%& command line option displays its value to admin users
13402 only. See section &<<SECTcos>>& for a description of the syntax of these option
13403 settings.
13404 .endlist
13405
13406 This chapter specifies all the main configuration options, along with their
13407 types and default values. For ease of finding a particular option, they appear
13408 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13409 are now so many options, they are first listed briefly in functional groups, as
13410 an aid to finding the name of the option you are looking for. Some options are
13411 listed in more than one group.
13412
13413 .section "Miscellaneous" "SECID96"
13414 .table2
13415 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13416 .row &%disable_ipv6%&                "do no IPv6 processing"
13417 .row &%keep_malformed%&              "for broken files &-- should not happen"
13418 .row &%localhost_number%&            "for unique message ids in clusters"
13419 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13420 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13421 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13422 .row &%print_topbitchars%&           "top-bit characters are printing"
13423 .row &%timezone%&                    "force time zone"
13424 .endtable
13425
13426
13427 .section "Exim parameters" "SECID97"
13428 .table2
13429 .row &%exim_group%&                  "override compiled-in value"
13430 .row &%exim_path%&                   "override compiled-in value"
13431 .row &%exim_user%&                   "override compiled-in value"
13432 .row &%primary_hostname%&            "default from &[uname()]&"
13433 .row &%split_spool_directory%&       "use multiple directories"
13434 .row &%spool_directory%&             "override compiled-in value"
13435 .endtable
13436
13437
13438
13439 .section "Privilege controls" "SECID98"
13440 .table2
13441 .row &%admin_groups%&                "groups that are Exim admin users"
13442 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13443 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13444 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13445 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13446 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13447 .row &%never_users%&                 "do not run deliveries as these"
13448 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13449 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13450 .row &%trusted_groups%&              "groups that are trusted"
13451 .row &%trusted_users%&               "users that are trusted"
13452 .endtable
13453
13454
13455
13456 .section "Logging" "SECID99"
13457 .table2
13458 .row &%event_action%&                "custom logging"
13459 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13460 .row &%log_file_path%&               "override compiled-in value"
13461 .row &%log_selector%&                "set/unset optional logging"
13462 .row &%log_timezone%&                "add timezone to log lines"
13463 .row &%message_logs%&                "create per-message logs"
13464 .row &%preserve_message_logs%&       "after message completion"
13465 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13466 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13467 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13468 .row &%syslog_facility%&             "set syslog &""facility""& field"
13469 .row &%syslog_processname%&          "set syslog &""ident""& field"
13470 .row &%syslog_timestamp%&            "timestamp syslog lines"
13471 .row &%write_rejectlog%&             "control use of message log"
13472 .endtable
13473
13474
13475
13476 .section "Frozen messages" "SECID100"
13477 .table2
13478 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13479 .row &%freeze_tell%&                 "send message when freezing"
13480 .row &%move_frozen_messages%&        "to another directory"
13481 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13482 .endtable
13483
13484
13485
13486 .section "Data lookups" "SECID101"
13487 .table2
13488 .row &%ibase_servers%&               "InterBase servers"
13489 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13490 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13491 .row &%ldap_cert_file%&              "client cert file for LDAP"
13492 .row &%ldap_cert_key%&               "client key file for LDAP"
13493 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13494 .row &%ldap_default_servers%&        "used if no server in query"
13495 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13496 .row &%ldap_start_tls%&              "require TLS within LDAP"
13497 .row &%ldap_version%&                "set protocol version"
13498 .row &%lookup_open_max%&             "lookup files held open"
13499 .row &%mysql_servers%&               "default MySQL servers"
13500 .row &%oracle_servers%&              "Oracle servers"
13501 .row &%pgsql_servers%&               "default PostgreSQL servers"
13502 .row &%sqlite_lock_timeout%&         "as it says"
13503 .endtable
13504
13505
13506
13507 .section "Message ids" "SECID102"
13508 .table2
13509 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13510 .row &%message_id_header_text%&      "ditto"
13511 .endtable
13512
13513
13514
13515 .section "Embedded Perl Startup" "SECID103"
13516 .table2
13517 .row &%perl_at_start%&               "always start the interpreter"
13518 .row &%perl_startup%&                "code to obey when starting Perl"
13519 .row &%perl_taintmode%&              "enable taint mode in Perl"
13520 .endtable
13521
13522
13523
13524 .section "Daemon" "SECID104"
13525 .table2
13526 .row &%daemon_smtp_ports%&           "default ports"
13527 .row &%daemon_startup_retries%&      "number of times to retry"
13528 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13529 .row &%extra_local_interfaces%&      "not necessarily listened on"
13530 .row &%local_interfaces%&            "on which to listen, with optional ports"
13531 .row &%pid_file_path%&               "override compiled-in value"
13532 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13533 .endtable
13534
13535
13536
13537 .section "Resource control" "SECID105"
13538 .table2
13539 .row &%check_log_inodes%&            "before accepting a message"
13540 .row &%check_log_space%&             "before accepting a message"
13541 .row &%check_spool_inodes%&          "before accepting a message"
13542 .row &%check_spool_space%&           "before accepting a message"
13543 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13544 .row &%queue_only_load%&             "queue incoming if load high"
13545 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13546 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13547 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13548 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13549 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13550 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13551 .row &%smtp_accept_max_per_connection%& "messages per connection"
13552 .row &%smtp_accept_max_per_host%&    "connections from one host"
13553 .row &%smtp_accept_queue%&           "queue mail if more connections"
13554 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13555                                            connection"
13556 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13557 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13558 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13559 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13560 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13561 .endtable
13562
13563
13564
13565 .section "Policy controls" "SECID106"
13566 .table2
13567 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13568 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13569 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13570 .row &%acl_smtp_auth%&               "ACL for AUTH"
13571 .row &%acl_smtp_connect%&            "ACL for connection"
13572 .row &%acl_smtp_data%&               "ACL for DATA"
13573 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13574 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13575 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13576 .row &%acl_smtp_expn%&               "ACL for EXPN"
13577 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13578 .row &%acl_smtp_mail%&               "ACL for MAIL"
13579 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13580 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13581 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13582 .row &%acl_smtp_predata%&            "ACL for start of data"
13583 .row &%acl_smtp_quit%&               "ACL for QUIT"
13584 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13585 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13586 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13587 .row &%av_scanner%&                  "specify virus scanner"
13588 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13589                                       words""&"
13590 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13591 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13592 .row &%header_maxsize%&              "total size of message header"
13593 .row &%header_line_maxsize%&         "individual header line limit"
13594 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13595 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13596 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13597 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13598 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13599 .row &%host_lookup%&                 "host name looked up for these hosts"
13600 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13601 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13602 .row &%host_reject_connection%&      "reject connection from these hosts"
13603 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13604 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13605 .row &%message_size_limit%&          "for all messages"
13606 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13607 .row &%spamd_address%&               "set interface to SpamAssassin"
13608 .row &%strict_acl_vars%&             "object to unset ACL variables"
13609 .endtable
13610
13611
13612
13613 .section "Callout cache" "SECID107"
13614 .table2
13615 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13616                                          item"
13617 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13618                                          item"
13619 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13620 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13621 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13622 .endtable
13623
13624
13625
13626 .section "TLS" "SECID108"
13627 .table2
13628 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13629 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13630 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13631 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13632 .row &%tls_certificate%&             "location of server certificate"
13633 .row &%tls_crl%&                     "certificate revocation list"
13634 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13635 .row &%tls_dhparam%&                 "DH parameters for server"
13636 .row &%tls_eccurve%&                 "EC curve selection for server"
13637 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13638 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13639 .row &%tls_privatekey%&              "location of server private key"
13640 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13641 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13642 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13643 .row &%tls_verify_certificates%&     "expected client certificates"
13644 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13645 .endtable
13646
13647
13648
13649 .section "Local user handling" "SECID109"
13650 .table2
13651 .row &%finduser_retries%&            "useful in NIS environments"
13652 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13653 .row &%gecos_pattern%&               "ditto"
13654 .row &%max_username_length%&         "for systems that truncate"
13655 .row &%unknown_login%&               "used when no login name found"
13656 .row &%unknown_username%&            "ditto"
13657 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13658 .row &%uucp_from_sender%&            "ditto"
13659 .endtable
13660
13661
13662
13663 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13664 .table2
13665 .row &%header_maxsize%&              "total size of message header"
13666 .row &%header_line_maxsize%&         "individual header line limit"
13667 .row &%message_size_limit%&          "applies to all messages"
13668 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13669 .row &%received_header_text%&        "expanded to make &'Received:'&"
13670 .row &%received_headers_max%&        "for mail loop detection"
13671 .row &%recipients_max%&              "limit per message"
13672 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13673 .endtable
13674
13675
13676
13677
13678 .section "Non-SMTP incoming messages" "SECID111"
13679 .table2
13680 .row &%receive_timeout%&             "for non-SMTP messages"
13681 .endtable
13682
13683
13684
13685
13686
13687 .section "Incoming SMTP messages" "SECID112"
13688 See also the &'Policy controls'& section above.
13689
13690 .table2
13691 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13692 .row &%host_lookup%&                 "host name looked up for these hosts"
13693 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13694 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13695 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13696 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13697 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13698 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13699 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13700 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13701 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13702 .row &%smtp_accept_max_per_connection%& "messages per connection"
13703 .row &%smtp_accept_max_per_host%&    "connections from one host"
13704 .row &%smtp_accept_queue%&           "queue mail if more connections"
13705 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13706                                            connection"
13707 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13708 .row &%smtp_active_hostname%&        "host name to use in messages"
13709 .row &%smtp_banner%&                 "text for welcome banner"
13710 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13711 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13712 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13713 .row &%smtp_etrn_command%&           "what to run for ETRN"
13714 .row &%smtp_etrn_serialize%&         "only one at once"
13715 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13716 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13717 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13718 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13719 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13720 .row &%smtp_receive_timeout%&        "per command or data line"
13721 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13722 .row &%smtp_return_error_details%&   "give detail on rejections"
13723 .endtable
13724
13725
13726
13727 .section "SMTP extensions" "SECID113"
13728 .table2
13729 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13730 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13731 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13732 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13733 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13734 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13735 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13736 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13737 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13738 .endtable
13739
13740
13741
13742 .section "Processing messages" "SECID114"
13743 .table2
13744 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13745 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13746 .row &%allow_utf8_domains%&          "in addresses"
13747 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13748                                       words""&"
13749 .row &%delivery_date_remove%&        "from incoming messages"
13750 .row &%envelope_to_remove%&          "from incoming messages"
13751 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13752 .row &%headers_charset%&             "default for translations"
13753 .row &%qualify_domain%&              "default for senders"
13754 .row &%qualify_recipient%&           "default for recipients"
13755 .row &%return_path_remove%&          "from incoming messages"
13756 .row &%strip_excess_angle_brackets%& "in addresses"
13757 .row &%strip_trailing_dot%&          "at end of addresses"
13758 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13759 .endtable
13760
13761
13762
13763 .section "System filter" "SECID115"
13764 .table2
13765 .row &%system_filter%&               "locate system filter"
13766 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13767                                             directory"
13768 .row &%system_filter_file_transport%& "transport for delivery to a file"
13769 .row &%system_filter_group%&         "group for filter running"
13770 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13771 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13772 .row &%system_filter_user%&          "user for filter running"
13773 .endtable
13774
13775
13776
13777 .section "Routing and delivery" "SECID116"
13778 .table2
13779 .row &%disable_ipv6%&                "do no IPv6 processing"
13780 .row &%dns_again_means_nonexist%&    "for broken domains"
13781 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13782 .row &%dns_dnssec_ok%&               "parameter for resolver"
13783 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13784 .row &%dns_retrans%&                 "parameter for resolver"
13785 .row &%dns_retry%&                   "parameter for resolver"
13786 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13787 .row &%dns_use_edns0%&               "parameter for resolver"
13788 .row &%hold_domains%&                "hold delivery for these domains"
13789 .row &%local_interfaces%&            "for routing checks"
13790 .row &%queue_domains%&               "no immediate delivery for these"
13791 .row &%queue_only%&                  "no immediate delivery at all"
13792 .row &%queue_only_file%&             "no immediate delivery if file exists"
13793 .row &%queue_only_load%&             "no immediate delivery if load is high"
13794 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13795 .row &%queue_only_override%&         "allow command line to override"
13796 .row &%queue_run_in_order%&          "order of arrival"
13797 .row &%queue_run_max%&               "of simultaneous queue runners"
13798 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13799 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13800 .row &%remote_sort_domains%&         "order of remote deliveries"
13801 .row &%retry_data_expire%&           "timeout for retry data"
13802 .row &%retry_interval_max%&          "safety net for retry rules"
13803 .endtable
13804
13805
13806
13807 .section "Bounce and warning messages" "SECID117"
13808 .table2
13809 .row &%bounce_message_file%&         "content of bounce"
13810 .row &%bounce_message_text%&         "content of bounce"
13811 .row &%bounce_return_body%&          "include body if returning message"
13812 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13813 .row &%bounce_return_message%&       "include original message in bounce"
13814 .row &%bounce_return_size_limit%&    "limit on returned message"
13815 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13816 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13817 .row &%errors_copy%&                 "copy bounce messages"
13818 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13819 .row &%delay_warning%&               "time schedule"
13820 .row &%delay_warning_condition%&     "condition for warning messages"
13821 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13822 .row &%smtp_return_error_details%&   "give detail on rejections"
13823 .row &%warn_message_file%&           "content of warning message"
13824 .endtable
13825
13826
13827
13828 .section "Alphabetical list of main options" "SECTalomo"
13829 Those options that undergo string expansion before use are marked with
13830 &dagger;.
13831
13832 .option accept_8bitmime main boolean true
13833 .cindex "8BITMIME"
13834 .cindex "8-bit characters"
13835 .cindex "log" "selectors"
13836 .cindex "log" "8BITMIME"
13837 This option causes Exim to send 8BITMIME in its response to an SMTP
13838 EHLO command, and to accept the BODY= parameter on MAIL commands.
13839 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13840 takes no steps to do anything special with messages received by this route.
13841
13842 Historically Exim kept this option off by default, but the maintainers
13843 feel that in today's Internet, this causes more problems than it solves.
13844 It now defaults to true.
13845 A more detailed analysis of the issues is provided by Dan Bernstein:
13846 .display
13847 &url(http://cr.yp.to/smtp/8bitmime.html)
13848 .endd
13849
13850 To log received 8BITMIME status use
13851 .code
13852 log_selector = +8bitmime
13853 .endd
13854
13855 .option acl_not_smtp main string&!! unset
13856 .cindex "&ACL;" "for non-SMTP messages"
13857 .cindex "non-SMTP messages" "ACLs for"
13858 This option defines the ACL that is run when a non-SMTP message has been
13859 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13860 further details.
13861
13862 .option acl_not_smtp_mime main string&!! unset
13863 This option defines the ACL that is run for individual MIME parts of non-SMTP
13864 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13865 SMTP messages.
13866
13867 .option acl_not_smtp_start main string&!! unset
13868 .cindex "&ACL;" "at start of non-SMTP message"
13869 .cindex "non-SMTP messages" "ACLs for"
13870 This option defines the ACL that is run before Exim starts reading a
13871 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13872
13873 .option acl_smtp_auth main string&!! unset
13874 .cindex "&ACL;" "setting up for SMTP commands"
13875 .cindex "AUTH" "ACL for"
13876 This option defines the ACL that is run when an SMTP AUTH command is
13877 received. See chapter &<<CHAPACL>>& for further details.
13878
13879 .option acl_smtp_connect main string&!! unset
13880 .cindex "&ACL;" "on SMTP connection"
13881 This option defines the ACL that is run when an SMTP connection is received.
13882 See chapter &<<CHAPACL>>& for further details.
13883
13884 .option acl_smtp_data main string&!! unset
13885 .cindex "DATA" "ACL for"
13886 This option defines the ACL that is run after an SMTP DATA command has been
13887 processed and the message itself has been received, but before the final
13888 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13889
13890 .option acl_smtp_data_prdr main string&!! accept
13891 .cindex "PRDR" "ACL for"
13892 .cindex "DATA" "PRDR ACL for"
13893 .cindex "&ACL;" "PRDR-related"
13894 .cindex "&ACL;" "per-user data processing"
13895 This option defines the ACL that,
13896 if the PRDR feature has been negotiated,
13897 is run for each recipient after an SMTP DATA command has been
13898 processed and the message itself has been received, but before the
13899 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13900
13901 .option acl_smtp_dkim main string&!! unset
13902 .cindex DKIM "ACL for"
13903 This option defines the ACL that is run for each DKIM signature
13904 of a received message.
13905 See chapter &<<CHAPdkim>>& for further details.
13906
13907 .option acl_smtp_etrn main string&!! unset
13908 .cindex "ETRN" "ACL for"
13909 This option defines the ACL that is run when an SMTP ETRN command is
13910 received. See chapter &<<CHAPACL>>& for further details.
13911
13912 .option acl_smtp_expn main string&!! unset
13913 .cindex "EXPN" "ACL for"
13914 This option defines the ACL that is run when an SMTP EXPN command is
13915 received. See chapter &<<CHAPACL>>& for further details.
13916
13917 .option acl_smtp_helo main string&!! unset
13918 .cindex "EHLO" "ACL for"
13919 .cindex "HELO" "ACL for"
13920 This option defines the ACL that is run when an SMTP EHLO or HELO
13921 command is received. See chapter &<<CHAPACL>>& for further details.
13922
13923
13924 .option acl_smtp_mail main string&!! unset
13925 .cindex "MAIL" "ACL for"
13926 This option defines the ACL that is run when an SMTP MAIL command is
13927 received. See chapter &<<CHAPACL>>& for further details.
13928
13929 .option acl_smtp_mailauth main string&!! unset
13930 .cindex "AUTH" "on MAIL command"
13931 This option defines the ACL that is run when there is an AUTH parameter on
13932 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13933 &<<CHAPSMTPAUTH>>& for details of authentication.
13934
13935 .option acl_smtp_mime main string&!! unset
13936 .cindex "MIME content scanning" "ACL for"
13937 This option is available when Exim is built with the content-scanning
13938 extension. It defines the ACL that is run for each MIME part in a message. See
13939 section &<<SECTscanmimepart>>& for details.
13940
13941 .option acl_smtp_notquit main string&!! unset
13942 .cindex "not-QUIT, ACL for"
13943 This option defines the ACL that is run when an SMTP session
13944 ends without a QUIT command being received.
13945 See chapter &<<CHAPACL>>& for further details.
13946
13947 .option acl_smtp_predata main string&!! unset
13948 This option defines the ACL that is run when an SMTP DATA command is
13949 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13950 further details.
13951
13952 .option acl_smtp_quit main string&!! unset
13953 .cindex "QUIT, ACL for"
13954 This option defines the ACL that is run when an SMTP QUIT command is
13955 received. See chapter &<<CHAPACL>>& for further details.
13956
13957 .option acl_smtp_rcpt main string&!! unset
13958 .cindex "RCPT" "ACL for"
13959 This option defines the ACL that is run when an SMTP RCPT command is
13960 received. See chapter &<<CHAPACL>>& for further details.
13961
13962 .option acl_smtp_starttls main string&!! unset
13963 .cindex "STARTTLS, ACL for"
13964 This option defines the ACL that is run when an SMTP STARTTLS command is
13965 received. See chapter &<<CHAPACL>>& for further details.
13966
13967 .option acl_smtp_vrfy main string&!! unset
13968 .cindex "VRFY" "ACL for"
13969 This option defines the ACL that is run when an SMTP VRFY command is
13970 received. See chapter &<<CHAPACL>>& for further details.
13971
13972 .option add_environment main "string list" empty
13973 .cindex "environment" "set values"
13974 This option allows to set individual environment variables that the
13975 currently linked libraries and programs in child processes use.
13976 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
13977
13978 .option admin_groups main "string list&!!" unset
13979 .cindex "admin user"
13980 This option is expanded just once, at the start of Exim's processing. If the
13981 current group or any of the supplementary groups of an Exim caller is in this
13982 colon-separated list, the caller has admin privileges. If all your system
13983 programmers are in a specific group, for example, you can give them all Exim
13984 admin privileges by putting that group in &%admin_groups%&. However, this does
13985 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13986 To permit this, you have to add individuals to the Exim group.
13987
13988 .option allow_domain_literals main boolean false
13989 .cindex "domain literal"
13990 If this option is set, the RFC 2822 domain literal format is permitted in
13991 email addresses. The option is not set by default, because the domain literal
13992 format is not normally required these days, and few people know about it. It
13993 has, however, been exploited by mail abusers.
13994
13995 Unfortunately, it seems that some DNS black list maintainers are using this
13996 format to report black listing to postmasters. If you want to accept messages
13997 addressed to your hosts by IP address, you need to set
13998 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13999 domains (defined in the named domain list &%local_domains%& in the default
14000 configuration). This &"magic string"& matches the domain literal form of all
14001 the local host's IP addresses.
14002
14003
14004 .option allow_mx_to_ip main boolean false
14005 .cindex "MX record" "pointing to IP address"
14006 It appears that more and more DNS zone administrators are breaking the rules
14007 and putting domain names that look like IP addresses on the right hand side of
14008 MX records. Exim follows the rules and rejects this, giving an error message
14009 that explains the misconfiguration. However, some other MTAs support this
14010 practice, so to avoid &"Why can't Exim do this?"& complaints,
14011 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14012 recommended, except when you have no other choice.
14013
14014 .option allow_utf8_domains main boolean false
14015 .cindex "domain" "UTF-8 characters in"
14016 .cindex "UTF-8" "in domain name"
14017 Lots of discussion is going on about internationalized domain names. One
14018 camp is strongly in favour of just using UTF-8 characters, and it seems
14019 that at least two other MTAs permit this. This option allows Exim users to
14020 experiment if they wish.
14021
14022 If it is set true, Exim's domain parsing function allows valid
14023 UTF-8 multicharacters to appear in domain name components, in addition to
14024 letters, digits, and hyphens. However, just setting this option is not
14025 enough; if you want to look up these domain names in the DNS, you must also
14026 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14027 suitable setting is:
14028 .code
14029 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14030   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14031 .endd
14032 Alternatively, you can just disable this feature by setting
14033 .code
14034 dns_check_names_pattern =
14035 .endd
14036 That is, set the option to an empty string so that no check is done.
14037
14038
14039 .option auth_advertise_hosts main "host list&!!" *
14040 .cindex "authentication" "advertising"
14041 .cindex "AUTH" "advertising"
14042 If any server authentication mechanisms are configured, Exim advertises them in
14043 response to an EHLO command only if the calling host matches this list.
14044 Otherwise, Exim does not advertise AUTH.
14045 Exim does not accept AUTH commands from clients to which it has not
14046 advertised the availability of AUTH. The advertising of individual
14047 authentication mechanisms can be controlled by the use of the
14048 &%server_advertise_condition%& generic authenticator option on the individual
14049 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14050
14051 Certain mail clients (for example, Netscape) require the user to provide a name
14052 and password for authentication if AUTH is advertised, even though it may
14053 not be needed (the host may accept messages from hosts on its local LAN without
14054 authentication, for example). The &%auth_advertise_hosts%& option can be used
14055 to make these clients more friendly by excluding them from the set of hosts to
14056 which Exim advertises AUTH.
14057
14058 .cindex "AUTH" "advertising when encrypted"
14059 If you want to advertise the availability of AUTH only when the connection
14060 is encrypted using TLS, you can make use of the fact that the value of this
14061 option is expanded, with a setting like this:
14062 .code
14063 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14064 .endd
14065 .vindex "&$tls_in_cipher$&"
14066 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14067 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14068 expansion is *, which matches all hosts.
14069
14070
14071 .option auto_thaw main time 0s
14072 .cindex "thawing messages"
14073 .cindex "unfreezing messages"
14074 If this option is set to a time greater than zero, a queue runner will try a
14075 new delivery attempt on any frozen message, other than a bounce message, if
14076 this much time has passed since it was frozen. This may result in the message
14077 being re-frozen if nothing has changed since the last attempt. It is a way of
14078 saying &"keep on trying, even though there are big problems"&.
14079
14080 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14081 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14082 thought to be very useful any more, and its use should probably be avoided.
14083
14084
14085 .option av_scanner main string "see below"
14086 This option is available if Exim is built with the content-scanning extension.
14087 It specifies which anti-virus scanner to use. The default value is:
14088 .code
14089 sophie:/var/run/sophie
14090 .endd
14091 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14092 before use. See section &<<SECTscanvirus>>& for further details.
14093
14094
14095 .option bi_command main string unset
14096 .oindex "&%-bi%&"
14097 This option supplies the name of a command that is run when Exim is called with
14098 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14099 just the command name, it is not a complete command line. If an argument is
14100 required, it must come from the &%-oA%& command line option.
14101
14102
14103 .option bounce_message_file main string unset
14104 .cindex "bounce message" "customizing"
14105 .cindex "customizing" "bounce message"
14106 This option defines a template file containing paragraphs of text to be used
14107 for constructing bounce messages.  Details of the file's contents are given in
14108 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14109
14110
14111 .option bounce_message_text main string unset
14112 When this option is set, its contents are included in the default bounce
14113 message immediately after &"This message was created automatically by mail
14114 delivery software."& It is not used if &%bounce_message_file%& is set.
14115
14116 .option bounce_return_body main boolean true
14117 .cindex "bounce message" "including body"
14118 This option controls whether the body of an incoming message is included in a
14119 bounce message when &%bounce_return_message%& is true. The default setting
14120 causes the entire message, both header and body, to be returned (subject to the
14121 value of &%bounce_return_size_limit%&). If this option is false, only the
14122 message header is included. In the case of a non-SMTP message containing an
14123 error that is detected during reception, only those header lines preceding the
14124 point at which the error was detected are returned.
14125 .cindex "bounce message" "including original"
14126
14127 .option bounce_return_linesize_limit main integer 998
14128 .cindex "size" "of bounce lines, limit"
14129 .cindex "bounce message" "line length limit"
14130 .cindex "limit" "bounce message line length"
14131 This option sets a limit in bytes on the line length of messages
14132 that are returned to senders due to delivery problems,
14133 when &%bounce_return_message%& is true.
14134 The default value corresponds to RFC limits.
14135 If the message being returned has lines longer than this value it is
14136 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14137
14138 The option also applies to bounces returned when an error is detected
14139 during reception of a message.
14140 In this case lines from the original are truncated.
14141
14142 The option does not apply to messages generated by an &(autoreply)& transport.
14143
14144
14145 .option bounce_return_message main boolean true
14146 If this option is set false, none of the original message is included in
14147 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14148 &%bounce_return_body%&.
14149
14150
14151 .option bounce_return_size_limit main integer 100K
14152 .cindex "size" "of bounce, limit"
14153 .cindex "bounce message" "size limit"
14154 .cindex "limit" "bounce message size"
14155 This option sets a limit in bytes on the size of messages that are returned to
14156 senders as part of bounce messages when &%bounce_return_message%& is true. The
14157 limit should be less than the value of the global &%message_size_limit%& and of
14158 any &%message_size_limit%& settings on transports, to allow for the bounce text
14159 that Exim generates. If this option is set to zero there is no limit.
14160
14161 When the body of any message that is to be included in a bounce message is
14162 greater than the limit, it is truncated, and a comment pointing this out is
14163 added at the top. The actual cutoff may be greater than the value given, owing
14164 to the use of buffering for transferring the message in chunks (typically 8K in
14165 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14166 messages.
14167
14168 .option bounce_sender_authentication main string unset
14169 .cindex "bounce message" "sender authentication"
14170 .cindex "authentication" "bounce message"
14171 .cindex "AUTH" "on bounce message"
14172 This option provides an authenticated sender address that is sent with any
14173 bounce messages generated by Exim that are sent over an authenticated SMTP
14174 connection. A typical setting might be:
14175 .code
14176 bounce_sender_authentication = mailer-daemon@my.domain.example
14177 .endd
14178 which would cause bounce messages to be sent using the SMTP command:
14179 .code
14180 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14181 .endd
14182 The value of &%bounce_sender_authentication%& must always be a complete email
14183 address.
14184
14185 .option callout_domain_negative_expire main time 3h
14186 .cindex "caching" "callout timeouts"
14187 .cindex "callout" "caching timeouts"
14188 This option specifies the expiry time for negative callout cache data for a
14189 domain. See section &<<SECTcallver>>& for details of callout verification, and
14190 section &<<SECTcallvercache>>& for details of the caching.
14191
14192
14193 .option callout_domain_positive_expire main time 7d
14194 This option specifies the expiry time for positive callout cache data for a
14195 domain. See section &<<SECTcallver>>& for details of callout verification, and
14196 section &<<SECTcallvercache>>& for details of the caching.
14197
14198
14199 .option callout_negative_expire main time 2h
14200 This option specifies the expiry time for negative callout cache data for an
14201 address. See section &<<SECTcallver>>& for details of callout verification, and
14202 section &<<SECTcallvercache>>& for details of the caching.
14203
14204
14205 .option callout_positive_expire main time 24h
14206 This option specifies the expiry time for positive callout cache data for an
14207 address. See section &<<SECTcallver>>& for details of callout verification, and
14208 section &<<SECTcallvercache>>& for details of the caching.
14209
14210
14211 .option callout_random_local_part main string&!! "see below"
14212 This option defines the &"random"& local part that can be used as part of
14213 callout verification. The default value is
14214 .code
14215 $primary_hostname-$tod_epoch-testing
14216 .endd
14217 See section &<<CALLaddparcall>>& for details of how this value is used.
14218
14219
14220 .option check_log_inodes main integer 0
14221 See &%check_spool_space%& below.
14222
14223
14224 .option check_log_space main integer 0
14225 See &%check_spool_space%& below.
14226
14227 .oindex "&%check_rfc2047_length%&"
14228 .cindex "RFC 2047" "disabling length check"
14229 .option check_rfc2047_length main boolean true
14230 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14231 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14232 word; strings to be encoded that exceed this length are supposed to use
14233 multiple encoded words. By default, Exim does not recognize encoded words that
14234 exceed the maximum length. However, it seems that some software, in violation
14235 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14236 set false, Exim recognizes encoded words of any length.
14237
14238
14239 .option check_spool_inodes main integer 0
14240 See &%check_spool_space%& below.
14241
14242
14243 .option check_spool_space main integer 0
14244 .cindex "checking disk space"
14245 .cindex "disk space, checking"
14246 .cindex "spool directory" "checking space"
14247 The four &%check_...%& options allow for checking of disk resources before a
14248 message is accepted.
14249
14250 .vindex "&$log_inodes$&"
14251 .vindex "&$log_space$&"
14252 .vindex "&$spool_inodes$&"
14253 .vindex "&$spool_space$&"
14254 When any of these options are set, they apply to all incoming messages. If you
14255 want to apply different checks to different kinds of message, you can do so by
14256 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14257 &$spool_space$& in an ACL with appropriate additional conditions.
14258
14259
14260 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14261 either value is greater than zero, for example:
14262 .code
14263 check_spool_space = 10M
14264 check_spool_inodes = 100
14265 .endd
14266 The spool partition is the one that contains the directory defined by
14267 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14268 transit.
14269
14270 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14271 files are written if either is greater than zero. These should be set only if
14272 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14273
14274 If there is less space or fewer inodes than requested, Exim refuses to accept
14275 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14276 error response to the MAIL command. If ESMTP is in use and there was a
14277 SIZE parameter on the MAIL command, its value is added to the
14278 &%check_spool_space%& value, and the check is performed even if
14279 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14280
14281 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14282 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14283
14284 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14285 failure a message is written to stderr and Exim exits with a non-zero code, as
14286 it obviously cannot send an error message of any kind.
14287
14288 .option daemon_smtp_ports main string &`smtp`&
14289 .cindex "port" "for daemon"
14290 .cindex "TCP/IP" "setting listening ports"
14291 This option specifies one or more default SMTP ports on which the Exim daemon
14292 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14293 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14294
14295 .option daemon_startup_retries main integer 9
14296 .cindex "daemon startup, retrying"
14297 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14298 the daemon at startup when it cannot immediately bind a listening socket
14299 (typically because the socket is already in use): &%daemon_startup_retries%&
14300 defines the number of retries after the first failure, and
14301 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14302
14303 .option daemon_startup_sleep main time 30s
14304 See &%daemon_startup_retries%&.
14305
14306 .option delay_warning main "time list" 24h
14307 .cindex "warning of delay"
14308 .cindex "delay warning, specifying"
14309 When a message is delayed, Exim sends a warning message to the sender at
14310 intervals specified by this option. The data is a colon-separated list of times
14311 after which to send warning messages. If the value of the option is an empty
14312 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14313 message has been on the queue for longer than the last time, the last interval
14314 between the times is used to compute subsequent warning times. For example,
14315 with
14316 .code
14317 delay_warning = 4h:8h:24h
14318 .endd
14319 the first message is sent after 4 hours, the second after 8 hours, and
14320 the third one after 24 hours. After that, messages are sent every 16 hours,
14321 because that is the interval between the last two times on the list. If you set
14322 just one time, it specifies the repeat interval. For example, with:
14323 .code
14324 delay_warning = 6h
14325 .endd
14326 messages are repeated every six hours. To stop warnings after a given time, set
14327 a very large time at the end of the list. For example:
14328 .code
14329 delay_warning = 2h:12h:99d
14330 .endd
14331 Note that the option is only evaluated at the time a delivery attempt fails,
14332 which depends on retry and queue-runner configuration.
14333 Typically retries will be configured more frequently than warning messages.
14334
14335 .option delay_warning_condition main string&!! "see below"
14336 .vindex "&$domain$&"
14337 The string is expanded at the time a warning message might be sent. If all the
14338 deferred addresses have the same domain, it is set in &$domain$& during the
14339 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14340 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14341 &"false"& (the comparison being done caselessly) then the warning message is
14342 not sent. The default is:
14343 .code
14344 delay_warning_condition = ${if or {\
14345   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14346   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14347   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14348   } {no}{yes}}
14349 .endd
14350 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14351 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14352 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14353 &"auto-replied"& in an &'Auto-Submitted:'& header.
14354
14355 .option deliver_drop_privilege main boolean false
14356 .cindex "unprivileged delivery"
14357 .cindex "delivery" "unprivileged"
14358 If this option is set true, Exim drops its root privilege at the start of a
14359 delivery process, and runs as the Exim user throughout. This severely restricts
14360 the kinds of local delivery that are possible, but is viable in certain types
14361 of configuration. There is a discussion about the use of root privilege in
14362 chapter &<<CHAPsecurity>>&.
14363
14364 .option deliver_queue_load_max main fixed-point unset
14365 .cindex "load average"
14366 .cindex "queue runner" "abandoning"
14367 When this option is set, a queue run is abandoned if the system load average
14368 becomes greater than the value of the option. The option has no effect on
14369 ancient operating systems on which Exim cannot determine the load average.
14370 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14371
14372
14373 .option delivery_date_remove main boolean true
14374 .cindex "&'Delivery-date:'& header line"
14375 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14376 message when it is delivered, in exactly the same way as &'Return-path:'& is
14377 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14378 should not be present in incoming messages, and this option causes them to be
14379 removed at the time the message is received, to avoid any problems that might
14380 occur when a delivered message is subsequently sent on to some other recipient.
14381
14382 .option disable_fsync main boolean false
14383 .cindex "&[fsync()]&, disabling"
14384 This option is available only if Exim was built with the compile-time option
14385 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14386 a runtime configuration generates an &"unknown option"& error. You should not
14387 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14388 really, really, really understand what you are doing. &'No pre-compiled
14389 distributions of Exim should ever make this option available.'&
14390
14391 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14392 updated files' data to be written to disc before continuing. Unexpected events
14393 such as crashes and power outages may cause data to be lost or scrambled.
14394 Here be Dragons. &*Beware.*&
14395
14396
14397 .option disable_ipv6 main boolean false
14398 .cindex "IPv6" "disabling"
14399 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14400 activities take place. AAAA records are never looked up, and any IPv6 addresses
14401 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14402 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14403 to handle IPv6 literal addresses.
14404
14405
14406 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14407 .cindex DKIM "controlling calls to the ACL"
14408 This option gives a list of DKIM domains for which the DKIM ACL is run.
14409 It is expanded after the message is received; by default it runs
14410 the ACL once for each signature in the message.
14411 See chapter &<<CHAPdkim>>&.
14412
14413
14414 .option dns_again_means_nonexist main "domain list&!!" unset
14415 .cindex "DNS" "&""try again""& response; overriding"
14416 DNS lookups give a &"try again"& response for the DNS errors
14417 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14418 keep trying to deliver a message, or to give repeated temporary errors to
14419 incoming mail. Sometimes the effect is caused by a badly set up name server and
14420 may persist for a long time. If a domain which exhibits this problem matches
14421 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14422 This option should be used with care. You can make it apply to reverse lookups
14423 by a setting such as this:
14424 .code
14425 dns_again_means_nonexist = *.in-addr.arpa
14426 .endd
14427 This option applies to all DNS lookups that Exim does. It also applies when the
14428 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14429 since these are most likely to be caused by DNS lookup problems. The
14430 &(dnslookup)& router has some options of its own for controlling what happens
14431 when lookups for MX or SRV records give temporary errors. These more specific
14432 options are applied after this global option.
14433
14434 .option dns_check_names_pattern main string "see below"
14435 .cindex "DNS" "pre-check of name syntax"
14436 When this option is set to a non-empty string, it causes Exim to check domain
14437 names for characters that are not allowed in host names before handing them to
14438 the DNS resolver, because some resolvers give temporary errors for names that
14439 contain unusual characters. If a domain name contains any unwanted characters,
14440 a &"not found"& result is forced, and the resolver is not called. The check is
14441 done by matching the domain name against a regular expression, which is the
14442 value of this option. The default pattern is
14443 .code
14444 dns_check_names_pattern = \
14445   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14446 .endd
14447 which permits only letters, digits, slashes, and hyphens in components, but
14448 they must start and end with a letter or digit. Slashes are not, in fact,
14449 permitted in host names, but they are found in certain NS records (which can be
14450 accessed in Exim by using a &%dnsdb%& lookup). If you set
14451 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14452 empty string.
14453
14454 .option dns_csa_search_limit main integer 5
14455 This option controls the depth of parental searching for CSA SRV records in the
14456 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14457
14458 .option dns_csa_use_reverse main boolean true
14459 This option controls whether or not an IP address, given as a CSA domain, is
14460 reversed and looked up in the reverse DNS, as described in more detail in
14461 section &<<SECTverifyCSA>>&.
14462
14463
14464 .option dns_dnssec_ok main integer -1
14465 .cindex "DNS" "resolver options"
14466 .cindex "DNS" "DNSSEC"
14467 If this option is set to a non-negative number then Exim will initialise the
14468 DNS resolver library to either use or not use DNSSEC, overriding the system
14469 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14470
14471 If the resolver library does not support DNSSEC then this option has no effect.
14472
14473
14474 .option dns_ipv4_lookup main "domain list&!!" unset
14475 .cindex "IPv6" "DNS lookup for AAAA records"
14476 .cindex "DNS" "IPv6 lookup for AAAA records"
14477 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14478 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14479 (A records) when trying to find IP addresses for hosts, unless the host's
14480 domain matches this list.
14481
14482 This is a fudge to help with name servers that give big delays or otherwise do
14483 not work for the AAAA record type. In due course, when the world's name
14484 servers have all been upgraded, there should be no need for this option.
14485
14486
14487 .option dns_retrans main time 0s
14488 .cindex "DNS" "resolver options"
14489 .cindex timeout "dns lookup"
14490 .cindex "DNS" timeout
14491 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14492 retransmission and retry parameters for DNS lookups. Values of zero (the
14493 defaults) leave the system default settings unchanged. The first value is the
14494 time between retries, and the second is the number of retries. It isn't
14495 totally clear exactly how these settings affect the total time a DNS lookup may
14496 take. I haven't found any documentation about timeouts on DNS lookups; these
14497 parameter values are available in the external resolver interface structure,
14498 but nowhere does it seem to describe how they are used or what you might want
14499 to set in them.
14500 See also the &%slow_lookup_log%& option.
14501
14502
14503 .option dns_retry main integer 0
14504 See &%dns_retrans%& above.
14505
14506
14507 .option dns_trust_aa main "domain list&!!" unset
14508 .cindex "DNS" "resolver options"
14509 .cindex "DNS" "DNSSEC"
14510 If this option is set then lookup results marked with the AA bit
14511 (Authoritative Answer) are trusted the same way as if they were
14512 DNSSEC-verified. The authority section's name of the answer must
14513 match with this expanded domain list.
14514
14515 Use this option only if you talk directly to a resolver that is
14516 authoritative for some zones and does not set the AD (Authentic Data)
14517 bit in the answer. Some DNS servers may have an configuration option to
14518 mark the answers from their own zones as verified (they set the AD bit).
14519 Others do not have this option. It is considered as poor practice using
14520 a resolver that is an authoritative server for some zones.
14521
14522 Use this option only if you really have to (e.g. if you want
14523 to use DANE for remote delivery to a server that is listed in the DNS
14524 zones that your resolver is authoritative for).
14525
14526 If the DNS answer packet has the AA bit set and contains resource record
14527 in the answer section, the name of the first NS record appearing in the
14528 authority section is compared against the list. If the answer packet is
14529 authoritative but the answer section is empty, the name of the first SOA
14530 record in the authoritative section is used instead.
14531
14532 .cindex "DNS" "resolver options"
14533 .option dns_use_edns0 main integer -1
14534 .cindex "DNS" "resolver options"
14535 .cindex "DNS" "EDNS0"
14536 If this option is set to a non-negative number then Exim will initialise the
14537 DNS resolver library to either use or not use EDNS0 extensions, overriding
14538 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14539 on.
14540
14541 If the resolver library does not support EDNS0 then this option has no effect.
14542
14543
14544 .option drop_cr main boolean false
14545 This is an obsolete option that is now a no-op. It used to affect the way Exim
14546 handled CR and LF characters in incoming messages. What happens now is
14547 described in section &<<SECTlineendings>>&.
14548
14549 .option dsn_advertise_hosts main "host list&!!" unset
14550 .cindex "bounce messages" "success"
14551 .cindex "DSN" "success"
14552 .cindex "Delivery Status Notification" "success"
14553 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14554 and accepted from, these hosts.
14555 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14556 and RET and ORCPT options on MAIL FROM commands.
14557 A NOTIFY=SUCCESS option requests success-DSN messages.
14558 A NOTIFY= option with no argument requests that no delay or failure DSNs
14559 are sent.
14560
14561 .option dsn_from main "string&!!" "see below"
14562 .cindex "&'From:'& header line" "in bounces"
14563 .cindex "bounce messages" "&'From:'& line, specifying"
14564 This option can be used to vary the contents of &'From:'& header lines in
14565 bounces and other automatically generated messages (&"Delivery Status
14566 Notifications"& &-- hence the name of the option). The default setting is:
14567 .code
14568 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14569 .endd
14570 The value is expanded every time it is needed. If the expansion fails, a
14571 panic is logged, and the default value is used.
14572
14573 .option envelope_to_remove main boolean true
14574 .cindex "&'Envelope-to:'& header line"
14575 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14576 message when it is delivered, in exactly the same way as &'Return-path:'& is
14577 handled. &'Envelope-to:'& records the original recipient address from the
14578 message's envelope that caused the delivery to happen. Such headers should not
14579 be present in incoming messages, and this option causes them to be removed at
14580 the time the message is received, to avoid any problems that might occur when a
14581 delivered message is subsequently sent on to some other recipient.
14582
14583
14584 .option errors_copy main "string list&!!" unset
14585 .cindex "bounce message" "copy to other address"
14586 .cindex "copy of bounce message"
14587 Setting this option causes Exim to send bcc copies of bounce messages that it
14588 generates to other addresses. &*Note*&: This does not apply to bounce messages
14589 coming from elsewhere. The value of the option is a colon-separated list of
14590 items. Each item consists of a pattern, terminated by white space, followed by
14591 a comma-separated list of email addresses. If a pattern contains spaces, it
14592 must be enclosed in double quotes.
14593
14594 Each pattern is processed in the same way as a single item in an address list
14595 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14596 the bounce message, the message is copied to the addresses on the list. The
14597 items are scanned in order, and once a matching one is found, no further items
14598 are examined. For example:
14599 .code
14600 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14601               rqps@mydomain   hostmaster@mydomain.example,\
14602                               postmaster@mydomain.example
14603 .endd
14604 .vindex "&$domain$&"
14605 .vindex "&$local_part$&"
14606 The address list is expanded before use. The expansion variables &$local_part$&
14607 and &$domain$& are set from the original recipient of the error message, and if
14608 there was any wildcard matching in the pattern, the expansion
14609 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14610 variables &$0$&, &$1$&, etc. are set in the normal way.
14611
14612
14613 .option errors_reply_to main string unset
14614 .cindex "bounce message" "&'Reply-to:'& in"
14615 By default, Exim's bounce and delivery warning messages contain the header line
14616 .display
14617 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14618 .endd
14619 .oindex &%quota_warn_message%&
14620 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14621 A warning message that is generated by the &%quota_warn_message%& option in an
14622 &(appendfile)& transport may contain its own &'From:'& header line that
14623 overrides the default.
14624
14625 Experience shows that people reply to bounce messages. If the
14626 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14627 and warning messages. For example:
14628 .code
14629 errors_reply_to = postmaster@my.domain.example
14630 .endd
14631 The value of the option is not expanded. It must specify a valid RFC 2822
14632 address. However, if a warning message that is generated by the
14633 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14634 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14635 not used.
14636
14637
14638 .option event_action main string&!! unset
14639 .cindex events
14640 This option declares a string to be expanded for Exim's events mechanism.
14641 For details see &<<CHAPevents>>&.
14642
14643
14644 .option exim_group main string "compile-time configured"
14645 .cindex "gid (group id)" "Exim's own"
14646 .cindex "Exim group"
14647 This option changes the gid under which Exim runs when it gives up root
14648 privilege. The default value is compiled into the binary. The value of this
14649 option is used only when &%exim_user%& is also set. Unless it consists entirely
14650 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14651 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14652 security issues.
14653
14654
14655 .option exim_path main string "see below"
14656 .cindex "Exim binary, path name"
14657 This option specifies the path name of the Exim binary, which is used when Exim
14658 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14659 the directory configured at compile time by the BIN_DIRECTORY setting. It
14660 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14661 other place.
14662 &*Warning*&: Do not use a macro to define the value of this option, because
14663 you will break those Exim utilities that scan the configuration file to find
14664 where the binary is. (They then use the &%-bP%& option to extract option
14665 settings such as the value of &%spool_directory%&.)
14666
14667
14668 .option exim_user main string "compile-time configured"
14669 .cindex "uid (user id)" "Exim's own"
14670 .cindex "Exim user"
14671 This option changes the uid under which Exim runs when it gives up root
14672 privilege. The default value is compiled into the binary. Ownership of the run
14673 time configuration file and the use of the &%-C%& and &%-D%& command line
14674 options is checked against the values in the binary, not what is set here.
14675
14676 Unless it consists entirely of digits, the string is looked up using
14677 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14678 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14679 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14680
14681
14682 .option extra_local_interfaces main "string list" unset
14683 This option defines network interfaces that are to be considered local when
14684 routing, but which are not used for listening by the daemon. See section
14685 &<<SECTreclocipadd>>& for details.
14686
14687
14688 . Allow this long option name to split; give it unsplit as a fifth argument
14689 . for the automatic .oindex that is generated by .option.
14690
14691 .option "extract_addresses_remove_arguments" main boolean true &&&
14692          extract_addresses_remove_arguments
14693 .oindex "&%-t%&"
14694 .cindex "command line" "addresses with &%-t%&"
14695 .cindex "Sendmail compatibility" "&%-t%& option"
14696 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14697 are present on the command line when the &%-t%& option is used to build an
14698 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14699 line addresses are removed from the recipients list. This is also how Smail
14700 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14701 command line addresses are added to those obtained from the header lines. When
14702 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14703 argument headers. If it is set false, Exim adds rather than removes argument
14704 addresses.
14705
14706
14707 .option finduser_retries main integer 0
14708 .cindex "NIS, retrying user lookups"
14709 On systems running NIS or other schemes in which user and group information is
14710 distributed from a remote system, there can be times when &[getpwnam()]& and
14711 related functions fail, even when given valid data, because things time out.
14712 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14713 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14714 many extra times to find a user or a group, waiting for one second between
14715 retries.
14716
14717 .cindex "&_/etc/passwd_&" "multiple reading of"
14718 You should not set this option greater than zero if your user information is in
14719 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14720 search the file multiple times for non-existent users, and also cause delay.
14721
14722
14723
14724 .option freeze_tell main "string list, comma separated" unset
14725 .cindex "freezing messages" "sending a message when freezing"
14726 On encountering certain errors, or when configured to do so in a system filter,
14727 ACL, or special router, Exim freezes a message. This means that no further
14728 delivery attempts take place until an administrator thaws the message, or the
14729 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14730 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14731 warning message whenever it freezes something, unless the message it is
14732 freezing is a locally-generated bounce message. (Without this exception there
14733 is the possibility of looping.) The warning message is sent to the addresses
14734 supplied as the comma-separated value of this option. If several of the
14735 message's addresses cause freezing, only a single message is sent. If the
14736 freezing was automatic, the reason(s) for freezing can be found in the message
14737 log. If you configure freezing in a filter or ACL, you must arrange for any
14738 logging that you require.
14739
14740
14741 .option gecos_name main string&!! unset
14742 .cindex "HP-UX"
14743 .cindex "&""gecos""& field, parsing"
14744 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14745 password file to hold other information in addition to users' real names. Exim
14746 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14747 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14748 of the field are used unchanged, except that, if an ampersand is encountered,
14749 it is replaced by the user's login name with the first character forced to
14750 upper case, since this is a convention that is observed on many systems.
14751
14752 When these options are set, &%gecos_pattern%& is treated as a regular
14753 expression that is to be applied to the field (again with && replaced by the
14754 login name), and if it matches, &%gecos_name%& is expanded and used as the
14755 user's name.
14756
14757 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14758 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14759 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14760 name terminates at the first comma, the following can be used:
14761 .code
14762 gecos_pattern = ([^,]*)
14763 gecos_name = $1
14764 .endd
14765
14766 .option gecos_pattern main string unset
14767 See &%gecos_name%& above.
14768
14769
14770 .option gnutls_compat_mode main boolean unset
14771 This option controls whether GnuTLS is used in compatibility mode in an Exim
14772 server. This reduces security slightly, but improves interworking with older
14773 implementations of TLS.
14774
14775
14776 option gnutls_allow_auto_pkcs11 main boolean unset
14777 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14778 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14779
14780 See
14781 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14782 for documentation.
14783
14784
14785
14786 .option headers_charset main string "see below"
14787 This option sets a default character set for translating from encoded MIME
14788 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14789 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14790 ultimate default is ISO-8859-1. For more details see the description of header
14791 insertions in section &<<SECTexpansionitems>>&.
14792
14793
14794
14795 .option header_maxsize main integer "see below"
14796 .cindex "header section" "maximum size of"
14797 .cindex "limit" "size of message header section"
14798 This option controls the overall maximum size of a message's header
14799 section. The default is the value of HEADER_MAXSIZE in
14800 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14801 sections are rejected.
14802
14803
14804 .option header_line_maxsize main integer 0
14805 .cindex "header lines" "maximum size of"
14806 .cindex "limit" "size of one header line"
14807 This option limits the length of any individual header line in a message, after
14808 all the continuations have been joined together. Messages with individual
14809 header lines that are longer than the limit are rejected. The default value of
14810 zero means &"no limit"&.
14811
14812
14813
14814
14815 .option helo_accept_junk_hosts main "host list&!!" unset
14816 .cindex "HELO" "accepting junk data"
14817 .cindex "EHLO" "accepting junk data"
14818 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14819 mail, and gives an error response for invalid data. Unfortunately, there are
14820 some SMTP clients that send syntactic junk. They can be accommodated by setting
14821 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14822 if you want to do semantic checking.
14823 See also &%helo_allow_chars%& for a way of extending the permitted character
14824 set.
14825
14826
14827 .option helo_allow_chars main string unset
14828 .cindex "HELO" "underscores in"
14829 .cindex "EHLO" "underscores in"
14830 .cindex "underscore in EHLO/HELO"
14831 This option can be set to a string of rogue characters that are permitted in
14832 all EHLO and HELO names in addition to the standard letters, digits,
14833 hyphens, and dots. If you really must allow underscores, you can set
14834 .code
14835 helo_allow_chars = _
14836 .endd
14837 Note that the value is one string, not a list.
14838
14839
14840 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14841 .cindex "HELO" "forcing reverse lookup"
14842 .cindex "EHLO" "forcing reverse lookup"
14843 If the domain given by a client in a HELO or EHLO command matches this
14844 list, a reverse lookup is done in order to establish the host's true name. The
14845 default forces a lookup if the client host gives the server's name or any of
14846 its IP addresses (in brackets), something that broken clients have been seen to
14847 do.
14848
14849
14850 .option helo_try_verify_hosts main "host list&!!" unset
14851 .cindex "HELO verifying" "optional"
14852 .cindex "EHLO" "verifying, optional"
14853 By default, Exim just checks the syntax of HELO and EHLO commands (see
14854 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14855 to do more extensive checking of the data supplied by these commands. The ACL
14856 condition &`verify = helo`& is provided to make this possible.
14857 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14858 to force the check to occur. From release 4.53 onwards, this is no longer
14859 necessary. If the check has not been done before &`verify = helo`& is
14860 encountered, it is done at that time. Consequently, this option is obsolete.
14861 Its specification is retained here for backwards compatibility.
14862
14863 When an EHLO or HELO command is received, if the calling host matches
14864 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14865 EHLO command either:
14866
14867 .ilist
14868 is an IP literal matching the calling address of the host, or
14869 .next
14870 .cindex "DNS" "reverse lookup"
14871 .cindex "reverse DNS lookup"
14872 matches the host name that Exim obtains by doing a reverse lookup of the
14873 calling host address, or
14874 .next
14875 when looked up in DNS yields the calling host address.
14876 .endlist
14877
14878 However, the EHLO or HELO command is not rejected if any of the checks
14879 fail. Processing continues, but the result of the check is remembered, and can
14880 be detected later in an ACL by the &`verify = helo`& condition.
14881
14882 If DNS was used for successful verification, the variable
14883 .cindex "DNS" "DNSSEC"
14884 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14885
14886 .option helo_verify_hosts main "host list&!!" unset
14887 .cindex "HELO verifying" "mandatory"
14888 .cindex "EHLO" "verifying, mandatory"
14889 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14890 backwards compatibility. For hosts that match this option, Exim checks the host
14891 name given in the HELO or EHLO in the same way as for
14892 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14893 rejected with a 550 error, and entries are written to the main and reject logs.
14894 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14895 error.
14896
14897 .option hold_domains main "domain list&!!" unset
14898 .cindex "domain" "delaying delivery"
14899 .cindex "delivery" "delaying certain domains"
14900 This option allows mail for particular domains to be held on the queue
14901 manually. The option is overridden if a message delivery is forced with the
14902 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14903 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14904 item in &%hold_domains%&, no routing or delivery for that address is done, and
14905 it is deferred every time the message is looked at.
14906
14907 This option is intended as a temporary operational measure for delaying the
14908 delivery of mail while some problem is being sorted out, or some new
14909 configuration tested. If you just want to delay the processing of some
14910 domains until a queue run occurs, you should use &%queue_domains%& or
14911 &%queue_smtp_domains%&, not &%hold_domains%&.
14912
14913 A setting of &%hold_domains%& does not override Exim's code for removing
14914 messages from the queue if they have been there longer than the longest retry
14915 time in any retry rule. If you want to hold messages for longer than the normal
14916 retry times, insert a dummy retry rule with a long retry time.
14917
14918
14919 .option host_lookup main "host list&!!" unset
14920 .cindex "host name" "lookup, forcing"
14921 Exim does not look up the name of a calling host from its IP address unless it
14922 is required to compare against some host list, or the host matches
14923 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14924 option (which normally contains IP addresses rather than host names). The
14925 default configuration file contains
14926 .code
14927 host_lookup = *
14928 .endd
14929 which causes a lookup to happen for all hosts. If the expense of these lookups
14930 is felt to be too great, the setting can be changed or removed.
14931
14932 After a successful reverse lookup, Exim does a forward lookup on the name it
14933 has obtained, to verify that it yields the IP address that it started with. If
14934 this check fails, Exim behaves as if the name lookup failed.
14935
14936 .vindex "&$host_lookup_failed$&"
14937 .vindex "&$sender_host_name$&"
14938 After any kind of failure, the host name (in &$sender_host_name$&) remains
14939 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14940 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14941 &`verify = reverse_host_lookup`& in ACLs.
14942
14943
14944 .option host_lookup_order main "string list" &`bydns:byaddr`&
14945 This option specifies the order of different lookup methods when Exim is trying
14946 to find a host name from an IP address. The default is to do a DNS lookup
14947 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14948 if that fails. You can change the order of these lookups, or omit one entirely,
14949 if you want.
14950
14951 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14952 multiple PTR records in the DNS and the IP address is not listed in
14953 &_/etc/hosts_&. Different operating systems give different results in this
14954 case. That is why the default tries a DNS lookup first.
14955
14956
14957
14958 .option host_reject_connection main "host list&!!" unset
14959 .cindex "host" "rejecting connections from"
14960 If this option is set, incoming SMTP calls from the hosts listed are rejected
14961 as soon as the connection is made.
14962 This option is obsolete, and retained only for backward compatibility, because
14963 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14964 connections immediately.
14965
14966 The ability to give an immediate rejection (either by this option or using an
14967 ACL) is provided for use in unusual cases. Many hosts will just try again,
14968 sometimes without much delay. Normally, it is better to use an ACL to reject
14969 incoming messages at a later stage, such as after RCPT commands. See
14970 chapter &<<CHAPACL>>&.
14971
14972
14973 .option hosts_connection_nolog main "host list&!!" unset
14974 .cindex "host" "not logging connections from"
14975 This option defines a list of hosts for which connection logging does not
14976 happen, even though the &%smtp_connection%& log selector is set. For example,
14977 you might want not to log SMTP connections from local processes, or from
14978 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14979 the daemon; you should therefore strive to restrict its value to a short inline
14980 list of IP addresses and networks. To disable logging SMTP connections from
14981 local processes, you must create a host list with an empty item. For example:
14982 .code
14983 hosts_connection_nolog = :
14984 .endd
14985 If the &%smtp_connection%& log selector is not set, this option has no effect.
14986
14987
14988
14989 .option hosts_proxy main "host list&!!" unset
14990 .cindex proxy "proxy protocol"
14991 This option enables use of Proxy Protocol proxies for incoming
14992 connections.  For details see &<<SECTproxyInbound>>&.
14993
14994
14995 .option hosts_treat_as_local main "domain list&!!" unset
14996 .cindex "local host" "domains treated as"
14997 .cindex "host" "treated as local"
14998 If this option is set, any host names that match the domain list are treated as
14999 if they were the local host when Exim is scanning host lists obtained from MX
15000 records
15001 or other sources. Note that the value of this option is a domain list, not a
15002 host list, because it is always used to check host names, not IP addresses.
15003
15004 This option also applies when Exim is matching the special items
15005 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15006 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15007 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15008 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15009 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15010 interfaces and recognizing the local host.
15011
15012
15013 .option ibase_servers main "string list" unset
15014 .cindex "InterBase" "server list"
15015 This option provides a list of InterBase servers and associated connection data,
15016 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15017 The option is available only if Exim has been built with InterBase support.
15018
15019
15020
15021 .option ignore_bounce_errors_after main time 10w
15022 .cindex "bounce message" "discarding"
15023 .cindex "discarding bounce message"
15024 This option affects the processing of bounce messages that cannot be delivered,
15025 that is, those that suffer a permanent delivery failure. (Bounce messages that
15026 suffer temporary delivery failures are of course retried in the usual way.)
15027
15028 After a permanent delivery failure, bounce messages are frozen,
15029 because there is no sender to whom they can be returned. When a frozen bounce
15030 message has been on the queue for more than the given time, it is unfrozen at
15031 the next queue run, and a further delivery is attempted. If delivery fails
15032 again, the bounce message is discarded. This makes it possible to keep failed
15033 bounce messages around for a shorter time than the normal maximum retry time
15034 for frozen messages. For example,
15035 .code
15036 ignore_bounce_errors_after = 12h
15037 .endd
15038 retries failed bounce message deliveries after 12 hours, discarding any further
15039 failures. If the value of this option is set to a zero time period, bounce
15040 failures are discarded immediately. Setting a very long time (as in the default
15041 value) has the effect of disabling this option. For ways of automatically
15042 dealing with other kinds of frozen message, see &%auto_thaw%& and
15043 &%timeout_frozen_after%&.
15044
15045
15046 .option ignore_fromline_hosts main "host list&!!" unset
15047 .cindex "&""From""& line"
15048 .cindex "UUCP" "&""From""& line"
15049 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15050 the headers of a message. By default this is treated as the start of the
15051 message's body, which means that any following headers are not recognized as
15052 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15053 match those hosts that insist on sending it. If the sender is actually a local
15054 process rather than a remote host, and is using &%-bs%& to inject the messages,
15055 &%ignore_fromline_local%& must be set to achieve this effect.
15056
15057
15058 .option ignore_fromline_local main boolean false
15059 See &%ignore_fromline_hosts%& above.
15060
15061 .option keep_environment main "string list" unset
15062 .cindex "environment" "values from"
15063 This option contains a string list of environment variables to keep.
15064 You have to trust these variables or you have to be sure that
15065 these variables do not impose any security risk. Keep in mind that
15066 during the startup phase Exim is running with an effective UID 0 in most
15067 installations. As the default value is an empty list, the default
15068 environment for using libraries, running embedded Perl code, or running
15069 external binaries is empty, and does not not even contain PATH or HOME.
15070
15071 Actually the list is interpreted as a list of patterns
15072 (&<<SECTlistexpand>>&), except that it is not expanded first.
15073
15074 WARNING: Macro substitution is still done first, so having a macro
15075 FOO and having FOO_HOME in your &%keep_environment%& option may have
15076 unexpected results. You may work around this using a regular expression
15077 that does not match the macro name: ^[F]OO_HOME$.
15078
15079 Current versions of Exim issue a warning during startup if you do not mention
15080 &%keep_environment%& in your runtime configuration file and if your
15081 current environment is not empty. Future versions may not issue that warning
15082 anymore.
15083
15084 See the &%add_environment%& main config option for a way to set
15085 environment variables to a fixed value.  The environment for &(pipe)&
15086 transports is handled separately, see section &<<SECTpipeenv>>& for
15087 details.
15088
15089
15090 .option keep_malformed main time 4d
15091 This option specifies the length of time to keep messages whose spool files
15092 have been corrupted in some way. This should, of course, never happen. At the
15093 next attempt to deliver such a message, it gets removed. The incident is
15094 logged.
15095
15096
15097 .option ldap_ca_cert_dir main string unset
15098 .cindex "LDAP", "TLS CA certificate directory"
15099 .cindex certificate "directory for LDAP"
15100 This option indicates which directory contains CA certificates for verifying
15101 a TLS certificate presented by an LDAP server.
15102 While Exim does not provide a default value, your SSL library may.
15103 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15104 and constrained to be a directory.
15105
15106
15107 .option ldap_ca_cert_file main string unset
15108 .cindex "LDAP", "TLS CA certificate file"
15109 .cindex certificate "file for LDAP"
15110 This option indicates which file contains CA certificates for verifying
15111 a TLS certificate presented by an LDAP server.
15112 While Exim does not provide a default value, your SSL library may.
15113 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15114 and constrained to be a file.
15115
15116
15117 .option ldap_cert_file main string unset
15118 .cindex "LDAP" "TLS client certificate file"
15119 .cindex certificate "file for LDAP"
15120 This option indicates which file contains an TLS client certificate which
15121 Exim should present to the LDAP server during TLS negotiation.
15122 Should be used together with &%ldap_cert_key%&.
15123
15124
15125 .option ldap_cert_key main string unset
15126 .cindex "LDAP" "TLS client key file"
15127 .cindex certificate "key for LDAP"
15128 This option indicates which file contains the secret/private key to use
15129 to prove identity to the LDAP server during TLS negotiation.
15130 Should be used together with &%ldap_cert_file%&, which contains the
15131 identity to be proven.
15132
15133
15134 .option ldap_cipher_suite main string unset
15135 .cindex "LDAP" "TLS cipher suite"
15136 This controls the TLS cipher-suite negotiation during TLS negotiation with
15137 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15138 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15139
15140
15141 .option ldap_default_servers main "string list" unset
15142 .cindex "LDAP" "default servers"
15143 This option provides a list of LDAP servers which are tried in turn when an
15144 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15145 details of LDAP queries. This option is available only when Exim has been built
15146 with LDAP support.
15147
15148
15149 .option ldap_require_cert main string unset.
15150 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15151 This should be one of the values "hard", "demand", "allow", "try" or "never".
15152 A value other than one of these is interpreted as "never".
15153 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15154 Although Exim does not set a default, the LDAP library probably defaults
15155 to hard/demand.
15156
15157
15158 .option ldap_start_tls main boolean false
15159 .cindex "LDAP" "whether or not to negotiate TLS"
15160 If set, Exim will attempt to negotiate TLS with the LDAP server when
15161 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15162 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15163 of SSL-on-connect.
15164 In the event of failure to negotiate TLS, the action taken is controlled
15165 by &%ldap_require_cert%&.
15166
15167
15168 .option ldap_version main integer unset
15169 .cindex "LDAP" "protocol version, forcing"
15170 This option can be used to force Exim to set a specific protocol version for
15171 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15172 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15173 the LDAP headers; otherwise it is 2. This option is available only when Exim
15174 has been built with LDAP support.
15175
15176
15177
15178 .option local_from_check main boolean true
15179 .cindex "&'Sender:'& header line" "disabling addition of"
15180 .cindex "&'From:'& header line" "disabling checking of"
15181 When a message is submitted locally (that is, not over a TCP/IP connection) by
15182 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15183 checks that the &'From:'& header line matches the login of the calling user and
15184 the domain specified by &%qualify_domain%&.
15185
15186 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15187 locally submitted message is automatically qualified by Exim, unless the
15188 &%-bnq%& command line option is used.
15189
15190 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15191 on the local part. If the &'From:'& header line does not match, Exim adds a
15192 &'Sender:'& header with an address constructed from the calling user's login
15193 and the default qualify domain.
15194
15195 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15196 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15197 &'Sender:'& header lines supplied by untrusted users, you must also set
15198 &%local_sender_retain%& to be true.
15199
15200 .cindex "envelope sender"
15201 These options affect only the header lines in the message. The envelope sender
15202 is still forced to be the login id at the qualify domain unless
15203 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15204
15205 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15206 request similar header line checking. See section &<<SECTthesenhea>>&, which
15207 has more details about &'Sender:'& processing.
15208
15209
15210
15211
15212 .option local_from_prefix main string unset
15213 When Exim checks the &'From:'& header line of locally submitted messages for
15214 matching the login id (see &%local_from_check%& above), it can be configured to
15215 ignore certain prefixes and suffixes in the local part of the address. This is
15216 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15217 appropriate lists, in the same form as the &%local_part_prefix%& and
15218 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15219 example, if
15220 .code
15221 local_from_prefix = *-
15222 .endd
15223 is set, a &'From:'& line containing
15224 .code
15225 From: anything-user@your.domain.example
15226 .endd
15227 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15228 matches the actual sender address that is constructed from the login name and
15229 qualify domain.
15230
15231
15232 .option local_from_suffix main string unset
15233 See &%local_from_prefix%& above.
15234
15235
15236 .option local_interfaces main "string list" "see below"
15237 This option controls which network interfaces are used by the daemon for
15238 listening; they are also used to identify the local host when routing. Chapter
15239 &<<CHAPinterfaces>>& contains a full description of this option and the related
15240 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15241 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15242 &%local_interfaces%& is
15243 .code
15244 local_interfaces = 0.0.0.0
15245 .endd
15246 when Exim is built without IPv6 support; otherwise it is
15247 .code
15248 local_interfaces = <; ::0 ; 0.0.0.0
15249 .endd
15250
15251 .option local_scan_timeout main time 5m
15252 .cindex "timeout" "for &[local_scan()]& function"
15253 .cindex "&[local_scan()]& function" "timeout"
15254 This timeout applies to the &[local_scan()]& function (see chapter
15255 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15256 the incoming message is rejected with a temporary error if it is an SMTP
15257 message. For a non-SMTP message, the message is dropped and Exim ends with a
15258 non-zero code. The incident is logged on the main and reject logs.
15259
15260
15261
15262 .option local_sender_retain main boolean false
15263 .cindex "&'Sender:'& header line" "retaining from local submission"
15264 When a message is submitted locally (that is, not over a TCP/IP connection) by
15265 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15266 do not want this to happen, you must set &%local_sender_retain%&, and you must
15267 also set &%local_from_check%& to be false (Exim will complain if you do not).
15268 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15269 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15270
15271
15272
15273
15274 .option localhost_number main string&!! unset
15275 .cindex "host" "locally unique number for"
15276 .cindex "message ids" "with multiple hosts"
15277 .vindex "&$localhost_number$&"
15278 Exim's message ids are normally unique only within the local host. If
15279 uniqueness among a set of hosts is required, each host must set a different
15280 value for the &%localhost_number%& option. The string is expanded immediately
15281 after reading the configuration file (so that a number can be computed from the
15282 host name, for example) and the result of the expansion must be a number in the
15283 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15284 systems). This is available in subsequent string expansions via the variable
15285 &$localhost_number$&. When &%localhost_number is set%&, the final two
15286 characters of the message id, instead of just being a fractional part of the
15287 time, are computed from the time and the local host number as described in
15288 section &<<SECTmessiden>>&.
15289
15290
15291
15292 .option log_file_path main "string list&!!" "set at compile time"
15293 .cindex "log" "file path for"
15294 This option sets the path which is used to determine the names of Exim's log
15295 files, or indicates that logging is to be to syslog, or both. It is expanded
15296 when Exim is entered, so it can, for example, contain a reference to the host
15297 name. If no specific path is set for the log files at compile or run time,
15298 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15299 they are written in a sub-directory called &_log_& in Exim's spool directory.
15300 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15301 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15302 used. If this string is fixed at your installation (contains no expansion
15303 variables) it is recommended that you do not set this option in the
15304 configuration file, but instead supply the path using LOG_FILE_PATH in
15305 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15306 early on &-- in particular, failure to read the configuration file.
15307
15308
15309 .option log_selector main string unset
15310 .cindex "log" "selectors"
15311 This option can be used to reduce or increase the number of things that Exim
15312 writes to its log files. Its argument is made up of names preceded by plus or
15313 minus characters. For example:
15314 .code
15315 log_selector = +arguments -retry_defer
15316 .endd
15317 A list of possible names and what they control is given in the chapter on
15318 logging, in section &<<SECTlogselector>>&.
15319
15320
15321 .option log_timezone main boolean false
15322 .cindex "log" "timezone for entries"
15323 .vindex "&$tod_log$&"
15324 .vindex "&$tod_zone$&"
15325 By default, the timestamps on log lines are in local time without the
15326 timezone. This means that if your timezone changes twice a year, the timestamps
15327 in log lines are ambiguous for an hour when the clocks go back. One way of
15328 avoiding this problem is to set the timezone to UTC. An alternative is to set
15329 &%log_timezone%& true. This turns on the addition of the timezone offset to
15330 timestamps in log lines. Turning on this option can add quite a lot to the size
15331 of log files because each line is extended by 6 characters. Note that the
15332 &$tod_log$& variable contains the log timestamp without the zone, but there is
15333 another variable called &$tod_zone$& that contains just the timezone offset.
15334
15335
15336 .option lookup_open_max main integer 25
15337 .cindex "too many open files"
15338 .cindex "open files, too many"
15339 .cindex "file" "too many open"
15340 .cindex "lookup" "maximum open files"
15341 .cindex "limit" "open files for lookups"
15342 This option limits the number of simultaneously open files for single-key
15343 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15344 Exim normally keeps these files open during routing, because often the same
15345 file is required several times. If the limit is reached, Exim closes the least
15346 recently used file. Note that if you are using the &'ndbm'& library, it
15347 actually opens two files for each logical DBM database, though it still counts
15348 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15349 open files"& errors with NDBM, you need to reduce the value of
15350 &%lookup_open_max%&.
15351
15352
15353 .option max_username_length main integer 0
15354 .cindex "length of login name"
15355 .cindex "user name" "maximum length"
15356 .cindex "limit" "user name length"
15357 Some operating systems are broken in that they truncate long arguments to
15358 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15359 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15360 an argument that is longer behaves as if &[getpwnam()]& failed.
15361
15362
15363 .option message_body_newlines main bool false
15364 .cindex "message body" "newlines in variables"
15365 .cindex "newline" "in message body variables"
15366 .vindex "&$message_body$&"
15367 .vindex "&$message_body_end$&"
15368 By default, newlines in the message body are replaced by spaces when setting
15369 the &$message_body$& and &$message_body_end$& expansion variables. If this
15370 option is set true, this no longer happens.
15371
15372
15373 .option message_body_visible main integer 500
15374 .cindex "body of message" "visible size"
15375 .cindex "message body" "visible size"
15376 .vindex "&$message_body$&"
15377 .vindex "&$message_body_end$&"
15378 This option specifies how much of a message's body is to be included in the
15379 &$message_body$& and &$message_body_end$& expansion variables.
15380
15381
15382 .option message_id_header_domain main string&!! unset
15383 .cindex "&'Message-ID:'& header line"
15384 If this option is set, the string is expanded and used as the right hand side
15385 (domain) of the &'Message-ID:'& header that Exim creates if a
15386 locally-originated incoming message does not have one. &"Locally-originated"&
15387 means &"not received over TCP/IP."&
15388 Otherwise, the primary host name is used.
15389 Only letters, digits, dot and hyphen are accepted; any other characters are
15390 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15391 empty string, the option is ignored.
15392
15393
15394 .option message_id_header_text main string&!! unset
15395 If this variable is set, the string is expanded and used to augment the text of
15396 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15397 message does not have one. The text of this header is required by RFC 2822 to
15398 take the form of an address. By default, Exim uses its internal message id as
15399 the local part, and the primary host name as the domain. If this option is set,
15400 it is expanded, and provided the expansion is not forced to fail, and does not
15401 yield an empty string, the result is inserted into the header immediately
15402 before the @, separated from the internal message id by a dot. Any characters
15403 that are illegal in an address are automatically converted into hyphens. This
15404 means that variables such as &$tod_log$& can be used, because the spaces and
15405 colons will become hyphens.
15406
15407
15408 .option message_logs main boolean true
15409 .cindex "message logs" "disabling"
15410 .cindex "log" "message log; disabling"
15411 If this option is turned off, per-message log files are not created in the
15412 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15413 Exim, by reducing the number of files involved in handling a message from a
15414 minimum of four (header spool file, body spool file, delivery journal, and
15415 per-message log) to three. The other major I/O activity is Exim's main log,
15416 which is not affected by this option.
15417
15418
15419 .option message_size_limit main string&!! 50M
15420 .cindex "message" "size limit"
15421 .cindex "limit" "message size"
15422 .cindex "size" "of message, limit"
15423 This option limits the maximum size of message that Exim will process. The
15424 value is expanded for each incoming connection so, for example, it can be made
15425 to depend on the IP address of the remote host for messages arriving via
15426 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15427 optionally followed by K or M.
15428
15429 &*Note*&: This limit cannot be made to depend on a message's sender or any
15430 other properties of an individual message, because it has to be advertised in
15431 the server's response to EHLO. String expansion failure causes a temporary
15432 error. A value of zero means no limit, but its use is not recommended. See also
15433 &%bounce_return_size_limit%&.
15434
15435 Incoming SMTP messages are failed with a 552 error if the limit is
15436 exceeded; locally-generated messages either get a stderr message or a delivery
15437 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15438 an oversized message is logged in both the main and the reject logs. See also
15439 the generic transport option &%message_size_limit%&, which limits the size of
15440 message that an individual transport can process.
15441
15442 If you use a virus-scanner and set this option to to a value larger than the
15443 maximum size that your virus-scanner is configured to support, you may get
15444 failures triggered by large mails.  The right size to configure for the
15445 virus-scanner depends upon what data is passed and the options in use but it's
15446 probably safest to just set it to a little larger than this value.  E.g., with a
15447 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15448 some problems may result.
15449
15450 A value of 0 will disable size limit checking; Exim will still advertise the
15451 SIZE extension in an EHLO response, but without a limit, so as to permit
15452 SMTP clients to still indicate the message size along with the MAIL verb.
15453
15454
15455 .option move_frozen_messages main boolean false
15456 .cindex "frozen messages" "moving"
15457 This option, which is available only if Exim has been built with the setting
15458 .code
15459 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15460 .endd
15461 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15462 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15463 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15464 standard utilities for handling such moved messages, and they do not show up in
15465 lists generated by &%-bp%& or by the Exim monitor.
15466
15467
15468 .option mua_wrapper main boolean false
15469 Setting this option true causes Exim to run in a very restrictive mode in which
15470 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15471 contains a full description of this facility.
15472
15473
15474
15475 .option mysql_servers main "string list" unset
15476 .cindex "MySQL" "server list"
15477 This option provides a list of MySQL servers and associated connection data, to
15478 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15479 option is available only if Exim has been built with MySQL support.
15480
15481
15482 .option never_users main "string list&!!" unset
15483 This option is expanded just once, at the start of Exim's processing. Local
15484 message deliveries are normally run in processes that are setuid to the
15485 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15486 It is usually desirable to prevent any deliveries from running as root, as a
15487 safety precaution.
15488
15489 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15490 list of users that must not be used for local deliveries. This list is fixed in
15491 the binary and cannot be overridden by the configuration file. By default, it
15492 contains just the single user name &"root"&. The &%never_users%& runtime option
15493 can be used to add more users to the fixed list.
15494
15495 If a message is to be delivered as one of the users on the fixed list or the
15496 &%never_users%& list, an error occurs, and delivery is deferred. A common
15497 example is
15498 .code
15499 never_users = root:daemon:bin
15500 .endd
15501 Including root is redundant if it is also on the fixed list, but it does no
15502 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15503 transport driver.
15504
15505
15506 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15507 .cindex "OpenSSL "compatibility options"
15508 This option allows an administrator to adjust the SSL options applied
15509 by OpenSSL to connections.  It is given as a space-separated list of items,
15510 each one to be +added or -subtracted from the current value.
15511
15512 This option is only available if Exim is built against OpenSSL.  The values
15513 available for this option vary according to the age of your OpenSSL install.
15514 The &"all"& value controls a subset of flags which are available, typically
15515 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15516 list the values known on your system and Exim should support all the
15517 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15518 names lose the leading &"SSL_OP_"& and are lower-cased.
15519
15520 Note that adjusting the options can have severe impact upon the security of
15521 SSL as used by Exim.  It is possible to disable safety checks and shoot
15522 yourself in the foot in various unpleasant ways.  This option should not be
15523 adjusted lightly.  An unrecognised item will be detected at startup, by
15524 invoking Exim with the &%-bV%& flag.
15525
15526 The option affects Exim operating both as a server and as a client.
15527
15528 Historical note: prior to release 4.80, Exim defaulted this value to
15529 "+dont_insert_empty_fragments", which may still be needed for compatibility
15530 with some clients, but which lowers security by increasing exposure to
15531 some now infamous attacks.
15532
15533 Examples:
15534 .code
15535 # Make both old MS and old Eudora happy:
15536 openssl_options = -all +microsoft_big_sslv3_buffer \
15537                        +dont_insert_empty_fragments
15538
15539 # Disable older protocol versions:
15540 openssl_options = +no_sslv2 +no_sslv3
15541 .endd
15542
15543 Possible options may include:
15544 .ilist
15545 &`all`&
15546 .next
15547 &`allow_unsafe_legacy_renegotiation`&
15548 .next
15549 &`cipher_server_preference`&
15550 .next
15551 &`dont_insert_empty_fragments`&
15552 .next
15553 &`ephemeral_rsa`&
15554 .next
15555 &`legacy_server_connect`&
15556 .next
15557 &`microsoft_big_sslv3_buffer`&
15558 .next
15559 &`microsoft_sess_id_bug`&
15560 .next
15561 &`msie_sslv2_rsa_padding`&
15562 .next
15563 &`netscape_challenge_bug`&
15564 .next
15565 &`netscape_reuse_cipher_change_bug`&
15566 .next
15567 &`no_compression`&
15568 .next
15569 &`no_session_resumption_on_renegotiation`&
15570 .next
15571 &`no_sslv2`&
15572 .next
15573 &`no_sslv3`&
15574 .next
15575 &`no_ticket`&
15576 .next
15577 &`no_tlsv1`&
15578 .next
15579 &`no_tlsv1_1`&
15580 .next
15581 &`no_tlsv1_2`&
15582 .next
15583 &`safari_ecdhe_ecdsa_bug`&
15584 .next
15585 &`single_dh_use`&
15586 .next
15587 &`single_ecdh_use`&
15588 .next
15589 &`ssleay_080_client_dh_bug`&
15590 .next
15591 &`sslref2_reuse_cert_type_bug`&
15592 .next
15593 &`tls_block_padding_bug`&
15594 .next
15595 &`tls_d5_bug`&
15596 .next
15597 &`tls_rollback_bug`&
15598 .endlist
15599
15600 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15601 all clients connecting using the MacOS SecureTransport TLS facility prior
15602 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15603 to negotiate TLS then this option value might help, provided that your OpenSSL
15604 release is new enough to contain this work-around.  This may be a situation
15605 where you have to upgrade OpenSSL to get buggy clients working.
15606
15607
15608 .option oracle_servers main "string list" unset
15609 .cindex "Oracle" "server list"
15610 This option provides a list of Oracle servers and associated connection data,
15611 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15612 The option is available only if Exim has been built with Oracle support.
15613
15614
15615 .option percent_hack_domains main "domain list&!!" unset
15616 .cindex "&""percent hack""&"
15617 .cindex "source routing" "in email address"
15618 .cindex "address" "source-routed"
15619 The &"percent hack"& is the convention whereby a local part containing a
15620 percent sign is re-interpreted as a new email address, with the percent
15621 replaced by @. This is sometimes called &"source routing"&, though that term is
15622 also applied to RFC 2822 addresses that begin with an @ character. If this
15623 option is set, Exim implements the percent facility for those domains listed,
15624 but no others. This happens before an incoming SMTP address is tested against
15625 an ACL.
15626
15627 &*Warning*&: The &"percent hack"& has often been abused by people who are
15628 trying to get round relaying restrictions. For this reason, it is best avoided
15629 if at all possible. Unfortunately, a number of less security-conscious MTAs
15630 implement it unconditionally. If you are running Exim on a gateway host, and
15631 routing mail through to internal MTAs without processing the local parts, it is
15632 a good idea to reject recipient addresses with percent characters in their
15633 local parts. Exim's default configuration does this.
15634
15635
15636 .option perl_at_start main boolean false
15637 .cindex "Perl"
15638 This option is available only when Exim is built with an embedded Perl
15639 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15640
15641
15642 .option perl_startup main string unset
15643 .cindex "Perl"
15644 This option is available only when Exim is built with an embedded Perl
15645 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15646
15647 .option perl_startup main boolean false
15648 .cindex "Perl"
15649 This Option enables the taint mode of the embedded Perl interpreter.
15650
15651
15652 .option pgsql_servers main "string list" unset
15653 .cindex "PostgreSQL lookup type" "server list"
15654 This option provides a list of PostgreSQL servers and associated connection
15655 data, to be used in conjunction with &(pgsql)& lookups (see section
15656 &<<SECID72>>&). The option is available only if Exim has been built with
15657 PostgreSQL support.
15658
15659
15660 .option pid_file_path main string&!! "set at compile time"
15661 .cindex "daemon" "pid file path"
15662 .cindex "pid file, path for"
15663 This option sets the name of the file to which the Exim daemon writes its
15664 process id. The string is expanded, so it can contain, for example, references
15665 to the host name:
15666 .code
15667 pid_file_path = /var/log/$primary_hostname/exim.pid
15668 .endd
15669 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15670 spool directory.
15671 The value set by the option can be overridden by the &%-oP%& command line
15672 option. A pid file is not written if a &"non-standard"& daemon is run by means
15673 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15674
15675
15676 .option pipelining_advertise_hosts main "host list&!!" *
15677 .cindex "PIPELINING" "suppressing advertising"
15678 This option can be used to suppress the advertisement of the SMTP
15679 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15680 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15681 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15682 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15683 that clients will use it; &"out of order"& commands that are &"expected"& do
15684 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15685
15686
15687 .option prdr_enable main boolean false
15688 .cindex "PRDR" "enabling on server"
15689 This option can be used to enable the Per-Recipient Data Response extension
15690 to SMTP, defined by Eric Hall.
15691 If the option is set, PRDR is advertised by Exim when operating as a server.
15692 If the client requests PRDR, and more than one recipient, for a message
15693 an additional ACL is called for each recipient after the message content
15694 is received.  See section &<<SECTPRDRACL>>&.
15695
15696 .option preserve_message_logs main boolean false
15697 .cindex "message logs" "preserving"
15698 If this option is set, message log files are not deleted when messages are
15699 completed. Instead, they are moved to a sub-directory of the spool directory
15700 called &_msglog.OLD_&, where they remain available for statistical or debugging
15701 purposes. This is a dangerous option to set on systems with any appreciable
15702 volume of mail. Use with care!
15703
15704
15705 .option primary_hostname main string "see below"
15706 .cindex "name" "of local host"
15707 .cindex "host" "name of local"
15708 .cindex "local host" "name of"
15709 .vindex "&$primary_hostname$&"
15710 This specifies the name of the current host. It is used in the default EHLO or
15711 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15712 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15713 The value is also used by default in some SMTP response messages from an Exim
15714 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15715
15716 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15717 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15718 contains only one component, Exim passes it to &[gethostbyname()]& (or
15719 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15720 version. The variable &$primary_hostname$& contains the host name, whether set
15721 explicitly by this option, or defaulted.
15722
15723
15724 .option print_topbitchars main boolean false
15725 .cindex "printing characters"
15726 .cindex "8-bit characters"
15727 By default, Exim considers only those characters whose codes lie in the range
15728 32&--126 to be printing characters. In a number of circumstances (for example,
15729 when writing log entries) non-printing characters are converted into escape
15730 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15731 is set, code values of 128 and above are also considered to be printing
15732 characters.
15733
15734 This option also affects the header syntax checks performed by the
15735 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15736 the user's full name when constructing From: and Sender: addresses (as
15737 described in section &<<SECTconstr>>&). Setting this option can cause
15738 Exim to generate eight bit message headers that do not conform to the
15739 standards.
15740
15741
15742 .option process_log_path main string unset
15743 .cindex "process log path"
15744 .cindex "log" "process log"
15745 .cindex "&'exiwhat'&"
15746 This option sets the name of the file to which an Exim process writes its
15747 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15748 utility script. If this option is unset, the file called &_exim-process.info_&
15749 in Exim's spool directory is used. The ability to specify the name explicitly
15750 can be useful in environments where two different Exims are running, using
15751 different spool directories.
15752
15753
15754 .option prod_requires_admin main boolean true
15755 .oindex "&%-M%&"
15756 .oindex "&%-R%&"
15757 .oindex "&%-q%&"
15758 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15759 admin user unless &%prod_requires_admin%& is set false. See also
15760 &%queue_list_requires_admin%&.
15761
15762
15763 .option qualify_domain main string "see below"
15764 .cindex "domain" "for qualifying addresses"
15765 .cindex "address" "qualification"
15766 This option specifies the domain name that is added to any envelope sender
15767 addresses that do not have a domain qualification. It also applies to
15768 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15769 are accepted by default only for locally-generated messages. Qualification is
15770 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15771 locally-generated messages, unless the &%-bnq%& command line option is used.
15772
15773 Messages from external sources must always contain fully qualified addresses,
15774 unless the sending host matches &%sender_unqualified_hosts%& or
15775 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15776 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15777 necessary. Internally, Exim always works with fully qualified envelope
15778 addresses. If &%qualify_domain%& is not set, it defaults to the
15779 &%primary_hostname%& value.
15780
15781
15782 .option qualify_recipient main string "see below"
15783 This option allows you to specify a different domain for qualifying recipient
15784 addresses to the one that is used for senders. See &%qualify_domain%& above.
15785
15786
15787
15788 .option queue_domains main "domain list&!!" unset
15789 .cindex "domain" "specifying non-immediate delivery"
15790 .cindex "queueing incoming messages"
15791 .cindex "message" "queueing certain domains"
15792 This option lists domains for which immediate delivery is not required.
15793 A delivery process is started whenever a message is received, but only those
15794 domains that do not match are processed. All other deliveries wait until the
15795 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15796
15797
15798 .option queue_list_requires_admin main boolean true
15799 .oindex "&%-bp%&"
15800 The &%-bp%& command-line option, which lists the messages that are on the
15801 queue, requires the caller to be an admin user unless
15802 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15803
15804
15805 .option queue_only main boolean false
15806 .cindex "queueing incoming messages"
15807 .cindex "message" "queueing unconditionally"
15808 If &%queue_only%& is set, a delivery process is not automatically started
15809 whenever a message is received. Instead, the message waits on the queue for the
15810 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15811 delivered immediately when certain conditions (such as heavy load) occur.
15812
15813 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15814 and &%-odi%& command line options override &%queue_only%& unless
15815 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15816 &%queue_only_load%&, and &%smtp_accept_queue%&.
15817
15818
15819 .option queue_only_file main string unset
15820 .cindex "queueing incoming messages"
15821 .cindex "message" "queueing by file existence"
15822 This option can be set to a colon-separated list of absolute path names, each
15823 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15824 it tests for the existence of each listed path using a call to &[stat()]&. For
15825 each path that exists, the corresponding queueing option is set.
15826 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15827 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15828 .code
15829 queue_only_file = smtp/some/file
15830 .endd
15831 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15832 &_/some/file_& exists.
15833
15834
15835 .option queue_only_load main fixed-point unset
15836 .cindex "load average"
15837 .cindex "queueing incoming messages"
15838 .cindex "message" "queueing by load"
15839 If the system load average is higher than this value, incoming messages from
15840 all sources are queued, and no automatic deliveries are started. If this
15841 happens during local or remote SMTP input, all subsequent messages received on
15842 the same SMTP connection are queued by default, whatever happens to the load in
15843 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15844 false.
15845
15846 Deliveries will subsequently be performed by queue runner processes. This
15847 option has no effect on ancient operating systems on which Exim cannot
15848 determine the load average. See also &%deliver_queue_load_max%& and
15849 &%smtp_load_reserve%&.
15850
15851
15852 .option queue_only_load_latch main boolean true
15853 .cindex "load average" "re-evaluating per message"
15854 When this option is true (the default), once one message has been queued
15855 because the load average is higher than the value set by &%queue_only_load%&,
15856 all subsequent messages received on the same SMTP connection are also queued.
15857 This is a deliberate choice; even though the load average may fall below the
15858 threshold, it doesn't seem right to deliver later messages on the same
15859 connection when not delivering earlier ones. However, there are special
15860 circumstances such as very long-lived connections from scanning appliances
15861 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15862 should be set false. This causes the value of the load average to be
15863 re-evaluated for each message.
15864
15865
15866 .option queue_only_override main boolean true
15867 .cindex "queueing incoming messages"
15868 When this option is true, the &%-od%&&'x'& command line options override the
15869 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15870 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15871 to override; they are accepted, but ignored.
15872
15873
15874 .option queue_run_in_order main boolean false
15875 .cindex "queue runner" "processing messages in order"
15876 If this option is set, queue runs happen in order of message arrival instead of
15877 in an arbitrary order. For this to happen, a complete list of the entire queue
15878 must be set up before the deliveries start. When the queue is all held in a
15879 single directory (the default), a single list is created for both the ordered
15880 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15881 single list is not created when &%queue_run_in_order%& is false. In this case,
15882 the sub-directories are processed one at a time (in a random order), and this
15883 avoids setting up one huge list for the whole queue. Thus, setting
15884 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15885 when the queue is large, because of the extra work in setting up the single,
15886 large list. In most situations, &%queue_run_in_order%& should not be set.
15887
15888
15889
15890 .option queue_run_max main integer 5
15891 .cindex "queue runner" "maximum number of"
15892 This controls the maximum number of queue runner processes that an Exim daemon
15893 can run simultaneously. This does not mean that it starts them all at once,
15894 but rather that if the maximum number are still running when the time comes to
15895 start another one, it refrains from starting another one. This can happen with
15896 very large queues and/or very sluggish deliveries. This option does not,
15897 however, interlock with other processes, so additional queue runners can be
15898 started by other means, or by killing and restarting the daemon.
15899
15900 Setting this option to zero does not suppress queue runs; rather, it disables
15901 the limit, allowing any number of simultaneous queue runner processes to be
15902 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15903 the daemon's command line.
15904
15905 .option queue_smtp_domains main "domain list&!!" unset
15906 .cindex "queueing incoming messages"
15907 .cindex "message" "queueing remote deliveries"
15908 When this option is set, a delivery process is started whenever a message is
15909 received, routing is performed, and local deliveries take place.
15910 However, if any SMTP deliveries are required for domains that match
15911 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15912 message waits on the queue for the next queue run. Since routing of the message
15913 has taken place, Exim knows to which remote hosts it must be delivered, and so
15914 when the queue run happens, multiple messages for the same host are delivered
15915 over a single SMTP connection. The &%-odqs%& command line option causes all
15916 SMTP deliveries to be queued in this way, and is equivalent to setting
15917 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15918 &%queue_domains%&.
15919
15920
15921 .option receive_timeout main time 0s
15922 .cindex "timeout" "for non-SMTP input"
15923 This option sets the timeout for accepting a non-SMTP message, that is, the
15924 maximum time that Exim waits when reading a message on the standard input. If
15925 the value is zero, it will wait for ever. This setting is overridden by the
15926 &%-or%& command line option. The timeout for incoming SMTP messages is
15927 controlled by &%smtp_receive_timeout%&.
15928
15929 .option received_header_text main string&!! "see below"
15930 .cindex "customizing" "&'Received:'& header"
15931 .cindex "&'Received:'& header line" "customizing"
15932 This string defines the contents of the &'Received:'& message header that is
15933 added to each message, except for the timestamp, which is automatically added
15934 on at the end (preceded by a semicolon). The string is expanded each time it is
15935 used. If the expansion yields an empty string, no &'Received:'& header line is
15936 added to the message. Otherwise, the string should start with the text
15937 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15938 header lines. The default setting is:
15939
15940 .code
15941 received_header_text = Received: \
15942   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15943   {${if def:sender_ident \
15944   {from ${quote_local_part:$sender_ident} }}\
15945   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15946   by $primary_hostname \
15947   ${if def:received_protocol {with $received_protocol}} \
15948   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15949   (Exim $version_number)\n\t\
15950   ${if def:sender_address \
15951   {(envelope-from <$sender_address>)\n\t}}\
15952   id $message_exim_id\
15953   ${if def:received_for {\n\tfor $received_for}}
15954 .endd
15955
15956 The reference to the TLS cipher is omitted when Exim is built without TLS
15957 support. The use of conditional expansions ensures that this works for both
15958 locally generated messages and messages received from remote hosts, giving
15959 header lines such as the following:
15960 .code
15961 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15962 by marley.carol.example with esmtp (Exim 4.00)
15963 (envelope-from <bob@carol.example>)
15964 id 16IOWa-00019l-00
15965 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15966 Received: by scrooge.carol.example with local (Exim 4.00)
15967 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15968 .endd
15969 Until the body of the message has been received, the timestamp is the time when
15970 the message started to be received. Once the body has arrived, and all policy
15971 checks have taken place, the timestamp is updated to the time at which the
15972 message was accepted.
15973
15974
15975 .option received_headers_max main integer 30
15976 .cindex "loop" "prevention"
15977 .cindex "mail loop prevention"
15978 .cindex "&'Received:'& header line" "counting"
15979 When a message is to be delivered, the number of &'Received:'& headers is
15980 counted, and if it is greater than this parameter, a mail loop is assumed to
15981 have occurred, the delivery is abandoned, and an error message is generated.
15982 This applies to both local and remote deliveries.
15983
15984
15985 .option recipient_unqualified_hosts main "host list&!!" unset
15986 .cindex "unqualified addresses"
15987 .cindex "host" "unqualified addresses from"
15988 This option lists those hosts from which Exim is prepared to accept unqualified
15989 recipient addresses in message envelopes. The addresses are made fully
15990 qualified by the addition of the &%qualify_recipient%& value. This option also
15991 affects message header lines. Exim does not reject unqualified recipient
15992 addresses in headers, but it qualifies them only if the message came from a
15993 host that matches &%recipient_unqualified_hosts%&,
15994 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15995 option was not set.
15996
15997
15998 .option recipients_max main integer 0
15999 .cindex "limit" "number of recipients"
16000 .cindex "recipient" "maximum number"
16001 If this option is set greater than zero, it specifies the maximum number of
16002 original recipients for any message. Additional recipients that are generated
16003 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16004 all recipients over the limit; earlier recipients are delivered as normal.
16005 Non-SMTP messages with too many recipients are failed, and no deliveries are
16006 done.
16007
16008 .cindex "RCPT" "maximum number of incoming"
16009 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16010 RCPT commands in a single message.
16011
16012
16013 .option recipients_max_reject main boolean false
16014 If this option is set true, Exim rejects SMTP messages containing too many
16015 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16016 error to the eventual DATA command. Otherwise (the default) it gives a 452
16017 error to the surplus RCPT commands and accepts the message on behalf of the
16018 initial set of recipients. The remote server should then re-send the message
16019 for the remaining recipients at a later time.
16020
16021
16022 .option remote_max_parallel main integer 2
16023 .cindex "delivery" "parallelism for remote"
16024 This option controls parallel delivery of one message to a number of remote
16025 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16026 does all the remote deliveries for a message one by one. Otherwise, if a single
16027 message has to be delivered to more than one remote host, or if several copies
16028 have to be sent to the same remote host, up to &%remote_max_parallel%&
16029 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16030 deliveries are required, the maximum number of processes are started, and as
16031 each one finishes, another is begun. The order of starting processes is the
16032 same as if sequential delivery were being done, and can be controlled by the
16033 &%remote_sort_domains%& option. If parallel delivery takes place while running
16034 with debugging turned on, the debugging output from each delivery process is
16035 tagged with its process id.
16036
16037 This option controls only the maximum number of parallel deliveries for one
16038 message in one Exim delivery process. Because Exim has no central queue
16039 manager, there is no way of controlling the total number of simultaneous
16040 deliveries if the configuration allows a delivery attempt as soon as a message
16041 is received.
16042
16043 .cindex "number of deliveries"
16044 .cindex "delivery" "maximum number of"
16045 If you want to control the total number of deliveries on the system, you
16046 need to set the &%queue_only%& option. This ensures that all incoming messages
16047 are added to the queue without starting a delivery process. Then set up an Exim
16048 daemon to start queue runner processes at appropriate intervals (probably
16049 fairly often, for example, every minute), and limit the total number of queue
16050 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16051 delivers only one message at a time, the maximum number of deliveries that can
16052 then take place at once is &%queue_run_max%& multiplied by
16053 &%remote_max_parallel%&.
16054
16055 If it is purely remote deliveries you want to control, use
16056 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16057 doing the SMTP routing before queueing, so that several messages for the same
16058 host will eventually get delivered down the same connection.
16059
16060
16061 .option remote_sort_domains main "domain list&!!" unset
16062 .cindex "sorting remote deliveries"
16063 .cindex "delivery" "sorting remote"
16064 When there are a number of remote deliveries for a message, they are sorted by
16065 domain into the order given by this list. For example,
16066 .code
16067 remote_sort_domains = *.cam.ac.uk:*.uk
16068 .endd
16069 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16070 then to those in the &%uk%& domain, then to any others.
16071
16072
16073 .option retry_data_expire main time 7d
16074 .cindex "hints database" "data expiry"
16075 This option sets a &"use before"& time on retry information in Exim's hints
16076 database. Any older retry data is ignored. This means that, for example, once a
16077 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16078 past failures.
16079
16080
16081 .option retry_interval_max main time 24h
16082 .cindex "retry" "limit on interval"
16083 .cindex "limit" "on retry interval"
16084 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16085 intervals between delivery attempts for messages that cannot be delivered
16086 straight away. This option sets an overall limit to the length of time between
16087 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16088 the default value.
16089
16090
16091 .option return_path_remove main boolean true
16092 .cindex "&'Return-path:'& header line" "removing"
16093 RFC 2821, section 4.4, states that an SMTP server must insert a
16094 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16095 The &'Return-path:'& header preserves the sender address as received in the
16096 MAIL command. This description implies that this header should not be present
16097 in an incoming message. If &%return_path_remove%& is true, any existing
16098 &'Return-path:'& headers are removed from messages at the time they are
16099 received. Exim's transports have options for adding &'Return-path:'& headers at
16100 the time of delivery. They are normally used only for final local deliveries.
16101
16102
16103 .option return_size_limit main integer 100K
16104 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16105
16106
16107 .option rfc1413_hosts main "host list&!!" @[]
16108 .cindex "RFC 1413"
16109 .cindex "host" "for RFC 1413 calls"
16110 RFC 1413 identification calls are made to any client host which matches
16111 an item in the list.
16112 The default value specifies just this host, being any local interface
16113 for the system.
16114
16115 .option rfc1413_query_timeout main time 0s
16116 .cindex "RFC 1413" "query timeout"
16117 .cindex "timeout" "for RFC 1413 call"
16118 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16119 no RFC 1413 calls are ever made.
16120
16121
16122 .option sender_unqualified_hosts main "host list&!!" unset
16123 .cindex "unqualified addresses"
16124 .cindex "host" "unqualified addresses from"
16125 This option lists those hosts from which Exim is prepared to accept unqualified
16126 sender addresses. The addresses are made fully qualified by the addition of
16127 &%qualify_domain%&. This option also affects message header lines. Exim does
16128 not reject unqualified addresses in headers that contain sender addresses, but
16129 it qualifies them only if the message came from a host that matches
16130 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16131 using TCP/IP), and the &%-bnq%& option was not set.
16132
16133 .option set_environment main "string list" empty
16134 .cindex "environment"
16135 This option allows to set individual environment variables that the
16136 currently linked libraries and programs in child processes use. The
16137 default list is empty,
16138
16139
16140 .option slow_lookup_log main integer 0
16141 .cindex "logging" "slow lookups"
16142 .cindex "dns" "logging slow lookups"
16143 This option controls logging of slow lookups.
16144 If the value is nonzero it is taken as a number of milliseconds
16145 and lookups taking longer than this are logged.
16146 Currently this applies only to DNS lookups.
16147
16148
16149
16150 .option smtp_accept_keepalive main boolean true
16151 .cindex "keepalive" "on incoming connection"
16152 This option controls the setting of the SO_KEEPALIVE option on incoming
16153 TCP/IP socket connections. When set, it causes the kernel to probe idle
16154 connections periodically, by sending packets with &"old"& sequence numbers. The
16155 other end of the connection should send an acknowledgment if the connection is
16156 still okay or a reset if the connection has been aborted. The reason for doing
16157 this is that it has the beneficial effect of freeing up certain types of
16158 connection that can get stuck when the remote host is disconnected without
16159 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16160 hours to detect unreachable hosts.
16161
16162
16163
16164 .option smtp_accept_max main integer 20
16165 .cindex "limit" "incoming SMTP connections"
16166 .cindex "SMTP" "incoming connection count"
16167 .cindex "inetd"
16168 This option specifies the maximum number of simultaneous incoming SMTP calls
16169 that Exim will accept. It applies only to the listening daemon; there is no
16170 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16171 value is set to zero, no limit is applied. However, it is required to be
16172 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16173 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16174
16175 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16176 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16177 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16178 and &%smtp_load_reserve%& are then checked before accepting the connection.
16179
16180
16181 .option smtp_accept_max_nonmail main integer 10
16182 .cindex "limit" "non-mail SMTP commands"
16183 .cindex "SMTP" "limiting non-mail commands"
16184 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16185 the connection if there are too many. This option defines &"too many"&. The
16186 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16187 client looping sending EHLO, for example. The check is applied only if the
16188 client host matches &%smtp_accept_max_nonmail_hosts%&.
16189
16190 When a new message is expected, one occurrence of RSET is not counted. This
16191 allows a client to send one RSET between messages (this is not necessary,
16192 but some clients do it). Exim also allows one uncounted occurrence of HELO
16193 or EHLO, and one occurrence of STARTTLS between messages. After
16194 starting up a TLS session, another EHLO is expected, and so it too is not
16195 counted. The first occurrence of AUTH in a connection, or immediately
16196 following STARTTLS is not counted. Otherwise, all commands other than
16197 MAIL, RCPT, DATA, and QUIT are counted.
16198
16199
16200 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16201 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16202 check by setting this option. The default value makes it apply to all hosts. By
16203 changing the value, you can exclude any badly-behaved hosts that you have to
16204 live with.
16205
16206
16207 . Allow this long option name to split; give it unsplit as a fifth argument
16208 . for the automatic .oindex that is generated by .option.
16209 . We insert " &~&~" which is both pretty nasty visually and results in
16210 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16211 . zero-width-space, which would be nicer visually and results in (at least)
16212 . html that Firefox will split on when it's forced to reflow (rather than
16213 . inserting a horizontal scrollbar).  However, the text is still not
16214 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16215 . the option name to split.
16216
16217 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16218          smtp_accept_max_per_connection
16219 .cindex "SMTP" "limiting incoming message count"
16220 .cindex "limit" "messages per SMTP connection"
16221 The value of this option limits the number of MAIL commands that Exim is
16222 prepared to accept over a single SMTP connection, whether or not each command
16223 results in the transfer of a message. After the limit is reached, a 421
16224 response is given to subsequent MAIL commands. This limit is a safety
16225 precaution against a client that goes mad (incidents of this type have been
16226 seen).
16227
16228
16229 .option smtp_accept_max_per_host main string&!! unset
16230 .cindex "limit" "SMTP connections from one host"
16231 .cindex "host" "limiting SMTP connections from"
16232 This option restricts the number of simultaneous IP connections from a single
16233 host (strictly, from a single IP address) to the Exim daemon. The option is
16234 expanded, to enable different limits to be applied to different hosts by
16235 reference to &$sender_host_address$&. Once the limit is reached, additional
16236 connection attempts from the same host are rejected with error code 421. This
16237 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16238 of zero imposes no limit. If this option is set greater than zero, it is
16239 required that &%smtp_accept_max%& be non-zero.
16240
16241 &*Warning*&: When setting this option you should not use any expansion
16242 constructions that take an appreciable amount of time. The expansion and test
16243 happen in the main daemon loop, in order to reject additional connections
16244 without forking additional processes (otherwise a denial-of-service attack
16245 could cause a vast number or processes to be created). While the daemon is
16246 doing this processing, it cannot accept any other incoming connections.
16247
16248
16249
16250 .option smtp_accept_queue main integer 0
16251 .cindex "SMTP" "incoming connection count"
16252 .cindex "queueing incoming messages"
16253 .cindex "message" "queueing by SMTP connection count"
16254 If the number of simultaneous incoming SMTP connections being handled via the
16255 listening daemon exceeds this value, messages received by SMTP are just placed
16256 on the queue; no delivery processes are started automatically. The count is
16257 fixed at the start of an SMTP connection. It cannot be updated in the
16258 subprocess that receives messages, and so the queueing or not queueing applies
16259 to all messages received in the same connection.
16260
16261 A value of zero implies no limit, and clearly any non-zero value is useful only
16262 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16263 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16264 various &%-od%&&'x'& command line options.
16265
16266
16267 . See the comment on smtp_accept_max_per_connection
16268
16269 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16270          smtp_accept_queue_per_connection
16271 .cindex "queueing incoming messages"
16272 .cindex "message" "queueing by message count"
16273 This option limits the number of delivery processes that Exim starts
16274 automatically when receiving messages via SMTP, whether via the daemon or by
16275 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16276 and the number of messages received in a single SMTP session exceeds this
16277 number, subsequent messages are placed on the queue, but no delivery processes
16278 are started. This helps to limit the number of Exim processes when a server
16279 restarts after downtime and there is a lot of mail waiting for it on other
16280 systems. On large systems, the default should probably be increased, and on
16281 dial-in client systems it should probably be set to zero (that is, disabled).
16282
16283
16284 .option smtp_accept_reserve main integer 0
16285 .cindex "SMTP" "incoming call count"
16286 .cindex "host" "reserved"
16287 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16288 number of SMTP connections that are reserved for connections from the hosts
16289 that are specified in &%smtp_reserve_hosts%&. The value set in
16290 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16291 restricted to this number of connections; the option specifies a minimum number
16292 of connection slots for them, not a maximum. It is a guarantee that this group
16293 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16294 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16295 individual host.
16296
16297 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16298 set to 5, once there are 45 active connections (from any hosts), new
16299 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16300 provided the other criteria for acceptance are met.
16301
16302
16303 .option smtp_active_hostname main string&!! unset
16304 .cindex "host" "name in SMTP responses"
16305 .cindex "SMTP" "host name in responses"
16306 .vindex "&$primary_hostname$&"
16307 This option is provided for multi-homed servers that want to masquerade as
16308 several different hosts. At the start of an incoming SMTP connection, its value
16309 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16310 responses. For example, it is used as domain name in the response to an
16311 incoming HELO or EHLO command.
16312
16313 .vindex "&$smtp_active_hostname$&"
16314 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16315 is saved with any messages that are received. It is therefore available for use
16316 in routers and transports when the message is later delivered.
16317
16318 If this option is unset, or if its expansion is forced to fail, or if the
16319 expansion results in an empty string, the value of &$primary_hostname$& is
16320 used. Other expansion failures cause a message to be written to the main and
16321 panic logs, and the SMTP command receives a temporary error. Typically, the
16322 value of &%smtp_active_hostname%& depends on the incoming interface address.
16323 For example:
16324 .code
16325 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16326   {cox.mydomain}{box.mydomain}}
16327 .endd
16328
16329 Although &$smtp_active_hostname$& is primarily concerned with incoming
16330 messages, it is also used as the default for HELO commands in callout
16331 verification if there is no remote transport from which to obtain a
16332 &%helo_data%& value.
16333
16334 .option smtp_banner main string&!! "see below"
16335 .cindex "SMTP" "welcome banner"
16336 .cindex "banner for SMTP"
16337 .cindex "welcome banner for SMTP"
16338 .cindex "customizing" "SMTP banner"
16339 This string, which is expanded every time it is used, is output as the initial
16340 positive response to an SMTP connection. The default setting is:
16341 .code
16342 smtp_banner = $smtp_active_hostname ESMTP Exim \
16343   $version_number $tod_full
16344 .endd
16345 Failure to expand the string causes a panic error. If you want to create a
16346 multiline response to the initial SMTP connection, use &"\n"& in the string at
16347 appropriate points, but not at the end. Note that the 220 code is not included
16348 in this string. Exim adds it automatically (several times in the case of a
16349 multiline response).
16350
16351
16352 .option smtp_check_spool_space main boolean true
16353 .cindex "checking disk space"
16354 .cindex "disk space, checking"
16355 .cindex "spool directory" "checking space"
16356 When this option is set, if an incoming SMTP session encounters the SIZE
16357 option on a MAIL command, it checks that there is enough space in the
16358 spool directory's partition to accept a message of that size, while still
16359 leaving free the amount specified by &%check_spool_space%& (even if that value
16360 is zero). If there isn't enough space, a temporary error code is returned.
16361
16362
16363 .option smtp_connect_backlog main integer 20
16364 .cindex "connection backlog"
16365 .cindex "SMTP" "connection backlog"
16366 .cindex "backlog of connections"
16367 This option specifies a maximum number of waiting SMTP connections. Exim passes
16368 this value to the TCP/IP system when it sets up its listener. Once this number
16369 of connections are waiting for the daemon's attention, subsequent connection
16370 attempts are refused at the TCP/IP level. At least, that is what the manuals
16371 say; in some circumstances such connection attempts have been observed to time
16372 out instead. For large systems it is probably a good idea to increase the
16373 value (to 50, say). It also gives some protection against denial-of-service
16374 attacks by SYN flooding.
16375
16376
16377 .option smtp_enforce_sync main boolean true
16378 .cindex "SMTP" "synchronization checking"
16379 .cindex "synchronization checking in SMTP"
16380 The SMTP protocol specification requires the client to wait for a response from
16381 the server at certain points in the dialogue. Without PIPELINING these
16382 synchronization points are after every command; with PIPELINING they are
16383 fewer, but they still exist.
16384
16385 Some spamming sites send out a complete set of SMTP commands without waiting
16386 for any response. Exim protects against this by rejecting a message if the
16387 client has sent further input when it should not have. The error response &"554
16388 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16389 for this error cannot be perfect because of transmission delays (unexpected
16390 input may be on its way but not yet received when Exim checks). However, it
16391 does detect many instances.
16392
16393 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16394 If you want to disable the check selectively (for example, only for certain
16395 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16396 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16397
16398
16399
16400 .option smtp_etrn_command main string&!! unset
16401 .cindex "ETRN" "command to be run"
16402 .vindex "&$domain$&"
16403 If this option is set, the given command is run whenever an SMTP ETRN
16404 command is received from a host that is permitted to issue such commands (see
16405 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16406 are independently expanded. The expansion variable &$domain$& is set to the
16407 argument of the ETRN command, and no syntax checking is done on it. For
16408 example:
16409 .code
16410 smtp_etrn_command = /etc/etrn_command $domain \
16411                     $sender_host_address
16412 .endd
16413 A new process is created to run the command, but Exim does not wait for it to
16414 complete. Consequently, its status cannot be checked. If the command cannot be
16415 run, a line is written to the panic log, but the ETRN caller still receives
16416 a 250 success response. Exim is normally running under its own uid when
16417 receiving SMTP, so it is not possible for it to change the uid before running
16418 the command.
16419
16420
16421 .option smtp_etrn_serialize main boolean true
16422 .cindex "ETRN" "serializing"
16423 When this option is set, it prevents the simultaneous execution of more than
16424 one identical command as a result of ETRN in an SMTP connection. See
16425 section &<<SECTETRN>>& for details.
16426
16427
16428 .option smtp_load_reserve main fixed-point unset
16429 .cindex "load average"
16430 If the system load average ever gets higher than this, incoming SMTP calls are
16431 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16432 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16433 the load is over the limit. The option has no effect on ancient operating
16434 systems on which Exim cannot determine the load average. See also
16435 &%deliver_queue_load_max%& and &%queue_only_load%&.
16436
16437
16438
16439 .option smtp_max_synprot_errors main integer 3
16440 .cindex "SMTP" "limiting syntax and protocol errors"
16441 .cindex "limit" "SMTP syntax and protocol errors"
16442 Exim rejects SMTP commands that contain syntax or protocol errors. In
16443 particular, a syntactically invalid email address, as in this command:
16444 .code
16445 RCPT TO:<abc xyz@a.b.c>
16446 .endd
16447 causes immediate rejection of the command, before any other tests are done.
16448 (The ACL cannot be run if there is no valid address to set up for it.) An
16449 example of a protocol error is receiving RCPT before MAIL. If there are
16450 too many syntax or protocol errors in one SMTP session, the connection is
16451 dropped. The limit is set by this option.
16452
16453 .cindex "PIPELINING" "expected errors"
16454 When the PIPELINING extension to SMTP is in use, some protocol errors are
16455 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16456 Exim assumes that PIPELINING will be used if it advertises it (see
16457 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16458 not count towards the limit.
16459
16460
16461
16462 .option smtp_max_unknown_commands main integer 3
16463 .cindex "SMTP" "limiting unknown commands"
16464 .cindex "limit" "unknown SMTP commands"
16465 If there are too many unrecognized commands in an incoming SMTP session, an
16466 Exim server drops the connection. This is a defence against some kinds of abuse
16467 that subvert web
16468 clients
16469 into making connections to SMTP ports; in these circumstances, a number of
16470 non-SMTP command lines are sent first.
16471
16472
16473
16474 .option smtp_ratelimit_hosts main "host list&!!" unset
16475 .cindex "SMTP" "rate limiting"
16476 .cindex "limit" "rate of message arrival"
16477 .cindex "RCPT" "rate limiting"
16478 Some sites find it helpful to be able to limit the rate at which certain hosts
16479 can send them messages, and the rate at which an individual message can specify
16480 recipients.
16481
16482 Exim has two rate-limiting facilities. This section describes the older
16483 facility, which can limit rates within a single connection. The newer
16484 &%ratelimit%& ACL condition can limit rates across all connections. See section
16485 &<<SECTratelimiting>>& for details of the newer facility.
16486
16487 When a host matches &%smtp_ratelimit_hosts%&, the values of
16488 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16489 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16490 respectively. Each option, if set, must contain a set of four comma-separated
16491 values:
16492
16493 .ilist
16494 A threshold, before which there is no rate limiting.
16495 .next
16496 An initial time delay. Unlike other times in Exim, numbers with decimal
16497 fractional parts are allowed here.
16498 .next
16499 A factor by which to increase the delay each time.
16500 .next
16501 A maximum value for the delay. This should normally be less than 5 minutes,
16502 because after that time, the client is liable to timeout the SMTP command.
16503 .endlist
16504
16505 For example, these settings have been used successfully at the site which
16506 first suggested this feature, for controlling mail from their customers:
16507 .code
16508 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16509 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16510 .endd
16511 The first setting specifies delays that are applied to MAIL commands after
16512 two have been received over a single connection. The initial delay is 0.5
16513 seconds, increasing by a factor of 1.05 each time. The second setting applies
16514 delays to RCPT commands when more than four occur in a single message.
16515
16516
16517 .option smtp_ratelimit_mail main string unset
16518 See &%smtp_ratelimit_hosts%& above.
16519
16520
16521 .option smtp_ratelimit_rcpt main string unset
16522 See &%smtp_ratelimit_hosts%& above.
16523
16524
16525 .option smtp_receive_timeout main time&!! 5m
16526 .cindex "timeout" "for SMTP input"
16527 .cindex "SMTP" "input timeout"
16528 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16529 input, including batch SMTP. If a line of input (either an SMTP command or a
16530 data line) is not received within this time, the SMTP connection is dropped and
16531 the message is abandoned.
16532 A line is written to the log containing one of the following messages:
16533 .code
16534 SMTP command timeout on connection from...
16535 SMTP data timeout on connection from...
16536 .endd
16537 The former means that Exim was expecting to read an SMTP command; the latter
16538 means that it was in the DATA phase, reading the contents of a message.
16539
16540 If the first character of the option is a &"$"& the option is
16541 expanded before use and may depend on
16542 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16543
16544
16545 .oindex "&%-os%&"
16546 The value set by this option can be overridden by the
16547 &%-os%& command-line option. A setting of zero time disables the timeout, but
16548 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16549 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16550 timeout is controlled by &%receive_timeout%& and &%-or%&.
16551
16552
16553 .option smtp_reserve_hosts main "host list&!!" unset
16554 This option defines hosts for which SMTP connections are reserved; see
16555 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16556
16557
16558 .option smtp_return_error_details main boolean false
16559 .cindex "SMTP" "details policy failures"
16560 .cindex "policy control" "rejection, returning details"
16561 In the default state, Exim uses bland messages such as
16562 &"Administrative prohibition"& when it rejects SMTP commands for policy
16563 reasons. Many sysadmins like this because it gives away little information
16564 to spammers. However, some other sysadmins who are applying strict checking
16565 policies want to give out much fuller information about failures. Setting
16566 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16567 example, instead of &"Administrative prohibition"&, it might give:
16568 .code
16569 550-Rejected after DATA: '>' missing at end of address:
16570 550 failing address in "From" header is: <user@dom.ain
16571 .endd
16572
16573
16574 .option smtputf8_advertise_hosts main "host list&!!" *
16575 .cindex "SMTPUTF8" "advertising"
16576 When Exim is built with support for internationalised mail names,
16577 the availability therof is advertised in
16578 response to EHLO only to those client hosts that match this option. See
16579 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16580
16581
16582 .option spamd_address main string "see below"
16583 This option is available when Exim is compiled with the content-scanning
16584 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16585 The default value is
16586 .code
16587 127.0.0.1 783
16588 .endd
16589 See section &<<SECTscanspamass>>& for more details.
16590
16591
16592
16593 .option split_spool_directory main boolean false
16594 .cindex "multiple spool directories"
16595 .cindex "spool directory" "split"
16596 .cindex "directories, multiple"
16597 If this option is set, it causes Exim to split its input directory into 62
16598 subdirectories, each with a single alphanumeric character as its name. The
16599 sixth character of the message id is used to allocate messages to
16600 subdirectories; this is the least significant base-62 digit of the time of
16601 arrival of the message.
16602
16603 Splitting up the spool in this way may provide better performance on systems
16604 where there are long mail queues, by reducing the number of files in any one
16605 directory. The msglog directory is also split up in a similar way to the input
16606 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16607 are still placed in the single directory &_msglog.OLD_&.
16608
16609 It is not necessary to take any special action for existing messages when
16610 changing &%split_spool_directory%&. Exim notices messages that are in the
16611 &"wrong"& place, and continues to process them. If the option is turned off
16612 after a period of being on, the subdirectories will eventually empty and be
16613 automatically deleted.
16614
16615 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16616 changes. Instead of creating a list of all messages in the queue, and then
16617 trying to deliver each one in turn, it constructs a list of those in one
16618 sub-directory and tries to deliver them, before moving on to the next
16619 sub-directory. The sub-directories are processed in a random order. This
16620 spreads out the scanning of the input directories, and uses less memory. It is
16621 particularly beneficial when there are lots of messages on the queue. However,
16622 if &%queue_run_in_order%& is set, none of this new processing happens. The
16623 entire queue has to be scanned and sorted before any deliveries can start.
16624
16625
16626 .option spool_directory main string&!! "set at compile time"
16627 .cindex "spool directory" "path to"
16628 This defines the directory in which Exim keeps its spool, that is, the messages
16629 it is waiting to deliver. The default value is taken from the compile-time
16630 configuration setting, if there is one. If not, this option must be set. The
16631 string is expanded, so it can contain, for example, a reference to
16632 &$primary_hostname$&.
16633
16634 If the spool directory name is fixed on your installation, it is recommended
16635 that you set it at build time rather than from this option, particularly if the
16636 log files are being written to the spool directory (see &%log_file_path%&).
16637 Otherwise log files cannot be used for errors that are detected early on, such
16638 as failures in the configuration file.
16639
16640 By using this option to override the compiled-in path, it is possible to run
16641 tests of Exim without using the standard spool.
16642
16643 .option sqlite_lock_timeout main time 5s
16644 .cindex "sqlite lookup type" "lock timeout"
16645 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16646 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16647
16648 .option strict_acl_vars main boolean false
16649 .cindex "&ACL;" "variables, handling unset"
16650 This option controls what happens if a syntactically valid but undefined ACL
16651 variable is referenced. If it is false (the default), an empty string
16652 is substituted; if it is true, an error is generated. See section
16653 &<<SECTaclvariables>>& for details of ACL variables.
16654
16655 .option strip_excess_angle_brackets main boolean false
16656 .cindex "angle brackets, excess"
16657 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16658 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16659 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16660 passed on to another MTA, the excess angle brackets are not passed on. If this
16661 option is not set, multiple pairs of angle brackets cause a syntax error.
16662
16663
16664 .option strip_trailing_dot main boolean false
16665 .cindex "trailing dot on domain"
16666 .cindex "dot" "trailing on domain"
16667 If this option is set, a trailing dot at the end of a domain in an address is
16668 ignored. If this is in the envelope and the message is passed on to another
16669 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16670 domain causes a syntax error.
16671 However, addresses in header lines are checked only when an ACL requests header
16672 syntax checking.
16673
16674
16675 .option syslog_duplication main boolean true
16676 .cindex "syslog" "duplicate log lines; suppressing"
16677 When Exim is logging to syslog, it writes the log lines for its three
16678 separate logs at different syslog priorities so that they can in principle
16679 be separated on the logging hosts. Some installations do not require this
16680 separation, and in those cases, the duplication of certain log lines is a
16681 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16682 particular log line is written to syslog. For lines that normally go to
16683 both the main log and the reject log, the reject log version (possibly
16684 containing message header lines) is written, at LOG_NOTICE priority.
16685 Lines that normally go to both the main and the panic log are written at
16686 the LOG_ALERT priority.
16687
16688
16689 .option syslog_facility main string unset
16690 .cindex "syslog" "facility; setting"
16691 This option sets the syslog &"facility"& name, used when Exim is logging to
16692 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16693 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16694 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16695 details of Exim's logging.
16696
16697
16698
16699 .option syslog_processname main string &`exim`&
16700 .cindex "syslog" "process name; setting"
16701 This option sets the syslog &"ident"& name, used when Exim is logging to
16702 syslog. The value must be no longer than 32 characters. See chapter
16703 &<<CHAPlog>>& for details of Exim's logging.
16704
16705
16706
16707 .option syslog_timestamp main boolean true
16708 .cindex "syslog" "timestamps"
16709 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16710 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16711 details of Exim's logging.
16712
16713
16714 .option system_filter main string&!! unset
16715 .cindex "filter" "system filter"
16716 .cindex "system filter" "specifying"
16717 .cindex "Sieve filter" "not available for system filter"
16718 This option specifies an Exim filter file that is applied to all messages at
16719 the start of each delivery attempt, before any routing is done. System filters
16720 must be Exim filters; they cannot be Sieve filters. If the system filter
16721 generates any deliveries to files or pipes, or any new mail messages, the
16722 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16723 which transports are to be used. Details of this facility are given in chapter
16724 &<<CHAPsystemfilter>>&.
16725
16726
16727 .option system_filter_directory_transport main string&!! unset
16728 .vindex "&$address_file$&"
16729 This sets the name of the transport driver that is to be used when the
16730 &%save%& command in a system message filter specifies a path ending in &"/"&,
16731 implying delivery of each message into a separate file in some directory.
16732 During the delivery, the variable &$address_file$& contains the path name.
16733
16734
16735 .option system_filter_file_transport main string&!! unset
16736 .cindex "file" "transport for system filter"
16737 This sets the name of the transport driver that is to be used when the &%save%&
16738 command in a system message filter specifies a path not ending in &"/"&. During
16739 the delivery, the variable &$address_file$& contains the path name.
16740
16741 .option system_filter_group main string unset
16742 .cindex "gid (group id)" "system filter"
16743 This option is used only when &%system_filter_user%& is also set. It sets the
16744 gid under which the system filter is run, overriding any gid that is associated
16745 with the user. The value may be numerical or symbolic.
16746
16747 .option system_filter_pipe_transport main string&!! unset
16748 .cindex "&(pipe)& transport" "for system filter"
16749 .vindex "&$address_pipe$&"
16750 This specifies the transport driver that is to be used when a &%pipe%& command
16751 is used in a system filter. During the delivery, the variable &$address_pipe$&
16752 contains the pipe command.
16753
16754
16755 .option system_filter_reply_transport main string&!! unset
16756 .cindex "&(autoreply)& transport" "for system filter"
16757 This specifies the transport driver that is to be used when a &%mail%& command
16758 is used in a system filter.
16759
16760
16761 .option system_filter_user main string unset
16762 .cindex "uid (user id)" "system filter"
16763 If this option is set to root, the system filter is run in the main Exim
16764 delivery process, as root.  Otherwise, the system filter runs in a separate
16765 process, as the given user, defaulting to the Exim run-time user.
16766 Unless the string consists entirely of digits, it
16767 is looked up in the password data. Failure to find the named user causes a
16768 configuration error. The gid is either taken from the password data, or
16769 specified by &%system_filter_group%&. When the uid is specified numerically,
16770 &%system_filter_group%& is required to be set.
16771
16772 If the system filter generates any pipe, file, or reply deliveries, the uid
16773 under which the filter is run is used when transporting them, unless a
16774 transport option overrides.
16775
16776
16777 .option tcp_nodelay main boolean true
16778 .cindex "daemon" "TCP_NODELAY on sockets"
16779 .cindex "Nagle algorithm"
16780 .cindex "TCP_NODELAY on listening sockets"
16781 If this option is set false, it stops the Exim daemon setting the
16782 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16783 turns off the &"Nagle algorithm"&, which is a way of improving network
16784 performance in interactive (character-by-character) situations. Turning it off
16785 should improve Exim's performance a bit, so that is what happens by default.
16786 However, it appears that some broken clients cannot cope, and time out. Hence
16787 this option. It affects only those sockets that are set up for listening by the
16788 daemon. Sockets created by the smtp transport for delivering mail always set
16789 TCP_NODELAY.
16790
16791
16792 .option timeout_frozen_after main time 0s
16793 .cindex "frozen messages" "timing out"
16794 .cindex "timeout" "frozen messages"
16795 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16796 message of any kind that has been on the queue for longer than the given time
16797 is automatically cancelled at the next queue run. If the frozen message is a
16798 bounce message, it is just discarded; otherwise, a bounce is sent to the
16799 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16800 If you want to timeout frozen bounce messages earlier than other kinds of
16801 frozen message, see &%ignore_bounce_errors_after%&.
16802
16803 &*Note:*& the default value of zero means no timeouts; with this setting,
16804 frozen messages remain on the queue forever (except for any frozen bounce
16805 messages that are released by &%ignore_bounce_errors_after%&).
16806
16807
16808 .option timezone main string unset
16809 .cindex "timezone, setting"
16810 .cindex "environment" "values from"
16811 The value of &%timezone%& is used to set the environment variable TZ while
16812 running Exim (if it is different on entry). This ensures that all timestamps
16813 created by Exim are in the required timezone. If you want all your timestamps
16814 to be in UTC (aka GMT) you should set
16815 .code
16816 timezone = UTC
16817 .endd
16818 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16819 or, if that is not set, from the value of the TZ environment variable when Exim
16820 is built. If &%timezone%& is set to the empty string, either at build or run
16821 time, any existing TZ variable is removed from the environment when Exim
16822 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16823 unfortunately not all, operating systems.
16824
16825
16826 .option tls_advertise_hosts main "host list&!!" *
16827 .cindex "TLS" "advertising"
16828 .cindex "encryption" "on SMTP connection"
16829 .cindex "SMTP" "encrypted connection"
16830 When Exim is built with support for TLS encrypted connections, the availability
16831 of the STARTTLS command to set up an encrypted session is advertised in
16832 response to EHLO only to those client hosts that match this option. See
16833 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16834 Note that the default value requires that a certificate be supplied
16835 using the &%tls_certificate%& option.  If no certificate is available then
16836 the &%tls_advertise_hosts%& option should be set empty.
16837
16838
16839 .option tls_certificate main string&!! unset
16840 .cindex "TLS" "server certificate; location of"
16841 .cindex "certificate" "server, location of"
16842 The value of this option is expanded, and must then be the absolute path to a
16843 file which contains the server's certificates. The server's private key is also
16844 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16845 &<<CHAPTLS>>& for further details.
16846
16847 &*Note*&: The certificates defined by this option are used only when Exim is
16848 receiving incoming messages as a server. If you want to supply certificates for
16849 use when sending messages as a client, you must set the &%tls_certificate%&
16850 option in the relevant &(smtp)& transport.
16851
16852 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16853 if the OpenSSL build supports TLS extensions and the TLS client sends the
16854 Server Name Indication extension, then this option and others documented in
16855 &<<SECTtlssni>>& will be re-expanded.
16856
16857 .option tls_crl main string&!! unset
16858 .cindex "TLS" "server certificate revocation list"
16859 .cindex "certificate" "revocation list for server"
16860 This option specifies a certificate revocation list. The expanded value must
16861 be the name of a file that contains a CRL in PEM format.
16862
16863 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16864
16865
16866 .option tls_dh_max_bits main integer 2236
16867 .cindex "TLS" "D-H bit count"
16868 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16869 the chosen TLS library.  That value might prove to be too high for
16870 interoperability.  This option provides a maximum clamp on the value
16871 suggested, trading off security for interoperability.
16872
16873 The value must be at least 1024.
16874
16875 The value 2236 was chosen because, at time of adding the option, it was the
16876 hard-coded maximum value supported by the NSS cryptographic library, as used
16877 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16878
16879 If you prefer more security and are willing to break some clients, raise this
16880 number.
16881
16882 Note that the value passed to GnuTLS for *generating* a new prime may be a
16883 little less than this figure, because GnuTLS is inexact and may produce a
16884 larger prime than requested.
16885
16886
16887 .option tls_dhparam main string&!! unset
16888 .cindex "TLS" "D-H parameters for server"
16889 The value of this option is expanded and indicates the source of DH parameters
16890 to be used by Exim.
16891
16892 If it is a filename starting with a &`/`&, then it names a file from which DH
16893 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16894 PKCS#3 representation of the DH prime.  If the file does not exist, for
16895 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16896 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16897 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16898 and treated as though the &%tls_dhparam%& were set to "none".
16899
16900 If this option expands to the string "none", then no DH parameters will be
16901 loaded by Exim.
16902
16903 If this option expands to the string "historic" and Exim is using GnuTLS, then
16904 Exim will attempt to load a file from inside the spool directory.  If the file
16905 does not exist, Exim will attempt to create it.
16906 See section &<<SECTgnutlsparam>>& for further details.
16907
16908 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16909 a default DH prime; the default is the 2048 bit prime described in section
16910 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16911 in IKE is assigned number 23.
16912
16913 Otherwise, the option must expand to the name used by Exim for any of a number
16914 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16915 "ike" followed by the number used by IKE, of "default" which corresponds to
16916 "ike23".
16917
16918 The available primes are:
16919 &`ike1`&, &`ike2`&, &`ike5`&,
16920 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16921 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16922
16923 Some of these will be too small to be accepted by clients.
16924 Some may be too large to be accepted by clients.
16925
16926 The TLS protocol does not negotiate an acceptable size for this; clients tend
16927 to hard-drop connections if what is offered by the server is unacceptable,
16928 whether too large or too small, and there's no provision for the client to
16929 tell the server what these constraints are.  Thus, as a server operator, you
16930 need to make an educated guess as to what is most likely to work for your
16931 userbase.
16932
16933 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16934 is most likely to maximise interoperability.  The upper bound comes from
16935 applications using the Mozilla Network Security Services (NSS) library, which
16936 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16937 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16938 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16939 acceptable bound from 1024 to 2048.
16940
16941
16942 .option tls_eccurve main string&!! prime256v1
16943 .cindex TLS "EC cryptography"
16944 If built with a recent-enough version of OpenSSL,
16945 this option selects a EC curve for use by Exim.
16946
16947 Curve names of the form &'prime256v1'& are accepted.
16948 For even more-recent library versions, names of the form &'P-512'&
16949 are also accepted, plus the special value &'auto'&
16950 which tells the library to choose.
16951
16952 If the option is set to an empty string, no EC curves will be enabled.
16953
16954
16955 .option tls_ocsp_file main string&!! unset
16956 .cindex TLS "certificate status"
16957 .cindex TLS "OCSP proof file"
16958 This option
16959 must if set expand to the absolute path to a file which contains a current
16960 status proof for the server's certificate, as obtained from the
16961 Certificate Authority.
16962
16963 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16964
16965
16966 .option tls_on_connect_ports main "string list" unset
16967 .cindex SSMTP
16968 .cindex SMTPS
16969 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16970 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16971 set up without waiting for the client to issue a STARTTLS command. For
16972 further details, see section &<<SECTsupobssmt>>&.
16973
16974
16975
16976 .option tls_privatekey main string&!! unset
16977 .cindex "TLS" "server private key; location of"
16978 The value of this option is expanded, and must then be the absolute path to a
16979 file which contains the server's private key. If this option is unset, or if
16980 the expansion is forced to fail, or the result is an empty string, the private
16981 key is assumed to be in the same file as the server's certificates. See chapter
16982 &<<CHAPTLS>>& for further details.
16983
16984 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16985
16986
16987 .option tls_remember_esmtp main boolean false
16988 .cindex "TLS" "esmtp state; remembering"
16989 .cindex "TLS" "broken clients"
16990 If this option is set true, Exim violates the RFCs by remembering that it is in
16991 &"esmtp"& state after successfully negotiating a TLS session. This provides
16992 support for broken clients that fail to send a new EHLO after starting a
16993 TLS session.
16994
16995
16996 .option tls_require_ciphers main string&!! unset
16997 .cindex "TLS" "requiring specific ciphers"
16998 .cindex "cipher" "requiring specific"
16999 This option controls which ciphers can be used for incoming TLS connections.
17000 The &(smtp)& transport has an option of the same name for controlling outgoing
17001 connections. This option is expanded for each connection, so can be varied for
17002 different clients if required. The value of this option must be a list of
17003 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17004 in somewhat different ways. If GnuTLS is being used, the client controls the
17005 preference order of the available ciphers. Details are given in sections
17006 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17007
17008
17009 .option tls_try_verify_hosts main "host list&!!" unset
17010 .cindex "TLS" "client certificate verification"
17011 .cindex "certificate" "verification of client"
17012 See &%tls_verify_hosts%& below.
17013
17014
17015 .option tls_verify_certificates main string&!! system
17016 .cindex "TLS" "client certificate verification"
17017 .cindex "certificate" "verification of client"
17018 The value of this option is expanded, and must then be either the
17019 word "system"
17020 or the absolute path to
17021 a file or directory containing permitted certificates for clients that
17022 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17023
17024 The "system" value for the option will use a
17025 system default location compiled into the SSL library.
17026 This is not available for GnuTLS versions preceding 3.0.20,
17027 and will be taken as empty; an explicit location
17028 must be specified.
17029
17030 The use of a directory for the option value is not available for GnuTLS versions
17031 preceding 3.3.6 and a single file must be used.
17032
17033 With OpenSSL the certificates specified
17034 explicitly
17035 either by file or directory
17036 are added to those given by the system default location.
17037
17038 These certificates should be for the certificate authorities trusted, rather
17039 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17040 the value is a file then the certificates are sent by Exim as a server to
17041 connecting clients, defining the list of accepted certificate authorities.
17042 Thus the values defined should be considered public data.  To avoid this,
17043 use the explicit directory version.
17044
17045 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17046
17047 A forced expansion failure or setting to an empty string is equivalent to
17048 being unset.
17049
17050
17051 .option tls_verify_hosts main "host list&!!" unset
17052 .cindex "TLS" "client certificate verification"
17053 .cindex "certificate" "verification of client"
17054 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17055 certificates from clients. The expected certificates are defined by
17056 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17057 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17058 &%tls_verify_certificates%& is not set.
17059
17060 Any client that matches &%tls_verify_hosts%& is constrained by
17061 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17062 present one of the listed certificates. If it does not, the connection is
17063 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17064 the host to use TLS. It can still send SMTP commands through unencrypted
17065 connections. Forcing a client to use TLS has to be done separately using an
17066 ACL to reject inappropriate commands when the connection is not encrypted.
17067
17068 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17069 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17070 certificate and checks it against &%tls_verify_certificates%&, but does not
17071 abort the connection if there is no certificate or if it does not match. This
17072 state can be detected in an ACL, which makes it possible to implement policies
17073 such as &"accept for relay only if a verified certificate has been received,
17074 but accept for local delivery if encrypted, even without a verified
17075 certificate"&.
17076
17077 Client hosts that match neither of these lists are not asked to present
17078 certificates.
17079
17080
17081 .option trusted_groups main "string list&!!" unset
17082 .cindex "trusted groups"
17083 .cindex "groups" "trusted"
17084 This option is expanded just once, at the start of Exim's processing. If this
17085 option is set, any process that is running in one of the listed groups, or
17086 which has one of them as a supplementary group, is trusted. The groups can be
17087 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17088 details of what trusted callers are permitted to do. If neither
17089 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17090 are trusted.
17091
17092 .option trusted_users main "string list&!!" unset
17093 .cindex "trusted users"
17094 .cindex "user" "trusted"
17095 This option is expanded just once, at the start of Exim's processing. If this
17096 option is set, any process that is running as one of the listed users is
17097 trusted. The users can be specified numerically or by name. See section
17098 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17099 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17100 Exim user are trusted.
17101
17102 .option unknown_login main string&!! unset
17103 .cindex "uid (user id)" "unknown caller"
17104 .vindex "&$caller_uid$&"
17105 This is a specialized feature for use in unusual configurations. By default, if
17106 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17107 gives up. The &%unknown_login%& option can be used to set a login name to be
17108 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17109 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17110 is used for the user's real name (gecos field), unless this has been set by the
17111 &%-F%& option.
17112
17113 .option unknown_username main string unset
17114 See &%unknown_login%&.
17115
17116 .option untrusted_set_sender main "address list&!!" unset
17117 .cindex "trusted users"
17118 .cindex "sender" "setting by untrusted user"
17119 .cindex "untrusted user setting sender"
17120 .cindex "user" "untrusted setting sender"
17121 .cindex "envelope sender"
17122 When an untrusted user submits a message to Exim using the standard input, Exim
17123 normally creates an envelope sender address from the user's login and the
17124 default qualification domain. Data from the &%-f%& option (for setting envelope
17125 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17126 is used) is ignored.
17127
17128 However, untrusted users are permitted to set an empty envelope sender address,
17129 to declare that a message should never generate any bounces. For example:
17130 .code
17131 exim -f '<>' user@domain.example
17132 .endd
17133 .vindex "&$sender_ident$&"
17134 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17135 other envelope sender addresses in a controlled way. When it is set, untrusted
17136 users are allowed to set envelope sender addresses that match any of the
17137 patterns in the list. Like all address lists, the string is expanded. The
17138 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17139 users to setting senders that start with their login ids
17140 followed by a hyphen
17141 by a setting like this:
17142 .code
17143 untrusted_set_sender = ^$sender_ident-
17144 .endd
17145 If you want to allow untrusted users to set envelope sender addresses without
17146 restriction, you can use
17147 .code
17148 untrusted_set_sender = *
17149 .endd
17150 The &%untrusted_set_sender%& option applies to all forms of local input, but
17151 only to the setting of the envelope sender. It does not permit untrusted users
17152 to use the other options which trusted user can use to override message
17153 parameters. Furthermore, it does not stop Exim from removing an existing
17154 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17155 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17156 overriding these actions. The handling of the &'Sender:'& header is also
17157 described in section &<<SECTthesenhea>>&.
17158
17159 The log line for a message's arrival shows the envelope sender following
17160 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17161 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17162 envelope sender address, the user's login is shown in parentheses after the
17163 sender address.
17164
17165
17166 .option uucp_from_pattern main string "see below"
17167 .cindex "&""From""& line"
17168 .cindex "UUCP" "&""From""& line"
17169 Some applications that pass messages to an MTA via a command line interface use
17170 an initial line starting with &"From&~"& to pass the envelope sender. In
17171 particular, this is used by UUCP software. Exim recognizes such a line by means
17172 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17173 matches, the sender address is constructed by expanding the contents of
17174 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17175 default pattern recognizes lines in the following two forms:
17176 .code
17177 From ph10 Fri Jan  5 12:35 GMT 1996
17178 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17179 .endd
17180 The pattern can be seen by running
17181 .code
17182 exim -bP uucp_from_pattern
17183 .endd
17184 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17185 year in the second case. The first word after &"From&~"& is matched in the
17186 regular expression by a parenthesized subpattern. The default value for
17187 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17188 (&"ph10"& in the example above) as the message's sender. See also
17189 &%ignore_fromline_hosts%&.
17190
17191
17192 .option uucp_from_sender main string&!! &`$1`&
17193 See &%uucp_from_pattern%& above.
17194
17195
17196 .option warn_message_file main string unset
17197 .cindex "warning of delay" "customizing the message"
17198 .cindex "customizing" "warning message"
17199 This option defines a template file containing paragraphs of text to be used
17200 for constructing the warning message which is sent by Exim when a message has
17201 been on the queue for a specified amount of time, as specified by
17202 &%delay_warning%&. Details of the file's contents are given in chapter
17203 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17204
17205
17206 .option write_rejectlog main boolean true
17207 .cindex "reject log" "disabling"
17208 If this option is set false, Exim no longer writes anything to the reject log.
17209 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17210 .ecindex IIDconfima
17211 .ecindex IIDmaiconf
17212
17213
17214
17215
17216 . ////////////////////////////////////////////////////////////////////////////
17217 . ////////////////////////////////////////////////////////////////////////////
17218
17219 .chapter "Generic options for routers" "CHAProutergeneric"
17220 .scindex IIDgenoprou1 "options" "generic; for routers"
17221 .scindex IIDgenoprou2 "generic options" "router"
17222 This chapter describes the generic options that apply to all routers.
17223 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17224
17225 For a general description of how a router operates, see sections
17226 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17227 which the preconditions are tested. The order of expansion of the options that
17228 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17229 &%headers_remove%&, &%transport%&.
17230
17231
17232
17233 .option address_data routers string&!! unset
17234 .cindex "router" "data attached to address"
17235 The string is expanded just before the router is run, that is, after all the
17236 precondition tests have succeeded. If the expansion is forced to fail, the
17237 router declines, the value of &%address_data%& remains unchanged, and the
17238 &%more%& option controls what happens next. Other expansion failures cause
17239 delivery of the address to be deferred.
17240
17241 .vindex "&$address_data$&"
17242 When the expansion succeeds, the value is retained with the address, and can be
17243 accessed using the variable &$address_data$& in the current router, subsequent
17244 routers, and the eventual transport.
17245
17246 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17247 that runs a user's filter file, the contents of &$address_data$& are accessible
17248 in the filter. This is not normally a problem, because such data is usually
17249 either not confidential or it &"belongs"& to the current user, but if you do
17250 put confidential data into &$address_data$& you need to remember this point.
17251
17252 Even if the router declines or passes, the value of &$address_data$& remains
17253 with the address, though it can be changed by another &%address_data%& setting
17254 on a subsequent router. If a router generates child addresses, the value of
17255 &$address_data$& propagates to them. This also applies to the special kind of
17256 &"child"& that is generated by a router with the &%unseen%& option.
17257
17258 The idea of &%address_data%& is that you can use it to look up a lot of data
17259 for the address once, and then pick out parts of the data later. For example,
17260 you could use a single LDAP lookup to return a string of the form
17261 .code
17262 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17263 .endd
17264 In the transport you could pick out the mailbox by a setting such as
17265 .code
17266 file = ${extract{mailbox}{$address_data}}
17267 .endd
17268 This makes the configuration file less messy, and also reduces the number of
17269 lookups (though Exim does cache lookups).
17270
17271 .vindex "&$sender_address_data$&"
17272 .vindex "&$address_data$&"
17273 The &%address_data%& facility is also useful as a means of passing information
17274 from one router to another, and from a router to a transport. In addition, if
17275 &$address_data$& is set by a router when verifying a recipient address from an
17276 ACL, it remains available for use in the rest of the ACL statement. After
17277 verifying a sender, the value is transferred to &$sender_address_data$&.
17278
17279
17280
17281 .option address_test routers&!? boolean true
17282 .oindex "&%-bt%&"
17283 .cindex "router" "skipping when address testing"
17284 If this option is set false, the router is skipped when routing is being tested
17285 by means of the &%-bt%& command line option. This can be a convenience when
17286 your first router sends messages to an external scanner, because it saves you
17287 having to set the &"already scanned"& indicator when testing real address
17288 routing.
17289
17290
17291
17292 .option cannot_route_message routers string&!! unset
17293 .cindex "router" "customizing &""cannot route""& message"
17294 .cindex "customizing" "&""cannot route""& message"
17295 This option specifies a text message that is used when an address cannot be
17296 routed because Exim has run out of routers. The default message is
17297 &"Unrouteable address"&. This option is useful only on routers that have
17298 &%more%& set false, or on the very last router in a configuration, because the
17299 value that is used is taken from the last router that is considered. This
17300 includes a router that is skipped because its preconditions are not met, as
17301 well as a router that declines. For example, using the default configuration,
17302 you could put:
17303 .code
17304 cannot_route_message = Remote domain not found in DNS
17305 .endd
17306 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17307 and
17308 .code
17309 cannot_route_message = Unknown local user
17310 .endd
17311 on the final router that checks for local users. If string expansion fails for
17312 this option, the default message is used. Unless the expansion failure was
17313 explicitly forced, a message about the failure is written to the main and panic
17314 logs, in addition to the normal message about the routing failure.
17315
17316
17317 .option caseful_local_part routers boolean false
17318 .cindex "case of local parts"
17319 .cindex "router" "case of local parts"
17320 By default, routers handle the local parts of addresses in a case-insensitive
17321 manner, though the actual case is preserved for transmission with the message.
17322 If you want the case of letters to be significant in a router, you must set
17323 this option true. For individual router options that contain address or local
17324 part lists (for example, &%local_parts%&), case-sensitive matching can be
17325 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17326 more details.
17327
17328 .vindex "&$local_part$&"
17329 .vindex "&$original_local_part$&"
17330 .vindex "&$parent_local_part$&"
17331 The value of the &$local_part$& variable is forced to lower case while a
17332 router is running unless &%caseful_local_part%& is set. When a router assigns
17333 an address to a transport, the value of &$local_part$& when the transport runs
17334 is the same as it was in the router. Similarly, when a router generates child
17335 addresses by aliasing or forwarding, the values of &$original_local_part$&
17336 and &$parent_local_part$& are those that were used by the redirecting router.
17337
17338 This option applies to the processing of an address by a router. When a
17339 recipient address is being processed in an ACL, there is a separate &%control%&
17340 modifier that can be used to specify case-sensitive processing within the ACL
17341 (see section &<<SECTcontrols>>&).
17342
17343
17344
17345 .option check_local_user routers&!? boolean false
17346 .cindex "local user, checking in router"
17347 .cindex "router" "checking for local user"
17348 .cindex "&_/etc/passwd_&"
17349 .vindex "&$home$&"
17350 When this option is true, Exim checks that the local part of the recipient
17351 address (with affixes removed if relevant) is the name of an account on the
17352 local system. The check is done by calling the &[getpwnam()]& function rather
17353 than trying to read &_/etc/passwd_& directly. This means that other methods of
17354 holding password data (such as NIS) are supported. If the local part is a local
17355 user, &$home$& is set from the password data, and can be tested in other
17356 preconditions that are evaluated after this one (the order of evaluation is
17357 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17358 overridden by &%router_home_directory%&. If the local part is not a local user,
17359 the router is skipped.
17360
17361 If you want to check that the local part is either the name of a local user
17362 or matches something else, you cannot combine &%check_local_user%& with a
17363 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17364 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17365 setting to achieve this. For example:
17366 .code
17367 local_parts = passwd;$local_part : lsearch;/etc/other/users
17368 .endd
17369 Note, however, that the side effects of &%check_local_user%& (such as setting
17370 up a home directory) do not occur when a &(passwd)& lookup is used in a
17371 &%local_parts%& (or any other) precondition.
17372
17373
17374
17375 .option condition routers&!? string&!! unset
17376 .cindex "router" "customized precondition"
17377 This option specifies a general precondition test that has to succeed for the
17378 router to be called. The &%condition%& option is the last precondition to be
17379 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17380 result is a forced failure, or an empty string, or one of the strings &"0"& or
17381 &"no"& or &"false"& (checked without regard to the case of the letters), the
17382 router is skipped, and the address is offered to the next one.
17383
17384 If the result is any other value, the router is run (as this is the last
17385 precondition to be evaluated, all the other preconditions must be true).
17386
17387 This option is unusual in that multiple &%condition%& options may be present.
17388 All &%condition%& options must succeed.
17389
17390 The &%condition%& option provides a means of applying custom conditions to the
17391 running of routers. Note that in the case of a simple conditional expansion,
17392 the default expansion values are exactly what is wanted. For example:
17393 .code
17394 condition = ${if >{$message_age}{600}}
17395 .endd
17396 Because of the default behaviour of the string expansion, this is equivalent to
17397 .code
17398 condition = ${if >{$message_age}{600}{true}{}}
17399 .endd
17400
17401 A multiple condition example, which succeeds:
17402 .code
17403 condition = ${if >{$message_age}{600}}
17404 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17405 condition = foobar
17406 .endd
17407
17408 If the expansion fails (other than forced failure) delivery is deferred. Some
17409 of the other precondition options are common special cases that could in fact
17410 be specified using &%condition%&.
17411
17412 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17413 are far older, and use one set of semantics.  ACLs are newer and when
17414 they were created, the ACL &%condition%& process was given far stricter
17415 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17416 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17417 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17418 Router rules processing behavior.
17419
17420 This is best illustrated in an example:
17421 .code
17422 # If used in an ACL condition will fail with a syntax error, but
17423 # in a router condition any extra characters are treated as a string
17424
17425 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17426 true {yes} {no}}
17427
17428 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17429  {yes} {no}}
17430 .endd
17431 In each example above, the &%if%& statement actually ends after
17432 &"{google.com}}"&.  Since no true or false braces were defined, the
17433 default &%if%& behavior is to return a boolean true or a null answer
17434 (which evaluates to false). The rest of the line is then treated as a
17435 string. So the first example resulted in the boolean answer &"true"&
17436 with the string &" {yes} {no}}"& appended to it. The second example
17437 resulted in the null output (indicating false) with the string
17438 &" {yes} {no}}"& appended to it.
17439
17440 In fact you can put excess forward braces in too.  In the router
17441 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17442 mean something, like after a &"$"& or when required as part of a
17443 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17444 string characters.
17445
17446 Thus, in a Router, the above expansion strings will both always evaluate
17447 true, as the result of expansion is a non-empty string which doesn't
17448 match an explicit false value.  This can be tricky to debug.  By
17449 contrast, in an ACL either of those strings will always result in an
17450 expansion error because the result doesn't look sufficiently boolean.
17451
17452
17453 .option debug_print routers string&!! unset
17454 .cindex "testing" "variables in drivers"
17455 If this option is set and debugging is enabled (see the &%-d%& command line
17456 option) or in address-testing mode (see the &%-bt%& command line option),
17457 the string is expanded and included in the debugging output.
17458 If expansion of the string fails, the error message is written to the debugging
17459 output, and Exim carries on processing.
17460 This option is provided to help with checking out the values of variables and
17461 so on when debugging router configurations. For example, if a &%condition%&
17462 option appears not to be working, &%debug_print%& can be used to output the
17463 variables it references. The output happens after checks for &%domains%&,
17464 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17465 are tested. A newline is added to the text if it does not end with one.
17466 The variable &$router_name$& contains the name of the router.
17467
17468
17469
17470 .option disable_logging routers boolean false
17471 If this option is set true, nothing is logged for any routing errors
17472 or for any deliveries caused by this router. You should not set this option
17473 unless you really, really know what you are doing. See also the generic
17474 transport option of the same name.
17475
17476 .option dnssec_request_domains routers "domain list&!!" unset
17477 .cindex "MX record" "security"
17478 .cindex "DNSSEC" "MX lookup"
17479 .cindex "security" "MX lookup"
17480 .cindex "DNS" "DNSSEC"
17481 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17482 the dnssec request bit set.
17483 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17484
17485 .option dnssec_require_domains routers "domain list&!!" unset
17486 .cindex "MX record" "security"
17487 .cindex "DNSSEC" "MX lookup"
17488 .cindex "security" "MX lookup"
17489 .cindex "DNS" "DNSSEC"
17490 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17491 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17492 (AD bit) set will be ignored and logged as a host-lookup failure.
17493 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17494
17495
17496 .option domains routers&!? "domain list&!!" unset
17497 .cindex "router" "restricting to specific domains"
17498 .vindex "&$domain_data$&"
17499 If this option is set, the router is skipped unless the current domain matches
17500 the list. If the match is achieved by means of a file lookup, the data that the
17501 lookup returned for the domain is placed in &$domain_data$& for use in string
17502 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17503 a list of the order in which preconditions are evaluated.
17504
17505
17506
17507 .option driver routers string unset
17508 This option must always be set. It specifies which of the available routers is
17509 to be used.
17510
17511
17512 .option dsn_lasthop routers boolean false
17513 .cindex "DSN" "success"
17514 .cindex "Delivery Status Notification" "success"
17515 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17516 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17517 instead send a success DSN as if the next hop does not support DSN.
17518 Not effective on redirect routers.
17519
17520
17521
17522 .option errors_to routers string&!! unset
17523 .cindex "envelope sender"
17524 .cindex "router" "changing address for errors"
17525 If a router successfully handles an address, it may assign the address to a
17526 transport for delivery or it may generate child addresses. In both cases, if
17527 there is a delivery problem during later processing, the resulting bounce
17528 message is sent to the address that results from expanding this string,
17529 provided that the address verifies successfully. The &%errors_to%& option is
17530 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17531
17532 The &%errors_to%& setting associated with an address can be overridden if it
17533 subsequently passes through other routers that have their own &%errors_to%&
17534 settings, or if the message is delivered by a transport with a &%return_path%&
17535 setting.
17536
17537 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17538 the expansion fails to verify, the errors address associated with the incoming
17539 address is used. At top level, this is the envelope sender. A non-forced
17540 expansion failure causes delivery to be deferred.
17541
17542 If an address for which &%errors_to%& has been set ends up being delivered over
17543 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17544 any bounces that are generated by other MTAs on the delivery route are also
17545 sent there. You can set &%errors_to%& to the empty string by either of these
17546 settings:
17547 .code
17548 errors_to =
17549 errors_to = ""
17550 .endd
17551 An expansion item that yields an empty string has the same effect. If you do
17552 this, a locally detected delivery error for addresses processed by this router
17553 no longer gives rise to a bounce message; the error is discarded. If the
17554 address is delivered to a remote host, the return path is set to &`<>`&, unless
17555 overridden by the &%return_path%& option on the transport.
17556
17557 .vindex "&$address_data$&"
17558 If for some reason you want to discard local errors, but use a non-empty
17559 MAIL command for remote delivery, you can preserve the original return
17560 path in &$address_data$& in the router, and reinstate it in the transport by
17561 setting &%return_path%&.
17562
17563 The most common use of &%errors_to%& is to direct mailing list bounces to the
17564 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17565 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17566
17567
17568
17569 .option expn routers&!? boolean true
17570 .cindex "address" "testing"
17571 .cindex "testing" "addresses"
17572 .cindex "EXPN" "router skipping"
17573 .cindex "router" "skipping for EXPN"
17574 If this option is turned off, the router is skipped when testing an address
17575 as a result of processing an SMTP EXPN command. You might, for example,
17576 want to turn it off on a router for users' &_.forward_& files, while leaving it
17577 on for the system alias file.
17578 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17579 are evaluated.
17580
17581 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17582 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17583 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17584
17585
17586
17587 .option fail_verify routers boolean false
17588 .cindex "router" "forcing verification failure"
17589 Setting this option has the effect of setting both &%fail_verify_sender%& and
17590 &%fail_verify_recipient%& to the same value.
17591
17592
17593
17594 .option fail_verify_recipient routers boolean false
17595 If this option is true and an address is accepted by this router when
17596 verifying a recipient, verification fails.
17597
17598
17599
17600 .option fail_verify_sender routers boolean false
17601 If this option is true and an address is accepted by this router when
17602 verifying a sender, verification fails.
17603
17604
17605
17606 .option fallback_hosts routers "string list" unset
17607 .cindex "router" "fallback hosts"
17608 .cindex "fallback" "hosts specified on router"
17609 String expansion is not applied to this option. The argument must be a
17610 colon-separated list of host names or IP addresses. The list separator can be
17611 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17612 each name or address. In fact, the format of each item is exactly the same as
17613 defined for the list of hosts in a &(manualroute)& router (see section
17614 &<<SECTformatonehostitem>>&).
17615
17616 If a router queues an address for a remote transport, this host list is
17617 associated with the address, and used instead of the transport's fallback host
17618 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17619 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17620 transport for further details.
17621
17622
17623 .option group routers string&!! "see below"
17624 .cindex "gid (group id)" "local delivery"
17625 .cindex "local transports" "uid and gid"
17626 .cindex "transport" "local"
17627 .cindex "router" "setting group"
17628 When a router queues an address for a transport, and the transport does not
17629 specify a group, the group given here is used when running the delivery
17630 process.
17631 The group may be specified numerically or by name. If expansion fails, the
17632 error is logged and delivery is deferred.
17633 The default is unset, unless &%check_local_user%& is set, when the default
17634 is taken from the password information. See also &%initgroups%& and &%user%&
17635 and the discussion in chapter &<<CHAPenvironment>>&.
17636
17637
17638
17639 .option headers_add routers list&!! unset
17640 .cindex "header lines" "adding"
17641 .cindex "router" "adding header lines"
17642 This option specifies a list of text headers,
17643 newline-separated (by default, changeable in the usual way),
17644 that is associated with any addresses that are accepted by the router.
17645 Each item is separately expanded, at routing time.  However, this
17646 option has no effect when an address is just being verified. The way in which
17647 the text is used to add header lines at transport time is described in section
17648 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17649 message is in the process of being transported. This means that references to
17650 header lines in string expansions in the transport's configuration do not
17651 &"see"& the added header lines.
17652
17653 The &%headers_add%& option is expanded after &%errors_to%&, but before
17654 &%headers_remove%& and &%transport%&. If an item is empty, or if
17655 an item expansion is forced to fail, the item has no effect. Other expansion
17656 failures are treated as configuration errors.
17657
17658 Unlike most options, &%headers_add%& can be specified multiple times
17659 for a router; all listed headers are added.
17660
17661 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17662 router that has the &%one_time%& option set.
17663
17664 .cindex "duplicate addresses"
17665 .oindex "&%unseen%&"
17666 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17667 additions are deleted when the address is passed on to subsequent routers.
17668 For a &%redirect%& router, if a generated address is the same as the incoming
17669 address, this can lead to duplicate addresses with different header
17670 modifications. Exim does not do duplicate deliveries (except, in certain
17671 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17672 which of the duplicates is discarded, so this ambiguous situation should be
17673 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17674
17675
17676
17677 .option headers_remove routers list&!! unset
17678 .cindex "header lines" "removing"
17679 .cindex "router" "removing header lines"
17680 This option specifies a list of text headers,
17681 colon-separated (by default, changeable in the usual way),
17682 that is associated with any addresses that are accepted by the router.
17683 Each item is separately expanded, at routing time.  However, this
17684 option has no effect when an address is just being verified. The way in which
17685 the text is used to remove header lines at transport time is described in
17686 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17687 the message is in the process of being transported. This means that references
17688 to header lines in string expansions in the transport's configuration still
17689 &"see"& the original header lines.
17690
17691 The &%headers_remove%& option is expanded after &%errors_to%& and
17692 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17693 the item has no effect. Other expansion failures are treated as configuration
17694 errors.
17695
17696 Unlike most options, &%headers_remove%& can be specified multiple times
17697 for a router; all listed headers are removed.
17698
17699 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17700 router that has the &%one_time%& option set.
17701
17702 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17703 removal requests are deleted when the address is passed on to subsequent
17704 routers, and this can lead to problems with duplicates -- see the similar
17705 warning for &%headers_add%& above.
17706
17707 &*Warning 3*&: Because of the separate expansion of the list items,
17708 items that contain a list separator must have it doubled.
17709 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17710
17711
17712
17713 .option ignore_target_hosts routers "host list&!!" unset
17714 .cindex "IP address" "discarding"
17715 .cindex "router" "discarding IP addresses"
17716 Although this option is a host list, it should normally contain IP address
17717 entries rather than names. If any host that is looked up by the router has an
17718 IP address that matches an item in this list, Exim behaves as if that IP
17719 address did not exist. This option allows you to cope with rogue DNS entries
17720 like
17721 .code
17722 remote.domain.example.  A  127.0.0.1
17723 .endd
17724 by setting
17725 .code
17726 ignore_target_hosts = 127.0.0.1
17727 .endd
17728 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17729 discarded in this way, the router declines. In a conventional configuration, an
17730 attempt to mail to such a domain would normally provoke the &"unrouteable
17731 domain"& error, and an attempt to verify an address in the domain would fail.
17732 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17733 router declines if presented with one of the listed addresses.
17734
17735 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17736 means of the first or the second of the following settings, respectively:
17737 .code
17738 ignore_target_hosts = 0.0.0.0/0
17739 ignore_target_hosts = <; 0::0/0
17740 .endd
17741 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17742 in the second line matches all IPv6 addresses.
17743
17744 This option may also be useful for ignoring link-local and site-local IPv6
17745 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17746 is expanded before use as a list, it is possible to make it dependent on the
17747 domain that is being routed.
17748
17749 .vindex "&$host_address$&"
17750 During its expansion, &$host_address$& is set to the IP address that is being
17751 checked.
17752
17753 .option initgroups routers boolean false
17754 .cindex "additional groups"
17755 .cindex "groups" "additional"
17756 .cindex "local transports" "uid and gid"
17757 .cindex "transport" "local"
17758 If the router queues an address for a transport, and this option is true, and
17759 the uid supplied by the router is not overridden by the transport, the
17760 &[initgroups()]& function is called when running the transport to ensure that
17761 any additional groups associated with the uid are set up. See also &%group%&
17762 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17763
17764
17765
17766 .option local_part_prefix routers&!? "string list" unset
17767 .cindex "router" "prefix for local part"
17768 .cindex "prefix" "for local part, used in router"
17769 If this option is set, the router is skipped unless the local part starts with
17770 one of the given strings, or &%local_part_prefix_optional%& is true. See
17771 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17772 evaluated.
17773
17774 The list is scanned from left to right, and the first prefix that matches is
17775 used. A limited form of wildcard is available; if the prefix begins with an
17776 asterisk, it matches the longest possible sequence of arbitrary characters at
17777 the start of the local part. An asterisk should therefore always be followed by
17778 some character that does not occur in normal local parts.
17779 .cindex "multiple mailboxes"
17780 .cindex "mailbox" "multiple"
17781 Wildcarding can be used to set up multiple user mailboxes, as described in
17782 section &<<SECTmulbox>>&.
17783
17784 .vindex "&$local_part$&"
17785 .vindex "&$local_part_prefix$&"
17786 During the testing of the &%local_parts%& option, and while the router is
17787 running, the prefix is removed from the local part, and is available in the
17788 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17789 the router accepts the address, this remains true during subsequent delivery by
17790 a transport. In particular, the local part that is transmitted in the RCPT
17791 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17792 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17793 the relevant transport.
17794
17795 When an address is being verified, &%local_part_prefix%& affects only the
17796 behaviour of the router. If the callout feature of verification is in use, this
17797 means that the full address, including the prefix, will be used during the
17798 callout.
17799
17800 The prefix facility is commonly used to handle local parts of the form
17801 &%owner-something%&. Another common use is to support local parts of the form
17802 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17803 to tell a user their forwarding is broken &-- by placing a router like this one
17804 immediately before the router that handles &_.forward_& files:
17805 .code
17806 real_localuser:
17807   driver = accept
17808   local_part_prefix = real-
17809   check_local_user
17810   transport = local_delivery
17811 .endd
17812 For security, it would probably be a good idea to restrict the use of this
17813 router to locally-generated messages, using a condition such as this:
17814 .code
17815   condition = ${if match {$sender_host_address}\
17816                          {\N^(|127\.0\.0\.1)$\N}}
17817 .endd
17818
17819 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17820 both conditions must be met if not optional. Care must be taken if wildcards
17821 are used in both a prefix and a suffix on the same router. Different
17822 separator characters must be used to avoid ambiguity.
17823
17824
17825 .option local_part_prefix_optional routers boolean false
17826 See &%local_part_prefix%& above.
17827
17828
17829
17830 .option local_part_suffix routers&!? "string list" unset
17831 .cindex "router" "suffix for local part"
17832 .cindex "suffix for local part" "used in router"
17833 This option operates in the same way as &%local_part_prefix%&, except that the
17834 local part must end (rather than start) with the given string, the
17835 &%local_part_suffix_optional%& option determines whether the suffix is
17836 mandatory, and the wildcard * character, if present, must be the last
17837 character of the suffix. This option facility is commonly used to handle local
17838 parts of the form &%something-request%& and multiple user mailboxes of the form
17839 &%username-foo%&.
17840
17841
17842 .option local_part_suffix_optional routers boolean false
17843 See &%local_part_suffix%& above.
17844
17845
17846
17847 .option local_parts routers&!? "local part list&!!" unset
17848 .cindex "router" "restricting to specific local parts"
17849 .cindex "local part" "checking in router"
17850 The router is run only if the local part of the address matches the list.
17851 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17852 are evaluated, and
17853 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17854 string is expanded, it is possible to make it depend on the domain, for
17855 example:
17856 .code
17857 local_parts = dbm;/usr/local/specials/$domain
17858 .endd
17859 .vindex "&$local_part_data$&"
17860 If the match is achieved by a lookup, the data that the lookup returned
17861 for the local part is placed in the variable &$local_part_data$& for use in
17862 expansions of the router's private options. You might use this option, for
17863 example, if you have a large number of local virtual domains, and you want to
17864 send all postmaster mail to the same place without having to set up an alias in
17865 each virtual domain:
17866 .code
17867 postmaster:
17868   driver = redirect
17869   local_parts = postmaster
17870   data = postmaster@real.domain.example
17871 .endd
17872
17873
17874 .option log_as_local routers boolean "see below"
17875 .cindex "log" "delivery line"
17876 .cindex "delivery" "log line format"
17877 Exim has two logging styles for delivery, the idea being to make local
17878 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17879 recipient address is given just as the local part, without a domain. The use of
17880 this style is controlled by this option. It defaults to true for the &(accept)&
17881 router, and false for all the others. This option applies only when a
17882 router assigns an address to a transport. It has no effect on routers that
17883 redirect addresses.
17884
17885
17886
17887 .option more routers boolean&!! true
17888 The result of string expansion for this option must be a valid boolean value,
17889 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17890 result causes an error, and delivery is deferred. If the expansion is forced to
17891 fail, the default value for the option (true) is used. Other failures cause
17892 delivery to be deferred.
17893
17894 If this option is set false, and the router declines to handle the address, no
17895 further routers are tried, routing fails, and the address is bounced.
17896 .oindex "&%self%&"
17897 However, if the router explicitly passes an address to the following router by
17898 means of the setting
17899 .code
17900 self = pass
17901 .endd
17902 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17903 does not affect the behaviour if one of the precondition tests fails. In that
17904 case, the address is always passed to the next router.
17905
17906 Note that &%address_data%& is not considered to be a precondition. If its
17907 expansion is forced to fail, the router declines, and the value of &%more%&
17908 controls what happens next.
17909
17910
17911 .option pass_on_timeout routers boolean false
17912 .cindex "timeout" "of router"
17913 .cindex "router" "timeout"
17914 If a router times out during a host lookup, it normally causes deferral of the
17915 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17916 router, overriding &%no_more%&. This may be helpful for systems that are
17917 intermittently connected to the Internet, or those that want to pass to a smart
17918 host any messages that cannot immediately be delivered.
17919
17920 There are occasional other temporary errors that can occur while doing DNS
17921 lookups. They are treated in the same way as a timeout, and this option
17922 applies to all of them.
17923
17924
17925
17926 .option pass_router routers string unset
17927 .cindex "router" "go to after &""pass""&"
17928 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17929 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17930 routing to continue, and overriding a false setting of &%more%&. When one of
17931 these routers returns &"pass"&, the address is normally handed on to the next
17932 router in sequence. This can be changed by setting &%pass_router%& to the name
17933 of another router. However (unlike &%redirect_router%&) the named router must
17934 be below the current router, to avoid loops. Note that this option applies only
17935 to the special case of &"pass"&. It does not apply when a router returns
17936 &"decline"& because it cannot handle an address.
17937
17938
17939
17940 .option redirect_router routers string unset
17941 .cindex "router" "start at after redirection"
17942 Sometimes an administrator knows that it is pointless to reprocess addresses
17943 generated from alias or forward files with the same router again. For
17944 example, if an alias file translates real names into login ids there is no
17945 point searching the alias file a second time, especially if it is a large file.
17946
17947 The &%redirect_router%& option can be set to the name of any router instance.
17948 It causes the routing of any generated addresses to start at the named router
17949 instead of at the first router. This option has no effect if the router in
17950 which it is set does not generate new addresses.
17951
17952
17953
17954 .option require_files routers&!? "string list&!!" unset
17955 .cindex "file" "requiring for router"
17956 .cindex "router" "requiring file existence"
17957 This option provides a general mechanism for predicating the running of a
17958 router on the existence or non-existence of certain files or directories.
17959 Before running a router, as one of its precondition tests, Exim works its way
17960 through the &%require_files%& list, expanding each item separately.
17961
17962 Because the list is split before expansion, any colons in expansion items must
17963 be doubled, or the facility for using a different list separator must be used.
17964 If any expansion is forced to fail, the item is ignored. Other expansion
17965 failures cause routing of the address to be deferred.
17966
17967 If any expanded string is empty, it is ignored. Otherwise, except as described
17968 below, each string must be a fully qualified file path, optionally preceded by
17969 &"!"&. The paths are passed to the &[stat()]& function to test for the
17970 existence of the files or directories. The router is skipped if any paths not
17971 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17972
17973 .cindex "NFS"
17974 If &[stat()]& cannot determine whether a file exists or not, delivery of
17975 the message is deferred. This can happen when NFS-mounted filesystems are
17976 unavailable.
17977
17978 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17979 options, so you cannot use it to check for the existence of a file in which to
17980 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17981 full list of the order in which preconditions are evaluated.) However, as
17982 these options are all expanded, you can use the &%exists%& expansion condition
17983 to make such tests. The &%require_files%& option is intended for checking files
17984 that the router may be going to use internally, or which are needed by a
17985 transport (for example &_.procmailrc_&).
17986
17987 During delivery, the &[stat()]& function is run as root, but there is a
17988 facility for some checking of the accessibility of a file by another user.
17989 This is not a proper permissions check, but just a &"rough"& check that
17990 operates as follows:
17991
17992 If an item in a &%require_files%& list does not contain any forward slash
17993 characters, it is taken to be the user (and optional group, separated by a
17994 comma) to be checked for subsequent files in the list. If no group is specified
17995 but the user is specified symbolically, the gid associated with the uid is
17996 used. For example:
17997 .code
17998 require_files = mail:/some/file
17999 require_files = $local_part:$home/.procmailrc
18000 .endd
18001 If a user or group name in a &%require_files%& list does not exist, the
18002 &%require_files%& condition fails.
18003
18004 Exim performs the check by scanning along the components of the file path, and
18005 checking the access for the given uid and gid. It checks for &"x"& access on
18006 directories, and &"r"& access on the final file. Note that this means that file
18007 access control lists, if the operating system has them, are ignored.
18008
18009 &*Warning 1*&: When the router is being run to verify addresses for an
18010 incoming SMTP message, Exim is not running as root, but under its own uid. This
18011 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18012 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18013 user is not permitted to read one of the directories on the file's path.
18014
18015 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18016 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18017 without root access. In this case, if a check for access by a particular user
18018 is requested, Exim creates a subprocess that runs as that user, and tries the
18019 check again in that process.
18020
18021 The default action for handling an unresolved EACCES is to consider it to
18022 be caused by a configuration error, and routing is deferred because the
18023 existence or non-existence of the file cannot be determined. However, in some
18024 circumstances it may be desirable to treat this condition as if the file did
18025 not exist. If the file name (or the exclamation mark that precedes the file
18026 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18027 as if the file did not exist. For example:
18028 .code
18029 require_files = +/some/file
18030 .endd
18031 If the router is not an essential part of verification (for example, it
18032 handles users' &_.forward_& files), another solution is to set the &%verify%&
18033 option false so that the router is skipped when verifying.
18034
18035
18036
18037 .option retry_use_local_part routers boolean "see below"
18038 .cindex "hints database" "retry keys"
18039 .cindex "local part" "in retry keys"
18040 When a delivery suffers a temporary routing failure, a retry record is created
18041 in Exim's hints database. For addresses whose routing depends only on the
18042 domain, the key for the retry record should not involve the local part, but for
18043 other addresses, both the domain and the local part should be included.
18044 Usually, remote routing is of the former kind, and local routing is of the
18045 latter kind.
18046
18047 This option controls whether the local part is used to form the key for retry
18048 hints for addresses that suffer temporary errors while being handled by this
18049 router. The default value is true for any router that has &%check_local_user%&
18050 set, and false otherwise. Note that this option does not apply to hints keys
18051 for transport delays; they are controlled by a generic transport option of the
18052 same name.
18053
18054 The setting of &%retry_use_local_part%& applies only to the router on which it
18055 appears. If the router generates child addresses, they are routed
18056 independently; this setting does not become attached to them.
18057
18058
18059
18060 .option router_home_directory routers string&!! unset
18061 .cindex "router" "home directory for"
18062 .cindex "home directory" "for router"
18063 .vindex "&$home$&"
18064 This option sets a home directory for use while the router is running. (Compare
18065 &%transport_home_directory%&, which sets a home directory for later
18066 transporting.) In particular, if used on a &(redirect)& router, this option
18067 sets a value for &$home$& while a filter is running. The value is expanded;
18068 forced expansion failure causes the option to be ignored &-- other failures
18069 cause the router to defer.
18070
18071 Expansion of &%router_home_directory%& happens immediately after the
18072 &%check_local_user%& test (if configured), before any further expansions take
18073 place.
18074 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18075 are evaluated.)
18076 While the router is running, &%router_home_directory%& overrides the value of
18077 &$home$& that came from &%check_local_user%&.
18078
18079 When a router accepts an address and assigns it to a local transport (including
18080 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18081 delivery), the home directory setting for the transport is taken from the first
18082 of these values that is set:
18083
18084 .ilist
18085 The &%home_directory%& option on the transport;
18086 .next
18087 The &%transport_home_directory%& option on the router;
18088 .next
18089 The password data if &%check_local_user%& is set on the router;
18090 .next
18091 The &%router_home_directory%& option on the router.
18092 .endlist
18093
18094 In other words, &%router_home_directory%& overrides the password data for the
18095 router, but not for the transport.
18096
18097
18098
18099 .option self routers string freeze
18100 .cindex "MX record" "pointing to local host"
18101 .cindex "local host" "MX pointing to"
18102 This option applies to those routers that use a recipient address to find a
18103 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18104 and &(manualroute)& routers.
18105 Certain configurations of the &(queryprogram)& router can also specify a list
18106 of remote hosts.
18107 Usually such routers are configured to send the message to a remote host via an
18108 &(smtp)& transport. The &%self%& option specifies what happens when the first
18109 host on the list turns out to be the local host.
18110 The way in which Exim checks for the local host is described in section
18111 &<<SECTreclocipadd>>&.
18112
18113 Normally this situation indicates either an error in Exim's configuration (for
18114 example, the router should be configured not to process this domain), or an
18115 error in the DNS (for example, the MX should not point to this host). For this
18116 reason, the default action is to log the incident, defer the address, and
18117 freeze the message. The following alternatives are provided for use in special
18118 cases:
18119
18120 .vlist
18121 .vitem &%defer%&
18122 Delivery of the message is tried again later, but the message is not frozen.
18123
18124 .vitem "&%reroute%&: <&'domain'&>"
18125 The domain is changed to the given domain, and the address is passed back to
18126 be reprocessed by the routers. No rewriting of headers takes place. This
18127 behaviour is essentially a redirection.
18128
18129 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18130 The domain is changed to the given domain, and the address is passed back to be
18131 reprocessed by the routers. Any headers that contain the original domain are
18132 rewritten.
18133
18134 .vitem &%pass%&
18135 .oindex "&%more%&"
18136 .vindex "&$self_hostname$&"
18137 The router passes the address to the next router, or to the router named in the
18138 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18139 subsequent routing and delivery, the variable &$self_hostname$& contains the
18140 name of the local host that the router encountered. This can be used to
18141 distinguish between different cases for hosts with multiple names. The
18142 combination
18143 .code
18144 self = pass
18145 no_more
18146 .endd
18147 ensures that only those addresses that routed to the local host are passed on.
18148 Without &%no_more%&, addresses that were declined for other reasons would also
18149 be passed to the next router.
18150
18151 .vitem &%fail%&
18152 Delivery fails and an error report is generated.
18153
18154 .vitem &%send%&
18155 .cindex "local host" "sending to"
18156 The anomaly is ignored and the address is queued for the transport. This
18157 setting should be used with extreme caution. For an &(smtp)& transport, it
18158 makes sense only in cases where the program that is listening on the SMTP port
18159 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18160 different configuration file that handles the domain in another way.
18161 .endlist
18162
18163
18164
18165 .option senders routers&!? "address list&!!" unset
18166 .cindex "router" "checking senders"
18167 If this option is set, the router is skipped unless the message's sender
18168 address matches something on the list.
18169 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18170 are evaluated.
18171
18172 There are issues concerning verification when the running of routers is
18173 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18174 setting, it sets the sender to the null string. When using the &%-bt%& option
18175 to check a configuration file, it is necessary also to use the &%-f%& option to
18176 set an appropriate sender. For incoming mail, the sender is unset when
18177 verifying the sender, but is available when verifying any recipients. If the
18178 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18179 matters.
18180
18181
18182 .option translate_ip_address routers string&!! unset
18183 .cindex "IP address" "translating"
18184 .cindex "packet radio"
18185 .cindex "router" "IP address translation"
18186 There exist some rare networking situations (for example, packet radio) where
18187 it is helpful to be able to translate IP addresses generated by normal routing
18188 mechanisms into other IP addresses, thus performing a kind of manual IP
18189 routing. This should be done only if the normal IP routing of the TCP/IP stack
18190 is inadequate or broken. Because this is an extremely uncommon requirement, the
18191 code to support this option is not included in the Exim binary unless
18192 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18193
18194 .vindex "&$host_address$&"
18195 The &%translate_ip_address%& string is expanded for every IP address generated
18196 by the router, with the generated address set in &$host_address$&. If the
18197 expansion is forced to fail, no action is taken.
18198 For any other expansion error, delivery of the message is deferred.
18199 If the result of the expansion is an IP address, that replaces the original
18200 address; otherwise the result is assumed to be a host name &-- this is looked
18201 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18202 produce one or more replacement IP addresses. For example, to subvert all IP
18203 addresses in some specific networks, this could be added to a router:
18204 .code
18205 translate_ip_address = \
18206   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18207     {$value}fail}}
18208 .endd
18209 The file would contain lines like
18210 .code
18211 10.2.3.128/26    some.host
18212 10.8.4.34/26     10.44.8.15
18213 .endd
18214 You should not make use of this facility unless you really understand what you
18215 are doing.
18216
18217
18218
18219 .option transport routers string&!! unset
18220 This option specifies the transport to be used when a router accepts an address
18221 and sets it up for delivery. A transport is never needed if a router is used
18222 only for verification. The value of the option is expanded at routing time,
18223 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18224 and result must be the name of one of the configured transports. If it is not,
18225 delivery is deferred.
18226
18227 The &%transport%& option is not used by the &(redirect)& router, but it does
18228 have some private options that set up transports for pipe and file deliveries
18229 (see chapter &<<CHAPredirect>>&).
18230
18231
18232
18233 .option transport_current_directory routers string&!! unset
18234 .cindex "current directory for local transport"
18235 This option associates a current directory with any address that is routed
18236 to a local transport. This can happen either because a transport is
18237 explicitly configured for the router, or because it generates a delivery to a
18238 file or a pipe. During the delivery process (that is, at transport time), this
18239 option string is expanded and is set as the current directory, unless
18240 overridden by a setting on the transport.
18241 If the expansion fails for any reason, including forced failure, an error is
18242 logged, and delivery is deferred.
18243 See chapter &<<CHAPenvironment>>& for details of the local delivery
18244 environment.
18245
18246
18247
18248
18249 .option transport_home_directory routers string&!! "see below"
18250 .cindex "home directory" "for local transport"
18251 This option associates a home directory with any address that is routed to a
18252 local transport. This can happen either because a transport is explicitly
18253 configured for the router, or because it generates a delivery to a file or a
18254 pipe. During the delivery process (that is, at transport time), the option
18255 string is expanded and is set as the home directory, unless overridden by a
18256 setting of &%home_directory%& on the transport.
18257 If the expansion fails for any reason, including forced failure, an error is
18258 logged, and delivery is deferred.
18259
18260 If the transport does not specify a home directory, and
18261 &%transport_home_directory%& is not set for the router, the home directory for
18262 the transport is taken from the password data if &%check_local_user%& is set for
18263 the router. Otherwise it is taken from &%router_home_directory%& if that option
18264 is set; if not, no home directory is set for the transport.
18265
18266 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18267 environment.
18268
18269
18270
18271
18272 .option unseen routers boolean&!! false
18273 .cindex "router" "carrying on after success"
18274 The result of string expansion for this option must be a valid boolean value,
18275 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18276 result causes an error, and delivery is deferred. If the expansion is forced to
18277 fail, the default value for the option (false) is used. Other failures cause
18278 delivery to be deferred.
18279
18280 When this option is set true, routing does not cease if the router accepts the
18281 address. Instead, a copy of the incoming address is passed to the next router,
18282 overriding a false setting of &%more%&. There is little point in setting
18283 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18284 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18285 sometimes true and sometimes false).
18286
18287 .cindex "copy of message (&%unseen%& option)"
18288 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18289 qualifier in filter files. It can be used to cause copies of messages to be
18290 delivered to some other destination, while also carrying out a normal delivery.
18291 In effect, the current address is made into a &"parent"& that has two children
18292 &-- one that is delivered as specified by this router, and a clone that goes on
18293 to be routed further. For this reason, &%unseen%& may not be combined with the
18294 &%one_time%& option in a &(redirect)& router.
18295
18296 &*Warning*&: Header lines added to the address (or specified for removal) by
18297 this router or by previous routers affect the &"unseen"& copy of the message
18298 only. The clone that continues to be processed by further routers starts with
18299 no added headers and none specified for removal. For a &%redirect%& router, if
18300 a generated address is the same as the incoming address, this can lead to
18301 duplicate addresses with different header modifications. Exim does not do
18302 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18303 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18304 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18305 &%redirect%& router may be of help.
18306
18307 Unlike the handling of header modifications, any data that was set by the
18308 &%address_data%& option in the current or previous routers &'is'& passed on to
18309 subsequent routers.
18310
18311
18312 .option user routers string&!! "see below"
18313 .cindex "uid (user id)" "local delivery"
18314 .cindex "local transports" "uid and gid"
18315 .cindex "transport" "local"
18316 .cindex "router" "user for filter processing"
18317 .cindex "filter" "user for processing"
18318 When a router queues an address for a transport, and the transport does not
18319 specify a user, the user given here is used when running the delivery process.
18320 The user may be specified numerically or by name. If expansion fails, the
18321 error is logged and delivery is deferred.
18322 This user is also used by the &(redirect)& router when running a filter file.
18323 The default is unset, except when &%check_local_user%& is set. In this case,
18324 the default is taken from the password information. If the user is specified as
18325 a name, and &%group%& is not set, the group associated with the user is used.
18326 See also &%initgroups%& and &%group%& and the discussion in chapter
18327 &<<CHAPenvironment>>&.
18328
18329
18330
18331 .option verify routers&!? boolean true
18332 Setting this option has the effect of setting &%verify_sender%& and
18333 &%verify_recipient%& to the same value.
18334
18335
18336 .option verify_only routers&!? boolean false
18337 .cindex "EXPN" "with &%verify_only%&"
18338 .oindex "&%-bv%&"
18339 .cindex "router" "used only when verifying"
18340 If this option is set, the router is used only when verifying an address,
18341 delivering in cutthrough mode or
18342 testing with the &%-bv%& option, not when actually doing a delivery, testing
18343 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18344 restricted to verifying only senders or recipients by means of
18345 &%verify_sender%& and &%verify_recipient%&.
18346
18347 &*Warning*&: When the router is being run to verify addresses for an incoming
18348 SMTP message, Exim is not running as root, but under its own uid. If the router
18349 accesses any files, you need to make sure that they are accessible to the Exim
18350 user or group.
18351
18352
18353 .option verify_recipient routers&!? boolean true
18354 If this option is false, the router is skipped when verifying recipient
18355 addresses,
18356 delivering in cutthrough mode
18357 or testing recipient verification using &%-bv%&.
18358 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18359 are evaluated.
18360 See also the &$verify_mode$& variable.
18361
18362
18363 .option verify_sender routers&!? boolean true
18364 If this option is false, the router is skipped when verifying sender addresses
18365 or testing sender verification using &%-bvs%&.
18366 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18367 are evaluated.
18368 See also the &$verify_mode$& variable.
18369 .ecindex IIDgenoprou1
18370 .ecindex IIDgenoprou2
18371
18372
18373
18374
18375
18376
18377 . ////////////////////////////////////////////////////////////////////////////
18378 . ////////////////////////////////////////////////////////////////////////////
18379
18380 .chapter "The accept router" "CHID4"
18381 .cindex "&(accept)& router"
18382 .cindex "routers" "&(accept)&"
18383 The &(accept)& router has no private options of its own. Unless it is being
18384 used purely for verification (see &%verify_only%&) a transport is required to
18385 be defined by the generic &%transport%& option. If the preconditions that are
18386 specified by generic options are met, the router accepts the address and queues
18387 it for the given transport. The most common use of this router is for setting
18388 up deliveries to local mailboxes. For example:
18389 .code
18390 localusers:
18391   driver = accept
18392   domains = mydomain.example
18393   check_local_user
18394   transport = local_delivery
18395 .endd
18396 The &%domains%& condition in this example checks the domain of the address, and
18397 &%check_local_user%& checks that the local part is the login of a local user.
18398 When both preconditions are met, the &(accept)& router runs, and queues the
18399 address for the &(local_delivery)& transport.
18400
18401
18402
18403
18404
18405
18406 . ////////////////////////////////////////////////////////////////////////////
18407 . ////////////////////////////////////////////////////////////////////////////
18408
18409 .chapter "The dnslookup router" "CHAPdnslookup"
18410 .scindex IIDdnsrou1 "&(dnslookup)& router"
18411 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18412 The &(dnslookup)& router looks up the hosts that handle mail for the
18413 recipient's domain in the DNS. A transport must always be set for this router,
18414 unless &%verify_only%& is set.
18415
18416 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18417 SRV records. If none are found, or if SRV support is not configured,
18418 MX records are looked up. If no MX records exist, address records are sought.
18419 However, &%mx_domains%& can be set to disable the direct use of address
18420 records.
18421
18422 MX records of equal priority are sorted by Exim into a random order. Exim then
18423 looks for address records for the host names obtained from MX or SRV records.
18424 When a host has more than one IP address, they are sorted into a random order,
18425 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18426 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18427 generic option, the router declines.
18428
18429 Unless they have the highest priority (lowest MX value), MX records that point
18430 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18431 are discarded, together with any other MX records of equal or lower priority.
18432
18433 .cindex "MX record" "pointing to local host"
18434 .cindex "local host" "MX pointing to"
18435 .oindex "&%self%&" "in &(dnslookup)& router"
18436 If the host pointed to by the highest priority MX record, or looked up as an
18437 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18438 happens is controlled by the generic &%self%& option.
18439
18440
18441 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18442 There have been problems with DNS servers when SRV records are looked up.
18443 Some misbehaving servers return a DNS error or timeout when a non-existent
18444 SRV record is sought. Similar problems have in the past been reported for
18445 MX records. The global &%dns_again_means_nonexist%& option can help with this
18446 problem, but it is heavy-handed because it is a global option.
18447
18448 For this reason, there are two options, &%srv_fail_domains%& and
18449 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18450 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18451 an attempt to look up an SRV or MX record causes one of these results, and the
18452 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18453 such record"&. In the case of an SRV lookup, this means that the router
18454 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18455 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18456 case routing fails.
18457
18458
18459 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18460 .cindex "&(dnslookup)& router" "declines"
18461 There are a few cases where a &(dnslookup)& router will decline to accept
18462 an address; if such a router is expected to handle "all remaining non-local
18463 domains", then it is important to set &%no_more%&.
18464
18465 The router will defer rather than decline if the domain
18466 is found in the &%fail_defer_domains%& router option.
18467
18468 Reasons for a &(dnslookup)& router to decline currently include:
18469 .ilist
18470 The domain does not exist in DNS
18471 .next
18472 The domain exists but the MX record's host part is just "."; this is a common
18473 convention (borrowed from SRV) used to indicate that there is no such service
18474 for this domain and to not fall back to trying A/AAAA records.
18475 .next
18476 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18477 .next
18478 MX record points to a non-existent host.
18479 .next
18480 MX record points to an IP address and the main section option
18481 &%allow_mx_to_ip%& is not set.
18482 .next
18483 MX records exist and point to valid hosts, but all hosts resolve only to
18484 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18485 .next
18486 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18487 &%dns_check_names_pattern%& for handling one variant of this)
18488 .next
18489 &%check_secondary_mx%& is set on this router but the local host can
18490 not be found in the MX records (see below)
18491 .endlist
18492
18493
18494
18495
18496 .section "Private options for dnslookup" "SECID118"
18497 .cindex "options" "&(dnslookup)& router"
18498 The private options for the &(dnslookup)& router are as follows:
18499
18500 .option check_secondary_mx dnslookup boolean false
18501 .cindex "MX record" "checking for secondary"
18502 If this option is set, the router declines unless the local host is found in
18503 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18504 process domains for which the local host is a secondary mail exchanger
18505 differently to other domains. The way in which Exim decides whether a host is
18506 the local host is described in section &<<SECTreclocipadd>>&.
18507
18508
18509 .option check_srv dnslookup string&!! unset
18510 .cindex "SRV record" "enabling use of"
18511 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18512 addition to MX and address records. The support is disabled by default. To
18513 enable SRV support, set the &%check_srv%& option to the name of the service
18514 required. For example,
18515 .code
18516 check_srv = smtp
18517 .endd
18518 looks for SRV records that refer to the normal smtp service. The option is
18519 expanded, so the service name can vary from message to message or address
18520 to address. This might be helpful if SRV records are being used for a
18521 submission service. If the expansion is forced to fail, the &%check_srv%&
18522 option is ignored, and the router proceeds to look for MX records in the
18523 normal way.
18524
18525 When the expansion succeeds, the router searches first for SRV records for
18526 the given service (it assumes TCP protocol). A single SRV record with a
18527 host name that consists of just a single dot indicates &"no such service for
18528 this domain"&; if this is encountered, the router declines. If other kinds of
18529 SRV record are found, they are used to construct a host list for delivery
18530 according to the rules of RFC 2782. MX records are not sought in this case.
18531
18532 When no SRV records are found, MX records (and address records) are sought in
18533 the traditional way. In other words, SRV records take precedence over MX
18534 records, just as MX records take precedence over address records. Note that
18535 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18536 defined it. It is apparently believed that MX records are sufficient for email
18537 and that SRV records should not be used for this purpose. However, SRV records
18538 have an additional &"weight"& feature which some people might find useful when
18539 trying to split an SMTP load between hosts of different power.
18540
18541 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18542 when there is a DNS lookup error.
18543
18544
18545
18546
18547 .option fail_defer_domains dnslookup "domain list&!!" unset
18548 .cindex "MX record" "not found"
18549 DNS lookups for domains matching &%fail_defer_domains%&
18550 which find no matching record will cause the router to defer
18551 rather than the default behaviour of decline.
18552 This maybe be useful for queueing messages for a newly created
18553 domain while the DNS configuration is not ready.
18554 However, it will result in any message with mistyped domains
18555 also being queued.
18556
18557
18558 .option mx_domains dnslookup "domain list&!!" unset
18559 .cindex "MX record" "required to exist"
18560 .cindex "SRV record" "required to exist"
18561 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18562 record in order to be recognized. (The name of this option could be improved.)
18563 For example, if all the mail hosts in &'fict.example'& are known to have MX
18564 records, except for those in &'discworld.fict.example'&, you could use this
18565 setting:
18566 .code
18567 mx_domains = ! *.discworld.fict.example : *.fict.example
18568 .endd
18569 This specifies that messages addressed to a domain that matches the list but
18570 has no MX record should be bounced immediately instead of being routed using
18571 the address record.
18572
18573
18574 .option mx_fail_domains dnslookup "domain list&!!" unset
18575 If the DNS lookup for MX records for one of the domains in this list causes a
18576 DNS lookup error, Exim behaves as if no MX records were found. See section
18577 &<<SECTprowitdnsloo>>& for more discussion.
18578
18579
18580
18581
18582 .option qualify_single dnslookup boolean true
18583 .cindex "DNS" "resolver options"
18584 .cindex "DNS" "qualifying single-component names"
18585 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18586 lookups. Typically, but not standardly, this causes the resolver to qualify
18587 single-component names with the default domain. For example, on a machine
18588 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18589 &'thesaurus.ref.example'& inside the resolver. For details of what your
18590 resolver actually does, consult your man pages for &'resolver'& and
18591 &'resolv.conf'&.
18592
18593
18594
18595 .option rewrite_headers dnslookup boolean true
18596 .cindex "rewriting" "header lines"
18597 .cindex "header lines" "rewriting"
18598 If the domain name in the address that is being processed is not fully
18599 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18600 an address is specified as &'dormouse@teaparty'&, the domain might be
18601 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18602 occur as a result of setting the &%widen_domains%& option. If
18603 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18604 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18605 header lines of the message are rewritten with the full domain name.
18606
18607 This option should be turned off only when it is known that no message is
18608 ever going to be sent outside an environment where the abbreviation makes
18609 sense.
18610
18611 When an MX record is looked up in the DNS and matches a wildcard record, name
18612 servers normally return a record containing the name that has been looked up,
18613 making it impossible to detect whether a wildcard was present or not. However,
18614 some name servers have recently been seen to return the wildcard entry. If the
18615 name returned by a DNS lookup begins with an asterisk, it is not used for
18616 header rewriting.
18617
18618
18619 .option same_domain_copy_routing dnslookup boolean false
18620 .cindex "address" "copying routing"
18621 Addresses with the same domain are normally routed by the &(dnslookup)& router
18622 to the same list of hosts. However, this cannot be presumed, because the router
18623 options and preconditions may refer to the local part of the address. By
18624 default, therefore, Exim routes each address in a message independently. DNS
18625 servers run caches, so repeated DNS lookups are not normally expensive, and in
18626 any case, personal messages rarely have more than a few recipients.
18627
18628 If you are running mailing lists with large numbers of subscribers at the same
18629 domain, and you are using a &(dnslookup)& router which is independent of the
18630 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18631 lookups for identical domains in one message. In this case, when &(dnslookup)&
18632 routes an address to a remote transport, any other unrouted addresses in the
18633 message that have the same domain are automatically given the same routing
18634 without processing them independently,
18635 provided the following conditions are met:
18636
18637 .ilist
18638 No router that processed the address specified &%headers_add%& or
18639 &%headers_remove%&.
18640 .next
18641 The router did not change the address in any way, for example, by &"widening"&
18642 the domain.
18643 .endlist
18644
18645
18646
18647
18648 .option search_parents dnslookup boolean false
18649 .cindex "DNS" "resolver options"
18650 When this option is true, the resolver option RES_DNSRCH is set for DNS
18651 lookups. This is different from the &%qualify_single%& option in that it
18652 applies to domains containing dots. Typically, but not standardly, it causes
18653 the resolver to search for the name in the current domain and in parent
18654 domains. For example, on a machine in the &'fict.example'& domain, if looking
18655 up &'teaparty.wonderland'& failed, the resolver would try
18656 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18657 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18658
18659 Setting this option true can cause problems in domains that have a wildcard MX
18660 record, because any domain that does not have its own MX record matches the
18661 local wildcard.
18662
18663
18664
18665 .option srv_fail_domains dnslookup "domain list&!!" unset
18666 If the DNS lookup for SRV records for one of the domains in this list causes a
18667 DNS lookup error, Exim behaves as if no SRV records were found. See section
18668 &<<SECTprowitdnsloo>>& for more discussion.
18669
18670
18671
18672
18673 .option widen_domains dnslookup "string list" unset
18674 .cindex "domain" "partial; widening"
18675 If a DNS lookup fails and this option is set, each of its strings in turn is
18676 added onto the end of the domain, and the lookup is tried again. For example,
18677 if
18678 .code
18679 widen_domains = fict.example:ref.example
18680 .endd
18681 is set and a lookup of &'klingon.dictionary'& fails,
18682 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18683 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18684 and &%search_parents%& options can cause some widening to be undertaken inside
18685 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18686 when verifying, unless &%rewrite_headers%& is false (not the default).
18687
18688
18689 .section "Effect of qualify_single and search_parents" "SECID119"
18690 When a domain from an envelope recipient is changed by the resolver as a result
18691 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18692 corresponding address in the message's header lines unless &%rewrite_headers%&
18693 is set false. Exim then re-routes the address, using the full domain.
18694
18695 These two options affect only the DNS lookup that takes place inside the router
18696 for the domain of the address that is being routed. They do not affect lookups
18697 such as that implied by
18698 .code
18699 domains = @mx_any
18700 .endd
18701 that may happen while processing a router precondition before the router is
18702 entered. No widening ever takes place for these lookups.
18703 .ecindex IIDdnsrou1
18704 .ecindex IIDdnsrou2
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714 . ////////////////////////////////////////////////////////////////////////////
18715 . ////////////////////////////////////////////////////////////////////////////
18716
18717 .chapter "The ipliteral router" "CHID5"
18718 .cindex "&(ipliteral)& router"
18719 .cindex "domain literal" "routing"
18720 .cindex "routers" "&(ipliteral)&"
18721 This router has no private options. Unless it is being used purely for
18722 verification (see &%verify_only%&) a transport is required to be defined by the
18723 generic &%transport%& option. The router accepts the address if its domain part
18724 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18725 router handles the address
18726 .code
18727 root@[192.168.1.1]
18728 .endd
18729 by setting up delivery to the host with that IP address. IPv4 domain literals
18730 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18731 are similar, but the address is preceded by &`ipv6:`&. For example:
18732 .code
18733 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18734 .endd
18735 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18736 grounds that sooner or later somebody will try it.
18737
18738 .oindex "&%self%&" "in &(ipliteral)& router"
18739 If the IP address matches something in &%ignore_target_hosts%&, the router
18740 declines. If an IP literal turns out to refer to the local host, the generic
18741 &%self%& option determines what happens.
18742
18743 The RFCs require support for domain literals; however, their use is
18744 controversial in today's Internet. If you want to use this router, you must
18745 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18746 Exim will not recognize the domain literal syntax in addresses.
18747
18748
18749
18750 . ////////////////////////////////////////////////////////////////////////////
18751 . ////////////////////////////////////////////////////////////////////////////
18752
18753 .chapter "The iplookup router" "CHID6"
18754 .cindex "&(iplookup)& router"
18755 .cindex "routers" "&(iplookup)&"
18756 The &(iplookup)& router was written to fulfil a specific requirement in
18757 Cambridge University (which in fact no longer exists). For this reason, it is
18758 not included in the binary of Exim by default. If you want to include it, you
18759 must set
18760 .code
18761 ROUTER_IPLOOKUP=yes
18762 .endd
18763 in your &_Local/Makefile_& configuration file.
18764
18765 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18766 connection to one or more specific hosts. The host can then return the same or
18767 a different address &-- in effect rewriting the recipient address in the
18768 message's envelope. The new address is then passed on to subsequent routers. If
18769 this process fails, the address can be passed on to other routers, or delivery
18770 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18771 must not be specified for it.
18772
18773 .cindex "options" "&(iplookup)& router"
18774 .option hosts iplookup string unset
18775 This option must be supplied. Its value is a colon-separated list of host
18776 names. The hosts are looked up using &[gethostbyname()]&
18777 (or &[getipnodebyname()]& when available)
18778 and are tried in order until one responds to the query. If none respond, what
18779 happens is controlled by &%optional%&.
18780
18781
18782 .option optional iplookup boolean false
18783 If &%optional%& is true, if no response is obtained from any host, the address
18784 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18785 delivery to the address is deferred.
18786
18787
18788 .option port iplookup integer 0
18789 .cindex "port" "&(iplookup)& router"
18790 This option must be supplied. It specifies the port number for the TCP or UDP
18791 call.
18792
18793
18794 .option protocol iplookup string udp
18795 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18796 protocols is to be used.
18797
18798
18799 .option query iplookup string&!! "see below"
18800 This defines the content of the query that is sent to the remote hosts. The
18801 default value is:
18802 .code
18803 $local_part@$domain $local_part@$domain
18804 .endd
18805 The repetition serves as a way of checking that a response is to the correct
18806 query in the default case (see &%response_pattern%& below).
18807
18808
18809 .option reroute iplookup string&!! unset
18810 If this option is not set, the rerouted address is precisely the byte string
18811 returned by the remote host, up to the first white space, if any. If set, the
18812 string is expanded to form the rerouted address. It can include parts matched
18813 in the response by &%response_pattern%& by means of numeric variables such as
18814 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18815 whether or not a pattern is in use. In all cases, the rerouted address must end
18816 up in the form &'local_part@domain'&.
18817
18818
18819 .option response_pattern iplookup string unset
18820 This option can be set to a regular expression that is applied to the string
18821 returned from the remote host. If the pattern does not match the response, the
18822 router declines. If &%response_pattern%& is not set, no checking of the
18823 response is done, unless the query was defaulted, in which case there is a
18824 check that the text returned after the first white space is the original
18825 address. This checks that the answer that has been received is in response to
18826 the correct question. For example, if the response is just a new domain, the
18827 following could be used:
18828 .code
18829 response_pattern = ^([^@]+)$
18830 reroute = $local_part@$1
18831 .endd
18832
18833 .option timeout iplookup time 5s
18834 This specifies the amount of time to wait for a response from the remote
18835 machine. The same timeout is used for the &[connect()]& function for a TCP
18836 call. It does not apply to UDP.
18837
18838
18839
18840
18841 . ////////////////////////////////////////////////////////////////////////////
18842 . ////////////////////////////////////////////////////////////////////////////
18843
18844 .chapter "The manualroute router" "CHID7"
18845 .scindex IIDmanrou1 "&(manualroute)& router"
18846 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18847 .cindex "domain" "manually routing"
18848 The &(manualroute)& router is so-called because it provides a way of manually
18849 routing an address according to its domain. It is mainly used when you want to
18850 route addresses to remote hosts according to your own rules, bypassing the
18851 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18852 route to local transports, a facility that may be useful if you want to save
18853 messages for dial-in hosts in local files.
18854
18855 The &(manualroute)& router compares a list of domain patterns with the domain
18856 it is trying to route. If there is no match, the router declines. Each pattern
18857 has associated with it a list of hosts and some other optional data, which may
18858 include a transport. The combination of a pattern and its data is called a
18859 &"routing rule"&. For patterns that do not have an associated transport, the
18860 generic &%transport%& option must specify a transport, unless the router is
18861 being used purely for verification (see &%verify_only%&).
18862
18863 .vindex "&$host$&"
18864 In the case of verification, matching the domain pattern is sufficient for the
18865 router to accept the address. When actually routing an address for delivery,
18866 an address that matches a domain pattern is queued for the associated
18867 transport. If the transport is not a local one, a host list must be associated
18868 with the pattern; IP addresses are looked up for the hosts, and these are
18869 passed to the transport along with the mail address. For local transports, a
18870 host list is optional. If it is present, it is passed in &$host$& as a single
18871 text string.
18872
18873 The list of routing rules can be provided as an inline string in
18874 &%route_list%&, or the data can be obtained by looking up the domain in a file
18875 or database by setting &%route_data%&. Only one of these settings may appear in
18876 any one instance of &(manualroute)&. The format of routing rules is described
18877 below, following the list of private options.
18878
18879
18880 .section "Private options for manualroute" "SECTprioptman"
18881
18882 .cindex "options" "&(manualroute)& router"
18883 The private options for the &(manualroute)& router are as follows:
18884
18885 .option host_all_ignored manualroute string defer
18886 See &%host_find_failed%&.
18887
18888 .option host_find_failed manualroute string freeze
18889 This option controls what happens when &(manualroute)& tries to find an IP
18890 address for a host, and the host does not exist. The option can be set to one
18891 of the following values:
18892 .code
18893 decline
18894 defer
18895 fail
18896 freeze
18897 ignore
18898 pass
18899 .endd
18900 The default (&"freeze"&) assumes that this state is a serious configuration
18901 error. The difference between &"pass"& and &"decline"& is that the former
18902 forces the address to be passed to the next router (or the router defined by
18903 &%pass_router%&),
18904 .oindex "&%more%&"
18905 overriding &%no_more%&, whereas the latter passes the address to the next
18906 router only if &%more%& is true.
18907
18908 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18909 cannot be found. If all the hosts in the list are ignored, the behaviour is
18910 controlled by the &%host_all_ignored%& option. This takes the same values
18911 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18912
18913 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18914 state; if a host lookup gets a temporary error, delivery is deferred unless the
18915 generic &%pass_on_timeout%& option is set.
18916
18917
18918 .option hosts_randomize manualroute boolean false
18919 .cindex "randomized host list"
18920 .cindex "host" "list of; randomized"
18921 If this option is set, the order of the items in a host list in a routing rule
18922 is randomized each time the list is used, unless an option in the routing rule
18923 overrides (see below). Randomizing the order of a host list can be used to do
18924 crude load sharing. However, if more than one mail address is routed by the
18925 same router to the same host list, the host lists are considered to be the same
18926 (even though they may be randomized into different orders) for the purpose of
18927 deciding whether to batch the deliveries into a single SMTP transaction.
18928
18929 When &%hosts_randomize%& is true, a host list may be split
18930 into groups whose order is separately randomized. This makes it possible to
18931 set up MX-like behaviour. The boundaries between groups are indicated by an
18932 item that is just &`+`& in the host list. For example:
18933 .code
18934 route_list = * host1:host2:host3:+:host4:host5
18935 .endd
18936 The order of the first three hosts and the order of the last two hosts is
18937 randomized for each use, but the first three always end up before the last two.
18938 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18939 randomized host list is passed to an &(smtp)& transport that also has
18940 &%hosts_randomize set%&, the list is not re-randomized.
18941
18942
18943 .option route_data manualroute string&!! unset
18944 If this option is set, it must expand to yield the data part of a routing rule.
18945 Typically, the expansion string includes a lookup based on the domain. For
18946 example:
18947 .code
18948 route_data = ${lookup{$domain}dbm{/etc/routes}}
18949 .endd
18950 If the expansion is forced to fail, or the result is an empty string, the
18951 router declines. Other kinds of expansion failure cause delivery to be
18952 deferred.
18953
18954
18955 .option route_list manualroute "string list" unset
18956 This string is a list of routing rules, in the form defined below. Note that,
18957 unlike most string lists, the items are separated by semicolons. This is so
18958 that they may contain colon-separated host lists.
18959
18960
18961 .option same_domain_copy_routing manualroute boolean false
18962 .cindex "address" "copying routing"
18963 Addresses with the same domain are normally routed by the &(manualroute)&
18964 router to the same list of hosts. However, this cannot be presumed, because the
18965 router options and preconditions may refer to the local part of the address. By
18966 default, therefore, Exim routes each address in a message independently. DNS
18967 servers run caches, so repeated DNS lookups are not normally expensive, and in
18968 any case, personal messages rarely have more than a few recipients.
18969
18970 If you are running mailing lists with large numbers of subscribers at the same
18971 domain, and you are using a &(manualroute)& router which is independent of the
18972 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18973 lookups for identical domains in one message. In this case, when
18974 &(manualroute)& routes an address to a remote transport, any other unrouted
18975 addresses in the message that have the same domain are automatically given the
18976 same routing without processing them independently. However, this is only done
18977 if &%headers_add%& and &%headers_remove%& are unset.
18978
18979
18980
18981
18982 .section "Routing rules in route_list" "SECID120"
18983 The value of &%route_list%& is a string consisting of a sequence of routing
18984 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18985 entered as two semicolons. Alternatively, the list separator can be changed as
18986 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18987 Empty rules are ignored. The format of each rule is
18988 .display
18989 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18990 .endd
18991 The following example contains two rules, each with a simple domain pattern and
18992 no options:
18993 .code
18994 route_list = \
18995   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18996   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18997 .endd
18998 The three parts of a rule are separated by white space. The pattern and the
18999 list of hosts can be enclosed in quotes if necessary, and if they are, the
19000 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19001 single domain pattern, which is the only mandatory item in the rule. The
19002 pattern is in the same format as one item in a domain list (see section
19003 &<<SECTdomainlist>>&),
19004 except that it may not be the name of an interpolated file.
19005 That is, it may be wildcarded, or a regular expression, or a file or database
19006 lookup (with semicolons doubled, because of the use of semicolon as a separator
19007 in a &%route_list%&).
19008
19009 The rules in &%route_list%& are searched in order until one of the patterns
19010 matches the domain that is being routed. The list of hosts and then options are
19011 then used as described below. If there is no match, the router declines. When
19012 &%route_list%& is set, &%route_data%& must not be set.
19013
19014
19015
19016 .section "Routing rules in route_data" "SECID121"
19017 The use of &%route_list%& is convenient when there are only a small number of
19018 routing rules. For larger numbers, it is easier to use a file or database to
19019 hold the routing information, and use the &%route_data%& option instead.
19020 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19021 Most commonly, &%route_data%& is set as a string that contains an
19022 expansion lookup. For example, suppose we place two routing rules in a file
19023 like this:
19024 .code
19025 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19026 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19027 .endd
19028 This data can be accessed by setting
19029 .code
19030 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19031 .endd
19032 Failure of the lookup results in an empty string, causing the router to
19033 decline. However, you do not have to use a lookup in &%route_data%&. The only
19034 requirement is that the result of expanding the string is a list of hosts,
19035 possibly followed by options, separated by white space. The list of hosts must
19036 be enclosed in quotes if it contains white space.
19037
19038
19039
19040
19041 .section "Format of the list of hosts" "SECID122"
19042 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19043 always separately expanded before use. If the expansion fails, the router
19044 declines. The result of the expansion must be a colon-separated list of names
19045 and/or IP addresses, optionally also including ports. The format of each item
19046 in the list is described in the next section. The list separator can be changed
19047 as described in section &<<SECTlistconstruct>>&.
19048
19049 If the list of hosts was obtained from a &%route_list%& item, the following
19050 variables are set during its expansion:
19051
19052 .ilist
19053 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19054 If the domain was matched against a regular expression, the numeric variables
19055 &$1$&, &$2$&, etc. may be set. For example:
19056 .code
19057 route_list = ^domain(\d+)   host-$1.text.example
19058 .endd
19059 .next
19060 &$0$& is always set to the entire domain.
19061 .next
19062 &$1$& is also set when partial matching is done in a file lookup.
19063
19064 .next
19065 .vindex "&$value$&"
19066 If the pattern that matched the domain was a lookup item, the data that was
19067 looked up is available in the expansion variable &$value$&. For example:
19068 .code
19069 route_list = lsearch;;/some/file.routes  $value
19070 .endd
19071 .endlist
19072
19073 Note the doubling of the semicolon in the pattern that is necessary because
19074 semicolon is the default route list separator.
19075
19076
19077
19078 .section "Format of one host item" "SECTformatonehostitem"
19079 Each item in the list of hosts is either a host name or an IP address,
19080 optionally with an attached port number. When no port is given, an IP address
19081 is not enclosed in brackets. When a port is specified, it overrides the port
19082 specification on the transport. The port is separated from the name or address
19083 by a colon. This leads to some complications:
19084
19085 .ilist
19086 Because colon is the default separator for the list of hosts, either
19087 the colon that specifies a port must be doubled, or the list separator must
19088 be changed. The following two examples have the same effect:
19089 .code
19090 route_list = * "host1.tld::1225 : host2.tld::1226"
19091 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19092 .endd
19093 .next
19094 When IPv6 addresses are involved, it gets worse, because they contain
19095 colons of their own. To make this case easier, it is permitted to
19096 enclose an IP address (either v4 or v6) in square brackets if a port
19097 number follows. For example:
19098 .code
19099 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19100 .endd
19101 .endlist
19102
19103 .section "How the list of hosts is used" "SECThostshowused"
19104 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19105 the hosts is tried, in the order specified, when carrying out the SMTP
19106 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19107 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19108 transport.
19109
19110 Hosts may be listed by name or by IP address. An unadorned name in the list of
19111 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19112 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19113 records in the DNS. For example:
19114 .code
19115 route_list = *  x.y.z:p.q.r/MX:e.f.g
19116 .endd
19117 If this feature is used with a port specifier, the port must come last. For
19118 example:
19119 .code
19120 route_list = *  dom1.tld/mx::1225
19121 .endd
19122 If the &%hosts_randomize%& option is set, the order of the items in the list is
19123 randomized before any lookups are done. Exim then scans the list; for any name
19124 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19125 be an interface on the local host and the item is not the first in the list,
19126 Exim discards it and any subsequent items. If it is the first item, what
19127 happens is controlled by the
19128 .oindex "&%self%&" "in &(manualroute)& router"
19129 &%self%& option of the router.
19130
19131 A name on the list that is followed by &`/MX`& is replaced with the list of
19132 hosts obtained by looking up MX records for the name. This is always a DNS
19133 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19134 below) are not relevant here. The order of these hosts is determined by the
19135 preference values in the MX records, according to the usual rules. Because
19136 randomizing happens before the MX lookup, it does not affect the order that is
19137 defined by MX preferences.
19138
19139 If the local host is present in the sublist obtained from MX records, but is
19140 not the most preferred host in that list, it and any equally or less
19141 preferred hosts are removed before the sublist is inserted into the main list.
19142
19143 If the local host is the most preferred host in the MX list, what happens
19144 depends on where in the original list of hosts the &`/MX`& item appears. If it
19145 is not the first item (that is, there are previous hosts in the main list),
19146 Exim discards this name and any subsequent items in the main list.
19147
19148 If the MX item is first in the list of hosts, and the local host is the
19149 most preferred host, what happens is controlled by the &%self%& option of the
19150 router.
19151
19152 DNS failures when lookup up the MX records are treated in the same way as DNS
19153 failures when looking up IP addresses: &%pass_on_timeout%& and
19154 &%host_find_failed%& are used when relevant.
19155
19156 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19157 whether obtained from an MX lookup or not.
19158
19159
19160
19161 .section "How the options are used" "SECThowoptused"
19162 The options are a sequence of words; in practice no more than three are ever
19163 present. One of the words can be the name of a transport; this overrides the
19164 &%transport%& option on the router for this particular routing rule only. The
19165 other words (if present) control randomization of the list of hosts on a
19166 per-rule basis, and how the IP addresses of the hosts are to be found when
19167 routing to a remote transport. These options are as follows:
19168
19169 .ilist
19170 &%randomize%&: randomize the order of the hosts in this list, overriding the
19171 setting of &%hosts_randomize%& for this routing rule only.
19172 .next
19173 &%no_randomize%&: do not randomize the order of the hosts in this list,
19174 overriding the setting of &%hosts_randomize%& for this routing rule only.
19175 .next
19176 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19177 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19178 also look in &_/etc/hosts_& or other sources of information.
19179 .next
19180 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19181 no address records are found. If there is a temporary DNS error (such as a
19182 timeout), delivery is deferred.
19183 .endlist
19184
19185 For example:
19186 .code
19187 route_list = domain1  host1:host2:host3  randomize bydns;\
19188              domain2  host4:host5
19189 .endd
19190 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19191 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19192 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19193 or &[gethostbyname()]&, and the result of the lookup is the result of that
19194 call.
19195
19196 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19197 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19198 instead of TRY_AGAIN. That is why the default action is to try a DNS
19199 lookup first. Only if that gives a definite &"no such host"& is the local
19200 function called.
19201
19202
19203
19204 If no IP address for a host can be found, what happens is controlled by the
19205 &%host_find_failed%& option.
19206
19207 .vindex "&$host$&"
19208 When an address is routed to a local transport, IP addresses are not looked up.
19209 The host list is passed to the transport in the &$host$& variable.
19210
19211
19212
19213 .section "Manualroute examples" "SECID123"
19214 In some of the examples that follow, the presence of the &%remote_smtp%&
19215 transport, as defined in the default configuration file, is assumed:
19216
19217 .ilist
19218 .cindex "smart host" "example router"
19219 The &(manualroute)& router can be used to forward all external mail to a
19220 &'smart host'&. If you have set up, in the main part of the configuration, a
19221 named domain list that contains your local domains, for example:
19222 .code
19223 domainlist local_domains = my.domain.example
19224 .endd
19225 You can arrange for all other domains to be routed to a smart host by making
19226 your first router something like this:
19227 .code
19228 smart_route:
19229   driver = manualroute
19230   domains = !+local_domains
19231   transport = remote_smtp
19232   route_list = * smarthost.ref.example
19233 .endd
19234 This causes all non-local addresses to be sent to the single host
19235 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19236 they are tried in order
19237 (but you can use &%hosts_randomize%& to vary the order each time).
19238 Another way of configuring the same thing is this:
19239 .code
19240 smart_route:
19241   driver = manualroute
19242   transport = remote_smtp
19243   route_list = !+local_domains  smarthost.ref.example
19244 .endd
19245 There is no difference in behaviour between these two routers as they stand.
19246 However, they behave differently if &%no_more%& is added to them. In the first
19247 example, the router is skipped if the domain does not match the &%domains%&
19248 precondition; the following router is always tried. If the router runs, it
19249 always matches the domain and so can never decline. Therefore, &%no_more%&
19250 would have no effect. In the second case, the router is never skipped; it
19251 always runs. However, if it doesn't match the domain, it declines. In this case
19252 &%no_more%& would prevent subsequent routers from running.
19253
19254 .next
19255 .cindex "mail hub example"
19256 A &'mail hub'& is a host which receives mail for a number of domains via MX
19257 records in the DNS and delivers it via its own private routing mechanism. Often
19258 the final destinations are behind a firewall, with the mail hub being the one
19259 machine that can connect to machines both inside and outside the firewall. The
19260 &(manualroute)& router is usually used on a mail hub to route incoming messages
19261 to the correct hosts. For a small number of domains, the routing can be inline,
19262 using the &%route_list%& option, but for a larger number a file or database
19263 lookup is easier to manage.
19264
19265 If the domain names are in fact the names of the machines to which the mail is
19266 to be sent by the mail hub, the configuration can be quite simple. For
19267 example:
19268 .code
19269 hub_route:
19270   driver = manualroute
19271   transport = remote_smtp
19272   route_list = *.rhodes.tvs.example  $domain
19273 .endd
19274 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19275 whose names are the same as the mail domains. A similar approach can be taken
19276 if the host name can be obtained from the domain name by a string manipulation
19277 that the expansion facilities can handle. Otherwise, a lookup based on the
19278 domain can be used to find the host:
19279 .code
19280 through_firewall:
19281   driver = manualroute
19282   transport = remote_smtp
19283   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19284 .endd
19285 The result of the lookup must be the name or IP address of the host (or
19286 hosts) to which the address is to be routed. If the lookup fails, the route
19287 data is empty, causing the router to decline. The address then passes to the
19288 next router.
19289
19290 .next
19291 .cindex "batched SMTP output example"
19292 .cindex "SMTP" "batched outgoing; example"
19293 You can use &(manualroute)& to deliver messages to pipes or files in batched
19294 SMTP format for onward transportation by some other means. This is one way of
19295 storing mail for a dial-up host when it is not connected. The route list entry
19296 can be as simple as a single domain name in a configuration like this:
19297 .code
19298 save_in_file:
19299   driver = manualroute
19300   transport = batchsmtp_appendfile
19301   route_list = saved.domain.example
19302 .endd
19303 though often a pattern is used to pick up more than one domain. If there are
19304 several domains or groups of domains with different transport requirements,
19305 different transports can be listed in the routing information:
19306 .code
19307 save_in_file:
19308   driver = manualroute
19309   route_list = \
19310     *.saved.domain1.example  $domain  batch_appendfile; \
19311     *.saved.domain2.example  \
19312       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19313       batch_pipe
19314 .endd
19315 .vindex "&$domain$&"
19316 .vindex "&$host$&"
19317 The first of these just passes the domain in the &$host$& variable, which
19318 doesn't achieve much (since it is also in &$domain$&), but the second does a
19319 file lookup to find a value to pass, causing the router to decline to handle
19320 the address if the lookup fails.
19321
19322 .next
19323 .cindex "UUCP" "example of router for"
19324 Routing mail directly to UUCP software is a specific case of the use of
19325 &(manualroute)& in a gateway to another mail environment. This is an example of
19326 one way it can be done:
19327 .code
19328 # Transport
19329 uucp:
19330   driver = pipe
19331   user = nobody
19332   command = /usr/local/bin/uux -r - \
19333     ${substr_-5:$host}!rmail ${local_part}
19334   return_fail_output = true
19335
19336 # Router
19337 uucphost:
19338   transport = uucp
19339   driver = manualroute
19340   route_data = \
19341     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19342 .endd
19343 The file &_/usr/local/exim/uucphosts_& contains entries like
19344 .code
19345 darksite.ethereal.example:           darksite.UUCP
19346 .endd
19347 It can be set up more simply without adding and removing &".UUCP"& but this way
19348 makes clear the distinction between the domain name
19349 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19350 .endlist
19351 .ecindex IIDmanrou1
19352 .ecindex IIDmanrou2
19353
19354
19355
19356
19357
19358
19359
19360
19361 . ////////////////////////////////////////////////////////////////////////////
19362 . ////////////////////////////////////////////////////////////////////////////
19363
19364 .chapter "The queryprogram router" "CHAPdriverlast"
19365 .scindex IIDquerou1 "&(queryprogram)& router"
19366 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19367 .cindex "routing" "by external program"
19368 The &(queryprogram)& router routes an address by running an external command
19369 and acting on its output. This is an expensive way to route, and is intended
19370 mainly for use in lightly-loaded systems, or for performing experiments.
19371 However, if it is possible to use the precondition options (&%domains%&,
19372 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19373 be used in special cases, even on a busy host. There are the following private
19374 options:
19375 .cindex "options" "&(queryprogram)& router"
19376
19377 .option command queryprogram string&!! unset
19378 This option must be set. It specifies the command that is to be run. The
19379 command is split up into a command name and arguments, and then each is
19380 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19381 &<<CHAPpipetransport>>&).
19382
19383
19384 .option command_group queryprogram string unset
19385 .cindex "gid (group id)" "in &(queryprogram)& router"
19386 This option specifies a gid to be set when running the command while routing an
19387 address for deliver. It must be set if &%command_user%& specifies a numerical
19388 uid. If it begins with a digit, it is interpreted as the numerical value of the
19389 gid. Otherwise it is looked up using &[getgrnam()]&.
19390
19391
19392 .option command_user queryprogram string unset
19393 .cindex "uid (user id)" "for &(queryprogram)&"
19394 This option must be set. It specifies the uid which is set when running the
19395 command while routing an address for delivery. If the value begins with a digit,
19396 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19397 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19398 not set, a value for the gid also.
19399
19400 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19401 root, which it does during a normal delivery in a conventional configuration.
19402 However, when an address is being verified during message reception, Exim is
19403 usually running as the Exim user, not as root. If the &(queryprogram)& router
19404 is called from a non-root process, Exim cannot change uid or gid before running
19405 the command. In this circumstance the command runs under the current uid and
19406 gid.
19407
19408
19409 .option current_directory queryprogram string /
19410 This option specifies an absolute path which is made the current directory
19411 before running the command.
19412
19413
19414 .option timeout queryprogram time 1h
19415 If the command does not complete within the timeout period, its process group
19416 is killed and the message is frozen. A value of zero time specifies no
19417 timeout.
19418
19419
19420 The standard output of the command is connected to a pipe, which is read when
19421 the command terminates. It should consist of a single line of output,
19422 containing up to five fields, separated by white space. The maximum length of
19423 the line is 1023 characters. Longer lines are silently truncated. The first
19424 field is one of the following words (case-insensitive):
19425
19426 .ilist
19427 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19428 below).
19429 .next
19430 &'Decline'&: the router declines; pass the address to the next router, unless
19431 &%no_more%& is set.
19432 .next
19433 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19434 subsequent text on the line is an error message. If the router is run as part
19435 of address verification during an incoming SMTP message, the message is
19436 included in the SMTP response.
19437 .next
19438 &'Defer'&: routing could not be completed at this time; try again later. Any
19439 subsequent text on the line is an error message which is logged. It is not
19440 included in any SMTP response.
19441 .next
19442 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19443 .next
19444 &'Pass'&: pass the address to the next router (or the router specified by
19445 &%pass_router%&), overriding &%no_more%&.
19446 .next
19447 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19448 new addresses, which are routed independently, starting with the first router,
19449 or the router specified by &%redirect_router%&, if set.
19450 .endlist
19451
19452 When the first word is &'accept'&, the remainder of the line consists of a
19453 number of keyed data values, as follows (split into two lines here, to fit on
19454 the page):
19455 .code
19456 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19457 LOOKUP=byname|bydns DATA=<text>
19458 .endd
19459 The data items can be given in any order, and all are optional. If no transport
19460 is included, the transport specified by the generic &%transport%& option is
19461 used. The list of hosts and the lookup type are needed only if the transport is
19462 an &(smtp)& transport that does not itself supply a list of hosts.
19463
19464 The format of the list of hosts is the same as for the &(manualroute)& router.
19465 As well as host names and IP addresses with optional port numbers, as described
19466 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19467 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19468 (see section &<<SECThostshowused>>&).
19469
19470 If the lookup type is not specified, Exim behaves as follows when trying to
19471 find an IP address for each host: First, a DNS lookup is done. If this yields
19472 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19473 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19474 result of the lookup is the result of that call.
19475
19476 .vindex "&$address_data$&"
19477 If the DATA field is set, its value is placed in the &$address_data$&
19478 variable. For example, this return line
19479 .code
19480 accept hosts=x1.y.example:x2.y.example data="rule1"
19481 .endd
19482 routes the address to the default transport, passing a list of two hosts. When
19483 the transport runs, the string &"rule1"& is in &$address_data$&.
19484 .ecindex IIDquerou1
19485 .ecindex IIDquerou2
19486
19487
19488
19489
19490 . ////////////////////////////////////////////////////////////////////////////
19491 . ////////////////////////////////////////////////////////////////////////////
19492
19493 .chapter "The redirect router" "CHAPredirect"
19494 .scindex IIDredrou1 "&(redirect)& router"
19495 .scindex IIDredrou2 "routers" "&(redirect)&"
19496 .cindex "alias file" "in a &(redirect)& router"
19497 .cindex "address redirection" "&(redirect)& router"
19498 The &(redirect)& router handles several kinds of address redirection. Its most
19499 common uses are for resolving local part aliases from a central alias file
19500 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19501 files, but it has many other potential uses. The incoming address can be
19502 redirected in several different ways:
19503
19504 .ilist
19505 It can be replaced by one or more new addresses which are themselves routed
19506 independently.
19507 .next
19508 It can be routed to be delivered to a given file or directory.
19509 .next
19510 It can be routed to be delivered to a specified pipe command.
19511 .next
19512 It can cause an automatic reply to be generated.
19513 .next
19514 It can be forced to fail, optionally with a custom error message.
19515 .next
19516 It can be temporarily deferred, optionally with a custom message.
19517 .next
19518 It can be discarded.
19519 .endlist
19520
19521 The generic &%transport%& option must not be set for &(redirect)& routers.
19522 However, there are some private options which define transports for delivery to
19523 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19524 &%pipe_transport%& and &%reply_transport%& descriptions below.
19525
19526 If success DSNs have been requested
19527 .cindex "DSN" "success"
19528 .cindex "Delivery Status Notification" "success"
19529 redirection triggers one and the DSN options are not passed any further.
19530
19531
19532
19533 .section "Redirection data" "SECID124"
19534 The router operates by interpreting a text string which it obtains either by
19535 expanding the contents of the &%data%& option, or by reading the entire
19536 contents of a file whose name is given in the &%file%& option. These two
19537 options are mutually exclusive. The first is commonly used for handling system
19538 aliases, in a configuration like this:
19539 .code
19540 system_aliases:
19541   driver = redirect
19542   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19543 .endd
19544 If the lookup fails, the expanded string in this example is empty. When the
19545 expansion of &%data%& results in an empty string, the router declines. A forced
19546 expansion failure also causes the router to decline; other expansion failures
19547 cause delivery to be deferred.
19548
19549 A configuration using &%file%& is commonly used for handling users'
19550 &_.forward_& files, like this:
19551 .code
19552 userforward:
19553   driver = redirect
19554   check_local_user
19555   file = $home/.forward
19556   no_verify
19557 .endd
19558 If the file does not exist, or causes no action to be taken (for example, it is
19559 empty or consists only of comments), the router declines. &*Warning*&: This
19560 is not the case when the file contains syntactically valid items that happen to
19561 yield empty addresses, for example, items containing only RFC 2822 address
19562 comments.
19563
19564
19565
19566 .section "Forward files and address verification" "SECID125"
19567 .cindex "address redirection" "while verifying"
19568 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19569 &_.forward_& files, as in the example above. There are two reasons for this:
19570
19571 .ilist
19572 When Exim is receiving an incoming SMTP message from a remote host, it is
19573 running under the Exim uid, not as root. Exim is unable to change uid to read
19574 the file as the user, and it may not be able to read it as the Exim user. So in
19575 practice the router may not be able to operate.
19576 .next
19577 However, even when the router can operate, the existence of a &_.forward_& file
19578 is unimportant when verifying an address. What should be checked is whether the
19579 local part is a valid user name or not. Cutting out the redirection processing
19580 saves some resources.
19581 .endlist
19582
19583
19584
19585
19586
19587
19588 .section "Interpreting redirection data" "SECID126"
19589 .cindex "Sieve filter" "specifying in redirection data"
19590 .cindex "filter" "specifying in redirection data"
19591 The contents of the data string, whether obtained from &%data%& or &%file%&,
19592 can be interpreted in two different ways:
19593
19594 .ilist
19595 If the &%allow_filter%& option is set true, and the data begins with the text
19596 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19597 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19598 respectively. Details of the syntax and semantics of filter files are described
19599 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19600 document is intended for use by end users.
19601 .next
19602 Otherwise, the data must be a comma-separated list of redirection items, as
19603 described in the next section.
19604 .endlist
19605
19606 When a message is redirected to a file (a &"mail folder"&), the file name given
19607 in a non-filter redirection list must always be an absolute path. A filter may
19608 generate a relative path &-- how this is handled depends on the transport's
19609 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19610 for the &(appendfile)& transport.
19611
19612
19613
19614 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19615 .cindex "address redirection" "non-filter list items"
19616 When the redirection data is not an Exim or Sieve filter, for example, if it
19617 comes from a conventional alias or forward file, it consists of a list of
19618 addresses, file names, pipe commands, or certain special items (see section
19619 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19620 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19621 depending on their default values. The items in the list are separated by
19622 commas or newlines.
19623 If a comma is required in an item, the entire item must be enclosed in double
19624 quotes.
19625
19626 Lines starting with a # character are comments, and are ignored, and # may
19627 also appear following a comma, in which case everything between the # and the
19628 next newline character is ignored.
19629
19630 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19631 double quotes are retained because some forms of mail address require their use
19632 (but never to enclose the entire address). In the following description,
19633 &"item"& refers to what remains after any surrounding double quotes have been
19634 removed.
19635
19636 .vindex "&$local_part$&"
19637 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19638 and the expansion contains a reference to &$local_part$&, you should make use
19639 of the &%quote_local_part%& expansion operator, in case the local part contains
19640 special characters. For example, to redirect all mail for the domain
19641 &'obsolete.example'&, retaining the existing local part, you could use this
19642 setting:
19643 .code
19644 data = ${quote_local_part:$local_part}@newdomain.example
19645 .endd
19646
19647
19648 .section "Redirecting to a local mailbox" "SECTredlocmai"
19649 .cindex "routing" "loops in"
19650 .cindex "loop" "while routing, avoidance of"
19651 .cindex "address redirection" "to local mailbox"
19652 A redirection item may safely be the same as the address currently under
19653 consideration. This does not cause a routing loop, because a router is
19654 automatically skipped if any ancestor of the address that is being processed
19655 is the same as the current address and was processed by the current router.
19656 Such an address is therefore passed to the following routers, so it is handled
19657 as if there were no redirection. When making this loop-avoidance test, the
19658 complete local part, including any prefix or suffix, is used.
19659
19660 .cindex "address redirection" "local part without domain"
19661 Specifying the same local part without a domain is a common usage in personal
19662 filter files when the user wants to have messages delivered to the local
19663 mailbox and also forwarded elsewhere. For example, the user whose login is
19664 &'cleo'& might have a &_.forward_& file containing this:
19665 .code
19666 cleo, cleopatra@egypt.example
19667 .endd
19668 .cindex "backslash in alias file"
19669 .cindex "alias file" "backslash in"
19670 For compatibility with other MTAs, such unqualified local parts may be
19671 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19672 it does make a difference if more than one domain is being handled
19673 synonymously.
19674
19675 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19676 2822 address that does not include a domain, the item is qualified using the
19677 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19678 addresses are qualified using the value in &%qualify_recipient%&, but you can
19679 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19680
19681 Care must be taken if there are alias names for local users.
19682 Consider an MTA handling a single local domain where the system alias file
19683 contains:
19684 .code
19685 Sam.Reman: spqr
19686 .endd
19687 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19688 messages in the local mailbox, and also forward copies elsewhere. He creates
19689 this forward file:
19690 .code
19691 Sam.Reman, spqr@reme.elsewhere.example
19692 .endd
19693 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19694 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19695 second time round, because it has previously routed it,
19696 and the following routers presumably cannot handle the alias. The forward file
19697 should really contain
19698 .code
19699 spqr, spqr@reme.elsewhere.example
19700 .endd
19701 but because this is such a common error, the &%check_ancestor%& option (see
19702 below) exists to provide a way to get round it. This is normally set on a
19703 &(redirect)& router that is handling users' &_.forward_& files.
19704
19705
19706
19707 .section "Special items in redirection lists" "SECTspecitredli"
19708 In addition to addresses, the following types of item may appear in redirection
19709 lists (that is, in non-filter redirection data):
19710
19711 .ilist
19712 .cindex "pipe" "in redirection list"
19713 .cindex "address redirection" "to pipe"
19714 An item is treated as a pipe command if it begins with &"|"& and does not parse
19715 as a valid RFC 2822 address that includes a domain. A transport for running the
19716 command must be specified by the &%pipe_transport%& option.
19717 Normally, either the router or the transport specifies a user and a group under
19718 which to run the delivery. The default is to use the Exim user and group.
19719
19720 Single or double quotes can be used for enclosing the individual arguments of
19721 the pipe command; no interpretation of escapes is done for single quotes. If
19722 the command contains a comma character, it is necessary to put the whole item
19723 in double quotes, for example:
19724 .code
19725 "|/some/command ready,steady,go"
19726 .endd
19727 since items in redirection lists are terminated by commas. Do not, however,
19728 quote just the command. An item such as
19729 .code
19730 |"/some/command ready,steady,go"
19731 .endd
19732 is interpreted as a pipe with a rather strange command name, and no arguments.
19733
19734 Note that the above example assumes that the text comes from a lookup source
19735 of some sort, so that the quotes are part of the data.  If composing a
19736 redirect router with a &%data%& option directly specifying this command, the
19737 quotes will be used by the configuration parser to define the extent of one
19738 string, but will not be passed down into the redirect router itself.  There
19739 are two main approaches to get around this: escape quotes to be part of the
19740 data itself, or avoid using this mechanism and instead create a custom
19741 transport with the &%command%& option set and reference that transport from
19742 an &%accept%& router.
19743
19744 .next
19745 .cindex "file" "in redirection list"
19746 .cindex "address redirection" "to file"
19747 An item is interpreted as a path name if it begins with &"/"& and does not
19748 parse as a valid RFC 2822 address that includes a domain. For example,
19749 .code
19750 /home/world/minbari
19751 .endd
19752 is treated as a file name, but
19753 .code
19754 /s=molari/o=babylon/@x400gate.way
19755 .endd
19756 is treated as an address. For a file name, a transport must be specified using
19757 the &%file_transport%& option. However, if the generated path name ends with a
19758 forward slash character, it is interpreted as a directory name rather than a
19759 file name, and &%directory_transport%& is used instead.
19760
19761 Normally, either the router or the transport specifies a user and a group under
19762 which to run the delivery. The default is to use the Exim user and group.
19763
19764 .cindex "&_/dev/null_&"
19765 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19766 bypassed at a high level, and the log entry shows &"**bypassed**"&
19767 instead of a transport name. In this case the user and group are not used.
19768
19769 .next
19770 .cindex "included address list"
19771 .cindex "address redirection" "included external list"
19772 If an item is of the form
19773 .code
19774 :include:<path name>
19775 .endd
19776 a list of further items is taken from the given file and included at that
19777 point. &*Note*&: Such a file can not be a filter file; it is just an
19778 out-of-line addition to the list. The items in the included list are separated
19779 by commas or newlines and are not subject to expansion. If this is the first
19780 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19781 the alias name. This example is incorrect:
19782 .code
19783 list1    :include:/opt/lists/list1
19784 .endd
19785 It must be given as
19786 .code
19787 list1:   :include:/opt/lists/list1
19788 .endd
19789 .next
19790 .cindex "address redirection" "to black hole"
19791 Sometimes you want to throw away mail to a particular local part. Making the
19792 &%data%& option expand to an empty string does not work, because that causes
19793 the router to decline. Instead, the alias item
19794 .cindex "black hole"
19795 .cindex "abandoning mail"
19796 &':blackhole:'& can be used. It does what its name implies. No delivery is
19797 done, and no error message is generated. This has the same effect as specifying
19798 &_/dev/null_& as a destination, but it can be independently disabled.
19799
19800 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19801 delivery is done for the original local part, even if other redirection items
19802 are present. If you are generating a multi-item list (for example, by reading a
19803 database) and need the ability to provide a no-op item, you must use
19804 &_/dev/null_&.
19805
19806 .next
19807 .cindex "delivery" "forcing failure"
19808 .cindex "delivery" "forcing deferral"
19809 .cindex "failing delivery" "forcing"
19810 .cindex "deferred delivery, forcing"
19811 .cindex "customizing" "failure message"
19812 An attempt to deliver a particular address can be deferred or forced to fail by
19813 redirection items of the form
19814 .code
19815 :defer:
19816 :fail:
19817 .endd
19818 respectively. When a redirection list contains such an item, it applies
19819 to the entire redirection; any other items in the list are ignored. Any
19820 text following &':fail:'& or &':defer:'& is placed in the error text
19821 associated with the failure. For example, an alias file might contain:
19822 .code
19823 X.Employee:  :fail: Gone away, no forwarding address
19824 .endd
19825 In the case of an address that is being verified from an ACL or as the subject
19826 of a
19827 .cindex "VRFY" "error text, display of"
19828 VRFY command, the text is included in the SMTP error response by
19829 default.
19830 .cindex "EXPN" "error text, display of"
19831 The text is not included in the response to an EXPN command. In non-SMTP cases
19832 the text is included in the error message that Exim generates.
19833
19834 .cindex "SMTP" "error codes"
19835 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19836 &':fail:'&. However, if the message starts with three digits followed by a
19837 space, optionally followed by an extended code of the form &'n.n.n'&, also
19838 followed by a space, and the very first digit is the same as the default error
19839 code, the code from the message is used instead. If the very first digit is
19840 incorrect, a panic error is logged, and the default code is used. You can
19841 suppress the use of the supplied code in a redirect router by setting the
19842 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19843 ignored.
19844
19845 .vindex "&$acl_verify_message$&"
19846 In an ACL, an explicitly provided message overrides the default, but the
19847 default message is available in the variable &$acl_verify_message$& and can
19848 therefore be included in a custom message if this is desired.
19849
19850 Normally the error text is the rest of the redirection list &-- a comma does
19851 not terminate it &-- but a newline does act as a terminator. Newlines are not
19852 normally present in alias expansions. In &(lsearch)& lookups they are removed
19853 as part of the continuation process, but they may exist in other kinds of
19854 lookup and in &':include:'& files.
19855
19856 During routing for message delivery (as opposed to verification), a redirection
19857 containing &':fail:'& causes an immediate failure of the incoming address,
19858 whereas &':defer:'& causes the message to remain on the queue so that a
19859 subsequent delivery attempt can happen at a later time. If an address is
19860 deferred for too long, it will ultimately fail, because the normal retry
19861 rules still apply.
19862
19863 .next
19864 .cindex "alias file" "exception to default"
19865 Sometimes it is useful to use a single-key search type with a default (see
19866 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19867 for exceptions to the default. These can be handled by aliasing them to
19868 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19869 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19870 results in an empty redirection list has the same effect.
19871 .endlist
19872
19873
19874 .section "Duplicate addresses" "SECTdupaddr"
19875 .cindex "duplicate addresses"
19876 .cindex "address duplicate, discarding"
19877 .cindex "pipe" "duplicated"
19878 Exim removes duplicate addresses from the list to which it is delivering, so as
19879 to deliver just one copy to each address. This does not apply to deliveries
19880 routed to pipes by different immediate parent addresses, but an indirect
19881 aliasing scheme of the type
19882 .code
19883 pipe:       |/some/command $local_part
19884 localpart1: pipe
19885 localpart2: pipe
19886 .endd
19887 does not work with a message that is addressed to both local parts, because
19888 when the second is aliased to the intermediate local part &"pipe"& it gets
19889 discarded as being the same as a previously handled address. However, a scheme
19890 such as
19891 .code
19892 localpart1: |/some/command $local_part
19893 localpart2: |/some/command $local_part
19894 .endd
19895 does result in two different pipe deliveries, because the immediate parents of
19896 the pipes are distinct.
19897
19898
19899
19900 .section "Repeated redirection expansion" "SECID128"
19901 .cindex "repeated redirection expansion"
19902 .cindex "address redirection" "repeated for each delivery attempt"
19903 When a message cannot be delivered to all of its recipients immediately,
19904 leading to two or more delivery attempts, redirection expansion is carried out
19905 afresh each time for those addresses whose children were not all previously
19906 delivered. If redirection is being used as a mailing list, this can lead to new
19907 members of the list receiving copies of old messages. The &%one_time%& option
19908 can be used to avoid this.
19909
19910
19911 .section "Errors in redirection lists" "SECID129"
19912 .cindex "address redirection" "errors"
19913 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19914 error is skipped, and an entry is written to the main log. This may be useful
19915 for mailing lists that are automatically managed. Otherwise, if an error is
19916 detected while generating the list of new addresses, the original address is
19917 deferred. See also &%syntax_errors_to%&.
19918
19919
19920
19921 .section "Private options for the redirect router" "SECID130"
19922
19923 .cindex "options" "&(redirect)& router"
19924 The private options for the &(redirect)& router are as follows:
19925
19926
19927 .option allow_defer redirect boolean false
19928 Setting this option allows the use of &':defer:'& in non-filter redirection
19929 data, or the &%defer%& command in an Exim filter file.
19930
19931
19932 .option allow_fail redirect boolean false
19933 .cindex "failing delivery" "from filter"
19934 If this option is true, the &':fail:'& item can be used in a redirection list,
19935 and the &%fail%& command may be used in an Exim filter file.
19936
19937
19938 .option allow_filter redirect boolean false
19939 .cindex "filter" "enabling use of"
19940 .cindex "Sieve filter" "enabling use of"
19941 Setting this option allows Exim to interpret redirection data that starts with
19942 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19943 are some features of Exim filter files that some administrators may wish to
19944 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19945
19946 It is also possible to lock out Exim filters or Sieve filters while allowing
19947 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19948
19949
19950 The filter is run using the uid and gid set by the generic &%user%& and
19951 &%group%& options. These take their defaults from the password data if
19952 &%check_local_user%& is set, so in the normal case of users' personal filter
19953 files, the filter is run as the relevant user. When &%allow_filter%& is set
19954 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19955
19956
19957
19958 .option allow_freeze redirect boolean false
19959 .cindex "freezing messages" "allowing in filter"
19960 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19961 This command is more normally encountered in system filters, and is disabled by
19962 default for redirection filters because it isn't something you usually want to
19963 let ordinary users do.
19964
19965
19966
19967 .option check_ancestor redirect boolean false
19968 This option is concerned with handling generated addresses that are the same
19969 as some address in the list of redirection ancestors of the current address.
19970 Although it is turned off by default in the code, it is set in the default
19971 configuration file for handling users' &_.forward_& files. It is recommended
19972 for this use of the &(redirect)& router.
19973
19974 When &%check_ancestor%& is set, if a generated address (including the domain)
19975 is the same as any ancestor of the current address, it is replaced by a copy of
19976 the current address. This helps in the case where local part A is aliased to B,
19977 and B has a &_.forward_& file pointing back to A. For example, within a single
19978 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19979 &_&~jb/.forward_& contains:
19980 .code
19981 \Joe.Bloggs, <other item(s)>
19982 .endd
19983 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19984 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19985 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19986 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19987 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19988 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19989 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19990 original address. See also the &%repeat_use%& option below.
19991
19992
19993 .option check_group redirect boolean "see below"
19994 When the &%file%& option is used, the group owner of the file is checked only
19995 when this option is set. The permitted groups are those listed in the
19996 &%owngroups%& option, together with the user's default group if
19997 &%check_local_user%& is set. If the file has the wrong group, routing is
19998 deferred. The default setting for this option is true if &%check_local_user%&
19999 is set and the &%modemask%& option permits the group write bit, or if the
20000 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20001
20002
20003
20004 .option check_owner redirect boolean "see below"
20005 When the &%file%& option is used, the owner of the file is checked only when
20006 this option is set. If &%check_local_user%& is set, the local user is
20007 permitted; otherwise the owner must be one of those listed in the &%owners%&
20008 option. The default value for this option is true if &%check_local_user%& or
20009 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20010
20011
20012 .option data redirect string&!! unset
20013 This option is mutually exclusive with &%file%&. One or other of them must be
20014 set, but not both. The contents of &%data%& are expanded, and then used as the
20015 list of forwarding items, or as a set of filtering instructions. If the
20016 expansion is forced to fail, or the result is an empty string or a string that
20017 has no effect (consists entirely of comments), the router declines.
20018
20019 When filtering instructions are used, the string must begin with &"#Exim
20020 filter"&, and all comments in the string, including this initial one, must be
20021 terminated with newline characters. For example:
20022 .code
20023 data = #Exim filter\n\
20024        if $h_to: contains Exim then save $home/mail/exim endif
20025 .endd
20026 If you are reading the data from a database where newlines cannot be included,
20027 you can use the &${sg}$& expansion item to turn the escape string of your
20028 choice into a newline.
20029
20030
20031 .option directory_transport redirect string&!! unset
20032 A &(redirect)& router sets up a direct delivery to a directory when a path name
20033 ending with a slash is specified as a new &"address"&. The transport used is
20034 specified by this option, which, after expansion, must be the name of a
20035 configured transport. This should normally be an &(appendfile)& transport.
20036
20037
20038 .option file redirect string&!! unset
20039 This option specifies the name of a file that contains the redirection data. It
20040 is mutually exclusive with the &%data%& option. The string is expanded before
20041 use; if the expansion is forced to fail, the router declines. Other expansion
20042 failures cause delivery to be deferred. The result of a successful expansion
20043 must be an absolute path. The entire file is read and used as the redirection
20044 data. If the data is an empty string or a string that has no effect (consists
20045 entirely of comments), the router declines.
20046
20047 .cindex "NFS" "checking for file existence"
20048 If the attempt to open the file fails with a &"does not exist"& error, Exim
20049 runs a check on the containing directory,
20050 unless &%ignore_enotdir%& is true (see below).
20051 If the directory does not appear to exist, delivery is deferred. This can
20052 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20053 is a mount problem. If the containing directory does exist, but the file does
20054 not, the router declines.
20055
20056
20057 .option file_transport redirect string&!! unset
20058 .vindex "&$address_file$&"
20059 A &(redirect)& router sets up a direct delivery to a file when a path name not
20060 ending in a slash is specified as a new &"address"&. The transport used is
20061 specified by this option, which, after expansion, must be the name of a
20062 configured transport. This should normally be an &(appendfile)& transport. When
20063 it is running, the file name is in &$address_file$&.
20064
20065
20066 .option filter_prepend_home redirect boolean true
20067 When this option is true, if a &(save)& command in an Exim filter specifies a
20068 relative path, and &$home$& is defined, it is automatically prepended to the
20069 relative path. If this option is set false, this action does not happen. The
20070 relative path is then passed to the transport unmodified.
20071
20072
20073 .option forbid_blackhole redirect boolean false
20074 If this option is true, the &':blackhole:'& item may not appear in a
20075 redirection list.
20076
20077
20078 .option forbid_exim_filter redirect boolean false
20079 If this option is set true, only Sieve filters are permitted when
20080 &%allow_filter%& is true.
20081
20082
20083
20084
20085 .option forbid_file redirect boolean false
20086 .cindex "delivery" "to file; forbidding"
20087 .cindex "Sieve filter" "forbidding delivery to a file"
20088 .cindex "Sieve filter" "&""keep""& facility; disabling"
20089 If this option is true, this router may not generate a new address that
20090 specifies delivery to a local file or directory, either from a filter or from a
20091 conventional forward file. This option is forced to be true if &%one_time%& is
20092 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20093 locks out the Sieve's &"keep"& facility.
20094
20095
20096 .option forbid_filter_dlfunc redirect boolean false
20097 .cindex "filter" "locking out certain features"
20098 If this option is true, string expansions in Exim filters are not allowed to
20099 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20100 functions.
20101
20102 .option forbid_filter_existstest redirect boolean false
20103 .cindex "expansion" "statting a file"
20104 If this option is true, string expansions in Exim filters are not allowed to
20105 make use of the &%exists%& condition or the &%stat%& expansion item.
20106
20107 .option forbid_filter_logwrite redirect boolean false
20108 If this option is true, use of the logging facility in Exim filters is not
20109 permitted. Logging is in any case available only if the filter is being run
20110 under some unprivileged uid (which is normally the case for ordinary users'
20111 &_.forward_& files).
20112
20113
20114 .option forbid_filter_lookup redirect boolean false
20115 If this option is true, string expansions in Exim filter files are not allowed
20116 to make use of &%lookup%& items.
20117
20118
20119 .option forbid_filter_perl redirect boolean false
20120 This option has an effect only if Exim is built with embedded Perl support. If
20121 it is true, string expansions in Exim filter files are not allowed to make use
20122 of the embedded Perl support.
20123
20124
20125 .option forbid_filter_readfile redirect boolean false
20126 If this option is true, string expansions in Exim filter files are not allowed
20127 to make use of &%readfile%& items.
20128
20129
20130 .option forbid_filter_readsocket redirect boolean false
20131 If this option is true, string expansions in Exim filter files are not allowed
20132 to make use of &%readsocket%& items.
20133
20134
20135 .option forbid_filter_reply redirect boolean false
20136 If this option is true, this router may not generate an automatic reply
20137 message. Automatic replies can be generated only from Exim or Sieve filter
20138 files, not from traditional forward files. This option is forced to be true if
20139 &%one_time%& is set.
20140
20141
20142 .option forbid_filter_run redirect boolean false
20143 If this option is true, string expansions in Exim filter files are not allowed
20144 to make use of &%run%& items.
20145
20146
20147 .option forbid_include redirect boolean false
20148 If this option is true, items of the form
20149 .code
20150 :include:<path name>
20151 .endd
20152 are not permitted in non-filter redirection lists.
20153
20154
20155 .option forbid_pipe redirect boolean false
20156 .cindex "delivery" "to pipe; forbidding"
20157 If this option is true, this router may not generate a new address which
20158 specifies delivery to a pipe, either from an Exim filter or from a conventional
20159 forward file. This option is forced to be true if &%one_time%& is set.
20160
20161
20162 .option forbid_sieve_filter redirect boolean false
20163 If this option is set true, only Exim filters are permitted when
20164 &%allow_filter%& is true.
20165
20166
20167 .cindex "SMTP" "error codes"
20168 .option forbid_smtp_code redirect boolean false
20169 If this option is set true, any SMTP error codes that are present at the start
20170 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20171 the default codes (451 and 550, respectively) are always used.
20172
20173
20174
20175
20176 .option hide_child_in_errmsg redirect boolean false
20177 .cindex "bounce message" "redirection details; suppressing"
20178 If this option is true, it prevents Exim from quoting a child address if it
20179 generates a bounce or delay message for it. Instead it says &"an address
20180 generated from <&'the top level address'&>"&. Of course, this applies only to
20181 bounces generated locally. If a message is forwarded to another host, &'its'&
20182 bounce may well quote the generated address.
20183
20184
20185 .option ignore_eacces redirect boolean false
20186 .cindex "EACCES"
20187 If this option is set and an attempt to open a redirection file yields the
20188 EACCES error (permission denied), the &(redirect)& router behaves as if the
20189 file did not exist.
20190
20191
20192 .option ignore_enotdir redirect boolean false
20193 .cindex "ENOTDIR"
20194 If this option is set and an attempt to open a redirection file yields the
20195 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20196 router behaves as if the file did not exist.
20197
20198 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20199 router that has the &%file%& option set discovers that the file does not exist
20200 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20201 against unmounted NFS directories. If the parent can not be statted, delivery
20202 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20203 is set, because that option tells Exim to ignore &"something on the path is not
20204 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20205 that some operating systems give ENOENT where others give ENOTDIR.
20206
20207
20208
20209 .option include_directory redirect string unset
20210 If this option is set, the path names of any &':include:'& items in a
20211 redirection list must start with this directory.
20212
20213
20214 .option modemask redirect "octal integer" 022
20215 This specifies mode bits which must not be set for a file specified by the
20216 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20217
20218
20219 .option one_time redirect boolean false
20220 .cindex "one-time aliasing/forwarding expansion"
20221 .cindex "alias file" "one-time expansion"
20222 .cindex "forward file" "one-time expansion"
20223 .cindex "mailing lists" "one-time expansion"
20224 .cindex "address redirection" "one-time expansion"
20225 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20226 files each time it tries to deliver a message causes a problem when one or more
20227 of the generated addresses fails be delivered at the first attempt. The problem
20228 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20229 but of what happens when the redirection list changes during the time that the
20230 message is on Exim's queue. This is particularly true in the case of mailing
20231 lists, where new subscribers might receive copies of messages that were posted
20232 before they subscribed.
20233
20234 If &%one_time%& is set and any addresses generated by the router fail to
20235 deliver at the first attempt, the failing addresses are added to the message as
20236 &"top level"& addresses, and the parent address that generated them is marked
20237 &"delivered"&. Thus, redirection does not happen again at the next delivery
20238 attempt.
20239
20240 &*Warning 1*&: Any header line addition or removal that is specified by this
20241 router would be lost if delivery did not succeed at the first attempt. For this
20242 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20243 permitted when &%one_time%& is set.
20244
20245 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20246 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20247 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20248
20249 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20250 &%one_time%&.
20251
20252 The original top-level address is remembered with each of the generated
20253 addresses, and is output in any log messages. However, any intermediate parent
20254 addresses are not recorded. This makes a difference to the log only if
20255 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20256 typically be used for mailing lists, where there is normally just one level of
20257 expansion.
20258
20259
20260 .option owners redirect "string list" unset
20261 .cindex "ownership" "alias file"
20262 .cindex "ownership" "forward file"
20263 .cindex "alias file" "ownership"
20264 .cindex "forward file" "ownership"
20265 This specifies a list of permitted owners for the file specified by &%file%&.
20266 This list is in addition to the local user when &%check_local_user%& is set.
20267 See &%check_owner%& above.
20268
20269
20270 .option owngroups redirect "string list" unset
20271 This specifies a list of permitted groups for the file specified by &%file%&.
20272 The list is in addition to the local user's primary group when
20273 &%check_local_user%& is set. See &%check_group%& above.
20274
20275
20276 .option pipe_transport redirect string&!! unset
20277 .vindex "&$address_pipe$&"
20278 A &(redirect)& router sets up a direct delivery to a pipe when a string
20279 starting with a vertical bar character is specified as a new &"address"&. The
20280 transport used is specified by this option, which, after expansion, must be the
20281 name of a configured transport. This should normally be a &(pipe)& transport.
20282 When the transport is run, the pipe command is in &$address_pipe$&.
20283
20284
20285 .option qualify_domain redirect string&!! unset
20286 .vindex "&$qualify_recipient$&"
20287 If this option is set, and an unqualified address (one without a domain) is
20288 generated, and that address would normally be qualified by the global setting
20289 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20290 expanding this string. If the expansion fails, the router declines. If you want
20291 to revert to the default, you can have the expansion generate
20292 &$qualify_recipient$&.
20293
20294 This option applies to all unqualified addresses generated by Exim filters,
20295 but for traditional &_.forward_& files, it applies only to addresses that are
20296 not preceded by a backslash. Sieve filters cannot generate unqualified
20297 addresses.
20298
20299 .option qualify_preserve_domain redirect boolean false
20300 .cindex "domain" "in redirection; preserving"
20301 .cindex "preserving domain in redirection"
20302 .cindex "address redirection" "domain; preserving"
20303 If this option is set, the router's local &%qualify_domain%& option must not be
20304 set (a configuration error occurs if it is). If an unqualified address (one
20305 without a domain) is generated, it is qualified with the domain of the parent
20306 address (the immediately preceding ancestor) instead of the global
20307 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20308 this applies whether or not the address is preceded by a backslash.
20309
20310
20311 .option repeat_use redirect boolean true
20312 If this option is set false, the router is skipped for a child address that has
20313 any ancestor that was routed by this router. This test happens before any of
20314 the other preconditions are tested. Exim's default anti-looping rules skip
20315 only when the ancestor is the same as the current address. See also
20316 &%check_ancestor%& above and the generic &%redirect_router%& option.
20317
20318
20319 .option reply_transport redirect string&!! unset
20320 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20321 &%vacation%& command is used in a filter file. The transport used is specified
20322 by this option, which, after expansion, must be the name of a configured
20323 transport. This should normally be an &(autoreply)& transport. Other transports
20324 are unlikely to do anything sensible or useful.
20325
20326
20327 .option rewrite redirect boolean true
20328 .cindex "address redirection" "disabling rewriting"
20329 If this option is set false, addresses generated by the router are not
20330 subject to address rewriting. Otherwise, they are treated like new addresses
20331 and are rewritten according to the global rewriting rules.
20332
20333
20334 .option sieve_subaddress redirect string&!! unset
20335 The value of this option is passed to a Sieve filter to specify the
20336 :subaddress part of an address.
20337
20338 .option sieve_useraddress redirect string&!! unset
20339 The value of this option is passed to a Sieve filter to specify the :user part
20340 of an address. However, if it is unset, the entire original local part
20341 (including any prefix or suffix) is used for :user.
20342
20343
20344 .option sieve_vacation_directory redirect string&!! unset
20345 .cindex "Sieve filter" "vacation directory"
20346 To enable the &"vacation"& extension for Sieve filters, you must set
20347 &%sieve_vacation_directory%& to the directory where vacation databases are held
20348 (do not put anything else in that directory), and ensure that the
20349 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20350 needs their own directory; Exim will create it if necessary.
20351
20352
20353
20354 .option skip_syntax_errors redirect boolean false
20355 .cindex "forward file" "broken"
20356 .cindex "address redirection" "broken files"
20357 .cindex "alias file" "broken"
20358 .cindex "broken alias or forward files"
20359 .cindex "ignoring faulty addresses"
20360 .cindex "skipping faulty addresses"
20361 .cindex "error" "skipping bad syntax"
20362 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20363 non-filter redirection data are skipped, and each failing address is logged. If
20364 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20365 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20366 are expanded and placed at the head of the error message generated by
20367 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20368 be the same address as the generic &%errors_to%& option. The
20369 &%skip_syntax_errors%& option is often used when handling mailing lists.
20370
20371 If all the addresses in a redirection list are skipped because of syntax
20372 errors, the router declines to handle the original address, and it is passed to
20373 the following routers.
20374
20375 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20376 error in the filter causes filtering to be abandoned without any action being
20377 taken. The incident is logged, and the router declines to handle the address,
20378 so it is passed to the following routers.
20379
20380 .cindex "Sieve filter" "syntax errors in"
20381 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20382 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20383 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20384
20385 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20386 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20387 option, used with an address that does not get redirected, can be used to
20388 notify users of these errors, by means of a router like this:
20389 .code
20390 userforward:
20391   driver = redirect
20392   allow_filter
20393   check_local_user
20394   file = $home/.forward
20395   file_transport = address_file
20396   pipe_transport = address_pipe
20397   reply_transport = address_reply
20398   no_verify
20399   skip_syntax_errors
20400   syntax_errors_to = real-$local_part@$domain
20401   syntax_errors_text = \
20402    This is an automatically generated message. An error has\n\
20403    been found in your .forward file. Details of the error are\n\
20404    reported below. While this error persists, you will receive\n\
20405    a copy of this message for every message that is addressed\n\
20406    to you. If your .forward file is a filter file, or if it is\n\
20407    a non-filter file containing no valid forwarding addresses,\n\
20408    a copy of each incoming message will be put in your normal\n\
20409    mailbox. If a non-filter file contains at least one valid\n\
20410    forwarding address, forwarding to the valid addresses will\n\
20411    happen, and those will be the only deliveries that occur.
20412 .endd
20413 You also need a router to ensure that local addresses that are prefixed by
20414 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20415 put this immediately before the &(userforward)& router:
20416 .code
20417 real_localuser:
20418   driver = accept
20419   check_local_user
20420   local_part_prefix = real-
20421   transport = local_delivery
20422 .endd
20423 For security, it would probably be a good idea to restrict the use of this
20424 router to locally-generated messages, using a condition such as this:
20425 .code
20426   condition = ${if match {$sender_host_address}\
20427                          {\N^(|127\.0\.0\.1)$\N}}
20428 .endd
20429
20430
20431 .option syntax_errors_text redirect string&!! unset
20432 See &%skip_syntax_errors%& above.
20433
20434
20435 .option syntax_errors_to redirect string unset
20436 See &%skip_syntax_errors%& above.
20437 .ecindex IIDredrou1
20438 .ecindex IIDredrou2
20439
20440
20441
20442
20443
20444
20445 . ////////////////////////////////////////////////////////////////////////////
20446 . ////////////////////////////////////////////////////////////////////////////
20447
20448 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20449          "Environment for local transports"
20450 .scindex IIDenvlotra1 "local transports" "environment for"
20451 .scindex IIDenvlotra2 "environment" "local transports"
20452 .scindex IIDenvlotra3 "transport" "local; environment for"
20453 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20454 transport can be thought of as similar to a pipe.) Exim always runs transports
20455 in subprocesses, under specified uids and gids. Typical deliveries to local
20456 mailboxes run under the uid and gid of the local user.
20457
20458 Exim also sets a specific current directory while running the transport; for
20459 some transports a home directory setting is also relevant. The &(pipe)&
20460 transport is the only one that sets up environment variables; see section
20461 &<<SECTpipeenv>>& for details.
20462
20463 The values used for the uid, gid, and the directories may come from several
20464 different places. In many cases, the router that handles the address associates
20465 settings with that address as a result of its &%check_local_user%&, &%group%&,
20466 or &%user%& options. However, values may also be given in the transport's own
20467 configuration, and these override anything that comes from the router.
20468
20469
20470
20471 .section "Concurrent deliveries" "SECID131"
20472 .cindex "concurrent deliveries"
20473 .cindex "simultaneous deliveries"
20474 If two different messages for the same local recipient arrive more or less
20475 simultaneously, the two delivery processes are likely to run concurrently. When
20476 the &(appendfile)& transport is used to write to a file, Exim applies locking
20477 rules to stop concurrent processes from writing to the same file at the same
20478 time.
20479
20480 However, when you use a &(pipe)& transport, it is up to you to arrange any
20481 locking that is needed. Here is a silly example:
20482 .code
20483 my_transport:
20484   driver = pipe
20485   command = /bin/sh -c 'cat >>/some/file'
20486 .endd
20487 This is supposed to write the message at the end of the file. However, if two
20488 messages arrive at the same time, the file will be scrambled. You can use the
20489 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20490 file using the same algorithm that Exim itself uses.
20491
20492
20493
20494
20495 .section "Uids and gids" "SECTenvuidgid"
20496 .cindex "local transports" "uid and gid"
20497 .cindex "transport" "local; uid and gid"
20498 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20499 overrides any group that the router set in the address, even if &%user%& is not
20500 set for the transport. This makes it possible, for example, to run local mail
20501 delivery under the uid of the recipient (set by the router), but in a special
20502 group (set by the transport). For example:
20503 .code
20504 # Routers ...
20505 # User/group are set by check_local_user in this router
20506 local_users:
20507   driver = accept
20508   check_local_user
20509   transport = group_delivery
20510
20511 # Transports ...
20512 # This transport overrides the group
20513 group_delivery:
20514   driver = appendfile
20515   file = /var/spool/mail/$local_part
20516   group = mail
20517 .endd
20518 If &%user%& is set for a transport, its value overrides what is set in the
20519 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20520 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20521 set.
20522
20523 .oindex "&%initgroups%&"
20524 When the uid is taken from the transport's configuration, the &[initgroups()]&
20525 function is called for the groups associated with that uid if the
20526 &%initgroups%& option is set for the transport. When the uid is not specified
20527 by the transport, but is associated with the address by a router, the option
20528 for calling &[initgroups()]& is taken from the router configuration.
20529
20530 .cindex "&(pipe)& transport" "uid for"
20531 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20532 is set and &%user%& is not set, the uid of the process that called Exim to
20533 receive the message is used, and if &%group%& is not set, the corresponding
20534 original gid is also used.
20535
20536 This is the detailed preference order for obtaining a gid; the first of the
20537 following that is set is used:
20538
20539 .ilist
20540 A &%group%& setting of the transport;
20541 .next
20542 A &%group%& setting of the router;
20543 .next
20544 A gid associated with a user setting of the router, either as a result of
20545 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20546 .next
20547 The group associated with a non-numeric &%user%& setting of the transport;
20548 .next
20549 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20550 the uid is the creator's uid;
20551 .next
20552 The Exim gid if the Exim uid is being used as a default.
20553 .endlist
20554
20555 If, for example, the user is specified numerically on the router and there are
20556 no group settings, no gid is available. In this situation, an error occurs.
20557 This is different for the uid, for which there always is an ultimate default.
20558 The first of the following that is set is used:
20559
20560 .ilist
20561 A &%user%& setting of the transport;
20562 .next
20563 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20564 .next
20565 A &%user%& setting of the router;
20566 .next
20567 A &%check_local_user%& setting of the router;
20568 .next
20569 The Exim uid.
20570 .endlist
20571
20572 Of course, an error will still occur if the uid that is chosen is on the
20573 &%never_users%& list.
20574
20575
20576
20577
20578
20579 .section "Current and home directories" "SECID132"
20580 .cindex "current directory for local transport"
20581 .cindex "home directory" "for local transport"
20582 .cindex "transport" "local; home directory for"
20583 .cindex "transport" "local; current directory for"
20584 Routers may set current and home directories for local transports by means of
20585 the &%transport_current_directory%& and &%transport_home_directory%& options.
20586 However, if the transport's &%current_directory%& or &%home_directory%& options
20587 are set, they override the router's values. In detail, the home directory
20588 for a local transport is taken from the first of these values that is set:
20589
20590 .ilist
20591 The &%home_directory%& option on the transport;
20592 .next
20593 The &%transport_home_directory%& option on the router;
20594 .next
20595 The password data if &%check_local_user%& is set on the router;
20596 .next
20597 The &%router_home_directory%& option on the router.
20598 .endlist
20599
20600 The current directory is taken from the first of these values that is set:
20601
20602 .ilist
20603 The &%current_directory%& option on the transport;
20604 .next
20605 The &%transport_current_directory%& option on the router.
20606 .endlist
20607
20608
20609 If neither the router nor the transport sets a current directory, Exim uses the
20610 value of the home directory, if it is set. Otherwise it sets the current
20611 directory to &_/_& before running a local transport.
20612
20613
20614
20615 .section "Expansion variables derived from the address" "SECID133"
20616 .vindex "&$domain$&"
20617 .vindex "&$local_part$&"
20618 .vindex "&$original_domain$&"
20619 Normally a local delivery is handling a single address, and in that case the
20620 variables such as &$domain$& and &$local_part$& are set during local
20621 deliveries. However, in some circumstances more than one address may be handled
20622 at once (for example, while writing batch SMTP for onward transmission by some
20623 other means). In this case, the variables associated with the local part are
20624 never set, &$domain$& is set only if all the addresses have the same domain,
20625 and &$original_domain$& is never set.
20626 .ecindex IIDenvlotra1
20627 .ecindex IIDenvlotra2
20628 .ecindex IIDenvlotra3
20629
20630
20631
20632
20633
20634
20635
20636 . ////////////////////////////////////////////////////////////////////////////
20637 . ////////////////////////////////////////////////////////////////////////////
20638
20639 .chapter "Generic options for transports" "CHAPtransportgeneric"
20640 .scindex IIDgenoptra1 "generic options" "transport"
20641 .scindex IIDgenoptra2 "options" "generic; for transports"
20642 .scindex IIDgenoptra3 "transport" "generic options for"
20643 The following generic options apply to all transports:
20644
20645
20646 .option body_only transports boolean false
20647 .cindex "transport" "body only"
20648 .cindex "message" "transporting body only"
20649 .cindex "body of message" "transporting"
20650 If this option is set, the message's headers are not transported. It is
20651 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20652 or &(pipe)& transports, the settings of &%message_prefix%& and
20653 &%message_suffix%& should be checked, because this option does not
20654 automatically suppress them.
20655
20656
20657 .option current_directory transports string&!! unset
20658 .cindex "transport" "current directory for"
20659 This specifies the current directory that is to be set while running the
20660 transport, overriding any value that may have been set by the router.
20661 If the expansion fails for any reason, including forced failure, an error is
20662 logged, and delivery is deferred.
20663
20664
20665 .option disable_logging transports boolean false
20666 If this option is set true, nothing is logged for any
20667 deliveries by the transport or for any
20668 transport errors. You should not set this option unless you really, really know
20669 what you are doing.
20670
20671
20672 .option debug_print transports string&!! unset
20673 .cindex "testing" "variables in drivers"
20674 If this option is set and debugging is enabled (see the &%-d%& command line
20675 option), the string is expanded and included in the debugging output when the
20676 transport is run.
20677 If expansion of the string fails, the error message is written to the debugging
20678 output, and Exim carries on processing.
20679 This facility is provided to help with checking out the values of variables and
20680 so on when debugging driver configurations. For example, if a &%headers_add%&
20681 option is not working properly, &%debug_print%& could be used to output the
20682 variables it references. A newline is added to the text if it does not end with
20683 one.
20684 The variables &$transport_name$& and &$router_name$& contain the name of the
20685 transport and the router that called it.
20686
20687 .option delivery_date_add transports boolean false
20688 .cindex "&'Delivery-date:'& header line"
20689 If this option is true, a &'Delivery-date:'& header is added to the message.
20690 This gives the actual time the delivery was made. As this is not a standard
20691 header, Exim has a configuration option (&%delivery_date_remove%&) which
20692 requests its removal from incoming messages, so that delivered messages can
20693 safely be resent to other recipients.
20694
20695
20696 .option driver transports string unset
20697 This specifies which of the available transport drivers is to be used.
20698 There is no default, and this option must be set for every transport.
20699
20700
20701 .option envelope_to_add transports boolean false
20702 .cindex "&'Envelope-to:'& header line"
20703 If this option is true, an &'Envelope-to:'& header is added to the message.
20704 This gives the original address(es) in the incoming envelope that caused this
20705 delivery to happen. More than one address may be present if the transport is
20706 configured to handle several addresses at once, or if more than one original
20707 address was redirected to the same final address. As this is not a standard
20708 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20709 its removal from incoming messages, so that delivered messages can safely be
20710 resent to other recipients.
20711
20712
20713 .option event_action transports string&!! unset
20714 .cindex events
20715 This option declares a string to be expanded for Exim's events mechanism.
20716 For details see &<<CHAPevents>>&.
20717
20718
20719 .option group transports string&!! "Exim group"
20720 .cindex "transport" "group; specifying"
20721 This option specifies a gid for running the transport process, overriding any
20722 value that the router supplies, and also overriding any value associated with
20723 &%user%& (see below).
20724
20725
20726 .option headers_add transports list&!! unset
20727 .cindex "header lines" "adding in transport"
20728 .cindex "transport" "header lines; adding"
20729 This option specifies a list of text headers,
20730 newline-separated (by default, changeable in the usual way),
20731 which are (separately) expanded and added to the header
20732 portion of a message as it is transported, as described in section
20733 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20734 routers. If the result of the expansion is an empty string, or if the expansion
20735 is forced to fail, no action is taken. Other expansion failures are treated as
20736 errors and cause the delivery to be deferred.
20737
20738 Unlike most options, &%headers_add%& can be specified multiple times
20739 for a transport; all listed headers are added.
20740
20741
20742 .option headers_only transports boolean false
20743 .cindex "transport" "header lines only"
20744 .cindex "message" "transporting headers only"
20745 .cindex "header lines" "transporting"
20746 If this option is set, the message's body is not transported. It is mutually
20747 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20748 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20749 checked, since this option does not automatically suppress them.
20750
20751
20752 .option headers_remove transports list&!! unset
20753 .cindex "header lines" "removing"
20754 .cindex "transport" "header lines; removing"
20755 This option specifies a list of header names,
20756 colon-separated (by default, changeable in the usual way);
20757 these headers are omitted from the message as it is transported, as described
20758 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20759 routers.
20760 Each list item is separately expanded.
20761 If the result of the expansion is an empty string, or if the expansion
20762 is forced to fail, no action is taken. Other expansion failures are treated as
20763 errors and cause the delivery to be deferred.
20764
20765 Unlike most options, &%headers_remove%& can be specified multiple times
20766 for a router; all listed headers are removed.
20767
20768 &*Warning*&: Because of the separate expansion of the list items,
20769 items that contain a list separator must have it doubled.
20770 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20771
20772
20773
20774 .option headers_rewrite transports string unset
20775 .cindex "transport" "header lines; rewriting"
20776 .cindex "rewriting" "at transport time"
20777 This option allows addresses in header lines to be rewritten at transport time,
20778 that is, as the message is being copied to its destination. The contents of the
20779 option are a colon-separated list of rewriting rules. Each rule is in exactly
20780 the same form as one of the general rewriting rules that are applied when a
20781 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20782 example,
20783 .code
20784 headers_rewrite = a@b c@d f : \
20785                   x@y w@z
20786 .endd
20787 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20788 &'w@z'& in all address-bearing header lines. The rules are applied to the
20789 header lines just before they are written out at transport time, so they affect
20790 only those copies of the message that pass through the transport. However, only
20791 the message's original header lines, and any that were added by a system
20792 filter, are rewritten. If a router or transport adds header lines, they are not
20793 affected by this option. These rewriting rules are &'not'& applied to the
20794 envelope. You can change the return path using &%return_path%&, but you cannot
20795 change envelope recipients at this time.
20796
20797
20798 .option home_directory transports string&!! unset
20799 .cindex "transport" "home directory for"
20800 .vindex "&$home$&"
20801 This option specifies a home directory setting for a local transport,
20802 overriding any value that may be set by the router. The home directory is
20803 placed in &$home$& while expanding the transport's private options. It is also
20804 used as the current directory if no current directory is set by the
20805 &%current_directory%& option on the transport or the
20806 &%transport_current_directory%& option on the router. If the expansion fails
20807 for any reason, including forced failure, an error is logged, and delivery is
20808 deferred.
20809
20810
20811 .option initgroups transports boolean false
20812 .cindex "additional groups"
20813 .cindex "groups" "additional"
20814 .cindex "transport" "group; additional"
20815 If this option is true and the uid for the delivery process is provided by the
20816 transport, the &[initgroups()]& function is called when running the transport
20817 to ensure that any additional groups associated with the uid are set up.
20818
20819
20820 .option max_parallel transports integer&!! unset
20821 .cindex limit "transport parallelism"
20822 .cindex transport "parallel processes"
20823 .cindex transport "concurrency limit"
20824 .cindex "delivery" "parallelism for transport"
20825 If this option is set and expands to an integer greater than zero
20826 it limits the number of concurrent runs of the transport.
20827 The control does not apply to shadow transports.
20828
20829 .cindex "hints database" "transport concurrency control"
20830 Exim implements this control by means of a hints database in which a record is
20831 incremented whenever a transport process is beaing created. The record
20832 is decremented and possibly removed when the process terminates.
20833 Obviously there is scope for
20834 records to get left lying around if there is a system or program crash. To
20835 guard against this, Exim ignores any records that are more than six hours old.
20836
20837 If you use this option, you should also arrange to delete the
20838 relevant hints database whenever your system reboots. The names of the files
20839 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20840 may be one or two files, depending on the type of DBM in use. The same files
20841 are used for ETRN and smtp transport serialization.
20842
20843
20844 .option message_size_limit transports string&!! 0
20845 .cindex "limit" "message size per transport"
20846 .cindex "size" "of message, limit"
20847 .cindex "transport" "message size; limiting"
20848 This option controls the size of messages passed through the transport. It is
20849 expanded before use; the result of the expansion must be a sequence of decimal
20850 digits, optionally followed by K or M. If the expansion fails for any reason,
20851 including forced failure, or if the result is not of the required form,
20852 delivery is deferred. If the value is greater than zero and the size of a
20853 message exceeds this limit, the address is failed. If there is any chance that
20854 the resulting bounce message could be routed to the same transport, you should
20855 ensure that &%return_size_limit%& is less than the transport's
20856 &%message_size_limit%&, as otherwise the bounce message will fail to get
20857 delivered.
20858
20859
20860
20861 .option rcpt_include_affixes transports boolean false
20862 .cindex "prefix" "for local part, including in envelope"
20863 .cindex "suffix for local part" "including in envelope"
20864 .cindex "local part" "prefix"
20865 .cindex "local part" "suffix"
20866 When this option is false (the default), and an address that has had any
20867 affixes (prefixes or suffixes) removed from the local part is delivered by any
20868 form of SMTP or LMTP, the affixes are not included. For example, if a router
20869 that contains
20870 .code
20871 local_part_prefix = *-
20872 .endd
20873 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20874 is delivered with
20875 .code
20876 RCPT TO:<xyz@some.domain>
20877 .endd
20878 This is also the case when an ACL-time callout is being used to verify a
20879 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20880 whole local part is included in the RCPT command. This option applies to BSMTP
20881 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20882 &(lmtp)& and &(smtp)& transports.
20883
20884
20885 .option retry_use_local_part transports boolean "see below"
20886 .cindex "hints database" "retry keys"
20887 When a delivery suffers a temporary failure, a retry record is created
20888 in Exim's hints database. For remote deliveries, the key for the retry record
20889 is based on the name and/or IP address of the failing remote host. For local
20890 deliveries, the key is normally the entire address, including both the local
20891 part and the domain. This is suitable for most common cases of local delivery
20892 temporary failure &-- for example, exceeding a mailbox quota should delay only
20893 deliveries to that mailbox, not to the whole domain.
20894
20895 However, in some special cases you may want to treat a temporary local delivery
20896 as a failure associated with the domain, and not with a particular local part.
20897 (For example, if you are storing all mail for some domain in files.) You can do
20898 this by setting &%retry_use_local_part%& false.
20899
20900 For all the local transports, its default value is true. For remote transports,
20901 the default value is false for tidiness, but changing the value has no effect
20902 on a remote transport in the current implementation.
20903
20904
20905 .option return_path transports string&!! unset
20906 .cindex "envelope sender"
20907 .cindex "transport" "return path; changing"
20908 .cindex "return path" "changing in transport"
20909 If this option is set, the string is expanded at transport time and replaces
20910 the existing return path (envelope sender) value in the copy of the message
20911 that is being delivered. An empty return path is permitted. This feature is
20912 designed for remote deliveries, where the value of this option is used in the
20913 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20914 only effect is to change the address that is placed in the &'Return-path:'&
20915 header line, if one is added to the message (see the next option).
20916
20917 &*Note:*& A changed return path is not logged unless you add
20918 &%return_path_on_delivery%& to the log selector.
20919
20920 .vindex "&$return_path$&"
20921 The expansion can refer to the existing value via &$return_path$&. This is
20922 either the message's envelope sender, or an address set by the
20923 &%errors_to%& option on a router. If the expansion is forced to fail, no
20924 replacement occurs; if it fails for another reason, delivery is deferred. This
20925 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20926 section &<<SECTverp>>&.
20927
20928 &*Note*&: If a delivery error is detected locally, including the case when a
20929 remote server rejects a message at SMTP time, the bounce message is not sent to
20930 the value of this option. It is sent to the previously set errors address.
20931 This defaults to the incoming sender address, but can be changed by setting
20932 &%errors_to%& in a router.
20933
20934
20935
20936 .option return_path_add transports boolean false
20937 .cindex "&'Return-path:'& header line"
20938 If this option is true, a &'Return-path:'& header is added to the message.
20939 Although the return path is normally available in the prefix line of BSD
20940 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20941 have easy access to it.
20942
20943 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20944 the delivery SMTP server makes the final delivery"&. This implies that this
20945 header should not be present in incoming messages. Exim has a configuration
20946 option, &%return_path_remove%&, which requests removal of this header from
20947 incoming messages, so that delivered messages can safely be resent to other
20948 recipients.
20949
20950
20951 .option shadow_condition transports string&!! unset
20952 See &%shadow_transport%& below.
20953
20954
20955 .option shadow_transport transports string unset
20956 .cindex "shadow transport"
20957 .cindex "transport" "shadow"
20958 A local transport may set the &%shadow_transport%& option to the name of
20959 another local transport. Shadow remote transports are not supported.
20960
20961 Whenever a delivery to the main transport succeeds, and either
20962 &%shadow_condition%& is unset, or its expansion does not result in the empty
20963 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20964 passed to the shadow transport, with the same delivery address or addresses. If
20965 expansion fails, no action is taken except that non-forced expansion failures
20966 cause a log line to be written.
20967
20968 The result of the shadow transport is discarded and does not affect the
20969 subsequent processing of the message. Only a single level of shadowing is
20970 provided; the &%shadow_transport%& option is ignored on any transport when it
20971 is running as a shadow. Options concerned with output from pipes are also
20972 ignored. The log line for the successful delivery has an item added on the end,
20973 of the form
20974 .code
20975 ST=<shadow transport name>
20976 .endd
20977 If the shadow transport did not succeed, the error message is put in
20978 parentheses afterwards. Shadow transports can be used for a number of different
20979 purposes, including keeping more detailed log information than Exim normally
20980 provides, and implementing automatic acknowledgment policies based on message
20981 headers that some sites insist on.
20982
20983
20984 .option transport_filter transports string&!! unset
20985 .cindex "transport" "filter"
20986 .cindex "filter" "transport filter"
20987 This option sets up a filtering (in the Unix shell sense) process for messages
20988 at transport time. It should not be confused with mail filtering as set up by
20989 individual users or via a system filter.
20990 If unset, or expanding to an empty string, no filtering is done.
20991
20992 When the message is about to be written out, the command specified by
20993 &%transport_filter%& is started up in a separate, parallel process, and
20994 the entire message, including the header lines, is passed to it on its standard
20995 input (this in fact is done from a third process, to avoid deadlock). The
20996 command must be specified as an absolute path.
20997
20998 The lines of the message that are written to the transport filter are
20999 terminated by newline (&"\n"&). The message is passed to the filter before any
21000 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21001 lines beginning with a dot, and also before any processing implied by the
21002 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21003 &(pipe)& transports.
21004
21005 The standard error for the filter process is set to the same destination as its
21006 standard output; this is read and written to the message's ultimate
21007 destination. The process that writes the message to the filter, the
21008 filter itself, and the original process that reads the result and delivers it
21009 are all run in parallel, like a shell pipeline.
21010
21011 The filter can perform any transformations it likes, but of course should take
21012 care not to break RFC 2822 syntax. Exim does not check the result, except to
21013 test for a final newline when SMTP is in use. All messages transmitted over
21014 SMTP must end with a newline, so Exim supplies one if it is missing.
21015
21016 .cindex "content scanning" "per user"
21017 A transport filter can be used to provide content-scanning on a per-user basis
21018 at delivery time if the only required effect of the scan is to modify the
21019 message. For example, a content scan could insert a new header line containing
21020 a spam score. This could be interpreted by a filter in the user's MUA. It is
21021 not possible to discard a message at this stage.
21022
21023 .cindex "SMTP" "SIZE"
21024 A problem might arise if the filter increases the size of a message that is
21025 being sent down an SMTP connection. If the receiving SMTP server has indicated
21026 support for the SIZE parameter, Exim will have sent the size of the message
21027 at the start of the SMTP session. If what is actually sent is substantially
21028 more, the server might reject the message. This can be worked round by setting
21029 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21030 additions to the message, or to disable the use of SIZE altogether.
21031
21032 .vindex "&$pipe_addresses$&"
21033 The value of the &%transport_filter%& option is the command string for starting
21034 the filter, which is run directly from Exim, not under a shell. The string is
21035 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21036 Exim breaks it up into arguments and then expands each argument separately (see
21037 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21038 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21039 of arguments, one for each address that applies to this delivery. (This isn't
21040 an ideal name for this feature here, but as it was already implemented for the
21041 &(pipe)& transport, it seemed sensible not to change it.)
21042
21043 .vindex "&$host$&"
21044 .vindex "&$host_address$&"
21045 The expansion variables &$host$& and &$host_address$& are available when the
21046 transport is a remote one. They contain the name and IP address of the host to
21047 which the message is being sent. For example:
21048 .code
21049 transport_filter = /some/directory/transport-filter.pl \
21050   $host $host_address $sender_address $pipe_addresses
21051 .endd
21052
21053 Two problems arise if you want to use more complicated expansion items to
21054 generate transport filter commands, both of which due to the fact that the
21055 command is split up &'before'& expansion.
21056 .ilist
21057 If an expansion item contains white space, you must quote it, so that it is all
21058 part of the same command item. If the entire option setting is one such
21059 expansion item, you have to take care what kind of quoting you use. For
21060 example:
21061 .code
21062 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21063 .endd
21064 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21065 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21066 stripped by Exim when it read the option's value. When the value is used, if
21067 the single quotes were missing, the line would be split into two items,
21068 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21069 Exim tried to expand the first one.
21070 .next
21071 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21072 expansion cannot generate multiple arguments, or a command name followed by
21073 arguments. Consider this example:
21074 .code
21075 transport_filter = ${lookup{$host}lsearch{/a/file}\
21076                     {$value}{/bin/cat}}
21077 .endd
21078 The result of the lookup is interpreted as the name of the command, even
21079 if it contains white space. The simplest way round this is to use a shell:
21080 .code
21081 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21082                                {$value}{/bin/cat}}
21083 .endd
21084 .endlist
21085
21086 The filter process is run under the same uid and gid as the normal delivery.
21087 For remote deliveries this is the Exim uid/gid by default. The command should
21088 normally yield a zero return code. Transport filters are not supposed to fail.
21089 A non-zero code is taken to mean that the transport filter encountered some
21090 serious problem. Delivery of the message is deferred; the message remains on
21091 the queue and is tried again later. It is not possible to cause a message to be
21092 bounced from a transport filter.
21093
21094 If a transport filter is set on an autoreply transport, the original message is
21095 passed through the filter as it is being copied into the newly generated
21096 message, which happens if the &%return_message%& option is set.
21097
21098
21099 .option transport_filter_timeout transports time 5m
21100 .cindex "transport" "filter, timeout"
21101 When Exim is reading the output of a transport filter, it applies a timeout
21102 that can be set by this option. Exceeding the timeout is normally treated as a
21103 temporary delivery failure. However, if a transport filter is used with a
21104 &(pipe)& transport, a timeout in the transport filter is treated in the same
21105 way as a timeout in the pipe command itself. By default, a timeout is a hard
21106 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21107 becomes a temporary error.
21108
21109
21110 .option user transports string&!! "Exim user"
21111 .cindex "uid (user id)" "local delivery"
21112 .cindex "transport" "user, specifying"
21113 This option specifies the user under whose uid the delivery process is to be
21114 run, overriding any uid that may have been set by the router. If the user is
21115 given as a name, the uid is looked up from the password data, and the
21116 associated group is taken as the value of the gid to be used if the &%group%&
21117 option is not set.
21118
21119 For deliveries that use local transports, a user and group are normally
21120 specified explicitly or implicitly (for example, as a result of
21121 &%check_local_user%&) by the router or transport.
21122
21123 .cindex "hints database" "access by remote transport"
21124 For remote transports, you should leave this option unset unless you really are
21125 sure you know what you are doing. When a remote transport is running, it needs
21126 to be able to access Exim's hints databases, because each host may have its own
21127 retry data.
21128 .ecindex IIDgenoptra1
21129 .ecindex IIDgenoptra2
21130 .ecindex IIDgenoptra3
21131
21132
21133
21134
21135
21136
21137 . ////////////////////////////////////////////////////////////////////////////
21138 . ////////////////////////////////////////////////////////////////////////////
21139
21140 .chapter "Address batching in local transports" "CHAPbatching" &&&
21141          "Address batching"
21142 .cindex "transport" "local; address batching in"
21143 The only remote transport (&(smtp)&) is normally configured to handle more than
21144 one address at a time, so that when several addresses are routed to the same
21145 remote host, just one copy of the message is sent. Local transports, however,
21146 normally handle one address at a time. That is, a separate instance of the
21147 transport is run for each address that is routed to the transport. A separate
21148 copy of the message is delivered each time.
21149
21150 .cindex "batched local delivery"
21151 .oindex "&%batch_max%&"
21152 .oindex "&%batch_id%&"
21153 In special cases, it may be desirable to handle several addresses at once in a
21154 local transport, for example:
21155
21156 .ilist
21157 In an &(appendfile)& transport, when storing messages in files for later
21158 delivery by some other means, a single copy of the message with multiple
21159 recipients saves space.
21160 .next
21161 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21162 a single copy saves time, and is the normal way LMTP is expected to work.
21163 .next
21164 In a &(pipe)& transport, when passing the message
21165 to a scanner program or
21166 to some other delivery mechanism such as UUCP, multiple recipients may be
21167 acceptable.
21168 .endlist
21169
21170 These three local transports all have the same options for controlling multiple
21171 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21172 repeating the information for each transport, these options are described here.
21173
21174 The &%batch_max%& option specifies the maximum number of addresses that can be
21175 delivered together in a single run of the transport. Its default value is one
21176 (no batching). When more than one address is routed to a transport that has a
21177 &%batch_max%& value greater than one, the addresses are delivered in a batch
21178 (that is, in a single run of the transport with multiple recipients), subject
21179 to certain conditions:
21180
21181 .ilist
21182 .vindex "&$local_part$&"
21183 If any of the transport's options contain a reference to &$local_part$&, no
21184 batching is possible.
21185 .next
21186 .vindex "&$domain$&"
21187 If any of the transport's options contain a reference to &$domain$&, only
21188 addresses with the same domain are batched.
21189 .next
21190 .cindex "customizing" "batching condition"
21191 If &%batch_id%& is set, it is expanded for each address, and only those
21192 addresses with the same expanded value are batched. This allows you to specify
21193 customized batching conditions. Failure of the expansion for any reason,
21194 including forced failure, disables batching, but it does not stop the delivery
21195 from taking place.
21196 .next
21197 Batched addresses must also have the same errors address (where to send
21198 delivery errors), the same header additions and removals, the same user and
21199 group for the transport, and if a host list is present, the first host must
21200 be the same.
21201 .endlist
21202
21203 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21204 both when the file or pipe command is specified in the transport, and when it
21205 is specified by a &(redirect)& router, but all the batched addresses must of
21206 course be routed to the same file or pipe command. These two transports have an
21207 option called &%use_bsmtp%&, which causes them to deliver the message in
21208 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21209 &%check_string%& and &%escape_string%& options are forced to the values
21210 .code
21211 check_string = "."
21212 escape_string = ".."
21213 .endd
21214 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21215 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21216 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21217
21218 .cindex "&'Envelope-to:'& header line"
21219 If the generic &%envelope_to_add%& option is set for a batching transport, the
21220 &'Envelope-to:'& header that is added to the message contains all the addresses
21221 that are being processed together. If you are using a batching &(appendfile)&
21222 transport without &%use_bsmtp%&, the only way to preserve the recipient
21223 addresses is to set the &%envelope_to_add%& option.
21224
21225 .cindex "&(pipe)& transport" "with multiple addresses"
21226 .vindex "&$pipe_addresses$&"
21227 If you are using a &(pipe)& transport without BSMTP, and setting the
21228 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21229 the command. This is not a true variable; it is a bit of magic that causes each
21230 of the recipient addresses to be inserted into the command as a separate
21231 argument. This provides a way of accessing all the addresses that are being
21232 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21233 are specified by a &(redirect)& router.
21234
21235
21236
21237
21238 . ////////////////////////////////////////////////////////////////////////////
21239 . ////////////////////////////////////////////////////////////////////////////
21240
21241 .chapter "The appendfile transport" "CHAPappendfile"
21242 .scindex IIDapptra1 "&(appendfile)& transport"
21243 .scindex IIDapptra2 "transports" "&(appendfile)&"
21244 .cindex "directory creation"
21245 .cindex "creating directories"
21246 The &(appendfile)& transport delivers a message by appending it to an existing
21247 file, or by creating an entirely new file in a specified directory. Single
21248 files to which messages are appended can be in the traditional Unix mailbox
21249 format, or optionally in the MBX format supported by the Pine MUA and
21250 University of Washington IMAP daemon, &'inter alia'&. When each message is
21251 being delivered as a separate file, &"maildir"& format can optionally be used
21252 to give added protection against failures that happen part-way through the
21253 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21254 supported. For all file formats, Exim attempts to create as many levels of
21255 directory as necessary, provided that &%create_directory%& is set.
21256
21257 The code for the optional formats is not included in the Exim binary by
21258 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21259 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21260 included.
21261
21262 .cindex "quota" "system"
21263 Exim recognizes system quota errors, and generates an appropriate message. Exim
21264 also supports its own quota control within the transport, for use when the
21265 system facility is unavailable or cannot be used for some reason.
21266
21267 If there is an error while appending to a file (for example, quota exceeded or
21268 partition filled), Exim attempts to reset the file's length and last
21269 modification time back to what they were before. If there is an error while
21270 creating an entirely new file, the new file is removed.
21271
21272 Before appending to a file, a number of security checks are made, and the
21273 file is locked. A detailed description is given below, after the list of
21274 private options.
21275
21276 The &(appendfile)& transport is most commonly used for local deliveries to
21277 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21278 putting messages into files for remote delivery by some means other than Exim.
21279 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21280 option).
21281
21282
21283
21284 .section "The file and directory options" "SECTfildiropt"
21285 The &%file%& option specifies a single file, to which the message is appended;
21286 the &%directory%& option specifies a directory, in which a new file containing
21287 the message is created. Only one of these two options can be set, and for
21288 normal deliveries to mailboxes, one of them &'must'& be set.
21289
21290 .vindex "&$address_file$&"
21291 .vindex "&$local_part$&"
21292 However, &(appendfile)& is also used for delivering messages to files or
21293 directories whose names (or parts of names) are obtained from alias,
21294 forwarding, or filtering operations (for example, a &%save%& command in a
21295 user's Exim filter). When such a transport is running, &$local_part$& contains
21296 the local part that was aliased or forwarded, and &$address_file$& contains the
21297 name (or partial name) of the file or directory generated by the redirection
21298 operation. There are two cases:
21299
21300 .ilist
21301 If neither &%file%& nor &%directory%& is set, the redirection operation
21302 must specify an absolute path (one that begins with &`/`&). This is the most
21303 common case when users with local accounts use filtering to sort mail into
21304 different folders. See for example, the &(address_file)& transport in the
21305 default configuration. If the path ends with a slash, it is assumed to be the
21306 name of a directory. A delivery to a directory can also be forced by setting
21307 &%maildir_format%& or &%mailstore_format%&.
21308 .next
21309 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21310 used to determine the file or directory name for the delivery. Normally, the
21311 contents of &$address_file$& are used in some way in the string expansion.
21312 .endlist
21313
21314
21315 .cindex "Sieve filter" "configuring &(appendfile)&"
21316 .cindex "Sieve filter" "relative mailbox path handling"
21317 As an example of the second case, consider an environment where users do not
21318 have home directories. They may be permitted to use Exim filter commands of the
21319 form:
21320 .code
21321 save folder23
21322 .endd
21323 or Sieve filter commands of the form:
21324 .code
21325 require "fileinto";
21326 fileinto "folder23";
21327 .endd
21328 In this situation, the expansion of &%file%& or &%directory%& in the transport
21329 must transform the relative path into an appropriate absolute file name. In the
21330 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21331 is used as a result of a &"keep"& action in the filter. This example shows one
21332 way of handling this requirement:
21333 .code
21334 file = ${if eq{$address_file}{inbox} \
21335             {/var/mail/$local_part} \
21336             {${if eq{${substr_0_1:$address_file}}{/} \
21337                   {$address_file} \
21338                   {$home/mail/$address_file} \
21339             }} \
21340        }
21341 .endd
21342 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21343 location, absolute paths are used without change, and other folders are in the
21344 &_mail_& directory within the home directory.
21345
21346 &*Note 1*&: While processing an Exim filter, a relative path such as
21347 &_folder23_& is turned into an absolute path if a home directory is known to
21348 the router. In particular, this is the case if &%check_local_user%& is set. If
21349 you want to prevent this happening at routing time, you can set
21350 &%router_home_directory%& empty. This forces the router to pass the relative
21351 path to the transport.
21352
21353 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21354 the &%file%& or &%directory%& option is still used if it is set.
21355
21356
21357
21358
21359 .section "Private options for appendfile" "SECID134"
21360 .cindex "options" "&(appendfile)& transport"
21361
21362
21363
21364 .option allow_fifo appendfile boolean false
21365 .cindex "fifo (named pipe)"
21366 .cindex "named pipe (fifo)"
21367 .cindex "pipe" "named (fifo)"
21368 Setting this option permits delivery to named pipes (FIFOs) as well as to
21369 regular files. If no process is reading the named pipe at delivery time, the
21370 delivery is deferred.
21371
21372
21373 .option allow_symlink appendfile boolean false
21374 .cindex "symbolic link" "to mailbox"
21375 .cindex "mailbox" "symbolic link"
21376 By default, &(appendfile)& will not deliver if the path name for the file is
21377 that of a symbolic link. Setting this option relaxes that constraint, but there
21378 are security issues involved in the use of symbolic links. Be sure you know
21379 what you are doing if you set this. Details of exactly what this option affects
21380 are included in the discussion which follows this list of options.
21381
21382
21383 .option batch_id appendfile string&!! unset
21384 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21385 However, batching is automatically disabled for &(appendfile)& deliveries that
21386 happen as a result of forwarding or aliasing or other redirection directly to a
21387 file.
21388
21389
21390 .option batch_max appendfile integer 1
21391 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21392
21393
21394 .option check_group appendfile boolean false
21395 When this option is set, the group owner of the file defined by the &%file%&
21396 option is checked to see that it is the same as the group under which the
21397 delivery process is running. The default setting is false because the default
21398 file mode is 0600, which means that the group is irrelevant.
21399
21400
21401 .option check_owner appendfile boolean true
21402 When this option is set, the owner of the file defined by the &%file%& option
21403 is checked to ensure that it is the same as the user under which the delivery
21404 process is running.
21405
21406
21407 .option check_string appendfile string "see below"
21408 .cindex "&""From""& line"
21409 As &(appendfile)& writes the message, the start of each line is tested for
21410 matching &%check_string%&, and if it does, the initial matching characters are
21411 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21412 a literal string, not a regular expression, and the case of any letters it
21413 contains is significant.
21414
21415 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21416 are forced to &"."& and &".."& respectively, and any settings in the
21417 configuration are ignored. Otherwise, they default to &"From&~"& and
21418 &">From&~"& when the &%file%& option is set, and unset when any of the
21419 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21420
21421 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21422 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21423 &"From&~"& indicates the start of a new message. All four options need changing
21424 if another format is used. For example, to deliver to mailboxes in MMDF format:
21425 .cindex "MMDF format mailbox"
21426 .cindex "mailbox" "MMDF format"
21427 .code
21428 check_string = "\1\1\1\1\n"
21429 escape_string = "\1\1\1\1 \n"
21430 message_prefix = "\1\1\1\1\n"
21431 message_suffix = "\1\1\1\1\n"
21432 .endd
21433 .option create_directory appendfile boolean true
21434 .cindex "directory creation"
21435 When this option is true, Exim attempts to create any missing superior
21436 directories for the file that it is about to write. A created directory's mode
21437 is given by the &%directory_mode%& option.
21438
21439 The group ownership of a newly created directory is highly dependent on the
21440 operating system (and possibly the file system) that is being used. For
21441 example, in Solaris, if the parent directory has the setgid bit set, its group
21442 is propagated to the child; if not, the currently set group is used. However,
21443 in FreeBSD, the parent's group is always used.
21444
21445
21446
21447 .option create_file appendfile string anywhere
21448 This option constrains the location of files and directories that are created
21449 by this transport. It applies to files defined by the &%file%& option and
21450 directories defined by the &%directory%& option. In the case of maildir
21451 delivery, it applies to the top level directory, not the maildir directories
21452 beneath.
21453
21454 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21455 &"belowhome"&. In the second and third cases, a home directory must have been
21456 set for the transport. This option is not useful when an explicit file name is
21457 given for normal mailbox deliveries. It is intended for the case when file
21458 names are generated from users' &_.forward_& files. These are usually handled
21459 by an &(appendfile)& transport called &%address_file%&. See also
21460 &%file_must_exist%&.
21461
21462
21463 .option directory appendfile string&!! unset
21464 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21465 or &%directory%& must be set, unless the delivery is the direct result of a
21466 redirection (see section &<<SECTfildiropt>>&).
21467
21468 When &%directory%& is set, the string is expanded, and the message is delivered
21469 into a new file or files in or below the given directory, instead of being
21470 appended to a single mailbox file. A number of different formats are provided
21471 (see &%maildir_format%& and &%mailstore_format%&), and see section
21472 &<<SECTopdir>>& for further details of this form of delivery.
21473
21474
21475 .option directory_file appendfile string&!! "see below"
21476 .cindex "base62"
21477 .vindex "&$inode$&"
21478 When &%directory%& is set, but neither &%maildir_format%& nor
21479 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21480 whose name is obtained by expanding this string. The default value is:
21481 .code
21482 q${base62:$tod_epoch}-$inode
21483 .endd
21484 This generates a unique name from the current time, in base 62 form, and the
21485 inode of the file. The variable &$inode$& is available only when expanding this
21486 option.
21487
21488
21489 .option directory_mode appendfile "octal integer" 0700
21490 If &(appendfile)& creates any directories as a result of the
21491 &%create_directory%& option, their mode is specified by this option.
21492
21493
21494 .option escape_string appendfile string "see description"
21495 See &%check_string%& above.
21496
21497
21498 .option file appendfile string&!! unset
21499 This option is mutually exclusive with the &%directory%& option, but one of
21500 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21501 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21502 specifies a single file, to which the message is appended. One or more of
21503 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21504 &%file%&.
21505
21506 .cindex "NFS" "lock file"
21507 .cindex "locking files"
21508 .cindex "lock files"
21509 If you are using more than one host to deliver over NFS into the same
21510 mailboxes, you should always use lock files.
21511
21512 The string value is expanded for each delivery, and must yield an absolute
21513 path. The most common settings of this option are variations on one of these
21514 examples:
21515 .code
21516 file = /var/spool/mail/$local_part
21517 file = /home/$local_part/inbox
21518 file = $home/inbox
21519 .endd
21520 .cindex "&""sticky""& bit"
21521 In the first example, all deliveries are done into the same directory. If Exim
21522 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21523 create a file in the directory, so the &"sticky"& bit must be turned on for
21524 deliveries to be possible, or alternatively the &%group%& option can be used to
21525 run the delivery under a group id which has write access to the directory.
21526
21527
21528
21529 .option file_format appendfile string unset
21530 .cindex "file" "mailbox; checking existing format"
21531 This option requests the transport to check the format of an existing file
21532 before adding to it. The check consists of matching a specific string at the
21533 start of the file. The value of the option consists of an even number of
21534 colon-separated strings. The first of each pair is the test string, and the
21535 second is the name of a transport. If the transport associated with a matched
21536 string is not the current transport, control is passed over to the other
21537 transport. For example, suppose the standard &(local_delivery)& transport has
21538 this added to it:
21539 .code
21540 file_format = "From       : local_delivery :\
21541                \1\1\1\1\n : local_mmdf_delivery"
21542 .endd
21543 Mailboxes that begin with &"From"& are still handled by this transport, but if
21544 a mailbox begins with four binary ones followed by a newline, control is passed
21545 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21546 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21547 is assumed to match the current transport. If the start of a mailbox doesn't
21548 match any string, or if the transport named for a given string is not defined,
21549 delivery is deferred.
21550
21551
21552 .option file_must_exist appendfile boolean false
21553 If this option is true, the file specified by the &%file%& option must exist.
21554 A temporary error occurs if it does not, causing delivery to be deferred.
21555 If this option is false, the file is created if it does not exist.
21556
21557
21558 .option lock_fcntl_timeout appendfile time 0s
21559 .cindex "timeout" "mailbox locking"
21560 .cindex "mailbox" "locking, blocking and non-blocking"
21561 .cindex "locking files"
21562 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21563 when locking an open mailbox file. If the call fails, the delivery process
21564 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21565 Non-blocking calls are used so that the file is not kept open during the wait
21566 for the lock; the reason for this is to make it as safe as possible for
21567 deliveries over NFS in the case when processes might be accessing an NFS
21568 mailbox without using a lock file. This should not be done, but
21569 misunderstandings and hence misconfigurations are not unknown.
21570
21571 On a busy system, however, the performance of a non-blocking lock approach is
21572 not as good as using a blocking lock with a timeout. In this case, the waiting
21573 is done inside the system call, and Exim's delivery process acquires the lock
21574 and can proceed as soon as the previous lock holder releases it.
21575
21576 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21577 timeout, are used. There may still be some retrying: the maximum number of
21578 retries is
21579 .code
21580 (lock_retries * lock_interval) / lock_fcntl_timeout
21581 .endd
21582 rounded up to the next whole number. In other words, the total time during
21583 which &(appendfile)& is trying to get a lock is roughly the same, unless
21584 &%lock_fcntl_timeout%& is set very large.
21585
21586 You should consider setting this option if you are getting a lot of delayed
21587 local deliveries because of errors of the form
21588 .code
21589 failed to lock mailbox /some/file (fcntl)
21590 .endd
21591
21592 .option lock_flock_timeout appendfile time 0s
21593 This timeout applies to file locking when using &[flock()]& (see
21594 &%use_flock%&); the timeout operates in a similar manner to
21595 &%lock_fcntl_timeout%&.
21596
21597
21598 .option lock_interval appendfile time 3s
21599 This specifies the time to wait between attempts to lock the file. See below
21600 for details of locking.
21601
21602
21603 .option lock_retries appendfile integer 10
21604 This specifies the maximum number of attempts to lock the file. A value of zero
21605 is treated as 1. See below for details of locking.
21606
21607
21608 .option lockfile_mode appendfile "octal integer" 0600
21609 This specifies the mode of the created lock file, when a lock file is being
21610 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21611
21612
21613 .option lockfile_timeout appendfile time 30m
21614 .cindex "timeout" "mailbox locking"
21615 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21616 exists and is older than this value, it is assumed to have been left behind by
21617 accident, and Exim attempts to remove it.
21618
21619
21620 .option mailbox_filecount appendfile string&!! unset
21621 .cindex "mailbox" "specifying size of"
21622 .cindex "size" "of mailbox"
21623 If this option is set, it is expanded, and the result is taken as the current
21624 number of files in the mailbox. It must be a decimal number, optionally
21625 followed by K or M. This provides a way of obtaining this information from an
21626 external source that maintains the data.
21627
21628
21629 .option mailbox_size appendfile string&!! unset
21630 .cindex "mailbox" "specifying size of"
21631 .cindex "size" "of mailbox"
21632 If this option is set, it is expanded, and the result is taken as the current
21633 size the mailbox. It must be a decimal number, optionally followed by K or M.
21634 This provides a way of obtaining this information from an external source that
21635 maintains the data. This is likely to be helpful for maildir deliveries where
21636 it is computationally expensive to compute the size of a mailbox.
21637
21638
21639
21640 .option maildir_format appendfile boolean false
21641 .cindex "maildir format" "specifying"
21642 If this option is set with the &%directory%& option, the delivery is into a new
21643 file, in the &"maildir"& format that is used by other mail software. When the
21644 transport is activated directly from a &(redirect)& router (for example, the
21645 &(address_file)& transport in the default configuration), setting
21646 &%maildir_format%& causes the path received from the router to be treated as a
21647 directory, whether or not it ends with &`/`&. This option is available only if
21648 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21649 &<<SECTmaildirdelivery>>& below for further details.
21650
21651
21652 .option maildir_quota_directory_regex appendfile string "See below"
21653 .cindex "maildir format" "quota; directories included in"
21654 .cindex "quota" "maildir; directories included in"
21655 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21656 a regular expression for specifying directories, relative to the quota
21657 directory (see &%quota_directory%&), that should be included in the quota
21658 calculation. The default value is:
21659 .code
21660 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21661 .endd
21662 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21663 (directories whose names begin with a dot). If you want to exclude the
21664 &_Trash_&
21665 folder from the count (as some sites do), you need to change this setting to
21666 .code
21667 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21668 .endd
21669 This uses a negative lookahead in the regular expression to exclude the
21670 directory whose name is &_.Trash_&. When a directory is excluded from quota
21671 calculations, quota processing is bypassed for any messages that are delivered
21672 directly into that directory.
21673
21674
21675 .option maildir_retries appendfile integer 10
21676 This option specifies the number of times to retry when writing a file in
21677 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21678
21679
21680 .option maildir_tag appendfile string&!! unset
21681 This option applies only to deliveries in maildir format, and is described in
21682 section &<<SECTmaildirdelivery>>& below.
21683
21684
21685 .option maildir_use_size_file appendfile&!! boolean false
21686 .cindex "maildir format" "&_maildirsize_& file"
21687 The result of string expansion for this option must be a valid boolean value.
21688 If it is true, it enables support for &_maildirsize_& files. Exim
21689 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21690 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21691 value is zero. See &%maildir_quota_directory_regex%& above and section
21692 &<<SECTmaildirdelivery>>& below for further details.
21693
21694 .option maildirfolder_create_regex appendfile string unset
21695 .cindex "maildir format" "&_maildirfolder_& file"
21696 .cindex "&_maildirfolder_&, creating"
21697 The value of this option is a regular expression. If it is unset, it has no
21698 effect. Otherwise, before a maildir delivery takes place, the pattern is
21699 matched against the name of the maildir directory, that is, the directory
21700 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21701 delivery. If there is a match, Exim checks for the existence of a file called
21702 &_maildirfolder_& in the directory, and creates it if it does not exist.
21703 See section &<<SECTmaildirdelivery>>& for more details.
21704
21705
21706 .option mailstore_format appendfile boolean false
21707 .cindex "mailstore format" "specifying"
21708 If this option is set with the &%directory%& option, the delivery is into two
21709 new files in  &"mailstore"& format. The option is available only if
21710 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21711 below for further details.
21712
21713
21714 .option mailstore_prefix appendfile string&!! unset
21715 This option applies only to deliveries in mailstore format, and is described in
21716 section &<<SECTopdir>>& below.
21717
21718
21719 .option mailstore_suffix appendfile string&!! unset
21720 This option applies only to deliveries in mailstore format, and is described in
21721 section &<<SECTopdir>>& below.
21722
21723
21724 .option mbx_format appendfile boolean false
21725 .cindex "locking files"
21726 .cindex "file" "locking"
21727 .cindex "file" "MBX format"
21728 .cindex "MBX format, specifying"
21729 This option is available only if Exim has been compiled with SUPPORT_MBX
21730 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21731 the message is appended to the mailbox file in MBX format instead of
21732 traditional Unix format. This format is supported by Pine4 and its associated
21733 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21734
21735 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21736 automatically changed by the use of &%mbx_format%&. They should normally be set
21737 empty when using MBX format, so this option almost always appears in this
21738 combination:
21739 .code
21740 mbx_format = true
21741 message_prefix =
21742 message_suffix =
21743 .endd
21744 If none of the locking options are mentioned in the configuration,
21745 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21746 is possible to specify the other kinds of locking with &%mbx_format%&, but
21747 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21748 interworks with &'c-client'&, providing for shared access to the mailbox. It
21749 should not be used if any program that does not use this form of locking is
21750 going to access the mailbox, nor should it be used if the mailbox file is NFS
21751 mounted, because it works only when the mailbox is accessed from a single host.
21752
21753 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21754 the standard version of &'c-client'&, because as long as it has a mailbox open
21755 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21756 append messages to it.
21757
21758
21759 .option message_prefix appendfile string&!! "see below"
21760 .cindex "&""From""& line"
21761 The string specified here is expanded and output at the start of every message.
21762 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21763 in which case it is:
21764 .code
21765 message_prefix = "From ${if def:return_path{$return_path}\
21766   {MAILER-DAEMON}} $tod_bsdinbox\n"
21767 .endd
21768 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21769 &`\n`& to &`\r\n`& in &%message_prefix%&.
21770
21771 .option message_suffix appendfile string&!! "see below"
21772 The string specified here is expanded and output at the end of every message.
21773 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21774 in which case it is a single newline character. The suffix can be suppressed by
21775 setting
21776 .code
21777 message_suffix =
21778 .endd
21779 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21780 &`\n`& to &`\r\n`& in &%message_suffix%&.
21781
21782 .option mode appendfile "octal integer" 0600
21783 If the output file is created, it is given this mode. If it already exists and
21784 has wider permissions, they are reduced to this mode. If it has narrower
21785 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21786 if the delivery is the result of a &%save%& command in a filter file specifying
21787 a particular mode, the mode of the output file is always forced to take that
21788 value, and this option is ignored.
21789
21790
21791 .option mode_fail_narrower appendfile boolean true
21792 This option applies in the case when an existing mailbox file has a narrower
21793 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21794 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21795 continues with the delivery attempt, using the existing mode of the file.
21796
21797
21798 .option notify_comsat appendfile boolean false
21799 If this option is true, the &'comsat'& daemon is notified after every
21800 successful delivery to a user mailbox. This is the daemon that notifies logged
21801 on users about incoming mail.
21802
21803
21804 .option quota appendfile string&!! unset
21805 .cindex "quota" "imposed by Exim"
21806 This option imposes a limit on the size of the file to which Exim is appending,
21807 or to the total space used in the directory tree when the &%directory%& option
21808 is set. In the latter case, computation of the space used is expensive, because
21809 all the files in the directory (and any sub-directories) have to be
21810 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21811 &%maildir_use_size_file%& for ways to avoid this in environments where users
21812 have no shell access to their mailboxes).
21813
21814 As there is no interlock against two simultaneous deliveries into a
21815 multi-file mailbox, it is possible for the quota to be overrun in this case.
21816 For single-file mailboxes, of course, an interlock is a necessity.
21817
21818 A file's size is taken as its &'used'& value. Because of blocking effects, this
21819 may be a lot less than the actual amount of disk space allocated to the file.
21820 If the sizes of a number of files are being added up, the rounding effect can
21821 become quite noticeable, especially on systems that have large block sizes.
21822 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21823 the obvious value which users understand most easily.
21824
21825 The value of the option is expanded, and must then be a numerical value
21826 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21827 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21828 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21829 be handled.
21830
21831 &*Note*&: A value of zero is interpreted as &"no quota"&.
21832
21833 The expansion happens while Exim is running as root, before it changes uid for
21834 the delivery. This means that files that are inaccessible to the end user can
21835 be used to hold quota values that are looked up in the expansion. When delivery
21836 fails because this quota is exceeded, the handling of the error is as for
21837 system quota failures.
21838
21839 By default, Exim's quota checking mimics system quotas, and restricts the
21840 mailbox to the specified maximum size, though the value is not accurate to the
21841 last byte, owing to separator lines and additional headers that may get added
21842 during message delivery. When a mailbox is nearly full, large messages may get
21843 refused even though small ones are accepted, because the size of the current
21844 message is added to the quota when the check is made. This behaviour can be
21845 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21846 for exceeding the quota does not include the current message. Thus, deliveries
21847 continue until the quota has been exceeded; thereafter, no further messages are
21848 delivered. See also &%quota_warn_threshold%&.
21849
21850
21851 .option quota_directory appendfile string&!! unset
21852 This option defines the directory to check for quota purposes when delivering
21853 into individual files. The default is the delivery directory, or, if a file
21854 called &_maildirfolder_& exists in a maildir directory, the parent of the
21855 delivery directory.
21856
21857
21858 .option quota_filecount appendfile string&!! 0
21859 This option applies when the &%directory%& option is set. It limits the total
21860 number of files in the directory (compare the inode limit in system quotas). It
21861 can only be used if &%quota%& is also set. The value is expanded; an expansion
21862 failure causes delivery to be deferred. A value of zero is interpreted as
21863 &"no quota"&.
21864
21865
21866 .option quota_is_inclusive appendfile boolean true
21867 See &%quota%& above.
21868
21869
21870 .option quota_size_regex appendfile string unset
21871 This option applies when one of the delivery modes that writes a separate file
21872 for each message is being used. When Exim wants to find the size of one of
21873 these files in order to test the quota, it first checks &%quota_size_regex%&.
21874 If this is set to a regular expression that matches the file name, and it
21875 captures one string, that string is interpreted as a representation of the
21876 file's size. The value of &%quota_size_regex%& is not expanded.
21877
21878 This feature is useful only when users have no shell access to their mailboxes
21879 &-- otherwise they could defeat the quota simply by renaming the files. This
21880 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21881 the file length to the file name. For example:
21882 .code
21883 maildir_tag = ,S=$message_size
21884 quota_size_regex = ,S=(\d+)
21885 .endd
21886 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21887 number of lines in the message.
21888
21889 The regular expression should not assume that the length is at the end of the
21890 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21891 sometimes add other information onto the ends of message file names.
21892
21893 Section &<<SECID136>>& contains further information.
21894
21895
21896 .option quota_warn_message appendfile string&!! "see below"
21897 See below for the use of this option. If it is not set when
21898 &%quota_warn_threshold%& is set, it defaults to
21899 .code
21900 quota_warn_message = "\
21901   To: $local_part@$domain\n\
21902   Subject: Your mailbox\n\n\
21903   This message is automatically created \
21904   by mail delivery software.\n\n\
21905   The size of your mailbox has exceeded \
21906   a warning threshold that is\n\
21907   set by the system administrator.\n"
21908 .endd
21909
21910
21911 .option quota_warn_threshold appendfile string&!! 0
21912 .cindex "quota" "warning threshold"
21913 .cindex "mailbox" "size warning"
21914 .cindex "size" "of mailbox"
21915 This option is expanded in the same way as &%quota%& (see above). If the
21916 resulting value is greater than zero, and delivery of the message causes the
21917 size of the file or total space in the directory tree to cross the given
21918 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21919 may be specified as a percentage of it by following the value with a percent
21920 sign. For example:
21921 .code
21922 quota = 10M
21923 quota_warn_threshold = 75%
21924 .endd
21925 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21926 percent sign is ignored.
21927
21928 The warning message itself is specified by the &%quota_warn_message%& option,
21929 and it must start with a &'To:'& header line containing the recipient(s) of the
21930 warning message. These do not necessarily have to include the recipient(s) of
21931 the original message. A &'Subject:'& line should also normally be supplied. You
21932 can include any other header lines that you want. If you do not include a
21933 &'From:'& line, the default is:
21934 .code
21935 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21936 .endd
21937 .oindex &%errors_reply_to%&
21938 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21939 option.
21940
21941 The &%quota%& option does not have to be set in order to use this option; they
21942 are independent of one another except when the threshold is specified as a
21943 percentage.
21944
21945
21946 .option use_bsmtp appendfile boolean false
21947 .cindex "envelope sender"
21948 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21949 format, with the envelope sender and recipient(s) included as SMTP commands. If
21950 you want to include a leading HELO command with such messages, you can do
21951 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21952 for details of batch SMTP.
21953
21954
21955 .option use_crlf appendfile boolean false
21956 .cindex "carriage return"
21957 .cindex "linefeed"
21958 This option causes lines to be terminated with the two-character CRLF sequence
21959 (carriage return, linefeed) instead of just a linefeed character. In the case
21960 of batched SMTP, the byte sequence written to the file is then an exact image
21961 of what would be sent down a real SMTP connection.
21962
21963 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21964 (which are used to supply the traditional &"From&~"& and blank line separators
21965 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21966 carriage return characters if these are needed. In cases where these options
21967 have non-empty defaults, the values end with a single linefeed, so they must be
21968 changed to end with &`\r\n`& if &%use_crlf%& is set.
21969
21970
21971 .option use_fcntl_lock appendfile boolean "see below"
21972 This option controls the use of the &[fcntl()]& function to lock a file for
21973 exclusive use when a message is being appended. It is set by default unless
21974 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21975 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21976 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21977
21978
21979 .option use_flock_lock appendfile boolean false
21980 This option is provided to support the use of &[flock()]& for file locking, for
21981 the few situations where it is needed. Most modern operating systems support
21982 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21983 each other. Exim uses &[fcntl()]& locking by default.
21984
21985 This option is required only if you are using an operating system where
21986 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21987 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21988 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21989
21990 .cindex "Solaris" "&[flock()]& support"
21991 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21992 have it (and some, I think, provide a not quite right version built on top of
21993 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21994 the ability to use it, and any attempt to do so will cause a configuration
21995 error.
21996
21997 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21998 is just being mapped onto &[fcntl()]& by the OS).
21999
22000
22001 .option use_lockfile appendfile boolean "see below"
22002 If this option is turned off, Exim does not attempt to create a lock file when
22003 appending to a mailbox file. In this situation, the only locking is by
22004 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22005 sure that every MUA that is ever going to look at your users' mailboxes uses
22006 &[fcntl()]& rather than a lock file, and even then only when you are not
22007 delivering over NFS from more than one host.
22008
22009 .cindex "NFS" "lock file"
22010 In order to append to an NFS file safely from more than one host, it is
22011 necessary to take out a lock &'before'& opening the file, and the lock file
22012 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22013 file corruption.
22014
22015 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22016 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22017 except when &%mbx_format%& is set.
22018
22019
22020 .option use_mbx_lock appendfile boolean "see below"
22021 This option is available only if Exim has been compiled with SUPPORT_MBX
22022 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22023 locking rules be used. It is set by default if &%mbx_format%& is set and none
22024 of the locking options are mentioned in the configuration. The locking rules
22025 are the same as are used by the &'c-client'& library that underlies Pine and
22026 the IMAP4 and POP daemons that come with it (see the discussion below). The
22027 rules allow for shared access to the mailbox. However, this kind of locking
22028 does not work when the mailbox is NFS mounted.
22029
22030 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22031 &%use_flock_lock%& to control what kind of locking is used in implementing the
22032 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22033 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22034
22035
22036
22037
22038 .section "Operational details for appending" "SECTopappend"
22039 .cindex "appending to a file"
22040 .cindex "file" "appending"
22041 Before appending to a file, the following preparations are made:
22042
22043 .ilist
22044 If the name of the file is &_/dev/null_&, no action is taken, and a success
22045 return is given.
22046
22047 .next
22048 .cindex "directory creation"
22049 If any directories on the file's path are missing, Exim creates them if the
22050 &%create_directory%& option is set. A created directory's mode is given by the
22051 &%directory_mode%& option.
22052
22053 .next
22054 If &%file_format%& is set, the format of an existing file is checked. If this
22055 indicates that a different transport should be used, control is passed to that
22056 transport.
22057
22058 .next
22059 .cindex "file" "locking"
22060 .cindex "locking files"
22061 .cindex "NFS" "lock file"
22062 If &%use_lockfile%& is set, a lock file is built in a way that will work
22063 reliably over NFS, as follows:
22064
22065 .olist
22066 Create a &"hitching post"& file whose name is that of the lock file with the
22067 current time, primary host name, and process id added, by opening for writing
22068 as a new file. If this fails with an access error, delivery is deferred.
22069 .next
22070 Close the hitching post file, and hard link it to the lock file name.
22071 .next
22072 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22073 Unlink the hitching post name.
22074 .next
22075 Otherwise, use &[stat()]& to get information about the hitching post file, and
22076 then unlink hitching post name. If the number of links is exactly two, creation
22077 of the lock file succeeded but something (for example, an NFS server crash and
22078 restart) caused this fact not to be communicated to the &[link()]& call.
22079 .next
22080 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22081 up to &%lock_retries%& times. However, since any program that writes to a
22082 mailbox should complete its task very quickly, it is reasonable to time out old
22083 lock files that are normally the result of user agent and system crashes. If an
22084 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22085 it before trying again.
22086 .endlist olist
22087
22088 .next
22089 A call is made to &[lstat()]& to discover whether the main file exists, and if
22090 so, what its characteristics are. If &[lstat()]& fails for any reason other
22091 than non-existence, delivery is deferred.
22092
22093 .next
22094 .cindex "symbolic link" "to mailbox"
22095 .cindex "mailbox" "symbolic link"
22096 If the file does exist and is a symbolic link, delivery is deferred, unless the
22097 &%allow_symlink%& option is set, in which case the ownership of the link is
22098 checked, and then &[stat()]& is called to find out about the real file, which
22099 is then subjected to the checks below. The check on the top-level link
22100 ownership prevents one user creating a link for another's mailbox in a sticky
22101 directory, though allowing symbolic links in this case is definitely not a good
22102 idea. If there is a chain of symbolic links, the intermediate ones are not
22103 checked.
22104
22105 .next
22106 If the file already exists but is not a regular file, or if the file's owner
22107 and group (if the group is being checked &-- see &%check_group%& above) are
22108 different from the user and group under which the delivery is running,
22109 delivery is deferred.
22110
22111 .next
22112 If the file's permissions are more generous than specified, they are reduced.
22113 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22114 is set false, in which case the delivery is tried using the existing
22115 permissions.
22116
22117 .next
22118 The file's inode number is saved, and the file is then opened for appending.
22119 If this fails because the file has vanished, &(appendfile)& behaves as if it
22120 hadn't existed (see below). For any other failures, delivery is deferred.
22121
22122 .next
22123 If the file is opened successfully, check that the inode number hasn't
22124 changed, that it is still a regular file, and that the owner and permissions
22125 have not changed. If anything is wrong, defer delivery and freeze the message.
22126
22127 .next
22128 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22129 option is set. Otherwise, check that the file is being created in a permitted
22130 directory if the &%create_file%& option is set (deferring on failure), and then
22131 open for writing as a new file, with the O_EXCL and O_CREAT options,
22132 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22133 set). In this case, which can happen if the link points to a non-existent file,
22134 the file is opened for writing using O_CREAT but not O_EXCL, because
22135 that prevents link following.
22136
22137 .next
22138 .cindex "loop" "while file testing"
22139 If opening fails because the file exists, obey the tests given above for
22140 existing files. However, to avoid looping in a situation where the file is
22141 being continuously created and destroyed, the exists/not-exists loop is broken
22142 after 10 repetitions, and the message is then frozen.
22143
22144 .next
22145 If opening fails with any other error, defer delivery.
22146
22147 .next
22148 .cindex "file" "locking"
22149 .cindex "locking files"
22150 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22151 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22152 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22153 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22154 file, and an exclusive lock on the file whose name is
22155 .code
22156 /tmp/.<device-number>.<inode-number>
22157 .endd
22158 using the device and inode numbers of the open mailbox file, in accordance with
22159 the MBX locking rules. This file is created with a mode that is specified by
22160 the &%lockfile_mode%& option.
22161
22162 If Exim fails to lock the file, there are two possible courses of action,
22163 depending on the value of the locking timeout. This is obtained from
22164 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22165
22166 If the timeout value is zero, the file is closed, Exim waits for
22167 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22168 to lock it again. This happens up to &%lock_retries%& times, after which the
22169 delivery is deferred.
22170
22171 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22172 &[flock()]& are used (with the given timeout), so there has already been some
22173 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22174 immediately. It retries up to
22175 .code
22176 (lock_retries * lock_interval) / <timeout>
22177 .endd
22178 times (rounded up).
22179 .endlist
22180
22181 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22182 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22183
22184
22185 .section "Operational details for delivery to a new file" "SECTopdir"
22186 .cindex "delivery" "to single file"
22187 .cindex "&""From""& line"
22188 When the &%directory%& option is set instead of &%file%&, each message is
22189 delivered into a newly-created file or set of files. When &(appendfile)& is
22190 activated directly from a &(redirect)& router, neither &%file%& nor
22191 &%directory%& is normally set, because the path for delivery is supplied by the
22192 router. (See for example, the &(address_file)& transport in the default
22193 configuration.) In this case, delivery is to a new file if either the path name
22194 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22195
22196 No locking is required while writing the message to a new file, so the various
22197 locking options of the transport are ignored. The &"From"& line that by default
22198 separates messages in a single file is not normally needed, nor is the escaping
22199 of message lines that start with &"From"&, and there is no need to ensure a
22200 newline at the end of each message. Consequently, the default values for
22201 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22202 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22203
22204 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22205 the files in the delivery directory by default. However, you can specify a
22206 different directory by setting &%quota_directory%&. Also, for maildir
22207 deliveries (see below) the &_maildirfolder_& convention is honoured.
22208
22209
22210 .cindex "maildir format"
22211 .cindex "mailstore format"
22212 There are three different ways in which delivery to individual files can be
22213 done, controlled by the settings of the &%maildir_format%& and
22214 &%mailstore_format%& options. Note that code to support maildir or mailstore
22215 formats is not included in the binary unless SUPPORT_MAILDIR or
22216 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22217
22218 .cindex "directory creation"
22219 In all three cases an attempt is made to create the directory and any necessary
22220 sub-directories if they do not exist, provided that the &%create_directory%&
22221 option is set (the default). The location of a created directory can be
22222 constrained by setting &%create_file%&. A created directory's mode is given by
22223 the &%directory_mode%& option. If creation fails, or if the
22224 &%create_directory%& option is not set when creation is required, delivery is
22225 deferred.
22226
22227
22228
22229 .section "Maildir delivery" "SECTmaildirdelivery"
22230 .cindex "maildir format" "description of"
22231 If the &%maildir_format%& option is true, Exim delivers each message by writing
22232 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22233 directory that is defined by the &%directory%& option (the &"delivery
22234 directory"&). If the delivery is successful, the file is renamed into the
22235 &_new_& subdirectory.
22236
22237 In the file name, <&'stime'&> is the current time of day in seconds, and
22238 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22239 Exim checks that the time-of-day clock has moved on by at least one microsecond
22240 before terminating the delivery process. This guarantees uniqueness for the
22241 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22242 opening it. If any response other than ENOENT (does not exist) is given,
22243 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22244
22245 Before Exim carries out a maildir delivery, it ensures that subdirectories
22246 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22247 do not exist, Exim tries to create them and any superior directories in their
22248 path, subject to the &%create_directory%& and &%create_file%& options. If the
22249 &%maildirfolder_create_regex%& option is set, and the regular expression it
22250 contains matches the delivery directory, Exim also ensures that a file called
22251 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22252 &_maildirfolder_& file cannot be created, delivery is deferred.
22253
22254 These features make it possible to use Exim to create all the necessary files
22255 and directories in a maildir mailbox, including subdirectories for maildir++
22256 folders. Consider this example:
22257 .code
22258 maildir_format = true
22259 directory = /var/mail/$local_part\
22260            ${if eq{$local_part_suffix}{}{}\
22261            {/.${substr_1:$local_part_suffix}}}
22262 maildirfolder_create_regex = /\.[^/]+$
22263 .endd
22264 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22265 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22266 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22267 not match this name, so Exim will not look for or create the file
22268 &_/var/mail/pimbo/maildirfolder_&, though it will create
22269 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22270
22271 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22272 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22273 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22274 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22275 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22276
22277 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22278 not inadvertently match the toplevel maildir directory, because a
22279 &_maildirfolder_& file at top level would completely break quota calculations.
22280
22281 .cindex "quota" "in maildir delivery"
22282 .cindex "maildir++"
22283 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22284 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22285 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22286 Exim assumes the directory is a maildir++ folder directory, which is one level
22287 down from the user's top level mailbox directory. This causes it to start at
22288 the parent directory instead of the current directory when calculating the
22289 amount of space used.
22290
22291 One problem with delivering into a multi-file mailbox is that it is
22292 computationally expensive to compute the size of the mailbox for quota
22293 checking. Various approaches have been taken to reduce the amount of work
22294 needed. The next two sections describe two of them. A third alternative is to
22295 use some external process for maintaining the size data, and use the expansion
22296 of the &%mailbox_size%& option as a way of importing it into Exim.
22297
22298
22299
22300
22301 .section "Using tags to record message sizes" "SECID135"
22302 If &%maildir_tag%& is set, the string is expanded for each delivery.
22303 When the maildir file is renamed into the &_new_& sub-directory, the
22304 tag is added to its name. However, if adding the tag takes the length of the
22305 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22306 the tag is dropped and the maildir file is created with no tag.
22307
22308
22309 .vindex "&$message_size$&"
22310 Tags can be used to encode the size of files in their names; see
22311 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22312 happens after the message has been written. The value of the &$message_size$&
22313 variable is set to the number of bytes actually written. If the expansion is
22314 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22315 be deferred. The expanded tag may contain any printing characters except &"/"&.
22316 Non-printing characters in the string are ignored; if the resulting string is
22317 empty, it is ignored. If it starts with an alphanumeric character, a leading
22318 colon is inserted; this default has not proven to be the path that popular
22319 maildir implementations have chosen (but changing it in Exim would break
22320 backwards compatibility).
22321
22322 For one common implementation, you might set:
22323 .code
22324 maildir_tag = ,S=${message_size}
22325 .endd
22326 but you should check the documentation of the other software to be sure.
22327
22328 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22329 as this allows Exim to extract the size from your tag, instead of having to
22330 &[stat()]& each message file.
22331
22332
22333 .section "Using a maildirsize file" "SECID136"
22334 .cindex "quota" "in maildir delivery"
22335 .cindex "maildir format" "&_maildirsize_& file"
22336 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22337 storing quota and message size information in a file called &_maildirsize_&
22338 within the toplevel maildir directory. If this file does not exist, Exim
22339 creates it, setting the quota from the &%quota%& option of the transport. If
22340 the maildir directory itself does not exist, it is created before any attempt
22341 to write a &_maildirsize_& file.
22342
22343 The &_maildirsize_& file is used to hold information about the sizes of
22344 messages in the maildir, thus speeding up quota calculations. The quota value
22345 in the file is just a cache; if the quota is changed in the transport, the new
22346 value overrides the cached value when the next message is delivered. The cache
22347 is maintained for the benefit of other programs that access the maildir and
22348 need to know the quota.
22349
22350 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22351 file is maintained (with a zero quota setting), but no quota is imposed.
22352
22353 A regular expression is available for controlling which directories in the
22354 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22355 See the description of the &%maildir_quota_directory_regex%& option above for
22356 details.
22357
22358
22359 .section "Mailstore delivery" "SECID137"
22360 .cindex "mailstore format" "description of"
22361 If the &%mailstore_format%& option is true, each message is written as two
22362 files in the given directory. A unique base name is constructed from the
22363 message id and the current delivery process, and the files that are written use
22364 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22365 contains the message's envelope, and the &_.msg_& file contains the message
22366 itself. The base name is placed in the variable &$mailstore_basename$&.
22367
22368 During delivery, the envelope is first written to a file with the suffix
22369 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22370 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22371 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22372 file before accessing either of them. An alternative approach is to wait for
22373 the absence of a &_.tmp_& file.
22374
22375 The envelope file starts with any text defined by the &%mailstore_prefix%&
22376 option, expanded and terminated by a newline if there isn't one. Then follows
22377 the sender address on one line, then all the recipient addresses, one per line.
22378 There can be more than one recipient only if the &%batch_max%& option is set
22379 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22380 appended to the file, followed by a newline if it does not end with one.
22381
22382 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22383 failure, it is ignored. Other expansion errors are treated as serious
22384 configuration errors, and delivery is deferred. The variable
22385 &$mailstore_basename$& is available for use during these expansions.
22386
22387
22388 .section "Non-special new file delivery" "SECID138"
22389 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22390 file is created directly in the named directory. For example, when delivering
22391 messages into files in batched SMTP format for later delivery to some host (see
22392 section &<<SECTbatchSMTP>>&), a setting such as
22393 .code
22394 directory = /var/bsmtp/$host
22395 .endd
22396 might be used. A message is written to a file with a temporary name, which is
22397 then renamed when the delivery is complete. The final name is obtained by
22398 expanding the contents of the &%directory_file%& option.
22399 .ecindex IIDapptra1
22400 .ecindex IIDapptra2
22401
22402
22403
22404
22405
22406
22407 . ////////////////////////////////////////////////////////////////////////////
22408 . ////////////////////////////////////////////////////////////////////////////
22409
22410 .chapter "The autoreply transport" "CHID8"
22411 .scindex IIDauttra1 "transports" "&(autoreply)&"
22412 .scindex IIDauttra2 "&(autoreply)& transport"
22413 The &(autoreply)& transport is not a true transport in that it does not cause
22414 the message to be transmitted. Instead, it generates a new mail message as an
22415 automatic reply to the incoming message. &'References:'& and
22416 &'Auto-Submitted:'& header lines are included. These are constructed according
22417 to the rules in RFCs 2822 and 3834, respectively.
22418
22419 If the router that passes the message to this transport does not have the
22420 &%unseen%& option set, the original message (for the current recipient) is not
22421 delivered anywhere. However, when the &%unseen%& option is set on the router
22422 that passes the message to this transport, routing of the address continues, so
22423 another router can set up a normal message delivery.
22424
22425
22426 The &(autoreply)& transport is usually run as the result of mail filtering, a
22427 &"vacation"& message being the standard example. However, it can also be run
22428 directly from a router like any other transport. To reduce the possibility of
22429 message cascades, messages created by the &(autoreply)& transport always have
22430 empty envelope sender addresses, like bounce messages.
22431
22432 The parameters of the message to be sent can be specified in the configuration
22433 by options described below. However, these are used only when the address
22434 passed to the transport does not contain its own reply information. When the
22435 transport is run as a consequence of a
22436 &%mail%&
22437 or &%vacation%& command in a filter file, the parameters of the message are
22438 supplied by the filter, and passed with the address. The transport's options
22439 that define the message are then ignored (so they are not usually set in this
22440 case). The message is specified entirely by the filter or by the transport; it
22441 is never built from a mixture of options. However, the &%file_optional%&,
22442 &%mode%&, and &%return_message%& options apply in all cases.
22443
22444 &(Autoreply)& is implemented as a local transport. When used as a result of a
22445 command in a user's filter file, &(autoreply)& normally runs under the uid and
22446 gid of the user, and with appropriate current and home directories (see chapter
22447 &<<CHAPenvironment>>&).
22448
22449 There is a subtle difference between routing a message to a &(pipe)& transport
22450 that generates some text to be returned to the sender, and routing it to an
22451 &(autoreply)& transport. This difference is noticeable only if more than one
22452 address from the same message is so handled. In the case of a pipe, the
22453 separate outputs from the different addresses are gathered up and returned to
22454 the sender in a single message, whereas if &(autoreply)& is used, a separate
22455 message is generated for each address that is passed to it.
22456
22457 Non-printing characters are not permitted in the header lines generated for the
22458 message that &(autoreply)& creates, with the exception of newlines that are
22459 immediately followed by white space. If any non-printing characters are found,
22460 the transport defers.
22461 Whether characters with the top bit set count as printing characters or not is
22462 controlled by the &%print_topbitchars%& global option.
22463
22464 If any of the generic options for manipulating headers (for example,
22465 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22466 of the original message that is included in the generated message when
22467 &%return_message%& is set. They do not apply to the generated message itself.
22468
22469 .vindex "&$sender_address$&"
22470 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22471 the message, indicating that there were no recipients, it does not treat this
22472 as an error. This means that autoreplies sent to &$sender_address$& when this
22473 is empty (because the incoming message is a bounce message) do not cause
22474 problems. They are just discarded.
22475
22476
22477
22478 .section "Private options for autoreply" "SECID139"
22479 .cindex "options" "&(autoreply)& transport"
22480
22481 .option bcc autoreply string&!! unset
22482 This specifies the addresses that are to receive &"blind carbon copies"& of the
22483 message when the message is specified by the transport.
22484
22485
22486 .option cc autoreply string&!! unset
22487 This specifies recipients of the message and the contents of the &'Cc:'& header
22488 when the message is specified by the transport.
22489
22490
22491 .option file autoreply string&!! unset
22492 The contents of the file are sent as the body of the message when the message
22493 is specified by the transport. If both &%file%& and &%text%& are set, the text
22494 string comes first.
22495
22496
22497 .option file_expand autoreply boolean false
22498 If this is set, the contents of the file named by the &%file%& option are
22499 subjected to string expansion as they are added to the message.
22500
22501
22502 .option file_optional autoreply boolean false
22503 If this option is true, no error is generated if the file named by the &%file%&
22504 option or passed with the address does not exist or cannot be read.
22505
22506
22507 .option from autoreply string&!! unset
22508 This specifies the contents of the &'From:'& header when the message is
22509 specified by the transport.
22510
22511
22512 .option headers autoreply string&!! unset
22513 This specifies additional RFC 2822 headers that are to be added to the message
22514 when the message is specified by the transport. Several can be given by using
22515 &"\n"& to separate them. There is no check on the format.
22516
22517
22518 .option log autoreply string&!! unset
22519 This option names a file in which a record of every message sent is logged when
22520 the message is specified by the transport.
22521
22522
22523 .option mode autoreply "octal integer" 0600
22524 If either the log file or the &"once"& file has to be created, this mode is
22525 used.
22526
22527
22528 .option never_mail autoreply "address list&!!" unset
22529 If any run of the transport creates a message with a recipient that matches any
22530 item in the list, that recipient is quietly discarded. If all recipients are
22531 discarded, no message is created. This applies both when the recipients are
22532 generated by a filter and when they are specified in the transport.
22533
22534
22535
22536 .option once autoreply string&!! unset
22537 This option names a file or DBM database in which a record of each &'To:'&
22538 recipient is kept when the message is specified by the transport. &*Note*&:
22539 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22540
22541 If &%once%& is unset, or is set to an empty string, the message is always sent.
22542 By default, if &%once%& is set to a non-empty file name, the message
22543 is not sent if a potential recipient is already listed in the database.
22544 However, if the &%once_repeat%& option specifies a time greater than zero, the
22545 message is sent if that much time has elapsed since a message was last sent to
22546 this recipient. A setting of zero time for &%once_repeat%& (the default)
22547 prevents a message from being sent a second time &-- in this case, zero means
22548 infinity.
22549
22550 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22551 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22552 greater than zero, it changes the way Exim implements the &%once%& option.
22553 Instead of using a DBM file to record every recipient it sends to, it uses a
22554 regular file, whose size will never get larger than the given value.
22555
22556 In the file, Exim keeps a linear list of recipient addresses and the times at
22557 which they were sent messages. If the file is full when a new address needs to
22558 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22559 means that a given recipient may receive multiple messages, but at
22560 unpredictable intervals that depend on the rate of turnover of addresses in the
22561 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22562
22563
22564 .option once_file_size autoreply integer 0
22565 See &%once%& above.
22566
22567
22568 .option once_repeat autoreply time&!! 0s
22569 See &%once%& above.
22570 After expansion, the value of this option must be a valid time value.
22571
22572
22573 .option reply_to autoreply string&!! unset
22574 This specifies the contents of the &'Reply-To:'& header when the message is
22575 specified by the transport.
22576
22577
22578 .option return_message autoreply boolean false
22579 If this is set, a copy of the original message is returned with the new
22580 message, subject to the maximum size set in the &%return_size_limit%& global
22581 configuration option.
22582
22583
22584 .option subject autoreply string&!! unset
22585 This specifies the contents of the &'Subject:'& header when the message is
22586 specified by the transport. It is tempting to quote the original subject in
22587 automatic responses. For example:
22588 .code
22589 subject = Re: $h_subject:
22590 .endd
22591 There is a danger in doing this, however. It may allow a third party to
22592 subscribe your users to an opt-in mailing list, provided that the list accepts
22593 bounce messages as subscription confirmations. Well-managed lists require a
22594 non-bounce message to confirm a subscription, so the danger is relatively
22595 small.
22596
22597
22598
22599 .option text autoreply string&!! unset
22600 This specifies a single string to be used as the body of the message when the
22601 message is specified by the transport. If both &%text%& and &%file%& are set,
22602 the text comes first.
22603
22604
22605 .option to autoreply string&!! unset
22606 This specifies recipients of the message and the contents of the &'To:'& header
22607 when the message is specified by the transport.
22608 .ecindex IIDauttra1
22609 .ecindex IIDauttra2
22610
22611
22612
22613
22614 . ////////////////////////////////////////////////////////////////////////////
22615 . ////////////////////////////////////////////////////////////////////////////
22616
22617 .chapter "The lmtp transport" "CHAPLMTP"
22618 .cindex "transports" "&(lmtp)&"
22619 .cindex "&(lmtp)& transport"
22620 .cindex "LMTP" "over a pipe"
22621 .cindex "LMTP" "over a socket"
22622 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22623 specified command
22624 or by interacting with a Unix domain socket.
22625 This transport is something of a cross between the &(pipe)& and &(smtp)&
22626 transports. Exim also has support for using LMTP over TCP/IP; this is
22627 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22628 to be of minority interest, the default build-time configure in &_src/EDITME_&
22629 has it commented out. You need to ensure that
22630 .code
22631 TRANSPORT_LMTP=yes
22632 .endd
22633 .cindex "options" "&(lmtp)& transport"
22634 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22635 included in the Exim binary. The private options of the &(lmtp)& transport are
22636 as follows:
22637
22638 .option batch_id lmtp string&!! unset
22639 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22640
22641
22642 .option batch_max lmtp integer 1
22643 This limits the number of addresses that can be handled in a single delivery.
22644 Most LMTP servers can handle several addresses at once, so it is normally a
22645 good idea to increase this value. See the description of local delivery
22646 batching in chapter &<<CHAPbatching>>&.
22647
22648
22649 .option command lmtp string&!! unset
22650 This option must be set if &%socket%& is not set. The string is a command which
22651 is run in a separate process. It is split up into a command name and list of
22652 arguments, each of which is separately expanded (so expansion cannot change the
22653 number of arguments). The command is run directly, not via a shell. The message
22654 is passed to the new process using the standard input and output to operate the
22655 LMTP protocol.
22656
22657 .option ignore_quota lmtp boolean false
22658 .cindex "LMTP" "ignoring quota errors"
22659 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22660 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22661 in its response to the LHLO command.
22662
22663 .option socket lmtp string&!! unset
22664 This option must be set if &%command%& is not set. The result of expansion must
22665 be the name of a Unix domain socket. The transport connects to the socket and
22666 delivers the message to it using the LMTP protocol.
22667
22668
22669 .option timeout lmtp time 5m
22670 The transport is aborted if the created process or Unix domain socket does not
22671 respond to LMTP commands or message input within this timeout. Delivery
22672 is deferred, and will be tried again later. Here is an example of a typical
22673 LMTP transport:
22674 .code
22675 lmtp:
22676   driver = lmtp
22677   command = /some/local/lmtp/delivery/program
22678   batch_max = 20
22679   user = exim
22680 .endd
22681 This delivers up to 20 addresses at a time, in a mixture of domains if
22682 necessary, running as the user &'exim'&.
22683
22684
22685
22686 . ////////////////////////////////////////////////////////////////////////////
22687 . ////////////////////////////////////////////////////////////////////////////
22688
22689 .chapter "The pipe transport" "CHAPpipetransport"
22690 .scindex IIDpiptra1 "transports" "&(pipe)&"
22691 .scindex IIDpiptra2 "&(pipe)& transport"
22692 The &(pipe)& transport is used to deliver messages via a pipe to a command
22693 running in another process. One example is the use of &(pipe)& as a
22694 pseudo-remote transport for passing messages to some other delivery mechanism
22695 (such as UUCP). Another is the use by individual users to automatically process
22696 their incoming messages. The &(pipe)& transport can be used in one of the
22697 following ways:
22698
22699 .ilist
22700 .vindex "&$local_part$&"
22701 A router routes one address to a transport in the normal way, and the
22702 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22703 contains the local part of the address (as usual), and the command that is run
22704 is specified by the &%command%& option on the transport.
22705 .next
22706 .vindex "&$pipe_addresses$&"
22707 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22708 transport can handle more than one address in a single run. In this case, when
22709 more than one address is routed to the transport, &$local_part$& is not set
22710 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22711 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22712 that are routed to the transport.
22713 .next
22714 .vindex "&$address_pipe$&"
22715 A router redirects an address directly to a pipe command (for example, from an
22716 alias or forward file). In this case, &$address_pipe$& contains the text of the
22717 pipe command, and the &%command%& option on the transport is ignored unless
22718 &%force_command%& is set. If only one address is being transported
22719 (&%batch_max%& is not greater than one, or only one address was redirected to
22720 this pipe command), &$local_part$& contains the local part that was redirected.
22721 .endlist
22722
22723
22724 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22725 deliver messages over pipes using the LMTP interactive protocol. This is
22726 implemented by the &(lmtp)& transport.
22727
22728 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22729 &_.forward_& file, the command runs under the uid and gid of that user. In
22730 other cases, the uid and gid have to be specified explicitly, either on the
22731 transport or on the router that handles the address. Current and &"home"&
22732 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22733 details of the local delivery environment and chapter &<<CHAPbatching>>&
22734 for a discussion of local delivery batching.
22735
22736
22737 .section "Concurrent delivery" "SECID140"
22738 If two messages arrive at almost the same time, and both are routed to a pipe
22739 delivery, the two pipe transports may be run concurrently. You must ensure that
22740 any pipe commands you set up are robust against this happening. If the commands
22741 write to a file, the &%exim_lock%& utility might be of use.
22742 Alternatively the &%max_parallel%& option could be used with a value
22743 of "1" to enforce serialization.
22744
22745
22746
22747
22748 .section "Returned status and data" "SECID141"
22749 .cindex "&(pipe)& transport" "returned data"
22750 If the command exits with a non-zero return code, the delivery is deemed to
22751 have failed, unless either the &%ignore_status%& option is set (in which case
22752 the return code is treated as zero), or the return code is one of those listed
22753 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22754 later"&. In this case, delivery is deferred. Details of a permanent failure are
22755 logged, but are not included in the bounce message, which merely contains
22756 &"local delivery failed"&.
22757
22758 If the command exits on a signal and the &%freeze_signal%& option is set then
22759 the message will be frozen in the queue. If that option is not set, a bounce
22760 will be sent as normal.
22761
22762 If the return code is greater than 128 and the command being run is a shell
22763 script, it normally means that the script was terminated by a signal whose
22764 value is the return code minus 128. The &%freeze_signal%& option does not
22765 apply in this case.
22766
22767 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22768 return code is set to 127. This is the value that a shell returns if it is
22769 asked to run a non-existent command. The wording for the log line suggests that
22770 a non-existent command may be the problem.
22771
22772 The &%return_output%& option can affect the result of a pipe delivery. If it is
22773 set and the command produces any output on its standard output or standard
22774 error streams, the command is considered to have failed, even if it gave a zero
22775 return code or if &%ignore_status%& is set. The output from the command is
22776 included as part of the bounce message. The &%return_fail_output%& option is
22777 similar, except that output is returned only when the command exits with a
22778 failure return code, that is, a value other than zero or a code that matches
22779 &%temp_errors%&.
22780
22781
22782
22783 .section "How the command is run" "SECThowcommandrun"
22784 .cindex "&(pipe)& transport" "path for command"
22785 The command line is (by default) broken down into a command name and arguments
22786 by the &(pipe)& transport itself. The &%allow_commands%& and
22787 &%restrict_to_path%& options can be used to restrict the commands that may be
22788 run.
22789
22790 .cindex "quoting" "in pipe command"
22791 Unquoted arguments are delimited by white space. If an argument appears in
22792 double quotes, backslash is interpreted as an escape character in the usual
22793 way. If an argument appears in single quotes, no escaping is done.
22794
22795 String expansion is applied to the command line except when it comes from a
22796 traditional &_.forward_& file (commands from a filter file are expanded). The
22797 expansion is applied to each argument in turn rather than to the whole line.
22798 For this reason, any string expansion item that contains white space must be
22799 quoted so as to be contained within a single argument. A setting such as
22800 .code
22801 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22802 .endd
22803 will not work, because the expansion item gets split between several
22804 arguments. You have to write
22805 .code
22806 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22807 .endd
22808 to ensure that it is all in one argument. The expansion is done in this way,
22809 argument by argument, so that the number of arguments cannot be changed as a
22810 result of expansion, and quotes or backslashes in inserted variables do not
22811 interact with external quoting. However, this leads to problems if you want to
22812 generate multiple arguments (or the command name plus arguments) from a single
22813 expansion. In this situation, the simplest solution is to use a shell. For
22814 example:
22815 .code
22816 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22817 .endd
22818
22819 .cindex "transport" "filter"
22820 .cindex "filter" "transport filter"
22821 .vindex "&$pipe_addresses$&"
22822 Special handling takes place when an argument consists of precisely the text
22823 &`$pipe_addresses`&. This is not a general expansion variable; the only
22824 place this string is recognized is when it appears as an argument for a pipe or
22825 transport filter command. It causes each address that is being handled to be
22826 inserted in the argument list at that point &'as a separate argument'&. This
22827 avoids any problems with spaces or shell metacharacters, and is of use when a
22828 &(pipe)& transport is handling groups of addresses in a batch.
22829
22830 If &%force_command%& is enabled on the transport, Special handling takes place
22831 for an argument that consists of precisely the text &`$address_pipe`&.  It
22832 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22833 argument is inserted in the argument list at that point
22834 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22835 the only item in the argument; in fact, if it were then &%force_command%&
22836 should behave as a no-op.  Rather, it should be used to adjust the command
22837 run while preserving the argument vector separation.
22838
22839 After splitting up into arguments and expansion, the resulting command is run
22840 in a subprocess directly from the transport, &'not'& under a shell. The
22841 message that is being delivered is supplied on the standard input, and the
22842 standard output and standard error are both connected to a single pipe that is
22843 read by Exim. The &%max_output%& option controls how much output the command
22844 may produce, and the &%return_output%& and &%return_fail_output%& options
22845 control what is done with it.
22846
22847 Not running the command under a shell (by default) lessens the security risks
22848 in cases when a command from a user's filter file is built out of data that was
22849 taken from an incoming message. If a shell is required, it can of course be
22850 explicitly specified as the command to be run. However, there are circumstances
22851 where existing commands (for example, in &_.forward_& files) expect to be run
22852 under a shell and cannot easily be modified. To allow for these cases, there is
22853 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22854 works. Instead of breaking up the command line as just described, it expands it
22855 as a single string and passes the result to &_/bin/sh_&. The
22856 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22857 with &%use_shell%&, and the whole mechanism is inherently less secure.
22858
22859
22860
22861 .section "Environment variables" "SECTpipeenv"
22862 .cindex "&(pipe)& transport" "environment for command"
22863 .cindex "environment" "&(pipe)& transport"
22864 The environment variables listed below are set up when the command is invoked.
22865 This list is a compromise for maximum compatibility with other MTAs. Note that
22866 the &%environment%& option can be used to add additional variables to this
22867 environment. The environment for the &(pipe)& transport is not subject
22868 to the &%add_environment%& and &%keep_environment%& main config options.
22869 .display
22870 &`DOMAIN            `&   the domain of the address
22871 &`HOME              `&   the home directory, if set
22872 &`HOST              `&   the host name when called from a router (see below)
22873 &`LOCAL_PART        `&   see below
22874 &`LOCAL_PART_PREFIX `&   see below
22875 &`LOCAL_PART_SUFFIX `&   see below
22876 &`LOGNAME           `&   see below
22877 &`MESSAGE_ID        `&   Exim's local ID for the message
22878 &`PATH              `&   as specified by the &%path%& option below
22879 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22880 &`RECIPIENT         `&   the complete recipient address
22881 &`SENDER            `&   the sender of the message (empty if a bounce)
22882 &`SHELL             `&   &`/bin/sh`&
22883 &`TZ                `&   the value of the &%timezone%& option, if set
22884 &`USER              `&   see below
22885 .endd
22886 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22887 router, LOCAL_PART is set to the local part of the address. When it is
22888 called as a result of a forward or alias expansion, LOCAL_PART is set to
22889 the local part of the address that was expanded. In both cases, any affixes are
22890 removed from the local part, and made available in LOCAL_PART_PREFIX and
22891 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22892 same value as LOCAL_PART for compatibility with other MTAs.
22893
22894 .cindex "HOST"
22895 HOST is set only when a &(pipe)& transport is called from a router that
22896 associates hosts with an address, typically when using &(pipe)& as a
22897 pseudo-remote transport. HOST is set to the first host name specified by
22898 the router.
22899
22900 .cindex "HOME"
22901 If the transport's generic &%home_directory%& option is set, its value is used
22902 for the HOME environment variable. Otherwise, a home directory may be set
22903 by the router's &%transport_home_directory%& option, which defaults to the
22904 user's home directory if &%check_local_user%& is set.
22905
22906
22907 .section "Private options for pipe" "SECID142"
22908 .cindex "options" "&(pipe)& transport"
22909
22910
22911
22912 .option allow_commands pipe "string list&!!" unset
22913 .cindex "&(pipe)& transport" "permitted commands"
22914 The string is expanded, and is then interpreted as a colon-separated list of
22915 permitted commands. If &%restrict_to_path%& is not set, the only commands
22916 permitted are those in the &%allow_commands%& list. They need not be absolute
22917 paths; the &%path%& option is still used for relative paths. If
22918 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22919 in the &%allow_commands%& list, or a name without any slashes that is found on
22920 the path. In other words, if neither &%allow_commands%& nor
22921 &%restrict_to_path%& is set, there is no restriction on the command, but
22922 otherwise only commands that are permitted by one or the other are allowed. For
22923 example, if
22924 .code
22925 allow_commands = /usr/bin/vacation
22926 .endd
22927 and &%restrict_to_path%& is not set, the only permitted command is
22928 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22929 &%use_shell%& is set.
22930
22931
22932 .option batch_id pipe string&!! unset
22933 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22934
22935
22936 .option batch_max pipe integer 1
22937 This limits the number of addresses that can be handled in a single delivery.
22938 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22939
22940
22941 .option check_string pipe string unset
22942 As &(pipe)& writes the message, the start of each line is tested for matching
22943 &%check_string%&, and if it does, the initial matching characters are replaced
22944 by the contents of &%escape_string%&, provided both are set. The value of
22945 &%check_string%& is a literal string, not a regular expression, and the case of
22946 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22947 of &%check_string%& and &%escape_string%& are forced to values that implement
22948 the SMTP escaping protocol. Any settings made in the configuration file are
22949 ignored.
22950
22951
22952 .option command pipe string&!! unset
22953 This option need not be set when &(pipe)& is being used to deliver to pipes
22954 obtained directly from address redirections. In other cases, the option must be
22955 set, to provide a command to be run. It need not yield an absolute path (see
22956 the &%path%& option below). The command is split up into separate arguments by
22957 Exim, and each argument is separately expanded, as described in section
22958 &<<SECThowcommandrun>>& above.
22959
22960
22961 .option environment pipe string&!! unset
22962 .cindex "&(pipe)& transport" "environment for command"
22963 .cindex "environment" "&(pipe)& transport"
22964 This option is used to add additional variables to the environment in which the
22965 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22966 a string which is expanded, and then interpreted as a colon-separated list of
22967 environment settings of the form <&'name'&>=<&'value'&>.
22968
22969
22970 .option escape_string pipe string unset
22971 See &%check_string%& above.
22972
22973
22974 .option freeze_exec_fail pipe boolean false
22975 .cindex "exec failure"
22976 .cindex "failure of exec"
22977 .cindex "&(pipe)& transport" "failure of exec"
22978 Failure to exec the command in a pipe transport is by default treated like
22979 any other failure while running the command. However, if &%freeze_exec_fail%&
22980 is set, failure to exec is treated specially, and causes the message to be
22981 frozen, whatever the setting of &%ignore_status%&.
22982
22983
22984 .option freeze_signal pipe boolean false
22985 .cindex "signal exit"
22986 .cindex "&(pipe)& transport", "signal exit"
22987 Normally if the process run by a command in a pipe transport exits on a signal,
22988 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22989 frozen in Exim's queue instead.
22990
22991
22992 .option force_command pipe boolean false
22993 .cindex "force command"
22994 .cindex "&(pipe)& transport", "force command"
22995 Normally when a router redirects an address directly to a pipe command
22996 the &%command%& option on the transport is ignored.  If &%force_command%&
22997 is set, the &%command%& option will used. This is especially
22998 useful for forcing a wrapper or additional argument to be added to the
22999 command. For example:
23000 .code
23001 command = /usr/bin/remote_exec myhost -- $address_pipe
23002 force_command
23003 .endd
23004
23005 Note that &$address_pipe$& is handled specially in &%command%& when
23006 &%force_command%& is set, expanding out to the original argument vector as
23007 separate items, similarly to a Unix shell &`"$@"`& construct.
23008
23009
23010 .option ignore_status pipe boolean false
23011 If this option is true, the status returned by the subprocess that is set up to
23012 run the command is ignored, and Exim behaves as if zero had been returned.
23013 Otherwise, a non-zero status or termination by signal causes an error return
23014 from the transport unless the status value is one of those listed in
23015 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23016
23017 &*Note*&: This option does not apply to timeouts, which do not return a status.
23018 See the &%timeout_defer%& option for how timeouts are handled.
23019
23020
23021 .option log_defer_output pipe boolean false
23022 .cindex "&(pipe)& transport" "logging output"
23023 If this option is set, and the status returned by the command is
23024 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23025 and any output was produced on stdout or stderr, the first line of it is
23026 written to the main log.
23027
23028
23029 .option log_fail_output pipe boolean false
23030 If this option is set, and the command returns any output on stdout or
23031 stderr, and also ends with a return code that is neither zero nor one of
23032 the return codes listed in &%temp_errors%& (that is, the delivery
23033 failed), the first line of output is written to the main log. This
23034 option and &%log_output%& are mutually exclusive.  Only one of them may
23035 be set.
23036
23037
23038 .option log_output pipe boolean false
23039 If this option is set and the command returns any output on stdout or
23040 stderr, the first line of output is written to the main log, whatever
23041 the return code. This option and &%log_fail_output%& are mutually
23042 exclusive. Only one of them may be set.
23043
23044
23045 .option max_output pipe integer 20K
23046 This specifies the maximum amount of output that the command may produce on its
23047 standard output and standard error file combined. If the limit is exceeded, the
23048 process running the command is killed. This is intended as a safety measure to
23049 catch runaway processes. The limit is applied independently of the settings of
23050 the options that control what is done with such output (for example,
23051 &%return_output%&). Because of buffering effects, the amount of output may
23052 exceed the limit by a small amount before Exim notices.
23053
23054
23055 .option message_prefix pipe string&!! "see below"
23056 The string specified here is expanded and output at the start of every message.
23057 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23058 .code
23059 message_prefix = \
23060   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23061   ${tod_bsdinbox}\n
23062 .endd
23063 .cindex "Cyrus"
23064 .cindex "&%tmail%&"
23065 .cindex "&""From""& line"
23066 This is required by the commonly used &_/usr/bin/vacation_& program.
23067 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23068 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23069 setting
23070 .code
23071 message_prefix =
23072 .endd
23073 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23074 &`\n`& to &`\r\n`& in &%message_prefix%&.
23075
23076
23077 .option message_suffix pipe string&!! "see below"
23078 The string specified here is expanded and output at the end of every message.
23079 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23080 The suffix can be suppressed by setting
23081 .code
23082 message_suffix =
23083 .endd
23084 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23085 &`\n`& to &`\r\n`& in &%message_suffix%&.
23086
23087
23088 .option path pipe string "see below"
23089 This option specifies the string that is set up in the PATH environment
23090 variable of the subprocess. The default is:
23091 .code
23092 /bin:/usr/bin
23093 .endd
23094 If the &%command%& option does not yield an absolute path name, the command is
23095 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23096 apply to a command specified as a transport filter.
23097
23098
23099 .option permit_coredump pipe boolean false
23100 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23101 a core-dump of a pipe command, enable this command.  This enables core-dumps
23102 during delivery and affects both the Exim binary and the pipe command run.
23103 It is recommended that this option remain off unless and until you have a need
23104 for it and that this only be enabled when needed, as the risk of excessive
23105 resource consumption can be quite high.  Note also that Exim is typically
23106 installed as a setuid binary and most operating systems will inhibit coredumps
23107 of these by default, so further OS-specific action may be required.
23108
23109
23110 .option pipe_as_creator pipe boolean false
23111 .cindex "uid (user id)" "local delivery"
23112 If the generic &%user%& option is not set and this option is true, the delivery
23113 process is run under the uid that was in force when Exim was originally called
23114 to accept the message. If the group id is not otherwise set (via the generic
23115 &%group%& option), the gid that was in force when Exim was originally called to
23116 accept the message is used.
23117
23118
23119 .option restrict_to_path pipe boolean false
23120 When this option is set, any command name not listed in &%allow_commands%& must
23121 contain no slashes. The command is searched for only in the directories listed
23122 in the &%path%& option. This option is intended for use in the case when a pipe
23123 command has been generated from a user's &_.forward_& file. This is usually
23124 handled by a &(pipe)& transport called &%address_pipe%&.
23125
23126
23127 .option return_fail_output pipe boolean false
23128 If this option is true, and the command produced any output and ended with a
23129 return code other than zero or one of the codes listed in &%temp_errors%& (that
23130 is, the delivery failed), the output is returned in the bounce message.
23131 However, if the message has a null sender (that is, it is itself a bounce
23132 message), output from the command is discarded. This option and
23133 &%return_output%& are mutually exclusive. Only one of them may be set.
23134
23135
23136
23137 .option return_output pipe boolean false
23138 If this option is true, and the command produced any output, the delivery is
23139 deemed to have failed whatever the return code from the command, and the output
23140 is returned in the bounce message. Otherwise, the output is just discarded.
23141 However, if the message has a null sender (that is, it is a bounce message),
23142 output from the command is always discarded, whatever the setting of this
23143 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23144 of them may be set.
23145
23146
23147
23148 .option temp_errors pipe "string list" "see below"
23149 .cindex "&(pipe)& transport" "temporary failure"
23150 This option contains either a colon-separated list of numbers, or a single
23151 asterisk. If &%ignore_status%& is false
23152 and &%return_output%& is not set,
23153 and the command exits with a non-zero return code, the failure is treated as
23154 temporary and the delivery is deferred if the return code matches one of the
23155 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23156 codes are treated as permanent errors. The default setting contains the codes
23157 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23158 compiled on a system that does not define these macros, it assumes values of 75
23159 and 73, respectively.
23160
23161
23162 .option timeout pipe time 1h
23163 If the command fails to complete within this time, it is killed. This normally
23164 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23165 specifies no timeout. In order to ensure that any subprocesses created by the
23166 command are also killed, Exim makes the initial process a process group leader,
23167 and kills the whole process group on a timeout. However, this can be defeated
23168 if one of the processes starts a new process group.
23169
23170 .option timeout_defer pipe boolean false
23171 A timeout in a &(pipe)& transport, either in the command that the transport
23172 runs, or in a transport filter that is associated with it, is by default
23173 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23174 is set true, both kinds of timeout become temporary errors, causing the
23175 delivery to be deferred.
23176
23177 .option umask pipe "octal integer" 022
23178 This specifies the umask setting for the subprocess that runs the command.
23179
23180
23181 .option use_bsmtp pipe boolean false
23182 .cindex "envelope sender"
23183 If this option is set true, the &(pipe)& transport writes messages in &"batch
23184 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23185 commands. If you want to include a leading HELO command with such messages,
23186 you can do so by setting the &%message_prefix%& option. See section
23187 &<<SECTbatchSMTP>>& for details of batch SMTP.
23188
23189 .option use_classresources pipe boolean false
23190 .cindex "class resources (BSD)"
23191 This option is available only when Exim is running on FreeBSD, NetBSD, or
23192 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23193 resource limits when a &(pipe)& transport is run to perform a delivery. The
23194 limits for the uid under which the pipe is to run are obtained from the login
23195 class database.
23196
23197
23198 .option use_crlf pipe boolean false
23199 .cindex "carriage return"
23200 .cindex "linefeed"
23201 This option causes lines to be terminated with the two-character CRLF sequence
23202 (carriage return, linefeed) instead of just a linefeed character. In the case
23203 of batched SMTP, the byte sequence written to the pipe is then an exact image
23204 of what would be sent down a real SMTP connection.
23205
23206 The contents of the &%message_prefix%& and &%message_suffix%& options are
23207 written verbatim, so must contain their own carriage return characters if these
23208 are needed. When &%use_bsmtp%& is not set, the default values for both
23209 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23210 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23211
23212
23213 .option use_shell pipe boolean false
23214 .vindex "&$pipe_addresses$&"
23215 If this option is set, it causes the command to be passed to &_/bin/sh_&
23216 instead of being run directly from the transport, as described in section
23217 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23218 where the command is expected to be run under a shell and cannot easily be
23219 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23220 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23221 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23222 its &%-c%& option.
23223
23224
23225
23226 .section "Using an external local delivery agent" "SECID143"
23227 .cindex "local delivery" "using an external agent"
23228 .cindex "&'procmail'&"
23229 .cindex "external local delivery"
23230 .cindex "delivery" "&'procmail'&"
23231 .cindex "delivery" "by external agent"
23232 The &(pipe)& transport can be used to pass all messages that require local
23233 delivery to a separate local delivery agent such as &%procmail%&. When doing
23234 this, care must be taken to ensure that the pipe is run under an appropriate
23235 uid and gid. In some configurations one wants this to be a uid that is trusted
23236 by the delivery agent to supply the correct sender of the message. It may be
23237 necessary to recompile or reconfigure the delivery agent so that it trusts an
23238 appropriate user. The following is an example transport and router
23239 configuration for &%procmail%&:
23240 .code
23241 # transport
23242 procmail_pipe:
23243   driver = pipe
23244   command = /usr/local/bin/procmail -d $local_part
23245   return_path_add
23246   delivery_date_add
23247   envelope_to_add
23248   check_string = "From "
23249   escape_string = ">From "
23250   umask = 077
23251   user = $local_part
23252   group = mail
23253
23254 # router
23255 procmail:
23256   driver = accept
23257   check_local_user
23258   transport = procmail_pipe
23259 .endd
23260 In this example, the pipe is run as the local user, but with the group set to
23261 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23262 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23263 user to supply a correct sender address. If you do not specify either a
23264 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23265 home directory is the user's home directory by default.
23266
23267 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23268 .code
23269 IFS=" "
23270 .endd
23271 as shown in some &%procmail%& documentation, because Exim does not by default
23272 use a shell to run pipe commands.
23273
23274 .cindex "Cyrus"
23275 The next example shows a transport and a router for a system where local
23276 deliveries are handled by the Cyrus IMAP server.
23277 .code
23278 # transport
23279 local_delivery_cyrus:
23280   driver = pipe
23281   command = /usr/cyrus/bin/deliver \
23282             -m ${substr_1:$local_part_suffix} -- $local_part
23283   user = cyrus
23284   group = mail
23285   return_output
23286   log_output
23287   message_prefix =
23288   message_suffix =
23289
23290 # router
23291 local_user_cyrus:
23292   driver = accept
23293   check_local_user
23294   local_part_suffix = .*
23295   transport = local_delivery_cyrus
23296 .endd
23297 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23298 &%return_output%& to cause any text written by Cyrus to be returned to the
23299 sender.
23300 .ecindex IIDpiptra1
23301 .ecindex IIDpiptra2
23302
23303
23304 . ////////////////////////////////////////////////////////////////////////////
23305 . ////////////////////////////////////////////////////////////////////////////
23306
23307 .chapter "The smtp transport" "CHAPsmtptrans"
23308 .scindex IIDsmttra1 "transports" "&(smtp)&"
23309 .scindex IIDsmttra2 "&(smtp)& transport"
23310 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23311 or LMTP protocol. The list of hosts to try can either be taken from the address
23312 that is being processed (having been set up by the router), or specified
23313 explicitly for the transport. Timeout and retry processing (see chapter
23314 &<<CHAPretry>>&) is applied to each IP address independently.
23315
23316
23317 .section "Multiple messages on a single connection" "SECID144"
23318 The sending of multiple messages over a single TCP/IP connection can arise in
23319 two ways:
23320
23321 .ilist
23322 If a message contains more than &%max_rcpt%& (see below) addresses that are
23323 routed to the same host, more than one copy of the message has to be sent to
23324 that host. In this situation, multiple copies may be sent in a single run of
23325 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23326 does when it has too many addresses to send in one message also depends on the
23327 value of the global &%remote_max_parallel%& option. Details are given in
23328 section &<<SECToutSMTPTCP>>&.)
23329 .next
23330 .cindex "hints database" "remembering routing"
23331 When a message has been successfully delivered over a TCP/IP connection, Exim
23332 looks in its hints database to see if there are any other messages awaiting a
23333 connection to the same host. If there are, a new delivery process is started
23334 for one of them, and the current TCP/IP connection is passed on to it. The new
23335 process may in turn send multiple copies and possibly create yet another
23336 process.
23337 .endlist
23338
23339
23340 For each copy sent over the same TCP/IP connection, a sequence counter is
23341 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23342 no further messages are sent over that connection.
23343
23344
23345
23346 .section "Use of the $host and $host_address variables" "SECID145"
23347 .vindex "&$host$&"
23348 .vindex "&$host_address$&"
23349 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23350 &$host_address$& are the name and IP address of the first host on the host list
23351 passed by the router. However, when the transport is about to connect to a
23352 specific host, and while it is connected to that host, &$host$& and
23353 &$host_address$& are set to the values for that host. These are the values
23354 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23355 &%serialize_hosts%&, and the various TLS options are expanded.
23356
23357
23358 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23359 .vindex &$tls_bits$&
23360 .vindex &$tls_cipher$&
23361 .vindex &$tls_peerdn$&
23362 .vindex &$tls_sni$&
23363 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23364 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23365 are the values that were set when the message was received.
23366 These are the values that are used for options that are expanded before any
23367 SMTP connections are made. Just before each connection is made, these four
23368 variables are emptied. If TLS is subsequently started, they are set to the
23369 appropriate values for the outgoing connection, and these are the values that
23370 are in force when any authenticators are run and when the
23371 &%authenticated_sender%& option is expanded.
23372
23373 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23374 and will be removed in a future release.
23375
23376
23377 .section "Private options for smtp" "SECID146"
23378 .cindex "options" "&(smtp)& transport"
23379 The private options of the &(smtp)& transport are as follows:
23380
23381
23382 .option address_retry_include_sender smtp boolean true
23383 .cindex "4&'xx'& responses" "retrying after"
23384 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23385 is the combination of sender and recipient that is delayed in subsequent queue
23386 runs until the retry time is reached. You can delay the recipient without
23387 reference to the sender (which is what earlier versions of Exim did), by
23388 setting &%address_retry_include_sender%& false. However, this can lead to
23389 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23390
23391 .option allow_localhost smtp boolean false
23392 .cindex "local host" "sending to"
23393 .cindex "fallback" "hosts specified on transport"
23394 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23395 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23396 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23397 the delivery anyway. This should be used only in special cases when the
23398 configuration ensures that no looping will result (for example, a differently
23399 configured Exim is listening on the port to which the message is sent).
23400
23401
23402 .option authenticated_sender smtp string&!! unset
23403 .cindex "Cyrus"
23404 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23405 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23406 overriding any existing authenticated sender value. If the string expansion is
23407 forced to fail, the option is ignored. Other expansion failures cause delivery
23408 to be deferred. If the result of expansion is an empty string, that is also
23409 ignored.
23410
23411 The expansion happens after the outgoing connection has been made and TLS
23412 started, if required. This means that the &$host$&, &$host_address$&,
23413 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23414 particular connection.
23415
23416 If the SMTP session is not authenticated, the expansion of
23417 &%authenticated_sender%& still happens (and can cause the delivery to be
23418 deferred if it fails), but no AUTH= item is added to MAIL commands
23419 unless &%authenticated_sender_force%& is true.
23420
23421 This option allows you to use the &(smtp)& transport in LMTP mode to
23422 deliver mail to Cyrus IMAP and provide the proper local part as the
23423 &"authenticated sender"&, via a setting such as:
23424 .code
23425 authenticated_sender = $local_part
23426 .endd
23427 This removes the need for IMAP subfolders to be assigned special ACLs to
23428 allow direct delivery to those subfolders.
23429
23430 Because of expected uses such as that just described for Cyrus (when no
23431 domain is involved), there is no checking on the syntax of the provided
23432 value.
23433
23434
23435 .option authenticated_sender_force smtp boolean false
23436 If this option is set true, the &%authenticated_sender%& option's value
23437 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23438 authenticated as a client.
23439
23440
23441 .option command_timeout smtp time 5m
23442 This sets a timeout for receiving a response to an SMTP command that has been
23443 sent out. It is also used when waiting for the initial banner line from the
23444 remote host. Its value must not be zero.
23445
23446
23447 .option connect_timeout smtp time 5m
23448 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23449 to a remote host. A setting of zero allows the system timeout (typically
23450 several minutes) to act. To have any effect, the value of this option must be
23451 less than the system timeout. However, it has been observed that on some
23452 systems there is no system timeout, which is why the default value for this
23453 option is 5 minutes, a value recommended by RFC 1123.
23454
23455
23456 .option connection_max_messages smtp integer 500
23457 .cindex "SMTP" "passed connection"
23458 .cindex "SMTP" "multiple deliveries"
23459 .cindex "multiple SMTP deliveries"
23460 This controls the maximum number of separate message deliveries that are sent
23461 over a single TCP/IP connection. If the value is zero, there is no limit.
23462 For testing purposes, this value can be overridden by the &%-oB%& command line
23463 option.
23464
23465
23466 .option data_timeout smtp time 5m
23467 This sets a timeout for the transmission of each block in the data portion of
23468 the message. As a result, the overall timeout for a message depends on the size
23469 of the message. Its value must not be zero. See also &%final_timeout%&.
23470
23471
23472 .option dkim_domain smtp string&!! unset
23473 .option dkim_selector smtp string&!! unset
23474 .option dkim_private_key smtp string&!! unset
23475 .option dkim_canon smtp string&!! unset
23476 .option dkim_strict smtp string&!! unset
23477 .option dkim_sign_headers smtp string&!! unset
23478 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23479
23480
23481 .option delay_after_cutoff smtp boolean true
23482 This option controls what happens when all remote IP addresses for a given
23483 domain have been inaccessible for so long that they have passed their retry
23484 cutoff times.
23485
23486 In the default state, if the next retry time has not been reached for any of
23487 them, the address is bounced without trying any deliveries. In other words,
23488 Exim delays retrying an IP address after the final cutoff time until a new
23489 retry time is reached, and can therefore bounce an address without ever trying
23490 a delivery, when machines have been down for a long time. Some people are
23491 unhappy at this prospect, so...
23492
23493 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23494 addresses are past their final cutoff time, Exim tries to deliver to those
23495 IP addresses that have not been tried since the message arrived. If there are
23496 none, of if they all fail, the address is bounced. In other words, it does not
23497 delay when a new message arrives, but immediately tries those expired IP
23498 addresses that haven't been tried since the message arrived. If there is a
23499 continuous stream of messages for the dead hosts, unsetting
23500 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23501 to them.
23502
23503
23504 .option dns_qualify_single smtp boolean true
23505 If the &%hosts%& or &%fallback_hosts%& option is being used,
23506 and the &%gethostbyname%& option is false,
23507 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23508 in chapter &<<CHAPdnslookup>>& for more details.
23509
23510
23511 .option dns_search_parents smtp boolean false
23512 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23513 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23514 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23515 details.
23516
23517
23518 .option dnssec_request_domains smtp "domain list&!!" unset
23519 .cindex "MX record" "security"
23520 .cindex "DNSSEC" "MX lookup"
23521 .cindex "security" "MX lookup"
23522 .cindex "DNS" "DNSSEC"
23523 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23524 the dnssec request bit set.
23525 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23526
23527
23528
23529 .option dnssec_require_domains smtp "domain list&!!" unset
23530 .cindex "MX record" "security"
23531 .cindex "DNSSEC" "MX lookup"
23532 .cindex "security" "MX lookup"
23533 .cindex "DNS" "DNSSEC"
23534 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23535 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23536 (AD bit) set will be ignored and logged as a host-lookup failure.
23537 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23538
23539
23540
23541 .option dscp smtp string&!! unset
23542 .cindex "DCSP" "outbound"
23543 This option causes the DSCP value associated with a socket to be set to one
23544 of a number of fixed strings or to numeric value.
23545 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23546 Common values include &`throughput`&, &`mincost`&, and on newer systems
23547 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23548
23549 The outbound packets from Exim will be marked with this value in the header
23550 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23551 that these values will have any effect, not be stripped by networking
23552 equipment, or do much of anything without cooperation with your Network
23553 Engineer and those of all network operators between the source and destination.
23554
23555
23556 .option fallback_hosts smtp "string list" unset
23557 .cindex "fallback" "hosts specified on transport"
23558 String expansion is not applied to this option. The argument must be a
23559 colon-separated list of host names or IP addresses, optionally also including
23560 port numbers, though the separator can be changed, as described in section
23561 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23562 item in a &%route_list%& setting for the &(manualroute)& router, as described
23563 in section &<<SECTformatonehostitem>>&.
23564
23565 Fallback hosts can also be specified on routers, which associate them with the
23566 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23567 &%fallback_hosts%& specified on the transport is used only if the address does
23568 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23569 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23570 However, &%hosts_randomize%& does apply to fallback host lists.
23571
23572 If Exim is unable to deliver to any of the hosts for a particular address, and
23573 the errors are not permanent rejections, the address is put on a separate
23574 transport queue with its host list replaced by the fallback hosts, unless the
23575 address was routed via MX records and the current host was in the original MX
23576 list. In that situation, the fallback host list is not used.
23577
23578 Once normal deliveries are complete, the fallback queue is delivered by
23579 re-running the same transports with the new host lists. If several failing
23580 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23581 copy of the message is sent.
23582
23583 The resolution of the host names on the fallback list is controlled by the
23584 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23585 both to cases when the host list comes with the address and when it is taken
23586 from &%hosts%&. This option provides a &"use a smart host only if delivery
23587 fails"& facility.
23588
23589
23590 .option final_timeout smtp time 10m
23591 This is the timeout that applies while waiting for the response to the final
23592 line containing just &"."& that terminates a message. Its value must not be
23593 zero.
23594
23595 .option gethostbyname smtp boolean false
23596 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23597 being used, names are looked up using &[gethostbyname()]&
23598 (or &[getipnodebyname()]& when available)
23599 instead of using the DNS. Of course, that function may in fact use the DNS, but
23600 it may also consult other sources of information such as &_/etc/hosts_&.
23601
23602 .option gnutls_compat_mode smtp boolean unset
23603 This option controls whether GnuTLS is used in compatibility mode in an Exim
23604 server. This reduces security slightly, but improves interworking with older
23605 implementations of TLS.
23606
23607 .option helo_data smtp string&!! "see below"
23608 .cindex "HELO" "argument, setting"
23609 .cindex "EHLO" "argument, setting"
23610 .cindex "LHLO argument setting"
23611 The value of this option is expanded after a connection to a another host has
23612 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23613 command that starts the outgoing SMTP or LMTP session. The default value of the
23614 option is:
23615 .code
23616 $primary_hostname
23617 .endd
23618 During the expansion, the variables &$host$& and &$host_address$& are set to
23619 the identity of the remote host, and the variables &$sending_ip_address$& and
23620 &$sending_port$& are set to the local IP address and port number that are being
23621 used. These variables can be used to generate different values for different
23622 servers or different local IP addresses. For example, if you want the string
23623 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23624 interface address, you could use this:
23625 .code
23626 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23627   {$primary_hostname}}
23628 .endd
23629 The use of &%helo_data%& applies both to sending messages and when doing
23630 callouts.
23631
23632 .option hosts smtp "string list&!!" unset
23633 Hosts are associated with an address by a router such as &(dnslookup)&, which
23634 finds the hosts by looking up the address domain in the DNS, or by
23635 &(manualroute)&, which has lists of hosts in its configuration. However,
23636 email addresses can be passed to the &(smtp)& transport by any router, and not
23637 all of them can provide an associated list of hosts.
23638
23639 The &%hosts%& option specifies a list of hosts to be used if the address being
23640 processed does not have any hosts associated with it. The hosts specified by
23641 &%hosts%& are also used, whether or not the address has its own hosts, if
23642 &%hosts_override%& is set.
23643
23644 The string is first expanded, before being interpreted as a colon-separated
23645 list of host names or IP addresses, possibly including port numbers. The
23646 separator may be changed to something other than colon, as described in section
23647 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23648 item in a &%route_list%& setting for the &(manualroute)& router, as described
23649 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23650 of the &(manualroute)& router is not available here.
23651
23652 If the expansion fails, delivery is deferred. Unless the failure was caused by
23653 the inability to complete a lookup, the error is logged to the panic log as
23654 well as the main log. Host names are looked up either by searching directly for
23655 address records in the DNS or by calling &[gethostbyname()]& (or
23656 &[getipnodebyname()]& when available), depending on the setting of the
23657 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23658 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23659 address are used.
23660
23661 During delivery, the hosts are tried in order, subject to their retry status,
23662 unless &%hosts_randomize%& is set.
23663
23664
23665 .option hosts_avoid_esmtp smtp "host list&!!" unset
23666 .cindex "ESMTP, avoiding use of"
23667 .cindex "HELO" "forcing use of"
23668 .cindex "EHLO" "avoiding use of"
23669 .cindex "PIPELINING" "avoiding the use of"
23670 This option is for use with broken hosts that announce ESMTP facilities (for
23671 example, PIPELINING) and then fail to implement them properly. When a host
23672 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23673 start of the SMTP session. This means that it cannot use any of the ESMTP
23674 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23675
23676
23677 .option hosts_avoid_pipelining smtp "host list&!!" unset
23678 .cindex "PIPELINING" "avoiding the use of"
23679 Exim will not use the SMTP PIPELINING extension when delivering to any host
23680 that matches this list, even if the server host advertises PIPELINING support.
23681
23682
23683 .option hosts_avoid_tls smtp "host list&!!" unset
23684 .cindex "TLS" "avoiding for certain hosts"
23685 Exim will not try to start a TLS session when delivering to any host that
23686 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23687
23688 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23689 .cindex "TLS" "avoiding for certain hosts"
23690 Exim will not try to start a TLS session for a verify callout,
23691 or when delivering in cutthrough mode,
23692 to any host that matches this list.
23693
23694
23695 .option hosts_max_try smtp integer 5
23696 .cindex "host" "maximum number to try"
23697 .cindex "limit" "number of hosts tried"
23698 .cindex "limit" "number of MX tried"
23699 .cindex "MX record" "maximum tried"
23700 This option limits the number of IP addresses that are tried for any one
23701 delivery in cases where there are temporary delivery errors. Section
23702 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23703
23704
23705 .option hosts_max_try_hardlimit smtp integer 50
23706 This is an additional check on the maximum number of IP addresses that Exim
23707 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23708 why it exists.
23709
23710
23711
23712 .option hosts_nopass_tls smtp "host list&!!" unset
23713 .cindex "TLS" "passing connection"
23714 .cindex "multiple SMTP deliveries"
23715 .cindex "TLS" "multiple message deliveries"
23716 For any host that matches this list, a connection on which a TLS session has
23717 been started will not be passed to a new delivery process for sending another
23718 message on the same connection. See section &<<SECTmulmessam>>& for an
23719 explanation of when this might be needed.
23720
23721
23722 .option hosts_override smtp boolean false
23723 If this option is set and the &%hosts%& option is also set, any hosts that are
23724 attached to the address are ignored, and instead the hosts specified by the
23725 &%hosts%& option are always used. This option does not apply to
23726 &%fallback_hosts%&.
23727
23728
23729 .option hosts_randomize smtp boolean false
23730 .cindex "randomized host list"
23731 .cindex "host" "list of; randomized"
23732 .cindex "fallback" "randomized hosts"
23733 If this option is set, and either the list of hosts is taken from the
23734 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23735 were not obtained from MX records (this includes fallback hosts from the
23736 router), and were not randomized by the router, the order of trying the hosts
23737 is randomized each time the transport runs. Randomizing the order of a host
23738 list can be used to do crude load sharing.
23739
23740 When &%hosts_randomize%& is true, a host list may be split into groups whose
23741 order is separately randomized. This makes it possible to set up MX-like
23742 behaviour. The boundaries between groups are indicated by an item that is just
23743 &`+`& in the host list. For example:
23744 .code
23745 hosts = host1:host2:host3:+:host4:host5
23746 .endd
23747 The order of the first three hosts and the order of the last two hosts is
23748 randomized for each use, but the first three always end up before the last two.
23749 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23750
23751 .option hosts_require_auth smtp "host list&!!" unset
23752 .cindex "authentication" "required by client"
23753 This option provides a list of servers for which authentication must succeed
23754 before Exim will try to transfer a message. If authentication fails for
23755 servers which are not in this list, Exim tries to send unauthenticated. If
23756 authentication fails for one of these servers, delivery is deferred. This
23757 temporary error is detectable in the retry rules, so it can be turned into a
23758 hard failure if required. See also &%hosts_try_auth%&, and chapter
23759 &<<CHAPSMTPAUTH>>& for details of authentication.
23760
23761
23762 .option hosts_request_ocsp smtp "host list&!!" *
23763 .cindex "TLS" "requiring for certain servers"
23764 Exim will request a Certificate Status on a
23765 TLS session for any host that matches this list.
23766 &%tls_verify_certificates%& should also be set for the transport.
23767
23768 .option hosts_require_ocsp smtp "host list&!!" unset
23769 .cindex "TLS" "requiring for certain servers"
23770 Exim will request, and check for a valid Certificate Status being given, on a
23771 TLS session for any host that matches this list.
23772 &%tls_verify_certificates%& should also be set for the transport.
23773
23774 .option hosts_require_tls smtp "host list&!!" unset
23775 .cindex "TLS" "requiring for certain servers"
23776 Exim will insist on using a TLS session when delivering to any host that
23777 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23778 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23779 incoming messages, use an appropriate ACL.
23780
23781 .option hosts_try_auth smtp "host list&!!" unset
23782 .cindex "authentication" "optional in client"
23783 This option provides a list of servers to which, provided they announce
23784 authentication support, Exim will attempt to authenticate as a client when it
23785 connects. If authentication fails, Exim will try to transfer the message
23786 unauthenticated. See also &%hosts_require_auth%&, and chapter
23787 &<<CHAPSMTPAUTH>>& for details of authentication.
23788
23789 .option hosts_try_prdr smtp "host list&!!" *
23790 .cindex "PRDR" "enabling, optional in client"
23791 This option provides a list of servers to which, provided they announce
23792 PRDR support, Exim will attempt to negotiate PRDR
23793 for multi-recipient messages.
23794 The option can usually be left as default.
23795
23796 .option interface smtp "string list&!!" unset
23797 .cindex "bind IP address"
23798 .cindex "IP address" "binding"
23799 .vindex "&$host$&"
23800 .vindex "&$host_address$&"
23801 This option specifies which interface to bind to when making an outgoing SMTP
23802 call. The value is an IP address, not an interface name such as
23803 &`eth0`&. Do not confuse this with the interface address that was used when a
23804 message was received, which is in &$received_ip_address$&, formerly known as
23805 &$interface_address$&. The name was changed to minimize confusion with the
23806 outgoing interface address. There is no variable that contains an outgoing
23807 interface address because, unless it is set by this option, its value is
23808 unknown.
23809
23810 During the expansion of the &%interface%& option the variables &$host$& and
23811 &$host_address$& refer to the host to which a connection is about to be made
23812 during the expansion of the string. Forced expansion failure, or an empty
23813 string result causes the option to be ignored. Otherwise, after expansion, the
23814 string must be a list of IP addresses, colon-separated by default, but the
23815 separator can be changed in the usual way. For example:
23816 .code
23817 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23818 .endd
23819 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23820 connection. If none of them are the correct type, the option is ignored. If
23821 &%interface%& is not set, or is ignored, the system's IP functions choose which
23822 interface to use if the host has more than one.
23823
23824
23825 .option keepalive smtp boolean true
23826 .cindex "keepalive" "on outgoing connection"
23827 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23828 connections. When set, it causes the kernel to probe idle connections
23829 periodically, by sending packets with &"old"& sequence numbers. The other end
23830 of the connection should send a acknowledgment if the connection is still okay
23831 or a reset if the connection has been aborted. The reason for doing this is
23832 that it has the beneficial effect of freeing up certain types of connection
23833 that can get stuck when the remote host is disconnected without tidying up the
23834 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23835 unreachable hosts.
23836
23837
23838 .option lmtp_ignore_quota smtp boolean false
23839 .cindex "LMTP" "ignoring quota errors"
23840 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23841 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23842 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23843
23844 .option max_rcpt smtp integer 100
23845 .cindex "RCPT" "maximum number of outgoing"
23846 This option limits the number of RCPT commands that are sent in a single
23847 SMTP message transaction. Each set of addresses is treated independently, and
23848 so can cause parallel connections to the same host if &%remote_max_parallel%&
23849 permits this.
23850
23851
23852 .option multi_domain smtp boolean&!! true
23853 .vindex "&$domain$&"
23854 When this option is set, the &(smtp)& transport can handle a number of
23855 addresses containing a mixture of different domains provided they all resolve
23856 to the same list of hosts. Turning the option off restricts the transport to
23857 handling only one domain at a time. This is useful if you want to use
23858 &$domain$& in an expansion for the transport, because it is set only when there
23859 is a single domain involved in a remote delivery.
23860
23861 It is expanded per-address and can depend on any of
23862 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23863 &$host$&, &$host_address$& and &$host_port$&.
23864
23865 .option port smtp string&!! "see below"
23866 .cindex "port" "sending TCP/IP"
23867 .cindex "TCP/IP" "setting outgoing port"
23868 This option specifies the TCP/IP port on the server to which Exim connects.
23869 &*Note:*& Do not confuse this with the port that was used when a message was
23870 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23871 The name was changed to minimize confusion with the outgoing port. There is no
23872 variable that contains an outgoing port.
23873
23874 If the value of this option begins with a digit it is taken as a port number;
23875 otherwise it is looked up using &[getservbyname()]&. The default value is
23876 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23877 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23878 is deferred.
23879
23880
23881
23882 .option protocol smtp string smtp
23883 .cindex "LMTP" "over TCP/IP"
23884 .cindex "ssmtp protocol" "outbound"
23885 .cindex "TLS" "SSL-on-connect outbound"
23886 .vindex "&$port$&"
23887 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23888 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23889 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23890 deliveries into closed message stores. Exim also has support for running LMTP
23891 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23892
23893 If this option is set to &"smtps"&, the default value for the &%port%& option
23894 changes to &"smtps"&, and the transport initiates TLS immediately after
23895 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23896 The Internet standards bodies strongly discourage use of this mode.
23897
23898
23899 .option retry_include_ip_address smtp boolean&!! true
23900 Exim normally includes both the host name and the IP address in the key it
23901 constructs for indexing retry data after a temporary delivery failure. This
23902 means that when one of several IP addresses for a host is failing, it gets
23903 tried periodically (controlled by the retry rules), but use of the other IP
23904 addresses is not affected.
23905
23906 However, in some dialup environments hosts are assigned a different IP address
23907 each time they connect. In this situation the use of the IP address as part of
23908 the retry key leads to undesirable behaviour. Setting this option false causes
23909 Exim to use only the host name.
23910 Since it is expanded it can be made to depend on the host or domain.
23911
23912
23913 .option serialize_hosts smtp "host list&!!" unset
23914 .cindex "serializing connections"
23915 .cindex "host" "serializing connections"
23916 Because Exim operates in a distributed manner, if several messages for the same
23917 host arrive at around the same time, more than one simultaneous connection to
23918 the remote host can occur. This is not usually a problem except when there is a
23919 slow link between the hosts. In that situation it may be helpful to restrict
23920 Exim to one connection at a time. This can be done by setting
23921 &%serialize_hosts%& to match the relevant hosts.
23922
23923 .cindex "hints database" "serializing deliveries to a host"
23924 Exim implements serialization by means of a hints database in which a record is
23925 written whenever a process connects to one of the restricted hosts. The record
23926 is deleted when the connection is completed. Obviously there is scope for
23927 records to get left lying around if there is a system or program crash. To
23928 guard against this, Exim ignores any records that are more than six hours old.
23929
23930 If you set up this kind of serialization, you should also arrange to delete the
23931 relevant hints database whenever your system reboots. The names of the files
23932 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23933 may be one or two files, depending on the type of DBM in use. The same files
23934 are used for ETRN serialization.
23935
23936 See also the &%max_parallel%& generic transport option.
23937
23938
23939 .option size_addition smtp integer 1024
23940 .cindex "SMTP" "SIZE"
23941 .cindex "message" "size issue for transport filter"
23942 .cindex "size" "of message"
23943 .cindex "transport" "filter"
23944 .cindex "filter" "transport filter"
23945 If a remote SMTP server indicates that it supports the SIZE option of the
23946 MAIL command, Exim uses this to pass over the message size at the start of
23947 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23948 sends, to allow for headers and other text that may be added during delivery by
23949 configuration options or in a transport filter. It may be necessary to increase
23950 this if a lot of text is added to messages.
23951
23952 Alternatively, if the value of &%size_addition%& is set negative, it disables
23953 the use of the SIZE option altogether.
23954
23955
23956 .option socks_proxy smtp string&!! unset
23957 .cindex proxy SOCKS
23958 This option enables use of SOCKS proxies for connections made by the
23959 transport.  For details see &<<SECTproxySOCKS>>&.
23960
23961
23962 .option tls_certificate smtp string&!! unset
23963 .cindex "TLS" "client certificate, location of"
23964 .cindex "certificate" "client, location of"
23965 .vindex "&$host$&"
23966 .vindex "&$host_address$&"
23967 The value of this option must be the absolute path to a file which contains the
23968 client's certificate, for possible use when sending a message over an encrypted
23969 connection. The values of &$host$& and &$host_address$& are set to the name and
23970 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23971 details of TLS.
23972
23973 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23974 certificate when sending messages as a client. The global option of the same
23975 name specifies the certificate for Exim as a server; it is not automatically
23976 assumed that the same certificate should be used when Exim is operating as a
23977 client.
23978
23979
23980 .option tls_crl smtp string&!! unset
23981 .cindex "TLS" "client certificate revocation list"
23982 .cindex "certificate" "revocation list for client"
23983 This option specifies a certificate revocation list. The expanded value must
23984 be the name of a file that contains a CRL in PEM format.
23985
23986
23987 .option tls_dh_min_bits smtp integer 1024
23988 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23989 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23990 key agreement is negotiated, the server will provide a large prime number
23991 for use.  This option establishes the minimum acceptable size of that number.
23992 If the parameter offered by the server is too small, then the TLS handshake
23993 will fail.
23994
23995 Only supported when using GnuTLS.
23996
23997
23998 .option tls_privatekey smtp string&!! unset
23999 .cindex "TLS" "client private key, location of"
24000 .vindex "&$host$&"
24001 .vindex "&$host_address$&"
24002 The value of this option must be the absolute path to a file which contains the
24003 client's private key. This is used when sending a message over an encrypted
24004 connection using a client certificate. The values of &$host$& and
24005 &$host_address$& are set to the name and address of the server during the
24006 expansion. If this option is unset, or the expansion is forced to fail, or the
24007 result is an empty string, the private key is assumed to be in the same file as
24008 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24009
24010
24011 .option tls_require_ciphers smtp string&!! unset
24012 .cindex "TLS" "requiring specific ciphers"
24013 .cindex "cipher" "requiring specific"
24014 .vindex "&$host$&"
24015 .vindex "&$host_address$&"
24016 The value of this option must be a list of permitted cipher suites, for use
24017 when setting up an outgoing encrypted connection. (There is a global option of
24018 the same name for controlling incoming connections.) The values of &$host$& and
24019 &$host_address$& are set to the name and address of the server during the
24020 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24021 is used in different ways by OpenSSL and GnuTLS (see sections
24022 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24023 ciphers is a preference order.
24024
24025
24026
24027 .option tls_sni smtp string&!! unset
24028 .cindex "TLS" "Server Name Indication"
24029 .vindex "&$tls_sni$&"
24030 If this option is set then it sets the $tls_out_sni variable and causes any
24031 TLS session to pass this value as the Server Name Indication extension to
24032 the remote side, which can be used by the remote side to select an appropriate
24033 certificate and private key for the session.
24034
24035 See &<<SECTtlssni>>& for more information.
24036
24037 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24038 TLS extensions.
24039
24040
24041
24042
24043 .option tls_tempfail_tryclear smtp boolean true
24044 .cindex "4&'xx'& responses" "to STARTTLS"
24045 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24046 setting up a TLS session, this option determines whether or not Exim should try
24047 to deliver the message unencrypted. If it is set false, delivery to the
24048 current host is deferred; if there are other hosts, they are tried. If this
24049 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24050 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24051 TLS negotiation fails, Exim closes the current connection (because it is in an
24052 unknown state), opens a new one to the same host, and then tries the delivery
24053 in clear.
24054
24055
24056 .option tls_try_verify_hosts smtp "host list&!!" *
24057 .cindex "TLS" "server certificate verification"
24058 .cindex "certificate" "verification of server"
24059 This option gives a list of hosts for which, on encrypted connections,
24060 certificate verification will be tried but need not succeed.
24061 The &%tls_verify_certificates%& option must also be set.
24062 Note that unless the host is in this list
24063 TLS connections will be denied to hosts using self-signed certificates
24064 when &%tls_verify_certificates%& is matched.
24065 The &$tls_out_certificate_verified$& variable is set when
24066 certificate verification succeeds.
24067
24068
24069 .option tls_verify_cert_hostnames smtp "host list&!!" *
24070 .cindex "TLS" "server certificate hostname verification"
24071 .cindex "certificate" "verification of server"
24072 This option give a list of hosts for which,
24073 while verifying the server certificate,
24074 checks will be included on the host name
24075 (note that this will generally be the result of a DNS MX lookup)
24076 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24077 limited to being the initial component of a 3-or-more component FQDN.
24078
24079 There is no equivalent checking on client certificates.
24080
24081
24082 .option tls_verify_certificates smtp string&!! system
24083 .cindex "TLS" "server certificate verification"
24084 .cindex "certificate" "verification of server"
24085 .vindex "&$host$&"
24086 .vindex "&$host_address$&"
24087 The value of this option must be either the
24088 word "system"
24089 or the absolute path to
24090 a file or directory containing permitted certificates for servers,
24091 for use when setting up an encrypted connection.
24092
24093 The "system" value for the option will use a location compiled into the SSL library.
24094 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24095 is taken as empty and an explicit location
24096 must be specified.
24097
24098 The use of a directory for the option value is not available for GnuTLS versions
24099 preceding 3.3.6 and a single file must be used.
24100
24101 With OpenSSL the certificates specified
24102 explicitly
24103 either by file or directory
24104 are added to those given by the system default location.
24105
24106 The values of &$host$& and
24107 &$host_address$& are set to the name and address of the server during the
24108 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24109
24110 For back-compatibility,
24111 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24112 (a single-colon empty list counts as being set)
24113 and certificate verification fails the TLS connection is closed.
24114
24115
24116 .option tls_verify_hosts smtp "host list&!!" unset
24117 .cindex "TLS" "server certificate verification"
24118 .cindex "certificate" "verification of server"
24119 This option gives a list of hosts for which, on encrypted connections,
24120 certificate verification must succeed.
24121 The &%tls_verify_certificates%& option must also be set.
24122 If both this option and &%tls_try_verify_hosts%& are unset
24123 operation is as if this option selected all hosts.
24124
24125
24126
24127
24128 .section "How the limits for the number of hosts to try are used" &&&
24129          "SECTvalhosmax"
24130 .cindex "host" "maximum number to try"
24131 .cindex "limit" "hosts; maximum number tried"
24132 There are two options that are concerned with the number of hosts that are
24133 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24134 &%hosts_max_try_hardlimit%&.
24135
24136
24137 The &%hosts_max_try%& option limits the number of hosts that are tried
24138 for a single delivery. However, despite the term &"host"& in its name, the
24139 option actually applies to each IP address independently. In other words, a
24140 multihomed host is treated as several independent hosts, just as it is for
24141 retrying.
24142
24143 Many of the larger ISPs have multiple MX records which often point to
24144 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24145 created as a result of routing one of these domains.
24146
24147 Trying every single IP address on such a long list does not seem sensible; if
24148 several at the top of the list fail, it is reasonable to assume there is some
24149 problem that is likely to affect all of them. Roughly speaking, the value of
24150 &%hosts_max_try%& is the maximum number that are tried before deferring the
24151 delivery. However, the logic cannot be quite that simple.
24152
24153 Firstly, IP addresses that are skipped because their retry times have not
24154 arrived do not count, and in addition, addresses that are past their retry
24155 limits are also not counted, even when they are tried. This means that when
24156 some IP addresses are past their retry limits, more than the value of
24157 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24158 that all IP addresses are considered before timing out an email address (but
24159 see below for an exception).
24160
24161 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24162 list to see if there is a subsequent host with a different (higher valued) MX.
24163 If there is, that host is considered next, and the current IP address is used
24164 but not counted. This behaviour helps in the case of a domain with a retry rule
24165 that hardly ever delays any hosts, as is now explained:
24166
24167 Consider the case of a long list of hosts with one MX value, and a few with a
24168 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24169 hosts at the top of the list are tried at first. With the default retry rule,
24170 which specifies increasing retry times, the higher MX hosts are eventually
24171 tried when those at the top of the list are skipped because they have not
24172 reached their retry times.
24173
24174 However, it is common practice to put a fixed short retry time on domains for
24175 large ISPs, on the grounds that their servers are rarely down for very long.
24176 Unfortunately, these are exactly the domains that tend to resolve to long lists
24177 of hosts. The short retry time means that the lowest MX hosts are tried every
24178 time. The attempts may be in a different order because of random sorting, but
24179 without the special MX check, the higher MX hosts would never be tried until
24180 all the lower MX hosts had timed out (which might be several days), because
24181 there are always some lower MX hosts that have reached their retry times. With
24182 the special check, Exim considers at least one IP address from each MX value at
24183 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24184 reached.
24185
24186 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24187 particular, Exim normally eventually tries all the IP addresses before timing
24188 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24189 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24190 been set up with hundreds of IP addresses for some domains. It can
24191 take a very long time indeed for an address to time out in these cases.
24192
24193 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24194 Exim never tries more than this number of IP addresses; if it hits this limit
24195 and they are all timed out, the email address is bounced, even though not all
24196 possible IP addresses have been tried.
24197 .ecindex IIDsmttra1
24198 .ecindex IIDsmttra2
24199
24200
24201
24202
24203
24204 . ////////////////////////////////////////////////////////////////////////////
24205 . ////////////////////////////////////////////////////////////////////////////
24206
24207 .chapter "Address rewriting" "CHAPrewrite"
24208 .scindex IIDaddrew "rewriting" "addresses"
24209 There are some circumstances in which Exim automatically rewrites domains in
24210 addresses. The two most common are when an address is given without a domain
24211 (referred to as an &"unqualified address"&) or when an address contains an
24212 abbreviated domain that is expanded by DNS lookup.
24213
24214 Unqualified envelope addresses are accepted only for locally submitted
24215 messages, or for messages that are received from hosts matching
24216 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24217 appropriate. Unqualified addresses in header lines are qualified if they are in
24218 locally submitted messages, or messages from hosts that are permitted to send
24219 unqualified envelope addresses. Otherwise, unqualified addresses in header
24220 lines are neither qualified nor rewritten.
24221
24222 One situation in which Exim does &'not'& automatically rewrite a domain is
24223 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24224 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24225 do this. The new RFCs do not contain this suggestion.
24226
24227
24228 .section "Explicitly configured address rewriting" "SECID147"
24229 This chapter describes the rewriting rules that can be used in the
24230 main rewrite section of the configuration file, and also in the generic
24231 &%headers_rewrite%& option that can be set on any transport.
24232
24233 Some people believe that configured address rewriting is a Mortal Sin.
24234 Others believe that life is not possible without it. Exim provides the
24235 facility; you do not have to use it.
24236
24237 The main rewriting rules that appear in the &"rewrite"& section of the
24238 configuration file are applied to addresses in incoming messages, both envelope
24239 addresses and addresses in header lines. Each rule specifies the types of
24240 address to which it applies.
24241
24242 Whether or not addresses in header lines are rewritten depends on the origin of
24243 the headers and the type of rewriting. Global rewriting, that is, rewriting
24244 rules from the rewrite section of the configuration file, is applied only to
24245 those headers that were received with the message. Header lines that are added
24246 by ACLs or by a system filter or by individual routers or transports (which
24247 are specific to individual recipient addresses) are not rewritten by the global
24248 rules.
24249
24250 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24251 applies all headers except those added by routers and transports. That is, as
24252 well as the headers that were received with the message, it also applies to
24253 headers that were added by an ACL or a system filter.
24254
24255
24256 In general, rewriting addresses from your own system or domain has some
24257 legitimacy. Rewriting other addresses should be done only with great care and
24258 in special circumstances. The author of Exim believes that rewriting should be
24259 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24260 Although it can sometimes be used as a routing tool, this is very strongly
24261 discouraged.
24262
24263 There are two commonly encountered circumstances where rewriting is used, as
24264 illustrated by these examples:
24265
24266 .ilist
24267 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24268 exchange mail with each other behind a firewall, but there is only a single
24269 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24270 &'hitch.fict.example'& when sending mail off-site.
24271 .next
24272 A host rewrites the local parts of its own users so that, for example,
24273 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24274 .endlist
24275
24276
24277
24278 .section "When does rewriting happen?" "SECID148"
24279 .cindex "rewriting" "timing of"
24280 .cindex "&ACL;" "rewriting addresses in"
24281 Configured address rewriting can take place at several different stages of a
24282 message's processing.
24283
24284 .vindex "&$sender_address$&"
24285 At the start of an ACL for MAIL, the sender address may have been rewritten
24286 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24287 ordinary rewrite rules have yet been applied. If, however, the sender address
24288 is verified in the ACL, it is rewritten before verification, and remains
24289 rewritten thereafter. The subsequent value of &$sender_address$& is the
24290 rewritten address. This also applies if sender verification happens in a
24291 RCPT ACL. Otherwise, when the sender address is not verified, it is
24292 rewritten as soon as a message's header lines have been received.
24293
24294 .vindex "&$domain$&"
24295 .vindex "&$local_part$&"
24296 Similarly, at the start of an ACL for RCPT, the current recipient's address
24297 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24298 rewrite rules have yet been applied to it. However, the behaviour is different
24299 from the sender address when a recipient is verified. The address is rewritten
24300 for the verification, but the rewriting is not remembered at this stage. The
24301 value of &$local_part$& and &$domain$& after verification are always the same
24302 as they were before (that is, they contain the unrewritten &-- except for
24303 SMTP-time rewriting &-- address).
24304
24305 As soon as a message's header lines have been received, all the envelope
24306 recipient addresses are permanently rewritten, and rewriting is also applied to
24307 the addresses in the header lines (if configured). This happens before adding
24308 any header lines that were specified in MAIL or RCPT ACLs, and
24309 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24310 before the DATA ACL and &[local_scan()]& functions are run.
24311
24312 When an address is being routed, either for delivery or for verification,
24313 rewriting is applied immediately to child addresses that are generated by
24314 redirection, unless &%no_rewrite%& is set on the router.
24315
24316 .cindex "envelope sender" "rewriting at transport time"
24317 .cindex "rewriting" "at transport time"
24318 .cindex "header lines" "rewriting at transport time"
24319 At transport time, additional rewriting of addresses in header lines can be
24320 specified by setting the generic &%headers_rewrite%& option on a transport.
24321 This option contains rules that are identical in form to those in the rewrite
24322 section of the configuration file. They are applied to the original message
24323 header lines and any that were added by ACLs or a system filter. They are not
24324 applied to header lines that are added by routers or the transport.
24325
24326 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24327 transport option. However, it is not possible to rewrite envelope recipients at
24328 transport time.
24329
24330
24331
24332
24333 .section "Testing the rewriting rules that apply on input" "SECID149"
24334 .cindex "rewriting" "testing"
24335 .cindex "testing" "rewriting"
24336 Exim's input rewriting configuration appears in a part of the run time
24337 configuration file headed by &"begin rewrite"&. It can be tested by the
24338 &%-brw%& command line option. This takes an address (which can be a full RFC
24339 2822 address) as its argument. The output is a list of how the address would be
24340 transformed by the rewriting rules for each of the different places it might
24341 appear in an incoming message, that is, for each different header and for the
24342 envelope sender and recipient fields. For example,
24343 .code
24344 exim -brw ph10@exim.workshop.example
24345 .endd
24346 might produce the output
24347 .code
24348 sender: Philip.Hazel@exim.workshop.example
24349 from: Philip.Hazel@exim.workshop.example
24350 to: ph10@exim.workshop.example
24351 cc: ph10@exim.workshop.example
24352 bcc: ph10@exim.workshop.example
24353 reply-to: Philip.Hazel@exim.workshop.example
24354 env-from: Philip.Hazel@exim.workshop.example
24355 env-to: ph10@exim.workshop.example
24356 .endd
24357 which shows that rewriting has been set up for that address when used in any of
24358 the source fields, but not when it appears as a recipient address. At the
24359 present time, there is no equivalent way of testing rewriting rules that are
24360 set for a particular transport.
24361
24362
24363 .section "Rewriting rules" "SECID150"
24364 .cindex "rewriting" "rules"
24365 The rewrite section of the configuration file consists of lines of rewriting
24366 rules in the form
24367 .display
24368 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24369 .endd
24370 Rewriting rules that are specified for the &%headers_rewrite%& generic
24371 transport option are given as a colon-separated list. Each item in the list
24372 takes the same form as a line in the main rewriting configuration (except that
24373 any colons must be doubled, of course).
24374
24375 The formats of source patterns and replacement strings are described below.
24376 Each is terminated by white space, unless enclosed in double quotes, in which
24377 case normal quoting conventions apply inside the quotes. The flags are single
24378 characters which may appear in any order. Spaces and tabs between them are
24379 ignored.
24380
24381 For each address that could potentially be rewritten, the rules are scanned in
24382 order, and replacements for the address from earlier rules can themselves be
24383 replaced by later rules (but see the &"q"& and &"R"& flags).
24384
24385 The order in which addresses are rewritten is undefined, may change between
24386 releases, and must not be relied on, with one exception: when a message is
24387 received, the envelope sender is always rewritten first, before any header
24388 lines are rewritten. For example, the replacement string for a rewrite of an
24389 address in &'To:'& must not assume that the message's address in &'From:'& has
24390 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24391 that the envelope sender has already been rewritten.
24392
24393 .vindex "&$domain$&"
24394 .vindex "&$local_part$&"
24395 The variables &$local_part$& and &$domain$& can be used in the replacement
24396 string to refer to the address that is being rewritten. Note that lookup-driven
24397 rewriting can be done by a rule of the form
24398 .code
24399 *@*   ${lookup ...
24400 .endd
24401 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24402 refer to the address that is being rewritten.
24403
24404
24405 .section "Rewriting patterns" "SECID151"
24406 .cindex "rewriting" "patterns"
24407 .cindex "address list" "in a rewriting pattern"
24408 The source pattern in a rewriting rule is any item which may appear in an
24409 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24410 single-item address list, which means that it is expanded before being tested
24411 against the address. As always, if you use a regular expression as a pattern,
24412 you must take care to escape dollar and backslash characters, or use the &`\N`&
24413 facility to suppress string expansion within the regular expression.
24414
24415 Domains in patterns should be given in lower case. Local parts in patterns are
24416 case-sensitive. If you want to do case-insensitive matching of local parts, you
24417 can use a regular expression that starts with &`^(?i)`&.
24418
24419 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24420 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24421 depending on the type of match which occurred. These can be used in the
24422 replacement string to insert portions of the incoming address. &$0$& always
24423 refers to the complete incoming address. When a regular expression is used, the
24424 numerical variables are set from its capturing subexpressions. For other types
24425 of pattern they are set as follows:
24426
24427 .ilist
24428 If a local part or domain starts with an asterisk, the numerical variables
24429 refer to the character strings matched by asterisks, with &$1$& associated with
24430 the first asterisk, and &$2$& with the second, if present. For example, if the
24431 pattern
24432 .code
24433 *queen@*.fict.example
24434 .endd
24435 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24436 .code
24437 $0 = hearts-queen@wonderland.fict.example
24438 $1 = hearts-
24439 $2 = wonderland
24440 .endd
24441 Note that if the local part does not start with an asterisk, but the domain
24442 does, it is &$1$& that contains the wild part of the domain.
24443
24444 .next
24445 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24446 of the domain are placed in the next available numerical variables. Suppose,
24447 for example, that the address &'foo@bar.baz.example'& is processed by a
24448 rewriting rule of the form
24449 .display
24450 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24451 .endd
24452 and the key in the file that matches the domain is &`*.baz.example`&. Then
24453 .code
24454 $1 = foo
24455 $2 = bar
24456 $3 = baz.example
24457 .endd
24458 If the address &'foo@baz.example'& is looked up, this matches the same
24459 wildcard file entry, and in this case &$2$& is set to the empty string, but
24460 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24461 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24462 whole domain. For non-partial domain lookups, no numerical variables are set.
24463 .endlist
24464
24465
24466 .section "Rewriting replacements" "SECID152"
24467 .cindex "rewriting" "replacements"
24468 If the replacement string for a rule is a single asterisk, addresses that
24469 match the pattern and the flags are &'not'& rewritten, and no subsequent
24470 rewriting rules are scanned. For example,
24471 .code
24472 hatta@lookingglass.fict.example  *  f
24473 .endd
24474 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24475 &'From:'& headers.
24476
24477 .vindex "&$domain$&"
24478 .vindex "&$local_part$&"
24479 If the replacement string is not a single asterisk, it is expanded, and must
24480 yield a fully qualified address. Within the expansion, the variables
24481 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24482 Any letters they contain retain their original case &-- they are not lower
24483 cased. The numerical variables are set up according to the type of pattern that
24484 matched the address, as described above. If the expansion is forced to fail by
24485 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24486 current rule is abandoned, but subsequent rules may take effect. Any other
24487 expansion failure causes the entire rewriting operation to be abandoned, and an
24488 entry written to the panic log.
24489
24490
24491
24492 .section "Rewriting flags" "SECID153"
24493 There are three different kinds of flag that may appear on rewriting rules:
24494
24495 .ilist
24496 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24497 c, f, h, r, s, t.
24498 .next
24499 A flag that specifies rewriting at SMTP time: S.
24500 .next
24501 Flags that control the rewriting process: Q, q, R, w.
24502 .endlist
24503
24504 For rules that are part of the &%headers_rewrite%& generic transport option,
24505 E, F, T, and S are not permitted.
24506
24507
24508
24509 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24510          "SECID154"
24511 .cindex "rewriting" "flags"
24512 If none of the following flag letters, nor the &"S"& flag (see section
24513 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24514 and to both the sender and recipient fields of the envelope, whereas a
24515 transport-time rewriting rule just applies to all headers. Otherwise, the
24516 rewriting rule is skipped unless the relevant addresses are being processed.
24517 .display
24518 &`E`&       rewrite all envelope fields
24519 &`F`&       rewrite the envelope From field
24520 &`T`&       rewrite the envelope To field
24521 &`b`&       rewrite the &'Bcc:'& header
24522 &`c`&       rewrite the &'Cc:'& header
24523 &`f`&       rewrite the &'From:'& header
24524 &`h`&       rewrite all headers
24525 &`r`&       rewrite the &'Reply-To:'& header
24526 &`s`&       rewrite the &'Sender:'& header
24527 &`t`&       rewrite the &'To:'& header
24528 .endd
24529 "All headers" means all of the headers listed above that can be selected
24530 individually, plus their &'Resent-'& versions. It does not include
24531 other headers such as &'Subject:'& etc.
24532
24533 You should be particularly careful about rewriting &'Sender:'& headers, and
24534 restrict this to special known cases in your own domains.
24535
24536
24537 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24538 .cindex "SMTP" "rewriting malformed addresses"
24539 .cindex "RCPT" "rewriting argument of"
24540 .cindex "MAIL" "rewriting argument of"
24541 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24542 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24543 before any other processing; even before syntax checking. The pattern is
24544 required to be a regular expression, and it is matched against the whole of the
24545 data for the command, including any surrounding angle brackets.
24546
24547 .vindex "&$domain$&"
24548 .vindex "&$local_part$&"
24549 This form of rewrite rule allows for the handling of addresses that are not
24550 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24551 input). Because the input is not required to be a syntactically valid address,
24552 the variables &$local_part$& and &$domain$& are not available during the
24553 expansion of the replacement string. The result of rewriting replaces the
24554 original address in the MAIL or RCPT command.
24555
24556
24557 .section "Flags controlling the rewriting process" "SECID155"
24558 There are four flags which control the way the rewriting process works. These
24559 take effect only when a rule is invoked, that is, when the address is of the
24560 correct type (matches the flags) and matches the pattern:
24561
24562 .ilist
24563 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24564 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24565 absence of &"Q"& the rewritten address must always include a domain.
24566 .next
24567 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24568 even if no rewriting actually takes place because of a &"fail"& in the
24569 expansion. The &"q"& flag is not effective if the address is of the wrong type
24570 (does not match the flags) or does not match the pattern.
24571 .next
24572 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24573 address, up to ten times. It can be combined with the &"q"& flag, to stop
24574 rewriting once it fails to match (after at least one successful rewrite).
24575 .next
24576 .cindex "rewriting" "whole addresses"
24577 When an address in a header is rewritten, the rewriting normally applies only
24578 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24579 left unchanged. For example, rewriting might change
24580 .code
24581 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24582 .endd
24583 into
24584 .code
24585 From: Ford Prefect <prefectf@hitch.fict.example>
24586 .endd
24587 .cindex "RFC 2047"
24588 Sometimes there is a need to replace the whole address item, and this can be
24589 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24590 causes an address in a header line to be rewritten, the entire address is
24591 replaced, not just the working part. The replacement must be a complete RFC
24592 2822 address, including the angle brackets if necessary. If text outside angle
24593 brackets contains a character whose value is greater than 126 or less than 32
24594 (except for tab), the text is encoded according to RFC 2047. The character set
24595 is taken from &%headers_charset%&, which gets its default at build time.
24596
24597 When the &"w"& flag is set on a rule that causes an envelope address to be
24598 rewritten, all but the working part of the replacement address is discarded.
24599 .endlist
24600
24601
24602 .section "Rewriting examples" "SECID156"
24603 Here is an example of the two common rewriting paradigms:
24604 .code
24605 *@*.hitch.fict.example  $1@hitch.fict.example
24606 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24607                      {$value}fail}@hitch.fict.example bctfrF
24608 .endd
24609 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24610 the string expansion to fail if the lookup does not succeed. In this context it
24611 has the effect of leaving the original address unchanged, but Exim goes on to
24612 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24613 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24614 explicitly, which would cause the rewritten address to be the same as before,
24615 at the cost of a small bit of processing. Not supplying either of these is an
24616 error, since the rewritten address would then contain no local part.
24617
24618 The first example above replaces the domain with a superior, more general
24619 domain. This may not be desirable for certain local parts. If the rule
24620 .code
24621 root@*.hitch.fict.example  *
24622 .endd
24623 were inserted before the first rule, rewriting would be suppressed for the
24624 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24625
24626 Rewriting can be made conditional on a number of tests, by making use of
24627 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24628 messages that originate outside the local host:
24629 .code
24630 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24631                          {$1@hitch.fict.example}fail}"
24632 .endd
24633 The replacement string is quoted in this example because it contains white
24634 space.
24635
24636 .cindex "rewriting" "bang paths"
24637 .cindex "bang paths" "rewriting"
24638 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24639 an address it treats it as an unqualified local part which it qualifies with
24640 the local qualification domain (if the source of the message is local or if the
24641 remote host is permitted to send unqualified addresses). Rewriting can
24642 sometimes be used to handle simple bang paths with a fixed number of
24643 components. For example, the rule
24644 .code
24645 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24646 .endd
24647 rewrites a two-component bang path &'host.name!user'& as the domain address
24648 &'user@host.name'&. However, there is a security implication in using this as
24649 a global rewriting rule for envelope addresses. It can provide a backdoor
24650 method for using your system as a relay, because the incoming addresses appear
24651 to be local. If the bang path addresses are received via SMTP, it is safer to
24652 use the &"S"& flag to rewrite them as they are received, so that relay checking
24653 can be done on the rewritten addresses.
24654 .ecindex IIDaddrew
24655
24656
24657
24658
24659
24660 . ////////////////////////////////////////////////////////////////////////////
24661 . ////////////////////////////////////////////////////////////////////////////
24662
24663 .chapter "Retry configuration" "CHAPretry"
24664 .scindex IIDretconf1 "retry" "configuration, description of"
24665 .scindex IIDregconf2 "configuration file" "retry section"
24666 The &"retry"& section of the runtime configuration file contains a list of
24667 retry rules that control how often Exim tries to deliver messages that cannot
24668 be delivered at the first attempt. If there are no retry rules (the section is
24669 empty or not present), there are no retries. In this situation, temporary
24670 errors are treated as permanent. The default configuration contains a single,
24671 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24672 line option can be used to test which retry rule will be used for a given
24673 address, domain and error.
24674
24675 The most common cause of retries is temporary failure to deliver to a remote
24676 host because the host is down, or inaccessible because of a network problem.
24677 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24678 address) basis, not on a per-message basis. Thus, if one message has recently
24679 been delayed, delivery of a new message to the same host is not immediately
24680 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24681 log selector is set, the message
24682 .cindex "retry" "time not reached"
24683 &"retry time not reached"& is written to the main log whenever a delivery is
24684 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24685 the handling of errors during remote deliveries.
24686
24687 Retry processing applies to routing as well as to delivering, except as covered
24688 in the next paragraph. The retry rules do not distinguish between these
24689 actions. It is not possible, for example, to specify different behaviour for
24690 failures to route the domain &'snark.fict.example'& and failures to deliver to
24691 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24692 added complication, so did not implement it. However, although they share the
24693 same retry rule, the actual retry times for routing and transporting a given
24694 domain are maintained independently.
24695
24696 When a delivery is not part of a queue run (typically an immediate delivery on
24697 receipt of a message), the routers are always run, and local deliveries are
24698 always attempted, even if retry times are set for them. This makes for better
24699 behaviour if one particular message is causing problems (for example, causing
24700 quota overflow, or provoking an error in a filter file). If such a delivery
24701 suffers a temporary failure, the retry data is updated as normal, and
24702 subsequent delivery attempts from queue runs occur only when the retry time for
24703 the local address is reached.
24704
24705 .section "Changing retry rules" "SECID157"
24706 If you change the retry rules in your configuration, you should consider
24707 whether or not to delete the retry data that is stored in Exim's spool area in
24708 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24709 always safe; that is why they are called &"hints"&.
24710
24711 The hints retry data contains suggested retry times based on the previous
24712 rules. In the case of a long-running problem with a remote host, it might
24713 record the fact that the host has timed out. If your new rules increase the
24714 timeout time for such a host, you should definitely remove the old retry data
24715 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24716 messages that it should now be retaining.
24717
24718
24719
24720 .section "Format of retry rules" "SECID158"
24721 .cindex "retry" "rules"
24722 Each retry rule occupies one line and consists of three or four parts,
24723 separated by white space: a pattern, an error name, an optional list of sender
24724 addresses, and a list of retry parameters. The pattern and sender lists must be
24725 enclosed in double quotes if they contain white space. The rules are searched
24726 in order until one is found where the pattern, error name, and sender list (if
24727 present) match the failing host or address, the error that occurred, and the
24728 message's sender, respectively.
24729
24730
24731 The pattern is any single item that may appear in an address list (see section
24732 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24733 which means that it is expanded before being tested against the address that
24734 has been delayed. A negated address list item is permitted. Address
24735 list processing treats a plain domain name as if it were preceded by &"*@"&,
24736 which makes it possible for many retry rules to start with just a domain. For
24737 example,
24738 .code
24739 lookingglass.fict.example        *  F,24h,30m;
24740 .endd
24741 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24742 whereas
24743 .code
24744 alice@lookingglass.fict.example  *  F,24h,30m;
24745 .endd
24746 applies only to temporary failures involving the local part &%alice%&.
24747 In practice, almost all rules start with a domain name pattern without a local
24748 part.
24749
24750 .cindex "regular expressions" "in retry rules"
24751 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24752 must match a complete address, not just a domain, because that is how regular
24753 expressions work in address lists.
24754 .display
24755 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24756 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24757 .endd
24758
24759
24760 .section "Choosing which retry rule to use for address errors" "SECID159"
24761 When Exim is looking for a retry rule after a routing attempt has failed (for
24762 example, after a DNS timeout), each line in the retry configuration is tested
24763 against the complete address only if &%retry_use_local_part%& is set for the
24764 router. Otherwise, only the domain is used, except when matching against a
24765 regular expression, when the local part of the address is replaced with &"*"&.
24766 A domain on its own can match a domain pattern, or a pattern that starts with
24767 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24768 &%check_local_user%& is true, and false for other routers.
24769
24770 Similarly, when Exim is looking for a retry rule after a local delivery has
24771 failed (for example, after a mailbox full error), each line in the retry
24772 configuration is tested against the complete address only if
24773 &%retry_use_local_part%& is set for the transport (it defaults true for all
24774 local transports).
24775
24776 .cindex "4&'xx'& responses" "retry rules for"
24777 However, when Exim is looking for a retry rule after a remote delivery attempt
24778 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24779 whole address is always used as the key when searching the retry rules. The
24780 rule that is found is used to create a retry time for the combination of the
24781 failing address and the message's sender. It is the combination of sender and
24782 recipient that is delayed in subsequent queue runs until its retry time is
24783 reached. You can delay the recipient without regard to the sender by setting
24784 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24785 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24786 commands.
24787
24788
24789
24790 .section "Choosing which retry rule to use for host and message errors" &&&
24791          "SECID160"
24792 For a temporary error that is not related to an individual address (for
24793 example, a connection timeout), each line in the retry configuration is checked
24794 twice. First, the name of the remote host is used as a domain name (preceded by
24795 &"*@"& when matching a regular expression). If this does not match the line,
24796 the domain from the email address is tried in a similar fashion. For example,
24797 suppose the MX records for &'a.b.c.example'& are
24798 .code
24799 a.b.c.example  MX  5  x.y.z.example
24800                MX  6  p.q.r.example
24801                MX  7  m.n.o.example
24802 .endd
24803 and the retry rules are
24804 .code
24805 p.q.r.example    *      F,24h,30m;
24806 a.b.c.example    *      F,4d,45m;
24807 .endd
24808 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24809 first rule matches neither the host nor the domain, so Exim looks at the second
24810 rule. This does not match the host, but it does match the domain, so it is used
24811 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24812 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24813 first retry rule is used, because it matches the host.
24814
24815 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24816 first rule to determine retry times, but for all the other hosts for the domain
24817 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24818 routing to &'a.b.c.example'& suffers a temporary failure.
24819
24820 &*Note*&: The host name is used when matching the patterns, not its IP address.
24821 However, if a message is routed directly to an IP address without the use of a
24822 host name, for example, if a &(manualroute)& router contains a setting such as:
24823 .code
24824 route_list = *.a.example  192.168.34.23
24825 .endd
24826 then the &"host name"& that is used when searching for a retry rule is the
24827 textual form of the IP address.
24828
24829 .section "Retry rules for specific errors" "SECID161"
24830 .cindex "retry" "specific errors; specifying"
24831 The second field in a retry rule is the name of a particular error, or an
24832 asterisk, which matches any error. The errors that can be tested for are:
24833
24834 .vlist
24835 .vitem &%auth_failed%&
24836 Authentication failed when trying to send to a host in the
24837 &%hosts_require_auth%& list in an &(smtp)& transport.
24838
24839 .vitem &%data_4xx%&
24840 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24841 after the command, or after sending the message's data.
24842
24843 .vitem &%mail_4xx%&
24844 A 4&'xx'& error was received for an outgoing MAIL command.
24845
24846 .vitem &%rcpt_4xx%&
24847 A 4&'xx'& error was received for an outgoing RCPT command.
24848 .endlist
24849
24850 For the three 4&'xx'& errors, either the first or both of the x's can be given
24851 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24852 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24853 and have retries every ten minutes with a one-hour timeout, you could set up a
24854 retry rule of this form:
24855 .code
24856 the.domain.name  rcpt_452   F,1h,10m
24857 .endd
24858 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24859 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24860
24861 .vlist
24862 .vitem &%lost_connection%&
24863 A server unexpectedly closed the SMTP connection. There may, of course,
24864 legitimate reasons for this (host died, network died), but if it repeats a lot
24865 for the same host, it indicates something odd.
24866
24867 .vitem &%lookup%&
24868 A DNS lookup for a host failed.
24869 Note that a &%dnslookup%& router will need to have matched
24870 its &%fail_defer_domains%& option for this retry type to be usable.
24871 Also note that a &%manualroute%& router will probably need
24872 its &%host_find_failed%& option set to &%defer%&.
24873
24874 .vitem &%refused_MX%&
24875 A connection to a host obtained from an MX record was refused.
24876
24877 .vitem &%refused_A%&
24878 A connection to a host not obtained from an MX record was refused.
24879
24880 .vitem &%refused%&
24881 A connection was refused.
24882
24883 .vitem &%timeout_connect_MX%&
24884 A connection attempt to a host obtained from an MX record timed out.
24885
24886 .vitem &%timeout_connect_A%&
24887 A connection attempt to a host not obtained from an MX record timed out.
24888
24889 .vitem &%timeout_connect%&
24890 A connection attempt timed out.
24891
24892 .vitem &%timeout_MX%&
24893 There was a timeout while connecting or during an SMTP session with a host
24894 obtained from an MX record.
24895
24896 .vitem &%timeout_A%&
24897 There was a timeout while connecting or during an SMTP session with a host not
24898 obtained from an MX record.
24899
24900 .vitem &%timeout%&
24901 There was a timeout while connecting or during an SMTP session.
24902
24903 .vitem &%tls_required%&
24904 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24905 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24906 to STARTTLS, or there was a problem setting up the TLS connection.
24907
24908 .vitem &%quota%&
24909 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24910 transport.
24911
24912 .vitem &%quota_%&<&'time'&>
24913 .cindex "quota" "error testing in retry rule"
24914 .cindex "retry" "quota error testing"
24915 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24916 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24917 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24918 for four days.
24919 .endlist
24920
24921 .cindex "mailbox" "time of last read"
24922 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24923 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24924 it should be based on the last time that the user accessed the mailbox.
24925 However, it is not always possible to determine this. Exim uses the following
24926 heuristic rules:
24927
24928 .ilist
24929 If the mailbox is a single file, the time of last access (the &"atime"&) is
24930 used. As no new messages are being delivered (because the mailbox is over
24931 quota), Exim does not access the file, so this is the time of last user access.
24932 .next
24933 .cindex "maildir format" "time of last read"
24934 For a maildir delivery, the time of last modification of the &_new_&
24935 subdirectory is used. As the mailbox is over quota, no new files are created in
24936 the &_new_& subdirectory, because no new messages are being delivered. Any
24937 change to the &_new_& subdirectory is therefore assumed to be the result of an
24938 MUA moving a new message to the &_cur_& directory when it is first read. The
24939 time that is used is therefore the last time that the user read a new message.
24940 .next
24941 For other kinds of multi-file mailbox, the time of last access cannot be
24942 obtained, so a retry rule that uses this type of error field is never matched.
24943 .endlist
24944
24945 The quota errors apply both to system-enforced quotas and to Exim's own quota
24946 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24947 when a local delivery is deferred because a partition is full (the ENOSPC
24948 error).
24949
24950
24951
24952 .section "Retry rules for specified senders" "SECID162"
24953 .cindex "retry" "rules; sender-specific"
24954 You can specify retry rules that apply only when the failing message has a
24955 specific sender. In particular, this can be used to define retry rules that
24956 apply only to bounce messages. The third item in a retry rule can be of this
24957 form:
24958 .display
24959 &`senders=`&<&'address list'&>
24960 .endd
24961 The retry timings themselves are then the fourth item. For example:
24962 .code
24963 *   rcpt_4xx   senders=:   F,1h,30m
24964 .endd
24965 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24966 host. If the address list contains white space, it must be enclosed in quotes.
24967 For example:
24968 .code
24969 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24970 .endd
24971 &*Warning*&: This facility can be unhelpful if it is used for host errors
24972 (which do not depend on the recipient). The reason is that the sender is used
24973 only to match the retry rule. Once the rule has been found for a host error,
24974 its contents are used to set a retry time for the host, and this will apply to
24975 all messages, not just those with specific senders.
24976
24977 When testing retry rules using &%-brt%&, you can supply a sender using the
24978 &%-f%& command line option, like this:
24979 .code
24980 exim -f "" -brt user@dom.ain
24981 .endd
24982 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24983 list is never matched.
24984
24985
24986
24987
24988
24989 .section "Retry parameters" "SECID163"
24990 .cindex "retry" "parameters in rules"
24991 The third (or fourth, if a senders list is present) field in a retry rule is a
24992 sequence of retry parameter sets, separated by semicolons. Each set consists of
24993 .display
24994 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24995 .endd
24996 The letter identifies the algorithm for computing a new retry time; the cutoff
24997 time is the time beyond which this algorithm no longer applies, and the
24998 arguments vary the algorithm's action. The cutoff time is measured from the
24999 time that the first failure for the domain (combined with the local part if
25000 relevant) was detected, not from the time the message was received.
25001
25002 .cindex "retry" "algorithms"
25003 .cindex "retry" "fixed intervals"
25004 .cindex "retry" "increasing intervals"
25005 .cindex "retry" "random intervals"
25006 The available algorithms are:
25007
25008 .ilist
25009 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25010 the interval.
25011 .next
25012 &'G'&: retry at geometrically increasing intervals. The first argument
25013 specifies a starting value for the interval, and the second a multiplier, which
25014 is used to increase the size of the interval at each retry.
25015 .next
25016 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25017 retry, the previous interval is multiplied by the factor in order to get a
25018 maximum for the next interval. The minimum interval is the first argument of
25019 the parameter, and an actual interval is chosen randomly between them. Such a
25020 rule has been found to be helpful in cluster configurations when all the
25021 members of the cluster restart at once, and may therefore synchronize their
25022 queue processing times.
25023 .endlist
25024
25025 When computing the next retry time, the algorithm definitions are scanned in
25026 order until one whose cutoff time has not yet passed is reached. This is then
25027 used to compute a new retry time that is later than the current time. In the
25028 case of fixed interval retries, this simply means adding the interval to the
25029 current time. For geometrically increasing intervals, retry intervals are
25030 computed from the rule's parameters until one that is greater than the previous
25031 interval is found. The main configuration variable
25032 .cindex "limit" "retry interval"
25033 .cindex "retry" "interval, maximum"
25034 .oindex "&%retry_interval_max%&"
25035 &%retry_interval_max%& limits the maximum interval between retries. It
25036 cannot be set greater than &`24h`&, which is its default value.
25037
25038 A single remote domain may have a number of hosts associated with it, and each
25039 host may have more than one IP address. Retry algorithms are selected on the
25040 basis of the domain name, but are applied to each IP address independently. If,
25041 for example, a host has two IP addresses and one is unusable, Exim will
25042 generate retry times for it and will not try to use it until its next retry
25043 time comes. Thus the good IP address is likely to be tried first most of the
25044 time.
25045
25046 .cindex "hints database" "use for retrying"
25047 Retry times are hints rather than promises. Exim does not make any attempt to
25048 run deliveries exactly at the computed times. Instead, a queue runner process
25049 starts delivery processes for delayed messages periodically, and these attempt
25050 new deliveries only for those addresses that have passed their next retry time.
25051 If a new message arrives for a deferred address, an immediate delivery attempt
25052 occurs only if the address has passed its retry time. In the absence of new
25053 messages, the minimum time between retries is the interval between queue runner
25054 processes. There is not much point in setting retry times of five minutes if
25055 your queue runners happen only once an hour, unless there are a significant
25056 number of incoming messages (which might be the case on a system that is
25057 sending everything to a smart host, for example).
25058
25059 The data in the retry hints database can be inspected by using the
25060 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25061 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25062 &'exinext'& utility script can be used to find out what the next retry times
25063 are for the hosts associated with a particular mail domain, and also for local
25064 deliveries that have been deferred.
25065
25066
25067 .section "Retry rule examples" "SECID164"
25068 Here are some example retry rules:
25069 .code
25070 alice@wonderland.fict.example quota_5d  F,7d,3h
25071 wonderland.fict.example       quota_5d
25072 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25073 lookingglass.fict.example     *         F,24h,30m;
25074 *                 refused_A   F,2h,20m;
25075 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25076 .endd
25077 The first rule sets up special handling for mail to
25078 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25079 mailbox has not been read for at least 5 days. Retries continue every three
25080 hours for 7 days. The second rule handles over-quota errors for all other local
25081 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25082 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25083 fail are bounced immediately if the mailbox has not been read for at least 5
25084 days.
25085
25086 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25087 happen every 15 minutes for an hour, then with geometrically increasing
25088 intervals until two days have passed since a delivery first failed. After the
25089 first hour there is a delay of one hour, then two hours, then four hours, and
25090 so on (this is a rather extreme example).
25091
25092 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25093 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25094 all other domains, with special action for connection refusal from hosts that
25095 were not obtained from an MX record.
25096
25097 The final rule in a retry configuration should always have asterisks in the
25098 first two fields so as to provide a general catch-all for any addresses that do
25099 not have their own special handling. This example tries every 15 minutes for 2
25100 hours, then with intervals starting at one hour and increasing by a factor of
25101 1.5 up to 16 hours, then every 8 hours up to 5 days.
25102
25103
25104
25105 .section "Timeout of retry data" "SECID165"
25106 .cindex "timeout" "of retry data"
25107 .oindex "&%retry_data_expire%&"
25108 .cindex "hints database" "data expiry"
25109 .cindex "retry" "timeout of data"
25110 Exim timestamps the data that it writes to its retry hints database. When it
25111 consults the data during a delivery it ignores any that is older than the value
25112 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25113 been tried for 7 days, Exim will try to deliver to it immediately a message
25114 arrives, and if that fails, it will calculate a retry time as if it were
25115 failing for the first time.
25116
25117 This improves the behaviour for messages routed to rarely-used hosts such as MX
25118 backups. If such a host was down at one time, and happens to be down again when
25119 Exim tries a month later, using the old retry data would imply that it had been
25120 down all the time, which is not a justified assumption.
25121
25122 If a host really is permanently dead, this behaviour causes a burst of retries
25123 every now and again, but only if messages routed to it are rare. If there is a
25124 message at least once every 7 days the retry data never expires.
25125
25126
25127
25128
25129 .section "Long-term failures" "SECID166"
25130 .cindex "delivery failure, long-term"
25131 .cindex "retry" "after long-term failure"
25132 Special processing happens when an email address has been failing for so long
25133 that the cutoff time for the last algorithm is reached. For example, using the
25134 default retry rule:
25135 .code
25136 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25137 .endd
25138 the cutoff time is four days. Reaching the retry cutoff is independent of how
25139 long any specific message has been failing; it is the length of continuous
25140 failure for the recipient address that counts.
25141
25142 When the cutoff time is reached for a local delivery, or for all the IP
25143 addresses associated with a remote delivery, a subsequent delivery failure
25144 causes Exim to give up on the address, and a bounce message is generated.
25145 In order to cater for new messages that use the failing address, a next retry
25146 time is still computed from the final algorithm, and is used as follows:
25147
25148 For local deliveries, one delivery attempt is always made for any subsequent
25149 messages. If this delivery fails, the address fails immediately. The
25150 post-cutoff retry time is not used.
25151
25152 If the delivery is remote, there are two possibilities, controlled by the
25153 .oindex "&%delay_after_cutoff%&"
25154 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25155 default. Until the post-cutoff retry time for one of the IP addresses is
25156 reached, the failing email address is bounced immediately, without a delivery
25157 attempt taking place. After that time, one new delivery attempt is made to
25158 those IP addresses that are past their retry times, and if that still fails,
25159 the address is bounced and new retry times are computed.
25160
25161 In other words, when all the hosts for a given email address have been failing
25162 for a long time, Exim bounces rather then defers until one of the hosts' retry
25163 times is reached. Then it tries once, and bounces if that attempt fails. This
25164 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25165 to a broken destination, but if the host does recover, Exim will eventually
25166 notice.
25167
25168 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25169 addresses are past their final cutoff time, Exim tries to deliver to those IP
25170 addresses that have not been tried since the message arrived. If there are
25171 no suitable IP addresses, or if they all fail, the address is bounced. In other
25172 words, it does not delay when a new message arrives, but tries the expired
25173 addresses immediately, unless they have been tried since the message arrived.
25174 If there is a continuous stream of messages for the failing domains, setting
25175 &%delay_after_cutoff%& false means that there will be many more attempts to
25176 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25177 true.
25178
25179 .section "Deliveries that work intermittently" "SECID167"
25180 .cindex "retry" "intermittently working deliveries"
25181 Some additional logic is needed to cope with cases where a host is
25182 intermittently available, or when a message has some attribute that prevents
25183 its delivery when others to the same address get through. In this situation,
25184 because some messages are successfully delivered, the &"retry clock"& for the
25185 host or address keeps getting reset by the successful deliveries, and so
25186 failing messages remain on the queue for ever because the cutoff time is never
25187 reached.
25188
25189 Two exceptional actions are applied to prevent this happening. The first
25190 applies to errors that are related to a message rather than a remote host.
25191 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25192 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25193 commands, and quota failures. For this type of error, if a message's arrival
25194 time is earlier than the &"first failed"& time for the error, the earlier time
25195 is used when scanning the retry rules to decide when to try next and when to
25196 time out the address.
25197
25198 The exceptional second action applies in all cases. If a message has been on
25199 the queue for longer than the cutoff time of any applicable retry rule for a
25200 given address, a delivery is attempted for that address, even if it is not yet
25201 time, and if this delivery fails, the address is timed out. A new retry time is
25202 not computed in this case, so that other messages for the same address are
25203 considered immediately.
25204 .ecindex IIDretconf1
25205 .ecindex IIDregconf2
25206
25207
25208
25209
25210
25211
25212 . ////////////////////////////////////////////////////////////////////////////
25213 . ////////////////////////////////////////////////////////////////////////////
25214
25215 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25216 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25217 .scindex IIDauthconf2 "authentication"
25218 The &"authenticators"& section of Exim's run time configuration is concerned
25219 with SMTP authentication. This facility is an extension to the SMTP protocol,
25220 described in RFC 2554, which allows a client SMTP host to authenticate itself
25221 to a server. This is a common way for a server to recognize clients that are
25222 permitted to use it as a relay. SMTP authentication is not of relevance to the
25223 transfer of mail between servers that have no managerial connection with each
25224 other.
25225
25226 .cindex "AUTH" "description of"
25227 Very briefly, the way SMTP authentication works is as follows:
25228
25229 .ilist
25230 The server advertises a number of authentication &'mechanisms'& in response to
25231 the client's EHLO command.
25232 .next
25233 The client issues an AUTH command, naming a specific mechanism. The command
25234 may, optionally, contain some authentication data.
25235 .next
25236 The server may issue one or more &'challenges'&, to which the client must send
25237 appropriate responses. In simple authentication mechanisms, the challenges are
25238 just prompts for user names and passwords. The server does not have to issue
25239 any challenges &-- in some mechanisms the relevant data may all be transmitted
25240 with the AUTH command.
25241 .next
25242 The server either accepts or denies authentication.
25243 .next
25244 If authentication succeeds, the client may optionally make use of the AUTH
25245 option on the MAIL command to pass an authenticated sender in subsequent
25246 mail transactions. Authentication lasts for the remainder of the SMTP
25247 connection.
25248 .next
25249 If authentication fails, the client may give up, or it may try a different
25250 authentication mechanism, or it may try transferring mail over the
25251 unauthenticated connection.
25252 .endlist
25253
25254 If you are setting up a client, and want to know which authentication
25255 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25256 SMTP port) on the server, and issue an EHLO command. The response to this
25257 includes the list of supported mechanisms. For example:
25258 .display
25259 &`$ `&&*&`telnet server.example 25`&*&
25260 &`Trying 192.168.34.25...`&
25261 &`Connected to server.example.`&
25262 &`Escape character is &#x0027;^]&#x0027;.`&
25263 &`220 server.example ESMTP Exim 4.20 ...`&
25264 &*&`ehlo client.example`&*&
25265 &`250-server.example Hello client.example [10.8.4.5]`&
25266 &`250-SIZE 52428800`&
25267 &`250-PIPELINING`&
25268 &`250-AUTH PLAIN`&
25269 &`250 HELP`&
25270 .endd
25271 The second-last line of this example output shows that the server supports
25272 authentication using the PLAIN mechanism. In Exim, the different authentication
25273 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25274 routers and transports, which authenticators are included in the binary is
25275 controlled by build-time definitions. The following are currently available,
25276 included by setting
25277 .code
25278 AUTH_CRAM_MD5=yes
25279 AUTH_CYRUS_SASL=yes
25280 AUTH_DOVECOT=yes
25281 AUTH_GSASL=yes
25282 AUTH_HEIMDAL_GSSAPI=yes
25283 AUTH_PLAINTEXT=yes
25284 AUTH_SPA=yes
25285 AUTH_TLS=yes
25286 .endd
25287 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25288 authentication mechanism (RFC 2195), and the second provides an interface to
25289 the Cyrus SASL authentication library.
25290 The third is an interface to Dovecot's authentication system, delegating the
25291 work via a socket interface.
25292 The fourth provides an interface to the GNU SASL authentication library, which
25293 provides mechanisms but typically not data sources.
25294 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25295 supporting setting a server keytab.
25296 The sixth can be configured to support
25297 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25298 not formally documented, but used by several MUAs. The seventh authenticator
25299 supports Microsoft's &'Secure Password Authentication'& mechanism.
25300 The eighth is an Exim authenticator but not an SMTP one;
25301 instead it can use information from a TLS negotiation.
25302
25303 The authenticators are configured using the same syntax as other drivers (see
25304 section &<<SECTfordricon>>&). If no authenticators are required, no
25305 authentication section need be present in the configuration file. Each
25306 authenticator can in principle have both server and client functions. When Exim
25307 is receiving SMTP mail, it is acting as a server; when it is sending out
25308 messages over SMTP, it is acting as a client. Authenticator configuration
25309 options are provided for use in both these circumstances.
25310
25311 To make it clear which options apply to which situation, the prefixes
25312 &%server_%& and &%client_%& are used on option names that are specific to
25313 either the server or the client function, respectively. Server and client
25314 functions are disabled if none of their options are set. If an authenticator is
25315 to be used for both server and client functions, a single definition, using
25316 both sets of options, is required. For example:
25317 .code
25318 cram:
25319   driver = cram_md5
25320   public_name = CRAM-MD5
25321   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25322   client_name = ph10
25323   client_secret = secret2
25324 .endd
25325 The &%server_%& option is used when Exim is acting as a server, and the
25326 &%client_%& options when it is acting as a client.
25327
25328 Descriptions of the individual authenticators are given in subsequent chapters.
25329 The remainder of this chapter covers the generic options for the
25330 authenticators, followed by general discussion of the way authentication works
25331 in Exim.
25332
25333 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25334 per-mechanism basis.  Please read carefully to determine which variables hold
25335 account labels such as usercodes and which hold passwords or other
25336 authenticating data.
25337
25338 Note that some mechanisms support two different identifiers for accounts: the
25339 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25340 and &'authz'& are commonly encountered.  The American spelling is standard here.
25341 Conceptually, authentication data such as passwords are tied to the identifier
25342 used to authenticate; servers may have rules to permit one user to act as a
25343 second user, so that after login the session is treated as though that second
25344 user had logged in.  That second user is the &'authorization id'&.  A robust
25345 configuration might confirm that the &'authz'& field is empty or matches the
25346 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25347 as verified data, the &'authz'& as an unverified request which the server might
25348 choose to honour.
25349
25350 A &'realm'& is a text string, typically a domain name, presented by a server
25351 to a client to help it select an account and credentials to use.  In some
25352 mechanisms, the client and server provably agree on the realm, but clients
25353 typically can not treat the realm as secure data to be blindly trusted.
25354
25355
25356
25357 .section "Generic options for authenticators" "SECID168"
25358 .cindex "authentication" "generic options"
25359 .cindex "options" "generic; for authenticators"
25360
25361 .option client_condition authenticators string&!! unset
25362 When Exim is authenticating as a client, it skips any authenticator whose
25363 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25364 used, for example, to skip plain text authenticators when the connection is not
25365 encrypted by a setting such as:
25366 .code
25367 client_condition = ${if !eq{$tls_out_cipher}{}}
25368 .endd
25369
25370
25371 .option client_set_id authenticators string&!! unset
25372 When client authentication succeeds, this condition is expanded; the
25373 result is used in the log lines for outbound messages.
25374 Typically it will be the user name used for authentication.
25375
25376
25377 .option driver authenticators string unset
25378 This option must always be set. It specifies which of the available
25379 authenticators is to be used.
25380
25381
25382 .option public_name authenticators string unset
25383 This option specifies the name of the authentication mechanism that the driver
25384 implements, and by which it is known to the outside world. These names should
25385 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25386 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25387 defaults to the driver's instance name.
25388
25389
25390 .option server_advertise_condition authenticators string&!! unset
25391 When a server is about to advertise an authentication mechanism, the condition
25392 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25393 mechanism is not advertised.
25394 If the expansion fails, the mechanism is not advertised. If the failure was not
25395 forced, and was not caused by a lookup defer, the incident is logged.
25396 See section &<<SECTauthexiser>>& below for further discussion.
25397
25398
25399 .option server_condition authenticators string&!! unset
25400 This option must be set for a &%plaintext%& server authenticator, where it
25401 is used directly to control authentication. See section &<<SECTplainserver>>&
25402 for details.
25403
25404 For the &(gsasl)& authenticator, this option is required for various
25405 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25406
25407 For the other authenticators, &%server_condition%& can be used as an additional
25408 authentication or authorization mechanism that is applied after the other
25409 authenticator conditions succeed. If it is set, it is expanded when the
25410 authenticator would otherwise return a success code. If the expansion is forced
25411 to fail, authentication fails. Any other expansion failure causes a temporary
25412 error code to be returned. If the result of a successful expansion is an empty
25413 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25414 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25415 other result, a temporary error code is returned, with the expanded string as
25416 the error text.
25417
25418
25419 .option server_debug_print authenticators string&!! unset
25420 If this option is set and authentication debugging is enabled (see the &%-d%&
25421 command line option), the string is expanded and included in the debugging
25422 output when the authenticator is run as a server. This can help with checking
25423 out the values of variables.
25424 If expansion of the string fails, the error message is written to the debugging
25425 output, and Exim carries on processing.
25426
25427
25428 .option server_set_id authenticators string&!! unset
25429 .vindex "&$authenticated_id$&"
25430 When an Exim server successfully authenticates a client, this string is
25431 expanded using data from the authentication, and preserved for any incoming
25432 messages in the variable &$authenticated_id$&. It is also included in the log
25433 lines for incoming messages. For example, a user/password authenticator
25434 configuration might preserve the user name that was used to authenticate, and
25435 refer to it subsequently during delivery of the message.
25436 If expansion fails, the option is ignored.
25437
25438
25439 .option server_mail_auth_condition authenticators string&!! unset
25440 This option allows a server to discard authenticated sender addresses supplied
25441 as part of MAIL commands in SMTP connections that are authenticated by the
25442 driver on which &%server_mail_auth_condition%& is set. The option is not used
25443 as part of the authentication process; instead its (unexpanded) value is
25444 remembered for later use.
25445 How it is used is described in the following section.
25446
25447
25448
25449
25450
25451 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25452 .cindex "authentication" "sender; authenticated"
25453 .cindex "AUTH" "on MAIL command"
25454 When a client supplied an AUTH= item on a MAIL command, Exim applies
25455 the following checks before accepting it as the authenticated sender of the
25456 message:
25457
25458 .ilist
25459 If the connection is not using extended SMTP (that is, HELO was used rather
25460 than EHLO), the use of AUTH= is a syntax error.
25461 .next
25462 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25463 .next
25464 .vindex "&$authenticated_sender$&"
25465 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25466 running, the value of &$authenticated_sender$& is set to the value obtained
25467 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25468 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25469 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25470 given for the MAIL command.
25471 .next
25472 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25473 is accepted and placed in &$authenticated_sender$& only if the client has
25474 authenticated.
25475 .next
25476 If the AUTH= value was accepted by either of the two previous rules, and
25477 the client has authenticated, and the authenticator has a setting for the
25478 &%server_mail_auth_condition%&, the condition is checked at this point. The
25479 valued that was saved from the authenticator is expanded. If the expansion
25480 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25481 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25482 the value of &$authenticated_sender$& is retained and passed on with the
25483 message.
25484 .endlist
25485
25486
25487 When &$authenticated_sender$& is set for a message, it is passed on to other
25488 hosts to which Exim authenticates as a client. Do not confuse this value with
25489 &$authenticated_id$&, which is a string obtained from the authentication
25490 process, and which is not usually a complete email address.
25491
25492 .vindex "&$sender_address$&"
25493 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25494 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25495 therefore make use of &$authenticated_sender$&. The converse is not true: the
25496 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25497 ACL is run.
25498
25499
25500
25501 .section "Authentication on an Exim server" "SECTauthexiser"
25502 .cindex "authentication" "on an Exim server"
25503 When Exim receives an EHLO command, it advertises the public names of those
25504 authenticators that are configured as servers, subject to the following
25505 conditions:
25506
25507 .ilist
25508 The client host must match &%auth_advertise_hosts%& (default *).
25509 .next
25510 It the &%server_advertise_condition%& option is set, its expansion must not
25511 yield the empty string, &"0"&, &"no"&, or &"false"&.
25512 .endlist
25513
25514 The order in which the authenticators are defined controls the order in which
25515 the mechanisms are advertised.
25516
25517 Some mail clients (for example, some versions of Netscape) require the user to
25518 provide a name and password for authentication whenever AUTH is advertised,
25519 even though authentication may not in fact be needed (for example, Exim may be
25520 set up to allow unconditional relaying from the client by an IP address check).
25521 You can make such clients more friendly by not advertising AUTH to them.
25522 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25523 that runs for RCPT) to relay without authentication, you should set
25524 .code
25525 auth_advertise_hosts = ! 10.9.8.0/24
25526 .endd
25527 so that no authentication mechanisms are advertised to them.
25528
25529 The &%server_advertise_condition%& controls the advertisement of individual
25530 authentication mechanisms. For example, it can be used to restrict the
25531 advertisement of a particular mechanism to encrypted connections, by a setting
25532 such as:
25533 .code
25534 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25535 .endd
25536 .vindex "&$tls_in_cipher$&"
25537 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25538 yields &"yes"&, which allows the advertisement to happen.
25539
25540 When an Exim server receives an AUTH command from a client, it rejects it
25541 immediately if AUTH was not advertised in response to an earlier EHLO
25542 command. This is the case if
25543
25544 .ilist
25545 The client host does not match &%auth_advertise_hosts%&; or
25546 .next
25547 No authenticators are configured with server options; or
25548 .next
25549 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25550 server authenticators.
25551 .endlist
25552
25553
25554 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25555 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25556 AUTH is accepted from any client host.
25557
25558 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25559 server authentication mechanism that was advertised in response to EHLO and
25560 that matches the one named in the AUTH command. If it finds one, it runs
25561 the appropriate authentication protocol, and authentication either succeeds or
25562 fails. If there is no matching advertised mechanism, the AUTH command is
25563 rejected with a 504 error.
25564
25565 .vindex "&$received_protocol$&"
25566 .vindex "&$sender_host_authenticated$&"
25567 When a message is received from an authenticated host, the value of
25568 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25569 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25570 public name) of the authenticator driver that successfully authenticated the
25571 client from which the message was received. This variable is empty if there was
25572 no successful authentication.
25573
25574
25575
25576
25577 .section "Testing server authentication" "SECID169"
25578 .cindex "authentication" "testing a server"
25579 .cindex "AUTH" "testing a server"
25580 .cindex "base64 encoding" "creating authentication test data"
25581 Exim's &%-bh%& option can be useful for testing server authentication
25582 configurations. The data for the AUTH command has to be sent using base64
25583 encoding. A quick way to produce such data for testing is the following Perl
25584 script:
25585 .code
25586 use MIME::Base64;
25587 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25588 .endd
25589 .cindex "binary zero" "in authentication data"
25590 This interprets its argument as a Perl string, and then encodes it. The
25591 interpretation as a Perl string allows binary zeros, which are required for
25592 some kinds of authentication, to be included in the data. For example, a
25593 command line to run this script on such data might be
25594 .code
25595 encode '\0user\0password'
25596 .endd
25597 Note the use of single quotes to prevent the shell interpreting the
25598 backslashes, so that they can be interpreted by Perl to specify characters
25599 whose code value is zero.
25600
25601 &*Warning 1*&: If either of the user or password strings starts with an octal
25602 digit, you must use three zeros instead of one after the leading backslash. If
25603 you do not, the octal digit that starts your string will be incorrectly
25604 interpreted as part of the code for the first character.
25605
25606 &*Warning 2*&: If there are characters in the strings that Perl interprets
25607 specially, you must use a Perl escape to prevent them being misinterpreted. For
25608 example, a command such as
25609 .code
25610 encode '\0user@domain.com\0pas$$word'
25611 .endd
25612 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25613
25614 If you have the &%mimencode%& command installed, another way to do produce
25615 base64-encoded strings is to run the command
25616 .code
25617 echo -e -n `\0user\0password' | mimencode
25618 .endd
25619 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25620 in the argument, and the &%-n%& option specifies no newline at the end of its
25621 output. However, not all versions of &%echo%& recognize these options, so you
25622 should check your version before relying on this suggestion.
25623
25624
25625
25626 .section "Authentication by an Exim client" "SECID170"
25627 .cindex "authentication" "on an Exim client"
25628 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25629 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25630 announces support for authentication, and the host matches an entry in either
25631 of these options, Exim (as a client) tries to authenticate as follows:
25632
25633 .ilist
25634 For each authenticator that is configured as a client, in the order in which
25635 they are defined in the configuration, it searches the authentication
25636 mechanisms announced by the server for one whose name matches the public name
25637 of the authenticator.
25638 .next
25639 .vindex "&$host$&"
25640 .vindex "&$host_address$&"
25641 When it finds one that matches, it runs the authenticator's client code. The
25642 variables &$host$& and &$host_address$& are available for any string expansions
25643 that the client might do. They are set to the server's name and IP address. If
25644 any expansion is forced to fail, the authentication attempt is abandoned, and
25645 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25646 delivery to be deferred.
25647 .next
25648 If the result of the authentication attempt is a temporary error or a timeout,
25649 Exim abandons trying to send the message to the host for the moment. It will
25650 try again later. If there are any backup hosts available, they are tried in the
25651 usual way.
25652 .next
25653 If the response to authentication is a permanent error (5&'xx'& code), Exim
25654 carries on searching the list of authenticators and tries another one if
25655 possible. If all authentication attempts give permanent errors, or if there are
25656 no attempts because no mechanisms match (or option expansions force failure),
25657 what happens depends on whether the host matches &%hosts_require_auth%& or
25658 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25659 delivery is deferred. The error can be detected in the retry rules, and thereby
25660 turned into a permanent error if you wish. In the second case, Exim tries to
25661 deliver the message unauthenticated.
25662 .endlist
25663
25664 .cindex "AUTH" "on MAIL command"
25665 When Exim has authenticated itself to a remote server, it adds the AUTH
25666 parameter to the MAIL commands it sends, if it has an authenticated sender for
25667 the message. If the message came from a remote host, the authenticated sender
25668 is the one that was receiving on an incoming MAIL command, provided that the
25669 incoming connection was authenticated and the &%server_mail_auth%& condition
25670 allowed the authenticated sender to be retained. If a local process calls Exim
25671 to send a message, the sender address that is built from the login name and
25672 &%qualify_domain%& is treated as authenticated. However, if the
25673 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25674 the authenticated sender that was received with the message.
25675 .ecindex IIDauthconf1
25676 .ecindex IIDauthconf2
25677
25678
25679
25680
25681
25682
25683 . ////////////////////////////////////////////////////////////////////////////
25684 . ////////////////////////////////////////////////////////////////////////////
25685
25686 .chapter "The plaintext authenticator" "CHAPplaintext"
25687 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25688 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25689 The &(plaintext)& authenticator can be configured to support the PLAIN and
25690 LOGIN authentication mechanisms, both of which transfer authentication data as
25691 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25692 security risk; you are strongly advised to insist on the use of SMTP encryption
25693 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25694 use unencrypted plain text, you should not use the same passwords for SMTP
25695 connections as you do for login accounts.
25696
25697 .section "Plaintext options" "SECID171"
25698 .cindex "options" "&(plaintext)& authenticator (server)"
25699 When configured as a server, &(plaintext)& uses the following options:
25700
25701 .option server_condition authenticators string&!! unset
25702 This is actually a global authentication option, but it must be set in order to
25703 configure the &(plaintext)& driver as a server. Its use is described below.
25704
25705 .option server_prompts plaintext string&!! unset
25706 The contents of this option, after expansion, must be a colon-separated list of
25707 prompt strings. If expansion fails, a temporary authentication rejection is
25708 given.
25709
25710 .section "Using plaintext in a server" "SECTplainserver"
25711 .cindex "AUTH" "in &(plaintext)& authenticator"
25712 .cindex "binary zero" "in &(plaintext)& authenticator"
25713 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25714         "in &(plaintext)& authenticator"
25715 .vindex "&$auth1$&, &$auth2$&, etc"
25716 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25717
25718 When running as a server, &(plaintext)& performs the authentication test by
25719 expanding a string. The data sent by the client with the AUTH command, or in
25720 response to subsequent prompts, is base64 encoded, and so may contain any byte
25721 values when decoded. If any data is supplied with the command, it is treated as
25722 a list of strings, separated by NULs (binary zeros), the first three of which
25723 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25724 (neither LOGIN nor PLAIN uses more than three strings).
25725
25726 For compatibility with previous releases of Exim, the values are also placed in
25727 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25728 variables for this purpose is now deprecated, as it can lead to confusion in
25729 string expansions that also use them for other things.
25730
25731 If there are more strings in &%server_prompts%& than the number of strings
25732 supplied with the AUTH command, the remaining prompts are used to obtain more
25733 data. Each response from the client may be a list of NUL-separated strings.
25734
25735 .vindex "&$authenticated_id$&"
25736 Once a sufficient number of data strings have been received,
25737 &%server_condition%& is expanded. If the expansion is forced to fail,
25738 authentication fails. Any other expansion failure causes a temporary error code
25739 to be returned. If the result of a successful expansion is an empty string,
25740 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25741 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25742 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25743 For any other result, a temporary error code is returned, with the expanded
25744 string as the error text
25745
25746 &*Warning*&: If you use a lookup in the expansion to find the user's
25747 password, be sure to make the authentication fail if the user is unknown.
25748 There are good and bad examples at the end of the next section.
25749
25750
25751
25752 .section "The PLAIN authentication mechanism" "SECID172"
25753 .cindex "PLAIN authentication mechanism"
25754 .cindex "authentication" "PLAIN mechanism"
25755 .cindex "binary zero" "in &(plaintext)& authenticator"
25756 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25757 sent as one item of data (that is, one combined string containing two NUL
25758 separators). The data is sent either as part of the AUTH command, or
25759 subsequently in response to an empty prompt from the server.
25760
25761 The second and third strings are a user name and a corresponding password.
25762 Using a single fixed user name and password as an example, this could be
25763 configured as follows:
25764 .code
25765 fixed_plain:
25766   driver = plaintext
25767   public_name = PLAIN
25768   server_prompts = :
25769   server_condition = \
25770     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25771   server_set_id = $auth2
25772 .endd
25773 Note that the default result strings from &%if%& (&"true"& or an empty string)
25774 are exactly what we want here, so they need not be specified. Obviously, if the
25775 password contains expansion-significant characters such as dollar, backslash,
25776 or closing brace, they have to be escaped.
25777
25778 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25779 the end of a string list are ignored). If all the data comes as part of the
25780 AUTH command, as is commonly the case, the prompt is not used. This
25781 authenticator is advertised in the response to EHLO as
25782 .code
25783 250-AUTH PLAIN
25784 .endd
25785 and a client host can authenticate itself by sending the command
25786 .code
25787 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25788 .endd
25789 As this contains three strings (more than the number of prompts), no further
25790 data is required from the client. Alternatively, the client may just send
25791 .code
25792 AUTH PLAIN
25793 .endd
25794 to initiate authentication, in which case the server replies with an empty
25795 prompt. The client must respond with the combined data string.
25796
25797 The data string is base64 encoded, as required by the RFC. This example,
25798 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25799 represents a zero byte. This is split up into three strings, the first of which
25800 is empty. The &%server_condition%& option in the authenticator checks that the
25801 second two are &`username`& and &`mysecret`& respectively.
25802
25803 Having just one fixed user name and password, as in this example, is not very
25804 realistic, though for a small organization with only a handful of
25805 authenticating clients it could make sense.
25806
25807 A more sophisticated instance of this authenticator could use the user name in
25808 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25809 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25810 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25811 This is an incorrect example:
25812 .code
25813 server_condition = \
25814   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25815 .endd
25816 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25817 which it then compares to the supplied password (&$auth3$&). Why is this example
25818 incorrect? It works fine for existing users, but consider what happens if a
25819 non-existent user name is given. The lookup fails, but as no success/failure
25820 strings are given for the lookup, it yields an empty string. Thus, to defeat
25821 the authentication, all a client has to do is to supply a non-existent user
25822 name and an empty password. The correct way of writing this test is:
25823 .code
25824 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25825   {${if eq{$value}{$auth3}}} {false}}
25826 .endd
25827 In this case, if the lookup succeeds, the result is checked; if the lookup
25828 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25829 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25830 always fails if its second argument is empty. However, the second way of
25831 writing the test makes the logic clearer.
25832
25833
25834 .section "The LOGIN authentication mechanism" "SECID173"
25835 .cindex "LOGIN authentication mechanism"
25836 .cindex "authentication" "LOGIN mechanism"
25837 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25838 in a number of programs. No data is sent with the AUTH command. Instead, a
25839 user name and password are supplied separately, in response to prompts. The
25840 plaintext authenticator can be configured to support this as in this example:
25841 .code
25842 fixed_login:
25843   driver = plaintext
25844   public_name = LOGIN
25845   server_prompts = User Name : Password
25846   server_condition = \
25847     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25848   server_set_id = $auth1
25849 .endd
25850 Because of the way plaintext operates, this authenticator accepts data supplied
25851 with the AUTH command (in contravention of the specification of LOGIN), but
25852 if the client does not supply it (as is the case for LOGIN clients), the prompt
25853 strings are used to obtain two data items.
25854
25855 Some clients are very particular about the precise text of the prompts. For
25856 example, Outlook Express is reported to recognize only &"Username:"& and
25857 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25858 strings. It uses the &%ldapauth%& expansion condition to check the user
25859 name and password by binding to an LDAP server:
25860 .code
25861 login:
25862   driver = plaintext
25863   public_name = LOGIN
25864   server_prompts = Username:: : Password::
25865   server_condition = ${if and{{ \
25866     !eq{}{$auth1} }{ \
25867     ldapauth{\
25868       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25869       pass=${quote:$auth2} \
25870       ldap://ldap.example.org/} }} }
25871   server_set_id = uid=$auth1,ou=people,o=example.org
25872 .endd
25873 We have to check that the username is not empty before using it, because LDAP
25874 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25875 operator to correctly quote the DN for authentication. However, the basic
25876 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25877 correct one to use for the password, because quoting is needed only to make
25878 the password conform to the Exim syntax. At the LDAP level, the password is an
25879 uninterpreted string.
25880
25881
25882 .section "Support for different kinds of authentication" "SECID174"
25883 A number of string expansion features are provided for the purpose of
25884 interfacing to different ways of user authentication. These include checking
25885 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25886 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25887 &<<SECTexpcond>>&.
25888
25889
25890
25891
25892 .section "Using plaintext in a client" "SECID175"
25893 .cindex "options" "&(plaintext)& authenticator (client)"
25894 The &(plaintext)& authenticator has two client options:
25895
25896 .option client_ignore_invalid_base64 plaintext boolean false
25897 If the client receives a server prompt that is not a valid base64 string,
25898 authentication is abandoned by default. However, if this option is set true,
25899 the error in the challenge is ignored and the client sends the response as
25900 usual.
25901
25902 .option client_send plaintext string&!! unset
25903 The string is a colon-separated list of authentication data strings. Each
25904 string is independently expanded before being sent to the server. The first
25905 string is sent with the AUTH command; any more strings are sent in response
25906 to prompts from the server. Before each string is expanded, the value of the
25907 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25908 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25909 way. Thus, the prompt that is received in response to sending the first string
25910 (with the AUTH command) can be used in the expansion of the second string, and
25911 so on. If an invalid base64 string is received when
25912 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25913 &$auth$&<&'n'&> variable.
25914
25915 &*Note*&: You cannot use expansion to create multiple strings, because
25916 splitting takes priority and happens first.
25917
25918 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25919 the data, further processing is applied to each string before it is sent. If
25920 there are any single circumflex characters in the string, they are converted to
25921 NULs. Should an actual circumflex be required as data, it must be doubled in
25922 the string.
25923
25924 This is an example of a client configuration that implements the PLAIN
25925 authentication mechanism with a fixed user name and password:
25926 .code
25927 fixed_plain:
25928   driver = plaintext
25929   public_name = PLAIN
25930   client_send = ^username^mysecret
25931 .endd
25932 The lack of colons means that the entire text is sent with the AUTH
25933 command, with the circumflex characters converted to NULs. A similar example
25934 that uses the LOGIN mechanism is:
25935 .code
25936 fixed_login:
25937   driver = plaintext
25938   public_name = LOGIN
25939   client_send = : username : mysecret
25940 .endd
25941 The initial colon means that the first string is empty, so no data is sent with
25942 the AUTH command itself. The remaining strings are sent in response to
25943 prompts.
25944 .ecindex IIDplaiauth1
25945 .ecindex IIDplaiauth2
25946
25947
25948
25949
25950 . ////////////////////////////////////////////////////////////////////////////
25951 . ////////////////////////////////////////////////////////////////////////////
25952
25953 .chapter "The cram_md5 authenticator" "CHID9"
25954 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25955 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25956 .cindex "CRAM-MD5 authentication mechanism"
25957 .cindex "authentication" "CRAM-MD5 mechanism"
25958 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25959 sends a challenge string to the client, and the response consists of a user
25960 name and the CRAM-MD5 digest of the challenge string combined with a secret
25961 string (password) which is known to both server and client. Thus, the secret
25962 is not sent over the network as plain text, which makes this authenticator more
25963 secure than &(plaintext)&. However, the downside is that the secret has to be
25964 available in plain text at either end.
25965
25966
25967 .section "Using cram_md5 as a server" "SECID176"
25968 .cindex "options" "&(cram_md5)& authenticator (server)"
25969 This authenticator has one server option, which must be set to configure the
25970 authenticator as a server:
25971
25972 .option server_secret cram_md5 string&!! unset
25973 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25974 When the server receives the client's response, the user name is placed in
25975 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25976 obtain the password for that user. The server then computes the CRAM-MD5 digest
25977 that the client should have sent, and checks that it received the correct
25978 string. If the expansion of &%server_secret%& is forced to fail, authentication
25979 fails. If the expansion fails for some other reason, a temporary error code is
25980 returned to the client.
25981
25982 For compatibility with previous releases of Exim, the user name is also placed
25983 in &$1$&. However, the use of this variables for this purpose is now
25984 deprecated, as it can lead to confusion in string expansions that also use
25985 numeric variables for other things.
25986
25987 For example, the following authenticator checks that the user name given by the
25988 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25989 user name, authentication fails.
25990 .code
25991 fixed_cram:
25992   driver = cram_md5
25993   public_name = CRAM-MD5
25994   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25995   server_set_id = $auth1
25996 .endd
25997 .vindex "&$authenticated_id$&"
25998 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25999 name in &$authenticated_id$&. A more typical configuration might look up the
26000 secret string in a file, using the user name as the key. For example:
26001 .code
26002 lookup_cram:
26003   driver = cram_md5
26004   public_name = CRAM-MD5
26005   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26006                   {$value}fail}
26007   server_set_id = $auth1
26008 .endd
26009 Note that this expansion explicitly forces failure if the lookup fails
26010 because &$auth1$& contains an unknown user name.
26011
26012 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26013 using the relevant libraries, you need to know the realm to specify in the
26014 lookup and then ask for the &"userPassword"& attribute for that user in that
26015 realm, with:
26016 .code
26017 cyrusless_crammd5:
26018   driver = cram_md5
26019   public_name = CRAM-MD5
26020   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26021                   dbmjz{/etc/sasldb2}{$value}fail}
26022   server_set_id = $auth1
26023 .endd
26024
26025 .section "Using cram_md5 as a client" "SECID177"
26026 .cindex "options" "&(cram_md5)& authenticator (client)"
26027 When used as a client, the &(cram_md5)& authenticator has two options:
26028
26029
26030
26031 .option client_name cram_md5 string&!! "the primary host name"
26032 This string is expanded, and the result used as the user name data when
26033 computing the response to the server's challenge.
26034
26035
26036 .option client_secret cram_md5 string&!! unset
26037 This option must be set for the authenticator to work as a client. Its value is
26038 expanded and the result used as the secret string when computing the response.
26039
26040
26041 .vindex "&$host$&"
26042 .vindex "&$host_address$&"
26043 Different user names and secrets can be used for different servers by referring
26044 to &$host$& or &$host_address$& in the options. Forced failure of either
26045 expansion string is treated as an indication that this authenticator is not
26046 prepared to handle this case. Exim moves on to the next configured client
26047 authenticator. Any other expansion failure causes Exim to give up trying to
26048 send the message to the current server.
26049
26050 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26051 strings, is:
26052 .code
26053 fixed_cram:
26054   driver = cram_md5
26055   public_name = CRAM-MD5
26056   client_name = ph10
26057   client_secret = secret
26058 .endd
26059 .ecindex IIDcramauth1
26060 .ecindex IIDcramauth2
26061
26062
26063
26064 . ////////////////////////////////////////////////////////////////////////////
26065 . ////////////////////////////////////////////////////////////////////////////
26066
26067 .chapter "The cyrus_sasl authenticator" "CHID10"
26068 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26069 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26070 .cindex "Cyrus" "SASL library"
26071 .cindex "Kerberos"
26072 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26073 Digital Ltd (&url(http://www.aldigital.co.uk)).
26074
26075 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26076 library implementation of the RFC 2222 (&"Simple Authentication and Security
26077 Layer"&). This library supports a number of authentication mechanisms,
26078 including PLAIN and LOGIN, but also several others that Exim does not support
26079 directly. In particular, there is support for Kerberos authentication.
26080
26081 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26082 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26083 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26084 name of the driver to determine which mechanism to support.
26085
26086 Where access to some kind of secret file is required, for example in GSSAPI
26087 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26088 user, and that the Cyrus SASL library has no way of escalating privileges
26089 by default. You may also find you need to set environment variables,
26090 depending on the driver you are using.
26091
26092 The application name provided by Exim is &"exim"&, so various SASL options may
26093 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26094 Kerberos, note that because of limitations in the GSSAPI interface,
26095 changing the server keytab might need to be communicated down to the Kerberos
26096 layer independently. The mechanism for doing so is dependent upon the Kerberos
26097 implementation.
26098
26099 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26100 may be set to point to an alternative keytab file. Exim will pass this
26101 variable through from its own inherited environment when started as root or the
26102 Exim user. The keytab file needs to be readable by the Exim user.
26103 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26104 environment variable.  In practice, for those releases, the Cyrus authenticator
26105 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26106 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26107
26108
26109 .section "Using cyrus_sasl as a server" "SECID178"
26110 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26111 (on a successful authentication) into &$auth1$&. For compatibility with
26112 previous releases of Exim, the username is also placed in &$1$&. However, the
26113 use of this variable for this purpose is now deprecated, as it can lead to
26114 confusion in string expansions that also use numeric variables for other
26115 things.
26116
26117
26118 .option server_hostname cyrus_sasl string&!! "see below"
26119 This option selects the hostname that is used when communicating with the
26120 library. The default value is &`$primary_hostname`&. It is up to the underlying
26121 SASL plug-in what it does with this data.
26122
26123
26124 .option server_mech cyrus_sasl string "see below"
26125 This option selects the authentication mechanism this driver should use. The
26126 default is the value of the generic &%public_name%& option. This option allows
26127 you to use a different underlying mechanism from the advertised name. For
26128 example:
26129 .code
26130 sasl:
26131   driver = cyrus_sasl
26132   public_name = X-ANYTHING
26133   server_mech = CRAM-MD5
26134   server_set_id = $auth1
26135 .endd
26136
26137 .option server_realm cyrus_sasl string&!! unset
26138 This specifies the SASL realm that the server claims to be in.
26139
26140
26141 .option server_service cyrus_sasl string &`smtp`&
26142 This is the SASL service that the server claims to implement.
26143
26144
26145 For straightforward cases, you do not need to set any of the authenticator's
26146 private options. All you need to do is to specify an appropriate mechanism as
26147 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26148 PLAIN, you could have two authenticators as follows:
26149 .code
26150 sasl_cram_md5:
26151   driver = cyrus_sasl
26152   public_name = CRAM-MD5
26153   server_set_id = $auth1
26154
26155 sasl_plain:
26156   driver = cyrus_sasl
26157   public_name = PLAIN
26158   server_set_id = $auth2
26159 .endd
26160 Cyrus SASL does implement the LOGIN authentication method, even though it is
26161 not a standard method. It is disabled by default in the source distribution,
26162 but it is present in many binary distributions.
26163 .ecindex IIDcyrauth1
26164 .ecindex IIDcyrauth2
26165
26166
26167
26168
26169 . ////////////////////////////////////////////////////////////////////////////
26170 . ////////////////////////////////////////////////////////////////////////////
26171 .chapter "The dovecot authenticator" "CHAPdovecot"
26172 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26173 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26174 This authenticator is an interface to the authentication facility of the
26175 Dovecot POP/IMAP server, which can support a number of authentication methods.
26176 Note that Dovecot must be configured to use auth-client not auth-userdb.
26177 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26178 to use the same mechanisms for SMTP authentication. This is a server
26179 authenticator only. There is only one option:
26180
26181 .option server_socket dovecot string unset
26182
26183 This option must specify the socket that is the interface to Dovecot
26184 authentication. The &%public_name%& option must specify an authentication
26185 mechanism that Dovecot is configured to support. You can have several
26186 authenticators for different mechanisms. For example:
26187 .code
26188 dovecot_plain:
26189   driver = dovecot
26190   public_name = PLAIN
26191   server_socket = /var/run/dovecot/auth-client
26192   server_set_id = $auth1
26193
26194 dovecot_ntlm:
26195   driver = dovecot
26196   public_name = NTLM
26197   server_socket = /var/run/dovecot/auth-client
26198   server_set_id = $auth1
26199 .endd
26200 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26201 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26202 option is passed in the Dovecot authentication command. If, for a TLS
26203 connection, a client certificate has been verified, the &"valid-client-cert"&
26204 option is passed. When authentication succeeds, the identity of the user
26205 who authenticated is placed in &$auth1$&.
26206 .ecindex IIDdcotauth1
26207 .ecindex IIDdcotauth2
26208
26209
26210 . ////////////////////////////////////////////////////////////////////////////
26211 . ////////////////////////////////////////////////////////////////////////////
26212 .chapter "The gsasl authenticator" "CHAPgsasl"
26213 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26214 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26215 .cindex "authentication" "GNU SASL"
26216 .cindex "authentication" "SASL"
26217 .cindex "authentication" "EXTERNAL"
26218 .cindex "authentication" "ANONYMOUS"
26219 .cindex "authentication" "PLAIN"
26220 .cindex "authentication" "LOGIN"
26221 .cindex "authentication" "DIGEST-MD5"
26222 .cindex "authentication" "CRAM-MD5"
26223 .cindex "authentication" "SCRAM-SHA-1"
26224 The &(gsasl)& authenticator provides server integration for the GNU SASL
26225 library and the mechanisms it provides.  This is new as of the 4.80 release
26226 and there are a few areas where the library does not let Exim smoothly
26227 scale to handle future authentication mechanisms, so no guarantee can be
26228 made that any particular new authentication mechanism will be supported
26229 without code changes in Exim.
26230
26231
26232 .option server_channelbinding gsasl boolean false
26233 Some authentication mechanisms are able to use external context at both ends
26234 of the session to bind the authentication to that context, and fail the
26235 authentication process if that context differs.  Specifically, some TLS
26236 ciphersuites can provide identifying information about the cryptographic
26237 context.
26238
26239 This means that certificate identity and verification becomes a non-issue,
26240 as a man-in-the-middle attack will cause the correct client and server to
26241 see different identifiers and authentication will fail.
26242
26243 This is currently only supported when using the GnuTLS library.  This is
26244 only usable by mechanisms which support "channel binding"; at time of
26245 writing, that's the SCRAM family.
26246
26247 This defaults off to ensure smooth upgrade across Exim releases, in case
26248 this option causes some clients to start failing.  Some future release
26249 of Exim may switch the default to be true.
26250
26251
26252 .option server_hostname gsasl string&!! "see below"
26253 This option selects the hostname that is used when communicating with the
26254 library. The default value is &`$primary_hostname`&.
26255 Some mechanisms will use this data.
26256
26257
26258 .option server_mech gsasl string "see below"
26259 This option selects the authentication mechanism this driver should use. The
26260 default is the value of the generic &%public_name%& option. This option allows
26261 you to use a different underlying mechanism from the advertised name. For
26262 example:
26263 .code
26264 sasl:
26265   driver = gsasl
26266   public_name = X-ANYTHING
26267   server_mech = CRAM-MD5
26268   server_set_id = $auth1
26269 .endd
26270
26271
26272 .option server_password gsasl string&!! unset
26273 Various mechanisms need access to the cleartext password on the server, so
26274 that proof-of-possession can be demonstrated on the wire, without sending
26275 the password itself.
26276
26277 The data available for lookup varies per mechanism.
26278 In all cases, &$auth1$& is set to the &'authentication id'&.
26279 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26280 if available, else the empty string.
26281 The &$auth3$& variable will always be the &'realm'& if available,
26282 else the empty string.
26283
26284 A forced failure will cause authentication to defer.
26285
26286 If using this option, it may make sense to set the &%server_condition%&
26287 option to be simply "true".
26288
26289
26290 .option server_realm gsasl string&!! unset
26291 This specifies the SASL realm that the server claims to be in.
26292 Some mechanisms will use this data.
26293
26294
26295 .option server_scram_iter gsasl string&!! unset
26296 This option provides data for the SCRAM family of mechanisms.
26297 &$auth1$& is not available at evaluation time.
26298 (This may change, as we receive feedback on use)
26299
26300
26301 .option server_scram_salt gsasl string&!! unset
26302 This option provides data for the SCRAM family of mechanisms.
26303 &$auth1$& is not available at evaluation time.
26304 (This may change, as we receive feedback on use)
26305
26306
26307 .option server_service gsasl string &`smtp`&
26308 This is the SASL service that the server claims to implement.
26309 Some mechanisms will use this data.
26310
26311
26312 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26313 .vindex "&$auth1$&, &$auth2$&, etc"
26314 These may be set when evaluating specific options, as detailed above.
26315 They will also be set when evaluating &%server_condition%&.
26316
26317 Unless otherwise stated below, the &(gsasl)& integration will use the following
26318 meanings for these variables:
26319
26320 .ilist
26321 .vindex "&$auth1$&"
26322 &$auth1$&: the &'authentication id'&
26323 .next
26324 .vindex "&$auth2$&"
26325 &$auth2$&: the &'authorization id'&
26326 .next
26327 .vindex "&$auth3$&"
26328 &$auth3$&: the &'realm'&
26329 .endlist
26330
26331 On a per-mechanism basis:
26332
26333 .ilist
26334 .cindex "authentication" "EXTERNAL"
26335 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26336 the &%server_condition%& option must be present.
26337 .next
26338 .cindex "authentication" "ANONYMOUS"
26339 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26340 the &%server_condition%& option must be present.
26341 .next
26342 .cindex "authentication" "GSSAPI"
26343 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26344 &$auth2$& will be set to the &'authorization id'&,
26345 the &%server_condition%& option must be present.
26346 .endlist
26347
26348 An &'anonymous token'& is something passed along as an unauthenticated
26349 identifier; this is analogous to FTP anonymous authentication passing an
26350 email address, or software-identifier@, as the "password".
26351
26352
26353 An example showing the password having the realm specified in the callback
26354 and demonstrating a Cyrus SASL to GSASL migration approach is:
26355 .code
26356 gsasl_cyrusless_crammd5:
26357   driver = gsasl
26358   public_name = CRAM-MD5
26359   server_realm = imap.example.org
26360   server_password = ${lookup{$auth1:$auth3:userPassword}\
26361                     dbmjz{/etc/sasldb2}{$value}fail}
26362   server_set_id = ${quote:$auth1}
26363   server_condition = yes
26364 .endd
26365
26366
26367 . ////////////////////////////////////////////////////////////////////////////
26368 . ////////////////////////////////////////////////////////////////////////////
26369
26370 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26371 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26372 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26373 .cindex "authentication" "GSSAPI"
26374 .cindex "authentication" "Kerberos"
26375 The &(heimdal_gssapi)& authenticator provides server integration for the
26376 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26377 reliably.
26378
26379 .option server_hostname heimdal_gssapi string&!! "see below"
26380 This option selects the hostname that is used, with &%server_service%&,
26381 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26382 identifier.  The default value is &`$primary_hostname`&.
26383
26384 .option server_keytab heimdal_gssapi string&!! unset
26385 If set, then Heimdal will not use the system default keytab (typically
26386 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26387 The value should be a pathname, with no &"file:"& prefix.
26388
26389 .option server_service heimdal_gssapi string&!! "smtp"
26390 This option specifies the service identifier used, in conjunction with
26391 &%server_hostname%&, for building the identifier for finding credentials
26392 from the keytab.
26393
26394
26395 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26396 Beware that these variables will typically include a realm, thus will appear
26397 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26398 not verified, so a malicious client can set it to anything.
26399
26400 The &$auth1$& field should be safely trustable as a value from the Key
26401 Distribution Center.  Note that these are not quite email addresses.
26402 Each identifier is for a role, and so the left-hand-side may include a
26403 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26404
26405 .vindex "&$auth1$&, &$auth2$&, etc"
26406 .ilist
26407 .vindex "&$auth1$&"
26408 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26409 .next
26410 .vindex "&$auth2$&"
26411 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26412 authentication.  If that was empty, this will also be set to the
26413 GSS Display Name.
26414 .endlist
26415
26416
26417 . ////////////////////////////////////////////////////////////////////////////
26418 . ////////////////////////////////////////////////////////////////////////////
26419
26420 .chapter "The spa authenticator" "CHAPspa"
26421 .scindex IIDspaauth1 "&(spa)& authenticator"
26422 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26423 .cindex "authentication" "Microsoft Secure Password"
26424 .cindex "authentication" "NTLM"
26425 .cindex "Microsoft Secure Password Authentication"
26426 .cindex "NTLM authentication"
26427 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26428 Password Authentication'& mechanism,
26429 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26430 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26431 taken from the Samba project (&url(http://www.samba.org)). The code for the
26432 server side was subsequently contributed by Tom Kistner. The mechanism works as
26433 follows:
26434
26435 .ilist
26436 After the AUTH command has been accepted, the client sends an SPA
26437 authentication request based on the user name and optional domain.
26438 .next
26439 The server sends back a challenge.
26440 .next
26441 The client builds a challenge response which makes use of the user's password
26442 and sends it to the server, which then accepts or rejects it.
26443 .endlist
26444
26445 Encryption is used to protect the password in transit.
26446
26447
26448
26449 .section "Using spa as a server" "SECID179"
26450 .cindex "options" "&(spa)& authenticator (server)"
26451 The &(spa)& authenticator has just one server option:
26452
26453 .option server_password spa string&!! unset
26454 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26455 This option is expanded, and the result must be the cleartext password for the
26456 authenticating user, whose name is at this point in &$auth1$&. For
26457 compatibility with previous releases of Exim, the user name is also placed in
26458 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26459 it can lead to confusion in string expansions that also use numeric variables
26460 for other things. For example:
26461 .code
26462 spa:
26463   driver = spa
26464   public_name = NTLM
26465   server_password = \
26466     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26467 .endd
26468 If the expansion is forced to fail, authentication fails. Any other expansion
26469 failure causes a temporary error code to be returned.
26470
26471
26472
26473
26474
26475 .section "Using spa as a client" "SECID180"
26476 .cindex "options" "&(spa)& authenticator (client)"
26477 The &(spa)& authenticator has the following client options:
26478
26479
26480
26481 .option client_domain spa string&!! unset
26482 This option specifies an optional domain for the authentication.
26483
26484
26485 .option client_password spa string&!! unset
26486 This option specifies the user's password, and must be set.
26487
26488
26489 .option client_username spa string&!! unset
26490 This option specifies the user name, and must be set. Here is an example of a
26491 configuration of this authenticator for use with the mail servers at
26492 &'msn.com'&:
26493 .code
26494 msn:
26495   driver = spa
26496   public_name = MSN
26497   client_username = msn/msn_username
26498   client_password = msn_plaintext_password
26499   client_domain = DOMAIN_OR_UNSET
26500 .endd
26501 .ecindex IIDspaauth1
26502 .ecindex IIDspaauth2
26503
26504
26505
26506
26507
26508 . ////////////////////////////////////////////////////////////////////////////
26509 . ////////////////////////////////////////////////////////////////////////////
26510
26511 .chapter "The tls authenticator" "CHAPtlsauth"
26512 .scindex IIDtlsauth1 "&(tls)& authenticator"
26513 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26514 .cindex "authentication" "Client Certificate"
26515 .cindex "authentication" "X509"
26516 .cindex "Certificate-based authentication"
26517 The &(tls)& authenticator provides server support for
26518 authentication based on client certificates.
26519
26520 It is not an SMTP authentication mechanism and is not
26521 advertised by the server as part of the SMTP EHLO response.
26522 It is an Exim authenticator in the sense that it affects
26523 the protocol element of the log line, can be tested for
26524 by the &%authenticated%& ACL condition, and can set
26525 the &$authenticated_id$& variable.
26526
26527 The client must present a verifiable certificate,
26528 for which it must have been requested via the
26529 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26530 (see &<<CHAPTLS>>&).
26531
26532 If an authenticator of this type is configured it is
26533 run before any SMTP-level communication is done,
26534 and can authenticate the connection.
26535 If it does, SMTP authentication is not offered.
26536
26537 A maximum of one authenticator of this type may be present.
26538
26539
26540 .cindex "options" "&(tls)& authenticator (server)"
26541 The &(tls)& authenticator has three server options:
26542
26543 .option server_param1 tls string&!! unset
26544 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26545 This option is expanded after the TLS negotiation and
26546 the result is placed in &$auth1$&.
26547 If the expansion is forced to fail, authentication fails. Any other expansion
26548 failure causes a temporary error code to be returned.
26549
26550 .option server_param2 tls string&!! unset
26551 .option server_param3 tls string&!! unset
26552 As above, for &$auth2$& and &$auth3$&.
26553
26554 &%server_param1%& may also be spelled &%server_param%&.
26555
26556
26557 Example:
26558 .code
26559 tls:
26560   driver = tls
26561   server_param1 =     ${certextract {subj_altname,mail,>:} \
26562                                     {$tls_in_peercert}}
26563   server_condition =  ${if forany {$auth1} \
26564                             {!= {0} \
26565                                 {${lookup ldap{ldap:///\
26566                          mailname=${quote_ldap_dn:${lc:$item}},\
26567                          ou=users,LDAP_DC?mailid} {$value}{0} \
26568                        }    }   } }
26569   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26570 .endd
26571 This accepts a client certificate that is verifiable against any
26572 of your configured trust-anchors
26573 which usually means the full set of public CAs)
26574 and which has a SAN with a good account name.
26575 Note that the client cert is on the wire in-clear, including the SAN,
26576 whereas a plaintext SMTP AUTH done inside TLS is not.
26577
26578 . An alternative might use
26579 . .code
26580 .   server_param1 = ${sha256:$tls_in_peercert}
26581 . .endd
26582 . to require one of a set of specific certs that define a given account
26583 . (the verification is still required, but mostly irrelevant).
26584 . This would help for per-device use.
26585 .
26586 . However, for the future we really need support for checking a
26587 . user cert in LDAP - which probably wants a base-64 DER.
26588
26589 .ecindex IIDtlsauth1
26590 .ecindex IIDtlsauth2
26591
26592
26593 Note that because authentication is traditionally an SMTP operation,
26594 the &%authenticated%& ACL condition cannot be used in
26595 a connect- or helo-ACL.
26596
26597
26598
26599 . ////////////////////////////////////////////////////////////////////////////
26600 . ////////////////////////////////////////////////////////////////////////////
26601
26602 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26603          "Encrypted SMTP connections"
26604 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26605 .scindex IIDencsmtp2 "SMTP" "encryption"
26606 .cindex "TLS" "on SMTP connection"
26607 .cindex "OpenSSL"
26608 .cindex "GnuTLS"
26609 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26610 Sockets Layer), is implemented by making use of the OpenSSL library or the
26611 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26612 cryptographic code in the Exim distribution itself for implementing TLS. In
26613 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26614 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26615 You also need to understand the basic concepts of encryption at a managerial
26616 level, and in particular, the way that public keys, private keys, and
26617 certificates are used.
26618
26619 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26620 connection is established, the client issues a STARTTLS command. If the
26621 server accepts this, the client and the server negotiate an encryption
26622 mechanism. If the negotiation succeeds, the data that subsequently passes
26623 between them is encrypted.
26624
26625 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26626 and if so, what cipher suite is in use, whether the client supplied a
26627 certificate, and whether or not that certificate was verified. This makes it
26628 possible for an Exim server to deny or accept certain commands based on the
26629 encryption state.
26630
26631 &*Warning*&: Certain types of firewall and certain anti-virus products can
26632 disrupt TLS connections. You need to turn off SMTP scanning for these products
26633 in order to get TLS to work.
26634
26635
26636
26637 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26638          "SECID284"
26639 .cindex "ssmtp protocol"
26640 .cindex "smtps protocol"
26641 .cindex "SMTP" "ssmtp protocol"
26642 .cindex "SMTP" "smtps protocol"
26643 Early implementations of encrypted SMTP used a different TCP port from normal
26644 SMTP, and expected an encryption negotiation to start immediately, instead of
26645 waiting for a STARTTLS command from the client using the standard SMTP
26646 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26647 allocated for this purpose.
26648
26649 This approach was abandoned when encrypted SMTP was standardized, but there are
26650 still some legacy clients that use it. Exim supports these clients by means of
26651 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26652 numbers; the most common use is expected to be:
26653 .code
26654 tls_on_connect_ports = 465
26655 .endd
26656 The port numbers specified by this option apply to all SMTP connections, both
26657 via the daemon and via &'inetd'&. You still need to specify all the ports that
26658 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26659 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26660 an extra port &-- rather, it specifies different behaviour on a port that is
26661 defined elsewhere.
26662
26663 There is also a &%-tls-on-connect%& command line option. This overrides
26664 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26665
26666
26667
26668
26669
26670
26671 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26672 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26673 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26674 followed later, when the first versions of GnuTLS were released. To build Exim
26675 to use GnuTLS, you need to set
26676 .code
26677 USE_GNUTLS=yes
26678 .endd
26679 in Local/Makefile, in addition to
26680 .code
26681 SUPPORT_TLS=yes
26682 .endd
26683 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26684 include files and libraries for GnuTLS can be found.
26685
26686 There are some differences in usage when using GnuTLS instead of OpenSSL:
26687
26688 .ilist
26689 The &%tls_verify_certificates%& option
26690 cannot be the path of a directory
26691 for GnuTLS versions before 3.3.6
26692 (for later versions, or OpenSSL, it can be either).
26693 .next
26694 The default value for &%tls_dhparam%& differs for historical reasons.
26695 .next
26696 .vindex "&$tls_in_peerdn$&"
26697 .vindex "&$tls_out_peerdn$&"
26698 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26699 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26700 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26701 .next
26702 OpenSSL identifies cipher suites using hyphens as separators, for example:
26703 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26704 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26705 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26706 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26707 to handle its own older variants) when processing lists of cipher suites in the
26708 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26709 option).
26710 .next
26711 The &%tls_require_ciphers%& options operate differently, as described in the
26712 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26713 .next
26714 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26715 When using OpenSSL, this option is ignored.
26716 (If an API is found to let OpenSSL be configured in this way,
26717 let the Exim Maintainers know and we'll likely use it).
26718 .next
26719 Some other recently added features may only be available in one or the other.
26720 This should be documented with the feature.  If the documentation does not
26721 explicitly state that the feature is infeasible in the other TLS
26722 implementation, then patches are welcome.
26723 .endlist
26724
26725
26726 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26727 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26728 an explicit path; if the latter, then the text about generation still applies,
26729 but not the chosen filename.
26730 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26731 See the documentation of &%tls_dhparam%& for more information.
26732
26733 GnuTLS uses D-H parameters that may take a substantial amount of time
26734 to compute. It is unreasonable to re-compute them for every TLS session.
26735 Therefore, Exim keeps this data in a file in its spool directory, called
26736 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26737 of bits requested.
26738 The file is owned by the Exim user and is readable only by
26739 its owner. Every Exim process that start up GnuTLS reads the D-H
26740 parameters from this file. If the file does not exist, the first Exim process
26741 that needs it computes the data and writes it to a temporary file which is
26742 renamed once it is complete. It does not matter if several Exim processes do
26743 this simultaneously (apart from wasting a few resources). Once a file is in
26744 place, new Exim processes immediately start using it.
26745
26746 For maximum security, the parameters that are stored in this file should be
26747 recalculated periodically, the frequency depending on your paranoia level.
26748 If you are avoiding using the fixed D-H primes published in RFCs, then you
26749 are concerned about some advanced attacks and will wish to do this; if you do
26750 not regenerate then you might as well stick to the standard primes.
26751
26752 Arranging this is easy in principle; just delete the file when you want new
26753 values to be computed. However, there may be a problem. The calculation of new
26754 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26755 If the system is not very active, &_/dev/random_& may delay returning data
26756 until enough randomness (entropy) is available. This may cause Exim to hang for
26757 a substantial amount of time, causing timeouts on incoming connections.
26758
26759 The solution is to generate the parameters externally to Exim. They are stored
26760 in &_gnutls-params-N_& in PEM format, which means that they can be
26761 generated externally using the &(certtool)& command that is part of GnuTLS.
26762
26763 To replace the parameters with new ones, instead of deleting the file
26764 and letting Exim re-create it, you can generate new parameters using
26765 &(certtool)& and, when this has been done, replace Exim's cache file by
26766 renaming. The relevant commands are something like this:
26767 .code
26768 # ls
26769 [ look for file; assume gnutls-params-2236 is the most recent ]
26770 # rm -f new-params
26771 # touch new-params
26772 # chown exim:exim new-params
26773 # chmod 0600 new-params
26774 # certtool --generate-dh-params --bits 2236 >>new-params
26775 # openssl dhparam -noout -text -in new-params | head
26776 [ check the first line, make sure it's not more than 2236;
26777   if it is, then go back to the start ("rm") and repeat
26778   until the size generated is at most the size requested ]
26779 # chmod 0400 new-params
26780 # mv new-params gnutls-params-2236
26781 .endd
26782 If Exim never has to generate the parameters itself, the possibility of
26783 stalling is removed.
26784
26785 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26786 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26787 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26788 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26789 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26790 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26791 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26792 which applies to all D-H usage, client or server.  If the value returned by
26793 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26794 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26795 limit, which is still much higher than Exim historically used.
26796
26797 The filename and bits used will change as the GnuTLS maintainers change the
26798 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26799 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26800 2432 bits, while NSS is limited to 2236 bits.
26801
26802 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26803 increase the chance of the generated prime actually being within acceptable
26804 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26805 procedure above.  There is no sane procedure available to Exim to double-check
26806 the size of the generated prime, so it might still be too large.
26807
26808
26809 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26810 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26811 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26812 There is a function in the OpenSSL library that can be passed a list of cipher
26813 suites before the cipher negotiation takes place. This specifies which ciphers
26814 are acceptable. The list is colon separated and may contain names like
26815 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26816 directly to this function call.
26817 Many systems will install the OpenSSL manual-pages, so you may have
26818 &'ciphers(1)'& available to you.
26819 The following quotation from the OpenSSL
26820 documentation specifies what forms of item are allowed in the cipher string:
26821
26822 .ilist
26823 It can consist of a single cipher suite such as RC4-SHA.
26824 .next
26825 It can represent a list of cipher suites containing a certain algorithm,
26826 or cipher suites of a certain type. For example SHA1 represents all
26827 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26828 SSL v3 algorithms.
26829 .next
26830 Lists of cipher suites can be combined in a single cipher string using
26831 the + character. This is used as a logical and operation. For example
26832 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26833 algorithms.
26834 .endlist
26835
26836 Each cipher string can be optionally preceded by one of the characters &`!`&,
26837 &`-`& or &`+`&.
26838 .ilist
26839 If &`!`& is used, the ciphers are permanently deleted from the list. The
26840 ciphers deleted can never reappear in the list even if they are explicitly
26841 stated.
26842 .next
26843 If &`-`& is used, the ciphers are deleted from the list, but some or all
26844 of the ciphers can be added again by later options.
26845 .next
26846 If &`+`& is used, the ciphers are moved to the end of the list. This
26847 option does not add any new ciphers; it just moves matching existing ones.
26848 .endlist
26849
26850 If none of these characters is present, the string is interpreted as
26851 a list of ciphers to be appended to the current preference list. If the list
26852 includes any ciphers already present they will be ignored: that is, they will
26853 not be moved to the end of the list.
26854 .endlist
26855
26856 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26857 string:
26858 .code
26859 # note single-quotes to get ! past any shell history expansion
26860 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26861 .endd
26862
26863 This example will let the library defaults be permitted on the MX port, where
26864 there's probably no identity verification anyway, but ups the ante on the
26865 submission ports where the administrator might have some influence on the
26866 choice of clients used:
26867 .code
26868 # OpenSSL variant; see man ciphers(1)
26869 tls_require_ciphers = ${if =={$received_port}{25}\
26870                            {DEFAULT}\
26871                            {HIGH:!MD5:!SHA1}}
26872 .endd
26873
26874
26875
26876 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26877          "SECTreqciphgnu"
26878 .cindex "GnuTLS" "specifying parameters for"
26879 .cindex "TLS" "specifying ciphers (GnuTLS)"
26880 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26881 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26882 .cindex "TLS" "specifying protocols (GnuTLS)"
26883 .cindex "TLS" "specifying priority string (GnuTLS)"
26884 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26885 The GnuTLS library allows the caller to provide a "priority string", documented
26886 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26887 ciphersuite specification in OpenSSL.
26888
26889 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26890 and controls both protocols and ciphers.
26891
26892 The &%tls_require_ciphers%& option is available both as an global option,
26893 controlling how Exim behaves as a server, and also as an option of the
26894 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26895 the value is string expanded.  The resulting string is not an Exim list and
26896 the string is given to the GnuTLS library, so that Exim does not need to be
26897 aware of future feature enhancements of GnuTLS.
26898
26899 Documentation of the strings accepted may be found in the GnuTLS manual, under
26900 "Priority strings".  This is online as
26901 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26902 but beware that this relates to GnuTLS 3, which may be newer than the version
26903 installed on your system.  If you are using GnuTLS 3,
26904 then the example code
26905 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
26906 on that site can be used to test a given string.
26907
26908 For example:
26909 .code
26910 # Disable older versions of protocols
26911 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26912 .endd
26913
26914 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26915 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26916 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26917
26918 This example will let the library defaults be permitted on the MX port, where
26919 there's probably no identity verification anyway, and lowers security further
26920 by increasing compatibility; but this ups the ante on the submission ports
26921 where the administrator might have some influence on the choice of clients
26922 used:
26923 .code
26924 # GnuTLS variant
26925 tls_require_ciphers = ${if =={$received_port}{25}\
26926                            {NORMAL:%COMPAT}\
26927                            {SECURE128}}
26928 .endd
26929
26930
26931 .section "Configuring an Exim server to use TLS" "SECID182"
26932 .cindex "TLS" "configuring an Exim server"
26933 When Exim has been built with TLS support, it advertises the availability of
26934 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26935 but not to any others. The default value of this option is unset, which means
26936 that STARTTLS is not advertised at all. This default is chosen because you
26937 need to set some other options in order to make TLS available, and also it is
26938 sensible for systems that want to use TLS only as a client.
26939
26940 If a client issues a STARTTLS command and there is some configuration
26941 problem in the server, the command is rejected with a 454 error. If the client
26942 persists in trying to issue SMTP commands, all except QUIT are rejected
26943 with the error
26944 .code
26945 554 Security failure
26946 .endd
26947 If a STARTTLS command is issued within an existing TLS session, it is
26948 rejected with a 554 error code.
26949
26950 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26951 match some hosts. You can, of course, set it to * to match all hosts.
26952 However, this is not all you need to do. TLS sessions to a server won't work
26953 without some further configuration at the server end.
26954
26955 It is rumoured that all existing clients that support TLS/SSL use RSA
26956 encryption. To make this work you need to set, in the server,
26957 .code
26958 tls_certificate = /some/file/name
26959 tls_privatekey = /some/file/name
26960 .endd
26961 These options are, in fact, expanded strings, so you can make them depend on
26962 the identity of the client that is connected if you wish. The first file
26963 contains the server's X509 certificate, and the second contains the private key
26964 that goes with it. These files need to be
26965 PEM format and readable by the Exim user, and must
26966 always be given as full path names.
26967 The key must not be password-protected.
26968 They can be the same file if both the
26969 certificate and the key are contained within it. If &%tls_privatekey%& is not
26970 set, or if its expansion is forced to fail or results in an empty string, this
26971 is assumed to be the case. The certificate file may also contain intermediate
26972 certificates that need to be sent to the client to enable it to authenticate
26973 the server's certificate.
26974
26975 If you do not understand about certificates and keys, please try to find a
26976 source of this background information, which is not Exim-specific. (There are a
26977 few comments below in section &<<SECTcerandall>>&.)
26978
26979 &*Note*&: These options do not apply when Exim is operating as a client &--
26980 they apply only in the case of a server. If you need to use a certificate in an
26981 Exim client, you must set the options of the same names in an &(smtp)&
26982 transport.
26983
26984 With just these options, an Exim server will be able to use TLS. It does not
26985 require the client to have a certificate (but see below for how to insist on
26986 this). There is one other option that may be needed in other situations. If
26987 .code
26988 tls_dhparam = /some/file/name
26989 .endd
26990 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26991 with the parameters contained in the file.
26992 Set this to &`none`& to disable use of DH entirely, by making no prime
26993 available:
26994 .code
26995 tls_dhparam = none
26996 .endd
26997 This may also be set to a string identifying a standard prime to be used for
26998 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26999 used is &`ike23`&.  There are a few standard primes available, see the
27000 documentation for &%tls_dhparam%& for the complete list.
27001
27002 See the command
27003 .code
27004 openssl dhparam
27005 .endd
27006 for a way of generating file data.
27007
27008 The strings supplied for these three options are expanded every time a client
27009 host connects. It is therefore possible to use different certificates and keys
27010 for different hosts, if you so wish, by making use of the client's IP address
27011 in &$sender_host_address$& to control the expansion. If a string expansion is
27012 forced to fail, Exim behaves as if the option is not set.
27013
27014 .cindex "cipher" "logging"
27015 .cindex "log" "TLS cipher"
27016 .vindex "&$tls_in_cipher$&"
27017 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27018 an incoming TLS connection. It is included in the &'Received:'& header of an
27019 incoming message (by default &-- you can, of course, change this), and it is
27020 also included in the log line that records a message's arrival, keyed by
27021 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27022 condition can be used to test for specific cipher suites in ACLs.
27023
27024 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27025 can check the name of the cipher suite and vary their actions accordingly. The
27026 cipher suite names vary, depending on which TLS library is being used. For
27027 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27028 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27029 documentation for more details.
27030
27031 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27032 (again depending on the &%tls_cipher%& log selector).
27033
27034
27035 .section "Requesting and verifying client certificates" "SECID183"
27036 .cindex "certificate" "verification of client"
27037 .cindex "TLS" "client certificate verification"
27038 If you want an Exim server to request a certificate when negotiating a TLS
27039 session with a client, you must set either &%tls_verify_hosts%& or
27040 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27041 apply to all TLS connections. For any host that matches one of these options,
27042 Exim requests a certificate as part of the setup of the TLS session. The
27043 contents of the certificate are verified by comparing it with a list of
27044 expected certificates.
27045 These may be the system default set (depending on library version),
27046 an explicit file or,
27047 depending on library version, a directory, identified by
27048 &%tls_verify_certificates%&.
27049
27050 A file can contain multiple certificates, concatenated end to end. If a
27051 directory is used
27052 (OpenSSL only),
27053 each certificate must be in a separate file, with a name (or a symbolic link)
27054 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27055 certificate. You can compute the relevant hash by running the command
27056 .code
27057 openssl x509 -hash -noout -in /cert/file
27058 .endd
27059 where &_/cert/file_& contains a single certificate.
27060
27061 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27062 what happens if the client does not supply a certificate, or if the certificate
27063 does not match any of the certificates in the collection named by
27064 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27065 attempt to set up a TLS session is aborted, and the incoming connection is
27066 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27067 session continues. ACLs that run for subsequent SMTP commands can detect the
27068 fact that no certificate was verified, and vary their actions accordingly. For
27069 example, you can insist on a certificate before accepting a message for
27070 relaying, but not when the message is destined for local delivery.
27071
27072 .vindex "&$tls_in_peerdn$&"
27073 When a client supplies a certificate (whether it verifies or not), the value of
27074 the Distinguished Name of the certificate is made available in the variable
27075 &$tls_in_peerdn$& during subsequent processing of the message.
27076
27077 .cindex "log" "distinguished name"
27078 Because it is often a long text string, it is not included in the log line or
27079 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27080 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27081 &%received_header_text%& to change the &'Received:'& header. When no
27082 certificate is supplied, &$tls_in_peerdn$& is empty.
27083
27084
27085 .section "Revoked certificates" "SECID184"
27086 .cindex "TLS" "revoked certificates"
27087 .cindex "revocation list"
27088 .cindex "certificate" "revocation list"
27089 .cindex "OCSP" "stapling"
27090 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27091 certificates are revoked. If you have such a list, you can pass it to an Exim
27092 server using the global option called &%tls_crl%& and to an Exim client using
27093 an identically named option for the &(smtp)& transport. In each case, the value
27094 of the option is expanded and must then be the name of a file that contains a
27095 CRL in PEM format.
27096 The downside is that clients have to periodically re-download a potentially huge
27097 file from every certificate authority they know of.
27098
27099 The way with most moving parts at query time is Online Certificate
27100 Status Protocol (OCSP), where the client verifies the certificate
27101 against an OCSP server run by the CA.  This lets the CA track all
27102 usage of the certs.  It requires running software with access to the
27103 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27104 is based on HTTP and can be proxied accordingly.
27105
27106 The only widespread OCSP server implementation (known to this writer)
27107 comes as part of OpenSSL and aborts on an invalid request, such as
27108 connecting to the port and then disconnecting.  This requires
27109 re-entering the passphrase each time some random client does this.
27110
27111 The third way is OCSP Stapling; in this, the server using a certificate
27112 issued by the CA periodically requests an OCSP proof of validity from
27113 the OCSP server, then serves it up inline as part of the TLS
27114 negotiation.   This approach adds no extra round trips, does not let the
27115 CA track users, scales well with number of certs issued by the CA and is
27116 resilient to temporary OCSP server failures, as long as the server
27117 starts retrying to fetch an OCSP proof some time before its current
27118 proof expires.  The downside is that it requires server support.
27119
27120 Unless Exim is built with the support disabled,
27121 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27122 support for OCSP stapling is included.
27123
27124 There is a global option called &%tls_ocsp_file%&.
27125 The file specified therein is expected to be in DER format, and contain
27126 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27127 option will be re-expanded for SNI, if the &%tls_certificate%& option
27128 contains &`tls_in_sni`&, as per other TLS options.
27129
27130 Exim does not at this time implement any support for fetching a new OCSP
27131 proof.  The burden is on the administrator to handle this, outside of
27132 Exim.  The file specified should be replaced atomically, so that the
27133 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27134 on each connection, so a new file will be handled transparently on the
27135 next connection.
27136
27137 When built with OpenSSL Exim will check for a valid next update timestamp
27138 in the OCSP proof; if not present, or if the proof has expired, it will be
27139 ignored.
27140
27141 For the client to be able to verify the stapled OCSP the server must
27142 also supply, in its stapled information, any intermediate
27143 certificates for the chain leading to the OCSP proof from the signer
27144 of the server certificate.  There may be zero or one such. These
27145 intermediate certificates should be added to the server OCSP stapling
27146 file named by &%tls_ocsp_file%&.
27147
27148 Note that the proof only covers the terminal server certificate,
27149 not any of the chain from CA to it.
27150
27151 There is no current way to staple a proof for a client certificate.
27152
27153 .code
27154   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27155   OCSP server is supplied.  The server URL may be included in the
27156   server certificate, if the CA is helpful.
27157
27158   One failure mode seen was the OCSP Signer cert expiring before the end
27159   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27160   noted this as invalid overall, but the re-fetch script did not.
27161 .endd
27162
27163
27164
27165
27166 .section "Configuring an Exim client to use TLS" "SECID185"
27167 .cindex "cipher" "logging"
27168 .cindex "log" "TLS cipher"
27169 .cindex "log" "distinguished name"
27170 .cindex "TLS" "configuring an Exim client"
27171 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27172 deliveries as well as to incoming, the latter one causing logging of the
27173 server certificate's DN. The remaining client configuration for TLS is all
27174 within the &(smtp)& transport.
27175
27176 It is not necessary to set any options to have TLS work in the &(smtp)&
27177 transport. If Exim is built with TLS support, and TLS is advertised by a
27178 server, the &(smtp)& transport always tries to start a TLS session. However,
27179 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27180 transport) to a list of server hosts for which TLS should not be used.
27181
27182 If you do not want Exim to attempt to send messages unencrypted when an attempt
27183 to set up an encrypted connection fails in any way, you can set
27184 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27185 those hosts, delivery is always deferred if an encrypted connection cannot be
27186 set up. If there are any other hosts for the address, they are tried in the
27187 usual way.
27188
27189 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27190 the message unencrypted. It always does this if the response to STARTTLS is
27191 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27192 session after a success response code, what happens is controlled by the
27193 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27194 delivery to this host is deferred, and other hosts (if available) are tried. If
27195 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27196 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27197 negotiation fails, Exim closes the current connection (because it is in an
27198 unknown state), opens a new one to the same host, and then tries the delivery
27199 unencrypted.
27200
27201 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27202 transport provide the client with a certificate, which is passed to the server
27203 if it requests it. If the server is Exim, it will request a certificate only if
27204 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27205
27206 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27207 specifies a collection of expected server certificates.
27208 These may be the system default set (depending on library version),
27209 a file or,
27210 depending on library version, a directory,
27211 must name a file or,
27212 for OpenSSL only (not GnuTLS), a directory.
27213 The client verifies the server's certificate
27214 against this collection, taking into account any revoked certificates that are
27215 in the list defined by &%tls_crl%&.
27216 Failure to verify fails the TLS connection unless either of the
27217 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27218
27219 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27220 certificate verification to the listed servers.  Verification either must
27221 or need not succeed respectively.
27222
27223 The &(smtp)& transport has two OCSP-related options:
27224 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27225 is requested and required for the connection to proceed.  The default
27226 value is empty.
27227 &%hosts_request_ocsp%&; a host-list for which (additionally)
27228 a Certificate Status is requested (but not necessarily verified).  The default
27229 value is "*" meaning that requests are made unless configured
27230 otherwise.
27231
27232 The host(s) should also be in &%hosts_require_tls%&, and
27233 &%tls_verify_certificates%& configured for the transport,
27234 for OCSP to be relevant.
27235
27236 If
27237 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27238 list of permitted cipher suites. If either of these checks fails, delivery to
27239 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27240 alternative hosts, if any.
27241
27242  &*Note*&:
27243 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27244 is operating as a client. Exim does not assume that a server certificate (set
27245 by the global options of the same name) should also be used when operating as a
27246 client.
27247
27248 .vindex "&$host$&"
27249 .vindex "&$host_address$&"
27250 All the TLS options in the &(smtp)& transport are expanded before use, with
27251 &$host$& and &$host_address$& containing the name and address of the server to
27252 which the client is connected. Forced failure of an expansion causes Exim to
27253 behave as if the relevant option were unset.
27254
27255 .vindex &$tls_out_bits$&
27256 .vindex &$tls_out_cipher$&
27257 .vindex &$tls_out_peerdn$&
27258 .vindex &$tls_out_sni$&
27259 Before an SMTP connection is established, the
27260 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27261 variables are emptied. (Until the first connection, they contain the values
27262 that were set when the message was received.) If STARTTLS is subsequently
27263 successfully obeyed, these variables are set to the relevant values for the
27264 outgoing connection.
27265
27266
27267
27268 .section "Use of TLS Server Name Indication" "SECTtlssni"
27269 .cindex "TLS" "Server Name Indication"
27270 .vindex "&$tls_in_sni$&"
27271 .oindex "&%tls_in_sni%&"
27272 With TLS1.0 or above, there is an extension mechanism by which extra
27273 information can be included at various points in the protocol.  One of these
27274 extensions, documented in RFC 6066 (and before that RFC 4366) is
27275 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27276 client in the initial handshake, so that the server can examine the servername
27277 within and possibly choose to use different certificates and keys (and more)
27278 for this session.
27279
27280 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27281 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27282 address.
27283
27284 With SMTP to MX, there are the same problems here as in choosing the identity
27285 against which to validate a certificate: you can't rely on insecure DNS to
27286 provide the identity which you then cryptographically verify.  So this will
27287 be of limited use in that environment.
27288
27289 With SMTP to Submission, there is a well-defined hostname which clients are
27290 connecting to and can validate certificates against.  Thus clients &*can*&
27291 choose to include this information in the TLS negotiation.  If this becomes
27292 wide-spread, then hosters can choose to present different certificates to
27293 different clients.  Or even negotiate different cipher suites.
27294
27295 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27296 if not empty, will be sent on a TLS session as part of the handshake.  There's
27297 nothing more to it.  Choosing a sensible value not derived insecurely is the
27298 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27299 for the lifetime of the client connection (including during authentication).
27300
27301 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27302 received from a client.
27303 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27304
27305 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27306 option (prior to expansion) then the following options will be re-expanded
27307 during TLS session handshake, to permit alternative values to be chosen:
27308
27309 .ilist
27310 .vindex "&%tls_certificate%&"
27311 &%tls_certificate%&
27312 .next
27313 .vindex "&%tls_crl%&"
27314 &%tls_crl%&
27315 .next
27316 .vindex "&%tls_privatekey%&"
27317 &%tls_privatekey%&
27318 .next
27319 .vindex "&%tls_verify_certificates%&"
27320 &%tls_verify_certificates%&
27321 .next
27322 .vindex "&%tls_ocsp_file%&"
27323 &%tls_ocsp_file%&
27324 .endlist
27325
27326 Great care should be taken to deal with matters of case, various injection
27327 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27328 can always be referenced; it is important to remember that &$tls_sni$& is
27329 arbitrary unverified data provided prior to authentication.
27330
27331 The Exim developers are proceeding cautiously and so far no other TLS options
27332 are re-expanded.
27333
27334 When Exim is built against OpenSSL, OpenSSL must have been built with support
27335 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27336 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27337 see &`-servername`& in the output, then OpenSSL has support.
27338
27339 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27340 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27341 built, then you have SNI support).
27342
27343
27344
27345 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27346          "SECTmulmessam"
27347 .cindex "multiple SMTP deliveries with TLS"
27348 .cindex "TLS" "multiple message deliveries"
27349 Exim sends multiple messages down the same TCP/IP connection by starting up
27350 an entirely new delivery process for each message, passing the socket from
27351 one process to the next. This implementation does not fit well with the use
27352 of TLS, because there is quite a lot of state information associated with a TLS
27353 connection, not just a socket identification. Passing all the state information
27354 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27355 session before passing the socket to a new process. The new process may then
27356 try to start a new TLS session, and if successful, may try to re-authenticate
27357 if AUTH is in use, before sending the next message.
27358
27359 The RFC is not clear as to whether or not an SMTP session continues in clear
27360 after TLS has been shut down, or whether TLS may be restarted again later, as
27361 just described. However, if the server is Exim, this shutdown and
27362 reinitialization works. It is not known which (if any) other servers operate
27363 successfully if the client closes a TLS session and continues with unencrypted
27364 SMTP, but there are certainly some that do not work. For such servers, Exim
27365 should not pass the socket to another process, because the failure of the
27366 subsequent attempt to use it would cause Exim to record a temporary host error,
27367 and delay other deliveries to that host.
27368
27369 To test for this case, Exim sends an EHLO command to the server after
27370 closing down the TLS session. If this fails in any way, the connection is
27371 closed instead of being passed to a new delivery process, but no retry
27372 information is recorded.
27373
27374 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27375 &(smtp)& transport to match those hosts for which Exim should not pass
27376 connections to new processes if TLS has been used.
27377
27378
27379
27380
27381 .section "Certificates and all that" "SECTcerandall"
27382 .cindex "certificate" "references to discussion"
27383 In order to understand fully how TLS works, you need to know about
27384 certificates, certificate signing, and certificate authorities. This is not the
27385 place to give a tutorial, especially as I do not know very much about it
27386 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27387 to Apache, currently at
27388 .display
27389 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27390 .endd
27391 Other parts of the &'modssl'& documentation are also helpful, and have
27392 links to further files.
27393 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27394 0-201-61598-3), contains both introductory and more in-depth descriptions.
27395 Some sample programs taken from the book are available from
27396 .display
27397 &url(http://www.rtfm.com/openssl-examples/)
27398 .endd
27399
27400
27401 .section "Certificate chains" "SECID186"
27402 The file named by &%tls_certificate%& may contain more than one
27403 certificate. This is useful in the case where the certificate that is being
27404 sent is validated by an intermediate certificate which the other end does
27405 not have. Multiple certificates must be in the correct order in the file.
27406 First the host's certificate itself, then the first intermediate
27407 certificate to validate the issuer of the host certificate, then the next
27408 intermediate certificate to validate the issuer of the first intermediate
27409 certificate, and so on, until finally (optionally) the root certificate.
27410 The root certificate must already be trusted by the recipient for
27411 validation to succeed, of course, but if it's not preinstalled, sending the
27412 root certificate along with the rest makes it available for the user to
27413 install if the receiving end is a client MUA that can interact with a user.
27414
27415 Note that certificates using MD5 are unlikely to work on today's Internet;
27416 even if your libraries allow loading them for use in Exim when acting as a
27417 server, increasingly clients will not accept such certificates.  The error
27418 diagnostics in such a case can be frustratingly vague.
27419
27420
27421
27422 .section "Self-signed certificates" "SECID187"
27423 .cindex "certificate" "self-signed"
27424 You can create a self-signed certificate using the &'req'& command provided
27425 with OpenSSL, like this:
27426 . ==== Do not shorten the duration here without reading and considering
27427 . ==== the text below.  Please leave it at 9999 days.
27428 .code
27429 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27430             -days 9999 -nodes
27431 .endd
27432 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27433 delimited and so can be identified independently. The &%-days%& option
27434 specifies a period for which the certificate is valid. The &%-nodes%& option is
27435 important: if you do not set it, the key is encrypted with a passphrase
27436 that you are prompted for, and any use that is made of the key causes more
27437 prompting for the passphrase. This is not helpful if you are going to use
27438 this certificate and key in an MTA, where prompting is not possible.
27439
27440 . ==== I expect to still be working 26 years from now.  The less technical
27441 . ==== debt I create, in terms of storing up trouble for my later years, the
27442 . ==== happier I will be then.  We really have reached the point where we
27443 . ==== should start, at the very least, provoking thought and making folks
27444 . ==== pause before proceeding, instead of leaving all the fixes until two
27445 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27446 . ==== -pdp, 2012
27447 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27448 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27449 the above command might produce a date in the past.  Think carefully about
27450 the lifetime of the systems you're deploying, and either reduce the duration
27451 of the certificate or reconsider your platform deployment.  (At time of
27452 writing, reducing the duration is the most likely choice, but the inexorable
27453 progression of time takes us steadily towards an era where this will not
27454 be a sensible resolution).
27455
27456 A self-signed certificate made in this way is sufficient for testing, and
27457 may be adequate for all your requirements if you are mainly interested in
27458 encrypting transfers, and not in secure identification.
27459
27460 However, many clients require that the certificate presented by the server be a
27461 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27462 certificate. In this situation, the self-signed certificate described above
27463 must be installed on the client host as a trusted root &'certification
27464 authority'& (CA), and the certificate used by Exim must be a user certificate
27465 signed with that self-signed certificate.
27466
27467 For information on creating self-signed CA certificates and using them to sign
27468 user certificates, see the &'General implementation overview'& chapter of the
27469 Open-source PKI book, available online at
27470 &url(http://ospkibook.sourceforge.net/).
27471 .ecindex IIDencsmtp1
27472 .ecindex IIDencsmtp2
27473
27474
27475
27476 . ////////////////////////////////////////////////////////////////////////////
27477 . ////////////////////////////////////////////////////////////////////////////
27478
27479 .chapter "Access control lists" "CHAPACL"
27480 .scindex IIDacl "&ACL;" "description"
27481 .cindex "control of incoming mail"
27482 .cindex "message" "controlling incoming"
27483 .cindex "policy control" "access control lists"
27484 Access Control Lists (ACLs) are defined in a separate section of the run time
27485 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27486 name, terminated by a colon. Here is a complete ACL section that contains just
27487 one very small ACL:
27488 .code
27489 begin acl
27490 small_acl:
27491   accept   hosts = one.host.only
27492 .endd
27493 You can have as many lists as you like in the ACL section, and the order in
27494 which they appear does not matter. The lists are self-terminating.
27495
27496 The majority of ACLs are used to control Exim's behaviour when it receives
27497 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27498 when a local process submits a message using SMTP by specifying the &%-bs%&
27499 option. The most common use is for controlling which recipients are accepted
27500 in incoming messages. In addition, you can define an ACL that is used to check
27501 local non-SMTP messages. The default configuration file contains an example of
27502 a realistic ACL for checking RCPT commands. This is discussed in chapter
27503 &<<CHAPdefconfil>>&.
27504
27505
27506 .section "Testing ACLs" "SECID188"
27507 The &%-bh%& command line option provides a way of testing your ACL
27508 configuration locally by running a fake SMTP session with which you interact.
27509
27510
27511 .section "Specifying when ACLs are used" "SECID189"
27512 .cindex "&ACL;" "options for specifying"
27513 In order to cause an ACL to be used, you have to name it in one of the relevant
27514 options in the main part of the configuration. These options are:
27515 .cindex "AUTH" "ACL for"
27516 .cindex "DATA" "ACLs for"
27517 .cindex "ETRN" "ACL for"
27518 .cindex "EXPN" "ACL for"
27519 .cindex "HELO" "ACL for"
27520 .cindex "EHLO" "ACL for"
27521 .cindex "DKIM" "ACL for"
27522 .cindex "MAIL" "ACL for"
27523 .cindex "QUIT, ACL for"
27524 .cindex "RCPT" "ACL for"
27525 .cindex "STARTTLS, ACL for"
27526 .cindex "VRFY" "ACL for"
27527 .cindex "SMTP" "connection, ACL for"
27528 .cindex "non-SMTP messages" "ACLs for"
27529 .cindex "MIME content scanning" "ACL for"
27530 .cindex "PRDR" "ACL for"
27531
27532 .table2 140pt
27533 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27534 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27535 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27536 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27537 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27538 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27539 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27540 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27541 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27542 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27543 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27544 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27545 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27546 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27547 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27548 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27549 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27550 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27551 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27552 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27553 .endtable
27554
27555 For example, if you set
27556 .code
27557 acl_smtp_rcpt = small_acl
27558 .endd
27559 the little ACL defined above is used whenever Exim receives a RCPT command
27560 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27561 done when RCPT commands arrive. A rejection of RCPT should cause the
27562 sending MTA to give up on the recipient address contained in the RCPT
27563 command, whereas rejection at other times may cause the client MTA to keep on
27564 trying to deliver the message. It is therefore recommended that you do as much
27565 testing as possible at RCPT time.
27566
27567
27568 .section "The non-SMTP ACLs" "SECID190"
27569 .cindex "non-SMTP messages" "ACLs for"
27570 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27571 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27572 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27573 the state of the SMTP connection such as encryption and authentication) are not
27574 relevant and are forbidden in these ACLs. However, the sender and recipients
27575 are known, so the &%senders%& and &%sender_domains%& conditions and the
27576 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27577 &$authenticated_sender$& are also available. You can specify added header lines
27578 in any of these ACLs.
27579
27580 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27581 non-SMTP message, before any of the message has been read. (This is the
27582 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27583 batched SMTP input, it runs after the DATA command has been reached. The
27584 result of this ACL is ignored; it cannot be used to reject a message. If you
27585 really need to, you could set a value in an ACL variable here and reject based
27586 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27587 controls, and in particular, it can be used to set
27588 .code
27589 control = suppress_local_fixups
27590 .endd
27591 This cannot be used in the other non-SMTP ACLs because by the time they are
27592 run, it is too late.
27593
27594 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27595 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27596
27597 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27598 kind of rejection is treated as permanent, because there is no way of sending a
27599 temporary error for these kinds of message.
27600
27601
27602 .section "The SMTP connect ACL" "SECID191"
27603 .cindex "SMTP" "connection, ACL for"
27604 .oindex &%smtp_banner%&
27605 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27606 session, after the test specified by &%host_reject_connection%& (which is now
27607 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27608 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27609 the message override the banner message that is otherwise specified by the
27610 &%smtp_banner%& option.
27611
27612
27613 .section "The EHLO/HELO ACL" "SECID192"
27614 .cindex "EHLO" "ACL for"
27615 .cindex "HELO" "ACL for"
27616 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27617 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27618 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27619 Note that a client may issue more than one EHLO or HELO command in an SMTP
27620 session, and indeed is required to issue a new EHLO or HELO after successfully
27621 setting up encryption following a STARTTLS command.
27622
27623 Note also that a deny neither forces the client to go away nor means that
27624 mail will be refused on the connection.  Consider checking for
27625 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27626
27627 If the command is accepted by an &%accept%& verb that has a &%message%&
27628 modifier, the message may not contain more than one line (it will be truncated
27629 at the first newline and a panic logged if it does). Such a message cannot
27630 affect the EHLO options that are listed on the second and subsequent lines of
27631 an EHLO response.
27632
27633
27634 .section "The DATA ACLs" "SECID193"
27635 .cindex "DATA" "ACLs for"
27636 Two ACLs are associated with the DATA command, because it is two-stage
27637 command, with two responses being sent to the client.
27638 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27639 is obeyed. This gives you control after all the RCPT commands, but before
27640 the message itself is received. It offers the opportunity to give a negative
27641 response to the DATA command before the data is transmitted. Header lines
27642 added by MAIL or RCPT ACLs are not visible at this time, but any that
27643 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27644
27645 You cannot test the contents of the message, for example, to verify addresses
27646 in the headers, at RCPT time or when the DATA command is received. Such
27647 tests have to appear in the ACL that is run after the message itself has been
27648 received, before the final response to the DATA command is sent. This is
27649 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27650 associated with the DATA command.
27651
27652 For both of these ACLs, it is not possible to reject individual recipients. An
27653 error response rejects the entire message. Unfortunately, it is known that some
27654 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27655 before or after the data) correctly &-- they keep the message on their queues
27656 and try again later, but that is their problem, though it does waste some of
27657 your resources.
27658
27659 The &%acl_smtp_data%& ACL is run after
27660 the &%acl_smtp_data_prdr%&,
27661 the &%acl_smtp_dkim%&
27662 and the &%acl_smtp_mime%& ACLs.
27663
27664 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27665 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27666 enabled (which is the default).
27667
27668 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27669 received, and is executed for each DKIM signature found in a message.  If not
27670 otherwise specified, the default action is to accept.
27671
27672 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27673
27674 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27675
27676
27677 .section "The SMTP MIME ACL" "SECID194"
27678 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27679 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27680
27681 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27682
27683
27684 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27685 .cindex "PRDR" "ACL for"
27686 .oindex "&%prdr_enable%&"
27687 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27688 with PRDR support enabled (which is the default).
27689 It becomes active only when the PRDR feature is negotiated between
27690 client and server for a message, and more than one recipient
27691 has been accepted.
27692
27693 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27694 has been received, and is executed once for each recipient of the message
27695 with &$local_part$& and &$domain$& valid.
27696 The test may accept, defer or deny for individual recipients.
27697 The &%acl_smtp_data%& will still be called after this ACL and
27698 can reject the message overall, even if this ACL has accepted it
27699 for some or all recipients.
27700
27701 PRDR may be used to support per-user content filtering.  Without it
27702 one must defer any recipient after the first that has a different
27703 content-filter configuration.  With PRDR, the RCPT-time check
27704 .cindex "PRDR" "variable for"
27705 for this can be disabled when the variable &$prdr_requested$&
27706 is &"yes"&.
27707 Any required difference in behaviour of the main DATA-time
27708 ACL should however depend on the PRDR-time ACL having run, as Exim
27709 will avoid doing so in some situations (e.g.  single-recipient mails).
27710
27711 See also the &%prdr_enable%& global option
27712 and the &%hosts_try_prdr%& smtp transport option.
27713
27714 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27715 If the ACL is not defined, processing completes as if
27716 the feature was not requested by the client.
27717
27718 .section "The QUIT ACL" "SECTQUITACL"
27719 .cindex "QUIT, ACL for"
27720 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27721 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27722 does not in fact control any access.
27723 For this reason, it may only accept
27724 or warn as its final result.
27725
27726 This ACL can be used for tasks such as custom logging at the end of an SMTP
27727 session. For example, you can use ACL variables in other ACLs to count
27728 messages, recipients, etc., and log the totals at QUIT time using one or
27729 more &%logwrite%& modifiers on a &%warn%& verb.
27730
27731 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27732 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27733
27734 You do not need to have a final &%accept%&, but if you do, you can use a
27735 &%message%& modifier to specify custom text that is sent as part of the 221
27736 response to QUIT.
27737
27738 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27739 failure (for example, failure to open a log file, or when Exim is bombing out
27740 because it has detected an unrecoverable error), all SMTP commands from the
27741 client are given temporary error responses until QUIT is received or the
27742 connection is closed. In these special cases, the QUIT ACL does not run.
27743
27744
27745 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27746 .vindex &$acl_smtp_notquit$&
27747 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27748 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27749 trouble, such as being unable to write to its log files, this ACL is not run,
27750 because it might try to do things (such as write to log files) that make the
27751 situation even worse.
27752
27753 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27754 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27755 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27756 and &%warn%&.
27757
27758 .vindex &$smtp_notquit_reason$&
27759 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27760 to a string that indicates the reason for the termination of the SMTP
27761 connection. The possible values are:
27762 .table2
27763 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27764 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27765 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27766 .irow &`connection-lost`&          "The SMTP connection has been lost"
27767 .irow &`data-timeout`&             "Timeout while reading message data"
27768 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27769 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27770 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27771 .irow &`synchronization-error`&    "SMTP synchronization error"
27772 .irow &`tls-failed`&               "TLS failed to start"
27773 .endtable
27774 In most cases when an SMTP connection is closed without having received QUIT,
27775 Exim sends an SMTP response message before actually closing the connection.
27776 With the exception of the &`acl-drop`& case, the default message can be
27777 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27778 &%drop%& verb in another ACL, it is the message from the other ACL that is
27779 used.
27780
27781
27782 .section "Finding an ACL to use" "SECID195"
27783 .cindex "&ACL;" "finding which to use"
27784 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27785 you can use different ACLs in different circumstances. For example,
27786 .code
27787 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27788                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27789 .endd
27790 In the default configuration file there are some example settings for
27791 providing an RFC 4409 message submission service on port 587 and a
27792 non-standard &"smtps"& service on port 465. You can use a string
27793 expansion like this to choose an ACL for MUAs on these ports which is
27794 more appropriate for this purpose than the default ACL on port 25.
27795
27796 The expanded string does not have to be the name of an ACL in the
27797 configuration file; there are other possibilities. Having expanded the
27798 string, Exim searches for an ACL as follows:
27799
27800 .ilist
27801 If the string begins with a slash, Exim uses it as a file name, and reads its
27802 contents as an ACL. The lines are processed in the same way as lines in the
27803 Exim configuration file. In particular, continuation lines are supported, blank
27804 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27805 If the file does not exist or cannot be read, an error occurs (typically
27806 causing a temporary failure of whatever caused the ACL to be run). For example:
27807 .code
27808 acl_smtp_data = /etc/acls/\
27809   ${lookup{$sender_host_address}lsearch\
27810   {/etc/acllist}{$value}{default}}
27811 .endd
27812 This looks up an ACL file to use on the basis of the host's IP address, falling
27813 back to a default if the lookup fails. If an ACL is successfully read from a
27814 file, it is retained in memory for the duration of the Exim process, so that it
27815 can be re-used without having to re-read the file.
27816 .next
27817 If the string does not start with a slash, and does not contain any spaces,
27818 Exim searches the ACL section of the configuration for an ACL whose name
27819 matches the string.
27820 .next
27821 If no named ACL is found, or if the string contains spaces, Exim parses
27822 the string as an inline ACL. This can save typing in cases where you just
27823 want to have something like
27824 .code
27825 acl_smtp_vrfy = accept
27826 .endd
27827 in order to allow free use of the VRFY command. Such a string may contain
27828 newlines; it is processed in the same way as an ACL that is read from a file.
27829 .endlist
27830
27831
27832
27833
27834 .section "ACL return codes" "SECID196"
27835 .cindex "&ACL;" "return codes"
27836 Except for the QUIT ACL, which does not affect the SMTP return code (see
27837 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27838 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27839 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27840 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27841 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27842 This also causes a 4&'xx'& return code.
27843
27844 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27845 &"deny"&, because there is no mechanism for passing temporary errors to the
27846 submitters of non-SMTP messages.
27847
27848
27849 ACLs that are relevant to message reception may also return &"discard"&. This
27850 has the effect of &"accept"&, but causes either the entire message or an
27851 individual recipient address to be discarded. In other words, it is a
27852 blackholing facility. Use it with care.
27853
27854 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27855 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27856 RCPT ACL is to discard just the one recipient address. If there are no
27857 recipients left when the message's data is received, the DATA ACL is not
27858 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27859 remaining recipients. The &"discard"& return is not permitted for the
27860 &%acl_smtp_predata%& ACL.
27861
27862
27863 .cindex "&[local_scan()]& function" "when all recipients discarded"
27864 The &[local_scan()]& function is always run, even if there are no remaining
27865 recipients; it may create new recipients.
27866
27867
27868
27869 .section "Unset ACL options" "SECID197"
27870 .cindex "&ACL;" "unset options"
27871 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27872 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27873 not defined at all. For any defined ACL, the default action when control
27874 reaches the end of the ACL statements is &"deny"&.
27875
27876 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27877 these two are ACLs that are used only for their side effects. They cannot be
27878 used to accept or reject anything.
27879
27880 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27881 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27882 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27883 when the ACL is not defined is &"accept"&.
27884
27885 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27886 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27887 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27888 messages over an SMTP connection. For an example, see the ACL in the default
27889 configuration file.
27890
27891
27892
27893
27894 .section "Data for message ACLs" "SECID198"
27895 .cindex "&ACL;" "data for message ACL"
27896 .vindex &$domain$&
27897 .vindex &$local_part$&
27898 .vindex &$sender_address$&
27899 .vindex &$sender_host_address$&
27900 .vindex &$smtp_command$&
27901 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27902 that contain information about the host and the message's sender (for example,
27903 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27904 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27905 &$local_part$& are set from the argument address. The entire SMTP command
27906 is available in &$smtp_command$&.
27907
27908 When an ACL for the AUTH parameter of MAIL is running, the variables that
27909 contain information about the host are set, but &$sender_address$& is not yet
27910 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27911 how it is used.
27912
27913 .vindex "&$message_size$&"
27914 The &$message_size$& variable is set to the value of the SIZE parameter on
27915 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27916 that parameter is not given. The value is updated to the true message size by
27917 the time the final DATA ACL is run (after the message data has been
27918 received).
27919
27920 .vindex "&$rcpt_count$&"
27921 .vindex "&$recipients_count$&"
27922 The &$rcpt_count$& variable increases by one for each RCPT command received.
27923 The &$recipients_count$& variable increases by one each time a RCPT command is
27924 accepted, so while an ACL for RCPT is being processed, it contains the number
27925 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27926 &$rcpt_count$& contains the total number of RCPT commands, and
27927 &$recipients_count$& contains the total number of accepted recipients.
27928
27929
27930
27931
27932
27933 .section "Data for non-message ACLs" "SECTdatfornon"
27934 .cindex "&ACL;" "data for non-message ACL"
27935 .vindex &$smtp_command_argument$&
27936 .vindex &$smtp_command$&
27937 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27938 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27939 and the entire SMTP command is available in &$smtp_command$&.
27940 These variables can be tested using a &%condition%& condition. For example,
27941 here is an ACL for use with AUTH, which insists that either the session is
27942 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27943 does not permit authentication methods that use cleartext passwords on
27944 unencrypted connections.
27945 .code
27946 acl_check_auth:
27947   accept encrypted = *
27948   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27949                      {CRAM-MD5}}
27950   deny   message   = TLS encryption or CRAM-MD5 required
27951 .endd
27952 (Another way of applying this restriction is to arrange for the authenticators
27953 that use cleartext passwords not to be advertised when the connection is not
27954 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27955 option to do this.)
27956
27957
27958
27959 .section "Format of an ACL" "SECID199"
27960 .cindex "&ACL;" "format of"
27961 .cindex "&ACL;" "verbs, definition of"
27962 An individual ACL consists of a number of statements. Each statement starts
27963 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27964 Modifiers can change the way the verb operates, define error and log messages,
27965 set variables, insert delays, and vary the processing of accepted messages.
27966
27967 If all the conditions are met, the verb is obeyed. The same condition may be
27968 used (with different arguments) more than once in the same statement. This
27969 provides a means of specifying an &"and"& conjunction between conditions. For
27970 example:
27971 .code
27972 deny  dnslists = list1.example
27973 dnslists = list2.example
27974 .endd
27975 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27976 the conditions and modifiers when it reaches a condition that fails. What
27977 happens then depends on the verb (and in one case, on a special modifier). Not
27978 all the conditions make sense at every testing point. For example, you cannot
27979 test a sender address in the ACL that is run for a VRFY command.
27980
27981
27982 .section "ACL verbs" "SECID200"
27983 The ACL verbs are as follows:
27984
27985 .ilist
27986 .cindex "&%accept%& ACL verb"
27987 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27988 of the conditions are not met, what happens depends on whether &%endpass%&
27989 appears among the conditions (for syntax see below). If the failing condition
27990 is before &%endpass%&, control is passed to the next ACL statement; if it is
27991 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27992 check a RCPT command:
27993 .code
27994 accept domains = +local_domains
27995 endpass
27996 verify = recipient
27997 .endd
27998 If the recipient domain does not match the &%domains%& condition, control
27999 passes to the next statement. If it does match, the recipient is verified, and
28000 the command is accepted if verification succeeds. However, if verification
28001 fails, the ACL yields &"deny"&, because the failing condition is after
28002 &%endpass%&.
28003
28004 The &%endpass%& feature has turned out to be confusing to many people, so its
28005 use is not recommended nowadays. It is always possible to rewrite an ACL so
28006 that &%endpass%& is not needed, and it is no longer used in the default
28007 configuration.
28008
28009 .cindex "&%message%& ACL modifier" "with &%accept%&"
28010 If a &%message%& modifier appears on an &%accept%& statement, its action
28011 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28012 (when an &%accept%& verb either accepts or passes control to the next
28013 statement), &%message%& can be used to vary the message that is sent when an
28014 SMTP command is accepted. For example, in a RCPT ACL you could have:
28015 .display
28016 &`accept  `&<&'some conditions'&>
28017 &`        message = OK, I will allow you through today`&
28018 .endd
28019 You can specify an SMTP response code, optionally followed by an &"extended
28020 response code"& at the start of the message, but the first digit must be the
28021 same as would be sent by default, which is 2 for an &%accept%& verb.
28022
28023 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28024 an error message that is used when access is denied. This behaviour is retained
28025 for backward compatibility, but current &"best practice"& is to avoid the use
28026 of &%endpass%&.
28027
28028
28029 .next
28030 .cindex "&%defer%& ACL verb"
28031 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28032 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28033 &%defer%& is the same as &%deny%&, because there is no way of sending a
28034 temporary error. For a RCPT command, &%defer%& is much the same as using a
28035 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28036 be used in any ACL, and even for a recipient it might be a simpler approach.
28037
28038
28039 .next
28040 .cindex "&%deny%& ACL verb"
28041 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28042 the conditions are not met, control is passed to the next ACL statement. For
28043 example,
28044 .code
28045 deny dnslists = blackholes.mail-abuse.org
28046 .endd
28047 rejects commands from hosts that are on a DNS black list.
28048
28049
28050 .next
28051 .cindex "&%discard%& ACL verb"
28052 &%discard%&: This verb behaves like &%accept%&, except that it returns
28053 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28054 that are concerned with receiving messages. When all the conditions are true,
28055 the sending entity receives a &"success"& response. However, &%discard%& causes
28056 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28057 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28058 message's recipients are discarded. Recipients that are discarded before DATA
28059 do not appear in the log line when the &%received_recipients%& log selector is set.
28060
28061 If the &%log_message%& modifier is set when &%discard%& operates,
28062 its contents are added to the line that is automatically written to the log.
28063 The &%message%& modifier operates exactly as it does for &%accept%&.
28064
28065
28066 .next
28067 .cindex "&%drop%& ACL verb"
28068 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28069 forcibly closed after the 5&'xx'& error message has been sent. For example:
28070 .code
28071 drop   message   = I don't take more than 20 RCPTs
28072        condition = ${if > {$rcpt_count}{20}}
28073 .endd
28074 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28075 The connection is always dropped after sending a 550 response.
28076
28077 .next
28078 .cindex "&%require%& ACL verb"
28079 &%require%&: If all the conditions are met, control is passed to the next ACL
28080 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28081 example, when checking a RCPT command,
28082 .code
28083 require message = Sender did not verify
28084         verify  = sender
28085 .endd
28086 passes control to subsequent statements only if the message's sender can be
28087 verified. Otherwise, it rejects the command. Note the positioning of the
28088 &%message%& modifier, before the &%verify%& condition. The reason for this is
28089 discussed in section &<<SECTcondmodproc>>&.
28090
28091 .next
28092 .cindex "&%warn%& ACL verb"
28093 &%warn%&: If all the conditions are true, a line specified by the
28094 &%log_message%& modifier is written to Exim's main log. Control always passes
28095 to the next ACL statement. If any condition is false, the log line is not
28096 written. If an identical log line is requested several times in the same
28097 message, only one copy is actually written to the log. If you want to force
28098 duplicates to be written, use the &%logwrite%& modifier instead.
28099
28100 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28101 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28102 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28103 first failing condition. There is more about adding header lines in section
28104 &<<SECTaddheadacl>>&.
28105
28106 If any condition on a &%warn%& statement cannot be completed (that is, there is
28107 some sort of defer), the log line specified by &%log_message%& is not written.
28108 This does not include the case of a forced failure from a lookup, which
28109 is considered to be a successful completion. After a defer, no further
28110 conditions or modifiers in the &%warn%& statement are processed. The incident
28111 is logged, and the ACL continues to be processed, from the next statement
28112 onwards.
28113
28114
28115 .vindex "&$acl_verify_message$&"
28116 When one of the &%warn%& conditions is an address verification that fails, the
28117 text of the verification failure message is in &$acl_verify_message$&. If you
28118 want this logged, you must set it up explicitly. For example:
28119 .code
28120 warn   !verify = sender
28121        log_message = sender verify failed: $acl_verify_message
28122 .endd
28123 .endlist
28124
28125 At the end of each ACL there is an implicit unconditional &%deny%&.
28126
28127 As you can see from the examples above, the conditions and modifiers are
28128 written one to a line, with the first one on the same line as the verb, and
28129 subsequent ones on following lines. If you have a very long condition, you can
28130 continue it onto several physical lines by the usual backslash continuation
28131 mechanism. It is conventional to align the conditions vertically.
28132
28133
28134
28135 .section "ACL variables" "SECTaclvariables"
28136 .cindex "&ACL;" "variables"
28137 There are some special variables that can be set during ACL processing. They
28138 can be used to pass information between different ACLs, different invocations
28139 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28140 transports, and filters that are used to deliver a message. The names of these
28141 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28142 an underscore, but the remainder of the name can be any sequence of
28143 alphanumeric characters and underscores that you choose. There is no limit on
28144 the number of ACL variables. The two sets act as follows:
28145 .ilist
28146 The values of those variables whose names begin with &$acl_c$& persist
28147 throughout an SMTP connection. They are never reset. Thus, a value that is set
28148 while receiving one message is still available when receiving the next message
28149 on the same SMTP connection.
28150 .next
28151 The values of those variables whose names begin with &$acl_m$& persist only
28152 while a message is being received. They are reset afterwards. They are also
28153 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28154 .endlist
28155
28156 When a message is accepted, the current values of all the ACL variables are
28157 preserved with the message and are subsequently made available at delivery
28158 time. The ACL variables are set by a modifier called &%set%&. For example:
28159 .code
28160 accept hosts = whatever
28161        set acl_m4 = some value
28162 accept authenticated = *
28163        set acl_c_auth = yes
28164 .endd
28165 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28166 be set. If you want to set a variable without taking any action, you can use a
28167 &%warn%& verb without any other modifiers or conditions.
28168
28169 .oindex &%strict_acl_vars%&
28170 What happens if a syntactically valid but undefined ACL variable is
28171 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28172 false (the default), an empty string is substituted; if it is true, an
28173 error is generated.
28174
28175 Versions of Exim before 4.64 have a limited set of numbered variables, but
28176 their names are compatible, so there is no problem with upgrading.
28177
28178
28179 .section "Condition and modifier processing" "SECTcondmodproc"
28180 .cindex "&ACL;" "conditions; processing"
28181 .cindex "&ACL;" "modifiers; processing"
28182 An exclamation mark preceding a condition negates its result. For example:
28183 .code
28184 deny   domains = *.dom.example
28185       !verify  = recipient
28186 .endd
28187 causes the ACL to return &"deny"& if the recipient domain ends in
28188 &'dom.example'& and the recipient address cannot be verified. Sometimes
28189 negation can be used on the right-hand side of a condition. For example, these
28190 two statements are equivalent:
28191 .code
28192 deny  hosts = !192.168.3.4
28193 deny !hosts =  192.168.3.4
28194 .endd
28195 However, for many conditions (&%verify%& being a good example), only left-hand
28196 side negation of the whole condition is possible.
28197
28198 The arguments of conditions and modifiers are expanded. A forced failure
28199 of an expansion causes a condition to be ignored, that is, it behaves as if the
28200 condition is true. Consider these two statements:
28201 .code
28202 accept  senders = ${lookup{$host_name}lsearch\
28203                   {/some/file}{$value}fail}
28204 accept  senders = ${lookup{$host_name}lsearch\
28205                   {/some/file}{$value}{}}
28206 .endd
28207 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28208 the returned list is searched, but if the lookup fails the behaviour is
28209 different in the two cases. The &%fail%& in the first statement causes the
28210 condition to be ignored, leaving no further conditions. The &%accept%& verb
28211 therefore succeeds. The second statement, however, generates an empty list when
28212 the lookup fails. No sender can match an empty list, so the condition fails,
28213 and therefore the &%accept%& also fails.
28214
28215 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28216 specify actions that are taken as the conditions for a statement are checked;
28217 others specify text for messages that are used when access is denied or a
28218 warning is generated. The &%control%& modifier affects the way an incoming
28219 message is handled.
28220
28221 The positioning of the modifiers in an ACL statement is important, because the
28222 processing of a verb ceases as soon as its outcome is known. Only those
28223 modifiers that have already been encountered will take effect. For example,
28224 consider this use of the &%message%& modifier:
28225 .code
28226 require message = Can't verify sender
28227         verify  = sender
28228         message = Can't verify recipient
28229         verify  = recipient
28230         message = This message cannot be used
28231 .endd
28232 If sender verification fails, Exim knows that the result of the statement is
28233 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28234 so its text is used as the error message. If sender verification succeeds, but
28235 recipient verification fails, the second message is used. If recipient
28236 verification succeeds, the third message becomes &"current"&, but is never used
28237 because there are no more conditions to cause failure.
28238
28239 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28240 modifier that is used, because all the conditions must be true for rejection to
28241 happen. Specifying more than one &%message%& modifier does not make sense, and
28242 the message can even be specified after all the conditions. For example:
28243 .code
28244 deny   hosts = ...
28245       !senders = *@my.domain.example
28246        message = Invalid sender from client host
28247 .endd
28248 The &"deny"& result does not happen until the end of the statement is reached,
28249 by which time Exim has set up the message.
28250
28251
28252
28253 .section "ACL modifiers" "SECTACLmodi"
28254 .cindex "&ACL;" "modifiers; list of"
28255 The ACL modifiers are as follows:
28256
28257 .vlist
28258 .vitem &*add_header*&&~=&~<&'text'&>
28259 This modifier specifies one or more header lines that are to be added to an
28260 incoming message, assuming, of course, that the message is ultimately
28261 accepted. For details, see section &<<SECTaddheadacl>>&.
28262
28263 .vitem &*continue*&&~=&~<&'text'&>
28264 .cindex "&%continue%& ACL modifier"
28265 .cindex "database" "updating in ACL"
28266 This modifier does nothing of itself, and processing of the ACL always
28267 continues with the next condition or modifier. The value of &%continue%& is in
28268 the side effects of expanding its argument. Typically this could be used to
28269 update a database. It is really just a syntactic tidiness, to avoid having to
28270 write rather ugly lines like this:
28271 .display
28272 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28273 .endd
28274 Instead, all you need is
28275 .display
28276 &`continue = `&<&'some expansion'&>
28277 .endd
28278
28279 .vitem &*control*&&~=&~<&'text'&>
28280 .cindex "&%control%& ACL modifier"
28281 This modifier affects the subsequent processing of the SMTP connection or of an
28282 incoming message that is accepted. The effect of the first type of control
28283 lasts for the duration of the connection, whereas the effect of the second type
28284 lasts only until the current message has been received. The message-specific
28285 controls always apply to the whole message, not to individual recipients,
28286 even if the &%control%& modifier appears in a RCPT ACL.
28287
28288 As there are now quite a few controls that can be applied, they are described
28289 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28290 in several different ways. For example:
28291
28292 . ==== As this is a nested list, any displays it contains must be indented
28293 . ==== as otherwise they are too far to the left. That comment applies only
28294 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28295 . ==== way.
28296
28297 .ilist
28298 It can be at the end of an &%accept%& statement:
28299 .code
28300     accept  ...some conditions
28301             control = queue_only
28302 .endd
28303 In this case, the control is applied when this statement yields &"accept"&, in
28304 other words, when the conditions are all true.
28305
28306 .next
28307 It can be in the middle of an &%accept%& statement:
28308 .code
28309     accept  ...some conditions...
28310             control = queue_only
28311             ...some more conditions...
28312 .endd
28313 If the first set of conditions are true, the control is applied, even if the
28314 statement does not accept because one of the second set of conditions is false.
28315 In this case, some subsequent statement must yield &"accept"& for the control
28316 to be relevant.
28317
28318 .next
28319 It can be used with &%warn%& to apply the control, leaving the
28320 decision about accepting or denying to a subsequent verb. For
28321 example:
28322 .code
28323     warn    ...some conditions...
28324             control = freeze
28325     accept  ...
28326 .endd
28327 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28328 &%logwrite%&, so it does not add anything to the message and does not write a
28329 log entry.
28330
28331 .next
28332 If you want to apply a control unconditionally, you can use it with a
28333 &%require%& verb. For example:
28334 .code
28335     require  control = no_multiline_responses
28336 .endd
28337 .endlist
28338
28339 .vitem &*delay*&&~=&~<&'time'&>
28340 .cindex "&%delay%& ACL modifier"
28341 .oindex "&%-bh%&"
28342 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28343 the time interval before proceeding. However, when testing Exim using the
28344 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28345 output instead). The time is given in the usual Exim notation, and the delay
28346 happens as soon as the modifier is processed. In an SMTP session, pending
28347 output is flushed before the delay is imposed.
28348
28349 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28350 example:
28351 .code
28352 deny    ...some conditions...
28353         delay = 30s
28354 .endd
28355 The delay happens if all the conditions are true, before the statement returns
28356 &"deny"&. Compare this with:
28357 .code
28358 deny    delay = 30s
28359         ...some conditions...
28360 .endd
28361 which waits for 30s before processing the conditions. The &%delay%& modifier
28362 can also be used with &%warn%& and together with &%control%&:
28363 .code
28364 warn    ...some conditions...
28365         delay = 2m
28366         control = freeze
28367 accept  ...
28368 .endd
28369
28370 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28371 responses to several commands are no longer buffered and sent in one packet (as
28372 they would normally be) because all output is flushed before imposing the
28373 delay. This optimization is disabled so that a number of small delays do not
28374 appear to the client as one large aggregated delay that might provoke an
28375 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28376 using a &%control%& modifier to set &%no_delay_flush%&.
28377
28378
28379 .vitem &*endpass*&
28380 .cindex "&%endpass%& ACL modifier"
28381 This modifier, which has no argument, is recognized only in &%accept%& and
28382 &%discard%& statements. It marks the boundary between the conditions whose
28383 failure causes control to pass to the next statement, and the conditions whose
28384 failure causes the ACL to return &"deny"&. This concept has proved to be
28385 confusing to some people, so the use of &%endpass%& is no longer recommended as
28386 &"best practice"&. See the description of &%accept%& above for more details.
28387
28388
28389 .vitem &*log_message*&&~=&~<&'text'&>
28390 .cindex "&%log_message%& ACL modifier"
28391 This modifier sets up a message that is used as part of the log message if the
28392 ACL denies access or a &%warn%& statement's conditions are true. For example:
28393 .code
28394 require log_message = wrong cipher suite $tls_in_cipher
28395         encrypted   = DES-CBC3-SHA
28396 .endd
28397 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28398 example:
28399 .display
28400 &`discard `&<&'some conditions'&>
28401 &`        log_message = Discarded $local_part@$domain because...`&
28402 .endd
28403 When access is denied, &%log_message%& adds to any underlying error message
28404 that may exist because of a condition failure. For example, while verifying a
28405 recipient address, a &':fail:'& redirection might have already set up a
28406 message.
28407
28408 The message may be defined before the conditions to which it applies, because
28409 the string expansion does not happen until Exim decides that access is to be
28410 denied. This means that any variables that are set by the condition are
28411 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28412 variables are set after a DNS black list lookup succeeds. If the expansion of
28413 &%log_message%& fails, or if the result is an empty string, the modifier is
28414 ignored.
28415
28416 .vindex "&$acl_verify_message$&"
28417 If you want to use a &%warn%& statement to log the result of an address
28418 verification, you can use &$acl_verify_message$& to include the verification
28419 error message.
28420
28421 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28422 the start of the logged message. If the same warning log message is requested
28423 more than once while receiving  a single email message, only one copy is
28424 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28425 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28426 is logged for a successful &%warn%& statement.
28427
28428 If &%log_message%& is not present and there is no underlying error message (for
28429 example, from the failure of address verification), but &%message%& is present,
28430 the &%message%& text is used for logging rejections. However, if any text for
28431 logging contains newlines, only the first line is logged. In the absence of
28432 both &%log_message%& and &%message%&, a default built-in message is used for
28433 logging rejections.
28434
28435
28436 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28437 .cindex "&%log_reject_target%& ACL modifier"
28438 .cindex "logging in ACL" "specifying which log"
28439 This modifier makes it possible to specify which logs are used for messages
28440 about ACL rejections. Its argument is a colon-separated list of words that can
28441 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28442 may be empty, in which case a rejection is not logged at all. For example, this
28443 ACL fragment writes no logging information when access is denied:
28444 .display
28445 &`deny `&<&'some conditions'&>
28446 &`     log_reject_target =`&
28447 .endd
28448 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28449 permanent and temporary rejections. Its effect lasts for the rest of the
28450 current ACL.
28451
28452
28453 .vitem &*logwrite*&&~=&~<&'text'&>
28454 .cindex "&%logwrite%& ACL modifier"
28455 .cindex "logging in ACL" "immediate"
28456 This modifier writes a message to a log file as soon as it is encountered when
28457 processing an ACL. (Compare &%log_message%&, which, except in the case of
28458 &%warn%& and &%discard%&, is used only if the ACL statement denies
28459 access.) The &%logwrite%& modifier can be used to log special incidents in
28460 ACLs. For example:
28461 .display
28462 &`accept `&<&'some special conditions'&>
28463 &`       control  = freeze`&
28464 &`       logwrite = froze message because ...`&
28465 .endd
28466 By default, the message is written to the main log. However, it may begin
28467 with a colon, followed by a comma-separated list of log names, and then
28468 another colon, to specify exactly which logs are to be written. For
28469 example:
28470 .code
28471 logwrite = :main,reject: text for main and reject logs
28472 logwrite = :panic: text for panic log only
28473 .endd
28474
28475
28476 .vitem &*message*&&~=&~<&'text'&>
28477 .cindex "&%message%& ACL modifier"
28478 This modifier sets up a text string that is expanded and used as a response
28479 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28480 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28481 there is some complication if &%endpass%& is involved; see the description of
28482 &%accept%& for details.)
28483
28484 The expansion of the message happens at the time Exim decides that the ACL is
28485 to end, not at the time it processes &%message%&. If the expansion fails, or
28486 generates an empty string, the modifier is ignored. Here is an example where
28487 &%message%& must be specified first, because the ACL ends with a rejection if
28488 the &%hosts%& condition fails:
28489 .code
28490 require  message = Host not recognized
28491          hosts = 10.0.0.0/8
28492 .endd
28493 (Once a condition has failed, no further conditions or modifiers are
28494 processed.)
28495
28496 .cindex "SMTP" "error codes"
28497 .oindex "&%smtp_banner%&
28498 For ACLs that are triggered by SMTP commands, the message is returned as part
28499 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28500 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28501 is accepted. In the case of the connect ACL, accepting with a message modifier
28502 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28503 accept message may not contain more than one line (otherwise it will be
28504 truncated at the first newline and a panic logged), and it cannot affect the
28505 EHLO options.
28506
28507 When SMTP is involved, the message may begin with an overriding response code,
28508 consisting of three digits optionally followed by an &"extended response code"&
28509 of the form &'n.n.n'&, each code being followed by a space. For example:
28510 .code
28511 deny  message = 599 1.2.3 Host not welcome
28512       hosts = 192.168.34.0/24
28513 .endd
28514 The first digit of the supplied response code must be the same as would be sent
28515 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28516 access, but for the predata ACL, note that the default success code is 354, not
28517 2&'xx'&.
28518
28519 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28520 the message modifier cannot override the 221 response code.
28521
28522 The text in a &%message%& modifier is literal; any quotes are taken as
28523 literals, but because the string is expanded, backslash escapes are processed
28524 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28525 response.
28526
28527 .vindex "&$acl_verify_message$&"
28528 For ACLs that are called by an &%acl =%& ACL condition, the message is
28529 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28530
28531 If &%message%& is used on a statement that verifies an address, the message
28532 specified overrides any message that is generated by the verification process.
28533 However, the original message is available in the variable
28534 &$acl_verify_message$&, so you can incorporate it into your message if you
28535 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28536 routers to be passed back as part of the SMTP response, you should either not
28537 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28538
28539 For compatibility with previous releases of Exim, a &%message%& modifier that
28540 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28541 modifier, but this usage is now deprecated. However, &%message%& acts only when
28542 all the conditions are true, wherever it appears in an ACL command, whereas
28543 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28544 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28545 effect.
28546
28547
28548 .vitem &*remove_header*&&~=&~<&'text'&>
28549 This modifier specifies one or more header names in a colon-separated list
28550  that are to be removed from an incoming message, assuming, of course, that
28551 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28552
28553
28554 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28555 .cindex "&%set%& ACL modifier"
28556 This modifier puts a value into one of the ACL variables (see section
28557 &<<SECTaclvariables>>&).
28558
28559
28560 .vitem &*udpsend*&&~=&~<&'parameters'&>
28561 This modifier sends a UDP packet, for purposes such as statistics
28562 collection or behaviour monitoring. The parameters are expanded, and
28563 the result of the expansion must be a colon-separated list consisting
28564 of a destination server, port number, and the packet contents. The
28565 server can be specified as a host name or IPv4 or IPv6 address. The
28566 separator can be changed with the usual angle bracket syntax. For
28567 example, you might want to collect information on which hosts connect
28568 when:
28569 .code
28570 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28571              $tod_zulu $sender_host_address
28572 .endd
28573 .endlist
28574
28575
28576
28577
28578 .section "Use of the control modifier" "SECTcontrols"
28579 .cindex "&%control%& ACL modifier"
28580 The &%control%& modifier supports the following settings:
28581
28582 .vlist
28583 .vitem &*control&~=&~allow_auth_unadvertised*&
28584 This modifier allows a client host to use the SMTP AUTH command even when it
28585 has not been advertised in response to EHLO. Furthermore, because there are
28586 apparently some really broken clients that do this, Exim will accept AUTH after
28587 HELO (rather than EHLO) when this control is set. It should be used only if you
28588 really need it, and you should limit its use to those broken clients that do
28589 not work without it. For example:
28590 .code
28591 warn hosts   = 192.168.34.25
28592      control = allow_auth_unadvertised
28593 .endd
28594 Normally, when an Exim server receives an AUTH command, it checks the name of
28595 the authentication mechanism that is given in the command to ensure that it
28596 matches an advertised mechanism. When this control is set, the check that a
28597 mechanism has been advertised is bypassed. Any configured mechanism can be used
28598 by the client. This control is permitted only in the connection and HELO ACLs.
28599
28600
28601 .vitem &*control&~=&~caseful_local_part*& &&&
28602        &*control&~=&~caselower_local_part*&
28603 .cindex "&ACL;" "case of local part in"
28604 .cindex "case of local parts"
28605 .vindex "&$local_part$&"
28606 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28607 (that is, during RCPT processing). By default, the contents of &$local_part$&
28608 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28609 any uppercase letters in the original local part are restored in &$local_part$&
28610 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28611 is encountered.
28612
28613 These controls affect only the current recipient. Moreover, they apply only to
28614 local part handling that takes place directly in the ACL (for example, as a key
28615 in lookups). If a test to verify the recipient is obeyed, the case-related
28616 handling of the local part during the verification is controlled by the router
28617 configuration (see the &%caseful_local_part%& generic router option).
28618
28619 This facility could be used, for example, to add a spam score to local parts
28620 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28621 spam score:
28622 .code
28623 warn  control = caseful_local_part
28624       set acl_m4 = ${eval:\
28625                      $acl_m4 + \
28626                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28627                     }
28628       control = caselower_local_part
28629 .endd
28630 Notice that we put back the lower cased version afterwards, assuming that
28631 is what is wanted for subsequent tests.
28632
28633
28634 .vitem &*control&~=&~cutthrough_delivery*&
28635 .cindex "&ACL;" "cutthrough routing"
28636 .cindex "cutthrough" "requesting"
28637 This option requests delivery be attempted while the item is being received.
28638
28639 The option is usable in the RCPT ACL.
28640 If enabled for a message received via smtp and routed to an smtp transport,
28641 and only one transport, interface, destination host and port combination
28642 is used for all recipients of the message,
28643 then the delivery connection is made while the receiving connection is open
28644 and data is copied from one to the other.
28645
28646 An attempt to set this option for any recipient but the first
28647 for a mail will be quietly ignored.
28648 If a recipient-verify callout
28649 (with use_sender)
28650 connection is subsequently
28651 requested in the same ACL it is held open and used for
28652 any subsequent recipients and the data,
28653 otherwise one is made after the initial RCPT ACL completes.
28654
28655 Note that routers are used in verify mode,
28656 and cannot depend on content of received headers.
28657 Note also that headers cannot be
28658 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28659 Headers may be modified by routers (subject to the above) and transports.
28660
28661 All the usual ACLs are called; if one results in the message being
28662 rejected, all effort spent in delivery (including the costs on
28663 the ultimate destination) will be wasted.
28664 Note that in the case of data-time ACLs this includes the entire
28665 message body.
28666
28667 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28668 of outgoing messages is done, because it sends data to the ultimate destination
28669 before the entire message has been received from the source.
28670 It is not supported for messages received with the SMTP PRDR option in use.
28671
28672 Should the ultimate destination system positively accept or reject the mail,
28673 a corresponding indication is given to the source system and nothing is queued.
28674 If there is a temporary error the item is queued for later delivery in the
28675 usual fashion. If the item is successfully delivered in cutthrough mode
28676 the delivery log lines are tagged with ">>" rather than "=>" and appear
28677 before the acceptance "<=" line.
28678
28679 Delivery in this mode avoids the generation of a bounce mail to a
28680 (possibly faked)
28681 sender when the destination system is doing content-scan based rejection.
28682
28683
28684 .vitem &*control&~=&~debug/*&<&'options'&>
28685 .cindex "&ACL;" "enabling debug logging"
28686 .cindex "debugging" "enabling from an ACL"
28687 This control turns on debug logging, almost as though Exim had been invoked
28688 with &`-d`&, with the output going to a new logfile, by default called
28689 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28690 may access any variables already defined.  The logging may be adjusted with
28691 the &'opts'& option, which takes the same values as the &`-d`& command-line
28692 option.  Some examples (which depend on variables that don't exist in all
28693 contexts):
28694 .code
28695       control = debug
28696       control = debug/tag=.$sender_host_address
28697       control = debug/opts=+expand+acl
28698       control = debug/tag=.$message_exim_id/opts=+expand
28699 .endd
28700
28701
28702 .vitem &*control&~=&~dkim_disable_verify*&
28703 .cindex "disable DKIM verify"
28704 .cindex "DKIM" "disable verify"
28705 This control turns off DKIM verification processing entirely.  For details on
28706 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28707
28708
28709 .vitem &*control&~=&~dscp/*&<&'value'&>
28710 .cindex "&ACL;" "setting DSCP value"
28711 .cindex "DSCP" "inbound"
28712 This option causes the DSCP value associated with the socket for the inbound
28713 connection to be adjusted to a given value, given as one of a number of fixed
28714 strings or to numeric value.
28715 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28716 Common values include &`throughput`&, &`mincost`&, and on newer systems
28717 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28718
28719 The outbound packets from Exim will be marked with this value in the header
28720 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28721 that these values will have any effect, not be stripped by networking
28722 equipment, or do much of anything without cooperation with your Network
28723 Engineer and those of all network operators between the source and destination.
28724
28725
28726 .vitem &*control&~=&~enforce_sync*& &&&
28727        &*control&~=&~no_enforce_sync*&
28728 .cindex "SMTP" "synchronization checking"
28729 .cindex "synchronization checking in SMTP"
28730 These controls make it possible to be selective about when SMTP synchronization
28731 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28732 state of the switch (it is true by default). See the description of this option
28733 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28734
28735 The effect of these two controls lasts for the remainder of the SMTP
28736 connection. They can appear in any ACL except the one for the non-SMTP
28737 messages. The most straightforward place to put them is in the ACL defined by
28738 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28739 before the first synchronization check. The expected use is to turn off the
28740 synchronization checks for badly-behaved hosts that you nevertheless need to
28741 work with.
28742
28743
28744 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28745 .cindex "fake defer"
28746 .cindex "defer, fake"
28747 This control works in exactly the same way as &%fakereject%& (described below)
28748 except that it causes an SMTP 450 response after the message data instead of a
28749 550 response. You must take care when using &%fakedefer%& because it causes the
28750 messages to be duplicated when the sender retries. Therefore, you should not
28751 use &%fakedefer%& if the message is to be delivered normally.
28752
28753 .vitem &*control&~=&~fakereject/*&<&'message'&>
28754 .cindex "fake rejection"
28755 .cindex "rejection, fake"
28756 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28757 words, only when an SMTP message is being received. If Exim accepts the
28758 message, instead the final 250 response, a 550 rejection message is sent.
28759 However, Exim proceeds to deliver the message as normal. The control applies
28760 only to the current message, not to any subsequent ones that may be received in
28761 the same SMTP connection.
28762
28763 The text for the 550 response is taken from the &%control%& modifier. If no
28764 message is supplied, the following is used:
28765 .code
28766 550-Your message has been rejected but is being
28767 550-kept for evaluation.
28768 550-If it was a legitimate message, it may still be
28769 550 delivered to the target recipient(s).
28770 .endd
28771 This facility should be used with extreme caution.
28772
28773 .vitem &*control&~=&~freeze*&
28774 .cindex "frozen messages" "forcing in ACL"
28775 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28776 other words, only when a message is being received. If the message is accepted,
28777 it is placed on Exim's queue and frozen. The control applies only to the
28778 current message, not to any subsequent ones that may be received in the same
28779 SMTP connection.
28780
28781 This modifier can optionally be followed by &`/no_tell`&. If the global option
28782 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28783 is told about the freezing), provided all the &*control=freeze*& modifiers that
28784 are obeyed for the current message have the &`/no_tell`& option.
28785
28786 .vitem &*control&~=&~no_delay_flush*&
28787 .cindex "SMTP" "output flushing, disabling for delay"
28788 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28789 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28790 use. This control, as long as it is encountered before the &%delay%& modifier,
28791 disables such output flushing.
28792
28793 .vitem &*control&~=&~no_callout_flush*&
28794 .cindex "SMTP" "output flushing, disabling for callout"
28795 Exim normally flushes SMTP output before performing a callout in an ACL, to
28796 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28797 use. This control, as long as it is encountered before the &%verify%& condition
28798 that causes the callout, disables such output flushing.
28799
28800 .vitem &*control&~=&~no_mbox_unspool*&
28801 This control is available when Exim is compiled with the content scanning
28802 extension. Content scanning may require a copy of the current message, or parts
28803 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28804 or spam scanner. Normally, such copies are deleted when they are no longer
28805 needed. If this control is set, the copies are not deleted. The control applies
28806 only to the current message, not to any subsequent ones that may be received in
28807 the same SMTP connection. It is provided for debugging purposes and is unlikely
28808 to be useful in production.
28809
28810 .vitem &*control&~=&~no_multiline_responses*&
28811 .cindex "multiline responses, suppressing"
28812 This control is permitted for any ACL except the one for non-SMTP messages.
28813 It seems that there are broken clients in use that cannot handle multiline
28814 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28815
28816 If this control is set, multiline SMTP responses from ACL rejections are
28817 suppressed. One way of doing this would have been to put out these responses as
28818 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28819 (&"use multiline responses for more"& it says &-- ha!), and some of the
28820 responses might get close to that. So this facility, which is after all only a
28821 sop to broken clients, is implemented by doing two very easy things:
28822
28823 .ilist
28824 Extra information that is normally output as part of a rejection caused by
28825 sender verification failure is omitted. Only the final line (typically &"sender
28826 verification failed"&) is sent.
28827 .next
28828 If a &%message%& modifier supplies a multiline response, only the first
28829 line is output.
28830 .endlist
28831
28832 The setting of the switch can, of course, be made conditional on the
28833 calling host. Its effect lasts until the end of the SMTP connection.
28834
28835 .vitem &*control&~=&~no_pipelining*&
28836 .cindex "PIPELINING" "suppressing advertising"
28837 This control turns off the advertising of the PIPELINING extension to SMTP in
28838 the current session. To be useful, it must be obeyed before Exim sends its
28839 response to an EHLO command. Therefore, it should normally appear in an ACL
28840 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28841 &%pipelining_advertise_hosts%&.
28842
28843 .vitem &*control&~=&~queue_only*&
28844 .oindex "&%queue_only%&"
28845 .cindex "queueing incoming messages"
28846 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28847 other words, only when a message is being received. If the message is accepted,
28848 it is placed on Exim's queue and left there for delivery by a subsequent queue
28849 runner. No immediate delivery process is started. In other words, it has the
28850 effect as the &%queue_only%& global option. However, the control applies only
28851 to the current message, not to any subsequent ones that may be received in the
28852 same SMTP connection.
28853
28854 .vitem &*control&~=&~submission/*&<&'options'&>
28855 .cindex "message" "submission"
28856 .cindex "submission mode"
28857 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28858 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28859 the current message is a submission from a local MUA. In this case, Exim
28860 operates in &"submission mode"&, and applies certain fixups to the message if
28861 necessary. For example, it adds a &'Date:'& header line if one is not present.
28862 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28863 late (the message has already been created).
28864
28865 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28866 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28867 submission mode; the available options for this control are described there.
28868 The control applies only to the current message, not to any subsequent ones
28869 that may be received in the same SMTP connection.
28870
28871 .vitem &*control&~=&~suppress_local_fixups*&
28872 .cindex "submission fixups, suppressing"
28873 This control applies to locally submitted (non TCP/IP) messages, and is the
28874 complement of &`control = submission`&. It disables the fixups that are
28875 normally applied to locally-submitted messages. Specifically:
28876
28877 .ilist
28878 Any &'Sender:'& header line is left alone (in this respect, it is a
28879 dynamic version of &%local_sender_retain%&).
28880 .next
28881 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28882 .next
28883 There is no check that &'From:'& corresponds to the actual sender.
28884 .endlist ilist
28885
28886 This control may be useful when a remotely-originated message is accepted,
28887 passed to some scanning program, and then re-submitted for delivery. It can be
28888 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28889 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28890 data is read.
28891
28892 &*Note:*& This control applies only to the current message, not to any others
28893 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28894
28895 .vitem &*control&~=&~utf8_downconvert*&
28896 This control enables conversion of UTF-8 in message addresses
28897 to a-label form.
28898 For details see &<<SECTi18nMTA>>&.
28899 .endlist vlist
28900
28901
28902 .section "Summary of message fixup control" "SECTsummesfix"
28903 All four possibilities for message fixups can be specified:
28904
28905 .ilist
28906 Locally submitted, fixups applied: the default.
28907 .next
28908 Locally submitted, no fixups applied: use
28909 &`control = suppress_local_fixups`&.
28910 .next
28911 Remotely submitted, no fixups applied: the default.
28912 .next
28913 Remotely submitted, fixups applied: use &`control = submission`&.
28914 .endlist
28915
28916
28917
28918 .section "Adding header lines in ACLs" "SECTaddheadacl"
28919 .cindex "header lines" "adding in an ACL"
28920 .cindex "header lines" "position of added lines"
28921 .cindex "&%add_header%& ACL modifier"
28922 The &%add_header%& modifier can be used to add one or more extra header lines
28923 to an incoming message, as in this example:
28924 .code
28925 warn dnslists = sbl.spamhaus.org : \
28926                 dialup.mail-abuse.org
28927      add_header = X-blacklisted-at: $dnslist_domain
28928 .endd
28929 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28930 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28931 receiving a message). The message must ultimately be accepted for
28932 &%add_header%& to have any significant effect. You can use &%add_header%& with
28933 any ACL verb, including &%deny%& (though this is potentially useful only in a
28934 RCPT ACL).
28935
28936 Headers will not be added to the message if the modifier is used in
28937 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28938
28939 Leading and trailing newlines are removed from
28940 the data for the &%add_header%& modifier; if it then
28941 contains one or more newlines that
28942 are not followed by a space or a tab, it is assumed to contain multiple header
28943 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28944 front of any line that is not a valid header line.
28945
28946 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28947 They are added to the message before processing the DATA and MIME ACLs.
28948 However, if an identical header line is requested more than once, only one copy
28949 is actually added to the message. Further header lines may be accumulated
28950 during the DATA and MIME ACLs, after which they are added to the message, again
28951 with duplicates suppressed. Thus, it is possible to add two identical header
28952 lines to an SMTP message, but only if one is added before DATA and one after.
28953 In the case of non-SMTP messages, new headers are accumulated during the
28954 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28955 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28956 are included in the entry that is written to the reject log.
28957
28958 .cindex "header lines" "added; visibility of"
28959 Header lines are not visible in string expansions
28960 of message headers
28961 until they are added to the
28962 message. It follows that header lines defined in the MAIL, RCPT, and predata
28963 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28964 header lines that are added by the DATA or MIME ACLs are not visible in those
28965 ACLs. Because of this restriction, you cannot use header lines as a way of
28966 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28967 this, you can use ACL variables, as described in section
28968 &<<SECTaclvariables>>&.
28969
28970 The list of headers yet to be added is given by the &%$headers_added%& variable.
28971
28972 The &%add_header%& modifier acts immediately as it is encountered during the
28973 processing of an ACL. Notice the difference between these two cases:
28974 .display
28975 &`accept add_header = ADDED: some text`&
28976 &`       `&<&'some condition'&>
28977
28978 &`accept `&<&'some condition'&>
28979 &`       add_header = ADDED: some text`&
28980 .endd
28981 In the first case, the header line is always added, whether or not the
28982 condition is true. In the second case, the header line is added only if the
28983 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28984 ACL statement. All those that are encountered before a condition fails are
28985 honoured.
28986
28987 .cindex "&%warn%& ACL verb"
28988 For compatibility with previous versions of Exim, a &%message%& modifier for a
28989 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28990 effect only if all the conditions are true, even if it appears before some of
28991 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28992 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28993 are present on a &%warn%& verb, both are processed according to their
28994 specifications.
28995
28996 By default, new header lines are added to a message at the end of the existing
28997 header lines. However, you can specify that any particular header line should
28998 be added right at the start (before all the &'Received:'& lines), immediately
28999 after the first block of &'Received:'& lines, or immediately before any line
29000 that is not a &'Received:'& or &'Resent-something:'& header.
29001
29002 This is done by specifying &":at_start:"&, &":after_received:"&, or
29003 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29004 header line, respectively. (Header text cannot start with a colon, as there has
29005 to be a header name first.) For example:
29006 .code
29007 warn add_header = \
29008        :after_received:X-My-Header: something or other...
29009 .endd
29010 If more than one header line is supplied in a single &%add_header%& modifier,
29011 each one is treated independently and can therefore be placed differently. If
29012 you add more than one line at the start, or after the Received: block, they end
29013 up in reverse order.
29014
29015 &*Warning*&: This facility currently applies only to header lines that are
29016 added in an ACL. It does NOT work for header lines that are added in a
29017 system filter or in a router or transport.
29018
29019
29020
29021 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29022 .cindex "header lines" "removing in an ACL"
29023 .cindex "header lines" "position of removed lines"
29024 .cindex "&%remove_header%& ACL modifier"
29025 The &%remove_header%& modifier can be used to remove one or more header lines
29026 from an incoming message, as in this example:
29027 .code
29028 warn   message        = Remove internal headers
29029        remove_header  = x-route-mail1 : x-route-mail2
29030 .endd
29031 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29032 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29033 receiving a message). The message must ultimately be accepted for
29034 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29035 with any ACL verb, including &%deny%&, though this is really not useful for
29036 any verb that doesn't result in a delivered message.
29037
29038 Headers will not be removed to the message if the modifier is used in
29039 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29040
29041 More than one header can be removed at the same time by using a colon separated
29042 list of header names. The header matching is case insensitive. Wildcards are
29043 not permitted, nor is list expansion performed, so you cannot use hostlists to
29044 create a list of headers, however both connection and message variable expansion
29045 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29046 .code
29047 warn   hosts           = +internal_hosts
29048        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29049 warn   message         = Remove internal headers
29050        remove_header   = $acl_c_ihdrs
29051 .endd
29052 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29053 They are removed from the message before processing the DATA and MIME ACLs.
29054 There is no harm in attempting to remove the same header twice nor is removing
29055 a non-existent header. Further header lines to be removed may be accumulated
29056 during the DATA and MIME ACLs, after which they are removed from the message,
29057 if present. In the case of non-SMTP messages, headers to be removed are
29058 accumulated during the non-SMTP ACLs, and are removed from the message after
29059 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29060 ACL, there really is no effect because there is no logging of what headers
29061 would have been removed.
29062
29063 .cindex "header lines" "removed; visibility of"
29064 Header lines are not visible in string expansions until the DATA phase when it
29065 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29066 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29067 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29068 this restriction, you cannot use header lines as a way of controlling data
29069 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29070 you should instead use ACL variables, as described in section
29071 &<<SECTaclvariables>>&.
29072
29073 The &%remove_header%& modifier acts immediately as it is encountered during the
29074 processing of an ACL. Notice the difference between these two cases:
29075 .display
29076 &`accept remove_header = X-Internal`&
29077 &`       `&<&'some condition'&>
29078
29079 &`accept `&<&'some condition'&>
29080 &`       remove_header = X-Internal`&
29081 .endd
29082 In the first case, the header line is always removed, whether or not the
29083 condition is true. In the second case, the header line is removed only if the
29084 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29085 same ACL statement. All those that are encountered before a condition fails
29086 are honoured.
29087
29088 &*Warning*&: This facility currently applies only to header lines that are
29089 present during ACL processing. It does NOT remove header lines that are added
29090 in a system filter or in a router or transport.
29091
29092
29093
29094
29095 .section "ACL conditions" "SECTaclconditions"
29096 .cindex "&ACL;" "conditions; list of"
29097 Some of the conditions listed in this section are available only when Exim is
29098 compiled with the content-scanning extension. They are included here briefly
29099 for completeness. More detailed descriptions can be found in the discussion on
29100 content scanning in chapter &<<CHAPexiscan>>&.
29101
29102 Not all conditions are relevant in all circumstances. For example, testing
29103 senders and recipients does not make sense in an ACL that is being run as the
29104 result of the arrival of an ETRN command, and checks on message headers can be
29105 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29106 can use the same condition (with different parameters) more than once in the
29107 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29108 The conditions are as follows:
29109
29110
29111 .vlist
29112 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29113 .cindex "&ACL;" "nested"
29114 .cindex "&ACL;" "indirect"
29115 .cindex "&ACL;" "arguments"
29116 .cindex "&%acl%& ACL condition"
29117 The possible values of the argument are the same as for the
29118 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29119 &"accept"& the condition is true; if it returns &"deny"& the condition is
29120 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29121 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29122 condition false. This means that further processing of the &%warn%& verb
29123 ceases, but processing of the ACL continues.
29124
29125 If the argument is a named ACL, up to nine space-separated optional values
29126 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29127 and $acl_narg is set to the count of values.
29128 Previous values of these variables are restored after the call returns.
29129 The name and values are expanded separately.
29130 Note that spaces in complex expansions which are used as arguments
29131 will act as argument separators.
29132
29133 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29134 the connection is dropped. If it returns &"discard"&, the verb must be
29135 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29136 conditions are tested.
29137
29138 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29139 loops. This condition allows you to use different ACLs in different
29140 circumstances. For example, different ACLs can be used to handle RCPT commands
29141 for different local users or different local domains.
29142
29143 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29144 .cindex "&%authenticated%& ACL condition"
29145 .cindex "authentication" "ACL checking"
29146 .cindex "&ACL;" "testing for authentication"
29147 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29148 the name of the authenticator is tested against the list. To test for
29149 authentication by any authenticator, you can set
29150 .code
29151 authenticated = *
29152 .endd
29153
29154 .vitem &*condition&~=&~*&<&'string'&>
29155 .cindex "&%condition%& ACL condition"
29156 .cindex "customizing" "ACL condition"
29157 .cindex "&ACL;" "customized test"
29158 .cindex "&ACL;" "testing, customized"
29159 This feature allows you to make up custom conditions. If the result of
29160 expanding the string is an empty string, the number zero, or one of the strings
29161 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29162 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29163 any other value, some error is assumed to have occurred, and the ACL returns
29164 &"defer"&. However, if the expansion is forced to fail, the condition is
29165 ignored. The effect is to treat it as true, whether it is positive or
29166 negative.
29167
29168 .vitem &*decode&~=&~*&<&'location'&>
29169 .cindex "&%decode%& ACL condition"
29170 This condition is available only when Exim is compiled with the
29171 content-scanning extension, and it is allowed only in the ACL defined by
29172 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29173 If all goes well, the condition is true. It is false only if there are
29174 problems such as a syntax error or a memory shortage. For more details, see
29175 chapter &<<CHAPexiscan>>&.
29176
29177 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29178 .cindex "&%dnslists%& ACL condition"
29179 .cindex "DNS list" "in ACL"
29180 .cindex "black list (DNS)"
29181 .cindex "&ACL;" "testing a DNS list"
29182 This condition checks for entries in DNS black lists. These are also known as
29183 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29184 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29185 different variants of this condition to describe briefly here. See sections
29186 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29187
29188 .vitem &*domains&~=&~*&<&'domain&~list'&>
29189 .cindex "&%domains%& ACL condition"
29190 .cindex "domain" "ACL checking"
29191 .cindex "&ACL;" "testing a recipient domain"
29192 .vindex "&$domain_data$&"
29193 This condition is relevant only after a RCPT command. It checks that the domain
29194 of the recipient address is in the domain list. If percent-hack processing is
29195 enabled, it is done before this test is done. If the check succeeds with a
29196 lookup, the result of the lookup is placed in &$domain_data$& until the next
29197 &%domains%& test.
29198
29199 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29200 use &%domains%& in a DATA ACL.
29201
29202
29203 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29204 .cindex "&%encrypted%& ACL condition"
29205 .cindex "encryption" "checking in an ACL"
29206 .cindex "&ACL;" "testing for encryption"
29207 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29208 name of the cipher suite in use is tested against the list. To test for
29209 encryption without testing for any specific cipher suite(s), set
29210 .code
29211 encrypted = *
29212 .endd
29213
29214
29215 .vitem &*hosts&~=&~*&<&'host&~list'&>
29216 .cindex "&%hosts%& ACL condition"
29217 .cindex "host" "ACL checking"
29218 .cindex "&ACL;" "testing the client host"
29219 This condition tests that the calling host matches the host list. If you have
29220 name lookups or wildcarded host names and IP addresses in the same host list,
29221 you should normally put the IP addresses first. For example, you could have:
29222 .code
29223 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29224 .endd
29225 The lookup in this example uses the host name for its key. This is implied by
29226 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29227 and it wouldn't matter which way round you had these two items.)
29228
29229 The reason for the problem with host names lies in the left-to-right way that
29230 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29231 but when it reaches an item that requires a host name, it fails if it cannot
29232 find a host name to compare with the pattern. If the above list is given in the
29233 opposite order, the &%accept%& statement fails for a host whose name cannot be
29234 found, even if its IP address is 10.9.8.7.
29235
29236 If you really do want to do the name check first, and still recognize the IP
29237 address even if the name lookup fails, you can rewrite the ACL like this:
29238 .code
29239 accept hosts = dbm;/etc/friendly/hosts
29240 accept hosts = 10.9.8.7
29241 .endd
29242 The default action on failing to find the host name is to assume that the host
29243 is not in the list, so the first &%accept%& statement fails. The second
29244 statement can then check the IP address.
29245
29246 .vindex "&$host_data$&"
29247 If a &%hosts%& condition is satisfied by means of a lookup, the result
29248 of the lookup is made available in the &$host_data$& variable. This
29249 allows you, for example, to set up a statement like this:
29250 .code
29251 deny  hosts = net-lsearch;/some/file
29252 message = $host_data
29253 .endd
29254 which gives a custom error message for each denied host.
29255
29256 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29257 .cindex "&%local_parts%& ACL condition"
29258 .cindex "local part" "ACL checking"
29259 .cindex "&ACL;" "testing a local part"
29260 .vindex "&$local_part_data$&"
29261 This condition is relevant only after a RCPT command. It checks that the local
29262 part of the recipient address is in the list. If percent-hack processing is
29263 enabled, it is done before this test. If the check succeeds with a lookup, the
29264 result of the lookup is placed in &$local_part_data$&, which remains set until
29265 the next &%local_parts%& test.
29266
29267 .vitem &*malware&~=&~*&<&'option'&>
29268 .cindex "&%malware%& ACL condition"
29269 .cindex "&ACL;" "virus scanning"
29270 .cindex "&ACL;" "scanning for viruses"
29271 This condition is available only when Exim is compiled with the
29272 content-scanning extension. It causes the incoming message to be scanned for
29273 viruses. For details, see chapter &<<CHAPexiscan>>&.
29274
29275 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29276 .cindex "&%mime_regex%& ACL condition"
29277 .cindex "&ACL;" "testing by regex matching"
29278 This condition is available only when Exim is compiled with the
29279 content-scanning extension, and it is allowed only in the ACL defined by
29280 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29281 with any of the regular expressions. For details, see chapter
29282 &<<CHAPexiscan>>&.
29283
29284 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29285 .cindex "rate limiting"
29286 This condition can be used to limit the rate at which a user or host submits
29287 messages. Details are given in section &<<SECTratelimiting>>&.
29288
29289 .vitem &*recipients&~=&~*&<&'address&~list'&>
29290 .cindex "&%recipients%& ACL condition"
29291 .cindex "recipient" "ACL checking"
29292 .cindex "&ACL;" "testing a recipient"
29293 This condition is relevant only after a RCPT command. It checks the entire
29294 recipient address against a list of recipients.
29295
29296 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29297 .cindex "&%regex%& ACL condition"
29298 .cindex "&ACL;" "testing by regex matching"
29299 This condition is available only when Exim is compiled with the
29300 content-scanning extension, and is available only in the DATA, MIME, and
29301 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29302 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29303
29304 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29305 .cindex "&%sender_domains%& ACL condition"
29306 .cindex "sender" "ACL checking"
29307 .cindex "&ACL;" "testing a sender domain"
29308 .vindex "&$domain$&"
29309 .vindex "&$sender_address_domain$&"
29310 This condition tests the domain of the sender of the message against the given
29311 domain list. &*Note*&: The domain of the sender address is in
29312 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29313 of this condition. This is an exception to the general rule for testing domain
29314 lists. It is done this way so that, if this condition is used in an ACL for a
29315 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29316 influence the sender checking.
29317
29318 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29319 relaying, because sender addresses are easily, and commonly, forged.
29320
29321 .vitem &*senders&~=&~*&<&'address&~list'&>
29322 .cindex "&%senders%& ACL condition"
29323 .cindex "sender" "ACL checking"
29324 .cindex "&ACL;" "testing a sender"
29325 This condition tests the sender of the message against the given list. To test
29326 for a bounce message, which has an empty sender, set
29327 .code
29328 senders = :
29329 .endd
29330 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29331 relaying, because sender addresses are easily, and commonly, forged.
29332
29333 .vitem &*spam&~=&~*&<&'username'&>
29334 .cindex "&%spam%& ACL condition"
29335 .cindex "&ACL;" "scanning for spam"
29336 This condition is available only when Exim is compiled with the
29337 content-scanning extension. It causes the incoming message to be scanned by
29338 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29339
29340 .vitem &*verify&~=&~certificate*&
29341 .cindex "&%verify%& ACL condition"
29342 .cindex "TLS" "client certificate verification"
29343 .cindex "certificate" "verification of client"
29344 .cindex "&ACL;" "certificate verification"
29345 .cindex "&ACL;" "testing a TLS certificate"
29346 This condition is true in an SMTP session if the session is encrypted, and a
29347 certificate was received from the client, and the certificate was verified. The
29348 server requests a certificate only if the client matches &%tls_verify_hosts%&
29349 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29350
29351 .vitem &*verify&~=&~csa*&
29352 .cindex "CSA verification"
29353 This condition checks whether the sending host (the client) is authorized to
29354 send email. Details of how this works are given in section
29355 &<<SECTverifyCSA>>&.
29356
29357 .vitem &*verify&~=&~header_names_ascii*&
29358 .cindex "&%verify%& ACL condition"
29359 .cindex "&ACL;" "verifying header names only ASCII"
29360 .cindex "header lines" "verifying header names only ASCII"
29361 .cindex "verifying" "header names only ASCII"
29362 This condition is relevant only in an ACL that is run after a message has been
29363 received, that is, in an ACL specified by &%acl_smtp_data%& or
29364 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29365 there are no non-ASCII characters, also excluding control characters.  The
29366 allowable characters are decimal ASCII values 33 through 126.
29367
29368 Exim itself will handle headers with non-ASCII characters, but it can cause
29369 problems for downstream applications, so this option will allow their
29370 detection and rejection in the DATA ACL's.
29371
29372 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29373 .cindex "&%verify%& ACL condition"
29374 .cindex "&ACL;" "verifying sender in the header"
29375 .cindex "header lines" "verifying the sender in"
29376 .cindex "sender" "verifying in header"
29377 .cindex "verifying" "sender in header"
29378 This condition is relevant only in an ACL that is run after a message has been
29379 received, that is, in an ACL specified by &%acl_smtp_data%& or
29380 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29381 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29382 is loosely thought of as a &"sender"& address (hence the name of the test).
29383 However, an address that appears in one of these headers need not be an address
29384 that accepts bounce messages; only sender addresses in envelopes are required
29385 to accept bounces. Therefore, if you use the callout option on this check, you
29386 might want to arrange for a non-empty address in the MAIL command.
29387
29388 Details of address verification and the options are given later, starting at
29389 section &<<SECTaddressverification>>& (callouts are described in section
29390 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29391 condition to restrict it to bounce messages only:
29392 .code
29393 deny    senders = :
29394         message = A valid sender header is required for bounces
29395        !verify  = header_sender
29396 .endd
29397
29398 .vitem &*verify&~=&~header_syntax*&
29399 .cindex "&%verify%& ACL condition"
29400 .cindex "&ACL;" "verifying header syntax"
29401 .cindex "header lines" "verifying syntax"
29402 .cindex "verifying" "header syntax"
29403 This condition is relevant only in an ACL that is run after a message has been
29404 received, that is, in an ACL specified by &%acl_smtp_data%& or
29405 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29406 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29407 and &'Bcc:'&), returning true if there are no problems.
29408 Unqualified addresses (local parts without domains) are
29409 permitted only in locally generated messages and from hosts that match
29410 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29411 appropriate.
29412
29413 Note that this condition is a syntax check only. However, a common spamming
29414 ploy used to be to send syntactically invalid headers such as
29415 .code
29416 To: @
29417 .endd
29418 and this condition can be used to reject such messages, though they are not as
29419 common as they used to be.
29420
29421 .vitem &*verify&~=&~helo*&
29422 .cindex "&%verify%& ACL condition"
29423 .cindex "&ACL;" "verifying HELO/EHLO"
29424 .cindex "HELO" "verifying"
29425 .cindex "EHLO" "verifying"
29426 .cindex "verifying" "EHLO"
29427 .cindex "verifying" "HELO"
29428 This condition is true if a HELO or EHLO command has been received from the
29429 client host, and its contents have been verified. If there has been no previous
29430 attempt to verify the HELO/EHLO contents, it is carried out when this
29431 condition is encountered. See the description of the &%helo_verify_hosts%& and
29432 &%helo_try_verify_hosts%& options for details of how to request verification
29433 independently of this condition.
29434
29435 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29436 option), this condition is always true.
29437
29438
29439 .vitem &*verify&~=&~not_blind*&
29440 .cindex "verifying" "not blind"
29441 .cindex "bcc recipients, verifying none"
29442 This condition checks that there are no blind (bcc) recipients in the message.
29443 Every envelope recipient must appear either in a &'To:'& header line or in a
29444 &'Cc:'& header line for this condition to be true. Local parts are checked
29445 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29446 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29447 used only in a DATA or non-SMTP ACL.
29448
29449 There are, of course, many legitimate messages that make use of blind (bcc)
29450 recipients. This check should not be used on its own for blocking messages.
29451
29452
29453 .vitem &*verify&~=&~recipient/*&<&'options'&>
29454 .cindex "&%verify%& ACL condition"
29455 .cindex "&ACL;" "verifying recipient"
29456 .cindex "recipient" "verifying"
29457 .cindex "verifying" "recipient"
29458 .vindex "&$address_data$&"
29459 This condition is relevant only after a RCPT command. It verifies the current
29460 recipient. Details of address verification are given later, starting at section
29461 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29462 of &$address_data$& is the last value that was set while routing the address.
29463 This applies even if the verification fails. When an address that is being
29464 verified is redirected to a single address, verification continues with the new
29465 address, and in that case, the subsequent value of &$address_data$& is the
29466 value for the child address.
29467
29468 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29469 .cindex "&%verify%& ACL condition"
29470 .cindex "&ACL;" "verifying host reverse lookup"
29471 .cindex "host" "verifying reverse lookup"
29472 This condition ensures that a verified host name has been looked up from the IP
29473 address of the client host. (This may have happened already if the host name
29474 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29475 Verification ensures that the host name obtained from a reverse DNS lookup, or
29476 one of its aliases, does, when it is itself looked up in the DNS, yield the
29477 original IP address.
29478
29479 There is one possible option, &`defer_ok`&.  If this is present and a
29480 DNS operation returns a temporary error, the verify condition succeeds.
29481
29482 If this condition is used for a locally generated message (that is, when there
29483 is no client host involved), it always succeeds.
29484
29485 .vitem &*verify&~=&~sender/*&<&'options'&>
29486 .cindex "&%verify%& ACL condition"
29487 .cindex "&ACL;" "verifying sender"
29488 .cindex "sender" "verifying"
29489 .cindex "verifying" "sender"
29490 This condition is relevant only after a MAIL or RCPT command, or after a
29491 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29492 the message's sender is empty (that is, this is a bounce message), the
29493 condition is true. Otherwise, the sender address is verified.
29494
29495 .vindex "&$address_data$&"
29496 .vindex "&$sender_address_data$&"
29497 If there is data in the &$address_data$& variable at the end of routing, its
29498 value is placed in &$sender_address_data$& at the end of verification. This
29499 value can be used in subsequent conditions and modifiers in the same ACL
29500 statement. It does not persist after the end of the current statement. If you
29501 want to preserve the value for longer, you can save it in an ACL variable.
29502
29503 Details of verification are given later, starting at section
29504 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29505 to avoid doing it more than once per message.
29506
29507 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29508 .cindex "&%verify%& ACL condition"
29509 This is a variation of the previous option, in which a modified address is
29510 verified as a sender.
29511 .endlist
29512
29513
29514
29515 .section "Using DNS lists" "SECTmorednslists"
29516 .cindex "DNS list" "in ACL"
29517 .cindex "black list (DNS)"
29518 .cindex "&ACL;" "testing a DNS list"
29519 In its simplest form, the &%dnslists%& condition tests whether the calling host
29520 is on at least one of a number of DNS lists by looking up the inverted IP
29521 address in one or more DNS domains. (Note that DNS list domains are not mail
29522 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29523 special options instead.) For example, if the calling host's IP
29524 address is 192.168.62.43, and the ACL statement is
29525 .code
29526 deny dnslists = blackholes.mail-abuse.org : \
29527                 dialups.mail-abuse.org
29528 .endd
29529 the following records are looked up:
29530 .code
29531 43.62.168.192.blackholes.mail-abuse.org
29532 43.62.168.192.dialups.mail-abuse.org
29533 .endd
29534 As soon as Exim finds an existing DNS record, processing of the list stops.
29535 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29536 to test that a host is on more than one list (an &"and"& conjunction), you can
29537 use two separate conditions:
29538 .code
29539 deny dnslists = blackholes.mail-abuse.org
29540      dnslists = dialups.mail-abuse.org
29541 .endd
29542 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29543 behaves as if the host does not match the list item, that is, as if the DNS
29544 record does not exist. If there are further items in the DNS list, they are
29545 processed.
29546
29547 This is usually the required action when &%dnslists%& is used with &%deny%&
29548 (which is the most common usage), because it prevents a DNS failure from
29549 blocking mail. However, you can change this behaviour by putting one of the
29550 following special items in the list:
29551 .display
29552 &`+include_unknown `&   behave as if the item is on the list
29553 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29554 &`+defer_unknown   `&   give a temporary error
29555 .endd
29556 .cindex "&`+include_unknown`&"
29557 .cindex "&`+exclude_unknown`&"
29558 .cindex "&`+defer_unknown`&"
29559 Each of these applies to any subsequent items on the list. For example:
29560 .code
29561 deny dnslists = +defer_unknown : foo.bar.example
29562 .endd
29563 Testing the list of domains stops as soon as a match is found. If you want to
29564 warn for one list and block for another, you can use two different statements:
29565 .code
29566 deny  dnslists = blackholes.mail-abuse.org
29567 warn  message  = X-Warn: sending host is on dialups list
29568       dnslists = dialups.mail-abuse.org
29569 .endd
29570 .cindex cacheing "of dns lookup"
29571 .cindex DNS TTL
29572 DNS list lookups are cached by Exim for the duration of the SMTP session
29573 (but limited by the DNS return TTL value),
29574 so a lookup based on the IP address is done at most once for any incoming
29575 connection (assuming long-enough TTL).
29576 Exim does not share information between multiple incoming
29577 connections (but your local name server cache should be active).
29578
29579
29580
29581 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29582 .cindex "DNS list" "keyed by explicit IP address"
29583 By default, the IP address that is used in a DNS list lookup is the IP address
29584 of the calling host. However, you can specify another IP address by listing it
29585 after the domain name, introduced by a slash. For example:
29586 .code
29587 deny dnslists = black.list.tld/192.168.1.2
29588 .endd
29589 This feature is not very helpful with explicit IP addresses; it is intended for
29590 use with IP addresses that are looked up, for example, the IP addresses of the
29591 MX hosts or nameservers of an email sender address. For an example, see section
29592 &<<SECTmulkeyfor>>& below.
29593
29594
29595
29596
29597 .section "DNS lists keyed on domain names" "SECID202"
29598 .cindex "DNS list" "keyed by domain name"
29599 There are some lists that are keyed on domain names rather than inverted IP
29600 addresses (see for example the &'domain based zones'& link at
29601 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29602 with these lists. You can change the name that is looked up in a DNS list by
29603 listing it after the domain name, introduced by a slash. For example,
29604 .code
29605 deny  message  = Sender's domain is listed at $dnslist_domain
29606       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29607 .endd
29608 This particular example is useful only in ACLs that are obeyed after the
29609 RCPT or DATA commands, when a sender address is available. If (for
29610 example) the message's sender is &'user@tld.example'& the name that is looked
29611 up by this example is
29612 .code
29613 tld.example.dsn.rfc-ignorant.org
29614 .endd
29615 A single &%dnslists%& condition can contain entries for both names and IP
29616 addresses. For example:
29617 .code
29618 deny dnslists = sbl.spamhaus.org : \
29619                 dsn.rfc-ignorant.org/$sender_address_domain
29620 .endd
29621 The first item checks the sending host's IP address; the second checks a domain
29622 name. The whole condition is true if either of the DNS lookups succeeds.
29623
29624
29625
29626
29627 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29628 .cindex "DNS list" "multiple keys for"
29629 The syntax described above for looking up explicitly-defined values (either
29630 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29631 name for the DNS list, what follows the slash can in fact be a list of items.
29632 As with all lists in Exim, the default separator is a colon. However, because
29633 this is a sublist within the list of DNS blacklist domains, it is necessary
29634 either to double the separators like this:
29635 .code
29636 dnslists = black.list.tld/name.1::name.2
29637 .endd
29638 or to change the separator character, like this:
29639 .code
29640 dnslists = black.list.tld/<;name.1;name.2
29641 .endd
29642 If an item in the list is an IP address, it is inverted before the DNS
29643 blacklist domain is appended. If it is not an IP address, no inversion
29644 occurs. Consider this condition:
29645 .code
29646 dnslists = black.list.tld/<;192.168.1.2;a.domain
29647 .endd
29648 The DNS lookups that occur are:
29649 .code
29650 2.1.168.192.black.list.tld
29651 a.domain.black.list.tld
29652 .endd
29653 Once a DNS record has been found (that matches a specific IP return
29654 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29655 are done. If there is a temporary DNS error, the rest of the sublist of domains
29656 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29657 only if no other DNS lookup in this sublist succeeds. In other words, a
29658 successful lookup for any of the items in the sublist overrides a temporary
29659 error for a previous item.
29660
29661 The ability to supply a list of items after the slash is in some sense just a
29662 syntactic convenience. These two examples have the same effect:
29663 .code
29664 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29665 dnslists = black.list.tld/a.domain::b.domain
29666 .endd
29667 However, when the data for the list is obtained from a lookup, the second form
29668 is usually much more convenient. Consider this example:
29669 .code
29670 deny message  = The mail servers for the domain \
29671                 $sender_address_domain \
29672                 are listed at $dnslist_domain ($dnslist_value); \
29673                 see $dnslist_text.
29674      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29675                                    ${lookup dnsdb {>|mxh=\
29676                                    $sender_address_domain} }} }
29677 .endd
29678 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29679 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29680 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29681 of expanding the condition might be something like this:
29682 .code
29683 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29684 .endd
29685 Thus, this example checks whether or not the IP addresses of the sender
29686 domain's mail servers are on the Spamhaus black list.
29687
29688 The key that was used for a successful DNS list lookup is put into the variable
29689 &$dnslist_matched$& (see section &<<SECID204>>&).
29690
29691
29692
29693
29694 .section "Data returned by DNS lists" "SECID203"
29695 .cindex "DNS list" "data returned from"
29696 DNS lists are constructed using address records in the DNS. The original RBL
29697 just used the address 127.0.0.1 on the right hand side of each record, but the
29698 RBL+ list and some other lists use a number of values with different meanings.
29699 The values used on the RBL+ list are:
29700 .display
29701 127.1.0.1  RBL
29702 127.1.0.2  DUL
29703 127.1.0.3  DUL and RBL
29704 127.1.0.4  RSS
29705 127.1.0.5  RSS and RBL
29706 127.1.0.6  RSS and DUL
29707 127.1.0.7  RSS and DUL and RBL
29708 .endd
29709 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29710 different values. Some DNS lists may return more than one address record;
29711 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29712
29713
29714 .section "Variables set from DNS lists" "SECID204"
29715 .cindex "expansion" "variables, set from DNS list"
29716 .cindex "DNS list" "variables set from"
29717 .vindex "&$dnslist_domain$&"
29718 .vindex "&$dnslist_matched$&"
29719 .vindex "&$dnslist_text$&"
29720 .vindex "&$dnslist_value$&"
29721 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29722 the name of the overall domain that matched (for example,
29723 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29724 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29725 the DNS record. When the key is an IP address, it is not reversed in
29726 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29727 cases, for example:
29728 .code
29729 deny dnslists = spamhaus.example
29730 .endd
29731 the key is also available in another variable (in this case,
29732 &$sender_host_address$&). In more complicated cases, however, this is not true.
29733 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29734 might generate a dnslists lookup like this:
29735 .code
29736 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29737 .endd
29738 If this condition succeeds, the value in &$dnslist_matched$& might be
29739 &`192.168.6.7`& (for example).
29740
29741 If more than one address record is returned by the DNS lookup, all the IP
29742 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29743 The variable &$dnslist_text$& contains the contents of any associated TXT
29744 record. For lists such as RBL+ the TXT record for a merged entry is often not
29745 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29746 information.
29747
29748 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29749 &-- although these appear before the condition in the ACL, they are not
29750 expanded until after it has failed. For example:
29751 .code
29752 deny    hosts = !+local_networks
29753         message = $sender_host_address is listed \
29754                   at $dnslist_domain
29755         dnslists = rbl-plus.mail-abuse.example
29756 .endd
29757
29758
29759
29760 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29761 .cindex "DNS list" "matching specific returned data"
29762 You can add an equals sign and an IP address after a &%dnslists%& domain name
29763 in order to restrict its action to DNS records with a matching right hand side.
29764 For example,
29765 .code
29766 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29767 .endd
29768 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29769 any address record is considered to be a match. For the moment, we assume
29770 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29771 describes how multiple records are handled.
29772
29773 More than one IP address may be given for checking, using a comma as a
29774 separator. These are alternatives &-- if any one of them matches, the
29775 &%dnslists%& condition is true. For example:
29776 .code
29777 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29778 .endd
29779 If you want to specify a constraining address list and also specify names or IP
29780 addresses to be looked up, the constraining address list must be specified
29781 first. For example:
29782 .code
29783 deny dnslists = dsn.rfc-ignorant.org\
29784                 =127.0.0.2/$sender_address_domain
29785 .endd
29786
29787 If the character &`&&`& is used instead of &`=`&, the comparison for each
29788 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29789 In other words, the listed addresses are used as bit masks. The comparison is
29790 true if all the bits in the mask are present in the address that is being
29791 tested. For example:
29792 .code
29793 dnslists = a.b.c&0.0.0.3
29794 .endd
29795 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29796 want to test whether one bit or another bit is present (as opposed to both
29797 being present), you must use multiple values. For example:
29798 .code
29799 dnslists = a.b.c&0.0.0.1,0.0.0.2
29800 .endd
29801 matches if the final component of the address is an odd number or two times
29802 an odd number.
29803
29804
29805
29806 .section "Negated DNS matching conditions" "SECID205"
29807 You can supply a negative list of IP addresses as part of a &%dnslists%&
29808 condition. Whereas
29809 .code
29810 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29811 .endd
29812 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29813 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29814 .code
29815 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29816 .endd
29817 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29818 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29819 words, the result of the test is inverted if an exclamation mark appears before
29820 the &`=`& (or the &`&&`&) sign.
29821
29822 &*Note*&: This kind of negation is not the same as negation in a domain,
29823 host, or address list (which is why the syntax is different).
29824
29825 If you are using just one list, the negation syntax does not gain you much. The
29826 previous example is precisely equivalent to
29827 .code
29828 deny  dnslists = a.b.c
29829      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29830 .endd
29831 However, if you are using multiple lists, the negation syntax is clearer.
29832 Consider this example:
29833 .code
29834 deny  dnslists = sbl.spamhaus.org : \
29835                  list.dsbl.org : \
29836                  dnsbl.njabl.org!=127.0.0.3 : \
29837                  relays.ordb.org
29838 .endd
29839 Using only positive lists, this would have to be:
29840 .code
29841 deny  dnslists = sbl.spamhaus.org : \
29842                  list.dsbl.org
29843 deny  dnslists = dnsbl.njabl.org
29844      !dnslists = dnsbl.njabl.org=127.0.0.3
29845 deny  dnslists = relays.ordb.org
29846 .endd
29847 which is less clear, and harder to maintain.
29848
29849
29850
29851
29852 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29853 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29854 thereby providing more than one IP address. When an item in a &%dnslists%& list
29855 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29856 the match to specific results from the DNS lookup, there are two ways in which
29857 the checking can be handled. For example, consider the condition:
29858 .code
29859 dnslists = a.b.c=127.0.0.1
29860 .endd
29861 What happens if the DNS lookup for the incoming IP address yields both
29862 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29863 condition true because at least one given value was found, or is it false
29864 because at least one of the found values was not listed? And how does this
29865 affect negated conditions? Both possibilities are provided for with the help of
29866 additional separators &`==`& and &`=&&`&.
29867
29868 .ilist
29869 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29870 IP addresses matches one of the listed addresses. For the example above, the
29871 condition is true because 127.0.0.1 matches.
29872 .next
29873 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29874 looked up IP addresses matches one of the listed addresses. If the condition is
29875 changed to:
29876 .code
29877 dnslists = a.b.c==127.0.0.1
29878 .endd
29879 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29880 false because 127.0.0.2 is not listed. You would need to have:
29881 .code
29882 dnslists = a.b.c==127.0.0.1,127.0.0.2
29883 .endd
29884 for the condition to be true.
29885 .endlist
29886
29887 When &`!`& is used to negate IP address matching, it inverts the result, giving
29888 the precise opposite of the behaviour above. Thus:
29889 .ilist
29890 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29891 addresses matches one of the listed addresses. Consider:
29892 .code
29893 dnslists = a.b.c!&0.0.0.1
29894 .endd
29895 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29896 false because 127.0.0.1 matches.
29897 .next
29898 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29899 looked up IP address that does not match. Consider:
29900 .code
29901 dnslists = a.b.c!=&0.0.0.1
29902 .endd
29903 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29904 true, because 127.0.0.2 does not match. You would need to have:
29905 .code
29906 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29907 .endd
29908 for the condition to be false.
29909 .endlist
29910 When the DNS lookup yields only a single IP address, there is no difference
29911 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29912
29913
29914
29915
29916 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29917 .cindex "DNS list" "information from merged"
29918 When the facility for restricting the matching IP values in a DNS list is used,
29919 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29920 the true reason for rejection. This happens when lists are merged and the IP
29921 address in the A record is used to distinguish them; unfortunately there is
29922 only one TXT record. One way round this is not to use merged lists, but that
29923 can be inefficient because it requires multiple DNS lookups where one would do
29924 in the vast majority of cases when the host of interest is not on any of the
29925 lists.
29926
29927 A less inefficient way of solving this problem is available. If
29928 two domain names, comma-separated, are given, the second is used first to
29929 do an initial check, making use of any IP value restrictions that are set.
29930 If there is a match, the first domain is used, without any IP value
29931 restrictions, to get the TXT record. As a byproduct of this, there is also
29932 a check that the IP being tested is indeed on the first list. The first
29933 domain is the one that is put in &$dnslist_domain$&. For example:
29934 .code
29935 reject message  = \
29936          rejected because $sender_host_address is blacklisted \
29937          at $dnslist_domain\n$dnslist_text
29938        dnslists = \
29939          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29940          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29941 .endd
29942 For the first blacklist item, this starts by doing a lookup in
29943 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29944 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29945 value, and as long as something is found, it looks for the corresponding TXT
29946 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29947 The second blacklist item is processed similarly.
29948
29949 If you are interested in more than one merged list, the same list must be
29950 given several times, but because the results of the DNS lookups are cached,
29951 the DNS calls themselves are not repeated. For example:
29952 .code
29953 reject dnslists = \
29954          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29955          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29956          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29957          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29958 .endd
29959 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29960 values matches (or if no record is found), this is the only lookup that is
29961 done. Only if there is a match is one of the more specific lists consulted.
29962
29963
29964
29965 .section "DNS lists and IPv6" "SECTmorednslistslast"
29966 .cindex "IPv6" "DNS black lists"
29967 .cindex "DNS list" "IPv6 usage"
29968 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29969 nibble by nibble. For example, if the calling host's IP address is
29970 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29971 .code
29972 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29973   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29974 .endd
29975 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29976 lists contain wildcard records, intended for IPv4, that interact badly with
29977 IPv6. For example, the DNS entry
29978 .code
29979 *.3.some.list.example.    A    127.0.0.1
29980 .endd
29981 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29982 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29983
29984 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29985 &%condition%& condition, as in this example:
29986 .code
29987 deny   condition = ${if isip4{$sender_host_address}}
29988        dnslists  = some.list.example
29989 .endd
29990
29991 If an explicit key is being used for a DNS lookup and it may be an IPv6
29992 address you should specify alternate list separators for both the outer
29993 (DNS list name) list and inner (lookup keys) list:
29994 .code
29995        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29996 .endd
29997
29998 .section "Rate limiting incoming messages" "SECTratelimiting"
29999 .cindex "rate limiting" "client sending"
30000 .cindex "limiting client sending rates"
30001 .oindex "&%smtp_ratelimit_*%&"
30002 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30003 which clients can send email. This is more powerful than the
30004 &%smtp_ratelimit_*%& options, because those options control the rate of
30005 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30006 works across all connections (concurrent and sequential) from the same client
30007 host. The syntax of the &%ratelimit%& condition is:
30008 .display
30009 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30010 .endd
30011 If the average client sending rate is less than &'m'& messages per time
30012 period &'p'& then the condition is false; otherwise it is true.
30013
30014 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30015 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30016 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30017 of &'p'&.
30018
30019 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30020 time interval, for example, &`8h`& for eight hours. A larger time constant
30021 means that it takes Exim longer to forget a client's past behaviour. The
30022 parameter &'m'& is the maximum number of messages that a client is permitted to
30023 send in each time interval. It also specifies the number of messages permitted
30024 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30025 constant, you can allow a client to send more messages in a burst without
30026 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30027 both small, messages must be sent at an even rate.
30028
30029 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30030 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30031 when deploying the &%ratelimit%& ACL condition. The script prints usage
30032 instructions when it is run with no arguments.
30033
30034 The key is used to look up the data for calculating the client's average
30035 sending rate. This data is stored in Exim's spool directory, alongside the
30036 retry and other hints databases. The default key is &$sender_host_address$&,
30037 which means Exim computes the sending rate of each client host IP address.
30038 By changing the key you can change how Exim identifies clients for the purpose
30039 of ratelimiting. For example, to limit the sending rate of each authenticated
30040 user, independent of the computer they are sending from, set the key to
30041 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30042 example, &$authenticated_id$& is only meaningful if the client has
30043 authenticated (which you can check with the &%authenticated%& ACL condition).
30044
30045 The lookup key does not have to identify clients: If you want to limit the
30046 rate at which a recipient receives messages, you can use the key
30047 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30048 ACL.
30049
30050 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30051 specifies what Exim measures the rate of, for example messages or recipients
30052 or bytes. You can adjust the measurement using the &%unique=%& and/or
30053 &%count=%& options. You can also control when Exim updates the recorded rate
30054 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30055 separated by a slash, like the other parameters. They may appear in any order.
30056
30057 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30058 any options that alter the meaning of the stored data. The limit &'m'& is not
30059 stored, so you can alter the configured maximum rate and Exim will still
30060 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30061 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30062 behaviour. The lookup key is not affected by changes to the update mode and
30063 the &%count=%& option.
30064
30065
30066 .section "Ratelimit options for what is being measured" "ratoptmea"
30067 .cindex "rate limiting" "per_* options"
30068 The &%per_conn%& option limits the client's connection rate. It is not
30069 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30070 &%acl_not_smtp_start%& ACLs.
30071
30072 The &%per_mail%& option limits the client's rate of sending messages. This is
30073 the default if none of the &%per_*%& options is specified. It can be used in
30074 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30075 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30076
30077 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30078 the same ACLs as the &%per_mail%& option, though it is best to use this option
30079 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30080 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30081 in its MAIL command, which may be inaccurate or completely missing. You can
30082 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30083 in kilobytes, megabytes, or gigabytes, respectively.
30084
30085 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30086 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30087 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30088 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30089 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30090 in either case the rate limiting engine will see a message with many
30091 recipients as a large high-speed burst.
30092
30093 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30094 number of different recipients that the client has sent messages to in the
30095 last time period. That is, if the client repeatedly sends messages to the same
30096 recipient, its measured rate is not increased. This option can only be used in
30097 &%acl_smtp_rcpt%&.
30098
30099 The &%per_cmd%& option causes Exim to recompute the rate every time the
30100 condition is processed. This can be used to limit the rate of any SMTP
30101 command. If it is used in multiple ACLs it can limit the aggregate rate of
30102 multiple different commands.
30103
30104 The &%count=%& option can be used to alter how much Exim adds to the client's
30105 measured rate. For example, the &%per_byte%& option is equivalent to
30106 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30107 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30108 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30109
30110 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30111
30112
30113 .section "Ratelimit update modes" "ratoptupd"
30114 .cindex "rate limiting" "reading data without updating"
30115 You can specify one of three options with the &%ratelimit%& condition to
30116 control when its database is updated. This section describes the &%readonly%&
30117 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30118
30119 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30120 previously-computed rate to check against the limit.
30121
30122 For example, you can test the client's sending rate and deny it access (when
30123 it is too fast) in the connect ACL. If the client passes this check then it
30124 can go on to send a message, in which case its recorded rate will be updated
30125 in the MAIL ACL. Subsequent connections from the same client will check this
30126 new rate.
30127 .code
30128 acl_check_connect:
30129  deny ratelimit = 100 / 5m / readonly
30130     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30131                   (max $sender_rate_limit)
30132 # ...
30133 acl_check_mail:
30134  warn ratelimit = 100 / 5m / strict
30135     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30136                   (max $sender_rate_limit)
30137 .endd
30138
30139 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30140 processing a message then it may increase the client's measured rate more than
30141 it should. For example, this will happen if you check the &%per_rcpt%& option
30142 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30143 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30144 multiple update problems by using the &%readonly%& option on later ratelimit
30145 checks.
30146
30147 The &%per_*%& options described above do not make sense in some ACLs. If you
30148 use a &%per_*%& option in an ACL where it is not normally permitted then the
30149 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30150 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30151 next section) so you must specify the &%readonly%& option explicitly.
30152
30153
30154 .section "Ratelimit options for handling fast clients" "ratoptfast"
30155 .cindex "rate limiting" "strict and leaky modes"
30156 If a client's average rate is greater than the maximum, the rate limiting
30157 engine can react in two possible ways, depending on the presence of the
30158 &%strict%& or &%leaky%& update modes. This is independent of the other
30159 counter-measures (such as rejecting the message) that may be specified by the
30160 rest of the ACL.
30161
30162 The &%leaky%& (default) option means that the client's recorded rate is not
30163 updated if it is above the limit. The effect of this is that Exim measures the
30164 client's average rate of successfully sent email, which cannot be greater than
30165 the maximum allowed. If the client is over the limit it may suffer some
30166 counter-measures (as specified in the ACL), but it will still be able to send
30167 email at the configured maximum rate, whatever the rate of its attempts. This
30168 is generally the better choice if you have clients that retry automatically.
30169 For example, it does not prevent a sender with an over-aggressive retry rate
30170 from getting any email through.
30171
30172 The &%strict%& option means that the client's recorded rate is always
30173 updated. The effect of this is that Exim measures the client's average rate
30174 of attempts to send email, which can be much higher than the maximum it is
30175 actually allowed. If the client is over the limit it may be subjected to
30176 counter-measures by the ACL. It must slow down and allow sufficient time to
30177 pass that its computed rate falls below the maximum before it can send email
30178 again. The time (the number of smoothing periods) it must wait and not
30179 attempt to send mail can be calculated with this formula:
30180 .code
30181         ln(peakrate/maxrate)
30182 .endd
30183
30184
30185 .section "Limiting the rate of different events" "ratoptuniq"
30186 .cindex "rate limiting" "counting unique events"
30187 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30188 rate of different events. For example, the &%per_addr%& option uses this
30189 mechanism to count the number of different recipients that the client has
30190 sent messages to in the last time period; it is equivalent to
30191 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30192 measure the rate that a client uses different sender addresses with the
30193 options &`per_mail/unique=$sender_address`&.
30194
30195 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30196 has seen for that key. The whole set is thrown away when it is older than the
30197 rate smoothing period &'p'&, so each different event is counted at most once
30198 per period. In the &%leaky%& update mode, an event that causes the client to
30199 go over the limit is not added to the set, in the same way that the client's
30200 recorded rate is not updated in the same situation.
30201
30202 When you combine the &%unique=%& and &%readonly%& options, the specific
30203 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30204 rate.
30205
30206 The &%unique=%& mechanism needs more space in the ratelimit database than the
30207 other &%ratelimit%& options in order to store the event set. The number of
30208 unique values is potentially as large as the rate limit, so the extra space
30209 required increases with larger limits.
30210
30211 The uniqueification is not perfect: there is a small probability that Exim
30212 will think a new event has happened before. If the sender's rate is less than
30213 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30214 the measured rate can go above the limit, in which case Exim may under-count
30215 events by a significant margin. Fortunately, if the rate is high enough (2.7
30216 times the limit) that the false positive rate goes above 9%, then Exim will
30217 throw away the over-full event set before the measured rate falls below the
30218 limit. Therefore the only harm should be that exceptionally high sending rates
30219 are logged incorrectly; any countermeasures you configure will be as effective
30220 as intended.
30221
30222
30223 .section "Using rate limiting" "useratlim"
30224 Exim's other ACL facilities are used to define what counter-measures are taken
30225 when the rate limit is exceeded. This might be anything from logging a warning
30226 (for example, while measuring existing sending rates in order to define
30227 policy), through time delays to slow down fast senders, up to rejecting the
30228 message. For example:
30229 .code
30230 # Log all senders' rates
30231 warn ratelimit = 0 / 1h / strict
30232      log_message = Sender rate $sender_rate / $sender_rate_period
30233
30234 # Slow down fast senders; note the need to truncate $sender_rate
30235 # at the decimal point.
30236 warn ratelimit = 100 / 1h / per_rcpt / strict
30237      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30238                    $sender_rate_limit }s
30239
30240 # Keep authenticated users under control
30241 deny authenticated = *
30242      ratelimit = 100 / 1d / strict / $authenticated_id
30243
30244 # System-wide rate limit
30245 defer message = Sorry, too busy. Try again later.
30246      ratelimit = 10 / 1s / $primary_hostname
30247
30248 # Restrict incoming rate from each host, with a default
30249 # set using a macro and special cases looked up in a table.
30250 defer message = Sender rate exceeds $sender_rate_limit \
30251                messages per $sender_rate_period
30252      ratelimit = ${lookup {$sender_host_address} \
30253                    cdb {DB/ratelimits.cdb} \
30254                    {$value} {RATELIMIT} }
30255 .endd
30256 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30257 especially with the &%per_rcpt%& option, you may suffer from a performance
30258 bottleneck caused by locking on the ratelimit hints database. Apart from
30259 making your ACLs less complicated, you can reduce the problem by using a
30260 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30261 this means that Exim will lose its hints data after a reboot (including retry
30262 hints, the callout cache, and ratelimit data).
30263
30264
30265
30266 .section "Address verification" "SECTaddressverification"
30267 .cindex "verifying address" "options for"
30268 .cindex "policy control" "address verification"
30269 Several of the &%verify%& conditions described in section
30270 &<<SECTaclconditions>>& cause addresses to be verified. Section
30271 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30272 The verification conditions can be followed by options that modify the
30273 verification process. The options are separated from the keyword and from each
30274 other by slashes, and some of them contain parameters. For example:
30275 .code
30276 verify = sender/callout
30277 verify = recipient/defer_ok/callout=10s,defer_ok
30278 .endd
30279 The first stage of address verification, which always happens, is to run the
30280 address through the routers, in &"verify mode"&. Routers can detect the
30281 difference between verification and routing for delivery, and their actions can
30282 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30283 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30284 The available options are as follows:
30285
30286 .ilist
30287 If the &%callout%& option is specified, successful routing to one or more
30288 remote hosts is followed by a &"callout"& to those hosts as an additional
30289 check. Callouts and their sub-options are discussed in the next section.
30290 .next
30291 If there is a defer error while doing verification routing, the ACL
30292 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30293 options, the condition is forced to be true instead. Note that this is a main
30294 verification option as well as a suboption for callouts.
30295 .next
30296 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30297 discusses the reporting of sender address verification failures.
30298 .next
30299 The &%success_on_redirect%& option causes verification always to succeed
30300 immediately after a successful redirection. By default, if a redirection
30301 generates just one address, that address is also verified. See further
30302 discussion in section &<<SECTredirwhilveri>>&.
30303 .endlist
30304
30305 .cindex "verifying address" "differentiating failures"
30306 .vindex "&$recipient_verify_failure$&"
30307 .vindex "&$sender_verify_failure$&"
30308 .vindex "&$acl_verify_message$&"
30309 After an address verification failure, &$acl_verify_message$& contains the
30310 error message that is associated with the failure. It can be preserved by
30311 coding like this:
30312 .code
30313 warn  !verify = sender
30314        set acl_m0 = $acl_verify_message
30315 .endd
30316 If you are writing your own custom rejection message or log message when
30317 denying access, you can use this variable to include information about the
30318 verification failure.
30319
30320 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30321 appropriate) contains one of the following words:
30322
30323 .ilist
30324 &%qualify%&: The address was unqualified (no domain), and the message
30325 was neither local nor came from an exempted host.
30326 .next
30327 &%route%&: Routing failed.
30328 .next
30329 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30330 occurred at or before the MAIL command (that is, on initial
30331 connection, HELO, or MAIL).
30332 .next
30333 &%recipient%&: The RCPT command in a callout was rejected.
30334 .next
30335 &%postmaster%&: The postmaster check in a callout was rejected.
30336 .endlist
30337
30338 The main use of these variables is expected to be to distinguish between
30339 rejections of MAIL and rejections of RCPT in callouts.
30340
30341
30342
30343
30344 .section "Callout verification" "SECTcallver"
30345 .cindex "verifying address" "by callout"
30346 .cindex "callout" "verification"
30347 .cindex "SMTP" "callout verification"
30348 For non-local addresses, routing verifies the domain, but is unable to do any
30349 checking of the local part. There are situations where some means of verifying
30350 the local part is desirable. One way this can be done is to make an SMTP
30351 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30352 a subsequent host for a recipient address, to see if the host accepts the
30353 address. We use the term &'callout'& to cover both cases. Note that for a
30354 sender address, the callback is not to the client host that is trying to
30355 deliver the message, but to one of the hosts that accepts incoming mail for the
30356 sender's domain.
30357
30358 Exim does not do callouts by default. If you want them to happen, you must
30359 request them by setting appropriate options on the &%verify%& condition, as
30360 described below. This facility should be used with care, because it can add a
30361 lot of resource usage to the cost of verifying an address. However, Exim does
30362 cache the results of callouts, which helps to reduce the cost. Details of
30363 caching are in section &<<SECTcallvercache>>&.
30364
30365 Recipient callouts are usually used only between hosts that are controlled by
30366 the same administration. For example, a corporate gateway host could use
30367 callouts to check for valid recipients on an internal mailserver. A successful
30368 callout does not guarantee that a real delivery to the address would succeed;
30369 on the other hand, a failing callout does guarantee that a delivery would fail.
30370
30371 If the &%callout%& option is present on a condition that verifies an address, a
30372 second stage of verification occurs if the address is successfully routed to
30373 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30374 &(manualroute)& router, where the router specifies the hosts. However, if a
30375 router that does not set up hosts routes to an &(smtp)& transport with a
30376 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30377 &%hosts_override%& set, its hosts are always used, whether or not the router
30378 supplies a host list.
30379 Callouts are only supported on &(smtp)& transports.
30380
30381 The port that is used is taken from the transport, if it is specified and is a
30382 remote transport. (For routers that do verification only, no transport need be
30383 specified.) Otherwise, the default SMTP port is used. If a remote transport
30384 specifies an outgoing interface, this is used; otherwise the interface is not
30385 specified. Likewise, the text that is used for the HELO command is taken from
30386 the transport's &%helo_data%& option; if there is no transport, the value of
30387 &$smtp_active_hostname$& is used.
30388
30389 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30390 test whether a bounce message could be delivered to the sender address. The
30391 following SMTP commands are sent:
30392 .display
30393 &`HELO `&<&'local host name'&>
30394 &`MAIL FROM:<>`&
30395 &`RCPT TO:`&<&'the address to be tested'&>
30396 &`QUIT`&
30397 .endd
30398 LHLO is used instead of HELO if the transport's &%protocol%& option is
30399 set to &"lmtp"&.
30400
30401 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30402 settings.
30403
30404 A recipient callout check is similar. By default, it also uses an empty address
30405 for the sender. This default is chosen because most hosts do not make use of
30406 the sender address when verifying a recipient. Using the same address means
30407 that a single cache entry can be used for each recipient. Some sites, however,
30408 do make use of the sender address when verifying. These are catered for by the
30409 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30410
30411 If the response to the RCPT command is a 2&'xx'& code, the verification
30412 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30413 Exim tries the next host, if any. If there is a problem with all the remote
30414 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30415 &%callout%& option is given, in which case the condition is forced to succeed.
30416
30417 .cindex "SMTP" "output flushing, disabling for callout"
30418 A callout may take a little time. For this reason, Exim normally flushes SMTP
30419 output before performing a callout in an ACL, to avoid unexpected timeouts in
30420 clients when the SMTP PIPELINING extension is in use. The flushing can be
30421 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30422
30423
30424
30425
30426 .section "Additional parameters for callouts" "CALLaddparcall"
30427 .cindex "callout" "additional parameters for"
30428 The &%callout%& option can be followed by an equals sign and a number of
30429 optional parameters, separated by commas. For example:
30430 .code
30431 verify = recipient/callout=10s,defer_ok
30432 .endd
30433 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30434 separate verify options, is retained for backwards compatibility, but is now
30435 deprecated. The additional parameters for &%callout%& are as follows:
30436
30437
30438 .vlist
30439 .vitem <&'a&~time&~interval'&>
30440 .cindex "callout" "timeout, specifying"
30441 This specifies the timeout that applies for the callout attempt to each host.
30442 For example:
30443 .code
30444 verify = sender/callout=5s
30445 .endd
30446 The default is 30 seconds. The timeout is used for each response from the
30447 remote host. It is also used for the initial connection, unless overridden by
30448 the &%connect%& parameter.
30449
30450
30451 .vitem &*connect&~=&~*&<&'time&~interval'&>
30452 .cindex "callout" "connection timeout, specifying"
30453 This parameter makes it possible to set a different (usually smaller) timeout
30454 for making the SMTP connection. For example:
30455 .code
30456 verify = sender/callout=5s,connect=1s
30457 .endd
30458 If not specified, this timeout defaults to the general timeout value.
30459
30460 .vitem &*defer_ok*&
30461 .cindex "callout" "defer, action on"
30462 When this parameter is present, failure to contact any host, or any other kind
30463 of temporary error, is treated as success by the ACL. However, the cache is not
30464 updated in this circumstance.
30465
30466 .vitem &*fullpostmaster*&
30467 .cindex "callout" "full postmaster check"
30468 This operates like the &%postmaster%& option (see below), but if the check for
30469 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30470 accordance with the specification in RFC 2821. The RFC states that the
30471 unqualified address &'postmaster'& should be accepted.
30472
30473
30474 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30475 .cindex "callout" "sender when verifying header"
30476 When verifying addresses in header lines using the &%header_sender%&
30477 verification option, Exim behaves by default as if the addresses are envelope
30478 sender addresses from a message. Callout verification therefore tests to see
30479 whether a bounce message could be delivered, by using an empty address in the
30480 MAIL command. However, it is arguable that these addresses might never be used
30481 as envelope senders, and could therefore justifiably reject bounce messages
30482 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30483 address to use in the MAIL command. For example:
30484 .code
30485 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30486 .endd
30487 This parameter is available only for the &%header_sender%& verification option.
30488
30489
30490 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30491 .cindex "callout" "overall timeout, specifying"
30492 This parameter sets an overall timeout for performing a callout verification.
30493 For example:
30494 .code
30495 verify = sender/callout=5s,maxwait=30s
30496 .endd
30497 This timeout defaults to four times the callout timeout for individual SMTP
30498 commands. The overall timeout applies when there is more than one host that can
30499 be tried. The timeout is checked before trying the next host. This prevents
30500 very long delays if there are a large number of hosts and all are timing out
30501 (for example, when network connections are timing out).
30502
30503
30504 .vitem &*no_cache*&
30505 .cindex "callout" "cache, suppressing"
30506 .cindex "caching callout, suppressing"
30507 When this parameter is given, the callout cache is neither read nor updated.
30508
30509 .vitem &*postmaster*&
30510 .cindex "callout" "postmaster; checking"
30511 When this parameter is set, a successful callout check is followed by a similar
30512 check for the local part &'postmaster'& at the same domain. If this address is
30513 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30514 the postmaster check is recorded in a cache record; if it is a failure, this is
30515 used to fail subsequent callouts for the domain without a connection being
30516 made, until the cache record expires.
30517
30518 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30519 The postmaster check uses an empty sender in the MAIL command by default.
30520 You can use this parameter to do a postmaster check using a different address.
30521 For example:
30522 .code
30523 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30524 .endd
30525 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30526 one overrides. The &%postmaster%& parameter is equivalent to this example:
30527 .code
30528 require  verify = sender/callout=postmaster_mailfrom=
30529 .endd
30530 &*Warning*&: The caching arrangements for postmaster checking do not take
30531 account of the sender address. It is assumed that either the empty address or
30532 a fixed non-empty address will be used. All that Exim remembers is that the
30533 postmaster check for the domain succeeded or failed.
30534
30535
30536 .vitem &*random*&
30537 .cindex "callout" "&""random""& check"
30538 When this parameter is set, before doing the normal callout check, Exim does a
30539 check for a &"random"& local part at the same domain. The local part is not
30540 really random &-- it is defined by the expansion of the option
30541 &%callout_random_local_part%&, which defaults to
30542 .code
30543 $primary_hostname-$tod_epoch-testing
30544 .endd
30545 The idea here is to try to determine whether the remote host accepts all local
30546 parts without checking. If it does, there is no point in doing callouts for
30547 specific local parts. If the &"random"& check succeeds, the result is saved in
30548 a cache record, and used to force the current and subsequent callout checks to
30549 succeed without a connection being made, until the cache record expires.
30550
30551 .vitem &*use_postmaster*&
30552 .cindex "callout" "sender for recipient check"
30553 This parameter applies to recipient callouts only. For example:
30554 .code
30555 deny  !verify = recipient/callout=use_postmaster
30556 .endd
30557 .vindex "&$qualify_domain$&"
30558 It causes a non-empty postmaster address to be used in the MAIL command when
30559 performing the callout for the recipient, and also for a &"random"& check if
30560 that is configured. The local part of the address is &`postmaster`& and the
30561 domain is the contents of &$qualify_domain$&.
30562
30563 .vitem &*use_sender*&
30564 This option applies to recipient callouts only. For example:
30565 .code
30566 require  verify = recipient/callout=use_sender
30567 .endd
30568 It causes the message's actual sender address to be used in the MAIL
30569 command when performing the callout, instead of an empty address. There is no
30570 need to use this option unless you know that the called hosts make use of the
30571 sender when checking recipients. If used indiscriminately, it reduces the
30572 usefulness of callout caching.
30573 .endlist
30574
30575 If you use any of the parameters that set a non-empty sender for the MAIL
30576 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30577 &%use_sender%&), you should think about possible loops. Recipient checking is
30578 usually done between two hosts that are under the same management, and the host
30579 that receives the callouts is not normally configured to do callouts itself.
30580 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30581 these circumstances.
30582
30583 However, if you use a non-empty sender address for a callout to an arbitrary
30584 host, there is the likelihood that the remote host will itself initiate a
30585 callout check back to your host. As it is checking what appears to be a message
30586 sender, it is likely to use an empty address in MAIL, thus avoiding a
30587 callout loop. However, to be on the safe side it would be best to set up your
30588 own ACLs so that they do not do sender verification checks when the recipient
30589 is the address you use for header sender or postmaster callout checking.
30590
30591 Another issue to think about when using non-empty senders for callouts is
30592 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30593 by the sender/recipient combination; thus, for any given recipient, many more
30594 actual callouts are performed than when an empty sender or postmaster is used.
30595
30596
30597
30598
30599 .section "Callout caching" "SECTcallvercache"
30600 .cindex "hints database" "callout cache"
30601 .cindex "callout" "cache, description of"
30602 .cindex "caching" "callout"
30603 Exim caches the results of callouts in order to reduce the amount of resources
30604 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30605 option. A hints database called &"callout"& is used for the cache. Two
30606 different record types are used: one records the result of a callout check for
30607 a specific address, and the other records information that applies to the
30608 entire domain (for example, that it accepts the local part &'postmaster'&).
30609
30610 When an original callout fails, a detailed SMTP error message is given about
30611 the failure. However, for subsequent failures use the cache data, this message
30612 is not available.
30613
30614 The expiry times for negative and positive address cache records are
30615 independent, and can be set by the global options &%callout_negative_expire%&
30616 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30617
30618 If a host gives a negative response to an SMTP connection, or rejects any
30619 commands up to and including
30620 .code
30621 MAIL FROM:<>
30622 .endd
30623 (but not including the MAIL command with a non-empty address),
30624 any callout attempt is bound to fail. Exim remembers such failures in a
30625 domain cache record, which it uses to fail callouts for the domain without
30626 making new connections, until the domain record times out. There are two
30627 separate expiry times for domain cache records:
30628 &%callout_domain_negative_expire%& (default 3h) and
30629 &%callout_domain_positive_expire%& (default 7d).
30630
30631 Domain records expire when the negative expiry time is reached if callouts
30632 cannot be made for the domain, or if the postmaster check failed.
30633 Otherwise, they expire when the positive expiry time is reached. This
30634 ensures that, for example, a host that stops accepting &"random"& local parts
30635 will eventually be noticed.
30636
30637 The callout caching mechanism is based on the domain of the address that is
30638 being tested. If the domain routes to several hosts, it is assumed that their
30639 behaviour will be the same.
30640
30641
30642
30643 .section "Sender address verification reporting" "SECTsenaddver"
30644 .cindex "verifying" "suppressing error details"
30645 See section &<<SECTaddressverification>>& for a general discussion of
30646 verification. When sender verification fails in an ACL, the details of the
30647 failure are given as additional output lines before the 550 response to the
30648 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30649 you might see:
30650 .code
30651 MAIL FROM:<xyz@abc.example>
30652 250 OK
30653 RCPT TO:<pqr@def.example>
30654 550-Verification failed for <xyz@abc.example>
30655 550-Called:   192.168.34.43
30656 550-Sent:     RCPT TO:<xyz@abc.example>
30657 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30658 550 Sender verification failed
30659 .endd
30660 If more than one RCPT command fails in the same way, the details are given
30661 only for the first of them. However, some administrators do not want to send
30662 out this much information. You can suppress the details by adding
30663 &`/no_details`& to the ACL statement that requests sender verification. For
30664 example:
30665 .code
30666 verify = sender/no_details
30667 .endd
30668
30669 .section "Redirection while verifying" "SECTredirwhilveri"
30670 .cindex "verifying" "redirection while"
30671 .cindex "address redirection" "while verifying"
30672 A dilemma arises when a local address is redirected by aliasing or forwarding
30673 during verification: should the generated addresses themselves be verified,
30674 or should the successful expansion of the original address be enough to verify
30675 it? By default, Exim takes the following pragmatic approach:
30676
30677 .ilist
30678 When an incoming address is redirected to just one child address, verification
30679 continues with the child address, and if that fails to verify, the original
30680 verification also fails.
30681 .next
30682 When an incoming address is redirected to more than one child address,
30683 verification does not continue. A success result is returned.
30684 .endlist
30685
30686 This seems the most reasonable behaviour for the common use of aliasing as a
30687 way of redirecting different local parts to the same mailbox. It means, for
30688 example, that a pair of alias entries of the form
30689 .code
30690 A.Wol:   aw123
30691 aw123:   :fail: Gone away, no forwarding address
30692 .endd
30693 work as expected, with both local parts causing verification failure. When a
30694 redirection generates more than one address, the behaviour is more like a
30695 mailing list, where the existence of the alias itself is sufficient for
30696 verification to succeed.
30697
30698 It is possible, however, to change the default behaviour so that all successful
30699 redirections count as successful verifications, however many new addresses are
30700 generated. This is specified by the &%success_on_redirect%& verification
30701 option. For example:
30702 .code
30703 require verify = recipient/success_on_redirect/callout=10s
30704 .endd
30705 In this example, verification succeeds if a router generates a new address, and
30706 the callout does not occur, because no address was routed to a remote host.
30707
30708 When verification is being tested via the &%-bv%& option, the treatment of
30709 redirections is as just described, unless the &%-v%& or any debugging option is
30710 also specified. In that case, full verification is done for every generated
30711 address and a report is output for each of them.
30712
30713
30714
30715 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30716 .cindex "CSA" "verifying"
30717 Client SMTP Authorization is a system that allows a site to advertise
30718 which machines are and are not permitted to send email. This is done by placing
30719 special SRV records in the DNS; these are looked up using the client's HELO
30720 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30721 Authorization checks in Exim are performed by the ACL condition:
30722 .code
30723 verify = csa
30724 .endd
30725 This fails if the client is not authorized. If there is a DNS problem, or if no
30726 valid CSA SRV record is found, or if the client is authorized, the condition
30727 succeeds. These three cases can be distinguished using the expansion variable
30728 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30729 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30730 be likely to cause problems for legitimate email.
30731
30732 The error messages produced by the CSA code include slightly more
30733 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30734 looking up the CSA SRV record, or problems looking up the CSA target
30735 address record. There are four reasons for &$csa_status$& being &"fail"&:
30736
30737 .ilist
30738 The client's host name is explicitly not authorized.
30739 .next
30740 The client's IP address does not match any of the CSA target IP addresses.
30741 .next
30742 The client's host name is authorized but it has no valid target IP addresses
30743 (for example, the target's addresses are IPv6 and the client is using IPv4).
30744 .next
30745 The client's host name has no CSA SRV record but a parent domain has asserted
30746 that all subdomains must be explicitly authorized.
30747 .endlist
30748
30749 The &%csa%& verification condition can take an argument which is the domain to
30750 use for the DNS query. The default is:
30751 .code
30752 verify = csa/$sender_helo_name
30753 .endd
30754 This implementation includes an extension to CSA. If the query domain
30755 is an address literal such as [192.0.2.95], or if it is a bare IP
30756 address, Exim searches for CSA SRV records in the reverse DNS as if
30757 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30758 meaningful to say:
30759 .code
30760 verify = csa/$sender_host_address
30761 .endd
30762 In fact, this is the check that Exim performs if the client does not say HELO.
30763 This extension can be turned off by setting the main configuration option
30764 &%dns_csa_use_reverse%& to be false.
30765
30766 If a CSA SRV record is not found for the domain itself, a search
30767 is performed through its parent domains for a record which might be
30768 making assertions about subdomains. The maximum depth of this search is limited
30769 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30770 default. Exim does not look for CSA SRV records in a top level domain, so the
30771 default settings handle HELO domains as long as seven
30772 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30773 of legitimate HELO domains.
30774
30775 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30776 direct SRV lookups, this is not sufficient because of the extra parent domain
30777 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30778 addresses into lookups in the reverse DNS space. The result of a successful
30779 lookup such as:
30780 .code
30781 ${lookup dnsdb {csa=$sender_helo_name}}
30782 .endd
30783 has two space-separated fields: an authorization code and a target host name.
30784 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30785 authorization required but absent, or &"?"& for unknown.
30786
30787
30788
30789
30790 .section "Bounce address tag validation" "SECTverifyPRVS"
30791 .cindex "BATV, verifying"
30792 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30793 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30794 Genuine incoming bounce messages should therefore always be addressed to
30795 recipients that have a valid tag. This scheme is a way of detecting unwanted
30796 bounce messages caused by sender address forgeries (often called &"collateral
30797 spam"&), because the recipients of such messages do not include valid tags.
30798
30799 There are two expansion items to help with the implementation of the BATV
30800 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30801 the original envelope sender address by using a simple key to add a hash of the
30802 address and some time-based randomizing information. The &%prvs%& expansion
30803 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30804 The syntax of these expansion items is described in section
30805 &<<SECTexpansionitems>>&.
30806
30807 As an example, suppose the secret per-address keys are stored in an MySQL
30808 database. A query to look up the key for an address could be defined as a macro
30809 like this:
30810 .code
30811 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30812                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30813                 }{$value}}
30814 .endd
30815 Suppose also that the senders who make use of BATV are defined by an address
30816 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30817 use this:
30818 .code
30819 # Bounces: drop unsigned addresses for BATV senders
30820 deny message = This address does not send an unsigned reverse path
30821      senders = :
30822      recipients = +batv_senders
30823
30824 # Bounces: In case of prvs-signed address, check signature.
30825 deny message = Invalid reverse path signature.
30826      senders = :
30827      condition  = ${prvscheck {$local_part@$domain}\
30828                   {PRVSCHECK_SQL}{1}}
30829      !condition = $prvscheck_result
30830 .endd
30831 The first statement rejects recipients for bounce messages that are addressed
30832 to plain BATV sender addresses, because it is known that BATV senders do not
30833 send out messages with plain sender addresses. The second statement rejects
30834 recipients that are prvs-signed, but with invalid signatures (either because
30835 the key is wrong, or the signature has timed out).
30836
30837 A non-prvs-signed address is not rejected by the second statement, because the
30838 &%prvscheck%& expansion yields an empty string if its first argument is not a
30839 prvs-signed address, thus causing the &%condition%& condition to be false. If
30840 the first argument is a syntactically valid prvs-signed address, the yield is
30841 the third string (in this case &"1"&), whether or not the cryptographic and
30842 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30843 of the checks (empty for failure, &"1"& for success).
30844
30845 There is one more issue you must consider when implementing prvs-signing:
30846 you have to ensure that the routers accept prvs-signed addresses and
30847 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30848 router to remove the signature with a configuration along these lines:
30849 .code
30850 batv_redirect:
30851   driver = redirect
30852   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30853 .endd
30854 This works because, if the third argument of &%prvscheck%& is empty, the result
30855 of the expansion of a prvs-signed address is the decoded value of the original
30856 address. This router should probably be the first of your routers that handles
30857 local addresses.
30858
30859 To create BATV-signed addresses in the first place, a transport of this form
30860 can be used:
30861 .code
30862 external_smtp_batv:
30863   driver = smtp
30864   return_path = ${prvs {$return_path} \
30865                        {${lookup mysql{SELECT \
30866                        secret FROM batv_prvs WHERE \
30867                        sender='${quote_mysql:$sender_address}'} \
30868                        {$value}fail}}}
30869 .endd
30870 If no key can be found for the existing return path, no signing takes place.
30871
30872
30873
30874 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30875 .cindex "&ACL;" "relay control"
30876 .cindex "relaying" "control by ACL"
30877 .cindex "policy control" "relay control"
30878 An MTA is said to &'relay'& a message if it receives it from some host and
30879 delivers it directly to another host as a result of a remote address contained
30880 within it. Redirecting a local address via an alias or forward file and then
30881 passing the message on to another host is not relaying,
30882 .cindex "&""percent hack""&"
30883 but a redirection as a result of the &"percent hack"& is.
30884
30885 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30886 A host which is acting as a gateway or an MX backup is concerned with incoming
30887 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30888 a host which is acting as a smart host for a number of clients is concerned
30889 with outgoing relaying from those clients to the Internet at large. Often the
30890 same host is fulfilling both functions,
30891 . ///
30892 . as illustrated in the diagram below,
30893 . ///
30894 but in principle these two kinds of relaying are entirely independent. What is
30895 not wanted is the transmission of mail from arbitrary remote hosts through your
30896 system to arbitrary domains.
30897
30898
30899 You can implement relay control by means of suitable statements in the ACL that
30900 runs for each RCPT command. For convenience, it is often easiest to use
30901 Exim's named list facility to define the domains and hosts involved. For
30902 example, suppose you want to do the following:
30903
30904 .ilist
30905 Deliver a number of domains to mailboxes on the local host (or process them
30906 locally in some other way). Let's say these are &'my.dom1.example'& and
30907 &'my.dom2.example'&.
30908 .next
30909 Relay mail for a number of other domains for which you are the secondary MX.
30910 These might be &'friend1.example'& and &'friend2.example'&.
30911 .next
30912 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30913 Suppose your LAN is 192.168.45.0/24.
30914 .endlist
30915
30916
30917 In the main part of the configuration, you put the following definitions:
30918 .code
30919 domainlist local_domains    = my.dom1.example : my.dom2.example
30920 domainlist relay_to_domains = friend1.example : friend2.example
30921 hostlist   relay_from_hosts = 192.168.45.0/24
30922 .endd
30923 Now you can use these definitions in the ACL that is run for every RCPT
30924 command:
30925 .code
30926 acl_check_rcpt:
30927   accept domains = +local_domains : +relay_to_domains
30928   accept hosts   = +relay_from_hosts
30929 .endd
30930 The first statement accepts any RCPT command that contains an address in
30931 the local or relay domains. For any other domain, control passes to the second
30932 statement, which accepts the command only if it comes from one of the relay
30933 hosts. In practice, you will probably want to make your ACL more sophisticated
30934 than this, for example, by including sender and recipient verification. The
30935 default configuration includes a more comprehensive example, which is described
30936 in chapter &<<CHAPdefconfil>>&.
30937
30938
30939
30940 .section "Checking a relay configuration" "SECTcheralcon"
30941 .cindex "relaying" "checking control of"
30942 You can check the relay characteristics of your configuration in the same way
30943 that you can test any ACL behaviour for an incoming SMTP connection, by using
30944 the &%-bh%& option to run a fake SMTP session with which you interact.
30945 .ecindex IIDacl
30946
30947
30948
30949 . ////////////////////////////////////////////////////////////////////////////
30950 . ////////////////////////////////////////////////////////////////////////////
30951
30952 .chapter "Content scanning at ACL time" "CHAPexiscan"
30953 .scindex IIDcosca "content scanning" "at ACL time"
30954 The extension of Exim to include content scanning at ACL time, formerly known
30955 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30956 was integrated into the main source for Exim release 4.50, and Tom continues to
30957 maintain it. Most of the wording of this chapter is taken from Tom's
30958 specification.
30959
30960 It is also possible to scan the content of messages at other times. The
30961 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30962 scanning after all the ACLs have run. A transport filter can be used to scan
30963 messages at delivery time (see the &%transport_filter%& option, described in
30964 chapter &<<CHAPtransportgeneric>>&).
30965
30966 If you want to include the ACL-time content-scanning features when you compile
30967 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30968 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30969
30970 .ilist
30971 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30972 for all MIME parts for SMTP and non-SMTP messages, respectively.
30973 .next
30974 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30975 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30976 run at the end of message reception (the &%acl_smtp_data%& ACL).
30977 .next
30978 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30979 of messages, or parts of messages, for debugging purposes.
30980 .next
30981 Additional expansion variables that are set in the new ACL and by the new
30982 conditions.
30983 .next
30984 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30985 .endlist
30986
30987 Content-scanning is continually evolving, and new features are still being
30988 added. While such features are still unstable and liable to incompatible
30989 changes, they are made available in Exim by setting options whose names begin
30990 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30991 this manual. You can find out about them by reading the file called
30992 &_doc/experimental.txt_&.
30993
30994 All the content-scanning facilities work on a MBOX copy of the message that is
30995 temporarily created in a file called:
30996 .display
30997 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30998 .endd
30999 The &_.eml_& extension is a friendly hint to virus scanners that they can
31000 expect an MBOX-like structure inside that file. The file is created when the
31001 first content scanning facility is called. Subsequent calls to content
31002 scanning conditions open the same file again. The directory is recursively
31003 removed when the &%acl_smtp_data%& ACL has finished running, unless
31004 .code
31005 control = no_mbox_unspool
31006 .endd
31007 has been encountered. When the MIME ACL decodes files, they are put into the
31008 same directory by default.
31009
31010
31011
31012 .section "Scanning for viruses" "SECTscanvirus"
31013 .cindex "virus scanning"
31014 .cindex "content scanning" "for viruses"
31015 .cindex "content scanning" "the &%malware%& condition"
31016 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31017 It supports a &"generic"& interface to scanners called via the shell, and
31018 specialized interfaces for &"daemon"& type virus scanners, which are resident
31019 in memory and thus are much faster.
31020
31021 A timeout of 2 minutes is applied to a scanner call (by default);
31022 if it expires then a defer action is taken.
31023
31024 .oindex "&%av_scanner%&"
31025 You can set the &%av_scanner%& option in the main part of the configuration
31026 to specify which scanner to use, together with any additional options that
31027 are needed. The basic syntax is as follows:
31028 .display
31029 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31030 .endd
31031 If you do not set &%av_scanner%&, it defaults to
31032 .code
31033 av_scanner = sophie:/var/run/sophie
31034 .endd
31035 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31036 before use.
31037 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31038 The following scanner types are supported in this release:
31039
31040 .vlist
31041 .vitem &%avast%&
31042 .cindex "virus scanners" "avast"
31043 This is the scanner daemon of Avast. It has been tested with Avast Core
31044 Security (currently at version 1.1.7).
31045 You can get a trial version at &url(http://www.avast.com) or for Linux
31046 at &url(http://www.avast.com/linux-server-antivirus).
31047 This scanner type takes one option,
31048 which can be either a full path to a UNIX socket,
31049 or host and port specifiers separated by white space.
31050 The host may be a name or an IP address; the port is either a
31051 single number or a pair of numbers with a dash between.
31052 Any further options are given, on separate lines,
31053 to the daemon as options before the main scan command.
31054 For example:
31055 .code
31056 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31057 av_scanner = avast:192.168.2.22 5036
31058 .endd
31059 If you omit the argument, the default path
31060 &_/var/run/avast/scan.sock_&
31061 is used.
31062 If you use a remote host,
31063 you need to make Exim's spool directory available to it,
31064 as the scanner is passed a file path, not file contents.
31065 For information about available commands and their options you may use
31066 .code
31067 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31068     FLAGS
31069     SENSITIVITY
31070     PACK
31071 .endd
31072
31073
31074 .vitem &%aveserver%&
31075 .cindex "virus scanners" "Kaspersky"
31076 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31077 at &url(http://www.kaspersky.com). This scanner type takes one option,
31078 which is the path to the daemon's UNIX socket. The default is shown in this
31079 example:
31080 .code
31081 av_scanner = aveserver:/var/run/aveserver
31082 .endd
31083
31084
31085 .vitem &%clamd%&
31086 .cindex "virus scanners" "clamd"
31087 This daemon-type scanner is GPL and free. You can get it at
31088 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31089 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31090 in the MIME ACL. This is no longer believed to be necessary.
31091
31092 The options are a list of server specifiers, which may be
31093 a UNIX socket specification,
31094 a TCP socket specification,
31095 or a (global) option.
31096
31097 A socket specification consists of a space-separated list.
31098 For a Unix socket the first element is a full path for the socket,
31099 for a TCP socket the first element is the IP address
31100 and the second a port number,
31101 Any further elements are per-server (non-global) options.
31102 These per-server options are supported:
31103 .code
31104 retry=<timespec>        Retry on connect fail
31105 .endd
31106
31107 The &`retry`& option specifies a time after which a single retry for
31108 a failed connect is made.  The default is to not retry.
31109
31110 If a Unix socket file is specified, only one server is supported.
31111
31112 Examples:
31113 .code
31114 av_scanner = clamd:/opt/clamd/socket
31115 av_scanner = clamd:192.0.2.3 1234
31116 av_scanner = clamd:192.0.2.3 1234:local
31117 av_scanner = clamd:192.0.2.3 1234 retry=10s
31118 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31119 .endd
31120 If the value of av_scanner points to a UNIX socket file or contains the
31121 &`local`&
31122 option, then the ClamAV interface will pass a filename containing the data
31123 to be scanned, which will should normally result in less I/O happening and be
31124 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31125 Exim does not assume that there is a common filesystem with the remote host.
31126 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31127 you be running a version of ClamAV prior to 0.95.
31128
31129 The final example shows that multiple TCP targets can be specified.  Exim will
31130 randomly use one for each incoming email (i.e. it load balances them).  Note
31131 that only TCP targets may be used if specifying a list of scanners; a UNIX
31132 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31133 unavailable, Exim will try the remaining one(s) until it finds one that works.
31134 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31135 not keep track of scanner state between multiple messages, and the scanner
31136 selection is random, so the message will get logged in the mainlog for each
31137 email that the down scanner gets chosen first (message wrapped to be readable):
31138 .code
31139 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31140    clamd: connection to localhost, port 3310 failed
31141    (Connection refused)
31142 .endd
31143
31144 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31145 contributing the code for this scanner.
31146
31147 .vitem &%cmdline%&
31148 .cindex "virus scanners" "command line interface"
31149 This is the keyword for the generic command line scanner interface. It can be
31150 used to attach virus scanners that are invoked from the shell. This scanner
31151 type takes 3 mandatory options:
31152
31153 .olist
31154 The full path and name of the scanner binary, with all command line options,
31155 and a placeholder (&`%s`&) for the directory to scan.
31156
31157 .next
31158 A regular expression to match against the STDOUT and STDERR output of the
31159 virus scanner. If the expression matches, a virus was found. You must make
31160 absolutely sure that this expression matches on &"virus found"&. This is called
31161 the &"trigger"& expression.
31162
31163 .next
31164 Another regular expression, containing exactly one pair of parentheses, to
31165 match the name of the virus found in the scanners output. This is called the
31166 &"name"& expression.
31167 .endlist olist
31168
31169 For example, Sophos Sweep reports a virus on a line like this:
31170 .code
31171 Virus 'W32/Magistr-B' found in file ./those.bat
31172 .endd
31173 For the trigger expression, we can match the phrase &"found in file"&. For the
31174 name expression, we want to extract the W32/Magistr-B string, so we can match
31175 for the single quotes left and right of it. Altogether, this makes the
31176 configuration setting:
31177 .code
31178 av_scanner = cmdline:\
31179              /path/to/sweep -ss -all -rec -archive %s:\
31180              found in file:'(.+)'
31181 .endd
31182 .vitem &%drweb%&
31183 .cindex "virus scanners" "DrWeb"
31184 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31185 takes one option,
31186 either a full path to a UNIX socket,
31187 or host and port specifiers separated by white space.
31188 The host may be a name or an IP address; the port is either a
31189 single number or a pair of numbers with a dash between.
31190 For example:
31191 .code
31192 av_scanner = drweb:/var/run/drwebd.sock
31193 av_scanner = drweb:192.168.2.20 31337
31194 .endd
31195 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31196 is used. Thanks to Alex Miller for contributing the code for this scanner.
31197
31198 .vitem &%f-protd%&
31199 .cindex "virus scanners" "f-protd"
31200 The f-protd scanner is accessed via HTTP over TCP.
31201 One argument is taken, being a space-separated hostname and port number
31202 (or port-range).
31203 For example:
31204 .code
31205 av_scanner = f-protd:localhost 10200-10204
31206 .endd
31207 If you omit the argument, the default values show above are used.
31208
31209 .vitem &%fsecure%&
31210 .cindex "virus scanners" "F-Secure"
31211 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31212 argument which is the path to a UNIX socket. For example:
31213 .code
31214 av_scanner = fsecure:/path/to/.fsav
31215 .endd
31216 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31217 Thelmen for contributing the code for this scanner.
31218
31219 .vitem &%kavdaemon%&
31220 .cindex "virus scanners" "Kaspersky"
31221 This is the scanner daemon of Kaspersky Version 4. This version of the
31222 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31223 scanner type takes one option, which is the path to the daemon's UNIX socket.
31224 For example:
31225 .code
31226 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31227 .endd
31228 The default path is &_/var/run/AvpCtl_&.
31229
31230 .vitem &%mksd%&
31231 .cindex "virus scanners" "mksd"
31232 This is a daemon type scanner that is aimed mainly at Polish users, though some
31233 parts of documentation are now available in English. You can get it at
31234 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31235 the maximum number of processes used simultaneously to scan the attachments,
31236 provided that mksd has
31237 been run with at least the same number of child processes. For example:
31238 .code
31239 av_scanner = mksd:2
31240 .endd
31241 You can safely omit this option (the default value is 1).
31242
31243 .vitem &%sock%&
31244 .cindex "virus scanners" "simple socket-connected"
31245 This is a general-purpose way of talking to simple scanner daemons
31246 running on the local machine.
31247 There are four options:
31248 an address (which may be an IP address and port, or the path of a Unix socket),
31249 a commandline to send (may include a single %s which will be replaced with
31250 the path to the mail file to be scanned),
31251 an RE to trigger on from the returned data,
31252 an RE to extract malware_name from the returned data.
31253 For example:
31254 .code
31255 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31256 .endd
31257 Default for the socket specifier is &_/tmp/malware.sock_&.
31258 Default for the commandline is &_%s\n_&.
31259 Both regular-expressions are required.
31260
31261 .vitem &%sophie%&
31262 .cindex "virus scanners" "Sophos and Sophie"
31263 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31264 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31265 for this scanner type is the path to the UNIX socket that Sophie uses for
31266 client communication. For example:
31267 .code
31268 av_scanner = sophie:/tmp/sophie
31269 .endd
31270 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31271 the option.
31272 .endlist
31273
31274 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31275 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31276 ACL.
31277
31278 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31279 makes it possible to use different scanners. See further below for an example.
31280 The &%malware%& condition caches its results, so when you use it multiple times
31281 for the same message, the actual scanning process is only carried out once.
31282 However, using expandable items in &%av_scanner%& disables this caching, in
31283 which case each use of the &%malware%& condition causes a new scan of the
31284 message.
31285
31286 The &%malware%& condition takes a right-hand argument that is expanded before
31287 use and taken as a list, slash-separated by default.
31288 The first element can then be one of
31289
31290 .ilist
31291 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31292 The condition succeeds if a virus was found, and fail otherwise. This is the
31293 recommended usage.
31294 .next
31295 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31296 the condition fails immediately.
31297 .next
31298 A regular expression, in which case the message is scanned for viruses. The
31299 condition succeeds if a virus is found and its name matches the regular
31300 expression. This allows you to take special actions on certain types of virus.
31301 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31302 unless the separator is changed (in the usual way).
31303 .endlist
31304
31305 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31306 messages even if there is a problem with the virus scanner.
31307 Otherwise, such a problem causes the ACL to defer.
31308
31309 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31310 specify a non-default timeout.  The default is two minutes.
31311 For example:
31312 .code
31313 malware = * / defer_ok / tmo=10s
31314 .endd
31315 A timeout causes the ACL to defer.
31316
31317 .vindex "&$callout_address$&"
31318 When a connection is made to the scanner the expansion variable &$callout_address$&
31319 is set to record the actual address used.
31320
31321 .vindex "&$malware_name$&"
31322 When a virus is found, the condition sets up an expansion variable called
31323 &$malware_name$& that contains the name of the virus. You can use it in a
31324 &%message%& modifier that specifies the error returned to the sender, and/or in
31325 logging data.
31326
31327 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31328 imposed by your anti-virus scanner.
31329
31330 Here is a very simple scanning example:
31331 .code
31332 deny message = This message contains malware ($malware_name)
31333      malware = *
31334 .endd
31335 The next example accepts messages when there is a problem with the scanner:
31336 .code
31337 deny message = This message contains malware ($malware_name)
31338      malware = */defer_ok
31339 .endd
31340 The next example shows how to use an ACL variable to scan with both sophie and
31341 aveserver. It assumes you have set:
31342 .code
31343 av_scanner = $acl_m0
31344 .endd
31345 in the main Exim configuration.
31346 .code
31347 deny message = This message contains malware ($malware_name)
31348      set acl_m0 = sophie
31349      malware = *
31350
31351 deny message = This message contains malware ($malware_name)
31352      set acl_m0 = aveserver
31353      malware = *
31354 .endd
31355
31356
31357 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31358 .cindex "content scanning" "for spam"
31359 .cindex "spam scanning"
31360 .cindex "SpamAssassin"
31361 .cindex "Rspamd"
31362 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31363 score and a report for the message.
31364 Support is also provided for Rspamd.
31365
31366 For more information about installation and configuration of SpamAssassin or
31367 Rspamd refer to their respective websites at
31368 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31369
31370 SpamAssassin can be installed with CPAN by running:
31371 .code
31372 perl -MCPAN -e 'install Mail::SpamAssassin'
31373 .endd
31374 SpamAssassin has its own set of configuration files. Please review its
31375 documentation to see how you can tweak it. The default installation should work
31376 nicely, however.
31377
31378 .oindex "&%spamd_address%&"
31379 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31380 intend to use an instance running on the local host you do not need to set
31381 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31382 you must set the &%spamd_address%& option in the global part of the Exim
31383 configuration as follows (example):
31384 .code
31385 spamd_address = 192.168.99.45 387
31386 .endd
31387
31388 To use Rspamd (which by default listens on all local addresses
31389 on TCP port 11333)
31390 you should add &%variant=rspamd%& after the address/port pair, for example:
31391 .code
31392 spamd_address = 127.0.0.1 11333 variant=rspamd
31393 .endd
31394
31395 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31396 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31397 file name instead of an address/port pair:
31398 .code
31399 spamd_address = /var/run/spamd_socket
31400 .endd
31401 You can have multiple &%spamd%& servers to improve scalability. These can
31402 reside on other hardware reachable over the network. To specify multiple
31403 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31404 option, separated with colons (the separator can be changed in the usual way):
31405 .code
31406 spamd_address = 192.168.2.10 783 : \
31407                 192.168.2.11 783 : \
31408                 192.168.2.12 783
31409 .endd
31410 Up to 32 &%spamd%& servers are supported.
31411 When a server fails to respond to the connection attempt, all other
31412 servers are tried until one succeeds. If no server responds, the &%spam%&
31413 condition defers.
31414
31415 Unix and TCP socket specifications may be mixed in any order.
31416 Each element of the list is a list itself, space-separated by default
31417 and changeable in the usual way.
31418
31419 For TCP socket specifications a host name or IP (v4 or v6, but
31420 subject to list-separator quoting rules) address can be used,
31421 and the port can be one or a dash-separated pair.
31422 In the latter case, the range is tried in strict order.
31423
31424 Elements after the first for Unix sockets, or second for TCP socket,
31425 are options.
31426 The supported options are:
31427 .code
31428 pri=<priority>      Selection priority
31429 weight=<value>      Selection bias
31430 time=<start>-<end>  Use only between these times of day
31431 retry=<timespec>    Retry on connect fail
31432 tmo=<timespec>      Connection time limit
31433 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31434 .endd
31435
31436 The &`pri`& option specifies a priority for the server within the list,
31437 higher values being tried first.
31438 The default priority is 1.
31439
31440 The &`weight`& option specifies a selection bias.
31441 Within a priority set
31442 servers are queried in a random fashion, weighted by this value.
31443 The default value for selection bias is 1.
31444
31445 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31446 in the local time zone; each element being one or more digits.
31447 Either the seconds or both minutes and seconds, plus the leading &`.`&
31448 characters, may be omitted and will be taken as zero.
31449
31450 Timeout specifications for the &`retry`& and &`tmo`& options
31451 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31452
31453 The &`tmo`& option specifies an overall timeout for communication.
31454 The default value is two minutes.
31455
31456 The &`retry`& option specifies a time after which a single retry for
31457 a failed connect is made.
31458 The default is to not retry.
31459
31460 The &%spamd_address%& variable is expanded before use if it starts with
31461 a dollar sign. In this case, the expansion may return a string that is
31462 used as the list so that multiple spamd servers can be the result of an
31463 expansion.
31464
31465 .vindex "&$callout_address$&"
31466 When a connection is made to the server the expansion variable &$callout_address$&
31467 is set to record the actual address used.
31468
31469 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31470 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31471 .code
31472 deny message = This message was classified as SPAM
31473      spam = joe
31474 .endd
31475 The right-hand side of the &%spam%& condition specifies a name. This is
31476 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31477 to scan using a specific profile, but rather use the SpamAssassin system-wide
31478 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31479 Rspamd does not use this setting. However, you must put something on the
31480 right-hand side.
31481
31482 The name allows you to use per-domain or per-user antispam profiles in
31483 principle, but this is not straightforward in practice, because a message may
31484 have multiple recipients, not necessarily all in the same domain. Because the
31485 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31486 read the contents of the message, the variables &$local_part$& and &$domain$&
31487 are not set.
31488 Careful enforcement of single-recipient messages
31489 (e.g. by responding with defer in the recipient ACL for all recipients
31490 after the first),
31491 or the use of PRDR,
31492 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31493 are needed to use this feature.
31494
31495 The right-hand side of the &%spam%& condition is expanded before being used, so
31496 you can put lookups or conditions there. When the right-hand side evaluates to
31497 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31498
31499
31500 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31501 large ones may cause significant performance degradation. As most spam messages
31502 are quite small, it is recommended that you do not scan the big ones. For
31503 example:
31504 .code
31505 deny message = This message was classified as SPAM
31506      condition = ${if < {$message_size}{10K}}
31507      spam = nobody
31508 .endd
31509
31510 The &%spam%& condition returns true if the threshold specified in the user's
31511 SpamAssassin profile has been matched or exceeded. If you want to use the
31512 &%spam%& condition for its side effects (see the variables below), you can make
31513 it always return &"true"& by appending &`:true`& to the username.
31514
31515 .cindex "spam scanning" "returned variables"
31516 When the &%spam%& condition is run, it sets up a number of expansion
31517 variables.
31518 Except for &$spam_report$&,
31519 these variables are saved with the received message so are
31520 available for use at delivery time.
31521
31522 .vlist
31523 .vitem &$spam_score$&
31524 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31525 for inclusion in log or reject messages.
31526
31527 .vitem &$spam_score_int$&
31528 The spam score of the message, multiplied by ten, as an integer value. For
31529 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31530 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31531 The integer value is useful for numeric comparisons in conditions.
31532
31533 .vitem &$spam_bar$&
31534 A string consisting of a number of &"+"& or &"-"& characters, representing the
31535 integer part of the spam score value. A spam score of 4.4 would have a
31536 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31537 headers, since MUAs can match on such strings. The maximum length of the
31538 spam bar is 50 characters.
31539
31540 .vitem &$spam_report$&
31541 A multiline text table, containing the full SpamAssassin report for the
31542 message. Useful for inclusion in headers or reject messages.
31543 This variable is only usable in a DATA-time ACL.
31544
31545 .vitem &$spam_action$&
31546 For SpamAssassin either 'reject' or 'no action' depending on the
31547 spam score versus threshold.
31548 For Rspamd, the recommended action.
31549
31550 .endlist
31551
31552 The &%spam%& condition caches its results unless expansion in
31553 spamd_address was used. If you call it again with the same user name, it
31554 does not scan again, but rather returns the same values as before.
31555
31556 The &%spam%& condition returns DEFER if there is any error while running
31557 the message through SpamAssassin or if the expansion of spamd_address
31558 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31559 statement block), append &`/defer_ok`& to the right-hand side of the
31560 spam condition, like this:
31561 .code
31562 deny message = This message was classified as SPAM
31563      spam    = joe/defer_ok
31564 .endd
31565 This causes messages to be accepted even if there is a problem with &%spamd%&.
31566
31567 Here is a longer, commented example of the use of the &%spam%&
31568 condition:
31569 .code
31570 # put headers in all messages (no matter if spam or not)
31571 warn  spam = nobody:true
31572       add_header = X-Spam-Score: $spam_score ($spam_bar)
31573       add_header = X-Spam-Report: $spam_report
31574
31575 # add second subject line with *SPAM* marker when message
31576 # is over threshold
31577 warn  spam = nobody
31578       add_header = Subject: *SPAM* $h_Subject:
31579
31580 # reject spam at high scores (> 12)
31581 deny  message = This message scored $spam_score spam points.
31582       spam = nobody:true
31583       condition = ${if >{$spam_score_int}{120}{1}{0}}
31584 .endd
31585
31586
31587
31588 .section "Scanning MIME parts" "SECTscanmimepart"
31589 .cindex "content scanning" "MIME parts"
31590 .cindex "MIME content scanning"
31591 .oindex "&%acl_smtp_mime%&"
31592 .oindex "&%acl_not_smtp_mime%&"
31593 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31594 each MIME part of an SMTP message, including multipart types, in the sequence
31595 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31596 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31597 options may both refer to the same ACL if you want the same processing in both
31598 cases.
31599
31600 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31601 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31602 the case of a non-SMTP message. However, a MIME ACL is called only if the
31603 message contains a &'Content-Type:'& header line. When a call to a MIME
31604 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31605 result code is sent to the client. In the case of an SMTP message, the
31606 &%acl_smtp_data%& ACL is not called when this happens.
31607
31608 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31609 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31610 condition to match against the raw MIME part. You can also use the
31611 &%mime_regex%& condition to match against the decoded MIME part (see section
31612 &<<SECTscanregex>>&).
31613
31614 At the start of a MIME ACL, a number of variables are set from the header
31615 information for the relevant MIME part. These are described below. The contents
31616 of the MIME part are not by default decoded into a disk file except for MIME
31617 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31618 part into a disk file, you can use the &%decode%& condition. The general
31619 syntax is:
31620 .display
31621 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31622 .endd
31623 The right hand side is expanded before use. After expansion,
31624 the value can be:
31625
31626 .olist
31627 &"0"& or &"false"&, in which case no decoding is done.
31628 .next
31629 The string &"default"&. In that case, the file is put in the temporary
31630 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31631 a sequential file name consisting of the message id and a sequence number. The
31632 full path and name is available in &$mime_decoded_filename$& after decoding.
31633 .next
31634 A full path name starting with a slash. If the full name is an existing
31635 directory, it is used as a replacement for the default directory. The filename
31636 is then sequentially assigned. If the path does not exist, it is used as
31637 the full path and file name.
31638 .next
31639 If the string does not start with a slash, it is used as the
31640 filename, and the default path is then used.
31641 .endlist
31642 The &%decode%& condition normally succeeds. It is only false for syntax
31643 errors or unusual circumstances such as memory shortages. You can easily decode
31644 a file with its original, proposed filename using
31645 .code
31646 decode = $mime_filename
31647 .endd
31648 However, you should keep in mind that &$mime_filename$& might contain
31649 anything. If you place files outside of the default path, they are not
31650 automatically unlinked.
31651
31652 For RFC822 attachments (these are messages attached to messages, with a
31653 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31654 as for the primary message, only that the &$mime_is_rfc822$& expansion
31655 variable is set (see below). Attached messages are always decoded to disk
31656 before being checked, and the files are unlinked once the check is done.
31657
31658 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31659 used to match regular expressions against raw and decoded MIME parts,
31660 respectively. They are described in section &<<SECTscanregex>>&.
31661
31662 .cindex "MIME content scanning" "returned variables"
31663 The following list describes all expansion variables that are
31664 available in the MIME ACL:
31665
31666 .vlist
31667 .vitem &$mime_boundary$&
31668 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31669 have a boundary string, which is stored in this variable. If the current part
31670 has no boundary parameter in the &'Content-Type:'& header, this variable
31671 contains the empty string.
31672
31673 .vitem &$mime_charset$&
31674 This variable contains the character set identifier, if one was found in the
31675 &'Content-Type:'& header. Examples for charset identifiers are:
31676 .code
31677 us-ascii
31678 gb2312 (Chinese)
31679 iso-8859-1
31680 .endd
31681 Please note that this value is not normalized, so you should do matches
31682 case-insensitively.
31683
31684 .vitem &$mime_content_description$&
31685 This variable contains the normalized content of the &'Content-Description:'&
31686 header. It can contain a human-readable description of the parts content. Some
31687 implementations repeat the filename for attachments here, but they are usually
31688 only used for display purposes.
31689
31690 .vitem &$mime_content_disposition$&
31691 This variable contains the normalized content of the &'Content-Disposition:'&
31692 header. You can expect strings like &"attachment"& or &"inline"& here.
31693
31694 .vitem &$mime_content_id$&
31695 This variable contains the normalized content of the &'Content-ID:'& header.
31696 This is a unique ID that can be used to reference a part from another part.
31697
31698 .vitem &$mime_content_size$&
31699 This variable is set only after the &%decode%& modifier (see above) has been
31700 successfully run. It contains the size of the decoded part in kilobytes. The
31701 size is always rounded up to full kilobytes, so only a completely empty part
31702 has a &$mime_content_size$& of zero.
31703
31704 .vitem &$mime_content_transfer_encoding$&
31705 This variable contains the normalized content of the
31706 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31707 type. Typical values are &"base64"& and &"quoted-printable"&.
31708
31709 .vitem &$mime_content_type$&
31710 If the MIME part has a &'Content-Type:'& header, this variable contains its
31711 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31712 are some examples of popular MIME types, as they may appear in this variable:
31713 .code
31714 text/plain
31715 text/html
31716 application/octet-stream
31717 image/jpeg
31718 audio/midi
31719 .endd
31720 If the MIME part has no &'Content-Type:'& header, this variable contains the
31721 empty string.
31722
31723 .vitem &$mime_decoded_filename$&
31724 This variable is set only after the &%decode%& modifier (see above) has been
31725 successfully run. It contains the full path and file name of the file
31726 containing the decoded data.
31727 .endlist
31728
31729 .cindex "RFC 2047"
31730 .vlist
31731 .vitem &$mime_filename$&
31732 This is perhaps the most important of the MIME variables. It contains a
31733 proposed filename for an attachment, if one was found in either the
31734 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31735 RFC2047
31736 or RFC2231
31737 decoded, but no additional sanity checks are done.
31738  If no filename was
31739 found, this variable contains the empty string.
31740
31741 .vitem &$mime_is_coverletter$&
31742 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31743 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31744 content in the cover letter, while not restricting attachments at all.
31745
31746 The variable contains 1 (true) for a MIME part believed to be part of the
31747 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31748 follows:
31749
31750 .olist
31751 The outermost MIME part of a message is always a cover letter.
31752
31753 .next
31754 If a multipart/alternative or multipart/related MIME part is a cover letter,
31755 so are all MIME subparts within that multipart.
31756
31757 .next
31758 If any other multipart is a cover letter, the first subpart is a cover letter,
31759 and the rest are attachments.
31760
31761 .next
31762 All parts contained within an attachment multipart are attachments.
31763 .endlist olist
31764
31765 As an example, the following will ban &"HTML mail"& (including that sent with
31766 alternative plain text), while allowing HTML files to be attached. HTML
31767 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31768 .code
31769 deny message = HTML mail is not accepted here
31770 !condition = $mime_is_rfc822
31771 condition = $mime_is_coverletter
31772 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31773 .endd
31774 .vitem &$mime_is_multipart$&
31775 This variable has the value 1 (true) when the current part has the main type
31776 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31777 Since multipart entities only serve as containers for other parts, you may not
31778 want to carry out specific actions on them.
31779
31780 .vitem &$mime_is_rfc822$&
31781 This variable has the value 1 (true) if the current part is not a part of the
31782 checked message itself, but part of an attached message. Attached message
31783 decoding is fully recursive.
31784
31785 .vitem &$mime_part_count$&
31786 This variable is a counter that is raised for each processed MIME part. It
31787 starts at zero for the very first part (which is usually a multipart). The
31788 counter is per-message, so it is reset when processing RFC822 attachments (see
31789 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31790 complete, so you can use it in the DATA ACL to determine the number of MIME
31791 parts of a message. For non-MIME messages, this variable contains the value -1.
31792 .endlist
31793
31794
31795
31796 .section "Scanning with regular expressions" "SECTscanregex"
31797 .cindex "content scanning" "with regular expressions"
31798 .cindex "regular expressions" "content scanning with"
31799 You can specify your own custom regular expression matches on the full body of
31800 the message, or on individual MIME parts.
31801
31802 The &%regex%& condition takes one or more regular expressions as arguments and
31803 matches them against the full message (when called in the DATA ACL) or a raw
31804 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31805 linewise, with a maximum line length of 32K characters. That means you cannot
31806 have multiline matches with the &%regex%& condition.
31807
31808 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31809 to 32K of decoded content (the whole content at once, not linewise). If the
31810 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31811 is decoded automatically when &%mime_regex%& is executed (using default path
31812 and filename values). If the decoded data is larger than  32K, only the first
31813 32K characters are checked.
31814
31815 The regular expressions are passed as a colon-separated list. To include a
31816 literal colon, you must double it. Since the whole right-hand side string is
31817 expanded before being used, you must also escape dollar signs and backslashes
31818 with more backslashes, or use the &`\N`& facility to disable expansion.
31819 Here is a simple example that contains two regular expressions:
31820 .code
31821 deny message = contains blacklisted regex ($regex_match_string)
31822      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31823 .endd
31824 The conditions returns true if any one of the regular expressions matches. The
31825 &$regex_match_string$& expansion variable is then set up and contains the
31826 matching regular expression.
31827 The expansion variables &$regex1$& &$regex2$& etc
31828 are set to any substrings captured by the regular expression.
31829
31830 &*Warning*&: With large messages, these conditions can be fairly
31831 CPU-intensive.
31832
31833 .ecindex IIDcosca
31834
31835
31836
31837
31838 . ////////////////////////////////////////////////////////////////////////////
31839 . ////////////////////////////////////////////////////////////////////////////
31840
31841 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31842          "Local scan function"
31843 .scindex IIDlosca "&[local_scan()]& function" "description of"
31844 .cindex "customizing" "input scan using C function"
31845 .cindex "policy control" "by local scan function"
31846 In these days of email worms, viruses, and ever-increasing spam, some sites
31847 want to apply a lot of checking to messages before accepting them.
31848
31849 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31850 passing messages to external virus and spam scanning software. You can also do
31851 a certain amount in Exim itself through string expansions and the &%condition%&
31852 condition in the ACL that runs after the SMTP DATA command or the ACL for
31853 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31854
31855 To allow for further customization to a site's own requirements, there is the
31856 possibility of linking Exim with a private message scanning function, written
31857 in C. If you want to run code that is written in something other than C, you
31858 can of course use a little C stub to call it.
31859
31860 The local scan function is run once for every incoming message, at the point
31861 when Exim is just about to accept the message.
31862 It can therefore be used to control non-SMTP messages from local processes as
31863 well as messages arriving via SMTP.
31864
31865 Exim applies a timeout to calls of the local scan function, and there is an
31866 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31867 Zero means &"no timeout"&.
31868 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31869 before calling the local scan function, so that the most common types of crash
31870 are caught. If the timeout is exceeded or one of those signals is caught, the
31871 incoming message is rejected with a temporary error if it is an SMTP message.
31872 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31873 code. The incident is logged on the main and reject logs.
31874
31875
31876
31877 .section "Building Exim to use a local scan function" "SECID207"
31878 .cindex "&[local_scan()]& function" "building Exim to use"
31879 To make use of the local scan function feature, you must tell Exim where your
31880 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31881 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31882 directory, so you might set
31883 .code
31884 LOCAL_SCAN_SOURCE=Local/local_scan.c
31885 .endd
31886 for example. The function must be called &[local_scan()]&. It is called by
31887 Exim after it has received a message, when the success return code is about to
31888 be sent. This is after all the ACLs have been run. The return code from your
31889 function controls whether the message is actually accepted or not. There is a
31890 commented template function (that just accepts the message) in the file
31891 _src/local_scan.c_.
31892
31893 If you want to make use of Exim's run time configuration file to set options
31894 for your &[local_scan()]& function, you must also set
31895 .code
31896 LOCAL_SCAN_HAS_OPTIONS=yes
31897 .endd
31898 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31899
31900
31901
31902
31903 .section "API for local_scan()" "SECTapiforloc"
31904 .cindex "&[local_scan()]& function" "API description"
31905 You must include this line near the start of your code:
31906 .code
31907 #include "local_scan.h"
31908 .endd
31909 This header file defines a number of variables and other values, and the
31910 prototype for the function itself. Exim is coded to use unsigned char values
31911 almost exclusively, and one of the things this header defines is a shorthand
31912 for &`unsigned char`& called &`uschar`&.
31913 It also contains the following macro definitions, to simplify casting character
31914 strings and pointers to character strings:
31915 .code
31916 #define CS   (char *)
31917 #define CCS  (const char *)
31918 #define CSS  (char **)
31919 #define US   (unsigned char *)
31920 #define CUS  (const unsigned char *)
31921 #define USS  (unsigned char **)
31922 .endd
31923 The function prototype for &[local_scan()]& is:
31924 .code
31925 extern int local_scan(int fd, uschar **return_text);
31926 .endd
31927 The arguments are as follows:
31928
31929 .ilist
31930 &%fd%& is a file descriptor for the file that contains the body of the message
31931 (the -D file). The file is open for reading and writing, but updating it is not
31932 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31933
31934 The descriptor is positioned at character 19 of the file, which is the first
31935 character of the body itself, because the first 19 characters are the message
31936 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31937 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31938 case this changes in some future version.
31939 .next
31940 &%return_text%& is an address which you can use to return a pointer to a text
31941 string at the end of the function. The value it points to on entry is NULL.
31942 .endlist
31943
31944 The function must return an &%int%& value which is one of the following macros:
31945
31946 .vlist
31947 .vitem &`LOCAL_SCAN_ACCEPT`&
31948 .vindex "&$local_scan_data$&"
31949 The message is accepted. If you pass back a string of text, it is saved with
31950 the message, and made available in the variable &$local_scan_data$&. No
31951 newlines are permitted (if there are any, they are turned into spaces) and the
31952 maximum length of text is 1000 characters.
31953
31954 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31955 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31956 queued without immediate delivery, and is frozen.
31957
31958 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31959 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31960 queued without immediate delivery.
31961
31962 .vitem &`LOCAL_SCAN_REJECT`&
31963 The message is rejected; the returned text is used as an error message which is
31964 passed back to the sender and which is also logged. Newlines are permitted &--
31965 they cause a multiline response for SMTP rejections, but are converted to
31966 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31967 used.
31968
31969 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31970 The message is temporarily rejected; the returned text is used as an error
31971 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31972 problem"& is used.
31973
31974 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31975 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31976 message is not written to the reject log. It has the effect of unsetting the
31977 &%rejected_header%& log selector for just this rejection. If
31978 &%rejected_header%& is already unset (see the discussion of the
31979 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31980 same as LOCAL_SCAN_REJECT.
31981
31982 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31983 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31984 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31985 .endlist
31986
31987 If the message is not being received by interactive SMTP, rejections are
31988 reported by writing to &%stderr%& or by sending an email, as configured by the
31989 &%-oe%& command line options.
31990
31991
31992
31993 .section "Configuration options for local_scan()" "SECTconoptloc"
31994 .cindex "&[local_scan()]& function" "configuration options"
31995 It is possible to have option settings in the main configuration file
31996 that set values in static variables in the &[local_scan()]& module. If you
31997 want to do this, you must have the line
31998 .code
31999 LOCAL_SCAN_HAS_OPTIONS=yes
32000 .endd
32001 in your &_Local/Makefile_& when you build Exim. (This line is in
32002 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32003 file, you must define static variables to hold the option values, and a table
32004 to define them.
32005
32006 The table must be a vector called &%local_scan_options%&, of type
32007 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32008 and a pointer to the variable that holds the value. The entries must appear in
32009 alphabetical order. Following &%local_scan_options%& you must also define a
32010 variable called &%local_scan_options_count%& that contains the number of
32011 entries in the table. Here is a short example, showing two kinds of option:
32012 .code
32013 static int my_integer_option = 42;
32014 static uschar *my_string_option = US"a default string";
32015
32016 optionlist local_scan_options[] = {
32017   { "my_integer", opt_int,       &my_integer_option },
32018   { "my_string",  opt_stringptr, &my_string_option }
32019 };
32020
32021 int local_scan_options_count =
32022   sizeof(local_scan_options)/sizeof(optionlist);
32023 .endd
32024 The values of the variables can now be changed from Exim's runtime
32025 configuration file by including a local scan section as in this example:
32026 .code
32027 begin local_scan
32028 my_integer = 99
32029 my_string = some string of text...
32030 .endd
32031 The available types of option data are as follows:
32032
32033 .vlist
32034 .vitem &*opt_bool*&
32035 This specifies a boolean (true/false) option. The address should point to a
32036 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32037 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32038 whether such a variable has been set at all, you can initialize it to
32039 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32040 values.)
32041
32042 .vitem &*opt_fixed*&
32043 This specifies a fixed point number, such as is used for load averages.
32044 The address should point to a variable of type &`int`&. The value is stored
32045 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32046
32047 .vitem &*opt_int*&
32048 This specifies an integer; the address should point to a variable of type
32049 &`int`&. The value may be specified in any of the integer formats accepted by
32050 Exim.
32051
32052 .vitem &*opt_mkint*&
32053 This is the same as &%opt_int%&, except that when such a value is output in a
32054 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32055 printed with the suffix K or M.
32056
32057 .vitem &*opt_octint*&
32058 This also specifies an integer, but the value is always interpreted as an
32059 octal integer, whether or not it starts with the digit zero, and it is
32060 always output in octal.
32061
32062 .vitem &*opt_stringptr*&
32063 This specifies a string value; the address must be a pointer to a
32064 variable that points to a string (for example, of type &`uschar *`&).
32065
32066 .vitem &*opt_time*&
32067 This specifies a time interval value. The address must point to a variable of
32068 type &`int`&. The value that is placed there is a number of seconds.
32069 .endlist
32070
32071 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32072 out the values of all the &[local_scan()]& options.
32073
32074
32075
32076 .section "Available Exim variables" "SECID208"
32077 .cindex "&[local_scan()]& function" "available Exim variables"
32078 The header &_local_scan.h_& gives you access to a number of C variables. These
32079 are the only ones that are guaranteed to be maintained from release to release.
32080 Note, however, that you can obtain the value of any Exim expansion variable,
32081 including &$recipients$&, by calling &'expand_string()'&. The exported
32082 C variables are as follows:
32083
32084 .vlist
32085 .vitem &*int&~body_linecount*&
32086 This variable contains the number of lines in the message's body.
32087
32088 .vitem &*int&~body_zerocount*&
32089 This variable contains the number of binary zero bytes in the message's body.
32090
32091 .vitem &*unsigned&~int&~debug_selector*&
32092 This variable is set to zero when no debugging is taking place. Otherwise, it
32093 is a bitmap of debugging selectors. Two bits are identified for use in
32094 &[local_scan()]&; they are defined as macros:
32095
32096 .ilist
32097 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32098 testing option that is not privileged &-- any caller may set it. All the
32099 other selector bits can be set only by admin users.
32100
32101 .next
32102 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32103 by the &`+local_scan`& debug selector. It is not included in the default set
32104 of debugging bits.
32105 .endlist ilist
32106
32107 Thus, to write to the debugging output only when &`+local_scan`& has been
32108 selected, you should use code like this:
32109 .code
32110 if ((debug_selector & D_local_scan) != 0)
32111   debug_printf("xxx", ...);
32112 .endd
32113 .vitem &*uschar&~*expand_string_message*&
32114 After a failing call to &'expand_string()'& (returned value NULL), the
32115 variable &%expand_string_message%& contains the error message, zero-terminated.
32116
32117 .vitem &*header_line&~*header_list*&
32118 A pointer to a chain of header lines. The &%header_line%& structure is
32119 discussed below.
32120
32121 .vitem &*header_line&~*header_last*&
32122 A pointer to the last of the header lines.
32123
32124 .vitem &*uschar&~*headers_charset*&
32125 The value of the &%headers_charset%& configuration option.
32126
32127 .vitem &*BOOL&~host_checking*&
32128 This variable is TRUE during a host checking session that is initiated by the
32129 &%-bh%& command line option.
32130
32131 .vitem &*uschar&~*interface_address*&
32132 The IP address of the interface that received the message, as a string. This
32133 is NULL for locally submitted messages.
32134
32135 .vitem &*int&~interface_port*&
32136 The port on which this message was received. When testing with the &%-bh%&
32137 command line option, the value of this variable is -1 unless a port has been
32138 specified via the &%-oMi%& option.
32139
32140 .vitem &*uschar&~*message_id*&
32141 This variable contains Exim's message id for the incoming message (the value of
32142 &$message_exim_id$&) as a zero-terminated string.
32143
32144 .vitem &*uschar&~*received_protocol*&
32145 The name of the protocol by which the message was received.
32146
32147 .vitem &*int&~recipients_count*&
32148 The number of accepted recipients.
32149
32150 .vitem &*recipient_item&~*recipients_list*&
32151 .cindex "recipient" "adding in local scan"
32152 .cindex "recipient" "removing in local scan"
32153 The list of accepted recipients, held in a vector of length
32154 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32155 can add additional recipients by calling &'receive_add_recipient()'& (see
32156 below). You can delete recipients by removing them from the vector and
32157 adjusting the value in &%recipients_count%&. In particular, by setting
32158 &%recipients_count%& to zero you remove all recipients. If you then return the
32159 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32160 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32161 and then call &'receive_add_recipient()'& as often as needed.
32162
32163 .vitem &*uschar&~*sender_address*&
32164 The envelope sender address. For bounce messages this is the empty string.
32165
32166 .vitem &*uschar&~*sender_host_address*&
32167 The IP address of the sending host, as a string. This is NULL for
32168 locally-submitted messages.
32169
32170 .vitem &*uschar&~*sender_host_authenticated*&
32171 The name of the authentication mechanism that was used, or NULL if the message
32172 was not received over an authenticated SMTP connection.
32173
32174 .vitem &*uschar&~*sender_host_name*&
32175 The name of the sending host, if known.
32176
32177 .vitem &*int&~sender_host_port*&
32178 The port on the sending host.
32179
32180 .vitem &*BOOL&~smtp_input*&
32181 This variable is TRUE for all SMTP input, including BSMTP.
32182
32183 .vitem &*BOOL&~smtp_batched_input*&
32184 This variable is TRUE for BSMTP input.
32185
32186 .vitem &*int&~store_pool*&
32187 The contents of this variable control which pool of memory is used for new
32188 requests. See section &<<SECTmemhanloc>>& for details.
32189 .endlist
32190
32191
32192 .section "Structure of header lines" "SECID209"
32193 The &%header_line%& structure contains the members listed below.
32194 You can add additional header lines by calling the &'header_add()'& function
32195 (see below). You can cause header lines to be ignored (deleted) by setting
32196 their type to *.
32197
32198
32199 .vlist
32200 .vitem &*struct&~header_line&~*next*&
32201 A pointer to the next header line, or NULL for the last line.
32202
32203 .vitem &*int&~type*&
32204 A code identifying certain headers that Exim recognizes. The codes are printing
32205 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32206 Notice in particular that any header line whose type is * is not transmitted
32207 with the message. This flagging is used for header lines that have been
32208 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32209 lines.) Effectively, * means &"deleted"&.
32210
32211 .vitem &*int&~slen*&
32212 The number of characters in the header line, including the terminating and any
32213 internal newlines.
32214
32215 .vitem &*uschar&~*text*&
32216 A pointer to the text of the header. It always ends with a newline, followed by
32217 a zero byte. Internal newlines are preserved.
32218 .endlist
32219
32220
32221
32222 .section "Structure of recipient items" "SECID210"
32223 The &%recipient_item%& structure contains these members:
32224
32225 .vlist
32226 .vitem &*uschar&~*address*&
32227 This is a pointer to the recipient address as it was received.
32228
32229 .vitem &*int&~pno*&
32230 This is used in later Exim processing when top level addresses are created by
32231 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32232 and must always contain -1 at this stage.
32233
32234 .vitem &*uschar&~*errors_to*&
32235 If this value is not NULL, bounce messages caused by failing to deliver to the
32236 recipient are sent to the address it contains. In other words, it overrides the
32237 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32238 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32239 an unqualified address, Exim qualifies it using the domain from
32240 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32241 is NULL for all recipients.
32242 .endlist
32243
32244
32245
32246 .section "Available Exim functions" "SECID211"
32247 .cindex "&[local_scan()]& function" "available Exim functions"
32248 The header &_local_scan.h_& gives you access to a number of Exim functions.
32249 These are the only ones that are guaranteed to be maintained from release to
32250 release:
32251
32252 .vlist
32253 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32254        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32255
32256 This function creates a child process that runs the command specified by
32257 &%argv%&. The environment for the process is specified by &%envp%&, which can
32258 be NULL if no environment variables are to be passed. A new umask is supplied
32259 for the process in &%newumask%&.
32260
32261 Pipes to the standard input and output of the new process are set up
32262 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32263 standard error is cloned to the standard output. If there are any file
32264 descriptors &"in the way"& in the new process, they are closed. If the final
32265 argument is TRUE, the new process is made into a process group leader.
32266
32267 The function returns the pid of the new process, or -1 if things go wrong.
32268
32269 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32270 This function waits for a child process to terminate, or for a timeout (in
32271 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32272 return value is as follows:
32273
32274 .ilist
32275 >= 0
32276
32277 The process terminated by a normal exit and the value is the process
32278 ending status.
32279
32280 .next
32281 < 0 and > &--256
32282
32283 The process was terminated by a signal and the value is the negation of the
32284 signal number.
32285
32286 .next
32287 &--256
32288
32289 The process timed out.
32290 .next
32291 &--257
32292
32293 The was some other error in wait(); &%errno%& is still set.
32294 .endlist
32295
32296 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32297 This function provide you with a means of submitting a new message to
32298 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32299 want, but this packages it all up for you.) The function creates a pipe,
32300 forks a subprocess that is running
32301 .code
32302 exim -t -oem -oi -f <>
32303 .endd
32304 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32305 that is connected to the standard input. The yield of the function is the PID
32306 of the subprocess. You can then write a message to the file descriptor, with
32307 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32308
32309 When you have finished, call &'child_close()'& to wait for the process to
32310 finish and to collect its ending status. A timeout value of zero is usually
32311 fine in this circumstance. Unless you have made a mistake with the recipient
32312 addresses, you should get a return code of zero.
32313
32314
32315 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32316        *sender_authentication)*&
32317 This function is a more sophisticated version of &'child_open()'&. The command
32318 that it runs is:
32319 .display
32320 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32321 .endd
32322 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32323
32324
32325 .vitem &*void&~debug_printf(char&~*,&~...)*&
32326 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32327 output is written to the standard error stream. If no debugging is selected,
32328 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32329 conditional on the &`local_scan`& debug selector by coding like this:
32330 .code
32331 if ((debug_selector & D_local_scan) != 0)
32332   debug_printf("xxx", ...);
32333 .endd
32334
32335 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32336 This is an interface to Exim's string expansion code. The return value is the
32337 expanded string, or NULL if there was an expansion failure.
32338 The C variable &%expand_string_message%& contains an error message after an
32339 expansion failure. If expansion does not change the string, the return value is
32340 the pointer to the input string. Otherwise, the return value points to a new
32341 block of memory that was obtained by a call to &'store_get()'&. See section
32342 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32343
32344 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32345 This function allows you to an add additional header line at the end of the
32346 existing ones. The first argument is the type, and should normally be a space
32347 character. The second argument is a format string and any number of
32348 substitution arguments as for &[sprintf()]&. You may include internal newlines
32349 if you want, and you must ensure that the string ends with a newline.
32350
32351 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32352         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32353 This function adds a new header line at a specified point in the header
32354 chain. The header itself is specified as for &'header_add()'&.
32355
32356 If &%name%& is NULL, the new header is added at the end of the chain if
32357 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32358 NULL, the header lines are searched for the first non-deleted header that
32359 matches the name. If one is found, the new header is added before it if
32360 &%after%& is false. If &%after%& is true, the new header is added after the
32361 found header and any adjacent subsequent ones with the same name (even if
32362 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32363 option controls where the header is added. If it is true, addition is at the
32364 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32365 headers, or at the top if there are no &'Received:'& headers, you could use
32366 .code
32367 header_add_at_position(TRUE, US"Received", TRUE,
32368   ' ', "X-xxx: ...");
32369 .endd
32370 Normally, there is always at least one non-deleted &'Received:'& header, but
32371 there may not be if &%received_header_text%& expands to an empty string.
32372
32373
32374 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32375 This function removes header lines. If &%occurrence%& is zero or negative, all
32376 occurrences of the header are removed. If occurrence is greater than zero, that
32377 particular instance of the header is removed. If no header(s) can be found that
32378 match the specification, the function does nothing.
32379
32380
32381 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32382         int&~length,&~BOOL&~notdel)*&"
32383 This function tests whether the given header has the given name. It is not just
32384 a string comparison, because white space is permitted between the name and the
32385 colon. If the &%notdel%& argument is true, a false return is forced for all
32386 &"deleted"& headers; otherwise they are not treated specially. For example:
32387 .code
32388 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32389 .endd
32390 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32391 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32392 This function base64-encodes a string, which is passed by address and length.
32393 The text may contain bytes of any value, including zero. The result is passed
32394 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32395 zero-terminated.
32396
32397 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32398 This function decodes a base64-encoded string. Its arguments are a
32399 zero-terminated base64-encoded string and the address of a variable that is set
32400 to point to the result, which is in dynamic memory. The length of the decoded
32401 string is the yield of the function. If the input is invalid base64 data, the
32402 yield is -1. A zero byte is added to the end of the output string to make it
32403 easy to interpret as a C string (assuming it contains no zeros of its own). The
32404 added zero byte is not included in the returned count.
32405
32406 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32407 This function checks for a match in a domain list. Domains are always
32408 matched caselessly. The return value is one of the following:
32409 .display
32410 &`OK     `& match succeeded
32411 &`FAIL   `& match failed
32412 &`DEFER  `& match deferred
32413 .endd
32414 DEFER is usually caused by some kind of lookup defer, such as the
32415 inability to contact a database.
32416
32417 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32418         BOOL&~caseless)*&"
32419 This function checks for a match in a local part list. The third argument
32420 controls case-sensitivity. The return values are as for
32421 &'lss_match_domain()'&.
32422
32423 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32424         BOOL&~caseless)*&"
32425 This function checks for a match in an address list. The third argument
32426 controls the case-sensitivity of the local part match. The domain is always
32427 matched caselessly. The return values are as for &'lss_match_domain()'&.
32428
32429 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32430         uschar&~*list)*&"
32431 This function checks for a match in a host list. The most common usage is
32432 expected to be
32433 .code
32434 lss_match_host(sender_host_name, sender_host_address, ...)
32435 .endd
32436 .vindex "&$sender_host_address$&"
32437 An empty address field matches an empty item in the host list. If the host name
32438 is NULL, the name corresponding to &$sender_host_address$& is automatically
32439 looked up if a host name is required to match an item in the list. The return
32440 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32441 returns ERROR in the case when it had to look up a host name, but the lookup
32442 failed.
32443
32444 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32445         *format,&~...)*&"
32446 This function writes to Exim's log files. The first argument should be zero (it
32447 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32448 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32449 them. It specifies to which log or logs the message is written. The remaining
32450 arguments are a format and relevant insertion arguments. The string should not
32451 contain any newlines, not even at the end.
32452
32453
32454 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32455 This function adds an additional recipient to the message. The first argument
32456 is the recipient address. If it is unqualified (has no domain), it is qualified
32457 with the &%qualify_recipient%& domain. The second argument must always be -1.
32458
32459 This function does not allow you to specify a private &%errors_to%& address (as
32460 described with the structure of &%recipient_item%& above), because it pre-dates
32461 the addition of that field to the structure. However, it is easy to add such a
32462 value afterwards. For example:
32463 .code
32464  receive_add_recipient(US"monitor@mydom.example", -1);
32465  recipients_list[recipients_count-1].errors_to =
32466    US"postmaster@mydom.example";
32467 .endd
32468
32469 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32470 This is a convenience function to remove a named recipient from the list of
32471 recipients. It returns true if a recipient was removed, and false if no
32472 matching recipient could be found. The argument must be a complete email
32473 address.
32474 .endlist
32475
32476
32477 .cindex "RFC 2047"
32478 .vlist
32479 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32480   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32481 This function decodes strings that are encoded according to RFC 2047. Typically
32482 these are the contents of header lines. First, each &"encoded word"& is decoded
32483 from the Q or B encoding into a byte-string. Then, if provided with the name of
32484 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32485 made  to translate the result to the named character set. If this fails, the
32486 binary string is returned with an error message.
32487
32488 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32489 maximum MIME word length is enforced. The third argument is the target
32490 encoding, or NULL if no translation is wanted.
32491
32492 .cindex "binary zero" "in RFC 2047 decoding"
32493 .cindex "RFC 2047" "binary zero in"
32494 If a binary zero is encountered in the decoded string, it is replaced by the
32495 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32496 not be 0 because header lines are handled as zero-terminated strings.
32497
32498 The function returns the result of processing the string, zero-terminated; if
32499 &%lenptr%& is not NULL, the length of the result is set in the variable to
32500 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32501
32502 If an error is encountered, the function returns NULL and uses the &%error%&
32503 argument to return an error message. The variable pointed to by &%error%& is
32504 set to NULL if there is no error; it may be set non-NULL even when the function
32505 returns a non-NULL value if decoding was successful, but there was a problem
32506 with translation.
32507
32508
32509 .vitem &*int&~smtp_fflush(void)*&
32510 This function is used in conjunction with &'smtp_printf()'&, as described
32511 below.
32512
32513 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32514 The arguments of this function are like &[printf()]&; it writes to the SMTP
32515 output stream. You should use this function only when there is an SMTP output
32516 stream, that is, when the incoming message is being received via interactive
32517 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32518 is FALSE. If you want to test for an incoming message from another host (as
32519 opposed to a local process that used the &%-bs%& command line option), you can
32520 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32521 is involved.
32522
32523 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32524 output function, so it can be used for all forms of SMTP connection.
32525
32526 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32527 must start with an appropriate response code: 550 if you are going to return
32528 LOCAL_SCAN_REJECT, 451 if you are going to return
32529 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32530 initial lines of a multi-line response, the code must be followed by a hyphen
32531 to indicate that the line is not the final response line. You must also ensure
32532 that the lines you write terminate with CRLF. For example:
32533 .code
32534 smtp_printf("550-this is some extra info\r\n");
32535 return LOCAL_SCAN_REJECT;
32536 .endd
32537 Note that you can also create multi-line responses by including newlines in
32538 the data returned via the &%return_text%& argument. The added value of using
32539 &'smtp_printf()'& is that, for instance, you could introduce delays between
32540 multiple output lines.
32541
32542 The &'smtp_printf()'& function does not return any error indication, because it
32543 does not automatically flush pending output, and therefore does not test
32544 the state of the stream. (In the main code of Exim, flushing and error
32545 detection is done when Exim is ready for the next SMTP input command.) If
32546 you want to flush the output and check for an error (for example, the
32547 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32548 arguments. It flushes the output stream, and returns a non-zero value if there
32549 is an error.
32550
32551 .vitem &*void&~*store_get(int)*&
32552 This function accesses Exim's internal store (memory) manager. It gets a new
32553 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32554 runs out of memory. See the next section for a discussion of memory handling.
32555
32556 .vitem &*void&~*store_get_perm(int)*&
32557 This function is like &'store_get()'&, but it always gets memory from the
32558 permanent pool. See the next section for a discussion of memory handling.
32559
32560 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32561 See below.
32562
32563 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32564 See below.
32565
32566 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32567 These three functions create strings using Exim's dynamic memory facilities.
32568 The first makes a copy of an entire string. The second copies up to a maximum
32569 number of characters, indicated by the second argument. The third uses a format
32570 and insertion arguments to create a new string. In each case, the result is a
32571 pointer to a new string in the current memory pool. See the next section for
32572 more discussion.
32573 .endlist
32574
32575
32576
32577 .section "More about Exim's memory handling" "SECTmemhanloc"
32578 .cindex "&[local_scan()]& function" "memory handling"
32579 No function is provided for freeing memory, because that is never needed.
32580 The dynamic memory that Exim uses when receiving a message is automatically
32581 recycled if another message is received by the same process (this applies only
32582 to incoming SMTP connections &-- other input methods can supply only one
32583 message at a time). After receiving the last message, a reception process
32584 terminates.
32585
32586 Because it is recycled, the normal dynamic memory cannot be used for holding
32587 data that must be preserved over a number of incoming messages on the same SMTP
32588 connection. However, Exim in fact uses two pools of dynamic memory; the second
32589 one is not recycled, and can be used for this purpose.
32590
32591 If you want to allocate memory that remains available for subsequent messages
32592 in the same SMTP connection, you should set
32593 .code
32594 store_pool = POOL_PERM
32595 .endd
32596 before calling the function that does the allocation. There is no need to
32597 restore the value if you do not need to; however, if you do want to revert to
32598 the normal pool, you can either restore the previous value of &%store_pool%& or
32599 set it explicitly to POOL_MAIN.
32600
32601 The pool setting applies to all functions that get dynamic memory, including
32602 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32603 There is also a convenience function called &'store_get_perm()'& that gets a
32604 block of memory from the permanent pool while preserving the value of
32605 &%store_pool%&.
32606 .ecindex IIDlosca
32607
32608
32609
32610
32611 . ////////////////////////////////////////////////////////////////////////////
32612 . ////////////////////////////////////////////////////////////////////////////
32613
32614 .chapter "System-wide message filtering" "CHAPsystemfilter"
32615 .scindex IIDsysfil1 "filter" "system filter"
32616 .scindex IIDsysfil2 "filtering all mail"
32617 .scindex IIDsysfil3 "system filter"
32618 The previous chapters (on ACLs and the local scan function) describe checks
32619 that can be applied to messages before they are accepted by a host. There is
32620 also a mechanism for checking messages once they have been received, but before
32621 they are delivered. This is called the &'system filter'&.
32622
32623 The system filter operates in a similar manner to users' filter files, but it
32624 is run just once per message (however many recipients the message has).
32625 It should not normally be used as a substitute for routing, because &%deliver%&
32626 commands in a system router provide new envelope recipient addresses.
32627 The system filter must be an Exim filter. It cannot be a Sieve filter.
32628
32629 The system filter is run at the start of a delivery attempt, before any routing
32630 is done. If a message fails to be completely delivered at the first attempt,
32631 the system filter is run again at the start of every retry.
32632 If you want your filter to do something only once per message, you can make use
32633 of the &%first_delivery%& condition in an &%if%& command in the filter to
32634 prevent it happening on retries.
32635
32636 .vindex "&$domain$&"
32637 .vindex "&$local_part$&"
32638 &*Warning*&: Because the system filter runs just once, variables that are
32639 specific to individual recipient addresses, such as &$local_part$& and
32640 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32641 you want to run a centrally-specified filter for each recipient address
32642 independently, you can do so by setting up a suitable &(redirect)& router, as
32643 described in section &<<SECTperaddfil>>& below.
32644
32645
32646 .section "Specifying a system filter" "SECID212"
32647 .cindex "uid (user id)" "system filter"
32648 .cindex "gid (group id)" "system filter"
32649 The name of the file that contains the system filter must be specified by
32650 setting &%system_filter%&. If you want the filter to run under a uid and gid
32651 other than root, you must also set &%system_filter_user%& and
32652 &%system_filter_group%& as appropriate. For example:
32653 .code
32654 system_filter = /etc/mail/exim.filter
32655 system_filter_user = exim
32656 .endd
32657 If a system filter generates any deliveries directly to files or pipes (via the
32658 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32659 specified by setting &%system_filter_file_transport%& and
32660 &%system_filter_pipe_transport%&, respectively. Similarly,
32661 &%system_filter_reply_transport%& must be set to handle any messages generated
32662 by the &%reply%& command.
32663
32664
32665 .section "Testing a system filter" "SECID213"
32666 You can run simple tests of a system filter in the same way as for a user
32667 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32668 are permitted only in system filters are recognized.
32669
32670 If you want to test the combined effect of a system filter and a user filter,
32671 you can use both &%-bF%& and &%-bf%& on the same command line.
32672
32673
32674
32675 .section "Contents of a system filter" "SECID214"
32676 The language used to specify system filters is the same as for users' filter
32677 files. It is described in the separate end-user document &'Exim's interface to
32678 mail filtering'&. However, there are some additional features that are
32679 available only in system filters; these are described in subsequent sections.
32680 If they are encountered in a user's filter file or when testing with &%-bf%&,
32681 they cause errors.
32682
32683 .cindex "frozen messages" "manual thaw; testing in filter"
32684 There are two special conditions which, though available in users' filter
32685 files, are designed for use in system filters. The condition &%first_delivery%&
32686 is true only for the first attempt at delivering a message, and
32687 &%manually_thawed%& is true only if the message has been frozen, and
32688 subsequently thawed by an admin user. An explicit forced delivery counts as a
32689 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32690
32691 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32692 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32693 succeed, it will not be tried again.
32694 If you want Exim to retry an unseen delivery until it succeeds, you should
32695 arrange to set it up every time the filter runs.
32696
32697 When a system filter finishes running, the values of the variables &$n0$& &--
32698 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32699 users' filter files. Thus a system filter can, for example, set up &"scores"&
32700 to which users' filter files can refer.
32701
32702
32703
32704 .section "Additional variable for system filters" "SECID215"
32705 .vindex "&$recipients$&"
32706 The expansion variable &$recipients$&, containing a list of all the recipients
32707 of the message (separated by commas and white space), is available in system
32708 filters. It is not available in users' filters for privacy reasons.
32709
32710
32711
32712 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32713 .cindex "freezing messages"
32714 .cindex "message" "freezing"
32715 .cindex "message" "forced failure"
32716 .cindex "&%fail%&" "in system filter"
32717 .cindex "&%freeze%& in system filter"
32718 .cindex "&%defer%& in system filter"
32719 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32720 always available in system filters, but are not normally enabled in users'
32721 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32722 for the &(redirect)& router.) These commands can optionally be followed by the
32723 word &%text%& and a string containing an error message, for example:
32724 .code
32725 fail text "this message looks like spam to me"
32726 .endd
32727 The keyword &%text%& is optional if the next character is a double quote.
32728
32729 The &%defer%& command defers delivery of the original recipients of the
32730 message. The &%fail%& command causes all the original recipients to be failed,
32731 and a bounce message to be created. The &%freeze%& command suspends all
32732 delivery attempts for the original recipients. In all cases, any new deliveries
32733 that are specified by the filter are attempted as normal after the filter has
32734 run.
32735
32736 The &%freeze%& command is ignored if the message has been manually unfrozen and
32737 not manually frozen since. This means that automatic freezing by a system
32738 filter can be used as a way of checking out suspicious messages. If a message
32739 is found to be all right, manually unfreezing it allows it to be delivered.
32740
32741 .cindex "log" "&%fail%& command log line"
32742 .cindex "&%fail%&" "log line; reducing"
32743 The text given with a fail command is used as part of the bounce message as
32744 well as being written to the log. If the message is quite long, this can fill
32745 up a lot of log space when such failures are common. To reduce the size of the
32746 log message, Exim interprets the text in a special way if it starts with the
32747 two characters &`<<`& and contains &`>>`& later. The text between these two
32748 strings is written to the log, and the rest of the text is used in the bounce
32749 message. For example:
32750 .code
32751 fail "<<filter test 1>>Your message is rejected \
32752      because it contains attachments that we are \
32753      not prepared to receive."
32754 .endd
32755
32756 .cindex "loop" "caused by &%fail%&"
32757 Take great care with the &%fail%& command when basing the decision to fail on
32758 the contents of the message, because the bounce message will of course include
32759 the contents of the original message and will therefore trigger the &%fail%&
32760 command again (causing a mail loop) unless steps are taken to prevent this.
32761 Testing the &%error_message%& condition is one way to prevent this. You could
32762 use, for example
32763 .code
32764 if $message_body contains "this is spam" and not error_message
32765 then fail text "spam is not wanted here" endif
32766 .endd
32767 though of course that might let through unwanted bounce messages. The
32768 alternative is clever checking of the body and/or headers to detect bounces
32769 generated by the filter.
32770
32771 The interpretation of a system filter file ceases after a
32772 &%defer%&,
32773 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32774 set up earlier in the filter file are honoured, so you can use a sequence such
32775 as
32776 .code
32777 mail ...
32778 freeze
32779 .endd
32780 to send a specified message when the system filter is freezing (or deferring or
32781 failing) a message. The normal deliveries for the message do not, of course,
32782 take place.
32783
32784
32785
32786 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32787 .cindex "header lines" "adding; in system filter"
32788 .cindex "header lines" "removing; in system filter"
32789 .cindex "filter" "header lines; adding/removing"
32790 Two filter commands that are available only in system filters are:
32791 .code
32792 headers add <string>
32793 headers remove <string>
32794 .endd
32795 The argument for the &%headers add%& is a string that is expanded and then
32796 added to the end of the message's headers. It is the responsibility of the
32797 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32798 space is ignored, and if the string is otherwise empty, or if the expansion is
32799 forced to fail, the command has no effect.
32800
32801 You can use &"\n"& within the string, followed by white space, to specify
32802 continued header lines. More than one header may be added in one command by
32803 including &"\n"& within the string without any following white space. For
32804 example:
32805 .code
32806 headers add "X-header-1: ....\n  \
32807              continuation of X-header-1 ...\n\
32808              X-header-2: ...."
32809 .endd
32810 Note that the header line continuation white space after the first newline must
32811 be placed before the backslash that continues the input string, because white
32812 space after input continuations is ignored.
32813
32814 The argument for &%headers remove%& is a colon-separated list of header names.
32815 This command applies only to those headers that are stored with the message;
32816 those that are added at delivery time (such as &'Envelope-To:'& and
32817 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32818 header with the same name, they are all removed.
32819
32820 The &%headers%& command in a system filter makes an immediate change to the set
32821 of header lines that was received with the message (with possible additions
32822 from ACL processing). Subsequent commands in the system filter operate on the
32823 modified set, which also forms the basis for subsequent message delivery.
32824 Unless further modified during routing or transporting, this set of headers is
32825 used for all recipients of the message.
32826
32827 During routing and transporting, the variables that refer to the contents of
32828 header lines refer only to those lines that are in this set. Thus, header lines
32829 that are added by a system filter are visible to users' filter files and to all
32830 routers and transports. This contrasts with the manipulation of header lines by
32831 routers and transports, which is not immediate, but which instead is saved up
32832 until the message is actually being written (see section
32833 &<<SECTheadersaddrem>>&).
32834
32835 If the message is not delivered at the first attempt, header lines that were
32836 added by the system filter are stored with the message, and so are still
32837 present at the next delivery attempt. Header lines that were removed are still
32838 present, but marked &"deleted"& so that they are not transported with the
32839 message. For this reason, it is usual to make the &%headers%& command
32840 conditional on &%first_delivery%& so that the set of header lines is not
32841 modified more than once.
32842
32843 Because header modification in a system filter acts immediately, you have to
32844 use an indirect approach if you want to modify the contents of a header line.
32845 For example:
32846 .code
32847 headers add "Old-Subject: $h_subject:"
32848 headers remove "Subject"
32849 headers add "Subject: new subject (was: $h_old-subject:)"
32850 headers remove "Old-Subject"
32851 .endd
32852
32853
32854
32855 .section "Setting an errors address in a system filter" "SECID217"
32856 .cindex "envelope sender"
32857 In a system filter, if a &%deliver%& command is followed by
32858 .code
32859 errors_to <some address>
32860 .endd
32861 in order to change the envelope sender (and hence the error reporting) for that
32862 delivery, any address may be specified. (In a user filter, only the current
32863 user's address can be set.) For example, if some mail is being monitored, you
32864 might use
32865 .code
32866 unseen deliver monitor@spying.example errors_to root@local.example
32867 .endd
32868 to take a copy which would not be sent back to the normal error reporting
32869 address if its delivery failed.
32870
32871
32872
32873 .section "Per-address filtering" "SECTperaddfil"
32874 .vindex "&$domain$&"
32875 .vindex "&$local_part$&"
32876 In contrast to the system filter, which is run just once per message for each
32877 delivery attempt, it is also possible to set up a system-wide filtering
32878 operation that runs once for each recipient address. In this case, variables
32879 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32880 filter file could be made dependent on them. This is an example of a router
32881 which implements such a filter:
32882 .code
32883 central_filter:
32884   check_local_user
32885   driver = redirect
32886   domains = +local_domains
32887   file = /central/filters/$local_part
32888   no_verify
32889   allow_filter
32890   allow_freeze
32891 .endd
32892 The filter is run in a separate process under its own uid. Therefore, either
32893 &%check_local_user%& must be set (as above), in which case the filter is run as
32894 the local user, or the &%user%& option must be used to specify which user to
32895 use. If both are set, &%user%& overrides.
32896
32897 Care should be taken to ensure that none of the commands in the filter file
32898 specify a significant delivery if the message is to go on to be delivered to
32899 its intended recipient. The router will not then claim to have dealt with the
32900 address, so it will be passed on to subsequent routers to be delivered in the
32901 normal way.
32902 .ecindex IIDsysfil1
32903 .ecindex IIDsysfil2
32904 .ecindex IIDsysfil3
32905
32906
32907
32908
32909
32910
32911 . ////////////////////////////////////////////////////////////////////////////
32912 . ////////////////////////////////////////////////////////////////////////////
32913
32914 .chapter "Message processing" "CHAPmsgproc"
32915 .scindex IIDmesproc "message" "general processing"
32916 Exim performs various transformations on the sender and recipient addresses of
32917 all messages that it handles, and also on the messages' header lines. Some of
32918 these are optional and configurable, while others always take place. All of
32919 this processing, except rewriting as a result of routing, and the addition or
32920 removal of header lines while delivering, happens when a message is received,
32921 before it is placed on Exim's queue.
32922
32923 Some of the automatic processing takes place by default only for
32924 &"locally-originated"& messages. This adjective is used to describe messages
32925 that are not received over TCP/IP, but instead are passed to an Exim process on
32926 its standard input. This includes the interactive &"local SMTP"& case that is
32927 set up by the &%-bs%& command line option.
32928
32929 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32930 or ::1) are not considered to be locally-originated. Exim does not treat the
32931 loopback interface specially in any way.
32932
32933 If you want the loopback interface to be treated specially, you must ensure
32934 that there are appropriate entries in your ACLs.
32935
32936
32937
32938
32939 .section "Submission mode for non-local messages" "SECTsubmodnon"
32940 .cindex "message" "submission"
32941 .cindex "submission mode"
32942 Processing that happens automatically for locally-originated messages (unless
32943 &%suppress_local_fixups%& is set) can also be requested for messages that are
32944 received over TCP/IP. The term &"submission mode"& is used to describe this
32945 state. Submission mode is set by the modifier
32946 .code
32947 control = submission
32948 .endd
32949 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32950 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32951 a local submission, and is normally used when the source of the message is
32952 known to be an MUA running on a client host (as opposed to an MTA). For
32953 example, to set submission mode for messages originating on the IPv4 loopback
32954 interface, you could include the following in the MAIL ACL:
32955 .code
32956 warn  hosts = 127.0.0.1
32957       control = submission
32958 .endd
32959 .cindex "&%sender_retain%& submission option"
32960 There are some options that can be used when setting submission mode. A slash
32961 is used to separate options. For example:
32962 .code
32963 control = submission/sender_retain
32964 .endd
32965 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32966 true and &%local_from_check%& false for the current incoming message. The first
32967 of these allows an existing &'Sender:'& header in the message to remain, and
32968 the second suppresses the check to ensure that &'From:'& matches the
32969 authenticated sender. With this setting, Exim still fixes up messages by adding
32970 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32971 attempt to check sender authenticity in header lines.
32972
32973 When &%sender_retain%& is not set, a submission mode setting may specify a
32974 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32975 example:
32976 .code
32977 control = submission/domain=some.domain
32978 .endd
32979 The domain may be empty. How this value is used is described in sections
32980 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32981 that allows you to specify the user's full name for inclusion in a created
32982 &'Sender:'& or &'From:'& header line. For example:
32983 .code
32984 accept authenticated = *
32985        control = submission/domain=wonderland.example/\
32986                             name=${lookup {$authenticated_id} \
32987                                    lsearch {/etc/exim/namelist}}
32988 .endd
32989 Because the name may contain any characters, including slashes, the &%name%&
32990 option must be given last. The remainder of the string is used as the name. For
32991 the example above, if &_/etc/exim/namelist_& contains:
32992 .code
32993 bigegg:  Humpty Dumpty
32994 .endd
32995 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32996 line would be:
32997 .code
32998 Sender: Humpty Dumpty <bigegg@wonderland.example>
32999 .endd
33000 .cindex "return path" "in submission mode"
33001 By default, submission mode forces the return path to the same address as is
33002 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33003 specified, the return path is also left unchanged.
33004
33005 &*Note*&: The changes caused by submission mode take effect after the predata
33006 ACL. This means that any sender checks performed before the fix-ups use the
33007 untrusted sender address specified by the user, not the trusted sender address
33008 specified by submission mode. Although this might be slightly unexpected, it
33009 does mean that you can configure ACL checks to spot that a user is trying to
33010 spoof another's address.
33011
33012 .section "Line endings" "SECTlineendings"
33013 .cindex "line endings"
33014 .cindex "carriage return"
33015 .cindex "linefeed"
33016 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33017 linefeed) is the line ending for messages transmitted over the Internet using
33018 SMTP over TCP/IP. However, within individual operating systems, different
33019 conventions are used. For example, Unix-like systems use just LF, but others
33020 use CRLF or just CR.
33021
33022 Exim was designed for Unix-like systems, and internally, it stores messages
33023 using the system's convention of a single LF as a line terminator. When
33024 receiving a message, all line endings are translated to this standard format.
33025 Originally, it was thought that programs that passed messages directly to an
33026 MTA within an operating system would use that system's convention. Experience
33027 has shown that this is not the case; for example, there are Unix applications
33028 that use CRLF in this circumstance. For this reason, and for compatibility with
33029 other MTAs, the way Exim handles line endings for all messages is now as
33030 follows:
33031
33032 .ilist
33033 LF not preceded by CR is treated as a line ending.
33034 .next
33035 CR is treated as a line ending; if it is immediately followed by LF, the LF
33036 is ignored.
33037 .next
33038 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33039 nor a local message in the state where a line containing only a dot is a
33040 terminator.
33041 .next
33042 If a bare CR is encountered within a header line, an extra space is added after
33043 the line terminator so as not to end the header line. The reasoning behind this
33044 is that bare CRs in header lines are most likely either to be mistakes, or
33045 people trying to play silly games.
33046 .next
33047 If the first header line received in a message ends with CRLF, a subsequent
33048 bare LF in a header line is treated in the same way as a bare CR in a header
33049 line.
33050 .endlist
33051
33052
33053
33054
33055
33056 .section "Unqualified addresses" "SECID218"
33057 .cindex "unqualified addresses"
33058 .cindex "address" "qualification"
33059 By default, Exim expects every envelope address it receives from an external
33060 host to be fully qualified. Unqualified addresses cause negative responses to
33061 SMTP commands. However, because SMTP is used as a means of transporting
33062 messages from MUAs running on personal workstations, there is sometimes a
33063 requirement to accept unqualified addresses from specific hosts or IP networks.
33064
33065 Exim has two options that separately control which hosts may send unqualified
33066 sender or recipient addresses in SMTP commands, namely
33067 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33068 cases, if an unqualified address is accepted, it is qualified by adding the
33069 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33070
33071 .oindex "&%qualify_domain%&"
33072 .oindex "&%qualify_recipient%&"
33073 Unqualified addresses in header lines are automatically qualified for messages
33074 that are locally originated, unless the &%-bnq%& option is given on the command
33075 line. For messages received over SMTP, unqualified addresses in header lines
33076 are qualified only if unqualified addresses are permitted in SMTP commands. In
33077 other words, such qualification is also controlled by
33078 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33079
33080
33081
33082
33083 .section "The UUCP From line" "SECID219"
33084 .cindex "&""From""& line"
33085 .cindex "UUCP" "&""From""& line"
33086 .cindex "sender" "address"
33087 .oindex "&%uucp_from_pattern%&"
33088 .oindex "&%uucp_from_sender%&"
33089 .cindex "envelope sender"
33090 .cindex "Sendmail compatibility" "&""From""& line"
33091 Messages that have come from UUCP (and some other applications) often begin
33092 with a line containing the envelope sender and a timestamp, following the word
33093 &"From"&. Examples of two common formats are:
33094 .code
33095 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33096 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33097 .endd
33098 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33099 Exim recognizes such lines at the start of messages that are submitted to it
33100 via the command line (that is, on the standard input). It does not recognize
33101 such lines in incoming SMTP messages, unless the sending host matches
33102 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33103 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33104 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33105 default value matches the two common cases shown above and puts the address
33106 that follows &"From"& into &$1$&.
33107
33108 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33109 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33110 a trusted user, the message's sender address is constructed by expanding the
33111 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33112 then parsed as an RFC 2822 address. If there is no domain, the local part is
33113 qualified with &%qualify_domain%& unless it is the empty string. However, if
33114 the command line &%-f%& option is used, it overrides the &"From"& line.
33115
33116 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33117 sender address is not changed. This is also the case for incoming SMTP messages
33118 that are permitted to contain &"From"& lines.
33119
33120 Only one &"From"& line is recognized. If there is more than one, the second is
33121 treated as a data line that starts the body of the message, as it is not valid
33122 as a header line. This also happens if a &"From"& line is present in an
33123 incoming SMTP message from a source that is not permitted to send them.
33124
33125
33126
33127 .section "Resent- header lines" "SECID220"
33128 .cindex "&%Resent-%& header lines"
33129 RFC 2822 makes provision for sets of header lines starting with the string
33130 &`Resent-`& to be added to a message when it is resent by the original
33131 recipient to somebody else. These headers are &'Resent-Date:'&,
33132 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33133 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33134
33135 .blockquote
33136 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33137 processing of replies or other such automatic actions on messages.'&
33138 .endblockquote
33139
33140 This leaves things a bit vague as far as other processing actions such as
33141 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33142 follows:
33143
33144 .ilist
33145 A &'Resent-From:'& line that just contains the login id of the submitting user
33146 is automatically rewritten in the same way as &'From:'& (see below).
33147 .next
33148 If there's a rewriting rule for a particular header line, it is also applied to
33149 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33150 &'From:'& also rewrites &'Resent-From:'&.
33151 .next
33152 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33153 also removed.
33154 .next
33155 For a locally-submitted message,
33156 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33157 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33158 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33159 included in log lines in this case.
33160 .next
33161 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33162 &%Resent-%& header lines are present.
33163 .endlist
33164
33165
33166
33167
33168 .section "The Auto-Submitted: header line" "SECID221"
33169 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33170 includes the header line:
33171 .code
33172 Auto-Submitted: auto-replied
33173 .endd
33174
33175 .section "The Bcc: header line" "SECID222"
33176 .cindex "&'Bcc:'& header line"
33177 If Exim is called with the &%-t%& option, to take recipient addresses from a
33178 message's header, it removes any &'Bcc:'& header line that may exist (after
33179 extracting its addresses). If &%-t%& is not present on the command line, any
33180 existing &'Bcc:'& is not removed.
33181
33182
33183 .section "The Date: header line" "SECID223"
33184 .cindex "&'Date:'& header line"
33185 If a locally-generated or submission-mode message has no &'Date:'& header line,
33186 Exim adds one, using the current date and time, unless the
33187 &%suppress_local_fixups%& control has been specified.
33188
33189 .section "The Delivery-date: header line" "SECID224"
33190 .cindex "&'Delivery-date:'& header line"
33191 .oindex "&%delivery_date_remove%&"
33192 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33193 set. Exim can be configured to add them to the final delivery of messages. (See
33194 the generic &%delivery_date_add%& transport option.) They should not be present
33195 in messages in transit. If the &%delivery_date_remove%& configuration option is
33196 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33197 messages.
33198
33199
33200 .section "The Envelope-to: header line" "SECID225"
33201 .cindex "&'Envelope-to:'& header line"
33202 .oindex "&%envelope_to_remove%&"
33203 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33204 Exim can be configured to add them to the final delivery of messages. (See the
33205 generic &%envelope_to_add%& transport option.) They should not be present in
33206 messages in transit. If the &%envelope_to_remove%& configuration option is set
33207 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33208 messages.
33209
33210
33211 .section "The From: header line" "SECTthefrohea"
33212 .cindex "&'From:'& header line"
33213 .cindex "Sendmail compatibility" "&""From""& line"
33214 .cindex "message" "submission"
33215 .cindex "submission mode"
33216 If a submission-mode message does not contain a &'From:'& header line, Exim
33217 adds one if either of the following conditions is true:
33218
33219 .ilist
33220 The envelope sender address is not empty (that is, this is not a bounce
33221 message). The added header line copies the envelope sender address.
33222 .next
33223 .vindex "&$authenticated_id$&"
33224 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33225 .olist
33226 .vindex "&$qualify_domain$&"
33227 If no domain is specified by the submission control, the local part is
33228 &$authenticated_id$& and the domain is &$qualify_domain$&.
33229 .next
33230 If a non-empty domain is specified by the submission control, the local
33231 part is &$authenticated_id$&, and the domain is the specified domain.
33232 .next
33233 If an empty domain is specified by the submission control,
33234 &$authenticated_id$& is assumed to be the complete address.
33235 .endlist
33236 .endlist
33237
33238 A non-empty envelope sender takes precedence.
33239
33240 If a locally-generated incoming message does not contain a &'From:'& header
33241 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33242 containing the sender's address. The calling user's login name and full name
33243 are used to construct the address, as described in section &<<SECTconstr>>&.
33244 They are obtained from the password data by calling &[getpwuid()]& (but see the
33245 &%unknown_login%& configuration option). The address is qualified with
33246 &%qualify_domain%&.
33247
33248 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33249 &'From:'& header line containing just the unqualified login name of the calling
33250 user, this is replaced by an address containing the user's login name and full
33251 name as described in section &<<SECTconstr>>&.
33252
33253
33254 .section "The Message-ID: header line" "SECID226"
33255 .cindex "&'Message-ID:'& header line"
33256 .cindex "message" "submission"
33257 .oindex "&%message_id_header_text%&"
33258 If a locally-generated or submission-mode incoming message does not contain a
33259 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33260 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33261 to the message. If there are any &'Resent-:'& headers in the message, it
33262 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33263 message id, preceded by the letter E to ensure it starts with a letter, and
33264 followed by @ and the primary host name. Additional information can be included
33265 in this header line by setting the &%message_id_header_text%& and/or
33266 &%message_id_header_domain%& options.
33267
33268
33269 .section "The Received: header line" "SECID227"
33270 .cindex "&'Received:'& header line"
33271 A &'Received:'& header line is added at the start of every message. The
33272 contents are defined by the &%received_header_text%& configuration option, and
33273 Exim automatically adds a semicolon and a timestamp to the configured string.
33274
33275 The &'Received:'& header is generated as soon as the message's header lines
33276 have been received. At this stage, the timestamp in the &'Received:'& header
33277 line is the time that the message started to be received. This is the value
33278 that is seen by the DATA ACL and by the &[local_scan()]& function.
33279
33280 Once a message is accepted, the timestamp in the &'Received:'& header line is
33281 changed to the time of acceptance, which is (apart from a small delay while the
33282 -H spool file is written) the earliest time at which delivery could start.
33283
33284
33285 .section "The References: header line" "SECID228"
33286 .cindex "&'References:'& header line"
33287 Messages created by the &(autoreply)& transport include a &'References:'&
33288 header line. This is constructed according to the rules that are described in
33289 section 3.64 of RFC 2822 (which states that replies should contain such a
33290 header line), and section 3.14 of RFC 3834 (which states that automatic
33291 responses are not different in this respect). However, because some mail
33292 processing software does not cope well with very long header lines, no more
33293 than 12 message IDs are copied from the &'References:'& header line in the
33294 incoming message. If there are more than 12, the first one and then the final
33295 11 are copied, before adding the message ID of the incoming message.
33296
33297
33298
33299 .section "The Return-path: header line" "SECID229"
33300 .cindex "&'Return-path:'& header line"
33301 .oindex "&%return_path_remove%&"
33302 &'Return-path:'& header lines are defined as something an MTA may insert when
33303 it does the final delivery of messages. (See the generic &%return_path_add%&
33304 transport option.) Therefore, they should not be present in messages in
33305 transit. If the &%return_path_remove%& configuration option is set (the
33306 default), Exim removes &'Return-path:'& header lines from incoming messages.
33307
33308
33309
33310 .section "The Sender: header line" "SECTthesenhea"
33311 .cindex "&'Sender:'& header line"
33312 .cindex "message" "submission"
33313 For a locally-originated message from an untrusted user, Exim may remove an
33314 existing &'Sender:'& header line, and it may add a new one. You can modify
33315 these actions by setting the &%local_sender_retain%& option true, the
33316 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33317 control setting.
33318
33319 When a local message is received from an untrusted user and
33320 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33321 control has not been set, a check is made to see if the address given in the
33322 &'From:'& header line is the correct (local) sender of the message. The address
33323 that is expected has the login name as the local part and the value of
33324 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33325 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33326 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33327 line is added to the message.
33328
33329 If you set &%local_from_check%& false, this checking does not occur. However,
33330 the removal of an existing &'Sender:'& line still happens, unless you also set
33331 &%local_sender_retain%& to be true. It is not possible to set both of these
33332 options true at the same time.
33333
33334 .cindex "submission mode"
33335 By default, no processing of &'Sender:'& header lines is done for messages
33336 received over TCP/IP or for messages submitted by trusted users. However, when
33337 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33338 not specified on the submission control, the following processing takes place:
33339
33340 .vindex "&$authenticated_id$&"
33341 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33342 authenticated, and &$authenticated_id$& is not empty, a sender address is
33343 created as follows:
33344
33345 .ilist
33346 .vindex "&$qualify_domain$&"
33347 If no domain is specified by the submission control, the local part is
33348 &$authenticated_id$& and the domain is &$qualify_domain$&.
33349 .next
33350 If a non-empty domain is specified by the submission control, the local part
33351 is &$authenticated_id$&, and the domain is the specified domain.
33352 .next
33353 If an empty domain is specified by the submission control,
33354 &$authenticated_id$& is assumed to be the complete address.
33355 .endlist
33356
33357 This address is compared with the address in the &'From:'& header line. If they
33358 are different, a &'Sender:'& header line containing the created address is
33359 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33360 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33361
33362 .cindex "return path" "created from &'Sender:'&"
33363 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33364 the message (the envelope sender address) is changed to be the same address,
33365 except in the case of submission mode when &%sender_retain%& is specified.
33366
33367
33368
33369 .section "Adding and removing header lines in routers and transports" &&&
33370          "SECTheadersaddrem"
33371 .cindex "header lines" "adding; in router or transport"
33372 .cindex "header lines" "removing; in router or transport"
33373 When a message is delivered, the addition and removal of header lines can be
33374 specified in a system filter, or on any of the routers and transports that
33375 process the message. Section &<<SECTaddremheasys>>& contains details about
33376 modifying headers in a system filter. Header lines can also be added in an ACL
33377 as a message is received (see section &<<SECTaddheadacl>>&).
33378
33379 In contrast to what happens in a system filter, header modifications that are
33380 specified on routers and transports apply only to the particular recipient
33381 addresses that are being processed by those routers and transports. These
33382 changes do not actually take place until a copy of the message is being
33383 transported. Therefore, they do not affect the basic set of header lines, and
33384 they do not affect the values of the variables that refer to header lines.
33385
33386 &*Note*&: In particular, this means that any expansions in the configuration of
33387 the transport cannot refer to the modified header lines, because such
33388 expansions all occur before the message is actually transported.
33389
33390 For both routers and transports, the argument of a &%headers_add%&
33391 option must be in the form of one or more RFC 2822 header lines, separated by
33392 newlines (coded as &"\n"&). For example:
33393 .code
33394 headers_add = X-added-header: added by $primary_hostname\n\
33395               X-added-second: another added header line
33396 .endd
33397 Exim does not check the syntax of these added header lines.
33398
33399 Multiple &%headers_add%& options for a single router or transport can be
33400 specified; the values will append to a single list of header lines.
33401 Each header-line is separately expanded.
33402
33403 The argument of a &%headers_remove%& option must consist of a colon-separated
33404 list of header names. This is confusing, because header names themselves are
33405 often terminated by colons. In this case, the colons are the list separators,
33406 not part of the names. For example:
33407 .code
33408 headers_remove = return-receipt-to:acknowledge-to
33409 .endd
33410
33411 Multiple &%headers_remove%& options for a single router or transport can be
33412 specified; the arguments will append to a single header-names list.
33413 Each item is separately expanded.
33414 Note that colons in complex expansions which are used to
33415 form all or part of a &%headers_remove%& list
33416 will act as list separators.
33417
33418 When &%headers_add%& or &%headers_remove%& is specified on a router,
33419 items are expanded at routing time,
33420 and then associated with all addresses that are
33421 accepted by that router, and also with any new addresses that it generates. If
33422 an address passes through several routers as a result of aliasing or
33423 forwarding, the changes are cumulative.
33424
33425 .oindex "&%unseen%&"
33426 However, this does not apply to multiple routers that result from the use of
33427 the &%unseen%& option. Any header modifications that were specified by the
33428 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33429
33430 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33431 settings cannot be delivered together in a batch, so a transport is always
33432 dealing with a set of addresses that have the same header-processing
33433 requirements.
33434
33435 The transport starts by writing the original set of header lines that arrived
33436 with the message, possibly modified by the system filter. As it writes out
33437 these lines, it consults the list of header names that were attached to the
33438 recipient address(es) by &%headers_remove%& options in routers, and it also
33439 consults the transport's own &%headers_remove%& option. Header lines whose
33440 names are on either of these lists are not written out. If there are multiple
33441 instances of any listed header, they are all skipped.
33442
33443 After the remaining original header lines have been written, new header
33444 lines that were specified by routers' &%headers_add%& options are written, in
33445 the order in which they were attached to the address. These are followed by any
33446 header lines specified by the transport's &%headers_add%& option.
33447
33448 This way of handling header line modifications in routers and transports has
33449 the following consequences:
33450
33451 .ilist
33452 The original set of header lines, possibly modified by the system filter,
33453 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33454 to it, at all times.
33455 .next
33456 Header lines that are added by a router's
33457 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33458 expansion syntax in subsequent routers or the transport.
33459 .next
33460 Conversely, header lines that are specified for removal by &%headers_remove%&
33461 in a router remain visible to subsequent routers and the transport.
33462 .next
33463 Headers added to an address by &%headers_add%& in a router cannot be removed by
33464 a later router or by a transport.
33465 .next
33466 An added header can refer to the contents of an original header that is to be
33467 removed, even it has the same name as the added header. For example:
33468 .code
33469 headers_remove = subject
33470 headers_add = Subject: new subject (was: $h_subject:)
33471 .endd
33472 .endlist
33473
33474 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33475 for a &(redirect)& router that has the &%one_time%& option set.
33476
33477
33478
33479
33480
33481 .section "Constructed addresses" "SECTconstr"
33482 .cindex "address" "constructed"
33483 .cindex "constructed address"
33484 When Exim constructs a sender address for a locally-generated message, it uses
33485 the form
33486 .display
33487 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33488 .endd
33489 For example:
33490 .code
33491 Zaphod Beeblebrox <zaphod@end.univ.example>
33492 .endd
33493 The user name is obtained from the &%-F%& command line option if set, or
33494 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33495 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33496 ampersand character, this is replaced by the login name with the first letter
33497 upper cased, as is conventional in a number of operating systems. See the
33498 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33499 The &%unknown_username%& option can be used to specify user names in cases when
33500 there is no password file entry.
33501
33502 .cindex "RFC 2047"
33503 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33504 parts of it if necessary. In addition, if it contains any non-printing
33505 characters, it is encoded as described in RFC 2047, which defines a way of
33506 including non-ASCII characters in header lines. The value of the
33507 &%headers_charset%& option specifies the name of the encoding that is used (the
33508 characters are assumed to be in this encoding). The setting of
33509 &%print_topbitchars%& controls whether characters with the top bit set (that
33510 is, with codes greater than 127) count as printing characters or not.
33511
33512
33513
33514 .section "Case of local parts" "SECID230"
33515 .cindex "case of local parts"
33516 .cindex "local part" "case of"
33517 RFC 2822 states that the case of letters in the local parts of addresses cannot
33518 be assumed to be non-significant. Exim preserves the case of local parts of
33519 addresses, but by default it uses a lower-cased form when it is routing,
33520 because on most Unix systems, usernames are in lower case and case-insensitive
33521 routing is required. However, any particular router can be made to use the
33522 original case for local parts by setting the &%caseful_local_part%& generic
33523 router option.
33524
33525 .cindex "mixed-case login names"
33526 If you must have mixed-case user names on your system, the best way to proceed,
33527 assuming you want case-independent handling of incoming email, is to set up
33528 your first router to convert incoming local parts in your domains to the
33529 correct case by means of a file lookup. For example:
33530 .code
33531 correct_case:
33532   driver = redirect
33533   domains = +local_domains
33534   data = ${lookup{$local_part}cdb\
33535               {/etc/usercased.cdb}{$value}fail}\
33536               @$domain
33537 .endd
33538 For this router, the local part is forced to lower case by the default action
33539 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33540 up a new local part in the correct case. If you then set &%caseful_local_part%&
33541 on any subsequent routers which process your domains, they will operate on
33542 local parts with the correct case in a case-sensitive manner.
33543
33544
33545
33546 .section "Dots in local parts" "SECID231"
33547 .cindex "dot" "in local part"
33548 .cindex "local part" "dots in"
33549 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33550 part may not begin or end with a dot, nor have two consecutive dots in the
33551 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33552 empty components for compatibility.
33553
33554
33555
33556 .section "Rewriting addresses" "SECID232"
33557 .cindex "rewriting" "addresses"
33558 Rewriting of sender and recipient addresses, and addresses in headers, can
33559 happen automatically, or as the result of configuration options, as described
33560 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33561 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33562
33563 Automatic rewriting includes qualification, as mentioned above. The other case
33564 in which it can happen is when an incomplete non-local domain is given. The
33565 routing process may cause this to be expanded into the full domain name. For
33566 example, a header such as
33567 .code
33568 To: hare@teaparty
33569 .endd
33570 might get rewritten as
33571 .code
33572 To: hare@teaparty.wonderland.fict.example
33573 .endd
33574 Rewriting as a result of routing is the one kind of message processing that
33575 does not happen at input time, as it cannot be done until the address has
33576 been routed.
33577
33578 Strictly, one should not do &'any'& deliveries of a message until all its
33579 addresses have been routed, in case any of the headers get changed as a
33580 result of routing. However, doing this in practice would hold up many
33581 deliveries for unreasonable amounts of time, just because one address could not
33582 immediately be routed. Exim therefore does not delay other deliveries when
33583 routing of one or more addresses is deferred.
33584 .ecindex IIDmesproc
33585
33586
33587
33588 . ////////////////////////////////////////////////////////////////////////////
33589 . ////////////////////////////////////////////////////////////////////////////
33590
33591 .chapter "SMTP processing" "CHAPSMTP"
33592 .scindex IIDsmtpproc1 "SMTP" "processing details"
33593 .scindex IIDsmtpproc2 "LMTP" "processing details"
33594 Exim supports a number of different ways of using the SMTP protocol, and its
33595 LMTP variant, which is an interactive protocol for transferring messages into a
33596 closed mail store application. This chapter contains details of how SMTP is
33597 processed. For incoming mail, the following are available:
33598
33599 .ilist
33600 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33601 .next
33602 SMTP over the standard input and output (the &%-bs%& option);
33603 .next
33604 Batched SMTP on the standard input (the &%-bS%& option).
33605 .endlist
33606
33607 For mail delivery, the following are available:
33608
33609 .ilist
33610 SMTP over TCP/IP (the &(smtp)& transport);
33611 .next
33612 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33613 &"lmtp"&);
33614 .next
33615 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33616 transport);
33617 .next
33618 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33619 the &%use_bsmtp%& option set).
33620 .endlist
33621
33622 &'Batched SMTP'& is the name for a process in which batches of messages are
33623 stored in or read from files (or pipes), in a format in which SMTP commands are
33624 used to contain the envelope information.
33625
33626
33627
33628 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33629 .cindex "SMTP" "outgoing over TCP/IP"
33630 .cindex "outgoing SMTP over TCP/IP"
33631 .cindex "LMTP" "over TCP/IP"
33632 .cindex "outgoing LMTP over TCP/IP"
33633 .cindex "EHLO"
33634 .cindex "HELO"
33635 .cindex "SIZE option on MAIL command"
33636 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33637 The &%protocol%& option selects which protocol is to be used, but the actual
33638 processing is the same in both cases.
33639
33640 If, in response to its EHLO command, Exim is told that the SIZE
33641 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33642 command. The value of <&'n'&> is the message size plus the value of the
33643 &%size_addition%& option (default 1024) to allow for additions to the message
33644 such as per-transport header lines, or changes made in a
33645 .cindex "transport" "filter"
33646 .cindex "filter" "transport filter"
33647 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33648 suppressed.
33649
33650 If the remote server advertises support for PIPELINING, Exim uses the
33651 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33652 required for the transaction.
33653
33654 If the remote server advertises support for the STARTTLS command, and Exim
33655 was built to support TLS encryption, it tries to start a TLS session unless the
33656 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33657 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33658 is called for verification.
33659
33660 If the remote server advertises support for the AUTH command, Exim scans
33661 the authenticators configuration for any suitable client settings, as described
33662 in chapter &<<CHAPSMTPAUTH>>&.
33663
33664 .cindex "carriage return"
33665 .cindex "linefeed"
33666 Responses from the remote host are supposed to be terminated by CR followed by
33667 LF. However, there are known to be hosts that do not send CR characters, so in
33668 order to be able to interwork with such hosts, Exim treats LF on its own as a
33669 line terminator.
33670
33671 If a message contains a number of different addresses, all those with the same
33672 characteristics (for example, the same envelope sender) that resolve to the
33673 same set of hosts, in the same order, are sent in a single SMTP transaction,
33674 even if they are for different domains, unless there are more than the setting
33675 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33676 they are split into groups containing no more than &%max_rcpt%&s addresses
33677 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33678 in parallel sessions. The order of hosts with identical MX values is not
33679 significant when checking whether addresses can be batched in this way.
33680
33681 When the &(smtp)& transport suffers a temporary failure that is not
33682 message-related, Exim updates its transport-specific database, which contains
33683 records indexed by host name that remember which messages are waiting for each
33684 particular host. It also updates the retry database with new retry times.
33685
33686 .cindex "hints database" "retry keys"
33687 Exim's retry hints are based on host name plus IP address, so if one address of
33688 a multi-homed host is broken, it will soon be skipped most of the time.
33689 See the next section for more detail about error handling.
33690
33691 .cindex "SMTP" "passed connection"
33692 .cindex "SMTP" "batching over TCP/IP"
33693 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33694 looks in the hints database for the transport to see if there are any queued
33695 messages waiting for the host to which it is connected. If it finds one, it
33696 creates a new Exim process using the &%-MC%& option (which can only be used by
33697 a process running as root or the Exim user) and passes the TCP/IP socket to it
33698 so that it can deliver another message using the same socket. The new process
33699 does only those deliveries that are routed to the connected host, and may in
33700 turn pass the socket on to a third process, and so on.
33701
33702 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33703 limit the number of messages sent down a single TCP/IP connection.
33704
33705 .cindex "asterisk" "after IP address"
33706 The second and subsequent messages delivered down an existing connection are
33707 identified in the main log by the addition of an asterisk after the closing
33708 square bracket of the IP address.
33709
33710
33711
33712
33713 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33714 .cindex "error" "in outgoing SMTP"
33715 .cindex "SMTP" "errors in outgoing"
33716 .cindex "host" "error"
33717 Three different kinds of error are recognized for outgoing SMTP: host errors,
33718 message errors, and recipient errors.
33719
33720 .vlist
33721 .vitem "&*Host errors*&"
33722 A host error is not associated with a particular message or with a
33723 particular recipient of a message. The host errors are:
33724
33725 .ilist
33726 Connection refused or timed out,
33727 .next
33728 Any error response code on connection,
33729 .next
33730 Any error response code to EHLO or HELO,
33731 .next
33732 Loss of connection at any time, except after &"."&,
33733 .next
33734 I/O errors at any time,
33735 .next
33736 Timeouts during the session, other than in response to MAIL, RCPT or
33737 the &"."& at the end of the data.
33738 .endlist ilist
33739
33740 For a host error, a permanent error response on connection, or in response to
33741 EHLO, causes all addresses routed to the host to be failed. Any other host
33742 error causes all addresses to be deferred, and retry data to be created for the
33743 host. It is not tried again, for any message, until its retry time arrives. If
33744 the current set of addresses are not all delivered in this run (to some
33745 alternative host), the message is added to the list of those waiting for this
33746 host, so if it is still undelivered when a subsequent successful delivery is
33747 made to the host, it will be sent down the same SMTP connection.
33748
33749 .vitem "&*Message errors*&"
33750 .cindex "message" "error"
33751 A message error is associated with a particular message when sent to a
33752 particular host, but not with a particular recipient of the message. The
33753 message errors are:
33754
33755 .ilist
33756 Any error response code to MAIL, DATA, or the &"."& that terminates
33757 the data,
33758 .next
33759 Timeout after MAIL,
33760 .next
33761 Timeout or loss of connection after the &"."& that terminates the data. A
33762 timeout after the DATA command itself is treated as a host error, as is loss of
33763 connection at any other time.
33764 .endlist ilist
33765
33766 For a message error, a permanent error response (5&'xx'&) causes all addresses
33767 to be failed, and a delivery error report to be returned to the sender. A
33768 temporary error response (4&'xx'&), or one of the timeouts, causes all
33769 addresses to be deferred. Retry data is not created for the host, but instead,
33770 a retry record for the combination of host plus message id is created. The
33771 message is not added to the list of those waiting for this host. This ensures
33772 that the failing message will not be sent to this host again until the retry
33773 time arrives. However, other messages that are routed to the host are not
33774 affected, so if it is some property of the message that is causing the error,
33775 it will not stop the delivery of other mail.
33776
33777 If the remote host specified support for the SIZE parameter in its response
33778 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33779 over-large message will cause a message error because the error arrives as a
33780 response to MAIL.
33781
33782 .vitem "&*Recipient errors*&"
33783 .cindex "recipient" "error"
33784 A recipient error is associated with a particular recipient of a message. The
33785 recipient errors are:
33786
33787 .ilist
33788 Any error response to RCPT,
33789 .next
33790 Timeout after RCPT.
33791 .endlist
33792
33793 For a recipient error, a permanent error response (5&'xx'&) causes the
33794 recipient address to be failed, and a bounce message to be returned to the
33795 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33796 address to be deferred, and routing retry data to be created for it. This is
33797 used to delay processing of the address in subsequent queue runs, until its
33798 routing retry time arrives. This applies to all messages, but because it
33799 operates only in queue runs, one attempt will be made to deliver a new message
33800 to the failing address before the delay starts to operate. This ensures that,
33801 if the failure is really related to the message rather than the recipient
33802 (&"message too big for this recipient"& is a possible example), other messages
33803 have a chance of getting delivered. If a delivery to the address does succeed,
33804 the retry information gets cleared, so all stuck messages get tried again, and
33805 the retry clock is reset.
33806
33807 The message is not added to the list of those waiting for this host. Use of the
33808 host for other messages is unaffected, and except in the case of a timeout,
33809 other recipients are processed independently, and may be successfully delivered
33810 in the current SMTP session. After a timeout it is of course impossible to
33811 proceed with the session, so all addresses get deferred. However, those other
33812 than the one that failed do not suffer any subsequent retry delays. Therefore,
33813 if one recipient is causing trouble, the others have a chance of getting
33814 through when a subsequent delivery attempt occurs before the failing
33815 recipient's retry time.
33816 .endlist
33817
33818 In all cases, if there are other hosts (or IP addresses) available for the
33819 current set of addresses (for example, from multiple MX records), they are
33820 tried in this run for any undelivered addresses, subject of course to their
33821 own retry data. In other words, recipient error retry data does not take effect
33822 until the next delivery attempt.
33823
33824 Some hosts have been observed to give temporary error responses to every
33825 MAIL command at certain times (&"insufficient space"& has been seen). It
33826 would be nice if such circumstances could be recognized, and defer data for the
33827 host itself created, but this is not possible within the current Exim design.
33828 What actually happens is that retry data for every (host, message) combination
33829 is created.
33830
33831 The reason that timeouts after MAIL and RCPT are treated specially is that
33832 these can sometimes arise as a result of the remote host's verification
33833 procedures. Exim makes this assumption, and treats them as if a temporary error
33834 response had been received. A timeout after &"."& is treated specially because
33835 it is known that some broken implementations fail to recognize the end of the
33836 message if the last character of the last line is a binary zero. Thus, it is
33837 helpful to treat this case as a message error.
33838
33839 Timeouts at other times are treated as host errors, assuming a problem with the
33840 host, or the connection to it. If a timeout after MAIL, RCPT,
33841 or &"."& is really a connection problem, the assumption is that at the next try
33842 the timeout is likely to occur at some other point in the dialogue, causing it
33843 then to be treated as a host error.
33844
33845 There is experimental evidence that some MTAs drop the connection after the
33846 terminating &"."& if they do not like the contents of the message for some
33847 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33848 should be given. That is why Exim treats this case as a message rather than a
33849 host error, in order not to delay other messages to the same host.
33850
33851
33852
33853
33854 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33855 .cindex "SMTP" "incoming over TCP/IP"
33856 .cindex "incoming SMTP over TCP/IP"
33857 .cindex "inetd"
33858 .cindex "daemon"
33859 Incoming SMTP messages can be accepted in one of two ways: by running a
33860 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33861 &_/etc/inetd.conf_& should be like this:
33862 .code
33863 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33864 .endd
33865 Exim distinguishes between this case and the case of a locally running user
33866 agent using the &%-bs%& option by checking whether or not the standard input is
33867 a socket. When it is, either the port must be privileged (less than 1024), or
33868 the caller must be root or the Exim user. If any other user passes a socket
33869 with an unprivileged port number, Exim prints a message on the standard error
33870 stream and exits with an error code.
33871
33872 By default, Exim does not make a log entry when a remote host connects or
33873 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33874 unexpected. It can be made to write such log entries by setting the
33875 &%smtp_connection%& log selector.
33876
33877 .cindex "carriage return"
33878 .cindex "linefeed"
33879 Commands from the remote host are supposed to be terminated by CR followed by
33880 LF. However, there are known to be hosts that do not send CR characters. In
33881 order to be able to interwork with such hosts, Exim treats LF on its own as a
33882 line terminator.
33883 Furthermore, because common code is used for receiving messages from all
33884 sources, a CR on its own is also interpreted as a line terminator. However, the
33885 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33886
33887 .cindex "EHLO" "invalid data"
33888 .cindex "HELO" "invalid data"
33889 One area that sometimes gives rise to problems concerns the EHLO or
33890 HELO commands. Some clients send syntactically invalid versions of these
33891 commands, which Exim rejects by default. (This is nothing to do with verifying
33892 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33893 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33894 match the broken hosts that send invalid commands.
33895
33896 .cindex "SIZE option on MAIL command"
33897 .cindex "MAIL" "SIZE option"
33898 The amount of disk space available is checked whenever SIZE is received on
33899 a MAIL command, independently of whether &%message_size_limit%& or
33900 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33901 false. A temporary error is given if there is not enough space. If
33902 &%check_spool_space%& is set, the check is for that amount of space plus the
33903 value given with SIZE, that is, it checks that the addition of the incoming
33904 message will not reduce the space below the threshold.
33905
33906 When a message is successfully received, Exim includes the local message id in
33907 its response to the final &"."& that terminates the data. If the remote host
33908 logs this text it can help with tracing what has happened to a message.
33909
33910 The Exim daemon can limit the number of simultaneous incoming connections it is
33911 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33912 number of simultaneous incoming connections from a single remote host (see the
33913 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33914 rejected using the SMTP temporary error code 421.
33915
33916 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33917 subprocess has finished, as this can get lost at busy times. Instead, it looks
33918 for completed subprocesses every time it wakes up. Provided there are other
33919 things happening (new incoming calls, starts of queue runs), completed
33920 processes will be noticed and tidied away. On very quiet systems you may
33921 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33922 it will be noticed when the daemon next wakes up.
33923
33924 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33925 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33926 high system load &-- for details see the &%smtp_accept_reserve%&,
33927 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33928 applies in both the daemon and &'inetd'& cases.
33929
33930 Exim normally starts a delivery process for each message received, though this
33931 can be varied by means of the &%-odq%& command line option and the
33932 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33933 number of simultaneously running delivery processes started in this way from
33934 SMTP input can be limited by the &%smtp_accept_queue%& and
33935 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33936 subsequently received messages are just put on the input queue without starting
33937 a delivery process.
33938
33939 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33940 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33941 started up from the &'inetd'& daemon, because in that case each connection is
33942 handled by an entirely independent Exim process. Control by load average is,
33943 however, available with &'inetd'&.
33944
33945 Exim can be configured to verify addresses in incoming SMTP commands as they
33946 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33947 to rewrite addresses at this time &-- before any syntax checking is done. See
33948 section &<<SECTrewriteS>>&.
33949
33950 Exim can also be configured to limit the rate at which a client host submits
33951 MAIL and RCPT commands in a single SMTP session. See the
33952 &%smtp_ratelimit_hosts%& option.
33953
33954
33955
33956 .section "Unrecognized SMTP commands" "SECID234"
33957 .cindex "SMTP" "unrecognized commands"
33958 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33959 commands during a single SMTP connection, it drops the connection after sending
33960 the error response to the last command. The default value for
33961 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33962 abuse that subvert web servers into making connections to SMTP ports; in these
33963 circumstances, a number of non-SMTP lines are sent first.
33964
33965
33966 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33967 .cindex "SMTP" "syntax errors"
33968 .cindex "SMTP" "protocol errors"
33969 A syntax error is detected if an SMTP command is recognized, but there is
33970 something syntactically wrong with its data, for example, a malformed email
33971 address in a RCPT command. Protocol errors include invalid command
33972 sequencing such as RCPT before MAIL. If Exim receives more than
33973 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33974 drops the connection after sending the error response to the last command. The
33975 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33976 broken clients that loop sending bad commands (yes, it has been seen).
33977
33978
33979
33980 .section "Use of non-mail SMTP commands" "SECID236"
33981 .cindex "SMTP" "non-mail commands"
33982 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33983 DATA. Exim counts such commands, and drops the connection if there are too
33984 many of them in a single SMTP session. This action catches some
33985 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33986 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33987 defines what &"too many"& means. Its default value is 10.
33988
33989 When a new message is expected, one occurrence of RSET is not counted. This
33990 allows a client to send one RSET between messages (this is not necessary,
33991 but some clients do it). Exim also allows one uncounted occurrence of HELO
33992 or EHLO, and one occurrence of STARTTLS between messages. After
33993 starting up a TLS session, another EHLO is expected, and so it too is not
33994 counted.
33995
33996 The first occurrence of AUTH in a connection, or immediately following
33997 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33998 RCPT, DATA, and QUIT are counted.
33999
34000 You can control which hosts are subject to the limit set by
34001 &%smtp_accept_max_nonmail%& by setting
34002 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34003 the limit apply to all hosts. This option means that you can exclude any
34004 specific badly-behaved hosts that you have to live with.
34005
34006
34007
34008
34009 .section "The VRFY and EXPN commands" "SECID237"
34010 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34011 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34012 appropriate) in order to decide whether the command should be accepted or not.
34013
34014 .cindex "VRFY" "processing"
34015 When no ACL is defined for VRFY, or if it rejects without
34016 setting an explicit response code, the command is accepted
34017 (with a 252 SMTP response code)
34018 in order to support awkward clients that do a VRFY before every RCPT.
34019 When VRFY is accepted, it runs exactly the same code as when Exim is
34020 called with the &%-bv%& option, and returns 250/451/550
34021 SMTP response codes.
34022
34023 .cindex "EXPN" "processing"
34024 If no ACL for EXPN is defined, the command is rejected.
34025 When EXPN is accepted, a single-level expansion of the address is done.
34026 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34027 than a verification (the &%-bv%& option). If an unqualified local part is given
34028 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34029 of VRFY and EXPN commands are logged on the main and reject logs, and
34030 VRFY verification failures are logged on the main log for consistency with
34031 RCPT failures.
34032
34033
34034
34035 .section "The ETRN command" "SECTETRN"
34036 .cindex "ETRN" "processing"
34037 RFC 1985 describes an SMTP command called ETRN that is designed to
34038 overcome the security problems of the TURN command (which has fallen into
34039 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34040 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34041 should be accepted or not. If no ACL is defined, the command is rejected.
34042
34043 The ETRN command is concerned with &"releasing"& messages that are awaiting
34044 delivery to certain hosts. As Exim does not organize its message queue by host,
34045 the only form of ETRN that is supported by default is the one where the
34046 text starts with the &"#"& prefix, in which case the remainder of the text is
34047 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34048 the &%-R%& option to happen, with the remainder of the ETRN text as its
34049 argument. For example,
34050 .code
34051 ETRN #brigadoon
34052 .endd
34053 runs the command
34054 .code
34055 exim -R brigadoon
34056 .endd
34057 which causes a delivery attempt on all messages with undelivered addresses
34058 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34059 default), Exim prevents the simultaneous execution of more than one queue run
34060 for the same argument string as a result of an ETRN command. This stops
34061 a misbehaving client from starting more than one queue runner at once.
34062
34063 .cindex "hints database" "ETRN serialization"
34064 Exim implements the serialization by means of a hints database in which a
34065 record is written whenever a process is started by ETRN, and deleted when
34066 the process completes. However, Exim does not keep the SMTP session waiting for
34067 the ETRN process to complete. Once ETRN is accepted, the client is sent
34068 a &"success"& return code. Obviously there is scope for hints records to get
34069 left lying around if there is a system or program crash. To guard against this,
34070 Exim ignores any records that are more than six hours old.
34071
34072 .oindex "&%smtp_etrn_command%&"
34073 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34074 used. This specifies a command that is run whenever ETRN is received,
34075 whatever the form of its argument. For
34076 example:
34077 .code
34078 smtp_etrn_command = /etc/etrn_command $domain \
34079                     $sender_host_address
34080 .endd
34081 .vindex "&$domain$&"
34082 The string is split up into arguments which are independently expanded. The
34083 expansion variable &$domain$& is set to the argument of the ETRN command,
34084 and no syntax checking is done on the contents of this argument. Exim does not
34085 wait for the command to complete, so its status code is not checked. Exim runs
34086 under its own uid and gid when receiving incoming SMTP, so it is not possible
34087 for it to change them before running the command.
34088
34089
34090
34091 .section "Incoming local SMTP" "SECID238"
34092 .cindex "SMTP" "local incoming"
34093 Some user agents use SMTP to pass messages to their local MTA using the
34094 standard input and output, as opposed to passing the envelope on the command
34095 line and writing the message to the standard input. This is supported by the
34096 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34097 messages over TCP/IP (including the use of ACLs), except that the envelope
34098 sender given in a MAIL command is ignored unless the caller is trusted. In
34099 an ACL you can detect this form of SMTP input by testing for an empty host
34100 identification. It is common to have this as the first line in the ACL that
34101 runs for RCPT commands:
34102 .code
34103 accept hosts = :
34104 .endd
34105 This accepts SMTP messages from local processes without doing any other tests.
34106
34107
34108
34109 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34110 .cindex "SMTP" "batched outgoing"
34111 .cindex "batched SMTP output"
34112 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34113 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34114 be output in BSMTP format. No SMTP responses are possible for this form of
34115 delivery. All it is doing is using SMTP commands as a way of transmitting the
34116 envelope along with the message.
34117
34118 The message is written to the file or pipe preceded by the SMTP commands
34119 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34120 the message that start with a dot have an extra dot added. The SMTP command
34121 HELO is not normally used. If it is required, the &%message_prefix%& option
34122 can be used to specify it.
34123
34124 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34125 one recipient address at a time by default. However, you can arrange for them
34126 to handle several addresses at once by setting the &%batch_max%& option. When
34127 this is done for BSMTP, messages may contain multiple RCPT commands. See
34128 chapter &<<CHAPbatching>>& for more details.
34129
34130 .vindex "&$host$&"
34131 When one or more addresses are routed to a BSMTP transport by a router that
34132 sets up a host list, the name of the first host on the list is available to the
34133 transport in the variable &$host$&. Here is an example of such a transport and
34134 router:
34135 .code
34136 begin routers
34137 route_append:
34138   driver = manualroute
34139   transport = smtp_appendfile
34140   route_list = domain.example  batch.host.example
34141
34142 begin transports
34143 smtp_appendfile:
34144   driver = appendfile
34145   directory = /var/bsmtp/$host
34146   batch_max = 1000
34147   use_bsmtp
34148   user = exim
34149 .endd
34150 This causes messages addressed to &'domain.example'& to be written in BSMTP
34151 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34152 message (unless there are more than 1000 recipients).
34153
34154
34155
34156 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34157 .cindex "SMTP" "batched incoming"
34158 .cindex "batched SMTP input"
34159 The &%-bS%& command line option causes Exim to accept one or more messages by
34160 reading SMTP on the standard input, but to generate no responses. If the caller
34161 is trusted, the senders in the MAIL commands are believed; otherwise the
34162 sender is always the caller of Exim. Unqualified senders and receivers are not
34163 rejected (there seems little point) but instead just get qualified. HELO
34164 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34165 as NOOP; QUIT quits.
34166
34167 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34168 ACL is run in the same way as for non-SMTP local input.
34169
34170 If an error is detected while reading a message, including a missing &"."& at
34171 the end, Exim gives up immediately. It writes details of the error to the
34172 standard output in a stylized way that the calling program should be able to
34173 make some use of automatically, for example:
34174 .code
34175 554 Unexpected end of file
34176 Transaction started in line 10
34177 Error detected in line 14
34178 .endd
34179 It writes a more verbose version, for human consumption, to the standard error
34180 file, for example:
34181 .code
34182 An error was detected while processing a file of BSMTP input.
34183 The error message was:
34184
34185 501 '>' missing at end of address
34186
34187 The SMTP transaction started in line 10.
34188 The error was detected in line 12.
34189 The SMTP command at fault was:
34190
34191 rcpt to:<malformed@in.com.plete
34192
34193 1 previous message was successfully processed.
34194 The rest of the batch was abandoned.
34195 .endd
34196 The return code from Exim is zero only if there were no errors. It is 1 if some
34197 messages were accepted before an error was detected, and 2 if no messages were
34198 accepted.
34199 .ecindex IIDsmtpproc1
34200 .ecindex IIDsmtpproc2
34201
34202
34203
34204 . ////////////////////////////////////////////////////////////////////////////
34205 . ////////////////////////////////////////////////////////////////////////////
34206
34207 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34208          "Customizing messages"
34209 When a message fails to be delivered, or remains on the queue for more than a
34210 configured amount of time, Exim sends a message to the original sender, or
34211 to an alternative configured address. The text of these messages is built into
34212 the code of Exim, but it is possible to change it, either by adding a single
34213 string, or by replacing each of the paragraphs by text supplied in a file.
34214
34215 The &'From:'& and &'To:'& header lines are automatically generated; you can
34216 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34217 option. Exim also adds the line
34218 .code
34219 Auto-Submitted: auto-generated
34220 .endd
34221 to all warning and bounce messages,
34222
34223
34224 .section "Customizing bounce messages" "SECID239"
34225 .cindex "customizing" "bounce message"
34226 .cindex "bounce message" "customizing"
34227 If &%bounce_message_text%& is set, its contents are included in the default
34228 message immediately after &"This message was created automatically by mail
34229 delivery software."& The string is not expanded. It is not used if
34230 &%bounce_message_file%& is set.
34231
34232 When &%bounce_message_file%& is set, it must point to a template file for
34233 constructing error messages. The file consists of a series of text items,
34234 separated by lines consisting of exactly four asterisks. If the file cannot be
34235 opened, default text is used and a message is written to the main and panic
34236 logs. If any text item in the file is empty, default text is used for that
34237 item.
34238
34239 .vindex "&$bounce_recipient$&"
34240 .vindex "&$bounce_return_size_limit$&"
34241 Each item of text that is read from the file is expanded, and there are two
34242 expansion variables which can be of use here: &$bounce_recipient$& is set to
34243 the recipient of an error message while it is being created, and
34244 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34245 option, rounded to a whole number.
34246
34247 The items must appear in the file in the following order:
34248
34249 .ilist
34250 The first item is included in the headers, and should include at least a
34251 &'Subject:'& header. Exim does not check the syntax of these headers.
34252 .next
34253 The second item forms the start of the error message. After it, Exim lists the
34254 failing addresses with their error messages.
34255 .next
34256 The third item is used to introduce any text from pipe transports that is to be
34257 returned to the sender. It is omitted if there is no such text.
34258 .next
34259 The fourth, fifth and sixth items will be ignored and may be empty.
34260 The fields exist for back-compatibility
34261 .endlist
34262
34263 The default state (&%bounce_message_file%& unset) is equivalent to the
34264 following file, in which the sixth item is empty. The &'Subject:'& and some
34265 other lines have been split in order to fit them on the page:
34266 .code
34267 Subject: Mail delivery failed
34268   ${if eq{$sender_address}{$bounce_recipient}
34269   {: returning message to sender}}
34270 ****
34271 This message was created automatically by mail delivery software.
34272
34273 A message ${if eq{$sender_address}{$bounce_recipient}
34274   {that you sent }{sent by
34275
34276 <$sender_address>
34277
34278 }}could not be delivered to all of its recipients.
34279 This is a permanent error. The following address(es) failed:
34280 ****
34281 The following text was generated during the delivery attempt(s):
34282 ****
34283 ------ This is a copy of the message, including all the headers.
34284   ------
34285 ****
34286 ------ The body of the message is $message_size characters long;
34287   only the first
34288 ------ $bounce_return_size_limit or so are included here.
34289 ****
34290 .endd
34291 .section "Customizing warning messages" "SECTcustwarn"
34292 .cindex "customizing" "warning message"
34293 .cindex "warning of delay" "customizing the message"
34294 The option &%warn_message_file%& can be pointed at a template file for use when
34295 warnings about message delays are created. In this case there are only three
34296 text sections:
34297
34298 .ilist
34299 The first item is included in the headers, and should include at least a
34300 &'Subject:'& header. Exim does not check the syntax of these headers.
34301 .next
34302 The second item forms the start of the warning message. After it, Exim lists
34303 the delayed addresses.
34304 .next
34305 The third item then ends the message.
34306 .endlist
34307
34308 The default state is equivalent to the following file, except that some lines
34309 have been split here, in order to fit them on the page:
34310 .code
34311 Subject: Warning: message $message_exim_id delayed
34312   $warn_message_delay
34313 ****
34314 This message was created automatically by mail delivery software.
34315
34316 A message ${if eq{$sender_address}{$warn_message_recipients}
34317 {that you sent }{sent by
34318
34319 <$sender_address>
34320
34321 }}has not been delivered to all of its recipients after
34322 more than $warn_message_delay on the queue on $primary_hostname.
34323
34324 The message identifier is:     $message_exim_id
34325 The subject of the message is: $h_subject
34326 The date of the message is:    $h_date
34327
34328 The following address(es) have not yet been delivered:
34329 ****
34330 No action is required on your part. Delivery attempts will
34331 continue for some time, and this warning may be repeated at
34332 intervals if the message remains undelivered. Eventually the
34333 mail delivery software will give up, and when that happens,
34334 the message will be returned to you.
34335 .endd
34336 .vindex "&$warn_message_delay$&"
34337 .vindex "&$warn_message_recipients$&"
34338 However, in the default state the subject and date lines are omitted if no
34339 appropriate headers exist. During the expansion of this file,
34340 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34341 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34342 of recipients for the warning message. There may be more than one if there are
34343 multiple addresses with different &%errors_to%& settings on the routers that
34344 handled them.
34345
34346
34347
34348
34349 . ////////////////////////////////////////////////////////////////////////////
34350 . ////////////////////////////////////////////////////////////////////////////
34351
34352 .chapter "Some common configuration settings" "CHAPcomconreq"
34353 This chapter discusses some configuration settings that seem to be fairly
34354 common. More examples and discussion can be found in the Exim book.
34355
34356
34357
34358 .section "Sending mail to a smart host" "SECID240"
34359 .cindex "smart host" "example router"
34360 If you want to send all mail for non-local domains to a &"smart host"&, you
34361 should replace the default &(dnslookup)& router with a router which does the
34362 routing explicitly:
34363 .code
34364 send_to_smart_host:
34365   driver = manualroute
34366   route_list = !+local_domains smart.host.name
34367   transport = remote_smtp
34368 .endd
34369 You can use the smart host's IP address instead of the name if you wish.
34370 If you are using Exim only to submit messages to a smart host, and not for
34371 receiving incoming messages, you can arrange for it to do the submission
34372 synchronously by setting the &%mua_wrapper%& option (see chapter
34373 &<<CHAPnonqueueing>>&).
34374
34375
34376
34377
34378 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34379 .cindex "mailing lists"
34380 Exim can be used to run simple mailing lists, but for large and/or complicated
34381 requirements, the use of additional specialized mailing list software such as
34382 Majordomo or Mailman is recommended.
34383
34384 The &(redirect)& router can be used to handle mailing lists where each list
34385 is maintained in a separate file, which can therefore be managed by an
34386 independent manager. The &%domains%& router option can be used to run these
34387 lists in a separate domain from normal mail. For example:
34388 .code
34389 lists:
34390   driver = redirect
34391   domains = lists.example
34392   file = /usr/lists/$local_part
34393   forbid_pipe
34394   forbid_file
34395   errors_to = $local_part-request@lists.example
34396   no_more
34397 .endd
34398 This router is skipped for domains other than &'lists.example'&. For addresses
34399 in that domain, it looks for a file that matches the local part. If there is no
34400 such file, the router declines, but because &%no_more%& is set, no subsequent
34401 routers are tried, and so the whole delivery fails.
34402
34403 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34404 expanded into a file name or a pipe delivery, which is usually inappropriate in
34405 a mailing list.
34406
34407 .oindex "&%errors_to%&"
34408 The &%errors_to%& option specifies that any delivery errors caused by addresses
34409 taken from a mailing list are to be sent to the given address rather than the
34410 original sender of the message. However, before acting on this, Exim verifies
34411 the error address, and ignores it if verification fails.
34412
34413 For example, using the configuration above, mail sent to
34414 &'dicts@lists.example'& is passed on to those addresses contained in
34415 &_/usr/lists/dicts_&, with error reports directed to
34416 &'dicts-request@lists.example'&, provided that this address can be verified.
34417 There could be a file called &_/usr/lists/dicts-request_& containing
34418 the address(es) of this particular list's manager(s), but other approaches,
34419 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34420 or &%local_part_suffix%& options) to handle addresses of the form
34421 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34422
34423
34424
34425 .section "Syntax errors in mailing lists" "SECID241"
34426 .cindex "mailing lists" "syntax errors in"
34427 If an entry in redirection data contains a syntax error, Exim normally defers
34428 delivery of the original address. That means that a syntax error in a mailing
34429 list holds up all deliveries to the list. This may not be appropriate when a
34430 list is being maintained automatically from data supplied by users, and the
34431 addresses are not rigorously checked.
34432
34433 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34434 entries that fail to parse, noting the incident in the log. If in addition
34435 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34436 whenever a broken address is skipped. It is usually appropriate to set
34437 &%syntax_errors_to%& to the same address as &%errors_to%&.
34438
34439
34440
34441 .section "Re-expansion of mailing lists" "SECID242"
34442 .cindex "mailing lists" "re-expansion of"
34443 Exim remembers every individual address to which a message has been delivered,
34444 in order to avoid duplication, but it normally stores only the original
34445 recipient addresses with a message. If all the deliveries to a mailing list
34446 cannot be done at the first attempt, the mailing list is re-expanded when the
34447 delivery is next tried. This means that alterations to the list are taken into
34448 account at each delivery attempt, so addresses that have been added to
34449 the list since the message arrived will therefore receive a copy of the
34450 message, even though it pre-dates their subscription.
34451
34452 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34453 on the &(redirect)& router. If this is done, any addresses generated by the
34454 router that fail to deliver at the first attempt are added to the message as
34455 &"top level"& addresses, and the parent address that generated them is marked
34456 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34457 subsequent delivery attempts. The disadvantage of this is that if any of the
34458 failing addresses are incorrect, correcting them in the file has no effect on
34459 pre-existing messages.
34460
34461 The original top-level address is remembered with each of the generated
34462 addresses, and is output in any log messages. However, any intermediate parent
34463 addresses are not recorded. This makes a difference to the log only if the
34464 &%all_parents%& selector is set, but for mailing lists there is normally only
34465 one level of expansion anyway.
34466
34467
34468
34469 .section "Closed mailing lists" "SECID243"
34470 .cindex "mailing lists" "closed"
34471 The examples so far have assumed open mailing lists, to which anybody may
34472 send mail. It is also possible to set up closed lists, where mail is accepted
34473 from specified senders only. This is done by making use of the generic
34474 &%senders%& option to restrict the router that handles the list.
34475
34476 The following example uses the same file as a list of recipients and as a list
34477 of permitted senders. It requires three routers:
34478 .code
34479 lists_request:
34480   driver = redirect
34481   domains = lists.example
34482   local_part_suffix = -request
34483   file = /usr/lists/$local_part$local_part_suffix
34484   no_more
34485
34486 lists_post:
34487   driver = redirect
34488   domains = lists.example
34489   senders = ${if exists {/usr/lists/$local_part}\
34490              {lsearch;/usr/lists/$local_part}{*}}
34491   file = /usr/lists/$local_part
34492   forbid_pipe
34493   forbid_file
34494   errors_to = $local_part-request@lists.example
34495   no_more
34496
34497 lists_closed:
34498   driver = redirect
34499   domains = lists.example
34500   allow_fail
34501   data = :fail: $local_part@lists.example is a closed mailing list
34502 .endd
34503 All three routers have the same &%domains%& setting, so for any other domains,
34504 they are all skipped. The first router runs only if the local part ends in
34505 &%-request%&. It handles messages to the list manager(s) by means of an open
34506 mailing list.
34507
34508 The second router runs only if the &%senders%& precondition is satisfied. It
34509 checks for the existence of a list that corresponds to the local part, and then
34510 checks that the sender is on the list by means of a linear search. It is
34511 necessary to check for the existence of the file before trying to search it,
34512 because otherwise Exim thinks there is a configuration error. If the file does
34513 not exist, the expansion of &%senders%& is *, which matches all senders. This
34514 means that the router runs, but because there is no list, declines, and
34515 &%no_more%& ensures that no further routers are run. The address fails with an
34516 &"unrouteable address"& error.
34517
34518 The third router runs only if the second router is skipped, which happens when
34519 a mailing list exists, but the sender is not on it. This router forcibly fails
34520 the address, giving a suitable error message.
34521
34522
34523
34524
34525 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34526 .cindex "VERP"
34527 .cindex "Variable Envelope Return Paths"
34528 .cindex "envelope sender"
34529 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34530 are a way of helping mailing list administrators discover which subscription
34531 address is the cause of a particular delivery failure. The idea is to encode
34532 the original recipient address in the outgoing envelope sender address, so that
34533 if the message is forwarded by another host and then subsequently bounces, the
34534 original recipient can be extracted from the recipient address of the bounce.
34535
34536 .oindex &%errors_to%&
34537 .oindex &%return_path%&
34538 Envelope sender addresses can be modified by Exim using two different
34539 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34540 list examples), or the &%return_path%& option on a transport. The second of
34541 these is effective only if the message is successfully delivered to another
34542 host; it is not used for errors detected on the local host (see the description
34543 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34544 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34545 .code
34546 verp_smtp:
34547   driver = smtp
34548   max_rcpt = 1
34549   return_path = \
34550     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34551       {$1-request+$local_part=$domain@your.dom.example}fail}
34552 .endd
34553 This has the effect of rewriting the return path (envelope sender) on outgoing
34554 SMTP messages, if the local part of the original return path ends in
34555 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34556 local part and domain of the recipient into the return path. Suppose, for
34557 example, that a message whose return path has been set to
34558 &'somelist-request@your.dom.example'& is sent to
34559 &'subscriber@other.dom.example'&. In the transport, the return path is
34560 rewritten as
34561 .code
34562 somelist-request+subscriber=other.dom.example@your.dom.example
34563 .endd
34564 .vindex "&$local_part$&"
34565 For this to work, you must tell Exim to send multiple copies of messages that
34566 have more than one recipient, so that each copy has just one recipient. This is
34567 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34568 might be sent to several different recipients in the same domain, in which case
34569 &$local_part$& is not available in the transport, because it is not unique.
34570
34571 Unless your host is doing nothing but mailing list deliveries, you should
34572 probably use a separate transport for the VERP deliveries, so as not to use
34573 extra resources in making one-per-recipient copies for other deliveries. This
34574 can easily be done by expanding the &%transport%& option in the router:
34575 .code
34576 dnslookup:
34577   driver = dnslookup
34578   domains = ! +local_domains
34579   transport = \
34580     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34581       {verp_smtp}{remote_smtp}}
34582   no_more
34583 .endd
34584 If you want to change the return path using &%errors_to%& in a router instead
34585 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34586 routers that handle mailing list addresses. This will ensure that all delivery
34587 errors, including those detected on the local host, are sent to the VERP
34588 address.
34589
34590 On a host that does no local deliveries and has no manual routing, only the
34591 &(dnslookup)& router needs to be changed. A special transport is not needed for
34592 SMTP deliveries. Every mailing list recipient has its own return path value,
34593 and so Exim must hand them to the transport one at a time. Here is an example
34594 of a &(dnslookup)& router that implements VERP:
34595 .code
34596 verp_dnslookup:
34597   driver = dnslookup
34598   domains = ! +local_domains
34599   transport = remote_smtp
34600   errors_to = \
34601     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34602      {$1-request+$local_part=$domain@your.dom.example}fail}
34603   no_more
34604 .endd
34605 Before you start sending out messages with VERPed return paths, you must also
34606 configure Exim to accept the bounce messages that come back to those paths.
34607 Typically this is done by setting a &%local_part_suffix%& option for a
34608 router, and using this to route the messages to wherever you want to handle
34609 them.
34610
34611 The overhead incurred in using VERP depends very much on the size of the
34612 message, the number of recipient addresses that resolve to the same remote
34613 host, and the speed of the connection over which the message is being sent. If
34614 a lot of addresses resolve to the same host and the connection is slow, sending
34615 a separate copy of the message for each address may take substantially longer
34616 than sending a single copy with many recipients (for which VERP cannot be
34617 used).
34618
34619
34620
34621
34622
34623
34624 .section "Virtual domains" "SECTvirtualdomains"
34625 .cindex "virtual domains"
34626 .cindex "domain" "virtual"
34627 The phrase &'virtual domain'& is unfortunately used with two rather different
34628 meanings:
34629
34630 .ilist
34631 A domain for which there are no real mailboxes; all valid local parts are
34632 aliases for other email addresses. Common examples are organizational
34633 top-level domains and &"vanity"& domains.
34634 .next
34635 One of a number of independent domains that are all handled by the same host,
34636 with mailboxes on that host, but where the mailbox owners do not necessarily
34637 have login accounts on that host.
34638 .endlist
34639
34640 The first usage is probably more common, and does seem more &"virtual"& than
34641 the second. This kind of domain can be handled in Exim with a straightforward
34642 aliasing router. One approach is to create a separate alias file for each
34643 virtual domain. Exim can test for the existence of the alias file to determine
34644 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34645 to a router of this form:
34646 .code
34647 virtual:
34648   driver = redirect
34649   domains = dsearch;/etc/mail/virtual
34650   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34651   no_more
34652 .endd
34653 The &%domains%& option specifies that the router is to be skipped, unless there
34654 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34655 domain that is being processed. When the router runs, it looks up the local
34656 part in the file to find a new address (or list of addresses). The &%no_more%&
34657 setting ensures that if the lookup fails (leading to &%data%& being an empty
34658 string), Exim gives up on the address without trying any subsequent routers.
34659
34660 This one router can handle all the virtual domains because the alias file names
34661 follow a fixed pattern. Permissions can be arranged so that appropriate people
34662 can edit the different alias files. A successful aliasing operation results in
34663 a new envelope recipient address, which is then routed from scratch.
34664
34665 The other kind of &"virtual"& domain can also be handled in a straightforward
34666 way. One approach is to create a file for each domain containing a list of
34667 valid local parts, and use it in a router like this:
34668 .code
34669 my_domains:
34670   driver = accept
34671   domains = dsearch;/etc/mail/domains
34672   local_parts = lsearch;/etc/mail/domains/$domain
34673   transport = my_mailboxes
34674 .endd
34675 The address is accepted if there is a file for the domain, and the local part
34676 can be found in the file. The &%domains%& option is used to check for the
34677 file's existence because &%domains%& is tested before the &%local_parts%&
34678 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34679 because that option is tested after &%local_parts%&. The transport is as
34680 follows:
34681 .code
34682 my_mailboxes:
34683   driver = appendfile
34684   file = /var/mail/$domain/$local_part
34685   user = mail
34686 .endd
34687 This uses a directory of mailboxes for each domain. The &%user%& setting is
34688 required, to specify which uid is to be used for writing to the mailboxes.
34689
34690 The configuration shown here is just one example of how you might support this
34691 requirement. There are many other ways this kind of configuration can be set
34692 up, for example, by using a database instead of separate files to hold all the
34693 information about the domains.
34694
34695
34696
34697 .section "Multiple user mailboxes" "SECTmulbox"
34698 .cindex "multiple mailboxes"
34699 .cindex "mailbox" "multiple"
34700 .cindex "local part" "prefix"
34701 .cindex "local part" "suffix"
34702 Heavy email users often want to operate with multiple mailboxes, into which
34703 incoming mail is automatically sorted. A popular way of handling this is to
34704 allow users to use multiple sender addresses, so that replies can easily be
34705 identified. Users are permitted to add prefixes or suffixes to their local
34706 parts for this purpose. The wildcard facility of the generic router options
34707 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34708 example, consider this router:
34709 .code
34710 userforward:
34711   driver = redirect
34712   check_local_user
34713   file = $home/.forward
34714   local_part_suffix = -*
34715   local_part_suffix_optional
34716   allow_filter
34717 .endd
34718 .vindex "&$local_part_suffix$&"
34719 It runs a user's &_.forward_& file for all local parts of the form
34720 &'username-*'&. Within the filter file the user can distinguish different
34721 cases by testing the variable &$local_part_suffix$&. For example:
34722 .code
34723 if $local_part_suffix contains -special then
34724 save /home/$local_part/Mail/special
34725 endif
34726 .endd
34727 If the filter file does not exist, or does not deal with such addresses, they
34728 fall through to subsequent routers, and, assuming no subsequent use of the
34729 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34730 control over which suffixes are valid.
34731
34732 Alternatively, a suffix can be used to trigger the use of a different
34733 &_.forward_& file &-- which is the way a similar facility is implemented in
34734 another MTA:
34735 .code
34736 userforward:
34737   driver = redirect
34738   check_local_user
34739   file = $home/.forward$local_part_suffix
34740   local_part_suffix = -*
34741   local_part_suffix_optional
34742   allow_filter
34743 .endd
34744 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34745 example, &_.forward-special_& is used. Once again, if the appropriate file
34746 does not exist, or does not deal with the address, it is passed on to
34747 subsequent routers, which could, if required, look for an unqualified
34748 &_.forward_& file to use as a default.
34749
34750
34751
34752 .section "Simplified vacation processing" "SECID244"
34753 .cindex "vacation processing"
34754 The traditional way of running the &'vacation'& program is for a user to set up
34755 a pipe command in a &_.forward_& file
34756 (see section &<<SECTspecitredli>>& for syntax details).
34757 This is prone to error by inexperienced users. There are two features of Exim
34758 that can be used to make this process simpler for users:
34759
34760 .ilist
34761 A local part prefix such as &"vacation-"& can be specified on a router which
34762 can cause the message to be delivered directly to the &'vacation'& program, or
34763 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34764 &_.forward_& file are then much simpler. For example:
34765 .code
34766 spqr, vacation-spqr
34767 .endd
34768 .next
34769 The &%require_files%& generic router option can be used to trigger a
34770 vacation delivery by checking for the existence of a certain file in the
34771 user's home directory. The &%unseen%& generic option should also be used, to
34772 ensure that the original delivery also proceeds. In this case, all the user has
34773 to do is to create a file called, say, &_.vacation_&, containing a vacation
34774 message.
34775 .endlist
34776
34777 Another advantage of both these methods is that they both work even when the
34778 use of arbitrary pipes by users is locked out.
34779
34780
34781
34782 .section "Taking copies of mail" "SECID245"
34783 .cindex "message" "copying every"
34784 Some installations have policies that require archive copies of all messages to
34785 be made. A single copy of each message can easily be taken by an appropriate
34786 command in a system filter, which could, for example, use a different file for
34787 each day's messages.
34788
34789 There is also a shadow transport mechanism that can be used to take copies of
34790 messages that are successfully delivered by local transports, one copy per
34791 delivery. This could be used, &'inter alia'&, to implement automatic
34792 notification of delivery by sites that insist on doing such things.
34793
34794
34795
34796 .section "Intermittently connected hosts" "SECID246"
34797 .cindex "intermittently connected hosts"
34798 It has become quite common (because it is cheaper) for hosts to connect to the
34799 Internet periodically rather than remain connected all the time. The normal
34800 arrangement is that mail for such hosts accumulates on a system that is
34801 permanently connected.
34802
34803 Exim was designed for use on permanently connected hosts, and so it is not
34804 particularly well-suited to use in an intermittently connected environment.
34805 Nevertheless there are some features that can be used.
34806
34807
34808 .section "Exim on the upstream server host" "SECID247"
34809 It is tempting to arrange for incoming mail for the intermittently connected
34810 host to remain on Exim's queue until the client connects. However, this
34811 approach does not scale very well. Two different kinds of waiting message are
34812 being mixed up in the same queue &-- those that cannot be delivered because of
34813 some temporary problem, and those that are waiting for their destination host
34814 to connect. This makes it hard to manage the queue, as well as wasting
34815 resources, because each queue runner scans the entire queue.
34816
34817 A better approach is to separate off those messages that are waiting for an
34818 intermittently connected host. This can be done by delivering these messages
34819 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34820 format, from where they are transmitted by other software when their
34821 destination connects. This makes it easy to collect all the mail for one host
34822 in a single directory, and to apply local timeout rules on a per-message basis
34823 if required.
34824
34825 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34826 you are doing this, you should configure Exim with a long retry period for the
34827 intermittent host. For example:
34828 .code
34829 cheshire.wonderland.fict.example    *   F,5d,24h
34830 .endd
34831 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34832 which messages it has queued up for that host. Once the intermittent host comes
34833 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34834 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34835 causes all the queued up messages to be delivered, often down a single SMTP
34836 connection. While the host remains connected, any new messages get delivered
34837 immediately.
34838
34839 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34840 issued with a different IP address each time it connects, Exim's retry
34841 mechanisms on the holding host get confused, because the IP address is normally
34842 used as part of the key string for holding retry information. This can be
34843 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34844 Since this has disadvantages for permanently connected hosts, it is best to
34845 arrange a separate transport for the intermittently connected ones.
34846
34847
34848
34849 .section "Exim on the intermittently connected client host" "SECID248"
34850 The value of &%smtp_accept_queue_per_connection%& should probably be
34851 increased, or even set to zero (that is, disabled) on the intermittently
34852 connected host, so that all incoming messages down a single connection get
34853 delivered immediately.
34854
34855 .cindex "SMTP" "passed connection"
34856 .cindex "SMTP" "multiple deliveries"
34857 .cindex "multiple SMTP deliveries"
34858 Mail waiting to be sent from an intermittently connected host will probably
34859 not have been routed, because without a connection DNS lookups are not
34860 possible. This means that if a normal queue run is done at connection time,
34861 each message is likely to be sent in a separate SMTP session. This can be
34862 avoided by starting the queue run with a command line option beginning with
34863 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34864 first pass, routing is done but no deliveries take place. The second pass is a
34865 normal queue run; since all the messages have been previously routed, those
34866 destined for the same host are likely to get sent as multiple deliveries in a
34867 single SMTP connection.
34868
34869
34870
34871 . ////////////////////////////////////////////////////////////////////////////
34872 . ////////////////////////////////////////////////////////////////////////////
34873
34874 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34875          "Exim as a non-queueing client"
34876 .cindex "client, non-queueing"
34877 .cindex "smart host" "suppressing queueing"
34878 On a personal computer, it is a common requirement for all
34879 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34880 configured to operate that way, for all the popular operating systems.
34881 However, there are some MUAs for Unix-like systems that cannot be so
34882 configured: they submit messages using the command line interface of
34883 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34884 messages this way.
34885
34886 If the personal computer runs continuously, there is no problem, because it can
34887 run a conventional MTA that handles delivery to the smart host, and deal with
34888 any delays via its queueing mechanism. However, if the computer does not run
34889 continuously or runs different operating systems at different times, queueing
34890 email is not desirable.
34891
34892 There is therefore a requirement for something that can provide the
34893 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34894 any queueing or retrying facilities. Furthermore, the delivery to the smart
34895 host should be synchronous, so that if it fails, the sending MUA is immediately
34896 informed. In other words, we want something that extends an MUA that submits
34897 to a local MTA via the command line so that it behaves like one that submits
34898 to a remote smart host using TCP/SMTP.
34899
34900 There are a number of applications (for example, there is one called &'ssmtp'&)
34901 that do this job. However, people have found them to be lacking in various
34902 ways. For instance, you might want to allow aliasing and forwarding to be done
34903 before sending a message to the smart host.
34904
34905 Exim already had the necessary infrastructure for doing this job. Just a few
34906 tweaks were needed to make it behave as required, though it is somewhat of an
34907 overkill to use a fully-featured MTA for this purpose.
34908
34909 .oindex "&%mua_wrapper%&"
34910 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34911 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34912 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34913 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34914 compatible router and transport configuration. Typically there will be just one
34915 router and one transport, sending everything to a smart host.
34916
34917 When run in MUA wrapping mode, the behaviour of Exim changes in the
34918 following ways:
34919
34920 .ilist
34921 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34922 In other words, the only way to submit messages is via the command line.
34923 .next
34924 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34925 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34926 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34927 does not finish until the delivery attempt is complete. If the delivery is
34928 successful, a zero return code is given.
34929 .next
34930 Address redirection is permitted, but the final routing for all addresses must
34931 be to the same remote transport, and to the same list of hosts. Furthermore,
34932 the return address (envelope sender) must be the same for all recipients, as
34933 must any added or deleted header lines. In other words, it must be possible to
34934 deliver the message in a single SMTP transaction, however many recipients there
34935 are.
34936 .next
34937 If these conditions are not met, or if routing any address results in a
34938 failure or defer status, or if Exim is unable to deliver all the recipients
34939 successfully to one of the smart hosts, delivery of the entire message fails.
34940 .next
34941 Because no queueing is allowed, all failures are treated as permanent; there
34942 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34943 smart host. Furthermore, because only a single yes/no response can be given to
34944 the caller, it is not possible to deliver to some recipients and not others. If
34945 there is an error (temporary or permanent) for any recipient, all are failed.
34946 .next
34947 If more than one smart host is listed, Exim will try another host after a
34948 connection failure or a timeout, in the normal way. However, if this kind of
34949 failure happens for all the hosts, the delivery fails.
34950 .next
34951 When delivery fails, an error message is written to the standard error stream
34952 (as well as to Exim's log), and Exim exits to the caller with a return code
34953 value 1. The message is expunged from Exim's spool files. No bounce messages
34954 are ever generated.
34955 .next
34956 No retry data is maintained, and any retry rules are ignored.
34957 .next
34958 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34959 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34960 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34961 .endlist
34962
34963 The overall effect is that Exim makes a single synchronous attempt to deliver
34964 the message, failing if there is any kind of problem. Because no local
34965 deliveries are done and no daemon can be run, Exim does not need root
34966 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34967 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34968 the advantages and disadvantages of running without root privilege.
34969
34970
34971
34972
34973 . ////////////////////////////////////////////////////////////////////////////
34974 . ////////////////////////////////////////////////////////////////////////////
34975
34976 .chapter "Log files" "CHAPlog"
34977 .scindex IIDloggen "log" "general description"
34978 .cindex "log" "types of"
34979 Exim writes three different logs, referred to as the main log, the reject log,
34980 and the panic log:
34981
34982 .ilist
34983 .cindex "main log"
34984 The main log records the arrival of each message and each delivery in a single
34985 line in each case. The format is as compact as possible, in an attempt to keep
34986 down the size of log files. Two-character flag sequences make it easy to pick
34987 out these lines. A number of other events are recorded in the main log. Some of
34988 them are optional, in which case the &%log_selector%& option controls whether
34989 they are included or not. A Perl script called &'eximstats'&, which does simple
34990 analysis of main log files, is provided in the Exim distribution (see section
34991 &<<SECTmailstat>>&).
34992 .next
34993 .cindex "reject log"
34994 The reject log records information from messages that are rejected as a result
34995 of a configuration option (that is, for policy reasons).
34996 The first line of each rejection is a copy of the line that is also written to
34997 the main log. Then, if the message's header has been read at the time the log
34998 is written, its contents are written to this log. Only the original header
34999 lines are available; header lines added by ACLs are not logged. You can use the
35000 reject log to check that your policy controls are working correctly; on a busy
35001 host this may be easier than scanning the main log for rejection messages. You
35002 can suppress the writing of the reject log by setting &%write_rejectlog%&
35003 false.
35004 .next
35005 .cindex "panic log"
35006 .cindex "system log"
35007 When certain serious errors occur, Exim writes entries to its panic log. If the
35008 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35009 are usually written to the main log as well, but can get lost amid the mass of
35010 other entries. The panic log should be empty under normal circumstances. It is
35011 therefore a good idea to check it (or to have a &'cron'& script check it)
35012 regularly, in order to become aware of any problems. When Exim cannot open its
35013 panic log, it tries as a last resort to write to the system log (syslog). This
35014 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35015 message itself is written at priority LOG_CRIT.
35016 .endlist
35017
35018 Every log line starts with a timestamp, in the format shown in the following
35019 example. Note that many of the examples shown in this chapter are line-wrapped.
35020 In the log file, this would be all on one line:
35021 .code
35022 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35023   by QUIT
35024 .endd
35025 By default, the timestamps are in the local timezone. There are two
35026 ways of changing this:
35027
35028 .ilist
35029 You can set the &%timezone%& option to a different time zone; in particular, if
35030 you set
35031 .code
35032 timezone = UTC
35033 .endd
35034 the timestamps will be in UTC (aka GMT).
35035 .next
35036 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35037 example:
35038 .code
35039 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35040 .endd
35041 .endlist
35042
35043 .cindex "log" "process ids in"
35044 .cindex "pid (process id)" "in log lines"
35045 Exim does not include its process id in log lines by default, but you can
35046 request that it does so by specifying the &`pid`& log selector (see section
35047 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35048 brackets, immediately after the time and date.
35049
35050
35051
35052
35053 .section "Where the logs are written" "SECTwhelogwri"
35054 .cindex "log" "destination"
35055 .cindex "log" "to file"
35056 .cindex "log" "to syslog"
35057 .cindex "syslog"
35058 The logs may be written to local files, or to syslog, or both. However, it
35059 should be noted that many syslog implementations use UDP as a transport, and
35060 are therefore unreliable in the sense that messages are not guaranteed to
35061 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35062 It has also been reported that on large log files (tens of megabytes) you may
35063 need to tweak syslog to prevent it syncing the file with each write &-- on
35064 Linux this has been seen to make syslog take 90% plus of CPU time.
35065
35066 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35067 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35068 configuration. This latter string is expanded, so it can contain, for example,
35069 references to the host name:
35070 .code
35071 log_file_path = /var/log/$primary_hostname/exim_%slog
35072 .endd
35073 It is generally advisable, however, to set the string in &_Local/Makefile_&
35074 rather than at run time, because then the setting is available right from the
35075 start of Exim's execution. Otherwise, if there's something it wants to log
35076 before it has read the configuration file (for example, an error in the
35077 configuration file) it will not use the path you want, and may not be able to
35078 log at all.
35079
35080 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35081 list, currently limited to at most two items. This is one option where the
35082 facility for changing a list separator may not be used. The list must always be
35083 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35084 otherwise the item must either be an absolute path, containing &`%s`& at the
35085 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35086 implying the use of a default path.
35087
35088 When Exim encounters an empty item in the list, it searches the list defined by
35089 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35090 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35091 mean &"use the path specified at build time"&. It no such item exists, log
35092 files are written in the &_log_& subdirectory of the spool directory. This is
35093 equivalent to the setting:
35094 .code
35095 log_file_path = $spool_directory/log/%slog
35096 .endd
35097 If you do not specify anything at build time or run time,
35098 or if you unset the option at run time (i.e. &`log_file_path = `&),
35099 that is where the logs are written.
35100
35101 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35102 are in use &-- see section &<<SECTdatlogfil>>& below.
35103
35104 Here are some examples of possible settings:
35105 .display
35106 &`LOG_FILE_PATH=syslog                    `& syslog only
35107 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35108 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35109 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35110 .endd
35111 If there are more than two paths in the list, the first is used and a panic
35112 error is logged.
35113
35114
35115
35116 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35117 .cindex "log" "cycling local files"
35118 .cindex "cycling logs"
35119 .cindex "&'exicyclog'&"
35120 .cindex "log" "local files; writing to"
35121 Some operating systems provide centralized and standardized methods for cycling
35122 log files. For those that do not, a utility script called &'exicyclog'& is
35123 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35124 main and reject logs each time it is called. The maximum number of old logs to
35125 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35126
35127 An Exim delivery process opens the main log when it first needs to write to it,
35128 and it keeps the file open in case subsequent entries are required &-- for
35129 example, if a number of different deliveries are being done for the same
35130 message. However, remote SMTP deliveries can take a long time, and this means
35131 that the file may be kept open long after it is renamed if &'exicyclog'& or
35132 something similar is being used to rename log files on a regular basis. To
35133 ensure that a switch of log files is noticed as soon as possible, Exim calls
35134 &[stat()]& on the main log's name before reusing an open file, and if the file
35135 does not exist, or its inode has changed, the old file is closed and Exim
35136 tries to open the main log from scratch. Thus, an old log file may remain open
35137 for quite some time, but no Exim processes should write to it once it has been
35138 renamed.
35139
35140
35141
35142 .section "Datestamped log files" "SECTdatlogfil"
35143 .cindex "log" "datestamped files"
35144 Instead of cycling the main and reject log files by renaming them
35145 periodically, some sites like to use files whose names contain a datestamp,
35146 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35147 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35148 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35149 point where the datestamp is required. For example:
35150 .code
35151 log_file_path = /var/spool/exim/log/%slog-%D
35152 log_file_path = /var/log/exim-%s-%D.log
35153 log_file_path = /var/spool/exim/log/%D-%slog
35154 log_file_path = /var/log/exim/%s.%M
35155 .endd
35156 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35157 examples of names generated by the above examples:
35158 .code
35159 /var/spool/exim/log/mainlog-20021225
35160 /var/log/exim-reject-20021225.log
35161 /var/spool/exim/log/20021225-mainlog
35162 /var/log/exim/main.200212
35163 .endd
35164 When this form of log file is specified, Exim automatically switches to new
35165 files at midnight. It does not make any attempt to compress old logs; you
35166 will need to write your own script if you require this. You should not
35167 run &'exicyclog'& with this form of logging.
35168
35169 The location of the panic log is also determined by &%log_file_path%&, but it
35170 is not datestamped, because rotation of the panic log does not make sense.
35171 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35172 the string. In addition, if it immediately follows a slash, a following
35173 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35174 character is removed. Thus, the four examples above would give these panic
35175 log names:
35176 .code
35177 /var/spool/exim/log/paniclog
35178 /var/log/exim-panic.log
35179 /var/spool/exim/log/paniclog
35180 /var/log/exim/panic
35181 .endd
35182
35183
35184 .section "Logging to syslog" "SECID249"
35185 .cindex "log" "syslog; writing to"
35186 The use of syslog does not change what Exim logs or the format of its messages,
35187 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35188 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35189 that, the same strings are written to syslog as to log files. The syslog
35190 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35191 by default, but you can change these by setting the &%syslog_facility%& and
35192 &%syslog_processname%& options, respectively. If Exim was compiled with
35193 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35194 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35195 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35196 the time and host name to each line.
35197 The three log streams are mapped onto syslog priorities as follows:
35198
35199 .ilist
35200 &'mainlog'& is mapped to LOG_INFO
35201 .next
35202 &'rejectlog'& is mapped to LOG_NOTICE
35203 .next
35204 &'paniclog'& is mapped to LOG_ALERT
35205 .endlist
35206
35207 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35208 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35209 these are routed by syslog to the same place. You can suppress this duplication
35210 by setting &%syslog_duplication%& false.
35211
35212 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35213 entries contain multiple lines when headers are included. To cope with both
35214 these cases, entries written to syslog are split into separate &[syslog()]&
35215 calls at each internal newline, and also after a maximum of
35216 870 data characters. (This allows for a total syslog line length of 1024, when
35217 additions such as timestamps are added.) If you are running a syslog
35218 replacement that can handle lines longer than the 1024 characters allowed by
35219 RFC 3164, you should set
35220 .code
35221 SYSLOG_LONG_LINES=yes
35222 .endd
35223 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35224 lines, but it still splits at internal newlines in &'reject'& log entries.
35225
35226 To make it easy to re-assemble split lines later, each component of a split
35227 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35228 where <&'n'&> is the component number and <&'m'&> is the total number of
35229 components in the entry. The / delimiter is used when the line was split
35230 because it was too long; if it was split because of an internal newline, the \
35231 delimiter is used. For example, supposing the length limit to be 50 instead of
35232 870, the following would be the result of a typical rejection message to
35233 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35234 name, and pid as added by syslog:
35235 .code
35236 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35237 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35238 [3/5]  when scanning for sender: missing or malformed lo
35239 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35240 [5/5] mple>)
35241 .endd
35242 The same error might cause the following lines to be written to &"rejectlog"&
35243 (LOG_NOTICE):
35244 .code
35245 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35246 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35247 [3/18] er when scanning for sender: missing or malformed
35248 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35249 [5\18] .example>)
35250 [6\18] Recipients: ph10@some.domain.cam.example
35251 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35252 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35253 [9\18]        id 16RdAL-0006pc-00
35254 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35255 [11\18] 09:43 +0100
35256 [12\18] F From: <>
35257 [13\18]   Subject: this is a test header
35258 [18\18]   X-something: this is another header
35259 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35260 [16\18] le>
35261 [17\18] B Bcc:
35262 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35263 .endd
35264 Log lines that are neither too long nor contain newlines are written to syslog
35265 without modification.
35266
35267 If only syslog is being used, the Exim monitor is unable to provide a log tail
35268 display, unless syslog is routing &'mainlog'& to a file on the local host and
35269 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35270 where it is.
35271
35272
35273
35274 .section "Log line flags" "SECID250"
35275 One line is written to the main log for each message received, and for each
35276 successful, unsuccessful, and delayed delivery. These lines can readily be
35277 picked out by the distinctive two-character flags that immediately follow the
35278 timestamp. The flags are:
35279 .display
35280 &`<=`&     message arrival
35281 &`=>`&     normal message delivery
35282 &`->`&     additional address in same delivery
35283 &`>>`&     cutthrough message delivery
35284 &`*>`&     delivery suppressed by &%-N%&
35285 &`**`&     delivery failed; address bounced
35286 &`==`&     delivery deferred; temporary problem
35287 .endd
35288
35289
35290 .section "Logging message reception" "SECID251"
35291 .cindex "log" "reception line"
35292 The format of the single-line entry in the main log that is written for every
35293 message received is shown in the basic example below, which is split over
35294 several lines in order to fit it on the page:
35295 .code
35296 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35297   H=mailer.fict.example [192.168.123.123] U=exim
35298   P=smtp S=5678 id=<incoming message id>
35299 .endd
35300 The address immediately following &"<="& is the envelope sender address. A
35301 bounce message is shown with the sender address &"<>"&, and if it is locally
35302 generated, this is followed by an item of the form
35303 .code
35304 R=<message id>
35305 .endd
35306 which is a reference to the message that caused the bounce to be sent.
35307
35308 .cindex "HELO"
35309 .cindex "EHLO"
35310 For messages from other hosts, the H and U fields identify the remote host and
35311 record the RFC 1413 identity of the user that sent the message, if one was
35312 received. The number given in square brackets is the IP address of the sending
35313 host. If there is a single, unparenthesized  host name in the H field, as
35314 above, it has been verified to correspond to the IP address (see the
35315 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35316 by the remote host in the SMTP HELO or EHLO command, and has not been
35317 verified. If verification yields a different name to that given for HELO or
35318 EHLO, the verified name appears first, followed by the HELO or EHLO
35319 name in parentheses.
35320
35321 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35322 without brackets, in the HELO or EHLO command, leading to entries in
35323 the log containing text like these examples:
35324 .code
35325 H=(10.21.32.43) [192.168.8.34]
35326 H=([10.21.32.43]) [192.168.8.34]
35327 .endd
35328 This can be confusing. Only the final address in square brackets can be relied
35329 on.
35330
35331 For locally generated messages (that is, messages not received over TCP/IP),
35332 the H field is omitted, and the U field contains the login name of the caller
35333 of Exim.
35334
35335 .cindex "authentication" "logging"
35336 .cindex "AUTH" "logging"
35337 For all messages, the P field specifies the protocol used to receive the
35338 message. This is the value that is stored in &$received_protocol$&. In the case
35339 of incoming SMTP messages, the value indicates whether or not any SMTP
35340 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35341 session was encrypted, there is an additional X field that records the cipher
35342 suite that was used.
35343
35344 .cindex log protocol
35345 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35346 hosts that have authenticated themselves using the SMTP AUTH command. The first
35347 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35348 there is an additional item A= followed by the name of the authenticator that
35349 was used. If an authenticated identification was set up by the authenticator's
35350 &%server_set_id%& option, this is logged too, separated by a colon from the
35351 authenticator name.
35352
35353 .cindex "size" "of message"
35354 The id field records the existing message id, if present. The size of the
35355 received message is given by the S field. When the message is delivered,
35356 headers may be removed or added, so that the size of delivered copies of the
35357 message may not correspond with this value (and indeed may be different to each
35358 other).
35359
35360 The &%log_selector%& option can be used to request the logging of additional
35361 data when a message is received. See section &<<SECTlogselector>>& below.
35362
35363
35364
35365 .section "Logging deliveries" "SECID252"
35366 .cindex "log" "delivery line"
35367 The format of the single-line entry in the main log that is written for every
35368 delivery is shown in one of the examples below, for local and remote
35369 deliveries, respectively. Each example has been split into multiple lines in order
35370 to fit it on the page:
35371 .code
35372 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35373   <marv@hitch.fict.example> R=localuser T=local_delivery
35374 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35375   monk@holistic.fict.example R=dnslookup T=remote_smtp
35376   H=holistic.fict.example [192.168.234.234]
35377 .endd
35378 For ordinary local deliveries, the original address is given in angle brackets
35379 after the final delivery address, which might be a pipe or a file. If
35380 intermediate address(es) exist between the original and the final address, the
35381 last of these is given in parentheses after the final address. The R and T
35382 fields record the router and transport that were used to process the address.
35383
35384 If SMTP AUTH was used for the delivery there is an additional item A=
35385 followed by the name of the authenticator that was used.
35386 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35387 option, this is logged too, separated by a colon from the authenticator name.
35388
35389 If a shadow transport was run after a successful local delivery, the log line
35390 for the successful delivery has an item added on the end, of the form
35391 .display
35392 &`ST=<`&&'shadow transport name'&&`>`&
35393 .endd
35394 If the shadow transport did not succeed, the error message is put in
35395 parentheses afterwards.
35396
35397 .cindex "asterisk" "after IP address"
35398 When more than one address is included in a single delivery (for example, two
35399 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35400 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35401 down a single SMTP connection, an asterisk follows the IP address in the log
35402 lines for the second and subsequent messages.
35403
35404 .cindex "delivery" "cutthrough; logging"
35405 .cindex "cutthrough" "logging"
35406 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35407 line precedes the reception line, since cutthrough waits for a possible
35408 rejection from the destination in case it can reject the sourced item.
35409
35410 The generation of a reply message by a filter file gets logged as a
35411 &"delivery"& to the addressee, preceded by &">"&.
35412
35413 The &%log_selector%& option can be used to request the logging of additional
35414 data when a message is delivered. See section &<<SECTlogselector>>& below.
35415
35416
35417 .section "Discarded deliveries" "SECID253"
35418 .cindex "discarded messages"
35419 .cindex "message" "discarded"
35420 .cindex "delivery" "discarded; logging"
35421 When a message is discarded as a result of the command &"seen finish"& being
35422 obeyed in a filter file which generates no deliveries, a log entry of the form
35423 .code
35424 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35425   <low.club@bridge.example> R=userforward
35426 .endd
35427 is written, to record why no deliveries are logged. When a message is discarded
35428 because it is aliased to &":blackhole:"& the log line is like this:
35429 .code
35430 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35431   <hole@nowhere.example> R=blackhole_router
35432 .endd
35433
35434
35435 .section "Deferred deliveries" "SECID254"
35436 When a delivery is deferred, a line of the following form is logged:
35437 .code
35438 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35439   R=dnslookup T=smtp defer (146): Connection refused
35440 .endd
35441 In the case of remote deliveries, the error is the one that was given for the
35442 last IP address that was tried. Details of individual SMTP failures are also
35443 written to the log, so the above line would be preceded by something like
35444 .code
35445 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35446   mail1.endrest.example [192.168.239.239]: Connection refused
35447 .endd
35448 When a deferred address is skipped because its retry time has not been reached,
35449 a message is written to the log, but this can be suppressed by setting an
35450 appropriate value in &%log_selector%&.
35451
35452
35453
35454 .section "Delivery failures" "SECID255"
35455 .cindex "delivery" "failure; logging"
35456 If a delivery fails because an address cannot be routed, a line of the
35457 following form is logged:
35458 .code
35459 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35460   <jim@trek99.example>: unknown mail domain
35461 .endd
35462 If a delivery fails at transport time, the router and transport are shown, and
35463 the response from the remote host is included, as in this example:
35464 .code
35465 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35466   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35467   after pipelined RCPT TO:<ace400@pb.example>: host
35468   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35469   <ace400@pb.example>...Addressee unknown
35470 .endd
35471 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35472 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35473 disabling PIPELINING. The log lines for all forms of delivery failure are
35474 flagged with &`**`&.
35475
35476
35477
35478 .section "Fake deliveries" "SECID256"
35479 .cindex "delivery" "fake; logging"
35480 If a delivery does not actually take place because the &%-N%& option has been
35481 used to suppress it, a normal delivery line is written to the log, except that
35482 &"=>"& is replaced by &"*>"&.
35483
35484
35485
35486 .section "Completion" "SECID257"
35487 A line of the form
35488 .code
35489 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35490 .endd
35491 is written to the main log when a message is about to be removed from the spool
35492 at the end of its processing.
35493
35494
35495
35496
35497 .section "Summary of Fields in Log Lines" "SECID258"
35498 .cindex "log" "summary of fields"
35499 A summary of the field identifiers that are used in log lines is shown in
35500 the following table:
35501 .display
35502 &`A   `&        authenticator name (and optional id and sender)
35503 &`C   `&        SMTP confirmation on delivery
35504 &`    `&        command list for &"no mail in SMTP session"&
35505 &`CV  `&        certificate verification status
35506 &`D   `&        duration of &"no mail in SMTP session"&
35507 &`DN  `&        distinguished name from peer certificate
35508 &`DT  `&        on &`=>`& lines: time taken for a delivery
35509 &`F   `&        sender address (on delivery lines)
35510 &`H   `&        host name and IP address
35511 &`I   `&        local interface used
35512 &`id  `&        message id for incoming message
35513 &`P   `&        on &`<=`& lines: protocol used
35514 &`    `&        on &`=>`& and &`**`& lines: return path
35515 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35516 &`QT  `&        on &`=>`& lines: time spent on queue so far
35517 &`    `&        on &"Completed"& lines: time spent on queue
35518 &`R   `&        on &`<=`& lines: reference for local bounce
35519 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35520 &`S   `&        size of message in bytes
35521 &`SNI `&        server name indication from TLS client hello
35522 &`ST  `&        shadow transport name
35523 &`T   `&        on &`<=`& lines: message subject (topic)
35524 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35525 &`U   `&        local user or RFC 1413 identity
35526 &`X   `&        TLS cipher suite
35527 .endd
35528
35529
35530 .section "Other log entries" "SECID259"
35531 Various other types of log entry are written from time to time. Most should be
35532 self-explanatory. Among the more common are:
35533
35534 .ilist
35535 .cindex "retry" "time not reached"
35536 &'retry time not reached'&&~&~An address previously suffered a temporary error
35537 during routing or local delivery, and the time to retry has not yet arrived.
35538 This message is not written to an individual message log file unless it happens
35539 during the first delivery attempt.
35540 .next
35541 &'retry time not reached for any host'&&~&~An address previously suffered
35542 temporary errors during remote delivery, and the retry time has not yet arrived
35543 for any of the hosts to which it is routed.
35544 .next
35545 .cindex "spool directory" "file locked"
35546 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35547 some other Exim process is already working on the message. This can be quite
35548 common if queue running processes are started at frequent intervals. The
35549 &'exiwhat'& utility script can be used to find out what Exim processes are
35550 doing.
35551 .next
35552 .cindex "error" "ignored"
35553 &'error ignored'&&~&~There are several circumstances that give rise to this
35554 message:
35555 .olist
35556 Exim failed to deliver a bounce message whose age was greater than
35557 &%ignore_bounce_errors_after%&. The bounce was discarded.
35558 .next
35559 A filter file set up a delivery using the &"noerror"& option, and the delivery
35560 failed. The delivery was discarded.
35561 .next
35562 A delivery set up by a router configured with
35563 . ==== As this is a nested list, any displays it contains must be indented
35564 . ==== as otherwise they are too far to the left.
35565 .code
35566     errors_to = <>
35567 .endd
35568 failed. The delivery was discarded.
35569 .endlist olist
35570 .endlist ilist
35571
35572
35573
35574
35575
35576 .section "Reducing or increasing what is logged" "SECTlogselector"
35577 .cindex "log" "selectors"
35578 By setting the &%log_selector%& global option, you can disable some of Exim's
35579 default logging, or you can request additional logging. The value of
35580 &%log_selector%& is made up of names preceded by plus or minus characters. For
35581 example:
35582 .code
35583 log_selector = +arguments -retry_defer
35584 .endd
35585 The list of optional log items is in the following table, with the default
35586 selection marked by asterisks:
35587 .display
35588 &` 8bitmime                   `&  received 8BITMIME status
35589 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35590 &` address_rewrite            `&  address rewriting
35591 &` all_parents                `&  all parents in => lines
35592 &` arguments                  `&  command line arguments
35593 &`*connection_reject          `&  connection rejections
35594 &`*delay_delivery             `&  immediate delivery delayed
35595 &` deliver_time               `&  time taken to perform delivery
35596 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35597 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35598 &`*etrn                       `&  ETRN commands
35599 &`*host_lookup_failed         `&  as it says
35600 &` ident_timeout              `&  timeout for ident connection
35601 &` incoming_interface         `&  local interface on <= and => lines
35602 &` incoming_port              `&  remote port on <= lines
35603 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35604 &` outgoing_interface         `&  local interface on => lines
35605 &` outgoing_port              `&  add remote port to => lines
35606 &`*queue_run                  `&  start and end queue runs
35607 &` queue_time                 `&  time on queue for one recipient
35608 &` queue_time_overall         `&  time on queue for whole message
35609 &` pid                        `&  Exim process id
35610 &` proxy                      `&  proxy address on <= and => lines
35611 &` received_recipients        `&  recipients on <= lines
35612 &` received_sender            `&  sender on <= lines
35613 &`*rejected_header            `&  header contents on reject log
35614 &`*retry_defer                `&  &"retry time not reached"&
35615 &` return_path_on_delivery    `&  put return path on => and ** lines
35616 &` sender_on_delivery         `&  add sender to => lines
35617 &`*sender_verify_fail         `&  sender verification failures
35618 &`*size_reject                `&  rejection because too big
35619 &`*skip_delivery              `&  delivery skipped in a queue run
35620 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35621 &` smtp_connection            `&  incoming SMTP connections
35622 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35623 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35624 &` smtp_no_mail               `&  session with no MAIL commands
35625 &` smtp_protocol_error        `&  SMTP protocol errors
35626 &` smtp_syntax_error          `&  SMTP syntax errors
35627 &` subject                    `&  contents of &'Subject:'& on <= lines
35628 &`*tls_certificate_verified   `&  certificate verification status
35629 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35630 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35631 &` tls_sni                    `&  TLS SNI on <= lines
35632 &` unknown_in_list            `&  DNS lookup failed in list match
35633
35634 &` all                        `&  all of the above
35635 .endd
35636 See also the &%slow_lookup_log%& main configuration option,
35637 section &<<SECID99>>&
35638
35639 More details on each of these items follows:
35640
35641 .ilist
35642 .cindex "8BITMIME"
35643 .cindex "log" "8BITMIME"
35644 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35645 which may help in tracking down interoperability issues with ancient MTAs
35646 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35647 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35648 &`7BIT`& and &`8BITMIME`& respectively.
35649 .next
35650 .cindex "&%warn%& ACL verb" "log when skipping"
35651 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35652 its conditions cannot be evaluated, a log line to this effect is written if
35653 this log selector is set.
35654 .next
35655 .cindex "log" "rewriting"
35656 .cindex "rewriting" "logging"
35657 &%address_rewrite%&: This applies both to global rewrites and per-transport
35658 rewrites, but not to rewrites in filters run as an unprivileged user (because
35659 such users cannot access the log).
35660 .next
35661 .cindex "log" "full parentage"
35662 &%all_parents%&: Normally only the original and final addresses are logged on
35663 delivery lines; with this selector, intermediate parents are given in
35664 parentheses between them.
35665 .next
35666 .cindex "log" "Exim arguments"
35667 .cindex "Exim arguments, logging"
35668 &%arguments%&: This causes Exim to write the arguments with which it was called
35669 to the main log, preceded by the current working directory. This is a debugging
35670 feature, added to make it easier to find out how certain MUAs call
35671 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35672 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35673 that are empty or that contain white space are quoted. Non-printing characters
35674 are shown as escape sequences. This facility cannot log unrecognized arguments,
35675 because the arguments are checked before the configuration file is read. The
35676 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35677 between the caller and Exim.
35678 .next
35679 .cindex "log" "connection rejections"
35680 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35681 connection is rejected, for whatever reason.
35682 .next
35683 .cindex "log" "delayed delivery"
35684 .cindex "delayed delivery, logging"
35685 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35686 started for an incoming message because the load is too high or too many
35687 messages were received on one connection. Logging does not occur if no delivery
35688 process is started because &%queue_only%& is set or &%-odq%& was used.
35689 .next
35690 .cindex "log" "delivery duration"
35691 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35692 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35693 .next
35694 .cindex "log" "message size on delivery"
35695 .cindex "size" "of message"
35696 &%delivery_size%&: For each delivery, the size of message delivered is added to
35697 the &"=>"& line, tagged with S=.
35698 .next
35699 .cindex "log" "dnslist defer"
35700 .cindex "DNS list" "logging defer"
35701 .cindex "black list (DNS)"
35702 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35703 DNS black list suffers a temporary error.
35704 .next
35705 .cindex "log" "ETRN commands"
35706 .cindex "ETRN" "logging"
35707 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35708 is run to determine whether or not it is actually accepted. An invalid ETRN
35709 command, or one received within a message transaction is not logged by this
35710 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35711 .next
35712 .cindex "log" "host lookup failure"
35713 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35714 any addresses, or when a lookup of an IP address fails to find a host name, a
35715 log line is written. This logging does not apply to direct DNS lookups when
35716 routing email addresses, but it does apply to &"byname"& lookups.
35717 .next
35718 .cindex "log" "ident timeout"
35719 .cindex "RFC 1413" "logging timeout"
35720 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35721 client's ident port times out.
35722 .next
35723 .cindex "log" "incoming interface"
35724 .cindex "log" "local interface"
35725 .cindex "log" "local address and port"
35726 .cindex "TCP/IP" "logging local address and port"
35727 .cindex "interface" "logging"
35728 &%incoming_interface%&: The interface on which a message was received is added
35729 to the &"<="& line as an IP address in square brackets, tagged by I= and
35730 followed by a colon and the port number. The local interface and port are also
35731 added to other SMTP log lines, for example &"SMTP connection from"&, to
35732 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35733 The latter can be disabled by turning off the &%outgoing_interface%& option.
35734 .next
35735 .cindex log "incoming proxy address"
35736 .cindex proxy "logging proxy address"
35737 .cindex "TCP/IP" "logging proxy address"
35738 &%proxy%&: The internal (closest to the system running Exim) IP address
35739 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35740 on a proxied connection
35741 or the &"=>"& line for a message delivered on a proxied connection..
35742 See &<<SECTproxyInbound>>& for more information.
35743 .next
35744 .cindex "log" "incoming remote port"
35745 .cindex "port" "logging remote"
35746 .cindex "TCP/IP" "logging incoming remote port"
35747 .vindex "&$sender_fullhost$&"
35748 .vindex "&$sender_rcvhost$&"
35749 &%incoming_port%&: The remote port number from which a message was received is
35750 added to log entries and &'Received:'& header lines, following the IP address
35751 in square brackets, and separated from it by a colon. This is implemented by
35752 changing the value that is put in the &$sender_fullhost$& and
35753 &$sender_rcvhost$& variables. Recording the remote port number has become more
35754 important with the widening use of NAT (see RFC 2505).
35755 .next
35756 .cindex "log" "dropped connection"
35757 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35758 connection is unexpectedly dropped.
35759 .next
35760 .cindex "log" "outgoing interface"
35761 .cindex "log" "local interface"
35762 .cindex "log" "local address and port"
35763 .cindex "TCP/IP" "logging local address and port"
35764 .cindex "interface" "logging"
35765 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35766 interface on which a message was sent is added to delivery lines as an I= tag
35767 followed by IP address in square brackets. You can disable this by turning
35768 off the &%outgoing_interface%& option.
35769 .next
35770 .cindex "log" "outgoing remote port"
35771 .cindex "port" "logging outgoint remote"
35772 .cindex "TCP/IP" "logging ougtoing remote port"
35773 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35774 containing => tags) following the IP address.
35775 The local port is also added if &%incoming_interface%& and
35776 &%outgoing_interface%& are both enabled.
35777 This option is not included in the default setting, because for most ordinary
35778 configurations, the remote port number is always 25 (the SMTP port), and the
35779 local port is a random ephemeral port.
35780 .next
35781 .cindex "log" "process ids in"
35782 .cindex "pid (process id)" "in log lines"
35783 &%pid%&: The current process id is added to every log line, in square brackets,
35784 immediately after the time and date.
35785 .next
35786 .cindex "log" "queue run"
35787 .cindex "queue runner" "logging"
35788 &%queue_run%&: The start and end of every queue run are logged.
35789 .next
35790 .cindex "log" "queue time"
35791 &%queue_time%&: The amount of time the message has been in the queue on the
35792 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35793 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35794 includes reception time as well as the delivery time for the current address.
35795 This means that it may be longer than the difference between the arrival and
35796 delivery log line times, because the arrival log line is not written until the
35797 message has been successfully received.
35798 .next
35799 &%queue_time_overall%&: The amount of time the message has been in the queue on
35800 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35801 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35802 message, so it includes reception time as well as the total delivery time.
35803 .next
35804 .cindex "log" "recipients"
35805 &%received_recipients%&: The recipients of a message are listed in the main log
35806 as soon as the message is received. The list appears at the end of the log line
35807 that is written when a message is received, preceded by the word &"for"&. The
35808 addresses are listed after they have been qualified, but before any rewriting
35809 has taken place.
35810 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35811 in the list.
35812 .next
35813 .cindex "log" "sender reception"
35814 &%received_sender%&: The unrewritten original sender of a message is added to
35815 the end of the log line that records the message's arrival, after the word
35816 &"from"& (before the recipients if &%received_recipients%& is also set).
35817 .next
35818 .cindex "log" "header lines for rejection"
35819 &%rejected_header%&: If a message's header has been received at the time a
35820 rejection is written to the reject log, the complete header is added to the
35821 log. Header logging can be turned off individually for messages that are
35822 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35823 .next
35824 .cindex "log" "retry defer"
35825 &%retry_defer%&: A log line is written if a delivery is deferred because a
35826 retry time has not yet been reached. However, this &"retry time not reached"&
35827 message is always omitted from individual message logs after the first delivery
35828 attempt.
35829 .next
35830 .cindex "log" "return path"
35831 &%return_path_on_delivery%&: The return path that is being transmitted with
35832 the message is included in delivery and bounce lines, using the tag P=.
35833 This is omitted if no delivery actually happens, for example, if routing fails,
35834 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35835 .next
35836 .cindex "log" "sender on delivery"
35837 &%sender_on_delivery%&: The message's sender address is added to every delivery
35838 and bounce line, tagged by F= (for &"from"&).
35839 This is the original sender that was received with the message; it is not
35840 necessarily the same as the outgoing return path.
35841 .next
35842 .cindex "log" "sender verify failure"
35843 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35844 gives details of a sender verification failure is not written. Log lines for
35845 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35846 detail is lost.
35847 .next
35848 .cindex "log" "size rejection"
35849 &%size_reject%&: A log line is written whenever a message is rejected because
35850 it is too big.
35851 .next
35852 .cindex "log" "frozen messages; skipped"
35853 .cindex "frozen messages" "logging skipping"
35854 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35855 queue run because it is frozen or because another process is already delivering
35856 it.
35857 .cindex "&""spool file is locked""&"
35858 The message that is written is &"spool file is locked"&.
35859 .next
35860 .cindex "log" "smtp confirmation"
35861 .cindex "SMTP" "logging confirmation"
35862 .cindex "LMTP" "logging confirmation"
35863 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35864 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35865 A number of MTAs (including Exim) return an identifying string in this
35866 response.
35867 .next
35868 .cindex "log" "SMTP connections"
35869 .cindex "SMTP" "logging connections"
35870 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35871 established or closed, unless the connection is from a host that matches
35872 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35873 only when the closure is unexpected.) This applies to connections from local
35874 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35875 dropped in the middle of a message, a log line is always written, whether or
35876 not this selector is set, but otherwise nothing is written at the start and end
35877 of connections unless this selector is enabled.
35878
35879 For TCP/IP connections to an Exim daemon, the current number of connections is
35880 included in the log message for each new connection, but note that the count is
35881 reset if the daemon is restarted.
35882 Also, because connections are closed (and the closure is logged) in
35883 subprocesses, the count may not include connections that have been closed but
35884 whose termination the daemon has not yet noticed. Thus, while it is possible to
35885 match up the opening and closing of connections in the log, the value of the
35886 logged counts may not be entirely accurate.
35887 .next
35888 .cindex "log" "SMTP transaction; incomplete"
35889 .cindex "SMTP" "logging incomplete transactions"
35890 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35891 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35892 and the message sender plus any accepted recipients are included in the log
35893 line. This can provide evidence of dictionary attacks.
35894 .next
35895 .cindex "log" "non-MAIL SMTP sessions"
35896 .cindex "MAIL" "logging session without"
35897 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35898 connection terminates without having issued a MAIL command. This includes both
35899 the case when the connection is dropped, and the case when QUIT is used. It
35900 does not include cases where the connection is rejected right at the start (by
35901 an ACL, or because there are too many connections, or whatever). These cases
35902 already have their own log lines.
35903
35904 The log line that is written contains the identity of the client in the usual
35905 way, followed by D= and a time, which records the duration of the connection.
35906 If the connection was authenticated, this fact is logged exactly as it is for
35907 an incoming message, with an A= item. If the connection was encrypted, CV=,
35908 DN=, and X= items may appear as they do for an incoming message, controlled by
35909 the same logging options.
35910
35911 Finally, if any SMTP commands were issued during the connection, a C= item
35912 is added to the line, listing the commands that were used. For example,
35913 .code
35914 C=EHLO,QUIT
35915 .endd
35916 shows that the client issued QUIT straight after EHLO. If there were fewer
35917 than 20 commands, they are all listed. If there were more than 20 commands,
35918 the last 20 are listed, preceded by &"..."&. However, with the default
35919 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
35920 have been aborted before 20 non-mail commands are processed.
35921 .next
35922 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35923 colon-separated, is appended to the A= item for a message arrival or delivery
35924 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35925 was accepted or used.
35926 .next
35927 .cindex "log" "SMTP protocol error"
35928 .cindex "SMTP" "logging protocol error"
35929 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35930 encountered. Exim does not have perfect detection of all protocol errors
35931 because of transmission delays and the use of pipelining. If PIPELINING has
35932 been advertised to a client, an Exim server assumes that the client will use
35933 it, and therefore it does not count &"expected"& errors (for example, RCPT
35934 received after rejecting MAIL) as protocol errors.
35935 .next
35936 .cindex "SMTP" "logging syntax errors"
35937 .cindex "SMTP" "syntax errors; logging"
35938 .cindex "SMTP" "unknown command; logging"
35939 .cindex "log" "unknown SMTP command"
35940 .cindex "log" "SMTP syntax error"
35941 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35942 encountered. An unrecognized command is treated as a syntax error. For an
35943 external connection, the host identity is given; for an internal connection
35944 using &%-bs%& the sender identification (normally the calling user) is given.
35945 .next
35946 .cindex "log" "subject"
35947 .cindex "subject, logging"
35948 &%subject%&: The subject of the message is added to the arrival log line,
35949 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35950 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35951 specifies whether characters with values greater than 127 should be logged
35952 unchanged, or whether they should be rendered as escape sequences.
35953 .next
35954 .cindex "log" "certificate verification"
35955 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35956 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35957 verified, and &`CV=no`& if not.
35958 .next
35959 .cindex "log" "TLS cipher"
35960 .cindex "TLS" "logging cipher"
35961 &%tls_cipher%&: When a message is sent or received over an encrypted
35962 connection, the cipher suite used is added to the log line, preceded by X=.
35963 .next
35964 .cindex "log" "TLS peer DN"
35965 .cindex "TLS" "logging peer DN"
35966 &%tls_peerdn%&: When a message is sent or received over an encrypted
35967 connection, and a certificate is supplied by the remote host, the peer DN is
35968 added to the log line, preceded by DN=.
35969 .next
35970 .cindex "log" "TLS SNI"
35971 .cindex "TLS" "logging SNI"
35972 &%tls_sni%&: When a message is received over an encrypted connection, and
35973 the remote host provided the Server Name Indication extension, the SNI is
35974 added to the log line, preceded by SNI=.
35975 .next
35976 .cindex "log" "DNS failure in list"
35977 &%unknown_in_list%&: This setting causes a log entry to be written when the
35978 result of a list match is failure because a DNS lookup failed.
35979 .endlist
35980
35981
35982 .section "Message log" "SECID260"
35983 .cindex "message" "log file for"
35984 .cindex "log" "message log; description of"
35985 .cindex "&_msglog_& directory"
35986 .oindex "&%preserve_message_logs%&"
35987 In addition to the general log files, Exim writes a log file for each message
35988 that it handles. The names of these per-message logs are the message ids, and
35989 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35990 message log contains copies of the log lines that apply to the message. This
35991 makes it easier to inspect the status of an individual message without having
35992 to search the main log. A message log is deleted when processing of the message
35993 is complete, unless &%preserve_message_logs%& is set, but this should be used
35994 only with great care because they can fill up your disk very quickly.
35995
35996 On a heavily loaded system, it may be desirable to disable the use of
35997 per-message logs, in order to reduce disk I/O. This can be done by setting the
35998 &%message_logs%& option false.
35999 .ecindex IIDloggen
36000
36001
36002
36003
36004 . ////////////////////////////////////////////////////////////////////////////
36005 . ////////////////////////////////////////////////////////////////////////////
36006
36007 .chapter "Exim utilities" "CHAPutils"
36008 .scindex IIDutils "utilities"
36009 A number of utility scripts and programs are supplied with Exim and are
36010 described in this chapter. There is also the Exim Monitor, which is covered in
36011 the next chapter. The utilities described here are:
36012
36013 .itable none 0 0 3  7* left  15* left  40* left
36014 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36015   "list what Exim processes are doing"
36016 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36017 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36018 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36019 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36020                                                 various criteria"
36021 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36022 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36023   "extract statistics from the log"
36024 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36025   "check address acceptance from given IP"
36026 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36027 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36028 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36029 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36030 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36031 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36032 .endtable
36033
36034 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36035 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36036 &url(http://duncanthrax.net/exilog/) for details.
36037
36038
36039
36040
36041 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36042 .cindex "&'exiwhat'&"
36043 .cindex "process, querying"
36044 .cindex "SIGUSR1"
36045 On operating systems that can restart a system call after receiving a signal
36046 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36047 a line describing what it is doing to the file &_exim-process.info_& in the
36048 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36049 processes it can find, having first emptied the file. It then waits for one
36050 second to allow the Exim processes to react before displaying the results. In
36051 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36052 send the signal to the Exim processes, so it is normally run as root.
36053
36054 &*Warning*&: This is not an efficient process. It is intended for occasional
36055 use by system administrators. It is not sensible, for example, to set up a
36056 script that sends SIGUSR1 signals to Exim processes at short intervals.
36057
36058
36059 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36060 varies in different operating systems. Not only are different options used,
36061 but the format of the output is different. For this reason, there are some
36062 system configuration options that configure exactly how &'exiwhat'& works. If
36063 it doesn't seem to be working for you, check the following compile-time
36064 options:
36065 .display
36066 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36067 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36068 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36069 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36070 .endd
36071 An example of typical output from &'exiwhat'& is
36072 .code
36073 164 daemon: -q1h, listening on port 25
36074 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36075 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36076   [10.19.42.42] (editor@ref.example)
36077 10592 handling incoming call from [192.168.243.242]
36078 10628 accepting a local non-SMTP message
36079 .endd
36080 The first number in the output line is the process number. The third line has
36081 been split here, in order to fit it on the page.
36082
36083
36084
36085 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36086 .cindex "&'exiqgrep'&"
36087 .cindex "queue" "grepping"
36088 This utility is a Perl script contributed by Matt Hubbard. It runs
36089 .code
36090 exim -bpu
36091 .endd
36092 or (in case &*-a*& switch is specified)
36093 .code
36094 exim -bp
36095 .endd
36096 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36097 contain alternate exim configuration the queue management might be using.
36098
36099 to obtain a queue listing, and then greps the output to select messages
36100 that match given criteria. The following selection options are available:
36101
36102 .vlist
36103 .vitem &*-f*&&~<&'regex'&>
36104 Match the sender address using a case-insensitive search. The field that is
36105 tested is enclosed in angle brackets, so you can test for bounce messages with
36106 .code
36107 exiqgrep -f '^<>$'
36108 .endd
36109 .vitem &*-r*&&~<&'regex'&>
36110 Match a recipient address using a case-insensitive search. The field that is
36111 tested is not enclosed in angle brackets.
36112
36113 .vitem &*-s*&&~<&'regex'&>
36114 Match against the size field.
36115
36116 .vitem &*-y*&&~<&'seconds'&>
36117 Match messages that are younger than the given time.
36118
36119 .vitem &*-o*&&~<&'seconds'&>
36120 Match messages that are older than the given time.
36121
36122 .vitem &*-z*&
36123 Match only frozen messages.
36124
36125 .vitem &*-x*&
36126 Match only non-frozen messages.
36127 .endlist
36128
36129 The following options control the format of the output:
36130
36131 .vlist
36132 .vitem &*-c*&
36133 Display only the count of matching messages.
36134
36135 .vitem &*-l*&
36136 Long format &-- display the full message information as output by Exim. This is
36137 the default.
36138
36139 .vitem &*-i*&
36140 Display message ids only.
36141
36142 .vitem &*-b*&
36143 Brief format &-- one line per message.
36144
36145 .vitem &*-R*&
36146 Display messages in reverse order.
36147
36148 .vitem &*-a*&
36149 Include delivered recipients in queue listing.
36150 .endlist
36151
36152 There is one more option, &%-h%&, which outputs a list of options.
36153
36154
36155
36156 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36157 .cindex "&'exiqsumm'&"
36158 .cindex "queue" "summary"
36159 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36160 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36161 running a command such as
36162 .code
36163 exim -bp | exiqsumm
36164 .endd
36165 The output consists of one line for each domain that has messages waiting for
36166 it, as in the following example:
36167 .code
36168 3   2322   74m   66m  msn.com.example
36169 .endd
36170 Each line lists the number of pending deliveries for a domain, their total
36171 volume, and the length of time that the oldest and the newest messages have
36172 been waiting. Note that the number of pending deliveries is greater than the
36173 number of messages when messages have more than one recipient.
36174
36175 A summary line is output at the end. By default the output is sorted on the
36176 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36177 the output to be sorted by oldest message and by count of messages,
36178 respectively. There are also three options that split the messages for each
36179 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36180 separates frozen messages, and &%-s%& separates messages according to their
36181 sender.
36182
36183 The output of &'exim -bp'& contains the original addresses in the message, so
36184 this also applies to the output from &'exiqsumm'&. No domains from addresses
36185 generated by aliasing or forwarding are included (unless the &%one_time%&
36186 option of the &(redirect)& router has been used to convert them into &"top
36187 level"& addresses).
36188
36189
36190
36191
36192 .section "Extracting specific information from the log (exigrep)" &&&
36193          "SECTextspeinf"
36194 .cindex "&'exigrep'&"
36195 .cindex "log" "extracts; grepping for"
36196 The &'exigrep'& utility is a Perl script that searches one or more main log
36197 files for entries that match a given pattern. When it finds a match, it
36198 extracts all the log entries for the relevant message, not just those that
36199 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36200 given message, or all mail for a given user, or for a given host, for example.
36201 The input files can be in Exim log format or syslog format.
36202 If a matching log line is not associated with a specific message, it is
36203 included in &'exigrep'&'s output without any additional lines. The usage is:
36204 .display
36205 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36206 .endd
36207 If no log file names are given on the command line, the standard input is read.
36208
36209 The &%-t%& argument specifies a number of seconds. It adds an additional
36210 condition for message selection. Messages that are complete are shown only if
36211 they spent more than <&'n'&> seconds on the queue.
36212
36213 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36214 makes it case-sensitive. This may give a performance improvement when searching
36215 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36216 option; with &%-I%& they do not. In both cases it is possible to change the
36217 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36218
36219 The &%-l%& option means &"literal"&, that is, treat all characters in the
36220 pattern as standing for themselves. Otherwise the pattern must be a Perl
36221 regular expression.
36222
36223 The &%-v%& option inverts the matching condition. That is, a line is selected
36224 if it does &'not'& match the pattern.
36225
36226 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36227 that are generated as a result/response to a message that &'exigrep'& matched
36228 normally.
36229
36230 Example of &%-M%&:
36231 user_a sends a message to user_b, which generates a bounce back to user_b. If
36232 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36233 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36234 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36235 when searching for &"user_a"& will show both messages since the bounce is
36236 &"related"& to or a &"result"& of the first message that was found by the
36237 search term.
36238
36239 If the location of a &'zcat'& command is known from the definition of
36240 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36241 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36242 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36243 autodetection of some well known compression extensions.
36244
36245
36246 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36247 .cindex "&'exipick'&"
36248 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36249 lists messages from the queue according to a variety of criteria. For details
36250 of &'exipick'&'s facilities, visit the web page at
36251 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36252 the &%--help%& option.
36253
36254
36255 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36256 .cindex "log" "cycling local files"
36257 .cindex "cycling logs"
36258 .cindex "&'exicyclog'&"
36259 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36260 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36261 you are using log files with datestamps in their names (see section
36262 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36263 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36264 There are two command line options for &'exicyclog'&:
36265 .ilist
36266 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36267 default that is set when Exim is built. The default default is 10.
36268 .next
36269 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36270 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36271 overriding the script's default, which is to find the setting from Exim's
36272 configuration.
36273 .endlist
36274
36275 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36276 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36277 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36278 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36279 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36280 logs are handled similarly.
36281
36282 If the limit is greater than 99, the script uses 3-digit numbers such as
36283 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36284 to one that is greater, or &'vice versa'&, you will have to fix the names of
36285 any existing log files.
36286
36287 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36288 the end are deleted. All files with numbers greater than 01 are compressed,
36289 using a compression command which is configured by the COMPRESS_COMMAND
36290 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36291 root &%crontab%& entry of the form
36292 .code
36293 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36294 .endd
36295 assuming you have used the name &"exim"& for the Exim user. You can run
36296 &'exicyclog'& as root if you wish, but there is no need.
36297
36298
36299
36300 .section "Mail statistics (eximstats)" "SECTmailstat"
36301 .cindex "statistics"
36302 .cindex "&'eximstats'&"
36303 A Perl script called &'eximstats'& is provided for extracting statistical
36304 information from log files. The output is either plain text, or HTML.
36305 Exim log files are also supported by the &'Lire'& system produced by the
36306 LogReport Foundation &url(http://www.logreport.org).
36307
36308 The &'eximstats'& script has been hacked about quite a bit over time. The
36309 latest version is the result of some extensive revision by Steve Campbell. A
36310 lot of information is given by default, but there are options for suppressing
36311 various parts of it. Following any options, the arguments to the script are a
36312 list of files, which should be main log files. For example:
36313 .code
36314 eximstats -nr /var/spool/exim/log/mainlog.01
36315 .endd
36316 By default, &'eximstats'& extracts information about the number and volume of
36317 messages received from or delivered to various hosts. The information is sorted
36318 both by message count and by volume, and the top fifty hosts in each category
36319 are listed on the standard output. Similar information, based on email
36320 addresses or domains instead of hosts can be requested by means of various
36321 options. For messages delivered and received locally, similar statistics are
36322 also produced per user.
36323
36324 The output also includes total counts and statistics about delivery errors, and
36325 histograms showing the number of messages received and deliveries made in each
36326 hour of the day. A delivery with more than one address in its envelope (for
36327 example, an SMTP transaction with more than one RCPT command) is counted
36328 as a single delivery by &'eximstats'&.
36329
36330 Though normally more deliveries than receipts are reported (as messages may
36331 have multiple recipients), it is possible for &'eximstats'& to report more
36332 messages received than delivered, even though the queue is empty at the start
36333 and end of the period in question. If an incoming message contains no valid
36334 recipients, no deliveries are recorded for it. A bounce message is handled as
36335 an entirely separate message.
36336
36337 &'eximstats'& always outputs a grand total summary giving the volume and number
36338 of messages received and deliveries made, and the number of hosts involved in
36339 each case. It also outputs the number of messages that were delayed (that is,
36340 not completely delivered at the first attempt), and the number that had at
36341 least one address that failed.
36342
36343 The remainder of the output is in sections that can be independently disabled
36344 or modified by various options. It consists of a summary of deliveries by
36345 transport, histograms of messages received and delivered per time interval
36346 (default per hour), information about the time messages spent on the queue,
36347 a list of relayed messages, lists of the top fifty sending hosts, local
36348 senders, destination hosts, and destination local users by count and by volume,
36349 and a list of delivery errors that occurred.
36350
36351 The relay information lists messages that were actually relayed, that is, they
36352 came from a remote host and were directly delivered to some other remote host,
36353 without being processed (for example, for aliasing or forwarding) locally.
36354
36355 There are quite a few options for &'eximstats'& to control exactly what it
36356 outputs. These are documented in the Perl script itself, and can be extracted
36357 by running the command &(perldoc)& on the script. For example:
36358 .code
36359 perldoc /usr/exim/bin/eximstats
36360 .endd
36361
36362 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36363 .cindex "&'exim_checkaccess'&"
36364 .cindex "policy control" "checking access"
36365 .cindex "checking access"
36366 The &%-bh%& command line argument allows you to run a fake SMTP session with
36367 debugging output, in order to check what Exim is doing when it is applying
36368 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36369 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36370 sometimes you just want to answer the question &"Does this address have
36371 access?"& without bothering with any further details.
36372
36373 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36374 two arguments, an IP address and an email address:
36375 .code
36376 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36377 .endd
36378 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36379 given email address would be accepted in a RCPT command in a TCP/IP
36380 connection from the host with the given IP address. The output of the utility
36381 is either the word &"accepted"&, or the SMTP error response, for example:
36382 .code
36383 Rejected:
36384 550 Relay not permitted
36385 .endd
36386 When running this test, the utility uses &`<>`& as the envelope sender address
36387 for the MAIL command, but you can change this by providing additional
36388 options. These are passed directly to the Exim command. For example, to specify
36389 that the test is to be run with the sender address &'himself@there.example'&
36390 you can use:
36391 .code
36392 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36393                  -f himself@there.example
36394 .endd
36395 Note that these additional Exim command line items must be given after the two
36396 mandatory arguments.
36397
36398 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36399 while running its checks. You can run checks that include callouts by using
36400 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36401
36402
36403
36404 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36405 .cindex "DBM" "building dbm files"
36406 .cindex "building DBM files"
36407 .cindex "&'exim_dbmbuild'&"
36408 .cindex "lower casing"
36409 .cindex "binary zero" "in lookup key"
36410 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36411 the format used by the &(lsearch)& lookup (see section
36412 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36413 names as keys and the remainder of the information as data. The lower-casing
36414 can be prevented by calling the program with the &%-nolc%& option.
36415
36416 A terminating zero is included as part of the key string. This is expected by
36417 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36418 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36419 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36420 files.
36421
36422 The program requires two arguments: the name of the input file (which can be a
36423 single hyphen to indicate the standard input), and the name of the output file.
36424 It creates the output under a temporary name, and then renames it if all went
36425 well.
36426
36427 .cindex "USE_DB"
36428 If the native DB interface is in use (USE_DB is set in a compile-time
36429 configuration file &-- this is common in free versions of Unix) the two file
36430 names must be different, because in this mode the Berkeley DB functions create
36431 a single output file using exactly the name given. For example,
36432 .code
36433 exim_dbmbuild /etc/aliases /etc/aliases.db
36434 .endd
36435 reads the system alias file and creates a DBM version of it in
36436 &_/etc/aliases.db_&.
36437
36438 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36439 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36440 environment, the suffixes are added to the second argument of
36441 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36442 when the Berkeley functions are used in compatibility mode (though this is not
36443 recommended), because in that case it adds a &_.db_& suffix to the file name.
36444
36445 If a duplicate key is encountered, the program outputs a warning, and when it
36446 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36447 option is used. By default, only the first of a set of duplicates is used &--
36448 this makes it compatible with &(lsearch)& lookups. There is an option
36449 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36450 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36451 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36452 return code is 2.
36453
36454
36455
36456
36457 .section "Finding individual retry times (exinext)" "SECTfinindret"
36458 .cindex "retry" "times"
36459 .cindex "&'exinext'&"
36460 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36461 fish specific information out of the retry database. Given a mail domain (or a
36462 complete address), it looks up the hosts for that domain, and outputs any retry
36463 information for the hosts or for the domain. At present, the retry information
36464 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36465 output. For example:
36466 .code
36467 $ exinext piglet@milne.fict.example
36468 kanga.milne.example:192.168.8.1 error 146: Connection refused
36469   first failed: 21-Feb-1996 14:57:34
36470   last tried:   21-Feb-1996 14:57:34
36471   next try at:  21-Feb-1996 15:02:34
36472 roo.milne.example:192.168.8.3 error 146: Connection refused
36473   first failed: 20-Jan-1996 13:12:08
36474   last tried:   21-Feb-1996 11:42:03
36475   next try at:  21-Feb-1996 19:42:03
36476   past final cutoff time
36477 .endd
36478 You can also give &'exinext'& a local part, without a domain, and it
36479 will give any retry information for that local part in your default domain.
36480 A message id can be used to obtain retry information pertaining to a specific
36481 message. This exists only when an attempt to deliver a message to a remote host
36482 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36483 &'exinext'& is not particularly efficient, but then it is not expected to be
36484 run very often.
36485
36486 The &'exinext'& utility calls Exim to find out information such as the location
36487 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36488 passed on to the &'exim'& commands. The first specifies an alternate Exim
36489 configuration file, and the second sets macros for use within the configuration
36490 file. These features are mainly to help in testing, but might also be useful in
36491 environments where more than one configuration file is in use.
36492
36493
36494
36495 .section "Hints database maintenance" "SECThindatmai"
36496 .cindex "hints database" "maintenance"
36497 .cindex "maintaining Exim's hints database"
36498 Three utility programs are provided for maintaining the DBM files that Exim
36499 uses to contain its delivery hint information. Each program requires two
36500 arguments. The first specifies the name of Exim's spool directory, and the
36501 second is the name of the database it is to operate on. These are as follows:
36502
36503 .ilist
36504 &'retry'&: the database of retry information
36505 .next
36506 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36507 for remote hosts
36508 .next
36509 &'callout'&: the callout cache
36510 .next
36511 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36512 .next
36513 &'misc'&: other hints data
36514 .endlist
36515
36516 The &'misc'& database is used for
36517
36518 .ilist
36519 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36520 .next
36521 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36522 &(smtp)& transport)
36523 .next
36524 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36525 in a transport)
36526 .endlist
36527
36528
36529
36530 .section "exim_dumpdb" "SECID261"
36531 .cindex "&'exim_dumpdb'&"
36532 The entire contents of a database are written to the standard output by the
36533 &'exim_dumpdb'& program, which has no options or arguments other than the
36534 spool and database names. For example, to dump the retry database:
36535 .code
36536 exim_dumpdb /var/spool/exim retry
36537 .endd
36538 Two lines of output are produced for each entry:
36539 .code
36540 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36541 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36542 .endd
36543 The first item on the first line is the key of the record. It starts with one
36544 of the letters R, or T, depending on whether it refers to a routing or
36545 transport retry. For a local delivery, the next part is the local address; for
36546 a remote delivery it is the name of the remote host, followed by its failing IP
36547 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36548 transport). If the remote port is not the standard one (port 25), it is added
36549 to the IP address. Then there follows an error code, an additional error code,
36550 and a textual description of the error.
36551
36552 The three times on the second line are the time of first failure, the time of
36553 the last delivery attempt, and the computed time for the next attempt. The line
36554 ends with an asterisk if the cutoff time for the last retry rule has been
36555 exceeded.
36556
36557 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36558 consists of a host name followed by a list of ids for messages that are or were
36559 waiting to be delivered to that host. If there are a very large number for any
36560 one host, continuation records, with a sequence number added to the host name,
36561 may be seen. The data in these records is often out of date, because a message
36562 may be routed to several alternative hosts, and Exim makes no effort to keep
36563 cross-references.
36564
36565
36566
36567 .section "exim_tidydb" "SECID262"
36568 .cindex "&'exim_tidydb'&"
36569 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36570 database. If run with no options, it removes all records that are more than 30
36571 days old. The age is calculated from the date and time that the record was last
36572 updated. Note that, in the case of the retry database, it is &'not'& the time
36573 since the first delivery failure. Information about a host that has been down
36574 for more than 30 days will remain in the database, provided that the record is
36575 updated sufficiently often.
36576
36577 The cutoff date can be altered by means of the &%-t%& option, which must be
36578 followed by a time. For example, to remove all records older than a week from
36579 the retry database:
36580 .code
36581 exim_tidydb -t 7d /var/spool/exim retry
36582 .endd
36583 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36584 message ids. In the former these appear as data in records keyed by host &--
36585 they were messages that were waiting for that host &-- and in the latter they
36586 are the keys for retry information for messages that have suffered certain
36587 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36588 message ids in database records are those of messages that are still on the
36589 queue. Message ids for messages that no longer exist are removed from
36590 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36591 For the &'retry'& database, records whose keys are non-existent message ids are
36592 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36593 whenever it removes information from the database.
36594
36595 Certain records are automatically removed by Exim when they are no longer
36596 needed, but others are not. For example, if all the MX hosts for a domain are
36597 down, a retry record is created for each one. If the primary MX host comes back
36598 first, its record is removed when Exim successfully delivers to it, but the
36599 records for the others remain because Exim has not tried to use those hosts.
36600
36601 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36602 hints databases. You should do this at a quiet time of day, because it requires
36603 a database to be locked (and therefore inaccessible to Exim) while it does its
36604 work. Removing records from a DBM file does not normally make the file smaller,
36605 but all the common DBM libraries are able to re-use the space that is released.
36606 After an initial phase of increasing in size, the databases normally reach a
36607 point at which they no longer get any bigger, as long as they are regularly
36608 tidied.
36609
36610 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36611 databases is likely to keep on increasing.
36612
36613
36614
36615
36616 .section "exim_fixdb" "SECID263"
36617 .cindex "&'exim_fixdb'&"
36618 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36619 Its main use is for testing Exim, but it might also be occasionally useful for
36620 getting round problems in a live system. It has no options, and its interface
36621 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36622 key of a database record can then be entered, and the data for that record is
36623 displayed.
36624
36625 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36626 except the &'retry'& database, that is the only operation that can be carried
36627 out. For the &'retry'& database, each field is output preceded by a number, and
36628 data for individual fields can be changed by typing the field number followed
36629 by new data, for example:
36630 .code
36631 > 4 951102:1000
36632 .endd
36633 resets the time of the next delivery attempt. Time values are given as a
36634 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36635 used as optional separators.
36636
36637
36638
36639
36640 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36641 .cindex "mailbox" "maintenance"
36642 .cindex "&'exim_lock'&"
36643 .cindex "locking mailboxes"
36644 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36645 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36646 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36647 a user agent while investigating a problem. The utility requires the name of
36648 the file as its first argument. If the locking is successful, the second
36649 argument is run as a command (using C's &[system()]& function); if there is no
36650 second argument, the value of the SHELL environment variable is used; if this
36651 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36652 is unlocked and the utility ends. The following options are available:
36653
36654 .vlist
36655 .vitem &%-fcntl%&
36656 Use &[fcntl()]& locking on the open mailbox.
36657
36658 .vitem &%-flock%&
36659 Use &[flock()]& locking on the open mailbox, provided the operating system
36660 supports it.
36661
36662 .vitem &%-interval%&
36663 This must be followed by a number, which is a number of seconds; it sets the
36664 interval to sleep between retries (default 3).
36665
36666 .vitem &%-lockfile%&
36667 Create a lock file before opening the mailbox.
36668
36669 .vitem &%-mbx%&
36670 Lock the mailbox using MBX rules.
36671
36672 .vitem &%-q%&
36673 Suppress verification output.
36674
36675 .vitem &%-retries%&
36676 This must be followed by a number; it sets the number of times to try to get
36677 the lock (default 10).
36678
36679 .vitem &%-restore_time%&
36680 This option causes &%exim_lock%& to restore the modified and read times to the
36681 locked file before exiting. This allows you to access a locked mailbox (for
36682 example, to take a backup copy) without disturbing the times that the user
36683 subsequently sees.
36684
36685 .vitem &%-timeout%&
36686 This must be followed by a number, which is a number of seconds; it sets a
36687 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36688 default), a non-blocking call is used.
36689
36690 .vitem &%-v%&
36691 Generate verbose output.
36692 .endlist
36693
36694 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36695 default is to create a lock file and also to use &[fcntl()]& locking on the
36696 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36697 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36698 requires that the directory containing the file be writeable. Locking by lock
36699 file does not last for ever; Exim assumes that a lock file is expired if it is
36700 more than 30 minutes old.
36701
36702 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36703 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36704 to be taken out on the open mailbox, and an exclusive lock on the file
36705 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36706 number of the mailbox file. When the locking is released, if an exclusive lock
36707 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36708
36709 The default output contains verification of the locking that takes place. The
36710 &%-v%& option causes some additional information to be given. The &%-q%& option
36711 suppresses all output except error messages.
36712
36713 A command such as
36714 .code
36715 exim_lock /var/spool/mail/spqr
36716 .endd
36717 runs an interactive shell while the file is locked, whereas
36718 .display
36719 &`exim_lock -q /var/spool/mail/spqr <<End`&
36720 <&'some commands'&>
36721 &`End`&
36722 .endd
36723 runs a specific non-interactive sequence of commands while the file is locked,
36724 suppressing all verification output. A single command can be run by a command
36725 such as
36726 .code
36727 exim_lock -q /var/spool/mail/spqr \
36728   "cp /var/spool/mail/spqr /some/where"
36729 .endd
36730 Note that if a command is supplied, it must be entirely contained within the
36731 second argument &-- hence the quotes.
36732 .ecindex IIDutils
36733
36734
36735 . ////////////////////////////////////////////////////////////////////////////
36736 . ////////////////////////////////////////////////////////////////////////////
36737
36738 .chapter "The Exim monitor" "CHAPeximon"
36739 .scindex IIDeximon "Exim monitor" "description"
36740 .cindex "X-windows"
36741 .cindex "&'eximon'&"
36742 .cindex "Local/eximon.conf"
36743 .cindex "&_exim_monitor/EDITME_&"
36744 The Exim monitor is an application which displays in an X window information
36745 about the state of Exim's queue and what Exim is doing. An admin user can
36746 perform certain operations on messages from this GUI interface; however all
36747 such facilities are also available from the command line, and indeed, the
36748 monitor itself makes use of the command line to perform any actions requested.
36749
36750
36751
36752 .section "Running the monitor" "SECID264"
36753 The monitor is started by running the script called &'eximon'&. This is a shell
36754 script that sets up a number of environment variables, and then runs the
36755 binary called &_eximon.bin_&. The default appearance of the monitor window can
36756 be changed by editing the &_Local/eximon.conf_& file created by editing
36757 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36758 parameters are for.
36759
36760 The parameters that get built into the &'eximon'& script can be overridden for
36761 a particular invocation by setting up environment variables of the same names,
36762 preceded by &`EXIMON_`&. For example, a shell command such as
36763 .code
36764 EXIMON_LOG_DEPTH=400 eximon
36765 .endd
36766 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36767 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36768 overrides the Exim log file configuration. This makes it possible to have
36769 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36770 syslog messages are routed to a file on the local host.
36771
36772 X resources can be used to change the appearance of the window in the normal
36773 way. For example, a resource setting of the form
36774 .code
36775 Eximon*background: gray94
36776 .endd
36777 changes the colour of the background to light grey rather than white. The
36778 stripcharts are drawn with both the data lines and the reference lines in
36779 black. This means that the reference lines are not visible when on top of the
36780 data. However, their colour can be changed by setting a resource called
36781 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36782 For example, if your X server is running Unix, you could set up lighter
36783 reference lines in the stripcharts by obeying
36784 .code
36785 xrdb -merge <<End
36786 Eximon*highlight: gray
36787 End
36788 .endd
36789 .cindex "admin user"
36790 In order to see the contents of messages on the queue, and to operate on them,
36791 &'eximon'& must either be run as root or by an admin user.
36792
36793 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36794 contain X11 resource parameters interpreted by the X11 library.  In addition,
36795 if the first parameter starts with the string "gdb" then it is removed and the
36796 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36797 versioned variants of gdb can be invoked).
36798
36799 The monitor's window is divided into three parts. The first contains one or
36800 more stripcharts and two action buttons, the second contains a &"tail"& of the
36801 main log file, and the third is a display of the queue of messages awaiting
36802 delivery, with two more action buttons. The following sections describe these
36803 different parts of the display.
36804
36805
36806
36807
36808 .section "The stripcharts" "SECID265"
36809 .cindex "stripchart"
36810 The first stripchart is always a count of messages on the queue. Its name can
36811 be configured by setting QUEUE_STRIPCHART_NAME in the
36812 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36813 configuration script by regular expression matches on log file entries, making
36814 it possible to display, for example, counts of messages delivered to certain
36815 hosts or using certain transports. The supplied defaults display counts of
36816 received and delivered messages, and of local and SMTP deliveries. The default
36817 period between stripchart updates is one minute; this can be adjusted by a
36818 parameter in the &_Local/eximon.conf_& file.
36819
36820 The stripchart displays rescale themselves automatically as the value they are
36821 displaying changes. There are always 10 horizontal lines in each chart; the
36822 title string indicates the value of each division when it is greater than one.
36823 For example, &"x2"& means that each division represents a value of 2.
36824
36825 It is also possible to have a stripchart which shows the percentage fullness of
36826 a particular disk partition, which is useful when local deliveries are confined
36827 to a single partition.
36828
36829 .cindex "&%statvfs%& function"
36830 This relies on the availability of the &[statvfs()]& function or equivalent in
36831 the operating system. Most, but not all versions of Unix that support Exim have
36832 this. For this particular stripchart, the top of the chart always represents
36833 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36834 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36835 &_Local/eximon.conf_& file.
36836
36837
36838
36839
36840 .section "Main action buttons" "SECID266"
36841 .cindex "size" "of monitor window"
36842 .cindex "Exim monitor" "window size"
36843 .cindex "window size"
36844 Below the stripcharts there is an action button for quitting the monitor. Next
36845 to this is another button marked &"Size"&. They are placed here so that
36846 shrinking the window to its default minimum size leaves just the queue count
36847 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36848 the window to expand to its maximum size, unless it is already at the maximum,
36849 in which case it is reduced to its minimum.
36850
36851 When expanding to the maximum, if the window cannot be fully seen where it
36852 currently is, it is moved back to where it was the last time it was at full
36853 size. When it is expanding from its minimum size, the old position is
36854 remembered, and next time it is reduced to the minimum it is moved back there.
36855
36856 The idea is that you can keep a reduced window just showing one or two
36857 stripcharts at a convenient place on your screen, easily expand it to show
36858 the full window when required, and just as easily put it back to what it was.
36859 The idea is copied from what the &'twm'& window manager does for its
36860 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36861 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36862
36863 Normally, the monitor starts up with the window at its full size, but it can be
36864 built so that it starts up with the window at its smallest size, by setting
36865 START_SMALL=yes in &_Local/eximon.conf_&.
36866
36867
36868
36869 .section "The log display" "SECID267"
36870 .cindex "log" "tail of; in monitor"
36871 The second section of the window is an area in which a display of the tail of
36872 the main log is maintained.
36873 To save space on the screen, the timestamp on each log line is shortened by
36874 removing the date and, if &%log_timezone%& is set, the timezone.
36875 The log tail is not available when the only destination for logging data is
36876 syslog, unless the syslog lines are routed to a local file whose name is passed
36877 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36878
36879 The log sub-window has a scroll bar at its lefthand side which can be used to
36880 move back to look at earlier text, and the up and down arrow keys also have a
36881 scrolling effect. The amount of log that is kept depends on the setting of
36882 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36883 to use. When this is full, the earlier 50% of data is discarded &-- this is
36884 much more efficient than throwing it away line by line. The sub-window also has
36885 a horizontal scroll bar for accessing the ends of long log lines. This is the
36886 only means of horizontal scrolling; the right and left arrow keys are not
36887 available. Text can be cut from this part of the window using the mouse in the
36888 normal way. The size of this subwindow is controlled by parameters in the
36889 configuration file &_Local/eximon.conf_&.
36890
36891 Searches of the text in the log window can be carried out by means of the ^R
36892 and ^S keystrokes, which default to a reverse and a forward search,
36893 respectively. The search covers only the text that is displayed in the window.
36894 It cannot go further back up the log.
36895
36896 The point from which the search starts is indicated by a caret marker. This is
36897 normally at the end of the text in the window, but can be positioned explicitly
36898 by pointing and clicking with the left mouse button, and is moved automatically
36899 by a successful search. If new text arrives in the window when it is scrolled
36900 back, the caret remains where it is, but if the window is not scrolled back,
36901 the caret is moved to the end of the new text.
36902
36903 Pressing ^R or ^S pops up a window into which the search text can be typed.
36904 There are buttons for selecting forward or reverse searching, for carrying out
36905 the search, and for cancelling. If the &"Search"& button is pressed, the search
36906 happens and the window remains so that further searches can be done. If the
36907 &"Return"& key is pressed, a single search is done and the window is closed. If
36908 ^C is typed the search is cancelled.
36909
36910 The searching facility is implemented using the facilities of the Athena text
36911 widget. By default this pops up a window containing both &"search"& and
36912 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36913 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36914 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36915 provided version of &%TextPop%& when the remaining parts of the text widget
36916 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36917 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36918 on these systems, at the expense of having unwanted items in the search popup
36919 window.
36920
36921
36922
36923 .section "The queue display" "SECID268"
36924 .cindex "queue" "display in monitor"
36925 The bottom section of the monitor window contains a list of all messages that
36926 are on the queue, which includes those currently being received or delivered,
36927 as well as those awaiting delivery. The size of this subwindow is controlled by
36928 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36929 at which it is updated is controlled by another parameter in the same file &--
36930 the default is 5 minutes, since queue scans can be quite expensive. However,
36931 there is an &"Update"& action button just above the display which can be used
36932 to force an update of the queue display at any time.
36933
36934 When a host is down for some time, a lot of pending mail can build up for it,
36935 and this can make it hard to deal with other messages on the queue. To help
36936 with this situation there is a button next to &"Update"& called &"Hide"&. If
36937 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36938 type anything in here and press &"Return"&, the text is added to a chain of
36939 such texts, and if every undelivered address in a message matches at least one
36940 of the texts, the message is not displayed.
36941
36942 If there is an address that does not match any of the texts, all the addresses
36943 are displayed as normal. The matching happens on the ends of addresses so, for
36944 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36945 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36946 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36947 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36948 a hide request is automatically cancelled after one hour.
36949
36950 While the dialogue box is displayed, you can't press any buttons or do anything
36951 else to the monitor window. For this reason, if you want to cut text from the
36952 queue display to use in the dialogue box, you have to do the cutting before
36953 pressing the &"Hide"& button.
36954
36955 The queue display contains, for each unhidden queued message, the length of
36956 time it has been on the queue, the size of the message, the message id, the
36957 message sender, and the first undelivered recipient, all on one line. If it is
36958 a bounce message, the sender is shown as &"<>"&. If there is more than one
36959 recipient to which the message has not yet been delivered, subsequent ones are
36960 listed on additional lines, up to a maximum configured number, following which
36961 an ellipsis is displayed. Recipients that have already received the message are
36962 not shown.
36963
36964 .cindex "frozen messages" "display"
36965 If a message is frozen, an asterisk is displayed at the left-hand side.
36966
36967 The queue display has a vertical scroll bar, and can also be scrolled by means
36968 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36969 The text searching facilities, as described above for the log window, are also
36970 available, but the caret is always moved to the end of the text when the queue
36971 display is updated.
36972
36973
36974
36975 .section "The queue menu" "SECID269"
36976 .cindex "queue" "menu in monitor"
36977 If the &%shift%& key is held down and the left button is clicked when the mouse
36978 pointer is over the text for any message, an action menu pops up, and the first
36979 line of the queue display for the message is highlighted. This does not affect
36980 any selected text.
36981
36982 If you want to use some other event for popping up the menu, you can set the
36983 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36984 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36985 value set in this parameter is a standard X event description. For example, to
36986 run eximon using &%ctrl%& rather than &%shift%& you could use
36987 .code
36988 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36989 .endd
36990 The title of the menu is the message id, and it contains entries which act as
36991 follows:
36992
36993 .ilist
36994 &'message log'&: The contents of the message log for the message are displayed
36995 in a new text window.
36996 .next
36997 &'headers'&: Information from the spool file that contains the envelope
36998 information and headers is displayed in a new text window. See chapter
36999 &<<CHAPspool>>& for a description of the format of spool files.
37000 .next
37001 &'body'&: The contents of the spool file containing the body of the message are
37002 displayed in a new text window. There is a default limit of 20,000 bytes to the
37003 amount of data displayed. This can be changed by setting the BODY_MAX
37004 option at compile time, or the EXIMON_BODY_MAX option at run time.
37005 .next
37006 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37007 delivery of the message. This causes an automatic thaw if the message is
37008 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37009 a new text window. The delivery is run in a separate process, to avoid holding
37010 up the monitor while the delivery proceeds.
37011 .next
37012 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37013 that the message be frozen.
37014 .next
37015 .cindex "thawing messages"
37016 .cindex "unfreezing messages"
37017 .cindex "frozen messages" "thawing"
37018 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37019 that the message be thawed.
37020 .next
37021 .cindex "delivery" "forcing failure"
37022 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37023 that Exim gives up trying to deliver the message. A bounce message is generated
37024 for any remaining undelivered addresses.
37025 .next
37026 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37027 that the message be deleted from the system without generating a bounce
37028 message.
37029 .next
37030 &'add recipient'&: A dialog box is displayed into which a recipient address can
37031 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37032 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37033 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37034 causes a call to Exim to be made using the &%-Mar%& option to request that an
37035 additional recipient be added to the message, unless the entry box is empty, in
37036 which case no action is taken.
37037 .next
37038 &'mark delivered'&: A dialog box is displayed into which a recipient address
37039 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37040 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37041 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37042 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37043 recipient address as already delivered, unless the entry box is empty, in which
37044 case no action is taken.
37045 .next
37046 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37047 mark all recipient addresses as already delivered.
37048 .next
37049 &'edit sender'&: A dialog box is displayed initialized with the current
37050 sender's address. Pressing RETURN causes a call to Exim to be made using the
37051 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37052 in which case no action is taken. If you want to set an empty sender (as in
37053 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37054 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37055 the address is qualified with that domain.
37056 .endlist
37057
37058 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37059 other cases when a call to Exim is made, if there is any output from Exim (in
37060 particular, if the command fails) a window containing the command and the
37061 output is displayed. Otherwise, the results of the action are normally apparent
37062 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37063 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37064 if no output is generated.
37065
37066 The queue display is automatically updated for actions such as freezing and
37067 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37068 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37069 force an update of the display after one of these actions.
37070
37071 In any text window that is displayed as result of a menu action, the normal
37072 cut-and-paste facility is available, and searching can be carried out using ^R
37073 and ^S, as described above for the log tail window.
37074 .ecindex IIDeximon
37075
37076
37077
37078
37079
37080 . ////////////////////////////////////////////////////////////////////////////
37081 . ////////////////////////////////////////////////////////////////////////////
37082
37083 .chapter "Security considerations" "CHAPsecurity"
37084 .scindex IIDsecurcon "security" "discussion of"
37085 This chapter discusses a number of issues concerned with security, some of
37086 which are also covered in other parts of this manual.
37087
37088 For reasons that this author does not understand, some people have promoted
37089 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37090 existence of this chapter in the documentation. However, the intent of the
37091 chapter is simply to describe the way Exim works in relation to certain
37092 security concerns, not to make any specific claims about the effectiveness of
37093 its security as compared with other MTAs.
37094
37095 What follows is a description of the way Exim is supposed to be. Best efforts
37096 have been made to try to ensure that the code agrees with the theory, but an
37097 absence of bugs can never be guaranteed. Any that are reported will get fixed
37098 as soon as possible.
37099
37100
37101 .section "Building a more &""hardened""& Exim" "SECID286"
37102 .cindex "security" "build-time features"
37103 There are a number of build-time options that can be set in &_Local/Makefile_&
37104 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37105 Exim administrator who does not have the root password, or by someone who has
37106 penetrated the Exim (but not the root) account. These options are as follows:
37107
37108 .ilist
37109 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37110 start of any file names used with the &%-C%& option. When it is set, these file
37111 names are also not allowed to contain the sequence &"/../"&. (However, if the
37112 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37113 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37114 default setting for &%ALT_CONFIG_PREFIX%&.
37115
37116 If the permitted configuration files are confined to a directory to
37117 which only root has access, this guards against someone who has broken
37118 into the Exim account from running a privileged Exim with an arbitrary
37119 configuration file, and using it to break into other accounts.
37120 .next
37121
37122 If a non-trusted configuration file (i.e. not the default configuration file
37123 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37124 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37125 the next item), then root privilege is retained only if the caller of Exim is
37126 root. This locks out the possibility of testing a configuration using &%-C%&
37127 right through message reception and delivery, even if the caller is root. The
37128 reception works, but by that time, Exim is running as the Exim user, so when
37129 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37130 privilege to be lost. However, root can test reception and delivery using two
37131 separate commands.
37132
37133 .next
37134 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37135 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37136 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37137 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37138 the restrictive side.  Requiring build-time selection of safe macros is onerous
37139 but this option is intended solely as a transition mechanism to permit
37140 previously-working configurations to continue to work after release 4.73.
37141 .next
37142 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37143 is disabled.
37144 .next
37145 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37146 never to be used for any deliveries. This is like the &%never_users%& runtime
37147 option, but it cannot be overridden; the runtime option adds additional users
37148 to the list. The default setting is &"root"&; this prevents a non-root user who
37149 is permitted to modify the runtime file from using Exim as a way to get root.
37150 .endlist
37151
37152
37153
37154 .section "Root privilege" "SECID270"
37155 .cindex "setuid"
37156 .cindex "root privilege"
37157 The Exim binary is normally setuid to root, which means that it gains root
37158 privilege (runs as root) when it starts execution. In some special cases (for
37159 example, when the daemon is not in use and there are no local deliveries), it
37160 may be possible to run Exim setuid to some user other than root. This is
37161 discussed in the next section. However, in most installations, root privilege
37162 is required for two things:
37163
37164 .ilist
37165 To set up a socket connected to the standard SMTP port (25) when initialising
37166 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37167 not required.
37168 .next
37169 To be able to change uid and gid in order to read users' &_.forward_& files and
37170 perform local deliveries as the receiving user or as specified in the
37171 configuration.
37172 .endlist
37173
37174 It is not necessary to be root to do any of the other things Exim does, such as
37175 receiving messages and delivering them externally over SMTP, and it is
37176 obviously more secure if Exim does not run as root except when necessary.
37177 For this reason, a user and group for Exim to use must be defined in
37178 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37179 group"&. Their values can be changed by the run time configuration, though this
37180 is not recommended. Often a user called &'exim'& is used, but some sites use
37181 &'mail'& or another user name altogether.
37182
37183 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37184 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37185 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37186
37187 After a new Exim process has interpreted its command line options, it changes
37188 uid and gid in the following cases:
37189
37190 .ilist
37191 .oindex "&%-C%&"
37192 .oindex "&%-D%&"
37193 If the &%-C%& option is used to specify an alternate configuration file, or if
37194 the &%-D%& option is used to define macro values for the configuration, and the
37195 calling process is not running as root, the uid and gid are changed to those of
37196 the calling process.
37197 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37198 option may not be used at all.
37199 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37200 can be supplied if the calling process is running as root, the Exim run-time
37201 user or CONFIGURE_OWNER, if defined.
37202 .next
37203 .oindex "&%-be%&"
37204 .oindex "&%-bf%&"
37205 .oindex "&%-bF%&"
37206 If the expansion test option (&%-be%&) or one of the filter testing options
37207 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37208 calling process.
37209 .next
37210 If the process is not a daemon process or a queue runner process or a delivery
37211 process or a process for testing address routing (started with &%-bt%&), the
37212 uid and gid are changed to the Exim user and group. This means that Exim always
37213 runs under its own uid and gid when receiving messages. This also applies when
37214 testing address verification
37215 .oindex "&%-bv%&"
37216 .oindex "&%-bh%&"
37217 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37218 option).
37219 .next
37220 For a daemon, queue runner, delivery, or address testing process, the uid
37221 remains as root at this stage, but the gid is changed to the Exim group.
37222 .endlist
37223
37224 The processes that initially retain root privilege behave as follows:
37225
37226 .ilist
37227 A daemon process changes the gid to the Exim group and the uid to the Exim
37228 user after setting up one or more listening sockets. The &[initgroups()]&
37229 function is called, so that if the Exim user is in any additional groups, they
37230 will be used during message reception.
37231 .next
37232 A queue runner process retains root privilege throughout its execution. Its
37233 job is to fork a controlled sequence of delivery processes.
37234 .next
37235 A delivery process retains root privilege throughout most of its execution,
37236 but any actual deliveries (that is, the transports themselves) are run in
37237 subprocesses which always change to a non-root uid and gid. For local
37238 deliveries this is typically the uid and gid of the owner of the mailbox; for
37239 remote deliveries, the Exim uid and gid are used. Once all the delivery
37240 subprocesses have been run, a delivery process changes to the Exim uid and gid
37241 while doing post-delivery tidying up such as updating the retry database and
37242 generating bounce and warning messages.
37243
37244 While the recipient addresses in a message are being routed, the delivery
37245 process runs as root. However, if a user's filter file has to be processed,
37246 this is done in a subprocess that runs under the individual user's uid and
37247 gid. A system filter is run as root unless &%system_filter_user%& is set.
37248 .next
37249 A process that is testing addresses (the &%-bt%& option) runs as root so that
37250 the routing is done in the same environment as a message delivery.
37251 .endlist
37252
37253
37254
37255
37256 .section "Running Exim without privilege" "SECTrunexiwitpri"
37257 .cindex "privilege, running without"
37258 .cindex "unprivileged running"
37259 .cindex "root privilege" "running without"
37260 Some installations like to run Exim in an unprivileged state for more of its
37261 operation, for added security. Support for this mode of operation is provided
37262 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37263 gid are changed to the Exim user and group at the start of a delivery process
37264 (and also queue runner and address testing processes). This means that address
37265 routing is no longer run as root, and the deliveries themselves cannot change
37266 to any other uid.
37267
37268 .cindex SIGHUP
37269 .cindex "daemon" "restarting"
37270 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37271 that the daemon can still be started in the usual way, and it can respond
37272 correctly to SIGHUP because the re-invocation regains root privilege.
37273
37274 An alternative approach is to make Exim setuid to the Exim user and also setgid
37275 to the Exim group. If you do this, the daemon must be started from a root
37276 process. (Calling Exim from a root process makes it behave in the way it does
37277 when it is setuid root.) However, the daemon cannot restart itself after a
37278 SIGHUP signal because it cannot regain privilege.
37279
37280 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37281 stops Exim from trying to re-invoke itself to do a delivery after a message has
37282 been received. Such a re-invocation is a waste of resources because it has no
37283 effect.
37284
37285 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37286 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37287 to the Exim user seems a clean approach, but there is one complication:
37288
37289 In this style of operation, Exim is running with the real uid and gid set to
37290 those of the calling process, and the effective uid/gid set to Exim's values.
37291 Ideally, any association with the calling process' uid/gid should be dropped,
37292 that is, the real uid/gid should be reset to the effective values so as to
37293 discard any privileges that the caller may have. While some operating systems
37294 have a function that permits this action for a non-root effective uid, quite a
37295 number of them do not. Because of this lack of standardization, Exim does not
37296 address this problem at this time.
37297
37298 For this reason, the recommended approach for &"mostly unprivileged"& running
37299 is to keep the Exim binary setuid to root, and to set
37300 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37301 be used in the most straightforward way.
37302
37303 If you configure Exim not to run delivery processes as root, there are a
37304 number of restrictions on what you can do:
37305
37306 .ilist
37307 You can deliver only as the Exim user/group. You should  explicitly use the
37308 &%user%& and &%group%& options to override routers or local transports that
37309 normally deliver as the recipient. This makes sure that configurations that
37310 work in this mode function the same way in normal mode. Any implicit or
37311 explicit specification of another user causes an error.
37312 .next
37313 Use of &_.forward_& files is severely restricted, such that it is usually
37314 not worthwhile to include them in the configuration.
37315 .next
37316 Users who wish to use &_.forward_& would have to make their home directory and
37317 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37318 and their equivalents in Exim filters, cannot be used. While they could be
37319 enabled in the Exim user's name, that would be insecure and not very useful.
37320 .next
37321 Unless the local user mailboxes are all owned by the Exim user (possible in
37322 some POP3 or IMAP-only environments):
37323
37324 .olist
37325 They must be owned by the Exim group and be writeable by that group. This
37326 implies you must set &%mode%& in the appendfile configuration, as well as the
37327 mode of the mailbox files themselves.
37328 .next
37329 You must set &%no_check_owner%&, since most or all of the files will not be
37330 owned by the Exim user.
37331 .next
37332 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37333 on a newly created mailbox when unprivileged. This also implies that new
37334 mailboxes need to be created manually.
37335 .endlist olist
37336 .endlist ilist
37337
37338
37339 These restrictions severely restrict what can be done in local deliveries.
37340 However, there are no restrictions on remote deliveries. If you are running a
37341 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37342 gives more security at essentially no cost.
37343
37344 If you are using the &%mua_wrapper%& facility (see chapter
37345 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37346
37347
37348
37349
37350 .section "Delivering to local files" "SECID271"
37351 Full details of the checks applied by &(appendfile)& before it writes to a file
37352 are given in chapter &<<CHAPappendfile>>&.
37353
37354
37355
37356 .section "Running local commands" "SECTsecconslocalcmds"
37357 .cindex "security" "local commands"
37358 .cindex "security" "command injection attacks"
37359 There are a number of ways in which an administrator can configure Exim to run
37360 commands based upon received, untrustworthy, data. Further, in some
37361 configurations a user who can control a &_.forward_& file can also arrange to
37362 run commands. Configuration to check includes, but is not limited to:
37363
37364 .ilist
37365 Use of &%use_shell%& in the pipe transport: various forms of shell command
37366 injection may be possible with this option present. It is dangerous and should
37367 be used only with considerable caution. Consider constraints which whitelist
37368 allowed characters in a variable which is to be used in a pipe transport that
37369 has &%use_shell%& enabled.
37370 .next
37371 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37372 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37373 &_.forward_& files in a redirect router. If Exim is running on a central mail
37374 hub to which ordinary users do not have shell access, but home directories are
37375 NFS mounted (for instance) then administrators should review the list of these
37376 forbid options available, and should bear in mind that the options that may
37377 need forbidding can change as new features are added between releases.
37378 .next
37379 The &%${run...}%& expansion item does not use a shell by default, but
37380 administrators can configure use of &_/bin/sh_& as part of the command.
37381 Such invocations should be viewed with prejudicial suspicion.
37382 .next
37383 Administrators who use embedded Perl are advised to explore how Perl's
37384 taint checking might apply to their usage.
37385 .next
37386 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37387 administrators are well advised to view its use with suspicion, in case (for
37388 instance) it allows a local-part to contain embedded Exim directives.
37389 .next
37390 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37391 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37392 each can reference arbitrary lists and files, rather than just being a list
37393 of opaque strings.
37394 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37395 real-world security vulnerabilities caused by its use with untrustworthy data
37396 injected in, for SQL injection attacks.
37397 Consider the use of the &%inlisti%& expansion condition instead.
37398 .endlist
37399
37400
37401
37402
37403 .section "Trust in configuration data" "SECTsecconfdata"
37404 .cindex "security" "data sources"
37405 .cindex "security" "regular expressions"
37406 .cindex "regular expressions" "security"
37407 .cindex "PCRE" "security"
37408 If configuration data for Exim can come from untrustworthy sources, there
37409 are some issues to be aware of:
37410
37411 .ilist
37412 Use of &%${expand...}%& may provide a path for shell injection attacks.
37413 .next
37414 Letting untrusted data provide a regular expression is unwise.
37415 .next
37416 Using &%${match...}%& to apply a fixed regular expression against untrusted
37417 data may result in pathological behaviour within PCRE.  Be aware of what
37418 "backtracking" means and consider options for being more strict with a regular
37419 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37420 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37421 possessive quantifiers or just not using regular expressions against untrusted
37422 data.
37423 .next
37424 It can be important to correctly use &%${quote:...}%&,
37425 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37426 items to ensure that data is correctly constructed.
37427 .next
37428 Some lookups might return multiple results, even though normal usage is only
37429 expected to yield one result.
37430 .endlist
37431
37432
37433
37434
37435 .section "IPv4 source routing" "SECID272"
37436 .cindex "source routing" "in IP packets"
37437 .cindex "IP source routing"
37438 Many operating systems suppress IP source-routed packets in the kernel, but
37439 some cannot be made to do this, so Exim does its own check. It logs incoming
37440 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37441 IPv6. No special checking is currently done.
37442
37443
37444
37445 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37446 Support for these SMTP commands is disabled by default. If required, they can
37447 be enabled by defining suitable ACLs.
37448
37449
37450
37451
37452 .section "Privileged users" "SECID274"
37453 .cindex "trusted users"
37454 .cindex "admin user"
37455 .cindex "privileged user"
37456 .cindex "user" "trusted"
37457 .cindex "user" "admin"
37458 Exim recognizes two sets of users with special privileges. Trusted users are
37459 able to submit new messages to Exim locally, but supply their own sender
37460 addresses and information about a sending host. For other users submitting
37461 local messages, Exim sets up the sender address from the uid, and doesn't
37462 permit a remote host to be specified.
37463
37464 .oindex "&%-f%&"
37465 However, an untrusted user is permitted to use the &%-f%& command line option
37466 in the special form &%-f <>%& to indicate that a delivery failure for the
37467 message should not cause an error report. This affects the message's envelope,
37468 but it does not affect the &'Sender:'& header. Untrusted users may also be
37469 permitted to use specific forms of address with the &%-f%& option by setting
37470 the &%untrusted_set_sender%& option.
37471
37472 Trusted users are used to run processes that receive mail messages from some
37473 other mail domain and pass them on to Exim for delivery either locally, or over
37474 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37475 as any user listed in the &%trusted_users%& configuration option, or under any
37476 group listed in the &%trusted_groups%& option.
37477
37478 Admin users are permitted to do things to the messages on Exim's queue. They
37479 can freeze or thaw messages, cause them to be returned to their senders, remove
37480 them entirely, or modify them in various ways. In addition, admin users can run
37481 the Exim monitor and see all the information it is capable of providing, which
37482 includes the contents of files on the spool.
37483
37484 .oindex "&%-M%&"
37485 .oindex "&%-q%&"
37486 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37487 delivery of messages on its queue is restricted to admin users. This
37488 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37489 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37490 queue is also restricted to admin users. This restriction can be relaxed by
37491 setting &%no_queue_list_requires_admin%&.
37492
37493 Exim recognizes an admin user if the calling process is running as root or as
37494 the Exim user or if any of the groups associated with the calling process is
37495 the Exim group. It is not necessary actually to be running under the Exim
37496 group. However, if admin users who are not root or the Exim user are to access
37497 the contents of files on the spool via the Exim monitor (which runs
37498 unprivileged), Exim must be built to allow group read access to its spool
37499 files.
37500
37501
37502
37503 .section "Spool files" "SECID275"
37504 .cindex "spool directory" "files"
37505 Exim's spool directory and everything it contains is owned by the Exim user and
37506 set to the Exim group. The mode for spool files is defined in the
37507 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37508 any user who is a member of the Exim group can access these files.
37509
37510
37511
37512 .section "Use of argv[0]" "SECID276"
37513 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37514 of specific strings, Exim assumes certain options. For example, calling Exim
37515 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37516 to calling it with the option &%-bS%&. There are no security implications in
37517 this.
37518
37519
37520
37521 .section "Use of %f formatting" "SECID277"
37522 The only use made of &"%f"& by Exim is in formatting load average values. These
37523 are actually stored in integer variables as 1000 times the load average.
37524 Consequently, their range is limited and so therefore is the length of the
37525 converted output.
37526
37527
37528
37529 .section "Embedded Exim path" "SECID278"
37530 Exim uses its own path name, which is embedded in the code, only when it needs
37531 to re-exec in order to regain root privilege. Therefore, it is not root when it
37532 does so. If some bug allowed the path to get overwritten, it would lead to an
37533 arbitrary program's being run as exim, not as root.
37534
37535
37536
37537 .section "Dynamic module directory" "SECTdynmoddir"
37538 Any dynamically loadable modules must be installed into the directory
37539 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37540 loading it.
37541
37542
37543 .section "Use of sprintf()" "SECID279"
37544 .cindex "&[sprintf()]&"
37545 A large number of occurrences of &"sprintf"& in the code are actually calls to
37546 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37547 The intermediate formatting is done into a large fixed buffer by a function
37548 that runs through the format string itself, and checks the length of each
37549 conversion before performing it, thus preventing buffer overruns.
37550
37551 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37552 the output buffer is known to be sufficiently long to contain the converted
37553 string.
37554
37555
37556
37557 .section "Use of debug_printf() and log_write()" "SECID280"
37558 Arbitrary strings are passed to both these functions, but they do their
37559 formatting by calling the function &'string_vformat()'&, which runs through
37560 the format string itself, and checks the length of each conversion.
37561
37562
37563
37564 .section "Use of strcat() and strcpy()" "SECID281"
37565 These are used only in cases where the output buffer is known to be large
37566 enough to hold the result.
37567 .ecindex IIDsecurcon
37568
37569
37570
37571
37572 . ////////////////////////////////////////////////////////////////////////////
37573 . ////////////////////////////////////////////////////////////////////////////
37574
37575 .chapter "Format of spool files" "CHAPspool"
37576 .scindex IIDforspo1 "format" "spool files"
37577 .scindex IIDforspo2 "spool directory" "format of files"
37578 .scindex IIDforspo3 "spool files" "format of"
37579 .cindex "spool files" "editing"
37580 A message on Exim's queue consists of two files, whose names are the message id
37581 followed by -D and -H, respectively. The data portion of the message is kept in
37582 the -D file on its own. The message's envelope, status, and headers are all
37583 kept in the -H file, whose format is described in this chapter. Each of these
37584 two files contains the final component of its own name as its first line. This
37585 is insurance against disk crashes where the directory is lost but the files
37586 themselves are recoverable.
37587
37588 Some people are tempted into editing -D files in order to modify messages. You
37589 need to be extremely careful if you do this; it is not recommended and you are
37590 on your own if you do it. Here are some of the pitfalls:
37591
37592 .ilist
37593 You must ensure that Exim does not try to deliver the message while you are
37594 fiddling with it. The safest way is to take out a write lock on the -D file,
37595 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37596 place, the lock will be retained. If you write a new file and rename it, the
37597 lock will be lost at the instant of rename.
37598 .next
37599 .vindex "&$body_linecount$&"
37600 If you change the number of lines in the file, the value of
37601 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37602 present, this value is not used by Exim, but there is no guarantee that this
37603 will always be the case.
37604 .next
37605 If the message is in MIME format, you must take care not to break it.
37606 .next
37607 If the message is cryptographically signed, any change will invalidate the
37608 signature.
37609 .endlist
37610 All in all, modifying -D files is fraught with danger.
37611
37612 Files whose names end with -J may also be seen in the &_input_& directory (or
37613 its subdirectories when &%split_spool_directory%& is set). These are journal
37614 files, used to record addresses to which the message has been delivered during
37615 the course of a delivery attempt. If there are still undelivered recipients at
37616 the end, the -H file is updated, and the -J file is deleted. If, however, there
37617 is some kind of crash (for example, a power outage) before this happens, the -J
37618 file remains in existence. When Exim next processes the message, it notices the
37619 -J file and uses it to update the -H file before starting the next delivery
37620 attempt.
37621
37622 .section "Format of the -H file" "SECID282"
37623 .cindex "uid (user id)" "in spool file"
37624 .cindex "gid (group id)" "in spool file"
37625 The second line of the -H file contains the login name for the uid of the
37626 process that called Exim to read the message, followed by the numerical uid and
37627 gid. For a locally generated message, this is normally the user who sent the
37628 message. For a message received over TCP/IP via the daemon, it is
37629 normally the Exim user.
37630
37631 The third line of the file contains the address of the message's sender as
37632 transmitted in the envelope, contained in angle brackets. The sender address is
37633 empty for bounce messages. For incoming SMTP mail, the sender address is given
37634 in the MAIL command. For locally generated mail, the sender address is
37635 created by Exim from the login name of the current user and the configured
37636 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37637 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37638 &"<>"& or an address that matches &%untrusted_set_senders%&.
37639
37640 The fourth line contains two numbers. The first is the time that the message
37641 was received, in the conventional Unix form &-- the number of seconds since the
37642 start of the epoch. The second number is a count of the number of messages
37643 warning of delayed delivery that have been sent to the sender.
37644
37645 There follow a number of lines starting with a hyphen. These can appear in any
37646 order, and are omitted when not relevant:
37647
37648 .vlist
37649 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37650 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37651 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37652 recognized, to provide backward compatibility. In the old format, a line of
37653 this form is present for every ACL variable that is not empty. The number
37654 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37655 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37656 the data string for the variable. The string itself starts at the beginning of
37657 the next line, and is followed by a newline character. It may contain internal
37658 newlines.
37659
37660 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37661 A line of this form is present for every ACL connection variable that is
37662 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37663 The length is the length of the data string for the variable. The string itself
37664 starts at the beginning of the next line, and is followed by a newline
37665 character. It may contain internal newlines.
37666
37667 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37668 A line of this form is present for every ACL message variable that is defined.
37669 Note that there is a space between &%-aclm%& and the rest of the name. The
37670 length is the length of the data string for the variable. The string itself
37671 starts at the beginning of the next line, and is followed by a newline
37672 character. It may contain internal newlines.
37673
37674 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37675 This is present if, when the message was received over SMTP, the value of
37676 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37677
37678 .vitem &%-allow_unqualified_recipient%&
37679 This is present if unqualified recipient addresses are permitted in header
37680 lines (to stop such addresses from being qualified if rewriting occurs at
37681 transport time). Local messages that were input using &%-bnq%& and remote
37682 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37683
37684 .vitem &%-allow_unqualified_sender%&
37685 This is present if unqualified sender addresses are permitted in header lines
37686 (to stop such addresses from being qualified if rewriting occurs at transport
37687 time). Local messages that were input using &%-bnq%& and remote messages from
37688 hosts that match &%sender_unqualified_hosts%& set this flag.
37689
37690 .vitem "&%-auth_id%&&~<&'text'&>"
37691 The id information for a message received on an authenticated SMTP connection
37692 &-- the value of the &$authenticated_id$& variable.
37693
37694 .vitem "&%-auth_sender%&&~<&'address'&>"
37695 The address of an authenticated sender &-- the value of the
37696 &$authenticated_sender$& variable.
37697
37698 .vitem "&%-body_linecount%&&~<&'number'&>"
37699 This records the number of lines in the body of the message, and is always
37700 present.
37701
37702 .vitem "&%-body_zerocount%&&~<&'number'&>"
37703 This records the number of binary zero bytes in the body of the message, and is
37704 present if the number is greater than zero.
37705
37706 .vitem &%-deliver_firsttime%&
37707 This is written when a new message is first added to the spool. When the spool
37708 file is updated after a deferral, it is omitted.
37709
37710 .vitem "&%-frozen%&&~<&'time'&>"
37711 .cindex "frozen messages" "spool data"
37712 The message is frozen, and the freezing happened at <&'time'&>.
37713
37714 .vitem "&%-helo_name%&&~<&'text'&>"
37715 This records the host name as specified by a remote host in a HELO or EHLO
37716 command.
37717
37718 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37719 This records the IP address of the host from which the message was received and
37720 the remote port number that was used. It is omitted for locally generated
37721 messages.
37722
37723 .vitem "&%-host_auth%&&~<&'text'&>"
37724 If the message was received on an authenticated SMTP connection, this records
37725 the name of the authenticator &-- the value of the
37726 &$sender_host_authenticated$& variable.
37727
37728 .vitem &%-host_lookup_failed%&
37729 This is present if an attempt to look up the sending host's name from its IP
37730 address failed. It corresponds to the &$host_lookup_failed$& variable.
37731
37732 .vitem "&%-host_name%&&~<&'text'&>"
37733 .cindex "reverse DNS lookup"
37734 .cindex "DNS" "reverse lookup"
37735 This records the name of the remote host from which the message was received,
37736 if the host name was looked up from the IP address when the message was being
37737 received. It is not present if no reverse lookup was done.
37738
37739 .vitem "&%-ident%&&~<&'text'&>"
37740 For locally submitted messages, this records the login of the originating user,
37741 unless it was a trusted user and the &%-oMt%& option was used to specify an
37742 ident value. For messages received over TCP/IP, this records the ident string
37743 supplied by the remote host, if any.
37744
37745 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37746 This records the IP address of the local interface and the port number through
37747 which a message was received from a remote host. It is omitted for locally
37748 generated messages.
37749
37750 .vitem &%-local%&
37751 The message is from a local sender.
37752
37753 .vitem &%-localerror%&
37754 The message is a locally-generated bounce message.
37755
37756 .vitem "&%-local_scan%&&~<&'string'&>"
37757 This records the data string that was returned by the &[local_scan()]& function
37758 when the message was received &-- the value of the &$local_scan_data$&
37759 variable. It is omitted if no data was returned.
37760
37761 .vitem &%-manual_thaw%&
37762 The message was frozen but has been thawed manually, that is, by an explicit
37763 Exim command rather than via the auto-thaw process.
37764
37765 .vitem &%-N%&
37766 A testing delivery process was started using the &%-N%& option to suppress any
37767 actual deliveries, but delivery was deferred. At any further delivery attempts,
37768 &%-N%& is assumed.
37769
37770 .vitem &%-received_protocol%&
37771 This records the value of the &$received_protocol$& variable, which contains
37772 the name of the protocol by which the message was received.
37773
37774 .vitem &%-sender_set_untrusted%&
37775 The envelope sender of this message was set by an untrusted local caller (used
37776 to ensure that the caller is displayed in queue listings).
37777
37778 .vitem "&%-spam_score_int%&&~<&'number'&>"
37779 If a message was scanned by SpamAssassin, this is present. It records the value
37780 of &$spam_score_int$&.
37781
37782 .vitem &%-tls_certificate_verified%&
37783 A TLS certificate was received from the client that sent this message, and the
37784 certificate was verified by the server.
37785
37786 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37787 When the message was received over an encrypted connection, this records the
37788 name of the cipher suite that was used.
37789
37790 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37791 When the message was received over an encrypted connection, and a certificate
37792 was received from the client, this records the Distinguished Name from that
37793 certificate.
37794 .endlist
37795
37796 Following the options there is a list of those addresses to which the message
37797 is not to be delivered. This set of addresses is initialized from the command
37798 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37799 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37800 the address is added to this set. The addresses are kept internally as a
37801 balanced binary tree, and it is a representation of that tree which is written
37802 to the spool file. If an address is expanded via an alias or forward file, the
37803 original address is added to the tree when deliveries to all its child
37804 addresses are complete.
37805
37806 If the tree is empty, there is a single line in the spool file containing just
37807 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37808 Y or N, followed by an address. The address is the value for the node of the
37809 tree, and the letters indicate whether the node has a left branch and/or a
37810 right branch attached to it, respectively. If branches exist, they immediately
37811 follow. Here is an example of a three-node tree:
37812 .code
37813 YY darcy@austen.fict.example
37814 NN alice@wonderland.fict.example
37815 NN editor@thesaurus.ref.example
37816 .endd
37817 After the non-recipients tree, there is a list of the message's recipients.
37818 This is a simple list, preceded by a count. It includes all the original
37819 recipients of the message, including those to whom the message has already been
37820 delivered. In the simplest case, the list contains one address per line. For
37821 example:
37822 .code
37823 4
37824 editor@thesaurus.ref.example
37825 darcy@austen.fict.example
37826 rdo@foundation
37827 alice@wonderland.fict.example
37828 .endd
37829 However, when a child address has been added to the top-level addresses as a
37830 result of the use of the &%one_time%& option on a &(redirect)& router, each
37831 line is of the following form:
37832 .display
37833 <&'top-level address'&> <&'errors_to address'&> &&&
37834   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37835 .endd
37836 The 01 flag bit indicates the presence of the three other fields that follow
37837 the top-level address. Other bits may be used in future to support additional
37838 fields. The <&'parent number'&> is the offset in the recipients list of the
37839 original parent of the &"one time"& address. The first two fields are the
37840 envelope sender that is associated with this address and its length. If the
37841 length is zero, there is no special envelope sender (there are then two space
37842 characters in the line). A non-empty field can arise from a &(redirect)& router
37843 that has an &%errors_to%& setting.
37844
37845
37846 A blank line separates the envelope and status information from the headers
37847 which follow. A header may occupy several lines of the file, and to save effort
37848 when reading it in, each header is preceded by a number and an identifying
37849 character. The number is the number of characters in the header, including any
37850 embedded newlines and the terminating newline. The character is one of the
37851 following:
37852
37853 .table2 50pt
37854 .row <&'blank'&>         "header in which Exim has no special interest"
37855 .row &`B`&               "&'Bcc:'& header"
37856 .row &`C`&               "&'Cc:'& header"
37857 .row &`F`&               "&'From:'& header"
37858 .row &`I`&               "&'Message-id:'& header"
37859 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37860 .row &`R`&               "&'Reply-To:'& header"
37861 .row &`S`&               "&'Sender:'& header"
37862 .row &`T`&               "&'To:'& header"
37863 .row &`*`&               "replaced or deleted header"
37864 .endtable
37865
37866 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37867 purposes. They are not transmitted when the message is delivered. Here is a
37868 typical set of headers:
37869 .code
37870 111P Received: by hobbit.fict.example with local (Exim 4.00)
37871 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37872 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37873 038* X-rewrote-sender: bb@hobbit.fict.example
37874 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37875 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37876 099* To: alice@wonderland.fict.example, rdo@foundation,
37877 darcy@austen.fict.example, editor@thesaurus.ref.example
37878 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37879 darcy@austen.fict.example, editor@thesaurus.ref.example
37880 038  Date: Fri, 11 May 2001 10:28:59 +0100
37881 .endd
37882 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37883 &'To:'& header have been rewritten, the last one because routing expanded the
37884 unqualified domain &'foundation'&.
37885 .ecindex IIDforspo1
37886 .ecindex IIDforspo2
37887 .ecindex IIDforspo3
37888
37889 . ////////////////////////////////////////////////////////////////////////////
37890 . ////////////////////////////////////////////////////////////////////////////
37891
37892 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37893          "DKIM Support"
37894 .cindex "DKIM"
37895
37896 DKIM is a mechanism by which messages sent by some entity can be provably
37897 linked to a domain which that entity controls.  It permits reputation to
37898 be tracked on a per-domain basis, rather than merely upon source IP address.
37899 DKIM is documented in RFC 4871.
37900
37901 DKIM support is compiled into Exim by default if TLS support is present.
37902 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
37903
37904 Exim's DKIM implementation allows to
37905 .olist
37906 Sign outgoing messages: This function is implemented in the SMTP transport.
37907 It can co-exist with all other Exim features
37908 (including transport filters)
37909 except cutthrough delivery.
37910 .next
37911 Verify signatures in incoming messages: This is implemented by an additional
37912 ACL (acl_smtp_dkim), which can be called several times per message, with
37913 different signature contexts.
37914 .endlist
37915
37916 In typical Exim style, the verification implementation does not include any
37917 default "policy". Instead it enables you to build your own policy using
37918 Exim's standard controls.
37919
37920 Please note that verification of DKIM signatures in incoming mail is turned
37921 on by default for logging purposes. For each signature in incoming email,
37922 exim will log a line displaying the most important signature details, and the
37923 signature status. Here is an example (with line-breaks added for clarity):
37924 .code
37925 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37926     d=facebookmail.com s=q1-2009b
37927     c=relaxed/relaxed a=rsa-sha1
37928     i=@facebookmail.com t=1252484542 [verification succeeded]
37929 .endd
37930 You might want to turn off DKIM verification processing entirely for internal
37931 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37932 control modifier. This should typically be done in the RCPT ACL, at points
37933 where you accept mail from relay sources (internal hosts or authenticated
37934 senders).
37935
37936
37937 .section "Signing outgoing messages" "SECDKIMSIGN"
37938 .cindex "DKIM" "signing"
37939
37940 Signing is implemented by setting private options on the SMTP transport.
37941 These options take (expandable) strings as arguments.
37942
37943 .option dkim_domain smtp string&!! unset
37944 MANDATORY:
37945 The domain you want to sign with. The result of this expanded
37946 option is put into the &%$dkim_domain%& expansion variable.
37947
37948 .option dkim_selector smtp string&!! unset
37949 MANDATORY:
37950 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37951 variable to look up a matching selector. The result is put in the expansion
37952 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
37953 option along with &%$dkim_domain%&.
37954
37955 .option dkim_private_key smtp string&!! unset
37956 MANDATORY:
37957 This sets the private key to use. You can use the &%$dkim_domain%& and
37958 &%$dkim_selector%& expansion variables to determine the private key to use.
37959 The result can either
37960 .ilist
37961 be a valid RSA private key in ASCII armor, including line breaks.
37962 .next
37963 start with a slash, in which case it is treated as a file that contains
37964 the private key.
37965 .next
37966 be "0", "false" or the empty string, in which case the message will not
37967 be signed. This case will not result in an error, even if &%dkim_strict%&
37968 is set.
37969 .endlist
37970
37971 .option dkim_canon smtp string&!! unset
37972 OPTIONAL:
37973 This option sets the canonicalization method used when signing a message.
37974 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37975 The option defaults to "relaxed" when unset. Note: the current implementation
37976 only supports using the same canonicalization method for both headers and body.
37977
37978 .option dkim_strict smtp string&!! unset
37979 OPTIONAL:
37980 This  option  defines  how  Exim  behaves  when  signing a message that
37981 should be signed fails for some reason.  When the expansion evaluates to
37982 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37983 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37984 variables here.
37985
37986 .option dkim_sign_headers smtp string&!! unset
37987 OPTIONAL:
37988 When set, this option must expand to (or be specified as) a colon-separated
37989 list of header names. Headers with these names will be included in the message
37990 signature. When unspecified, the header names recommended in RFC4871 will be
37991 used.
37992
37993
37994 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37995 .cindex "DKIM" "verification"
37996
37997 Verification of DKIM signatures in incoming email is implemented via the
37998 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37999 syntactically(!) correct signature in the incoming message.
38000 A missing ACL definition defaults to accept.
38001 If any ACL call does not accept, the message is not accepted.
38002 If a cutthrough delivery was in progress for the message it is
38003 summarily dropped (having wasted the transmission effort).
38004
38005 To evaluate the signature in the ACL a large number of expansion variables
38006 containing the signature status and its details are set up during the
38007 runtime of the ACL.
38008
38009 Calling the ACL only for existing signatures is not sufficient to build
38010 more advanced policies. For that reason, the global option
38011 &%dkim_verify_signers%&, and a global expansion variable
38012 &%$dkim_signers%& exist.
38013
38014 The global option &%dkim_verify_signers%& can be set to a colon-separated
38015 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38016 called. It is expanded when the message has been received. At this point,
38017 the expansion variable &%$dkim_signers%& already contains a colon-separated
38018 list of signer domains and identities for the message. When
38019 &%dkim_verify_signers%& is not specified in the main configuration,
38020 it defaults as:
38021 .code
38022 dkim_verify_signers = $dkim_signers
38023 .endd
38024 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38025 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38026 call the ACL for known domains or identities. This would be achieved as follows:
38027 .code
38028 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38029 .endd
38030 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38031 and "ebay.com", plus all domains and identities that have signatures in the message.
38032 You can also be more creative in constructing your policy. For example:
38033 .code
38034 dkim_verify_signers = $sender_address_domain:$dkim_signers
38035 .endd
38036
38037 If a domain or identity is listed several times in the (expanded) value of
38038 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38039
38040
38041 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38042 available (from most to least important):
38043
38044
38045 .vlist
38046 .vitem &%$dkim_cur_signer%&
38047 The signer that is being evaluated in this ACL run. This can be a domain or
38048 an identity. This is one of the list items from the expanded main option
38049 &%dkim_verify_signers%& (see above).
38050 .vitem &%$dkim_verify_status%&
38051 A string describing the general status of the signature. One of
38052 .ilist
38053 &%none%&: There is no signature in the message for the current domain or
38054 identity (as reflected by &%$dkim_cur_signer%&).
38055 .next
38056 &%invalid%&: The signature could not be verified due to a processing error.
38057 More detail is available in &%$dkim_verify_reason%&.
38058 .next
38059 &%fail%&: Verification of the signature failed.  More detail is
38060 available in &%$dkim_verify_reason%&.
38061 .next
38062 &%pass%&: The signature passed verification. It is valid.
38063 .endlist
38064 .vitem &%$dkim_verify_reason%&
38065 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38066 "fail" or "invalid". One of
38067 .ilist
38068 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38069 key for the domain could not be retrieved. This may be a temporary problem.
38070 .next
38071 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38072 record for the domain is syntactically invalid.
38073 .next
38074 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38075 body hash does not match the one specified in the signature header. This
38076 means that the message body was modified in transit.
38077 .next
38078 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38079 could not be verified. This may mean that headers were modified,
38080 re-written or otherwise changed in a way which is incompatible with
38081 DKIM verification. It may of course also mean that the signature is forged.
38082 .endlist
38083 .vitem &%$dkim_domain%&
38084 The signing domain. IMPORTANT: This variable is only populated if there is
38085 an actual signature in the message for the current domain or identity (as
38086 reflected by &%$dkim_cur_signer%&).
38087 .vitem &%$dkim_identity%&
38088 The signing identity, if present. IMPORTANT: This variable is only populated
38089 if there is an actual signature in the message for the current domain or
38090 identity (as reflected by &%$dkim_cur_signer%&).
38091 .vitem &%$dkim_selector%&
38092 The key record selector string.
38093 .vitem &%$dkim_algo%&
38094 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38095 .vitem &%$dkim_canon_body%&
38096 The body canonicalization method. One of 'relaxed' or 'simple'.
38097 .vitem &%dkim_canon_headers%&
38098 The header canonicalization method. One of 'relaxed' or 'simple'.
38099 .vitem &%$dkim_copiedheaders%&
38100 A transcript of headers and their values which are included in the signature
38101 (copied from the 'z=' tag of the signature).
38102 .vitem &%$dkim_bodylength%&
38103 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38104 limit was set by the signer, "9999999999999" is returned. This makes sure
38105 that this variable always expands to an integer value.
38106 .vitem &%$dkim_created%&
38107 UNIX timestamp reflecting the date and time when the signature was created.
38108 When this was not specified by the signer, "0" is returned.
38109 .vitem &%$dkim_expires%&
38110 UNIX timestamp reflecting the date and time when the signer wants the
38111 signature to be treated as "expired". When this was not specified by the
38112 signer, "9999999999999" is returned. This makes it possible to do useful
38113 integer size comparisons against this value.
38114 .vitem &%$dkim_headernames%&
38115 A colon-separated list of names of headers included in the signature.
38116 .vitem &%$dkim_key_testing%&
38117 "1" if the key record has the "testing" flag set, "0" if not.
38118 .vitem &%$dkim_key_nosubdomains%&
38119 "1" if the key record forbids subdomaining, "0" otherwise.
38120 .vitem &%$dkim_key_srvtype%&
38121 Service type (tag s=) from the key record. Defaults to "*" if not specified
38122 in the key record.
38123 .vitem &%$dkim_key_granularity%&
38124 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38125 in the key record.
38126 .vitem &%$dkim_key_notes%&
38127 Notes from the key record (tag n=).
38128 .vitem &%$dkim_key_length%&
38129 Number of bits in the key.
38130 .endlist
38131
38132 In addition, two ACL conditions are provided:
38133
38134 .vlist
38135 .vitem &%dkim_signers%&
38136 ACL condition that checks a colon-separated list of domains or identities
38137 for a match against the domain or identity that the ACL is currently verifying
38138 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38139 verb to a group of domains or identities. For example:
38140
38141 .code
38142 # Warn when Mail purportedly from GMail has no signature at all
38143 warn log_message = GMail sender without DKIM signature
38144      sender_domains = gmail.com
38145      dkim_signers = gmail.com
38146      dkim_status = none
38147 .endd
38148
38149 .vitem &%dkim_status%&
38150 ACL condition that checks a colon-separated list of possible DKIM verification
38151 results against the actual result of verification. This is typically used
38152 to restrict an ACL verb to a list of verification outcomes, for example:
38153
38154 .code
38155 deny message = Mail from Paypal with invalid/missing signature
38156      sender_domains = paypal.com:paypal.de
38157      dkim_signers = paypal.com:paypal.de
38158      dkim_status = none:invalid:fail
38159 .endd
38160
38161 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38162 see the documentation of the &%$dkim_verify_status%& expansion variable above
38163 for more information of what they mean.
38164 .endlist
38165
38166 . ////////////////////////////////////////////////////////////////////////////
38167 . ////////////////////////////////////////////////////////////////////////////
38168
38169 .chapter "Proxies" "CHAPproxies" &&&
38170          "Proxy support"
38171 .cindex "proxy support"
38172 .cindex "proxy" "access via"
38173
38174 A proxy is an intermediate system through which communication is passed.
38175 Proxies may provide a security, availability or load-distribution function.
38176
38177
38178 .section "Inbound proxies" SECTproxyInbound
38179 .cindex proxy inbound
38180 .cindex proxy "server side"
38181 .cindex proxy "Proxy protocol"
38182 .cindex "Proxy protocol" proxy
38183
38184 Exim has support for receiving inbound SMTP connections via a proxy
38185 that uses &"Proxy Protocol"& to speak to it.
38186 To include this support, include &"SUPPORT_PROXY=yes"&
38187 in Local/Makefile.
38188
38189 It was built on specifications from:
38190 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38191 That URL was revised in May 2014 to version 2 spec:
38192 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38193
38194 The purpose of this facility is so that an application load balancer,
38195 such as HAProxy, can sit in front of several Exim servers
38196 to distribute load.
38197 Exim uses the local protocol communication with the proxy to obtain
38198 the remote SMTP system IP address and port information.
38199 There is no logging if a host passes or
38200 fails Proxy Protocol negotiation, but it can easily be determined and
38201 recorded in an ACL (example is below).
38202
38203 Use of a proxy is enabled by setting the &%hosts_proxy%&
38204 main configuration option to a hostlist; connections from these
38205 hosts will use Proxy Protocol.
38206
38207 The following expansion variables are usable
38208 (&"internal"& and &"external"& here refer to the interfaces
38209 of the proxy):
38210 .display
38211 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38212 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38213 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38214 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38215 &'proxy_session        '& boolean: SMTP connection via proxy
38216 .endd
38217 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38218 there was a protocol error.
38219
38220 Since the real connections are all coming from the proxy, and the
38221 per host connection tracking is done before Proxy Protocol is
38222 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38223 handle all of the parallel volume you expect per inbound proxy.
38224 With the option set so high, you lose the ability
38225 to protect your server from many connections from one IP.
38226 In order to prevent your server from overload, you
38227 need to add a per connection ratelimit to your connect ACL.
38228 A possible solution is:
38229 .display
38230   # Set max number of connections per host
38231   LIMIT   = 5
38232   # Or do some kind of IP lookup in a flat file or database
38233   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38234
38235   defer   message        = Too many connections from this IP right now
38236           ratelimit      = LIMIT / 5s / per_conn / strict
38237 .endd
38238
38239
38240
38241 .section "Outbound proxies" SECTproxySOCKS
38242 .cindex proxy outbound
38243 .cindex proxy "client side"
38244 .cindex proxy SOCKS
38245 .cindex SOCKS proxy
38246 Exim has support for sending outbound SMTP via a proxy
38247 using a protocol called SOCKS5 (defined by RFC1928).
38248 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38249 Local/Makefile.
38250
38251 Use of a proxy is enabled by setting the &%socks_proxy%& option
38252 on an smtp transport.
38253 The option value is expanded and should then be a list
38254 (colon-separated by default) of proxy specifiers.
38255 Each proxy specifier is a list
38256 (space-separated by default) where the initial element
38257 is an IP address and any subsequent elements are options.
38258
38259 Options are a string <name>=<value>.
38260 The list of options is in the following table:
38261 .display
38262 &'auth   '& authentication method
38263 &'name   '& authentication username
38264 &'pass   '& authentication password
38265 &'port   '& tcp port
38266 &'tmo    '& connection timeout
38267 &'pri    '& priority
38268 &'weight '& selection bias
38269 .endd
38270
38271 More details on each of these options follows:
38272
38273 .ilist
38274 .cindex authentication "to proxy"
38275 .cindex proxy authentication
38276 &%auth%&: Either &"none"& (default) or &"name"&.
38277 Using &"name"& selects username/password authentication per RFC 1929
38278 for access to the proxy.
38279 Default is &"none"&.
38280 .next
38281 &%name%&: sets the username for the &"name"& authentication method.
38282 Default is empty.
38283 .next
38284 &%pass%&: sets the password for the &"name"& authentication method.
38285 Default is empty.
38286 .next
38287 &%port%&: the TCP port number to use for the connection to the proxy.
38288 Default is 1080.
38289 .next
38290 &%tmo%&: sets a connection timeout in seconds for this proxy.
38291 Default is 5.
38292 .next
38293 &%pri%&: specifies a priority for the proxy within the list,
38294 higher values being tried first.
38295 The default priority is 1.
38296 .next
38297 &%weight%&: specifies a selection bias.
38298 Within a priority set servers are queried in a random fashion,
38299 weighted by this value.
38300 The default value for selection bias is 1.
38301 .endlist
38302
38303 Proxies from the list are tried according to their priority
38304 and weight settings until one responds.  The timeout for the
38305 overall connection applies to the set of proxied attempts.
38306
38307 .section Logging SECTproxyLog
38308 To log the (local) IP of a proxy in the incoming or delivery logline,
38309 add &"+proxy"& to the &%log_selector%& option.
38310 This will add a component tagged with &"PRX="& to the line.
38311
38312 . ////////////////////////////////////////////////////////////////////////////
38313 . ////////////////////////////////////////////////////////////////////////////
38314
38315 .chapter "Internationalisation" "CHAPi18n" &&&
38316          "Internationalisation""
38317 .cindex internationalisation "email address"
38318 .cindex EAI
38319 .cindex i18n
38320 .cindex UTF-8 "mail name handling"
38321
38322 Exim has support for Internationalised mail names.
38323 To include this it must be built with SUPPORT_I18N and the libidn library.
38324 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38325
38326 .section "MTA operations" SECTi18nMTA
38327 .cindex SMTPUTF8 "ESMTP option"
38328 The main configuration option &%smtputf8_advertise_hosts%& specifies
38329 a host list.  If this matches the sending host and
38330 accept_8bitmime is true (the default) then the ESMTP option
38331 SMTPUTF8 will be advertised.
38332
38333 If the sender specifies the SMTPUTF8 option on a MAIL command
38334 international handling for the message is enabled and
38335 the expansion variable &$message_smtputf8$& will have value TRUE.
38336
38337 The option &%allow_utf8_domains%& is set to true for this
38338 message. All DNS lookups are converted to a-label form
38339 whatever the setting of &%allow_utf8_domains%&
38340 when Exim is built with SUPPORT_I18N.
38341
38342 Both localparts and domain are maintained as the original
38343 UTF-8 form internally; any comparison or regular-expression use will
38344 require appropriate care.  Filenames created, eg. by
38345 the appendfile transport, will have UTF-8 names.
38346
38347 HELO names sent by the smtp transport will have any UTF-8
38348 components expanded to a-label form,
38349 and any certificate name checks will be done using the a-label
38350 form of the name.
38351
38352 .cindex log protocol
38353 .cindex SMTPUTF8 logging
38354 Log lines and Received-by: header lines will acquire a "utf8"
38355 prefix on the protocol element, eg. utf8esmtp.
38356
38357 The following expansion operator can be used:
38358 .code
38359 ${utf8_domain_to_alabel:str}
38360 ${utf8_domain_from_alabel:str}
38361 ${utf8_localpart_to_alabel:str}
38362 ${utf8_localpart_from_alabel:str}
38363 .endd
38364
38365 ACLs may use the following modifier:
38366 .display
38367 control = utf8_downconvert
38368 control = utf8_downconvert/<value>
38369 .endd
38370 This sets a flag requiring that addresses are converted to
38371 a-label form before smtp delivery, for use in a
38372 Message Submission Agent context.
38373 If a value is appended it may be:
38374 .display
38375 &`1  `& (default) mandatory downconversion
38376 &`0  `& no downconversion
38377 &`-1 `& if SMTPUTF8 not supported by destination host
38378 .endd
38379
38380 If mua_wrapper is set, the utf8_downconvert control
38381 is initially set to -1.
38382
38383
38384 There is no explicit support for VRFY and EXPN.
38385 Configurations supporting these should inspect
38386 &$smtp_command_argument$& for an SMTPUTF8 argument.
38387
38388 There is no support for LMTP on Unix sockets.
38389 Using the "lmtp" protocol option on an smtp transport,
38390 for LMTP over TCP, should work as expected.
38391
38392 There is no support for DSN unitext handling,
38393 and no provision for converting logging from or to UTF-8.
38394
38395
38396
38397 .section "MDA operations" SECTi18nMDA
38398 To aid in constructing names suitable for IMAP folders
38399 the following expansion operator can be used:
38400 .code
38401 ${imapfolder {<string>} {<sep>} {<specials>}}
38402 .endd
38403
38404 The string is converted from the charset specified by
38405 the "headers charset" command (in a filter file)
38406 or &%headers_charset%& main configuration option (otherwise),
38407 to the
38408 modified UTF-7 encoding specified by RFC 2060,
38409 with the following exception: All occurences of <sep>
38410 (which has to be a single character)
38411 are replaced with periods ("."), and all periods and slashes that are not
38412 <sep> and are not in the <specials> string are BASE64 encoded.
38413
38414 The third argument can be omitted, defaulting to an empty string.
38415 The second argument can be omitted, defaulting to "/".
38416
38417 This is the encoding used by Courier for Maildir names on disk, and followed
38418 by many other IMAP servers.
38419
38420 Examples:
38421 .display
38422 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38423 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38424 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38425 .endd
38426
38427 Note that the source charset setting is vital, and also that characters
38428 must be representable in UTF-16.
38429
38430
38431 . ////////////////////////////////////////////////////////////////////////////
38432 . ////////////////////////////////////////////////////////////////////////////
38433
38434 .chapter "Events" "CHAPevents" &&&
38435          "Events"
38436 .cindex events
38437
38438 The events mechanism in Exim can be used to intercept processing at a number
38439 of points.  It was originally invented to giave a way to do customised logging
38440 actions (for example, to a database) but can also be used to modify some
38441 processing actions.
38442
38443 Most installations will never need to use Events.
38444 The support can be left out of a build by defining DISABLE_EVENT=yes
38445 in &_Local/Makefile_&.
38446
38447 There are two major classes of events: main and transport.
38448 The main configuration option &%event_action%& controls reception events;
38449 a transport option &%event_action%& controls delivery events.
38450
38451 Both options are a string which is expanded when the event fires.
38452 An example might look like:
38453 .cindex logging custom
38454 .code
38455 event_action = ${if eq {msg:delivery}{$event_name} \
38456 {${lookup pgsql {SELECT * FROM record_Delivery( \
38457     '${quote_pgsql:$sender_address_domain}',\
38458     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38459     '${quote_pgsql:$domain}', \
38460     '${quote_pgsql:${lc:$local_part}}', \
38461     '${quote_pgsql:$host_address}', \
38462     '${quote_pgsql:${lc:$host}}', \
38463     '${quote_pgsql:$message_exim_id}')}} \
38464 } {}}
38465 .endd
38466
38467 Events have names which correspond to the point in process at which they fire.
38468 The name is placed in the variable &$event_name$& and the event action
38469 expansion must check this, as it will be called for every possible event type.
38470
38471 The current list of events is:
38472 .display
38473 &`msg:complete           after    main       `& per message
38474 &`msg:delivery           after    transport  `& per recipient
38475 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38476 &`msg:rcpt:defer         after    transport  `& per recipient
38477 &`msg:host:defer         after    transport  `& per attempt
38478 &`msg:fail:delivery      after    main       `& per recipient
38479 &`msg:fail:internal      after    main       `& per recipient
38480 &`tcp:connect            before   transport  `& per connection
38481 &`tcp:close              after    transport  `& per connection
38482 &`tls:cert               before   both       `& per certificate in verification chain
38483 &`smtp:connect           after    transport  `& per connection
38484 .endd
38485 New event types may be added in future.
38486
38487 The event name is a colon-separated list, defining the type of
38488 event in a tree of possibilities.  It may be used as a list
38489 or just matched on as a whole.  There will be no spaces in the name.
38490
38491 The second column in the table above describes whether the event fires
38492 before or after the action is associates with.  Those which fire before
38493 can be used to affect that action (more on this below).
38494
38495 An additional variable, &$event_data$&, is filled with information varying
38496 with the event type:
38497 .display
38498 &`msg:delivery         `& smtp confirmation mssage
38499 &`msg:rcpt:host:defer  `& error string
38500 &`msg:rcpt:defer       `& error string
38501 &`msg:host:defer       `& error string
38502 &`tls:cert             `& verification chain depth
38503 &`smtp:connect         `& smtp banner
38504 .endd
38505
38506 The :defer events populate one extra variable: &$event_defer_errno$&.
38507
38508 For complex operations an ACL expansion can be used in &%event_action%&
38509 however due to the multiple contextx that Exim operates in during
38510 the course of its processing:
38511 .ilist
38512 variables set in transport events will not be visible outside that
38513 transport call
38514 .next
38515 acl_m variables in a server context are lost on a new connection,
38516 and after smtp helo/ehlo/mail/starttls/rset commands
38517 .endlist
38518 Using an ACL expansion with the logwrite modifier can be
38519 a useful way of writing to the main log.
38520
38521 The expansion of the event_action option should normally
38522 return an empty string.  Should it return anything else the
38523 following will be forced:
38524 .display
38525 &`msg:delivery     `&  (ignored)
38526 &`msg:host:defer   `&  (ignored)
38527 &`msg:fail:delivery`&  (ignored)
38528 &`tcp:connect      `&  do not connect
38529 &`tcp:close        `&  (ignored)
38530 &`tls:cert         `&  refuse verification
38531 &`smtp:connect     `&  close connection
38532 .endd
38533 No other use is made of the result string.
38534
38535 For a tcp:connect event, if the connection is being made to a proxy
38536 then the address and port variables will be that of the proxy and not
38537 the target system.
38538
38539 For tls:cert events, if GnuTLS is in use this will trigger only per
38540 chain element received on the connection.
38541 For OpenSSL it will trigger for every chain element including those
38542 loaded locally.
38543
38544 . ////////////////////////////////////////////////////////////////////////////
38545 . ////////////////////////////////////////////////////////////////////////////
38546
38547 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38548          "Adding drivers or lookups"
38549 .cindex "adding drivers"
38550 .cindex "new drivers, adding"
38551 .cindex "drivers" "adding new"
38552 The following actions have to be taken in order to add a new router, transport,
38553 authenticator, or lookup type to Exim:
38554
38555 .olist
38556 Choose a name for the driver or lookup type that does not conflict with any
38557 existing name; I will use &"newdriver"& in what follows.
38558 .next
38559 Add to &_src/EDITME_& the line:
38560 .display
38561 <&'type'&>&`_NEWDRIVER=yes`&
38562 .endd
38563 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38564 code is not to be included in the binary by default, comment this line out. You
38565 should also add any relevant comments about the driver or lookup type.
38566 .next
38567 Add to &_src/config.h.defaults_& the line:
38568 .code
38569 #define <type>_NEWDRIVER
38570 .endd
38571 .next
38572 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38573 and create a table entry as is done for all the other drivers and lookup types.
38574 .next
38575 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38576 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38577 Add your &`NEWDRIVER`& to that list.
38578 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38579 simple form that most lookups have.
38580 .next
38581 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38582 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38583 driver or lookup type and add it to the definition of OBJ.
38584 .next
38585 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38586 &_src_&.
38587 .next
38588 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38589 as for other drivers and lookups.
38590 .endlist
38591
38592 Then all you need to do is write the code! A good way to start is to make a
38593 proforma by copying an existing module of the same type, globally changing all
38594 occurrences of the name, and cutting out most of the code. Note that any
38595 options you create must be listed in alphabetical order, because the tables are
38596 searched using a binary chop procedure.
38597
38598 There is a &_README_& file in each of the sub-directories of &_src_& describing
38599 the interface that is expected.
38600
38601
38602
38603
38604 . ////////////////////////////////////////////////////////////////////////////
38605 . ////////////////////////////////////////////////////////////////////////////
38606
38607 . /////////////////////////////////////////////////////////////////////////////
38608 . These lines are processing instructions for the Simple DocBook Processor that
38609 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38610 . PDFs than using xmlto and fop. They will be ignored by all other XML
38611 . processors.
38612 . /////////////////////////////////////////////////////////////////////////////
38613
38614 .literal xml
38615 <?sdop
38616   format="newpage"
38617   foot_right_recto="&chaptertitle;"
38618   foot_right_verso="&chaptertitle;"
38619 ?>
38620 .literal off
38621
38622 .makeindex "Options index"   "option"
38623 .makeindex "Variables index" "variable"
38624 .makeindex "Concept index"   "concept"
38625
38626
38627 . /////////////////////////////////////////////////////////////////////////////
38628 . /////////////////////////////////////////////////////////////////////////////