Doc: clarify -n
[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.86"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2015
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 &$sender_domain$&) 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 .new
3561 Only macro names up to 22 letters long can be set.
3562 .wen
3563
3564
3565 .vitem &%-d%&<&'debug&~options'&>
3566 .oindex "&%-d%&"
3567 .cindex "debugging" "list of selectors"
3568 .cindex "debugging" "&%-d%& option"
3569 This option causes debugging information to be written to the standard
3570 error stream. It is restricted to admin users because debugging output may show
3571 database queries that contain password information. Also, the details of users'
3572 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3573 writes an error message to the standard error stream and exits with a non-zero
3574 return code.
3575
3576 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3577 standard debugging data is output. This can be reduced, or increased to include
3578 some more rarely needed information, by directly following &%-d%& with a string
3579 made up of names preceded by plus or minus characters. These add or remove sets
3580 of debugging data, respectively. For example, &%-d+filter%& adds filter
3581 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3582 no spaces are allowed in the debug setting. The available debugging categories
3583 are:
3584 .display
3585 &`acl            `& ACL interpretation
3586 &`auth           `& authenticators
3587 &`deliver        `& general delivery logic
3588 &`dns            `& DNS lookups (see also resolver)
3589 &`dnsbl          `& DNS black list (aka RBL) code
3590 &`exec           `& arguments for &[execv()]& calls
3591 &`expand         `& detailed debugging for string expansions
3592 &`filter         `& filter handling
3593 &`hints_lookup   `& hints data lookups
3594 &`host_lookup    `& all types of name-to-IP address handling
3595 &`ident          `& ident lookup
3596 &`interface      `& lists of local interfaces
3597 &`lists          `& matching things in lists
3598 &`load           `& system load checks
3599 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3600                     &<<CHAPlocalscan>>&)
3601 &`lookup         `& general lookup code and all lookups
3602 &`memory         `& memory handling
3603 &`pid            `& add pid to debug output lines
3604 &`process_info   `& setting info for the process log
3605 &`queue_run      `& queue runs
3606 &`receive        `& general message reception logic
3607 &`resolver       `& turn on the DNS resolver's debugging output
3608 &`retry          `& retry handling
3609 &`rewrite        `& address rewriting
3610 &`route          `& address routing
3611 &`timestamp      `& add timestamp to debug output lines
3612 &`tls            `& TLS logic
3613 &`transport      `& transports
3614 &`uid            `& changes of uid/gid and looking up uid/gid
3615 &`verify         `& address verification logic
3616 &`all            `& almost all of the above (see below), and also &%-v%&
3617 .endd
3618 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3619 for &`-all`&. The reason for this is that &`+all`& is something that people
3620 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3621 is included, an awful lot of output that is very rarely of interest is
3622 generated, so it now has to be explicitly requested. However, &`-all`& does
3623 turn everything off.
3624
3625 .cindex "resolver, debugging output"
3626 .cindex "DNS resolver, debugging output"
3627 The &`resolver`& option produces output only if the DNS resolver was compiled
3628 with DEBUG enabled. This is not the case in some operating systems. Also,
3629 unfortunately, debugging output from the DNS resolver is written to stdout
3630 rather than stderr.
3631
3632 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3633 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3634 However, the &`pid`& selector is forced when debugging is turned on for a
3635 daemon, which then passes it on to any re-executed Exims. Exim also
3636 automatically adds the pid to debug lines when several remote deliveries are
3637 run in parallel.
3638
3639 The &`timestamp`& selector causes the current time to be inserted at the start
3640 of all debug output lines. This can be useful when trying to track down delays
3641 in processing.
3642
3643 If the &%debug_print%& option is set in any driver, it produces output whenever
3644 any debugging is selected, or if &%-v%& is used.
3645
3646 .vitem &%-dd%&<&'debug&~options'&>
3647 .oindex "&%-dd%&"
3648 This option behaves exactly like &%-d%& except when used on a command that
3649 starts a daemon process. In that case, debugging is turned off for the
3650 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3651 behaviour of the daemon without creating as much output as full debugging does.
3652
3653 .vitem &%-dropcr%&
3654 .oindex "&%-dropcr%&"
3655 This is an obsolete option that is now a no-op. It used to affect the way Exim
3656 handled CR and LF characters in incoming messages. What happens now is
3657 described in section &<<SECTlineendings>>&.
3658
3659 .vitem &%-E%&
3660 .oindex "&%-E%&"
3661 .cindex "bounce message" "generating"
3662 This option specifies that an incoming message is a locally-generated delivery
3663 failure report. It is used internally by Exim when handling delivery failures
3664 and is not intended for external use. Its only effect is to stop Exim
3665 generating certain messages to the postmaster, as otherwise message cascades
3666 could occur in some situations. As part of the same option, a message id may
3667 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3668 new message contains the id, following &"R="&, as a cross-reference.
3669
3670 .vitem &%-e%&&'x'&
3671 .oindex "&%-e%&&'x'&"
3672 There are a number of Sendmail options starting with &%-oe%& which seem to be
3673 called by various programs without the leading &%o%& in the option. For
3674 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3675 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3676
3677 .vitem &%-F%&&~<&'string'&>
3678 .oindex "&%-F%&"
3679 .cindex "sender" "name"
3680 .cindex "name" "of sender"
3681 This option sets the sender's full name for use when a locally-generated
3682 message is being accepted. In the absence of this option, the user's &'gecos'&
3683 entry from the password data is used. As users are generally permitted to alter
3684 their &'gecos'& entries, no security considerations are involved. White space
3685 between &%-F%& and the <&'string'&> is optional.
3686
3687 .vitem &%-f%&&~<&'address'&>
3688 .oindex "&%-f%&"
3689 .cindex "sender" "address"
3690 .cindex "address" "sender"
3691 .cindex "trusted users"
3692 .cindex "envelope sender"
3693 .cindex "user" "trusted"
3694 This option sets the address of the envelope sender of a locally-generated
3695 message (also known as the return path). The option can normally be used only
3696 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3697 users to use it.
3698
3699 Processes running as root or the Exim user are always trusted. Other
3700 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3701 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3702 of a local message is set to the caller's login name at the default qualify
3703 domain.
3704
3705 There is one exception to the restriction on the use of &%-f%&: an empty sender
3706 can be specified by any user, trusted or not, to create a message that can
3707 never provoke a bounce. An empty sender can be specified either as an empty
3708 string, or as a pair of angle brackets with nothing between them, as in these
3709 examples of shell commands:
3710 .code
3711 exim -f '<>' user@domain
3712 exim -f "" user@domain
3713 .endd
3714 In addition, the use of &%-f%& is not restricted when testing a filter file
3715 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3716 &%-bv%& options.
3717
3718 Allowing untrusted users to change the sender address does not of itself make
3719 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3720 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3721 though this can be overridden by setting &%no_local_from_check%&.
3722
3723 White
3724 .cindex "&""From""& line"
3725 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3726 given as two arguments or one combined argument). The sender of a
3727 locally-generated message can also be set (when permitted) by an initial
3728 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3729 if &%-f%& is also present, it overrides &"From&~"&.
3730
3731 .vitem &%-G%&
3732 .oindex "&%-G%&"
3733 .cindex "submission fixups, suppressing (command-line)"
3734 This option is equivalent to an ACL applying:
3735 .code
3736 control = suppress_local_fixups
3737 .endd
3738 for every message received.  Note that Sendmail will complain about such
3739 bad formatting, where Exim silently just does not fix it up.  This may change
3740 in future.
3741
3742 As this affects audit information, the caller must be a trusted user to use
3743 this option.
3744
3745 .vitem &%-h%&&~<&'number'&>
3746 .oindex "&%-h%&"
3747 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3748 This option is accepted for compatibility with Sendmail, but has no effect. (In
3749 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3750 headers.)
3751
3752 .vitem &%-i%&
3753 .oindex "&%-i%&"
3754 .cindex "Solaris" "&'mail'& command"
3755 .cindex "dot" "in incoming non-SMTP message"
3756 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3757 line by itself should not terminate an incoming, non-SMTP message. I can find
3758 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3759 command in Solaris 2.4 uses it. See also &%-ti%&.
3760
3761 .vitem &%-L%&&~<&'tag'&>
3762 .oindex "&%-L%&"
3763 .cindex "syslog" "process name; set with flag"
3764 This option is equivalent to setting &%syslog_processname%& in the config
3765 file and setting &%log_file_path%& to &`syslog`&.
3766 Its use is restricted to administrators.  The configuration file has to be
3767 read and parsed, to determine access rights, before this is set and takes
3768 effect, so early configuration file errors will not honour this flag.
3769
3770 The tag should not be longer than 32 characters.
3771
3772 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3773 .oindex "&%-M%&"
3774 .cindex "forcing delivery"
3775 .cindex "delivery" "forcing attempt"
3776 .cindex "frozen messages" "forcing delivery"
3777 This option requests Exim to run a delivery attempt on each message in turn. If
3778 any of the messages are frozen, they are automatically thawed before the
3779 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3780 and &%hold_domains%& are ignored.
3781
3782 Retry
3783 .cindex "hints database" "overriding retry hints"
3784 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3785 the normal retry time has not yet been reached. This option requires the caller
3786 to be an admin user. However, there is an option called &%prod_requires_admin%&
3787 which can be set false to relax this restriction (and also the same requirement
3788 for the &%-q%&, &%-R%&, and &%-S%& options).
3789
3790 The deliveries happen synchronously, that is, the original Exim process does
3791 not terminate until all the delivery attempts have finished. No output is
3792 produced unless there is a serious error. If you want to see what is happening,
3793 use the &%-v%& option as well, or inspect Exim's main log.
3794
3795 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3796 .oindex "&%-Mar%&"
3797 .cindex "message" "adding recipients"
3798 .cindex "recipient" "adding"
3799 This option requests Exim to add the addresses to the list of recipients of the
3800 message (&"ar"& for &"add recipients"&). The first argument must be a message
3801 id, and the remaining ones must be email addresses. However, if the message is
3802 active (in the middle of a delivery attempt), it is not altered. This option
3803 can be used only by an admin user.
3804
3805 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3806         &~<&'message&~id'&>"
3807 .oindex "&%-MC%&"
3808 .cindex "SMTP" "passed connection"
3809 .cindex "SMTP" "multiple deliveries"
3810 .cindex "multiple SMTP deliveries"
3811 This option is not intended for use by external callers. It is used internally
3812 by Exim to invoke another instance of itself to deliver a waiting message using
3813 an existing SMTP connection, which is passed as the standard input. Details are
3814 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3815 must be root or the Exim user in order to use it.
3816
3817 .vitem &%-MCA%&
3818 .oindex "&%-MCA%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the
3821 connection to the remote host has been authenticated.
3822
3823 .vitem &%-MCD%&
3824 .oindex "&%-MCD%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option. It signifies that the
3827 remote host supports the ESMTP &_DSN_& extension.
3828
3829 .vitem &%-MCP%&
3830 .oindex "&%-MCP%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3833 which Exim is connected supports pipelining.
3834
3835 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3836 .oindex "&%-MCQ%&"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim in conjunction with the &%-MC%& option when the original delivery was
3839 started by a queue runner. It passes on the process id of the queue runner,
3840 together with the file descriptor number of an open pipe. Closure of the pipe
3841 signals the final completion of the sequence of processes that are passing
3842 messages through the same SMTP connection.
3843
3844 .vitem &%-MCS%&
3845 .oindex "&%-MCS%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3848 SMTP SIZE option should be used on messages delivered down the existing
3849 connection.
3850
3851 .vitem &%-MCT%&
3852 .oindex "&%-MCT%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3855 host to which Exim is connected supports TLS encryption.
3856
3857 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3858 .oindex "&%-Mc%&"
3859 .cindex "hints database" "not overridden by &%-Mc%&"
3860 .cindex "delivery" "manually started &-- not forced"
3861 This option requests Exim to run a delivery attempt on each message in turn,
3862 but unlike the &%-M%& option, it does check for retry hints, and respects any
3863 that are found. This option is not very useful to external callers. It is
3864 provided mainly for internal use by Exim when it needs to re-invoke itself in
3865 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3866 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3867 respects retry times and other options such as &%hold_domains%& that are
3868 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3869 If you want to run a specific delivery as if in a queue run, you should use
3870 &%-q%& with a message id argument. A distinction between queue run deliveries
3871 and other deliveries is made in one or two places.
3872
3873 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3874 .oindex "&%-Mes%&"
3875 .cindex "message" "changing sender"
3876 .cindex "sender" "changing"
3877 This option requests Exim to change the sender address in the message to the
3878 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3879 &"edit sender"&). There must be exactly two arguments. The first argument must
3880 be a message id, and the second one an email address. However, if the message
3881 is active (in the middle of a delivery attempt), its status is not altered.
3882 This option can be used only by an admin user.
3883
3884 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3885 .oindex "&%-Mf%&"
3886 .cindex "freezing messages"
3887 .cindex "message" "manually freezing"
3888 This option requests Exim to mark each listed message as &"frozen"&. This
3889 prevents any delivery attempts taking place until the message is &"thawed"&,
3890 either manually or as a result of the &%auto_thaw%& configuration option.
3891 However, if any of the messages are active (in the middle of a delivery
3892 attempt), their status is not altered. This option can be used only by an admin
3893 user.
3894
3895 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3896 .oindex "&%-Mg%&"
3897 .cindex "giving up on messages"
3898 .cindex "message" "abandoning delivery attempts"
3899 .cindex "delivery" "abandoning further attempts"
3900 This option requests Exim to give up trying to deliver the listed messages,
3901 including any that are frozen. However, if any of the messages are active,
3902 their status is not altered. For non-bounce messages, a delivery error message
3903 is sent to the sender, containing the text &"cancelled by administrator"&.
3904 Bounce messages are just discarded. This option can be used only by an admin
3905 user.
3906
3907 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3908 .oindex "&%-Mmad%&"
3909 .cindex "delivery" "cancelling all"
3910 This option requests Exim to mark all the recipient addresses in the messages
3911 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3912 message is active (in the middle of a delivery attempt), its status is not
3913 altered. This option can be used only by an admin user.
3914
3915 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3916 .oindex "&%-Mmd%&"
3917 .cindex "delivery" "cancelling by address"
3918 .cindex "recipient" "removing"
3919 .cindex "removing recipients"
3920 This option requests Exim to mark the given addresses as already delivered
3921 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3922 the remaining ones must be email addresses. These are matched to recipient
3923 addresses in the message in a case-sensitive manner. If the message is active
3924 (in the middle of a delivery attempt), its status is not altered. This option
3925 can be used only by an admin user.
3926
3927 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3928 .oindex "&%-Mrm%&"
3929 .cindex "removing messages"
3930 .cindex "abandoning mail"
3931 .cindex "message" "manually discarding"
3932 This option requests Exim to remove the given messages from the queue. No
3933 bounce messages are sent; each message is simply forgotten. However, if any of
3934 the messages are active, their status is not altered. This option can be used
3935 only by an admin user or by the user who originally caused the message to be
3936 placed on the queue.
3937
3938 .vitem &%-Mset%&&~<&'message&~id'&>
3939 .oindex "&%-Mset%&
3940 .cindex "testing" "string expansion"
3941 .cindex "expansion" "testing"
3942 This option is useful only in conjunction with &%-be%& (that is, when testing
3943 string expansions). Exim loads the given message from its spool before doing
3944 the test expansions, thus setting message-specific variables such as
3945 &$message_size$& and the header variables. The &$recipients$& variable is made
3946 available. This feature is provided to make it easier to test expansions that
3947 make use of these variables. However, this option can be used only by an admin
3948 user. See also &%-bem%&.
3949
3950 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3951 .oindex "&%-Mt%&"
3952 .cindex "thawing messages"
3953 .cindex "unfreezing messages"
3954 .cindex "frozen messages" "thawing"
3955 .cindex "message" "thawing frozen"
3956 This option requests Exim to &"thaw"& any of the listed messages that are
3957 &"frozen"&, so that delivery attempts can resume. However, if any of the
3958 messages are active, their status is not altered. This option can be used only
3959 by an admin user.
3960
3961 .vitem &%-Mvb%&&~<&'message&~id'&>
3962 .oindex "&%-Mvb%&"
3963 .cindex "listing" "message body"
3964 .cindex "message" "listing body of"
3965 This option causes the contents of the message body (-D) spool file to be
3966 written to the standard output. This option can be used only by an admin user.
3967
3968 .vitem &%-Mvc%&&~<&'message&~id'&>
3969 .oindex "&%-Mvc%&"
3970 .cindex "message" "listing in RFC 2822 format"
3971 .cindex "listing" "message in RFC 2822 format"
3972 This option causes a copy of the complete message (header lines plus body) to
3973 be written to the standard output in RFC 2822 format. This option can be used
3974 only by an admin user.
3975
3976 .vitem &%-Mvh%&&~<&'message&~id'&>
3977 .oindex "&%-Mvh%&"
3978 .cindex "listing" "message headers"
3979 .cindex "header lines" "listing"
3980 .cindex "message" "listing header lines"
3981 This option causes the contents of the message headers (-H) spool file to be
3982 written to the standard output. This option can be used only by an admin user.
3983
3984 .vitem &%-Mvl%&&~<&'message&~id'&>
3985 .oindex "&%-Mvl%&"
3986 .cindex "listing" "message log"
3987 .cindex "message" "listing message log"
3988 This option causes the contents of the message log spool file to be written to
3989 the standard output. This option can be used only by an admin user.
3990
3991 .vitem &%-m%&
3992 .oindex "&%-m%&"
3993 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3994 treats it that way too.
3995
3996 .vitem &%-N%&
3997 .oindex "&%-N%&"
3998 .cindex "debugging" "&%-N%& option"
3999 .cindex "debugging" "suppressing delivery"
4000 This is a debugging option that inhibits delivery of a message at the transport
4001 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4002 it just doesn't actually transport the message, but instead behaves as if it
4003 had successfully done so. However, it does not make any updates to the retry
4004 database, and the log entries for deliveries are flagged with &"*>"& rather
4005 than &"=>"&.
4006
4007 Because &%-N%& discards any message to which it applies, only root or the Exim
4008 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4009 words, an ordinary user can use it only when supplying an incoming message to
4010 which it will apply. Although transportation never fails when &%-N%& is set, an
4011 address may be deferred because of a configuration problem on a transport, or a
4012 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4013 the message, and applies to any subsequent delivery attempts that may happen
4014 for that message.
4015
4016 .vitem &%-n%&
4017 .oindex "&%-n%&"
4018 This option is interpreted by Sendmail to mean &"no aliasing"&.
4019 For normal modes of operation, it is ignored by Exim.
4020 When combined with &%-bP%& it makes the output more terse (suppresses
4021 option names, environment values and config pretty printing).
4022
4023 .vitem &%-O%&&~<&'data'&>
4024 .oindex "&%-O%&"
4025 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4026 Exim.
4027
4028 .vitem &%-oA%&&~<&'file&~name'&>
4029 .oindex "&%-oA%&"
4030 .cindex "Sendmail compatibility" "&%-oA%& option"
4031 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4032 alternative alias file name. Exim handles &%-bi%& differently; see the
4033 description above.
4034
4035 .vitem &%-oB%&&~<&'n'&>
4036 .oindex "&%-oB%&"
4037 .cindex "SMTP" "passed connection"
4038 .cindex "SMTP" "multiple deliveries"
4039 .cindex "multiple SMTP deliveries"
4040 This is a debugging option which limits the maximum number of messages that can
4041 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4042 transport. If <&'n'&> is omitted, the limit is set to 1.
4043
4044 .vitem &%-odb%&
4045 .oindex "&%-odb%&"
4046 .cindex "background delivery"
4047 .cindex "delivery" "in the background"
4048 This option applies to all modes in which Exim accepts incoming messages,
4049 including the listening daemon. It requests &"background"& delivery of such
4050 messages, which means that the accepting process automatically starts a
4051 delivery process for each message received, but does not wait for the delivery
4052 processes to finish.
4053
4054 When all the messages have been received, the reception process exits,
4055 leaving the delivery processes to finish in their own time. The standard output
4056 and error streams are closed at the start of each delivery process.
4057 This is the default action if none of the &%-od%& options are present.
4058
4059 If one of the queueing options in the configuration file
4060 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4061 overrides it if &%queue_only_override%& is set true, which is the default
4062 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4063
4064 .vitem &%-odf%&
4065 .oindex "&%-odf%&"
4066 .cindex "foreground delivery"
4067 .cindex "delivery" "in the foreground"
4068 This option requests &"foreground"& (synchronous) delivery when Exim has
4069 accepted a locally-generated message. (For the daemon it is exactly the same as
4070 &%-odb%&.) A delivery process is automatically started to deliver the message,
4071 and Exim waits for it to complete before proceeding.
4072
4073 The original Exim reception process does not finish until the delivery
4074 process for the final message has ended. The standard error stream is left open
4075 during deliveries.
4076
4077 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4078 false and one of the queueing options in the configuration file is in effect.
4079
4080 If there is a temporary delivery error during foreground delivery, the
4081 message is left on the queue for later delivery, and the original reception
4082 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4083 restricted configuration that never queues messages.
4084
4085
4086 .vitem &%-odi%&
4087 .oindex "&%-odi%&"
4088 This option is synonymous with &%-odf%&. It is provided for compatibility with
4089 Sendmail.
4090
4091 .vitem &%-odq%&
4092 .oindex "&%-odq%&"
4093 .cindex "non-immediate delivery"
4094 .cindex "delivery" "suppressing immediate"
4095 .cindex "queueing incoming messages"
4096 This option applies to all modes in which Exim accepts incoming messages,
4097 including the listening daemon. It specifies that the accepting process should
4098 not automatically start a delivery process for each message received. Messages
4099 are placed on the queue, and remain there until a subsequent queue runner
4100 process encounters them. There are several configuration options (such as
4101 &%queue_only%&) that can be used to queue incoming messages under certain
4102 conditions. This option overrides all of them and also &%-odqs%&. It always
4103 forces queueing.
4104
4105 .vitem &%-odqs%&
4106 .oindex "&%-odqs%&"
4107 .cindex "SMTP" "delaying delivery"
4108 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4109 However, like &%-odb%& and &%-odi%&, this option has no effect if
4110 &%queue_only_override%& is false and one of the queueing options in the
4111 configuration file is in effect.
4112
4113 When &%-odqs%& does operate, a delivery process is started for each incoming
4114 message, in the background by default, but in the foreground if &%-odi%& is
4115 also present. The recipient addresses are routed, and local deliveries are done
4116 in the normal way. However, if any SMTP deliveries are required, they are not
4117 done at this time, so the message remains on the queue until a subsequent queue
4118 runner process encounters it. Because routing was done, Exim knows which
4119 messages are waiting for which hosts, and so a number of messages for the same
4120 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4121 configuration option has the same effect for specific domains. See also the
4122 &%-qq%& option.
4123
4124 .vitem &%-oee%&
4125 .oindex "&%-oee%&"
4126 .cindex "error" "reporting"
4127 If an error is detected while a non-SMTP message is being received (for
4128 example, a malformed address), the error is reported to the sender in a mail
4129 message.
4130
4131 .cindex "return code" "for &%-oee%&"
4132 Provided
4133 this error message is successfully sent, the Exim receiving process
4134 exits with a return code of zero. If not, the return code is 2 if the problem
4135 is that the original message has no recipients, or 1 for any other error.
4136 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4137
4138 .vitem &%-oem%&
4139 .oindex "&%-oem%&"
4140 .cindex "error" "reporting"
4141 .cindex "return code" "for &%-oem%&"
4142 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4143 return code, whether or not the error message was successfully sent.
4144 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4145
4146 .vitem &%-oep%&
4147 .oindex "&%-oep%&"
4148 .cindex "error" "reporting"
4149 If an error is detected while a non-SMTP message is being received, the
4150 error is reported by writing a message to the standard error file (stderr).
4151 .cindex "return code" "for &%-oep%&"
4152 The return code is 1 for all errors.
4153
4154 .vitem &%-oeq%&
4155 .oindex "&%-oeq%&"
4156 .cindex "error" "reporting"
4157 This option is supported for compatibility with Sendmail, but has the same
4158 effect as &%-oep%&.
4159
4160 .vitem &%-oew%&
4161 .oindex "&%-oew%&"
4162 .cindex "error" "reporting"
4163 This option is supported for compatibility with Sendmail, but has the same
4164 effect as &%-oem%&.
4165
4166 .vitem &%-oi%&
4167 .oindex "&%-oi%&"
4168 .cindex "dot" "in incoming non-SMTP message"
4169 This option, which has the same effect as &%-i%&, specifies that a dot on a
4170 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4171 single dot does terminate, though Exim does no special processing for other
4172 lines that start with a dot. This option is set by default if Exim is called as
4173 &'rmail'&. See also &%-ti%&.
4174
4175 .vitem &%-oitrue%&
4176 .oindex "&%-oitrue%&"
4177 This option is treated as synonymous with &%-oi%&.
4178
4179 .vitem &%-oMa%&&~<&'host&~address'&>
4180 .oindex "&%-oMa%&"
4181 .cindex "sender" "host address, specifying for local message"
4182 A number of options starting with &%-oM%& can be used to set values associated
4183 with remote hosts on locally-submitted messages (that is, messages not received
4184 over TCP/IP). These options can be used by any caller in conjunction with the
4185 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4186 other circumstances, they are ignored unless the caller is trusted.
4187
4188 The &%-oMa%& option sets the sender host address. This may include a port
4189 number at the end, after a full stop (period). For example:
4190 .code
4191 exim -bs -oMa 10.9.8.7.1234
4192 .endd
4193 An alternative syntax is to enclose the IP address in square brackets,
4194 followed by a colon and the port number:
4195 .code
4196 exim -bs -oMa [10.9.8.7]:1234
4197 .endd
4198 The IP address is placed in the &$sender_host_address$& variable, and the
4199 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4200 are present on the command line, the sender host IP address is taken from
4201 whichever one is last.
4202
4203 .vitem &%-oMaa%&&~<&'name'&>
4204 .oindex "&%-oMaa%&"
4205 .cindex "authentication" "name, specifying for local message"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4207 option sets the value of &$sender_host_authenticated$& (the authenticator
4208 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4209 This option can be used with &%-bh%& and &%-bs%& to set up an
4210 authenticated SMTP session without actually using the SMTP AUTH command.
4211
4212 .vitem &%-oMai%&&~<&'string'&>
4213 .oindex "&%-oMai%&"
4214 .cindex "authentication" "id, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4216 option sets the value of &$authenticated_id$& (the id that was authenticated).
4217 This overrides the default value (the caller's login id, except with &%-bh%&,
4218 where there is no default) for messages from local sources. See chapter
4219 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4220
4221 .vitem &%-oMas%&&~<&'address'&>
4222 .oindex "&%-oMas%&"
4223 .cindex "authentication" "sender, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4225 option sets the authenticated sender value in &$authenticated_sender$&. It
4226 overrides the sender address that is created from the caller's login id for
4227 messages from local sources, except when &%-bh%& is used, when there is no
4228 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4229 specified on a MAIL command overrides this value. See chapter
4230 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4231
4232 .vitem &%-oMi%&&~<&'interface&~address'&>
4233 .oindex "&%-oMi%&"
4234 .cindex "interface" "address, specifying for local message"
4235 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4236 option sets the IP interface address value. A port number may be included,
4237 using the same syntax as for &%-oMa%&. The interface address is placed in
4238 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4239
4240 .vitem &%-oMm%&&~<&'message&~reference'&>
4241 .oindex "&%-oMm%&"
4242 .cindex "message reference" "message reference, specifying for local message"
4243 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4244 option sets the message reference, e.g. message-id, and is logged during
4245 delivery. This is useful when some kind of audit trail is required to tie
4246 messages together. The format of the message reference is checked and will
4247 abort if the format is invalid. The option will only be accepted if exim is
4248 running in trusted mode, not as any regular user.
4249
4250 The best example of a message reference is when Exim sends a bounce message.
4251 The message reference is the message-id of the original message for which Exim
4252 is sending the bounce.
4253
4254 .vitem &%-oMr%&&~<&'protocol&~name'&>
4255 .oindex "&%-oMr%&"
4256 .cindex "protocol, specifying for local message"
4257 .vindex "&$received_protocol$&"
4258 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4259 option sets the received protocol value that is stored in
4260 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4261 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4262 SMTP protocol names (see the description of &$received_protocol$& in section
4263 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4264 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4265 be set by &%-oMr%&.
4266
4267 .vitem &%-oMs%&&~<&'host&~name'&>
4268 .oindex "&%-oMs%&"
4269 .cindex "sender" "host name, specifying for local message"
4270 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4271 option sets the sender host name in &$sender_host_name$&. When this option is
4272 present, Exim does not attempt to look up a host name from an IP address; it
4273 uses the name it is given.
4274
4275 .vitem &%-oMt%&&~<&'ident&~string'&>
4276 .oindex "&%-oMt%&"
4277 .cindex "sender" "ident string, specifying for local message"
4278 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4279 option sets the sender ident value in &$sender_ident$&. The default setting for
4280 local callers is the login id of the calling process, except when &%-bh%& is
4281 used, when there is no default.
4282
4283 .vitem &%-om%&
4284 .oindex "&%-om%&"
4285 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4286 In Sendmail, this option means &"me too"&, indicating that the sender of a
4287 message should receive a copy of the message if the sender appears in an alias
4288 expansion. Exim always does this, so the option does nothing.
4289
4290 .vitem &%-oo%&
4291 .oindex "&%-oo%&"
4292 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4293 This option is ignored. In Sendmail it specifies &"old style headers"&,
4294 whatever that means.
4295
4296 .vitem &%-oP%&&~<&'path'&>
4297 .oindex "&%-oP%&"
4298 .cindex "pid (process id)" "of daemon"
4299 .cindex "daemon" "process id (pid)"
4300 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4301 value. The option specifies the file to which the process id of the daemon is
4302 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4303 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4304 because in those cases, the normal pid file is not used.
4305
4306 .vitem &%-or%&&~<&'time'&>
4307 .oindex "&%-or%&"
4308 .cindex "timeout" "for non-SMTP input"
4309 This option sets a timeout value for incoming non-SMTP messages. If it is not
4310 set, Exim will wait forever for the standard input. The value can also be set
4311 by the &%receive_timeout%& option. The format used for specifying times is
4312 described in section &<<SECTtimeformat>>&.
4313
4314 .vitem &%-os%&&~<&'time'&>
4315 .oindex "&%-os%&"
4316 .cindex "timeout" "for SMTP input"
4317 .cindex "SMTP" "input timeout"
4318 This option sets a timeout value for incoming SMTP messages. The timeout
4319 applies to each SMTP command and block of data. The value can also be set by
4320 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4321 for specifying times is described in section &<<SECTtimeformat>>&.
4322
4323 .vitem &%-ov%&
4324 .oindex "&%-ov%&"
4325 This option has exactly the same effect as &%-v%&.
4326
4327 .vitem &%-oX%&&~<&'number&~or&~string'&>
4328 .oindex "&%-oX%&"
4329 .cindex "TCP/IP" "setting listening ports"
4330 .cindex "TCP/IP" "setting listening interfaces"
4331 .cindex "port" "receiving TCP/IP"
4332 This option is relevant only when the &%-bd%& (start listening daemon) option
4333 is also given. It controls which ports and interfaces the daemon uses. Details
4334 of the syntax, and how it interacts with configuration file options, are given
4335 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4336 file is written unless &%-oP%& is also present to specify a pid file name.
4337
4338 .vitem &%-pd%&
4339 .oindex "&%-pd%&"
4340 .cindex "Perl" "starting the interpreter"
4341 This option applies when an embedded Perl interpreter is linked with Exim (see
4342 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4343 option, forcing the starting of the interpreter to be delayed until it is
4344 needed.
4345
4346 .vitem &%-ps%&
4347 .oindex "&%-ps%&"
4348 .cindex "Perl" "starting the interpreter"
4349 This option applies when an embedded Perl interpreter is linked with Exim (see
4350 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4351 option, forcing the starting of the interpreter to occur as soon as Exim is
4352 started.
4353
4354 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4355 .oindex "&%-p%&"
4356 For compatibility with Sendmail, this option is equivalent to
4357 .display
4358 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4359 .endd
4360 It sets the incoming protocol and host name (for trusted callers). The
4361 host name and its colon can be omitted when only the protocol is to be set.
4362 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4363 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4364 or &`s`& using this option (but that does not seem a real limitation).
4365
4366 .vitem &%-q%&
4367 .oindex "&%-q%&"
4368 .cindex "queue runner" "starting manually"
4369 This option is normally restricted to admin users. However, there is a
4370 configuration option called &%prod_requires_admin%& which can be set false to
4371 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4372 and &%-S%& options).
4373
4374 .cindex "queue runner" "description of operation"
4375 The &%-q%& option starts one queue runner process. This scans the queue of
4376 waiting messages, and runs a delivery process for each one in turn. It waits
4377 for each delivery process to finish before starting the next one. A delivery
4378 process may not actually do any deliveries if the retry times for the addresses
4379 have not been reached. Use &%-qf%& (see below) if you want to override this.
4380
4381 If
4382 .cindex "SMTP" "passed connection"
4383 .cindex "SMTP" "multiple deliveries"
4384 .cindex "multiple SMTP deliveries"
4385 the delivery process spawns other processes to deliver other messages down
4386 passed SMTP connections, the queue runner waits for these to finish before
4387 proceeding.
4388
4389 When all the queued messages have been considered, the original queue runner
4390 process terminates. In other words, a single pass is made over the waiting
4391 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4392 this to be repeated periodically.
4393
4394 Exim processes the waiting messages in an unpredictable order. It isn't very
4395 random, but it is likely to be different each time, which is all that matters.
4396 If one particular message screws up a remote MTA, other messages to the same
4397 MTA have a chance of getting through if they get tried first.
4398
4399 It is possible to cause the messages to be processed in lexical message id
4400 order, which is essentially the order in which they arrived, by setting the
4401 &%queue_run_in_order%& option, but this is not recommended for normal use.
4402
4403 .vitem &%-q%&<&'qflags'&>
4404 The &%-q%& option may be followed by one or more flag letters that change its
4405 behaviour. They are all optional, but if more than one is present, they must
4406 appear in the correct order. Each flag is described in a separate item below.
4407
4408 .vitem &%-qq...%&
4409 .oindex "&%-qq%&"
4410 .cindex "queue" "double scanning"
4411 .cindex "queue" "routing"
4412 .cindex "routing" "whole queue before delivery"
4413 An option starting with &%-qq%& requests a two-stage queue run. In the first
4414 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4415 every domain. Addresses are routed, local deliveries happen, but no remote
4416 transports are run.
4417
4418 .cindex "hints database" "remembering routing"
4419 The hints database that remembers which messages are waiting for specific hosts
4420 is updated, as if delivery to those hosts had been deferred. After this is
4421 complete, a second, normal queue scan happens, with routing and delivery taking
4422 place as normal. Messages that are routed to the same host should mostly be
4423 delivered down a single SMTP
4424 .cindex "SMTP" "passed connection"
4425 .cindex "SMTP" "multiple deliveries"
4426 .cindex "multiple SMTP deliveries"
4427 connection because of the hints that were set up during the first queue scan.
4428 This option may be useful for hosts that are connected to the Internet
4429 intermittently.
4430
4431 .vitem &%-q[q]i...%&
4432 .oindex "&%-qi%&"
4433 .cindex "queue" "initial delivery"
4434 If the &'i'& flag is present, the queue runner runs delivery processes only for
4435 those messages that haven't previously been tried. (&'i'& stands for &"initial
4436 delivery"&.) This can be helpful if you are putting messages on the queue using
4437 &%-odq%& and want a queue runner just to process the new messages.
4438
4439 .vitem &%-q[q][i]f...%&
4440 .oindex "&%-qf%&"
4441 .cindex "queue" "forcing delivery"
4442 .cindex "delivery" "forcing in queue run"
4443 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4444 message, whereas without &'f'& only those non-frozen addresses that have passed
4445 their retry times are tried.
4446
4447 .vitem &%-q[q][i]ff...%&
4448 .oindex "&%-qff%&"
4449 .cindex "frozen messages" "forcing delivery"
4450 If &'ff'& is present, a delivery attempt is forced for every message, whether
4451 frozen or not.
4452
4453 .vitem &%-q[q][i][f[f]]l%&
4454 .oindex "&%-ql%&"
4455 .cindex "queue" "local deliveries only"
4456 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4457 be done. If a message requires any remote deliveries, it remains on the queue
4458 for later delivery.
4459
4460 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4461 .cindex "queue" "delivering specific messages"
4462 When scanning the queue, Exim can be made to skip over messages whose ids are
4463 lexically less than a given value by following the &%-q%& option with a
4464 starting message id. For example:
4465 .code
4466 exim -q 0t5C6f-0000c8-00
4467 .endd
4468 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4469 second message id is given, messages whose ids are lexically greater than it
4470 are also skipped. If the same id is given twice, for example,
4471 .code
4472 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4473 .endd
4474 just one delivery process is started, for that message. This differs from
4475 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4476 that it counts as a delivery from a queue run. Note that the selection
4477 mechanism does not affect the order in which the messages are scanned. There
4478 are also other ways of selecting specific sets of messages for delivery in a
4479 queue run &-- see &%-R%& and &%-S%&.
4480
4481 .vitem &%-q%&<&'qflags'&><&'time'&>
4482 .cindex "queue runner" "starting periodically"
4483 .cindex "periodic queue running"
4484 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4485 starting a queue runner process at intervals specified by the given time value
4486 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4487 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4488 single daemon process handles both functions. A common way of starting up a
4489 combined daemon at system boot time is to use a command such as
4490 .code
4491 /usr/exim/bin/exim -bd -q30m
4492 .endd
4493 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4494 process every 30 minutes.
4495
4496 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4497 pid file is written unless one is explicitly requested by the &%-oP%& option.
4498
4499 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4500 .oindex "&%-qR%&"
4501 This option is synonymous with &%-R%&. It is provided for Sendmail
4502 compatibility.
4503
4504 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4505 .oindex "&%-qS%&"
4506 This option is synonymous with &%-S%&.
4507
4508 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4509 .oindex "&%-R%&"
4510 .cindex "queue runner" "for specific recipients"
4511 .cindex "delivery" "to given domain"
4512 .cindex "domain" "delivery to"
4513 The <&'rsflags'&> may be empty, in which case the white space before the string
4514 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4515 which are the possible values for <&'rsflags'&>. White space is required if
4516 <&'rsflags'&> is not empty.
4517
4518 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4519 perform a single queue run, except that, when scanning the messages on the
4520 queue, Exim processes only those that have at least one undelivered recipient
4521 address containing the given string, which is checked in a case-independent
4522 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4523 regular expression; otherwise it is a literal string.
4524
4525 If you want to do periodic queue runs for messages with specific recipients,
4526 you can combine &%-R%& with &%-q%& and a time value. For example:
4527 .code
4528 exim -q25m -R @special.domain.example
4529 .endd
4530 This example does a queue run for messages with recipients in the given domain
4531 every 25 minutes. Any additional flags that are specified with &%-q%& are
4532 applied to each queue run.
4533
4534 Once a message is selected for delivery by this mechanism, all its addresses
4535 are processed. For the first selected message, Exim overrides any retry
4536 information and forces a delivery attempt for each undelivered address. This
4537 means that if delivery of any address in the first message is successful, any
4538 existing retry information is deleted, and so delivery attempts for that
4539 address in subsequently selected messages (which are processed without forcing)
4540 will run. However, if delivery of any address does not succeed, the retry
4541 information is updated, and in subsequently selected messages, the failing
4542 address will be skipped.
4543
4544 .cindex "frozen messages" "forcing delivery"
4545 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4546 all selected messages, not just the first; frozen messages are included when
4547 &'ff'& is present.
4548
4549 The &%-R%& option makes it straightforward to initiate delivery of all messages
4550 to a given domain after a host has been down for some time. When the SMTP
4551 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4552 effect is to run Exim with the &%-R%& option, but it can be configured to run
4553 an arbitrary command instead.
4554
4555 .vitem &%-r%&
4556 .oindex "&%-r%&"
4557 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4558
4559 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4560 .oindex "&%-S%&"
4561 .cindex "delivery" "from given sender"
4562 .cindex "queue runner" "for specific senders"
4563 This option acts like &%-R%& except that it checks the string against each
4564 message's sender instead of against the recipients. If &%-R%& is also set, both
4565 conditions must be met for a message to be selected. If either of the options
4566 has &'f'& or &'ff'& in its flags, the associated action is taken.
4567
4568 .vitem &%-Tqt%&&~<&'times'&>
4569 .oindex "&%-Tqt%&"
4570 This is an option that is exclusively for use by the Exim testing suite. It is not
4571 recognized when Exim is run normally. It allows for the setting up of explicit
4572 &"queue times"& so that various warning/retry features can be tested.
4573
4574 .vitem &%-t%&
4575 .oindex "&%-t%&"
4576 .cindex "recipient" "extracting from header lines"
4577 .cindex "&'Bcc:'& header line"
4578 .cindex "&'Cc:'& header line"
4579 .cindex "&'To:'& header line"
4580 When Exim is receiving a locally-generated, non-SMTP message on its standard
4581 input, the &%-t%& option causes the recipients of the message to be obtained
4582 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4583 from the command arguments. The addresses are extracted before any rewriting
4584 takes place and the &'Bcc:'& header line, if present, is then removed.
4585
4586 .cindex "Sendmail compatibility" "&%-t%& option"
4587 If the command has any arguments, they specify addresses to which the message
4588 is &'not'& to be delivered. That is, the argument addresses are removed from
4589 the recipients list obtained from the headers. This is compatible with Smail 3
4590 and in accordance with the documented behaviour of several versions of
4591 Sendmail, as described in man pages on a number of operating systems (e.g.
4592 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4593 argument addresses to those obtained from the headers, and the O'Reilly
4594 Sendmail book documents it that way. Exim can be made to add argument addresses
4595 instead of subtracting them by setting the option
4596 &%extract_addresses_remove_arguments%& false.
4597
4598 .cindex "&%Resent-%& header lines" "with &%-t%&"
4599 If there are any &%Resent-%& header lines in the message, Exim extracts
4600 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4601 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4602 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4603 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4604
4605 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4606 message is resent several times). The RFC also specifies that they should be
4607 added at the front of the message, and separated by &'Received:'& lines. It is
4608 not at all clear how &%-t%& should operate in the present of multiple sets,
4609 nor indeed exactly what constitutes a &"set"&.
4610 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4611 are often added at the end of the header, and if a message is resent more than
4612 once, it is common for the original set of &%Resent-%& headers to be renamed as
4613 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4614
4615 .vitem &%-ti%&
4616 .oindex "&%-ti%&"
4617 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4618 compatibility with Sendmail.
4619
4620 .vitem &%-tls-on-connect%&
4621 .oindex "&%-tls-on-connect%&"
4622 .cindex "TLS" "use without STARTTLS"
4623 .cindex "TLS" "automatic start"
4624 This option is available when Exim is compiled with TLS support. It forces all
4625 incoming SMTP connections to behave as if the incoming port is listed in the
4626 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4627 &<<CHAPTLS>>& for further details.
4628
4629
4630 .vitem &%-U%&
4631 .oindex "&%-U%&"
4632 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4633 Sendmail uses this option for &"initial message submission"&, and its
4634 documentation states that in future releases, it may complain about
4635 syntactically invalid messages rather than fixing them when this flag is not
4636 set. Exim ignores this option.
4637
4638 .vitem &%-v%&
4639 .oindex "&%-v%&"
4640 This option causes Exim to write information to the standard error stream,
4641 describing what it is doing. In particular, it shows the log lines for
4642 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4643 dialogue is shown. Some of the log lines shown may not actually be written to
4644 the log if the setting of &%log_selector%& discards them. Any relevant
4645 selectors are shown with each log line. If none are shown, the logging is
4646 unconditional.
4647
4648 .vitem &%-x%&
4649 .oindex "&%-x%&"
4650 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4651 National Language Support extended characters in the body of the mail item"&).
4652 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4653 this option.
4654
4655 .vitem &%-X%&&~<&'logfile'&>
4656 .oindex "&%-X%&"
4657 This option is interpreted by Sendmail to cause debug information to be sent
4658 to the named file.  It is ignored by Exim.
4659
4660 .vitem &%-z%&&~<&'log-line'&>
4661 .oindex "&%-z%&"
4662 This option writes its argument to Exim's logfile.
4663 Use is restricted to administrators; the intent is for operational notes.
4664 Quotes should be used to maintain a multi-word item as a single argument,
4665 under most shells.
4666 .endlist
4667
4668 .ecindex IIDclo1
4669 .ecindex IIDclo2
4670
4671
4672 . ////////////////////////////////////////////////////////////////////////////
4673 . Insert a stylized DocBook comment here, to identify the end of the command
4674 . line options. This is for the benefit of the Perl script that automatically
4675 . creates a man page for the options.
4676 . ////////////////////////////////////////////////////////////////////////////
4677
4678 .literal xml
4679 <!-- === End of command line options === -->
4680 .literal off
4681
4682
4683
4684
4685
4686 . ////////////////////////////////////////////////////////////////////////////
4687 . ////////////////////////////////////////////////////////////////////////////
4688
4689
4690 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4691          "The runtime configuration file"
4692
4693 .cindex "run time configuration"
4694 .cindex "configuration file" "general description"
4695 .cindex "CONFIGURE_FILE"
4696 .cindex "configuration file" "errors in"
4697 .cindex "error" "in configuration file"
4698 .cindex "return code" "for bad configuration"
4699 Exim uses a single run time configuration file that is read whenever an Exim
4700 binary is executed. Note that in normal operation, this happens frequently,
4701 because Exim is designed to operate in a distributed manner, without central
4702 control.
4703
4704 If a syntax error is detected while reading the configuration file, Exim
4705 writes a message on the standard error, and exits with a non-zero return code.
4706 The message is also written to the panic log. &*Note*&: Only simple syntax
4707 errors can be detected at this time. The values of any expanded options are
4708 not checked until the expansion happens, even when the expansion does not
4709 actually alter the string.
4710
4711 The name of the configuration file is compiled into the binary for security
4712 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4713 most configurations, this specifies a single file. However, it is permitted to
4714 give a colon-separated list of file names, in which case Exim uses the first
4715 existing file in the list.
4716
4717 .cindex "EXIM_USER"
4718 .cindex "EXIM_GROUP"
4719 .cindex "CONFIGURE_OWNER"
4720 .cindex "CONFIGURE_GROUP"
4721 .cindex "configuration file" "ownership"
4722 .cindex "ownership" "configuration file"
4723 The run time configuration file must be owned by root or by the user that is
4724 specified at compile time by the CONFIGURE_OWNER option (if set). The
4725 configuration file must not be world-writeable, or group-writeable unless its
4726 group is the root group or the one specified at compile time by the
4727 CONFIGURE_GROUP option.
4728
4729 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4730 to root, anybody who is able to edit the run time configuration file has an
4731 easy way to run commands as root. If you specify a user or group in the
4732 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4733 who are members of that group will trivially be able to obtain root privileges.
4734
4735 Up to Exim version 4.72, the run time configuration file was also permitted to
4736 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4737 since it offered a simple privilege escalation for any attacker who managed to
4738 compromise the Exim user account.
4739
4740 A default configuration file, which will work correctly in simple situations,
4741 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4742 defines just one file name, the installation process copies the default
4743 configuration to a new file of that name if it did not previously exist. If
4744 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4745 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4746 configuration.
4747
4748
4749
4750 .section "Using a different configuration file" "SECID40"
4751 .cindex "configuration file" "alternate"
4752 A one-off alternate configuration can be specified by the &%-C%& command line
4753 option, which may specify a single file or a list of files. However, when
4754 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4755 unless the argument for &%-C%& is identical to the built-in value from
4756 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4757 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4758 is useful mainly for checking the syntax of configuration files before
4759 installing them. No owner or group checks are done on a configuration file
4760 specified by &%-C%&, if root privilege has been dropped.
4761
4762 Even the Exim user is not trusted to specify an arbitrary configuration file
4763 with the &%-C%& option to be used with root privileges, unless that file is
4764 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4765 testing a configuration using &%-C%& right through message reception and
4766 delivery, even if the caller is root. The reception works, but by that time,
4767 Exim is running as the Exim user, so when it re-execs to regain privilege for
4768 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4769 can test reception and delivery using two separate commands (one to put a
4770 message on the queue, using &%-odq%&, and another to do the delivery, using
4771 &%-M%&).
4772
4773 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4774 prefix string with which any file named in a &%-C%& command line option must
4775 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4776 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4777 name can be used with &%-C%&.
4778
4779 One-off changes to a configuration can be specified by the &%-D%& command line
4780 option, which defines and overrides values for macros used inside the
4781 configuration file. However, like &%-C%&, the use of this option by a
4782 non-privileged user causes Exim to discard its root privilege.
4783 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4784 completely disabled, and its use causes an immediate error exit.
4785
4786 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4787 to declare certain macro names trusted, such that root privilege will not
4788 necessarily be discarded.
4789 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4790 considered safe and, if &%-D%& only supplies macros from this list, and the
4791 values are acceptable, then Exim will not give up root privilege if the caller
4792 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4793 transition mechanism and is expected to be removed in the future.  Acceptable
4794 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4795
4796 Some sites may wish to use the same Exim binary on different machines that
4797 share a file system, but to use different configuration files on each machine.
4798 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4799 looks for a file whose name is the configuration file name followed by a dot
4800 and the machine's node name, as obtained from the &[uname()]& function. If this
4801 file does not exist, the standard name is tried. This processing occurs for
4802 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4803
4804 In some esoteric situations different versions of Exim may be run under
4805 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4806 help with this. See the comments in &_src/EDITME_& for details.
4807
4808
4809
4810 .section "Configuration file format" "SECTconffilfor"
4811 .cindex "configuration file" "format of"
4812 .cindex "format" "configuration file"
4813 Exim's configuration file is divided into a number of different parts. General
4814 option settings must always appear at the start of the file. The other parts
4815 are all optional, and may appear in any order. Each part other than the first
4816 is introduced by the word &"begin"& followed by at least one literal
4817 space, and the name of the part. The optional parts are:
4818
4819 .ilist
4820 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4821 &<<CHAPACL>>&).
4822 .next
4823 .cindex "AUTH" "configuration"
4824 &'authenticators'&: Configuration settings for the authenticator drivers. These
4825 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4826 .next
4827 &'routers'&: Configuration settings for the router drivers. Routers process
4828 addresses and determine how the message is to be delivered (see chapters
4829 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4830 .next
4831 &'transports'&: Configuration settings for the transport drivers. Transports
4832 define mechanisms for copying messages to destinations (see chapters
4833 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4834 .next
4835 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4836 If there is no retry section, or if it is empty (that is, no retry rules are
4837 defined), Exim will not retry deliveries. In this situation, temporary errors
4838 are treated the same as permanent errors. Retry rules are discussed in chapter
4839 &<<CHAPretry>>&.
4840 .next
4841 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4842 when new addresses are generated during delivery. Rewriting is discussed in
4843 chapter &<<CHAPrewrite>>&.
4844 .next
4845 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4846 want to use this feature, you must set
4847 .code
4848 LOCAL_SCAN_HAS_OPTIONS=yes
4849 .endd
4850 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4851 facility are given in chapter &<<CHAPlocalscan>>&.
4852 .endlist
4853
4854 .cindex "configuration file" "leading white space in"
4855 .cindex "configuration file" "trailing white space in"
4856 .cindex "white space" "in configuration file"
4857 Leading and trailing white space in configuration lines is always ignored.
4858
4859 Blank lines in the file, and lines starting with a # character (ignoring
4860 leading white space) are treated as comments and are ignored. &*Note*&: A
4861 # character other than at the beginning of a line is not treated specially,
4862 and does not introduce a comment.
4863
4864 Any non-comment line can be continued by ending it with a backslash. Note that
4865 the general rule for white space means that trailing white space after the
4866 backslash and leading white space at the start of continuation
4867 lines is ignored. Comment lines beginning with # (but not empty lines) may
4868 appear in the middle of a sequence of continuation lines.
4869
4870 A convenient way to create a configuration file is to start from the
4871 default, which is supplied in &_src/configure.default_&, and add, delete, or
4872 change settings as required.
4873
4874 The ACLs, retry rules, and rewriting rules have their own syntax which is
4875 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4876 respectively. The other parts of the configuration file have some syntactic
4877 items in common, and these are described below, from section &<<SECTcos>>&
4878 onwards. Before that, the inclusion, macro, and conditional facilities are
4879 described.
4880
4881
4882
4883 .section "File inclusions in the configuration file" "SECID41"
4884 .cindex "inclusions in configuration file"
4885 .cindex "configuration file" "including other files"
4886 .cindex "&`.include`& in configuration file"
4887 .cindex "&`.include_if_exists`& in configuration file"
4888 You can include other files inside Exim's run time configuration file by
4889 using this syntax:
4890 .display
4891 &`.include`& <&'file name'&>
4892 &`.include_if_exists`& <&'file name'&>
4893 .endd
4894 on a line by itself. Double quotes round the file name are optional. If you use
4895 the first form, a configuration error occurs if the file does not exist; the
4896 second form does nothing for non-existent files. In all cases, an absolute file
4897 name is required.
4898
4899 Includes may be nested to any depth, but remember that Exim reads its
4900 configuration file often, so it is a good idea to keep them to a minimum.
4901 If you change the contents of an included file, you must HUP the daemon,
4902 because an included file is read only when the configuration itself is read.
4903
4904 The processing of inclusions happens early, at a physical line level, so, like
4905 comment lines, an inclusion can be used in the middle of an option setting,
4906 for example:
4907 .code
4908 hosts_lookup = a.b.c \
4909                .include /some/file
4910 .endd
4911 Include processing happens after macro processing (see below). Its effect is to
4912 process the lines of the included file as if they occurred inline where the
4913 inclusion appears.
4914
4915
4916
4917 .section "Macros in the configuration file" "SECTmacrodefs"
4918 .cindex "macro" "description of"
4919 .cindex "configuration file" "macros"
4920 If a line in the main part of the configuration (that is, before the first
4921 &"begin"& line) begins with an upper case letter, it is taken as a macro
4922 definition, and must be of the form
4923 .display
4924 <&'name'&> = <&'rest of line'&>
4925 .endd
4926 The name must consist of letters, digits, and underscores, and need not all be
4927 in upper case, though that is recommended. The rest of the line, including any
4928 continuations, is the replacement text, and has leading and trailing white
4929 space removed. Quotes are not removed. The replacement text can never end with
4930 a backslash character, but this doesn't seem to be a serious limitation.
4931
4932 Macros may also be defined between router, transport, authenticator, or ACL
4933 definitions. They may not, however, be defined within an individual driver or
4934 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4935
4936 .section "Macro substitution" "SECID42"
4937 Once a macro is defined, all subsequent lines in the file (and any included
4938 files) are scanned for the macro name; if there are several macros, the line is
4939 scanned for each in turn, in the order in which the macros are defined. The
4940 replacement text is not re-scanned for the current macro, though it is scanned
4941 for subsequently defined macros. For this reason, a macro name may not contain
4942 the name of a previously defined macro as a substring. You could, for example,
4943 define
4944 .display
4945 &`ABCD_XYZ = `&<&'something'&>
4946 &`ABCD = `&<&'something else'&>
4947 .endd
4948 but putting the definitions in the opposite order would provoke a configuration
4949 error. Macro expansion is applied to individual physical lines from the file,
4950 before checking for line continuation or file inclusion (see above). If a line
4951 consists solely of a macro name, and the expansion of the macro is empty, the
4952 line is ignored. A macro at the start of a line may turn the line into a
4953 comment line or a &`.include`& line.
4954
4955
4956 .section "Redefining macros" "SECID43"
4957 Once defined, the value of a macro can be redefined later in the configuration
4958 (or in an included file). Redefinition is specified by using &'=='& instead of
4959 &'='&. For example:
4960 .code
4961 MAC =  initial value
4962 ...
4963 MAC == updated value
4964 .endd
4965 Redefinition does not alter the order in which the macros are applied to the
4966 subsequent lines of the configuration file. It is still the same order in which
4967 the macros were originally defined. All that changes is the macro's value.
4968 Redefinition makes it possible to accumulate values. For example:
4969 .code
4970 MAC =  initial value
4971 ...
4972 MAC == MAC and something added
4973 .endd
4974 This can be helpful in situations where the configuration file is built
4975 from a number of other files.
4976
4977 .section "Overriding macro values" "SECID44"
4978 The values set for macros in the configuration file can be overridden by the
4979 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4980 used, unless called by root or the Exim user. A definition on the command line
4981 using the &%-D%& option causes all definitions and redefinitions within the
4982 file to be ignored.
4983
4984
4985
4986 .section "Example of macro usage" "SECID45"
4987 As an example of macro usage, consider a configuration where aliases are looked
4988 up in a MySQL database. It helps to keep the file less cluttered if long
4989 strings such as SQL statements are defined separately as macros, for example:
4990 .code
4991 ALIAS_QUERY = select mailbox from user where \
4992               login='${quote_mysql:$local_part}';
4993 .endd
4994 This can then be used in a &(redirect)& router setting like this:
4995 .code
4996 data = ${lookup mysql{ALIAS_QUERY}}
4997 .endd
4998 In earlier versions of Exim macros were sometimes used for domain, host, or
4999 address lists. In Exim 4 these are handled better by named lists &-- see
5000 section &<<SECTnamedlists>>&.
5001
5002
5003 .section "Conditional skips in the configuration file" "SECID46"
5004 .cindex "configuration file" "conditional skips"
5005 .cindex "&`.ifdef`&"
5006 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5007 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5008 portions of the configuration file. The processing happens whenever the file is
5009 read (that is, when an Exim binary starts to run).
5010
5011 The implementation is very simple. Instances of the first four directives must
5012 be followed by text that includes the names of one or macros. The condition
5013 that is tested is whether or not any macro substitution has taken place in the
5014 line. Thus:
5015 .code
5016 .ifdef AAA
5017 message_size_limit = 50M
5018 .else
5019 message_size_limit = 100M
5020 .endif
5021 .endd
5022 sets a message size limit of 50M if the macro &`AAA`& is defined
5023 (or &`A`& or &`AA`&), and 100M
5024 otherwise. If there is more than one macro named on the line, the condition
5025 is true if any of them are defined. That is, it is an &"or"& condition. To
5026 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5027
5028 Although you can use a macro expansion to generate one of these directives,
5029 it is not very useful, because the condition &"there was a macro substitution
5030 in this line"& will always be true.
5031
5032 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5033 to clarify complicated nestings.
5034
5035
5036
5037 .section "Common option syntax" "SECTcos"
5038 .cindex "common option syntax"
5039 .cindex "syntax of common options"
5040 .cindex "configuration file" "common option syntax"
5041 For the main set of options, driver options, and &[local_scan()]& options,
5042 each setting is on a line by itself, and starts with a name consisting of
5043 lower-case letters and underscores. Many options require a data value, and in
5044 these cases the name must be followed by an equals sign (with optional white
5045 space) and then the value. For example:
5046 .code
5047 qualify_domain = mydomain.example.com
5048 .endd
5049 .cindex "hiding configuration option values"
5050 .cindex "configuration options" "hiding value of"
5051 .cindex "options" "hiding value of"
5052 Some option settings may contain sensitive data, for example, passwords for
5053 accessing databases. To stop non-admin users from using the &%-bP%& command
5054 line option to read these values, you can precede the option settings with the
5055 word &"hide"&. For example:
5056 .code
5057 hide mysql_servers = localhost/users/admin/secret-password
5058 .endd
5059 For non-admin users, such options are displayed like this:
5060 .code
5061 mysql_servers = <value not displayable>
5062 .endd
5063 If &"hide"& is used on a driver option, it hides the value of that option on
5064 all instances of the same driver.
5065
5066 The following sections describe the syntax used for the different data types
5067 that are found in option settings.
5068
5069
5070 .section "Boolean options" "SECID47"
5071 .cindex "format" "boolean"
5072 .cindex "boolean configuration values"
5073 .oindex "&%no_%&&'xxx'&"
5074 .oindex "&%not_%&&'xxx'&"
5075 Options whose type is given as boolean are on/off switches. There are two
5076 different ways of specifying such options: with and without a data value. If
5077 the option name is specified on its own without data, the switch is turned on;
5078 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5079 boolean options may be followed by an equals sign and one of the words
5080 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5081 the following two settings have exactly the same effect:
5082 .code
5083 queue_only
5084 queue_only = true
5085 .endd
5086 The following two lines also have the same (opposite) effect:
5087 .code
5088 no_queue_only
5089 queue_only = false
5090 .endd
5091 You can use whichever syntax you prefer.
5092
5093
5094
5095
5096 .section "Integer values" "SECID48"
5097 .cindex "integer configuration values"
5098 .cindex "format" "integer"
5099 If an option's type is given as &"integer"&, the value can be given in decimal,
5100 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5101 number is assumed. Otherwise, it is treated as an octal number unless it starts
5102 with the characters &"0x"&, in which case the remainder is interpreted as a
5103 hexadecimal number.
5104
5105 If an integer value is followed by the letter K, it is multiplied by 1024; if
5106 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5107 of integer option settings are output, values which are an exact multiple of
5108 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5109 and M. The printing style is independent of the actual input format that was
5110 used.
5111
5112
5113 .section "Octal integer values" "SECID49"
5114 .cindex "integer format"
5115 .cindex "format" "octal integer"
5116 If an option's type is given as &"octal integer"&, its value is always
5117 interpreted as an octal number, whether or not it starts with the digit zero.
5118 Such options are always output in octal.
5119
5120
5121 .section "Fixed point numbers" "SECID50"
5122 .cindex "fixed point configuration values"
5123 .cindex "format" "fixed point"
5124 If an option's type is given as &"fixed-point"&, its value must be a decimal
5125 integer, optionally followed by a decimal point and up to three further digits.
5126
5127
5128
5129 .section "Time intervals" "SECTtimeformat"
5130 .cindex "time interval" "specifying in configuration"
5131 .cindex "format" "time interval"
5132 A time interval is specified as a sequence of numbers, each followed by one of
5133 the following letters, with no intervening white space:
5134
5135 .table2 30pt
5136 .irow &%s%& seconds
5137 .irow &%m%& minutes
5138 .irow &%h%& hours
5139 .irow &%d%& days
5140 .irow &%w%& weeks
5141 .endtable
5142
5143 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5144 intervals are output in the same format. Exim does not restrict the values; it
5145 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5146
5147
5148
5149 .section "String values" "SECTstrings"
5150 .cindex "string" "format of configuration values"
5151 .cindex "format" "string"
5152 If an option's type is specified as &"string"&, the value can be specified with
5153 or without double-quotes. If it does not start with a double-quote, the value
5154 consists of the remainder of the line plus any continuation lines, starting at
5155 the first character after any leading white space, with trailing white space
5156 removed, and with no interpretation of the characters in the string. Because
5157 Exim removes comment lines (those beginning with #) at an early stage, they can
5158 appear in the middle of a multi-line string. The following two settings are
5159 therefore equivalent:
5160 .code
5161 trusted_users = uucp:mail
5162 trusted_users = uucp:\
5163                 # This comment line is ignored
5164                 mail
5165 .endd
5166 .cindex "string" "quoted"
5167 .cindex "escape characters in quoted strings"
5168 If a string does start with a double-quote, it must end with a closing
5169 double-quote, and any backslash characters other than those used for line
5170 continuation are interpreted as escape characters, as follows:
5171
5172 .table2 100pt
5173 .irow &`\\`&                     "single backslash"
5174 .irow &`\n`&                     "newline"
5175 .irow &`\r`&                     "carriage return"
5176 .irow &`\t`&                     "tab"
5177 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5178 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5179                                    character"
5180 .endtable
5181
5182 If a backslash is followed by some other character, including a double-quote
5183 character, that character replaces the pair.
5184
5185 Quoting is necessary only if you want to make use of the backslash escapes to
5186 insert special characters, or if you need to specify a value with leading or
5187 trailing spaces. These cases are rare, so quoting is almost never needed in
5188 current versions of Exim. In versions of Exim before 3.14, quoting was required
5189 in order to continue lines, so you may come across older configuration files
5190 and examples that apparently quote unnecessarily.
5191
5192
5193 .section "Expanded strings" "SECID51"
5194 .cindex "expansion" "definition of"
5195 Some strings in the configuration file are subjected to &'string expansion'&,
5196 by which means various parts of the string may be changed according to the
5197 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5198 is as just described; in particular, the handling of backslashes in quoted
5199 strings is done as part of the input process, before expansion takes place.
5200 However, backslash is also an escape character for the expander, so any
5201 backslashes that are required for that reason must be doubled if they are
5202 within a quoted configuration string.
5203
5204
5205 .section "User and group names" "SECID52"
5206 .cindex "user name" "format of"
5207 .cindex "format" "user name"
5208 .cindex "groups" "name format"
5209 .cindex "format" "group name"
5210 User and group names are specified as strings, using the syntax described
5211 above, but the strings are interpreted specially. A user or group name must
5212 either consist entirely of digits, or be a name that can be looked up using the
5213 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5214
5215
5216 .section "List construction" "SECTlistconstruct"
5217 .cindex "list" "syntax of in configuration"
5218 .cindex "format" "list item in configuration"
5219 .cindex "string" "list, definition of"
5220 The data for some configuration options is a list of items, with colon as the
5221 default separator. Many of these options are shown with type &"string list"& in
5222 the descriptions later in this document. Others are listed as &"domain list"&,
5223 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5224 are all the same; however, those other than &"string list"& are subject to
5225 particular kinds of interpretation, as described in chapter
5226 &<<CHAPdomhosaddlists>>&.
5227
5228 In all these cases, the entire list is treated as a single string as far as the
5229 input syntax is concerned. The &%trusted_users%& setting in section
5230 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5231 in a list, it must be entered as two colons. Leading and trailing white space
5232 on each item in a list is ignored. This makes it possible to include items that
5233 start with a colon, and in particular, certain forms of IPv6 address. For
5234 example, the list
5235 .code
5236 local_interfaces = 127.0.0.1 : ::::1
5237 .endd
5238 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5239
5240 &*Note*&: Although leading and trailing white space is ignored in individual
5241 list items, it is not ignored when parsing the list. The space after the first
5242 colon in the example above is necessary. If it were not there, the list would
5243 be interpreted as the two items 127.0.0.1:: and 1.
5244
5245 .section "Changing list separators" "SECTlistsepchange"
5246 .cindex "list separator" "changing"
5247 .cindex "IPv6" "addresses in lists"
5248 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5249 introduced to allow the separator character to be changed. If a list begins
5250 with a left angle bracket, followed by any punctuation character, that
5251 character is used instead of colon as the list separator. For example, the list
5252 above can be rewritten to use a semicolon separator like this:
5253 .code
5254 local_interfaces = <; 127.0.0.1 ; ::1
5255 .endd
5256 This facility applies to all lists, with the exception of the list in
5257 &%log_file_path%&. It is recommended that the use of non-colon separators be
5258 confined to circumstances where they really are needed.
5259
5260 .cindex "list separator" "newline as"
5261 .cindex "newline" "as list separator"
5262 It is also possible to use newline and other control characters (those with
5263 code values less than 32, plus DEL) as separators in lists. Such separators
5264 must be provided literally at the time the list is processed. For options that
5265 are string-expanded, you can write the separator using a normal escape
5266 sequence. This will be processed by the expander before the string is
5267 interpreted as a list. For example, if a newline-separated list of domains is
5268 generated by a lookup, you can process it directly by a line such as this:
5269 .code
5270 domains = <\n ${lookup mysql{.....}}
5271 .endd
5272 This avoids having to change the list separator in such data. You are unlikely
5273 to want to use a control character as a separator in an option that is not
5274 expanded, because the value is literal text. However, it can be done by giving
5275 the value in quotes. For example:
5276 .code
5277 local_interfaces = "<\n 127.0.0.1 \n ::1"
5278 .endd
5279 Unlike printing character separators, which can be included in list items by
5280 doubling, it is not possible to include a control character as data when it is
5281 set as the separator. Two such characters in succession are interpreted as
5282 enclosing an empty list item.
5283
5284
5285
5286 .section "Empty items in lists" "SECTempitelis"
5287 .cindex "list" "empty item in"
5288 An empty item at the end of a list is always ignored. In other words, trailing
5289 separator characters are ignored. Thus, the list in
5290 .code
5291 senders = user@domain :
5292 .endd
5293 contains only a single item. If you want to include an empty string as one item
5294 in a list, it must not be the last item. For example, this list contains three
5295 items, the second of which is empty:
5296 .code
5297 senders = user1@domain : : user2@domain
5298 .endd
5299 &*Note*&: There must be white space between the two colons, as otherwise they
5300 are interpreted as representing a single colon data character (and the list
5301 would then contain just one item). If you want to specify a list that contains
5302 just one, empty item, you can do it as in this example:
5303 .code
5304 senders = :
5305 .endd
5306 In this case, the first item is empty, and the second is discarded because it
5307 is at the end of the list.
5308
5309
5310
5311
5312 .section "Format of driver configurations" "SECTfordricon"
5313 .cindex "drivers" "configuration format"
5314 There are separate parts in the configuration for defining routers, transports,
5315 and authenticators. In each part, you are defining a number of driver
5316 instances, each with its own set of options. Each driver instance is defined by
5317 a sequence of lines like this:
5318 .display
5319 <&'instance name'&>:
5320   <&'option'&>
5321   ...
5322   <&'option'&>
5323 .endd
5324 In the following example, the instance name is &(localuser)&, and it is
5325 followed by three options settings:
5326 .code
5327 localuser:
5328   driver = accept
5329   check_local_user
5330   transport = local_delivery
5331 .endd
5332 For each driver instance, you specify which Exim code module it uses &-- by the
5333 setting of the &%driver%& option &-- and (optionally) some configuration
5334 settings. For example, in the case of transports, if you want a transport to
5335 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5336 a local file you would use the &(appendfile)& driver. Each of the drivers is
5337 described in detail in its own separate chapter later in this manual.
5338
5339 You can have several routers, transports, or authenticators that are based on
5340 the same underlying driver (each must have a different instance name).
5341
5342 The order in which routers are defined is important, because addresses are
5343 passed to individual routers one by one, in order. The order in which
5344 transports are defined does not matter at all. The order in which
5345 authenticators are defined is used only when Exim, as a client, is searching
5346 them to find one that matches an authentication mechanism offered by the
5347 server.
5348
5349 .cindex "generic options"
5350 .cindex "options" "generic &-- definition of"
5351 Within a driver instance definition, there are two kinds of option: &'generic'&
5352 and &'private'&. The generic options are those that apply to all drivers of the
5353 same type (that is, all routers, all transports or all authenticators). The
5354 &%driver%& option is a generic option that must appear in every definition.
5355 .cindex "private options"
5356 The private options are special for each driver, and none need appear, because
5357 they all have default values.
5358
5359 The options may appear in any order, except that the &%driver%& option must
5360 precede any private options, since these depend on the particular driver. For
5361 this reason, it is recommended that &%driver%& always be the first option.
5362
5363 Driver instance names, which are used for reference in log entries and
5364 elsewhere, can be any sequence of letters, digits, and underscores (starting
5365 with a letter) and must be unique among drivers of the same type. A router and
5366 a transport (for example) can each have the same name, but no two router
5367 instances can have the same name. The name of a driver instance should not be
5368 confused with the name of the underlying driver module. For example, the
5369 configuration lines:
5370 .code
5371 remote_smtp:
5372   driver = smtp
5373 .endd
5374 create an instance of the &(smtp)& transport driver whose name is
5375 &(remote_smtp)&. The same driver code can be used more than once, with
5376 different instance names and different option settings each time. A second
5377 instance of the &(smtp)& transport, with different options, might be defined
5378 thus:
5379 .code
5380 special_smtp:
5381   driver = smtp
5382   port = 1234
5383   command_timeout = 10s
5384 .endd
5385 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5386 these transport instances from routers, and these names would appear in log
5387 lines.
5388
5389 Comment lines may be present in the middle of driver specifications. The full
5390 list of option settings for any particular driver instance, including all the
5391 defaulted values, can be extracted by making use of the &%-bP%& command line
5392 option.
5393
5394
5395
5396
5397
5398
5399 . ////////////////////////////////////////////////////////////////////////////
5400 . ////////////////////////////////////////////////////////////////////////////
5401
5402 .chapter "The default configuration file" "CHAPdefconfil"
5403 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5404 .cindex "default" "configuration file &""walk through""&"
5405 The default configuration file supplied with Exim as &_src/configure.default_&
5406 is sufficient for a host with simple mail requirements. As an introduction to
5407 the way Exim is configured, this chapter &"walks through"& the default
5408 configuration, giving brief explanations of the settings. Detailed descriptions
5409 of the options are given in subsequent chapters. The default configuration file
5410 itself contains extensive comments about ways you might want to modify the
5411 initial settings. However, note that there are many options that are not
5412 mentioned at all in the default configuration.
5413
5414
5415
5416 .section "Main configuration settings" "SECTdefconfmain"
5417 The main (global) configuration option settings must always come first in the
5418 file. The first thing you'll see in the file, after some initial comments, is
5419 the line
5420 .code
5421 # primary_hostname =
5422 .endd
5423 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5424 to know the official, fully qualified name of your host, and this is where you
5425 can specify it. However, in most cases you do not need to set this option. When
5426 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5427
5428 The first three non-comment configuration lines are as follows:
5429 .code
5430 domainlist local_domains    = @
5431 domainlist relay_to_domains =
5432 hostlist   relay_from_hosts = 127.0.0.1
5433 .endd
5434 These are not, in fact, option settings. They are definitions of two named
5435 domain lists and one named host list. Exim allows you to give names to lists of
5436 domains, hosts, and email addresses, in order to make it easier to manage the
5437 configuration file (see section &<<SECTnamedlists>>&).
5438
5439 The first line defines a domain list called &'local_domains'&; this is used
5440 later in the configuration to identify domains that are to be delivered
5441 on the local host.
5442
5443 .cindex "@ in a domain list"
5444 There is just one item in this list, the string &"@"&. This is a special form
5445 of entry which means &"the name of the local host"&. Thus, if the local host is
5446 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5447 be delivered locally. Because the local host's name is referenced indirectly,
5448 the same configuration file can be used on different hosts.
5449
5450 The second line defines a domain list called &'relay_to_domains'&, but the
5451 list itself is empty. Later in the configuration we will come to the part that
5452 controls mail relaying through the local host; it allows relaying to any
5453 domains in this list. By default, therefore, no relaying on the basis of a mail
5454 domain is permitted.
5455
5456 The third line defines a host list called &'relay_from_hosts'&. This list is
5457 used later in the configuration to permit relaying from any host or IP address
5458 that matches the list. The default contains just the IP address of the IPv4
5459 loopback interface, which means that processes on the local host are able to
5460 submit mail for relaying by sending it over TCP/IP to that interface. No other
5461 hosts are permitted to submit messages for relaying.
5462
5463 Just to be sure there's no misunderstanding: at this point in the configuration
5464 we aren't actually setting up any controls. We are just defining some domains
5465 and hosts that will be used in the controls that are specified later.
5466
5467 The next two configuration lines are genuine option settings:
5468 .code
5469 acl_smtp_rcpt = acl_check_rcpt
5470 acl_smtp_data = acl_check_data
5471 .endd
5472 These options specify &'Access Control Lists'& (ACLs) that are to be used
5473 during an incoming SMTP session for every recipient of a message (every RCPT
5474 command), and after the contents of the message have been received,
5475 respectively. The names of the lists are &'acl_check_rcpt'& and
5476 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5477 section of the configuration. The RCPT ACL controls which recipients are
5478 accepted for an incoming message &-- if a configuration does not provide an ACL
5479 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5480 contents of a message to be checked.
5481
5482 Two commented-out option settings are next:
5483 .code
5484 # av_scanner = clamd:/tmp/clamd
5485 # spamd_address = 127.0.0.1 783
5486 .endd
5487 These are example settings that can be used when Exim is compiled with the
5488 content-scanning extension. The first specifies the interface to the virus
5489 scanner, and the second specifies the interface to SpamAssassin. Further
5490 details are given in chapter &<<CHAPexiscan>>&.
5491
5492 Three more commented-out option settings follow:
5493 .code
5494 # tls_advertise_hosts = *
5495 # tls_certificate = /etc/ssl/exim.crt
5496 # tls_privatekey = /etc/ssl/exim.pem
5497 .endd
5498 These are example settings that can be used when Exim is compiled with
5499 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5500 first one specifies the list of clients that are allowed to use TLS when
5501 connecting to this server; in this case the wildcard means all clients. The
5502 other options specify where Exim should find its TLS certificate and private
5503 key, which together prove the server's identity to any clients that connect.
5504 More details are given in chapter &<<CHAPTLS>>&.
5505
5506 Another two commented-out option settings follow:
5507 .code
5508 # daemon_smtp_ports = 25 : 465 : 587
5509 # tls_on_connect_ports = 465
5510 .endd
5511 .cindex "port" "465 and 587"
5512 .cindex "port" "for message submission"
5513 .cindex "message" "submission, ports for"
5514 .cindex "ssmtp protocol"
5515 .cindex "smtps protocol"
5516 .cindex "SMTP" "ssmtp protocol"
5517 .cindex "SMTP" "smtps protocol"
5518 These options provide better support for roaming users who wish to use this
5519 server for message submission. They are not much use unless you have turned on
5520 TLS (as described in the previous paragraph) and authentication (about which
5521 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5522 on end-user networks, so RFC 4409 specifies that message submission should use
5523 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5524 configured to use port 587 correctly, so these settings also enable the
5525 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5526 &<<SECTsupobssmt>>&).
5527
5528 Two more commented-out options settings follow:
5529 .code
5530 # qualify_domain =
5531 # qualify_recipient =
5532 .endd
5533 The first of these specifies a domain that Exim uses when it constructs a
5534 complete email address from a local login name. This is often needed when Exim
5535 receives a message from a local process. If you do not set &%qualify_domain%&,
5536 the value of &%primary_hostname%& is used. If you set both of these options,
5537 you can have different qualification domains for sender and recipient
5538 addresses. If you set only the first one, its value is used in both cases.
5539
5540 .cindex "domain literal" "recognizing format"
5541 The following line must be uncommented if you want Exim to recognize
5542 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5543 (an IP address within square brackets) instead of a named domain.
5544 .code
5545 # allow_domain_literals
5546 .endd
5547 The RFCs still require this form, but many people think that in the modern
5548 Internet it makes little sense to permit mail to be sent to specific hosts by
5549 quoting their IP addresses. This ancient format has been used by people who
5550 try to abuse hosts by using them for unwanted relaying. However, some
5551 people believe there are circumstances (for example, messages addressed to
5552 &'postmaster'&) where domain literals are still useful.
5553
5554 The next configuration line is a kind of trigger guard:
5555 .code
5556 never_users = root
5557 .endd
5558 It specifies that no delivery must ever be run as the root user. The normal
5559 convention is to set up &'root'& as an alias for the system administrator. This
5560 setting is a guard against slips in the configuration.
5561 The list of users specified by &%never_users%& is not, however, the complete
5562 list; the build-time configuration in &_Local/Makefile_& has an option called
5563 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5564 contents of &%never_users%& are added to this list. By default
5565 FIXED_NEVER_USERS also specifies root.
5566
5567 When a remote host connects to Exim in order to send mail, the only information
5568 Exim has about the host's identity is its IP address. The next configuration
5569 line,
5570 .code
5571 host_lookup = *
5572 .endd
5573 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5574 in order to get a host name. This improves the quality of the logging
5575 information, but if you feel it is too expensive, you can remove it entirely,
5576 or restrict the lookup to hosts on &"nearby"& networks.
5577 Note that it is not always possible to find a host name from an IP address,
5578 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5579 unreachable.
5580
5581 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5582 1413 (hence their names):
5583 .code
5584 rfc1413_hosts = *
5585 rfc1413_query_timeout = 0s
5586 .endd
5587 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5588 Few hosts offer RFC1413 service these days; calls have to be
5589 terminated by a timeout and this needlessly delays the startup
5590 of an incoming SMTP connection.
5591 If you have hosts for which you trust RFC1413 and need this
5592 information, you can change this.
5593
5594 This line enables an efficiency SMTP option.  It is negotiated by clients
5595 and not expected to cause problems but can be disabled if needed.
5596 .code
5597 prdr_enable = true
5598 .endd
5599
5600 When Exim receives messages over SMTP connections, it expects all addresses to
5601 be fully qualified with a domain, as required by the SMTP definition. However,
5602 if you are running a server to which simple clients submit messages, you may
5603 find that they send unqualified addresses. The two commented-out options:
5604 .code
5605 # sender_unqualified_hosts =
5606 # recipient_unqualified_hosts =
5607 .endd
5608 show how you can specify hosts that are permitted to send unqualified sender
5609 and recipient addresses, respectively.
5610
5611 The &%log_selector%& option is used to increase the detail of logging
5612 over the default:
5613 .code
5614 log_selector = +smtp_protocol_error +smtp_syntax_error \
5615                +tls_certificate_verified
5616 .endd
5617
5618 The &%percent_hack_domains%& option is also commented out:
5619 .code
5620 # percent_hack_domains =
5621 .endd
5622 It provides a list of domains for which the &"percent hack"& is to operate.
5623 This is an almost obsolete form of explicit email routing. If you do not know
5624 anything about it, you can safely ignore this topic.
5625
5626 The next two settings in the main part of the default configuration are
5627 concerned with messages that have been &"frozen"& on Exim's queue. When a
5628 message is frozen, Exim no longer continues to try to deliver it. Freezing
5629 occurs when a bounce message encounters a permanent failure because the sender
5630 address of the original message that caused the bounce is invalid, so the
5631 bounce cannot be delivered. This is probably the most common case, but there
5632 are also other conditions that cause freezing, and frozen messages are not
5633 always bounce messages.
5634 .code
5635 ignore_bounce_errors_after = 2d
5636 timeout_frozen_after = 7d
5637 .endd
5638 The first of these options specifies that failing bounce messages are to be
5639 discarded after 2 days on the queue. The second specifies that any frozen
5640 message (whether a bounce message or not) is to be timed out (and discarded)
5641 after a week. In this configuration, the first setting ensures that no failing
5642 bounce message ever lasts a week.
5643
5644 Exim queues it's messages in a spool directory. If you expect to have
5645 large queues, you may consider using this option. It splits the spool
5646 directory into subdirectories to avoid file system degradation from
5647 many files in a single directory, resulting in better performance.
5648 Manual manipulation of queued messages becomes more complex (though fortunately 
5649 not often needed).
5650 .code
5651 # split_spool_directory = true
5652 .endd
5653
5654 In an ideal world everybody follows the standards. For non-ASCII
5655 messages RFC 2047 is a standard, allowing a maximum line length of 76
5656 characters. Exim adheres that standard and won't process messages which
5657 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5658 In particular, the Exim maintainers have had multiple reports of
5659 problems from Russian administrators of issues until they disable this
5660 check, because of some popular, yet buggy, mail composition software.
5661 .code
5662 # check_rfc2047_length = false
5663 .endd
5664
5665 If you need to be strictly RFC compliant you may wish to disable the
5666 8BITMIME advertisement. Use this, if you exchange mails with systems
5667 that are not 8-bit clean.
5668 .code
5669 # accept_8bitmime = false
5670 .endd
5671
5672 Libraries you use may depend on specific environment settings.  This
5673 imposes a security risk (e.g. PATH). There are two lists:
5674 &%keep_environment%& for the variables to import as they are, and
5675 &%add_environment%& for variables we want to set to a fixed value.
5676 Note that TZ is handled separately, by the $%timezone%$ runtime
5677 option and by the TIMEZONE_DEFAULT buildtime option.
5678 .code
5679 # keep_environment = ^LDAP
5680 # add_environment = PATH=/usr/bin::/bin
5681 .endd
5682
5683
5684 .section "ACL configuration" "SECID54"
5685 .cindex "default" "ACLs"
5686 .cindex "&ACL;" "default configuration"
5687 In the default configuration, the ACL section follows the main configuration.
5688 It starts with the line
5689 .code
5690 begin acl
5691 .endd
5692 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5693 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5694 and &%acl_smtp_data%& above.
5695
5696 .cindex "RCPT" "ACL for"
5697 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5698 RCPT command specifies one of the message's recipients. The ACL statements
5699 are considered in order, until the recipient address is either accepted or
5700 rejected. The RCPT command is then accepted or rejected, according to the
5701 result of the ACL processing.
5702 .code
5703 acl_check_rcpt:
5704 .endd
5705 This line, consisting of a name terminated by a colon, marks the start of the
5706 ACL, and names it.
5707 .code
5708 accept  hosts = :
5709 .endd
5710 This ACL statement accepts the recipient if the sending host matches the list.
5711 But what does that strange list mean? It doesn't actually contain any host
5712 names or IP addresses. The presence of the colon puts an empty item in the
5713 list; Exim matches this only if the incoming message did not come from a remote
5714 host, because in that case, the remote hostname is empty. The colon is
5715 important. Without it, the list itself is empty, and can never match anything.
5716
5717 What this statement is doing is to accept unconditionally all recipients in
5718 messages that are submitted by SMTP from local processes using the standard
5719 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5720 manner.
5721 .code
5722 deny    message       = Restricted characters in address
5723         domains       = +local_domains
5724         local_parts   = ^[.] : ^.*[@%!/|]
5725
5726 deny    message       = Restricted characters in address
5727         domains       = !+local_domains
5728         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5729 .endd
5730 These statements are concerned with local parts that contain any of the
5731 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5732 Although these characters are entirely legal in local parts (in the case of
5733 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5734 in Internet mail addresses.
5735
5736 The first three have in the past been associated with explicitly routed
5737 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5738 option). Addresses containing these characters are regularly tried by spammers
5739 in an attempt to bypass relaying restrictions, and also by open relay testing
5740 programs. Unless you really need them it is safest to reject these characters
5741 at this early stage. This configuration is heavy-handed in rejecting these
5742 characters for all messages it accepts from remote hosts. This is a deliberate
5743 policy of being as safe as possible.
5744
5745 The first rule above is stricter, and is applied to messages that are addressed
5746 to one of the local domains handled by this host. This is implemented by the
5747 first condition, which restricts it to domains that are listed in the
5748 &'local_domains'& domain list. The &"+"& character is used to indicate a
5749 reference to a named list. In this configuration, there is just one domain in
5750 &'local_domains'&, but in general there may be many.
5751
5752 The second condition on the first statement uses two regular expressions to
5753 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5754 or &"|"&. If you have local accounts that include these characters, you will
5755 have to modify this rule.
5756
5757 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5758 allows them because they have been encountered in practice. (Consider the
5759 common convention of local parts constructed as
5760 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5761 the author of Exim, who has no second initial.) However, a local part starting
5762 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5763 file name (for example, for a mailing list). This is also true for local parts
5764 that contain slashes. A pipe symbol can also be troublesome if the local part
5765 is incorporated unthinkingly into a shell command line.
5766
5767 The second rule above applies to all other domains, and is less strict. This
5768 allows your own users to send outgoing messages to sites that use slashes
5769 and vertical bars in their local parts. It blocks local parts that begin
5770 with a dot, slash, or vertical bar, but allows these characters within the
5771 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5772 and &"!"& is blocked, as before. The motivation here is to prevent your users
5773 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5774 .code
5775 accept  local_parts   = postmaster
5776         domains       = +local_domains
5777 .endd
5778 This statement, which has two conditions, accepts an incoming address if the
5779 local part is &'postmaster'& and the domain is one of those listed in the
5780 &'local_domains'& domain list. The &"+"& character is used to indicate a
5781 reference to a named list. In this configuration, there is just one domain in
5782 &'local_domains'&, but in general there may be many.
5783
5784 The presence of this statement means that mail to postmaster is never blocked
5785 by any of the subsequent tests. This can be helpful while sorting out problems
5786 in cases where the subsequent tests are incorrectly denying access.
5787 .code
5788 require verify        = sender
5789 .endd
5790 This statement requires the sender address to be verified before any subsequent
5791 ACL statement can be used. If verification fails, the incoming recipient
5792 address is refused. Verification consists of trying to route the address, to
5793 see if a bounce message could be delivered to it. In the case of remote
5794 addresses, basic verification checks only the domain, but &'callouts'& can be
5795 used for more verification if required. Section &<<SECTaddressverification>>&
5796 discusses the details of address verification.
5797 .code
5798 accept  hosts         = +relay_from_hosts
5799         control       = submission
5800 .endd
5801 This statement accepts the address if the message is coming from one of the
5802 hosts that are defined as being allowed to relay through this host. Recipient
5803 verification is omitted here, because in many cases the clients are dumb MUAs
5804 that do not cope well with SMTP error responses. For the same reason, the
5805 second line specifies &"submission mode"& for messages that are accepted. This
5806 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5807 messages that are deficient in some way, for example, because they lack a
5808 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5809 probably add recipient verification here, and disable submission mode.
5810 .code
5811 accept  authenticated = *
5812         control       = submission
5813 .endd
5814 This statement accepts the address if the client host has authenticated itself.
5815 Submission mode is again specified, on the grounds that such messages are most
5816 likely to come from MUAs. The default configuration does not define any
5817 authenticators, though it does include some nearly complete commented-out
5818 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5819 fact authenticate until you complete the authenticator definitions.
5820 .code
5821 require message = relay not permitted
5822         domains = +local_domains : +relay_to_domains
5823 .endd
5824 This statement rejects the address if its domain is neither a local domain nor
5825 one of the domains for which this host is a relay.
5826 .code
5827 require verify = recipient
5828 .endd
5829 This statement requires the recipient address to be verified; if verification
5830 fails, the address is rejected.
5831 .code
5832 # deny    message     = rejected because $sender_host_address \
5833 #                       is in a black list at $dnslist_domain\n\
5834 #                       $dnslist_text
5835 #         dnslists    = black.list.example
5836 #
5837 # warn    dnslists    = black.list.example
5838 #         add_header  = X-Warning: $sender_host_address is in \
5839 #                       a black list at $dnslist_domain
5840 #         log_message = found in $dnslist_domain
5841 .endd
5842 These commented-out lines are examples of how you could configure Exim to check
5843 sending hosts against a DNS black list. The first statement rejects messages
5844 from blacklisted hosts, whereas the second just inserts a warning header
5845 line.
5846 .code
5847 # require verify = csa
5848 .endd
5849 This commented-out line is an example of how you could turn on client SMTP
5850 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5851 records.
5852 .code
5853 accept
5854 .endd
5855 The final statement in the first ACL unconditionally accepts any recipient
5856 address that has successfully passed all the previous tests.
5857 .code
5858 acl_check_data:
5859 .endd
5860 This line marks the start of the second ACL, and names it. Most of the contents
5861 of this ACL are commented out:
5862 .code
5863 # deny    malware   = *
5864 #         message   = This message contains a virus \
5865 #                     ($malware_name).
5866 .endd
5867 These lines are examples of how to arrange for messages to be scanned for
5868 viruses when Exim has been compiled with the content-scanning extension, and a
5869 suitable virus scanner is installed. If the message is found to contain a
5870 virus, it is rejected with the given custom error message.
5871 .code
5872 # warn    spam      = nobody
5873 #         message   = X-Spam_score: $spam_score\n\
5874 #                     X-Spam_score_int: $spam_score_int\n\
5875 #                     X-Spam_bar: $spam_bar\n\
5876 #                     X-Spam_report: $spam_report
5877 .endd
5878 These lines are an example of how to arrange for messages to be scanned by
5879 SpamAssassin when Exim has been compiled with the content-scanning extension,
5880 and SpamAssassin has been installed. The SpamAssassin check is run with
5881 &`nobody`& as its user parameter, and the results are added to the message as a
5882 series of extra header line. In this case, the message is not rejected,
5883 whatever the spam score.
5884 .code
5885 accept
5886 .endd
5887 This final line in the DATA ACL accepts the message unconditionally.
5888
5889
5890 .section "Router configuration" "SECID55"
5891 .cindex "default" "routers"
5892 .cindex "routers" "default"
5893 The router configuration comes next in the default configuration, introduced
5894 by the line
5895 .code
5896 begin routers
5897 .endd
5898 Routers are the modules in Exim that make decisions about where to send
5899 messages. An address is passed to each router in turn, until it is either
5900 accepted, or failed. This means that the order in which you define the routers
5901 matters. Each router is fully described in its own chapter later in this
5902 manual. Here we give only brief overviews.
5903 .code
5904 # domain_literal:
5905 #   driver = ipliteral
5906 #   domains = !+local_domains
5907 #   transport = remote_smtp
5908 .endd
5909 .cindex "domain literal" "default router"
5910 This router is commented out because the majority of sites do not want to
5911 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5912 you uncomment this router, you also need to uncomment the setting of
5913 &%allow_domain_literals%& in the main part of the configuration.
5914 .code
5915 dnslookup:
5916   driver = dnslookup
5917   domains = ! +local_domains
5918   transport = remote_smtp
5919   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5920   no_more
5921 .endd
5922 The first uncommented router handles addresses that do not involve any local
5923 domains. This is specified by the line
5924 .code
5925 domains = ! +local_domains
5926 .endd
5927 The &%domains%& option lists the domains to which this router applies, but the
5928 exclamation mark is a negation sign, so the router is used only for domains
5929 that are not in the domain list called &'local_domains'& (which was defined at
5930 the start of the configuration). The plus sign before &'local_domains'&
5931 indicates that it is referring to a named list. Addresses in other domains are
5932 passed on to the following routers.
5933
5934 The name of the router driver is &(dnslookup)&,
5935 and is specified by the &%driver%& option. Do not be confused by the fact that
5936 the name of this router instance is the same as the name of the driver. The
5937 instance name is arbitrary, but the name set in the &%driver%& option must be
5938 one of the driver modules that is in the Exim binary.
5939
5940 The &(dnslookup)& router routes addresses by looking up their domains in the
5941 DNS in order to obtain a list of hosts to which the address is routed. If the
5942 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5943 specified by the &%transport%& option. If the router does not find the domain
5944 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5945 the address fails and is bounced.
5946
5947 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5948 be entirely ignored. This option is present because a number of cases have been
5949 encountered where MX records in the DNS point to host names
5950 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5951 Completely ignoring these IP addresses causes Exim to fail to route the
5952 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5953 continue to try to deliver the message periodically until the address timed
5954 out.
5955 .code
5956 system_aliases:
5957   driver = redirect
5958   allow_fail
5959   allow_defer
5960   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5961 # user = exim
5962   file_transport = address_file
5963   pipe_transport = address_pipe
5964 .endd
5965 Control reaches this and subsequent routers only for addresses in the local
5966 domains. This router checks to see whether the local part is defined as an
5967 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5968 data that it looks up from that file. If no data is found for the local part,
5969 the value of the &%data%& option is empty, causing the address to be passed to
5970 the next router.
5971
5972 &_/etc/aliases_& is a conventional name for the system aliases file that is
5973 often used. That is why it is referenced by from the default configuration
5974 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5975 &_Local/Makefile_& before building Exim.
5976 .code
5977 userforward:
5978   driver = redirect
5979   check_local_user
5980 # local_part_suffix = +* : -*
5981 # local_part_suffix_optional
5982   file = $home/.forward
5983 # allow_filter
5984   no_verify
5985   no_expn
5986   check_ancestor
5987   file_transport = address_file
5988   pipe_transport = address_pipe
5989   reply_transport = address_reply
5990 .endd
5991 This is the most complicated router in the default configuration. It is another
5992 redirection router, but this time it is looking for forwarding data set up by
5993 individual users. The &%check_local_user%& setting specifies a check that the
5994 local part of the address is the login name of a local user. If it is not, the
5995 router is skipped. The two commented options that follow &%check_local_user%&,
5996 namely:
5997 .code
5998 # local_part_suffix = +* : -*
5999 # local_part_suffix_optional
6000 .endd
6001 .vindex "&$local_part_suffix$&"
6002 show how you can specify the recognition of local part suffixes. If the first
6003 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6004 by any sequence of characters, is removed from the local part and placed in the
6005 variable &$local_part_suffix$&. The second suffix option specifies that the
6006 presence of a suffix in the local part is optional. When a suffix is present,
6007 the check for a local login uses the local part with the suffix removed.
6008
6009 When a local user account is found, the file called &_.forward_& in the user's
6010 home directory is consulted. If it does not exist, or is empty, the router
6011 declines. Otherwise, the contents of &_.forward_& are interpreted as
6012 redirection data (see chapter &<<CHAPredirect>>& for more details).
6013
6014 .cindex "Sieve filter" "enabling in default router"
6015 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6016 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6017 is commented out by default), the contents of the file are interpreted as a set
6018 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6019 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6020 separate document entitled &'Exim's interfaces to mail filtering'&.
6021
6022 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6023 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6024 There are two reasons for doing this:
6025
6026 .olist
6027 Whether or not a local user has a &_.forward_& file is not really relevant when
6028 checking an address for validity; it makes sense not to waste resources doing
6029 unnecessary work.
6030 .next
6031 More importantly, when Exim is verifying addresses or handling an EXPN
6032 command during an SMTP session, it is running as the Exim user, not as root.
6033 The group is the Exim group, and no additional groups are set up.
6034 It may therefore not be possible for Exim to read users' &_.forward_& files at
6035 this time.
6036 .endlist
6037
6038 The setting of &%check_ancestor%& prevents the router from generating a new
6039 address that is the same as any previous address that was redirected. (This
6040 works round a problem concerning a bad interaction between aliasing and
6041 forwarding &-- see section &<<SECTredlocmai>>&).
6042
6043 The final three option settings specify the transports that are to be used when
6044 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6045 auto-reply, respectively. For example, if a &_.forward_& file contains
6046 .code
6047 a.nother@elsewhere.example, /home/spqr/archive
6048 .endd
6049 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6050 transport.
6051 .code
6052 localuser:
6053   driver = accept
6054   check_local_user
6055 # local_part_suffix = +* : -*
6056 # local_part_suffix_optional
6057   transport = local_delivery
6058 .endd
6059 The final router sets up delivery into local mailboxes, provided that the local
6060 part is the name of a local login, by accepting the address and assigning it to
6061 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6062 routers, so the address is bounced. The commented suffix settings fulfil the
6063 same purpose as they do for the &(userforward)& router.
6064
6065
6066 .section "Transport configuration" "SECID56"
6067 .cindex "default" "transports"
6068 .cindex "transports" "default"
6069 Transports define mechanisms for actually delivering messages. They operate
6070 only when referenced from routers, so the order in which they are defined does
6071 not matter. The transports section of the configuration starts with
6072 .code
6073 begin transports
6074 .endd
6075 One remote transport and four local transports are defined.
6076 .code
6077 remote_smtp:
6078   driver = smtp
6079   hosts_try_prdr = *
6080 .endd
6081 This transport is used for delivering messages over SMTP connections.
6082 The list of remote hosts comes from the router.
6083 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6084 It is negotiated between client and server
6085 and not expected to cause problems but can be disabled if needed.
6086 All other options are defaulted.
6087 .code
6088 local_delivery:
6089   driver = appendfile
6090   file = /var/mail/$local_part
6091   delivery_date_add
6092   envelope_to_add
6093   return_path_add
6094 # group = mail
6095 # mode = 0660
6096 .endd
6097 This &(appendfile)& transport is used for local delivery to user mailboxes in
6098 traditional BSD mailbox format. By default it runs under the uid and gid of the
6099 local user, which requires the sticky bit to be set on the &_/var/mail_&
6100 directory. Some systems use the alternative approach of running mail deliveries
6101 under a particular group instead of using the sticky bit. The commented options
6102 show how this can be done.
6103
6104 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6105 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6106 similarly-named options above.
6107 .code
6108 address_pipe:
6109   driver = pipe
6110   return_output
6111 .endd
6112 This transport is used for handling deliveries to pipes that are generated by
6113 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6114 option specifies that any output on stdout or stderr generated by the pipe is to
6115 be returned to the sender.
6116 .code
6117 address_file:
6118   driver = appendfile
6119   delivery_date_add
6120   envelope_to_add
6121   return_path_add
6122 .endd
6123 This transport is used for handling deliveries to files that are generated by
6124 redirection. The name of the file is not specified in this instance of
6125 &(appendfile)&, because it comes from the &(redirect)& router.
6126 .code
6127 address_reply:
6128   driver = autoreply
6129 .endd
6130 This transport is used for handling automatic replies generated by users'
6131 filter files.
6132
6133
6134
6135 .section "Default retry rule" "SECID57"
6136 .cindex "retry" "default rule"
6137 .cindex "default" "retry rule"
6138 The retry section of the configuration file contains rules which affect the way
6139 Exim retries deliveries that cannot be completed at the first attempt. It is
6140 introduced by the line
6141 .code
6142 begin retry
6143 .endd
6144 In the default configuration, there is just one rule, which applies to all
6145 errors:
6146 .code
6147 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6148 .endd
6149 This causes any temporarily failing address to be retried every 15 minutes for
6150 2 hours, then at intervals starting at one hour and increasing by a factor of
6151 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6152 is not delivered after 4 days of temporary failure, it is bounced.
6153
6154 If the retry section is removed from the configuration, or is empty (that is,
6155 if no retry rules are defined), Exim will not retry deliveries. This turns
6156 temporary errors into permanent errors.
6157
6158
6159 .section "Rewriting configuration" "SECID58"
6160 The rewriting section of the configuration, introduced by
6161 .code
6162 begin rewrite
6163 .endd
6164 contains rules for rewriting addresses in messages as they arrive. There are no
6165 rewriting rules in the default configuration file.
6166
6167
6168
6169 .section "Authenticators configuration" "SECTdefconfauth"
6170 .cindex "AUTH" "configuration"
6171 The authenticators section of the configuration, introduced by
6172 .code
6173 begin authenticators
6174 .endd
6175 defines mechanisms for the use of the SMTP AUTH command. The default
6176 configuration file contains two commented-out example authenticators
6177 which support plaintext username/password authentication using the
6178 standard PLAIN mechanism and the traditional but non-standard LOGIN
6179 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6180 to support most MUA software.
6181
6182 The example PLAIN authenticator looks like this:
6183 .code
6184 #PLAIN:
6185 #  driver                  = plaintext
6186 #  server_set_id           = $auth2
6187 #  server_prompts          = :
6188 #  server_condition        = Authentication is not yet configured
6189 #  server_advertise_condition = ${if def:tls_in_cipher }
6190 .endd
6191 And the example LOGIN authenticator looks like this:
6192 .code
6193 #LOGIN:
6194 #  driver                  = plaintext
6195 #  server_set_id           = $auth1
6196 #  server_prompts          = <| Username: | Password:
6197 #  server_condition        = Authentication is not yet configured
6198 #  server_advertise_condition = ${if def:tls_in_cipher }
6199 .endd
6200
6201 The &%server_set_id%& option makes Exim remember the authenticated username
6202 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6203 &%server_prompts%& option configures the &(plaintext)& authenticator so
6204 that it implements the details of the specific authentication mechanism,
6205 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6206 when Exim offers authentication to clients; in the examples, this is only
6207 when TLS or SSL has been started, so to enable the authenticators you also
6208 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6209
6210 The &%server_condition%& setting defines how to verify that the username and
6211 password are correct. In the examples it just produces an error message.
6212 To make the authenticators work, you can use a string expansion
6213 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6214
6215 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6216 usercode and password are in different positions.
6217 Chapter &<<CHAPplaintext>>& covers both.
6218
6219 .ecindex IIDconfiwal
6220
6221
6222
6223 . ////////////////////////////////////////////////////////////////////////////
6224 . ////////////////////////////////////////////////////////////////////////////
6225
6226 .chapter "Regular expressions" "CHAPregexp"
6227
6228 .cindex "regular expressions" "library"
6229 .cindex "PCRE"
6230 Exim supports the use of regular expressions in many of its options. It
6231 uses the PCRE regular expression library; this provides regular expression
6232 matching that is compatible with Perl 5. The syntax and semantics of
6233 regular expressions is discussed in many Perl reference books, and also in
6234 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6235 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6236
6237 The documentation for the syntax and semantics of the regular expressions that
6238 are supported by PCRE is included in the PCRE distribution, and no further
6239 description is included here. The PCRE functions are called from Exim using
6240 the default option settings (that is, with no PCRE options set), except that
6241 the PCRE_CASELESS option is set when the matching is required to be
6242 case-insensitive.
6243
6244 In most cases, when a regular expression is required in an Exim configuration,
6245 it has to start with a circumflex, in order to distinguish it from plain text
6246 or an &"ends with"& wildcard. In this example of a configuration setting, the
6247 second item in the colon-separated list is a regular expression.
6248 .code
6249 domains = a.b.c : ^\\d{3} : *.y.z : ...
6250 .endd
6251 The doubling of the backslash is required because of string expansion that
6252 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6253 of this issue, and a way of avoiding the need for doubling backslashes. The
6254 regular expression that is eventually used in this example contains just one
6255 backslash. The circumflex is included in the regular expression, and has the
6256 normal effect of &"anchoring"& it to the start of the string that is being
6257 matched.
6258
6259 There are, however, two cases where a circumflex is not required for the
6260 recognition of a regular expression: these are the &%match%& condition in a
6261 string expansion, and the &%matches%& condition in an Exim filter file. In
6262 these cases, the relevant string is always treated as a regular expression; if
6263 it does not start with a circumflex, the expression is not anchored, and can
6264 match anywhere in the subject string.
6265
6266 In all cases, if you want a regular expression to match at the end of a string,
6267 you must code the $ metacharacter to indicate this. For example:
6268 .code
6269 domains = ^\\d{3}\\.example
6270 .endd
6271 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6272 You need to use:
6273 .code
6274 domains = ^\\d{3}\\.example\$
6275 .endd
6276 if you want &'example'& to be the top-level domain. The backslash before the
6277 $ is needed because string expansion also interprets dollar characters.
6278
6279
6280
6281 . ////////////////////////////////////////////////////////////////////////////
6282 . ////////////////////////////////////////////////////////////////////////////
6283
6284 .chapter "File and database lookups" "CHAPfdlookup"
6285 .scindex IIDfidalo1 "file" "lookups"
6286 .scindex IIDfidalo2 "database" "lookups"
6287 .cindex "lookup" "description of"
6288 Exim can be configured to look up data in files or databases as it processes
6289 messages. Two different kinds of syntax are used:
6290
6291 .olist
6292 A string that is to be expanded may contain explicit lookup requests. These
6293 cause parts of the string to be replaced by data that is obtained from the
6294 lookup. Lookups of this type are conditional expansion items. Different results
6295 can be defined for the cases of lookup success and failure. See chapter
6296 &<<CHAPexpand>>&, where string expansions are described in detail.
6297 The key for the lookup is specified as part of the string expansion.
6298 .next
6299 Lists of domains, hosts, and email addresses can contain lookup requests as a
6300 way of avoiding excessively long linear lists. In this case, the data that is
6301 returned by the lookup is often (but not always) discarded; whether the lookup
6302 succeeds or fails is what really counts. These kinds of list are described in
6303 chapter &<<CHAPdomhosaddlists>>&.
6304 The key for the lookup is given by the context in which the list is expanded.
6305 .endlist
6306
6307 String expansions, lists, and lookups interact with each other in such a way
6308 that there is no order in which to describe any one of them that does not
6309 involve references to the others. Each of these three chapters makes more sense
6310 if you have read the other two first. If you are reading this for the first
6311 time, be aware that some of it will make a lot more sense after you have read
6312 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6313
6314 .section "Examples of different lookup syntax" "SECID60"
6315 It is easy to confuse the two different kinds of lookup, especially as the
6316 lists that may contain the second kind are always expanded before being
6317 processed as lists. Therefore, they may also contain lookups of the first kind.
6318 Be careful to distinguish between the following two examples:
6319 .code
6320 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6321 domains = lsearch;/some/file
6322 .endd
6323 The first uses a string expansion, the result of which must be a domain list.
6324 No strings have been specified for a successful or a failing lookup; the
6325 defaults in this case are the looked-up data and an empty string, respectively.
6326 The expansion takes place before the string is processed as a list, and the
6327 file that is searched could contain lines like this:
6328 .code
6329 192.168.3.4: domain1:domain2:...
6330 192.168.1.9: domain3:domain4:...
6331 .endd
6332 When the lookup succeeds, the result of the expansion is a list of domains (and
6333 possibly other types of item that are allowed in domain lists).
6334
6335 In the second example, the lookup is a single item in a domain list. It causes
6336 Exim to use a lookup to see if the domain that is being processed can be found
6337 in the file. The file could contains lines like this:
6338 .code
6339 domain1:
6340 domain2:
6341 .endd
6342 Any data that follows the keys is not relevant when checking that the domain
6343 matches the list item.
6344
6345 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6346 Consider a file containing lines like this:
6347 .code
6348 192.168.5.6: lsearch;/another/file
6349 .endd
6350 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6351 first &%domains%& setting above generates the second setting, which therefore
6352 causes a second lookup to occur.
6353
6354 The rest of this chapter describes the different lookup types that are
6355 available. Any of them can be used in any part of the configuration where a
6356 lookup is permitted.
6357
6358
6359 .section "Lookup types" "SECID61"
6360 .cindex "lookup" "types of"
6361 .cindex "single-key lookup" "definition of"
6362 Two different types of data lookup are implemented:
6363
6364 .ilist
6365 The &'single-key'& type requires the specification of a file in which to look,
6366 and a single key to search for. The key must be a non-empty string for the
6367 lookup to succeed. The lookup type determines how the file is searched.
6368 .next
6369 .cindex "query-style lookup" "definition of"
6370 The &'query-style'& type accepts a generalized database query. No particular
6371 key value is assumed by Exim for query-style lookups. You can use whichever
6372 Exim variables you need to construct the database query.
6373 .endlist
6374
6375 The code for each lookup type is in a separate source file that is included in
6376 the binary of Exim only if the corresponding compile-time option is set. The
6377 default settings in &_src/EDITME_& are:
6378 .code
6379 LOOKUP_DBM=yes
6380 LOOKUP_LSEARCH=yes
6381 .endd
6382 which means that only linear searching and DBM lookups are included by default.
6383 For some types of lookup (e.g. SQL databases), you need to install appropriate
6384 libraries and header files before building Exim.
6385
6386
6387
6388
6389 .section "Single-key lookup types" "SECTsinglekeylookups"
6390 .cindex "lookup" "single-key types"
6391 .cindex "single-key lookup" "list of types"
6392 The following single-key lookup types are implemented:
6393
6394 .ilist
6395 .cindex "cdb" "description of"
6396 .cindex "lookup" "cdb"
6397 .cindex "binary zero" "in lookup key"
6398 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6399 string without a terminating binary zero. The cdb format is designed for
6400 indexed files that are read frequently and never updated, except by total
6401 re-creation. As such, it is particularly suitable for large files containing
6402 aliases or other indexed data referenced by an MTA. Information about cdb can
6403 be found in several places:
6404 .display
6405 &url(http://www.pobox.com/~djb/cdb.html)
6406 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6407 &url(http://packages.debian.org/stable/utils/freecdb.html)
6408 .endd
6409 A cdb distribution is not needed in order to build Exim with cdb support,
6410 because the code for reading cdb files is included directly in Exim itself.
6411 However, no means of building or testing cdb files is provided with Exim, so
6412 you need to obtain a cdb distribution in order to do this.
6413 .next
6414 .cindex "DBM" "lookup type"
6415 .cindex "lookup" "dbm"
6416 .cindex "binary zero" "in lookup key"
6417 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6418 DBM file by looking up the record with the given key. A terminating binary
6419 zero is included in the key that is passed to the DBM library. See section
6420 &<<SECTdb>>& for a discussion of DBM libraries.
6421
6422 .cindex "Berkeley DB library" "file format"
6423 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6424 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6425 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6426 the DB_UNKNOWN option. This enables it to handle any of the types of database
6427 that the library supports, and can be useful for accessing DBM files created by
6428 other applications. (For earlier DB versions, DB_HASH is always used.)
6429 .next
6430 .cindex "lookup" "dbmjz"
6431 .cindex "lookup" "dbm &-- embedded NULs"
6432 .cindex "sasldb2"
6433 .cindex "dbmjz lookup type"
6434 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6435 interpreted as an Exim list; the elements of the list are joined together with
6436 ASCII NUL characters to form the lookup key.  An example usage would be to
6437 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6438 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6439 &(cram_md5)& authenticator.
6440 .next
6441 .cindex "lookup" "dbmnz"
6442 .cindex "lookup" "dbm &-- terminating zero"
6443 .cindex "binary zero" "in lookup key"
6444 .cindex "Courier"
6445 .cindex "&_/etc/userdbshadow.dat_&"
6446 .cindex "dbmnz lookup type"
6447 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6448 is not included in the key that is passed to the DBM library. You may need this
6449 if you want to look up data in files that are created by or shared with some
6450 other application that does not use terminating zeros. For example, you need to
6451 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6452 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6453 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6454 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6455 .next
6456 .cindex "lookup" "dsearch"
6457 .cindex "dsearch lookup type"
6458 &(dsearch)&: The given file must be a directory; this is searched for an entry
6459 whose name is the key by calling the &[lstat()]& function. The key may not
6460 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6461 the lookup is the name of the entry, which may be a file, directory,
6462 symbolic link, or any other kind of directory entry. An example of how this
6463 lookup can be used to support virtual domains is given in section
6464 &<<SECTvirtualdomains>>&.
6465 .next
6466 .cindex "lookup" "iplsearch"
6467 .cindex "iplsearch lookup type"
6468 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6469 terminated by a colon or white space or the end of the line. The keys in the
6470 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6471 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6472 being interpreted as a key terminator. For example:
6473 .code
6474 1.2.3.4:           data for 1.2.3.4
6475 192.168.0.0/16:    data for 192.168.0.0/16
6476 "abcd::cdab":      data for abcd::cdab
6477 "abcd:abcd::/32"   data for abcd:abcd::/32
6478 .endd
6479 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6480 file is searched linearly, using the CIDR masks where present, until a matching
6481 key is found. The first key that matches is used; there is no attempt to find a
6482 &"best"& match. Apart from the way the keys are matched, the processing for
6483 &(iplsearch)& is the same as for &(lsearch)&.
6484
6485 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6486 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6487 lookup types support only literal keys.
6488
6489 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6490 the implicit key is the host's IP address rather than its name (see section
6491 &<<SECThoslispatsikey>>&).
6492 .next
6493 .cindex "linear search"
6494 .cindex "lookup" "lsearch"
6495 .cindex "lsearch lookup type"
6496 .cindex "case sensitivity" "in lsearch lookup"
6497 &(lsearch)&: The given file is a text file that is searched linearly for a
6498 line beginning with the search key, terminated by a colon or white space or the
6499 end of the line. The search is case-insensitive; that is, upper and lower case
6500 letters are treated as the same. The first occurrence of the key that is found
6501 in the file is used.
6502
6503 White space between the key and the colon is permitted. The remainder of the
6504 line, with leading and trailing white space removed, is the data. This can be
6505 continued onto subsequent lines by starting them with any amount of white
6506 space, but only a single space character is included in the data at such a
6507 junction. If the data begins with a colon, the key must be terminated by a
6508 colon, for example:
6509 .code
6510 baduser:  :fail:
6511 .endd
6512 Empty lines and lines beginning with # are ignored, even if they occur in the
6513 middle of an item. This is the traditional textual format of alias files. Note
6514 that the keys in an &(lsearch)& file are literal strings. There is no
6515 wildcarding of any kind.
6516
6517 .cindex "lookup" "lsearch &-- colons in keys"
6518 .cindex "white space" "in lsearch key"
6519 In most &(lsearch)& files, keys are not required to contain colons or #
6520 characters, or white space. However, if you need this feature, it is available.
6521 If a key begins with a doublequote character, it is terminated only by a
6522 matching quote (or end of line), and the normal escaping rules apply to its
6523 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6524 quoted keys (exactly as for unquoted keys). There is no special handling of
6525 quotes for the data part of an &(lsearch)& line.
6526
6527 .next
6528 .cindex "NIS lookup type"
6529 .cindex "lookup" "NIS"
6530 .cindex "binary zero" "in lookup key"
6531 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6532 the given key, without a terminating binary zero. There is a variant called
6533 &(nis0)& which does include the terminating binary zero in the key. This is
6534 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6535 aliases; the full map names must be used.
6536
6537 .next
6538 .cindex "wildlsearch lookup type"
6539 .cindex "lookup" "wildlsearch"
6540 .cindex "nwildlsearch lookup type"
6541 .cindex "lookup" "nwildlsearch"
6542 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6543 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6544 the file may be wildcarded. The difference between these two lookup types is
6545 that for &(wildlsearch)&, each key in the file is string-expanded before being
6546 used, whereas for &(nwildlsearch)&, no expansion takes place.
6547
6548 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6549 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6550 file that are regular expressions can be made case-sensitive by the use of
6551 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6552
6553 . ==== As this is a nested list, any displays it contains must be indented
6554 . ==== as otherwise they are too far to the left.
6555
6556 .olist
6557 The string may begin with an asterisk to mean &"ends with"&. For example:
6558 .code
6559     *.a.b.c       data for anything.a.b.c
6560     *fish         data for anythingfish
6561 .endd
6562 .next
6563 The string may begin with a circumflex to indicate a regular expression. For
6564 example, for &(wildlsearch)&:
6565 .code
6566     ^\N\d+\.a\.b\N    data for <digits>.a.b
6567 .endd
6568 Note the use of &`\N`& to disable expansion of the contents of the regular
6569 expression. If you are using &(nwildlsearch)&, where the keys are not
6570 string-expanded, the equivalent entry is:
6571 .code
6572     ^\d+\.a\.b        data for <digits>.a.b
6573 .endd
6574 The case-insensitive flag is set at the start of compiling the regular
6575 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6576 For example, to make the entire pattern case-sensitive:
6577 .code
6578     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6579 .endd
6580
6581 If the regular expression contains white space or colon characters, you must
6582 either quote it (see &(lsearch)& above), or represent these characters in other
6583 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6584 colon. This may be easier than quoting, because if you quote, you have to
6585 escape all the backslashes inside the quotes.
6586
6587 &*Note*&: It is not possible to capture substrings in a regular expression
6588 match for later use, because the results of all lookups are cached. If a lookup
6589 is repeated, the result is taken from the cache, and no actual pattern matching
6590 takes place. The values of all the numeric variables are unset after a
6591 &((n)wildlsearch)& match.
6592
6593 .next
6594 Although I cannot see it being of much use, the general matching function that
6595 is used to implement &((n)wildlsearch)& means that the string may begin with a
6596 lookup name terminated by a semicolon, and followed by lookup data. For
6597 example:
6598 .code
6599     cdb;/some/file  data for keys that match the file
6600 .endd
6601 The data that is obtained from the nested lookup is discarded.
6602 .endlist olist
6603
6604 Keys that do not match any of these patterns are interpreted literally. The
6605 continuation rules for the data are the same as for &(lsearch)&, and keys may
6606 be followed by optional colons.
6607
6608 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6609 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6610 lookup types support only literal keys.
6611 .endlist ilist
6612
6613
6614 .section "Query-style lookup types" "SECID62"
6615 .cindex "lookup" "query-style types"
6616 .cindex "query-style lookup" "list of types"
6617 The supported query-style lookup types are listed below. Further details about
6618 many of them are given in later sections.
6619
6620 .ilist
6621 .cindex "DNS" "as a lookup type"
6622 .cindex "lookup" "DNS"
6623 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6624 are given in the supplied query. The resulting data is the contents of the
6625 records. See section &<<SECTdnsdb>>&.
6626 .next
6627 .cindex "InterBase lookup type"
6628 .cindex "lookup" "InterBase"
6629 &(ibase)&: This does a lookup in an InterBase database.
6630 .next
6631 .cindex "LDAP" "lookup type"
6632 .cindex "lookup" "LDAP"
6633 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6634 returns attributes from a single entry. There is a variant called &(ldapm)&
6635 that permits values from multiple entries to be returned. A third variant
6636 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6637 any attribute values. See section &<<SECTldap>>&.
6638 .next
6639 .cindex "MySQL" "lookup type"
6640 .cindex "lookup" "MySQL"
6641 &(mysql)&: The format of the query is an SQL statement that is passed to a
6642 MySQL database. See section &<<SECTsql>>&.
6643 .next
6644 .cindex "NIS+ lookup type"
6645 .cindex "lookup" "NIS+"
6646 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6647 the field to be returned. See section &<<SECTnisplus>>&.
6648 .next
6649 .cindex "Oracle" "lookup type"
6650 .cindex "lookup" "Oracle"
6651 &(oracle)&: The format of the query is an SQL statement that is passed to an
6652 Oracle database. See section &<<SECTsql>>&.
6653 .next
6654 .cindex "lookup" "passwd"
6655 .cindex "passwd lookup type"
6656 .cindex "&_/etc/passwd_&"
6657 &(passwd)& is a query-style lookup with queries that are just user names. The
6658 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6659 success, the result string is the same as you would get from an &(lsearch)&
6660 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6661 password value. For example:
6662 .code
6663 *:42:42:King Rat:/home/kr:/bin/bash
6664 .endd
6665 .next
6666 .cindex "PostgreSQL lookup type"
6667 .cindex "lookup" "PostgreSQL"
6668 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6669 PostgreSQL database. See section &<<SECTsql>>&.
6670
6671 .next
6672 .new
6673 .cindex "Redis lookup type"
6674 .cindex lookup Redis
6675 &(redis)&: The format of the query is an SQL statement that is passed to a
6676 Redis database. See section &<<SECTsql>>&.
6677 .wen
6678
6679 .next
6680 .cindex "sqlite lookup type"
6681 .cindex "lookup" "sqlite"
6682 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6683 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6684
6685 .next
6686 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6687 not likely to be useful in normal operation.
6688 .next
6689 .cindex "whoson lookup type"
6690 .cindex "lookup" "whoson"
6691 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6692 allows a server to check whether a particular (dynamically allocated) IP
6693 address is currently allocated to a known (trusted) user and, optionally, to
6694 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6695 at one time for &"POP before SMTP"& authentication, but that approach has been
6696 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6697 &"POP before SMTP"& checking using ACL statements such as
6698 .code
6699 require condition = \
6700   ${lookup whoson {$sender_host_address}{yes}{no}}
6701 .endd
6702 The query consists of a single IP address. The value returned is the name of
6703 the authenticated user, which is stored in the variable &$value$&. However, in
6704 this example, the data in &$value$& is not used; the result of the lookup is
6705 one of the fixed strings &"yes"& or &"no"&.
6706 .endlist
6707
6708
6709
6710 .section "Temporary errors in lookups" "SECID63"
6711 .cindex "lookup" "temporary error in"
6712 Lookup functions can return temporary error codes if the lookup cannot be
6713 completed. For example, an SQL or LDAP database might be unavailable. For this
6714 reason, it is not advisable to use a lookup that might do this for critical
6715 options such as a list of local domains.
6716
6717 When a lookup cannot be completed in a router or transport, delivery
6718 of the message (to the relevant address) is deferred, as for any other
6719 temporary error. In other circumstances Exim may assume the lookup has failed,
6720 or may give up altogether.
6721
6722
6723
6724 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6725 .cindex "wildcard lookups"
6726 .cindex "lookup" "default values"
6727 .cindex "lookup" "wildcard"
6728 .cindex "lookup" "* added to type"
6729 .cindex "default" "in single-key lookups"
6730 In this context, a &"default value"& is a value specified by the administrator
6731 that is to be used if a lookup fails.
6732
6733 &*Note:*& This section applies only to single-key lookups. For query-style
6734 lookups, the facilities of the query language must be used. An attempt to
6735 specify a default for a query-style lookup provokes an error.
6736
6737 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6738 and the initial lookup fails, the key &"*"& is looked up in the file to
6739 provide a default value. See also the section on partial matching below.
6740
6741 .cindex "*@ with single-key lookup"
6742 .cindex "lookup" "*@ added to type"
6743 .cindex "alias file" "per-domain default"
6744 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6745 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6746 character, a second lookup is done with everything before the last @ replaced
6747 by *. This makes it possible to provide per-domain defaults in alias files
6748 that include the domains in the keys. If the second lookup fails (or doesn't
6749 take place because there is no @ in the key), &"*"& is looked up.
6750 For example, a &(redirect)& router might contain:
6751 .code
6752 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6753 .endd
6754 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6755 looks up these keys, in this order:
6756 .code
6757 jane@eyre.example
6758 *@eyre.example
6759 *
6760 .endd
6761 The data is taken from whichever key it finds first. &*Note*&: In an
6762 &(lsearch)& file, this does not mean the first of these keys in the file. A
6763 complete scan is done for each key, and only if it is not found at all does
6764 Exim move on to try the next key.
6765
6766
6767
6768 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6769 .cindex "partial matching"
6770 .cindex "wildcard lookups"
6771 .cindex "lookup" "partial matching"
6772 .cindex "lookup" "wildcard"
6773 .cindex "asterisk" "in search type"
6774 The normal operation of a single-key lookup is to search the file for an exact
6775 match with the given key. However, in a number of situations where domains are
6776 being looked up, it is useful to be able to do partial matching. In this case,
6777 information in the file that has a key starting with &"*."& is matched by any
6778 domain that ends with the components that follow the full stop. For example, if
6779 a key in a DBM file is
6780 .code
6781 *.dates.fict.example
6782 .endd
6783 then when partial matching is enabled this is matched by (amongst others)
6784 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6785 by &'dates.fict.example'&, if that does not appear as a separate key in the
6786 file.
6787
6788 &*Note*&: Partial matching is not available for query-style lookups. It is
6789 also not available for any lookup items in address lists (see section
6790 &<<SECTaddresslist>>&).
6791
6792 Partial matching is implemented by doing a series of separate lookups using
6793 keys constructed by modifying the original subject key. This means that it can
6794 be used with any of the single-key lookup types, provided that
6795 partial matching keys
6796 beginning with a special prefix (default &"*."&) are included in the data file.
6797 Keys in the file that do not begin with the prefix are matched only by
6798 unmodified subject keys when partial matching is in use.
6799
6800 Partial matching is requested by adding the string &"partial-"& to the front of
6801 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6802 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6803 is added at the start of the subject key, and it is looked up again. If that
6804 fails, further lookups are tried with dot-separated components removed from the
6805 start of the subject key, one-by-one, and &"*."& added on the front of what
6806 remains.
6807
6808 A minimum number of two non-* components are required. This can be adjusted
6809 by including a number before the hyphen in the search type. For example,
6810 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6811 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6812 subject key is &'2250.dates.fict.example'& then the following keys are looked
6813 up when the minimum number of non-* components is two:
6814 .code
6815 2250.dates.fict.example
6816 *.2250.dates.fict.example
6817 *.dates.fict.example
6818 *.fict.example
6819 .endd
6820 As soon as one key in the sequence is successfully looked up, the lookup
6821 finishes.
6822
6823 .cindex "lookup" "partial matching &-- changing prefix"
6824 .cindex "prefix" "for partial matching"
6825 The use of &"*."& as the partial matching prefix is a default that can be
6826 changed. The motivation for this feature is to allow Exim to operate with file
6827 formats that are used by other MTAs. A different prefix can be supplied in
6828 parentheses instead of the hyphen after &"partial"&. For example:
6829 .code
6830 domains = partial(.)lsearch;/some/file
6831 .endd
6832 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6833 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6834 components is unchanged). The prefix may consist of any punctuation characters
6835 other than a closing parenthesis. It may be empty, for example:
6836 .code
6837 domains = partial1()cdb;/some/file
6838 .endd
6839 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6840 &`a.b.c`&, &`b.c`&, and &`c`&.
6841
6842 If &"partial0"& is specified, what happens at the end (when the lookup with
6843 just one non-wild component has failed, and the original key is shortened right
6844 down to the null string) depends on the prefix:
6845
6846 .ilist
6847 If the prefix has zero length, the whole lookup fails.
6848 .next
6849 If the prefix has length 1, a lookup for just the prefix is done. For
6850 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6851 .next
6852 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6853 remainder is looked up. With the default prefix, therefore, the final lookup is
6854 for &"*"& on its own.
6855 .next
6856 Otherwise, the whole prefix is looked up.
6857 .endlist
6858
6859
6860 If the search type ends in &"*"& or &"*@"& (see section
6861 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6862 this implies happens after all partial lookups have failed. If &"partial0"& is
6863 specified, adding &"*"& to the search type has no effect with the default
6864 prefix, because the &"*"& key is already included in the sequence of partial
6865 lookups. However, there might be a use for lookup types such as
6866 &"partial0(.)lsearch*"&.
6867
6868 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6869 in domain lists and the like. Partial matching works only in terms of
6870 dot-separated components; a key such as &`*fict.example`&
6871 in a database file is useless, because the asterisk in a partial matching
6872 subject key is always followed by a dot.
6873
6874
6875
6876
6877 .section "Lookup caching" "SECID64"
6878 .cindex "lookup" "caching"
6879 .cindex "caching" "lookup data"
6880 Exim caches all lookup results in order to avoid needless repetition of
6881 lookups. However, because (apart from the daemon) Exim operates as a collection
6882 of independent, short-lived processes, this caching applies only within a
6883 single Exim process. There is no inter-process lookup caching facility.
6884
6885 For single-key lookups, Exim keeps the relevant files open in case there is
6886 another lookup that needs them. In some types of configuration this can lead to
6887 many files being kept open for messages with many recipients. To avoid hitting
6888 the operating system limit on the number of simultaneously open files, Exim
6889 closes the least recently used file when it needs to open more files than its
6890 own internal limit, which can be changed via the &%lookup_open_max%& option.
6891
6892 The single-key lookup files are closed and the lookup caches are flushed at
6893 strategic points during delivery &-- for example, after all routing is
6894 complete.
6895
6896
6897
6898
6899 .section "Quoting lookup data" "SECID65"
6900 .cindex "lookup" "quoting"
6901 .cindex "quoting" "in lookups"
6902 When data from an incoming message is included in a query-style lookup, there
6903 is the possibility of special characters in the data messing up the syntax of
6904 the query. For example, a NIS+ query that contains
6905 .code
6906 [name=$local_part]
6907 .endd
6908 will be broken if the local part happens to contain a closing square bracket.
6909 For NIS+, data can be enclosed in double quotes like this:
6910 .code
6911 [name="$local_part"]
6912 .endd
6913 but this still leaves the problem of a double quote in the data. The rule for
6914 NIS+ is that double quotes must be doubled. Other lookup types have different
6915 rules, and to cope with the differing requirements, an expansion operator
6916 of the following form is provided:
6917 .code
6918 ${quote_<lookup-type>:<string>}
6919 .endd
6920 For example, the safest way to write the NIS+ query is
6921 .code
6922 [name="${quote_nisplus:$local_part}"]
6923 .endd
6924 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6925 operator can be used for all lookup types, but has no effect for single-key
6926 lookups, since no quoting is ever needed in their key strings.
6927
6928
6929
6930
6931 .section "More about dnsdb" "SECTdnsdb"
6932 .cindex "dnsdb lookup"
6933 .cindex "lookup" "dnsdb"
6934 .cindex "DNS" "as a lookup type"
6935 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6936 of a record type and a domain name, separated by an equals sign. For example,
6937 an expansion string could contain:
6938 .code
6939 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6940 .endd
6941 If the lookup succeeds, the result is placed in &$value$&, which in this case
6942 is used on its own as the result. If the lookup does not succeed, the
6943 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6944 &<<SECTforexpfai>>& for an explanation of what this means.
6945
6946 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6947 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6948 If no type is given, TXT is assumed.
6949
6950 For any record type, if multiple records are found, the data is returned as a
6951 concatenation, with newline as the default separator. The order, of course,
6952 depends on the DNS resolver. You can specify a different separator character
6953 between multiple records by putting a right angle-bracket followed immediately
6954 by the new separator at the start of the query. For example:
6955 .code
6956 ${lookup dnsdb{>: a=host1.example}}
6957 .endd
6958 It is permitted to specify a space as the separator character. Further
6959 white space is ignored.
6960 For lookup types that return multiple fields per record,
6961 an alternate field separator can be specified using a comma after the main
6962 separator character, followed immediately by the field separator.
6963
6964 .cindex "PTR record" "in &(dnsdb)& lookup"
6965 When the type is PTR,
6966 the data can be an IP address, written as normal; inversion and the addition of
6967 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6968 .code
6969 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6970 .endd
6971 If the data for a PTR record is not a syntactically valid IP address, it is not
6972 altered and nothing is added.
6973
6974 .cindex "MX record" "in &(dnsdb)& lookup"
6975 .cindex "SRV record" "in &(dnsdb)& lookup"
6976 For an MX lookup, both the preference value and the host name are returned for
6977 each record, separated by a space. For an SRV lookup, the priority, weight,
6978 port, and host name are returned for each record, separated by spaces.
6979 The field separator can be modified as above.
6980
6981 .cindex "TXT record" "in &(dnsdb)& lookup"
6982 .cindex "SPF record" "in &(dnsdb)& lookup"
6983 For TXT records with multiple items of data, only the first item is returned,
6984 unless a field separator is specified.
6985 To concatenate items without a separator, use a semicolon instead.
6986 For SPF records the
6987 default behaviour is to concatenate multiple items without using a separator.
6988 .code
6989 ${lookup dnsdb{>\n,: txt=a.b.example}}
6990 ${lookup dnsdb{>\n; txt=a.b.example}}
6991 ${lookup dnsdb{spf=example.org}}
6992 .endd
6993 It is permitted to specify a space as the separator character. Further
6994 white space is ignored.
6995
6996 .cindex "SOA record" "in &(dnsdb)& lookup"
6997 For an SOA lookup, while no result is obtained the lookup is redone with
6998 successively more leading components dropped from the given domain.
6999 Only the primary-nameserver field is returned unless a field separator is
7000 specified.
7001 .code
7002 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7003 .endd
7004
7005 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7006 .cindex "dnsdb modifiers"
7007 .cindex "modifiers" "dnsdb"
7008 .cindex "options" "dnsdb"
7009 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7010 each followed by a comma,
7011 that may appear before the record type.
7012
7013 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7014 temporary DNS error for any of them, the behaviour is controlled by
7015 a defer-option modifier.
7016 The possible keywords are
7017 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7018 With &"strict"& behaviour, any temporary DNS error causes the
7019 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7020 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7021 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7022 error causes the whole lookup to defer only if none of the other lookups
7023 succeed. The default is &"lax"&, so the following lookups are equivalent:
7024 .code
7025 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7026 ${lookup dnsdb{a=one.host.com:two.host.com}}
7027 .endd
7028 Thus, in the default case, as long as at least one of the DNS lookups
7029 yields some data, the lookup succeeds.
7030
7031 .cindex "DNSSEC" "dns lookup"
7032 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7033 The possible keywords are
7034 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7035 With &"strict"& or &"lax"& DNSSEC information is requested
7036 with the lookup.
7037 With &"strict"& a response from the DNS resolver that
7038 is not labelled as authenticated data
7039 is treated as equivalent to a temporary DNS error.
7040 The default is &"never"&.
7041
7042 See also the &$lookup_dnssec_authenticated$& variable.
7043
7044 .cindex timeout "dns lookup"
7045 .cindex "DNS" timeout
7046 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7047 The form is &"retrans_VAL"& where VAL is an Exim time specification
7048 (e.g. &"5s"&).
7049 The default value is set by the main configuration option &%dns_retrans%&.
7050
7051 Retries for the dnsdb lookup can be controlled by a retry modifier.
7052 The form if &"retry_VAL"& where VAL is an integer.
7053 The default count is set by the main configuration option &%dns_retry%&.
7054
7055 .new
7056 .cindex cacheing "of dns lookup"
7057 .cindex TTL "of dns lookup"
7058 .cindex DNS TTL
7059 Dnsdb lookup results are cached within a single process (and its children).
7060 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7061 value of the set of returned DNS records.
7062 .wen
7063
7064
7065 .section "Pseudo dnsdb record types" "SECID66"
7066 .cindex "MX record" "in &(dnsdb)& lookup"
7067 By default, both the preference value and the host name are returned for
7068 each MX record, separated by a space. If you want only host names, you can use
7069 the pseudo-type MXH:
7070 .code
7071 ${lookup dnsdb{mxh=a.b.example}}
7072 .endd
7073 In this case, the preference values are omitted, and just the host names are
7074 returned.
7075
7076 .cindex "name server for enclosing domain"
7077 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7078 records on the given domain, but if none are found, it removes the first
7079 component of the domain name, and tries again. This process continues until NS
7080 records are found or there are no more components left (or there is a DNS
7081 error). In other words, it may return the name servers for a top-level domain,
7082 but it never returns the root name servers. If there are no NS records for the
7083 top-level domain, the lookup fails. Consider these examples:
7084 .code
7085 ${lookup dnsdb{zns=xxx.quercite.com}}
7086 ${lookup dnsdb{zns=xxx.edu}}
7087 .endd
7088 Assuming that in each case there are no NS records for the full domain name,
7089 the first returns the name servers for &%quercite.com%&, and the second returns
7090 the name servers for &%edu%&.
7091
7092 You should be careful about how you use this lookup because, unless the
7093 top-level domain does not exist, the lookup always returns some host names. The
7094 sort of use to which this might be put is for seeing if the name servers for a
7095 given domain are on a blacklist. You can probably assume that the name servers
7096 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7097 such a list.
7098
7099 .cindex "CSA" "in &(dnsdb)& lookup"
7100 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7101 records according to the CSA rules, which are described in section
7102 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7103 not sufficient because of the extra parent domain search behaviour of CSA. The
7104 result of a successful lookup such as:
7105 .code
7106 ${lookup dnsdb {csa=$sender_helo_name}}
7107 .endd
7108 has two space-separated fields: an authorization code and a target host name.
7109 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7110 authorization required but absent, or &"?"& for unknown.
7111
7112 .cindex "A+" "in &(dnsdb)& lookup"
7113 The pseudo-type A+ performs an AAAA
7114 and then an A lookup.  All results are returned; defer processing
7115 (see below) is handled separately for each lookup.  Example:
7116 .code
7117 ${lookup dnsdb {>; a+=$sender_helo_name}}
7118 .endd
7119
7120
7121 .section "Multiple dnsdb lookups" "SECID67"
7122 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7123 However, you can specify a list of domains or IP addresses in a single
7124 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7125 the default separator, but with the ability to change this. For example:
7126 .code
7127 ${lookup dnsdb{one.domain.com:two.domain.com}}
7128 ${lookup dnsdb{a=one.host.com:two.host.com}}
7129 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7130 .endd
7131 In order to retain backwards compatibility, there is one special case: if
7132 the lookup type is PTR and no change of separator is specified, Exim looks
7133 to see if the rest of the string is precisely one IPv6 address. In this
7134 case, it does not treat it as a list.
7135
7136 The data from each lookup is concatenated, with newline separators by default,
7137 in the same way that multiple DNS records for a single item are handled. A
7138 different separator can be specified, as described above.
7139
7140
7141
7142
7143 .section "More about LDAP" "SECTldap"
7144 .cindex "LDAP" "lookup, more about"
7145 .cindex "lookup" "LDAP"
7146 .cindex "Solaris" "LDAP"
7147 The original LDAP implementation came from the University of Michigan; this has
7148 become &"Open LDAP"&, and there are now two different releases. Another
7149 implementation comes from Netscape, and Solaris 7 and subsequent releases
7150 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7151 the lookup function level, their error handling is different. For this reason
7152 it is necessary to set a compile-time variable when building Exim with LDAP, to
7153 indicate which LDAP library is in use. One of the following should appear in
7154 your &_Local/Makefile_&:
7155 .code
7156 LDAP_LIB_TYPE=UMICHIGAN
7157 LDAP_LIB_TYPE=OPENLDAP1
7158 LDAP_LIB_TYPE=OPENLDAP2
7159 LDAP_LIB_TYPE=NETSCAPE
7160 LDAP_LIB_TYPE=SOLARIS
7161 .endd
7162 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7163 same interface as the University of Michigan version.
7164
7165 There are three LDAP lookup types in Exim. These behave slightly differently in
7166 the way they handle the results of a query:
7167
7168 .ilist
7169 &(ldap)& requires the result to contain just one entry; if there are more, it
7170 gives an error.
7171 .next
7172 &(ldapdn)& also requires the result to contain just one entry, but it is the
7173 Distinguished Name that is returned rather than any attribute values.
7174 .next
7175 &(ldapm)& permits the result to contain more than one entry; the attributes
7176 from all of them are returned.
7177 .endlist
7178
7179
7180 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7181 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7182 the data returned by a successful lookup is described in the next section.
7183 First we explain how LDAP queries are coded.
7184
7185
7186 .section "Format of LDAP queries" "SECTforldaque"
7187 .cindex "LDAP" "query format"
7188 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7189 the configuration of a &(redirect)& router one might have this setting:
7190 .code
7191 data = ${lookup ldap \
7192   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7193   c=UK?mailbox?base?}}
7194 .endd
7195 .cindex "LDAP" "with TLS"
7196 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7197 secure (encrypted) LDAP connections. The second of these ensures that an
7198 encrypted TLS connection is used.
7199
7200 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7201 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7202 See the &%ldap_start_tls%& option.
7203
7204 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7205 controlled. Every part of the TLS configuration can be configured by settings in
7206 &_exim.conf_&. Depending on the version of the client libraries installed on
7207 your system, some of the initialization may have required setting options in
7208 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7209 certificates. This revealed a nuance where the current UID that exim was
7210 running as could affect which config files it read. With Exim 4.83, these
7211 methods become optional, only taking effect if not specifically set in
7212 &_exim.conf_&.
7213
7214
7215 .section "LDAP quoting" "SECID68"
7216 .cindex "LDAP" "quoting"
7217 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7218 and the second because the LDAP query is represented as a URL. Furthermore,
7219 within an LDAP query, two different kinds of quoting are required. For this
7220 reason, there are two different LDAP-specific quoting operators.
7221
7222 The &%quote_ldap%& operator is designed for use on strings that are part of
7223 filter specifications. Conceptually, it first does the following conversions on
7224 the string:
7225 .code
7226 *   =>   \2A
7227 (   =>   \28
7228 )   =>   \29
7229 \   =>   \5C
7230 .endd
7231 in accordance with RFC 2254. The resulting string is then quoted according
7232 to the rules for URLs, that is, all non-alphanumeric characters except
7233 .code
7234 ! $ ' - . _ ( ) * +
7235 .endd
7236 are converted to their hex values, preceded by a percent sign. For example:
7237 .code
7238 ${quote_ldap: a(bc)*, a<yz>; }
7239 .endd
7240 yields
7241 .code
7242 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7243 .endd
7244 Removing the URL quoting, this is (with a leading and a trailing space):
7245 .code
7246 a\28bc\29\2A, a<yz>;
7247 .endd
7248 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7249 base DN specifications in queries. Conceptually, it first converts the string
7250 by inserting a backslash in front of any of the following characters:
7251 .code
7252 , + " \ < > ;
7253 .endd
7254 It also inserts a backslash before any leading spaces or # characters, and
7255 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7256 is then quoted according to the rules for URLs. For example:
7257 .code
7258 ${quote_ldap_dn: a(bc)*, a<yz>; }
7259 .endd
7260 yields
7261 .code
7262 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7263 .endd
7264 Removing the URL quoting, this is (with a trailing space):
7265 .code
7266 \ a(bc)*\, a\<yz\>\;\
7267 .endd
7268 There are some further comments about quoting in the section on LDAP
7269 authentication below.
7270
7271
7272 .section "LDAP connections" "SECID69"
7273 .cindex "LDAP" "connections"
7274 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7275 is in use, via a Unix domain socket. The example given above does not specify
7276 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7277 by starting it with
7278 .code
7279 ldap://<hostname>:<port>/...
7280 .endd
7281 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7282 used. When no server is specified in a query, a list of default servers is
7283 taken from the &%ldap_default_servers%& configuration option. This supplies a
7284 colon-separated list of servers which are tried in turn until one successfully
7285 handles a query, or there is a serious error. Successful handling either
7286 returns the requested data, or indicates that it does not exist. Serious errors
7287 are syntactical, or multiple values when only a single value is expected.
7288 Errors which cause the next server to be tried are connection failures, bind
7289 failures, and timeouts.
7290
7291 For each server name in the list, a port number can be given. The standard way
7292 of specifying a host and port is to use a colon separator (RFC 1738). Because
7293 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7294 doubled. For example
7295 .code
7296 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7297 .endd
7298 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7299 to the LDAP library with no server name, and the library's default (normally
7300 the local host) is used.
7301
7302 If you are using the OpenLDAP library, you can connect to an LDAP server using
7303 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7304 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7305 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7306 not available.
7307
7308 For this type of connection, instead of a host name for the server, a pathname
7309 for the socket is required, and the port number is not relevant. The pathname
7310 can be specified either as an item in &%ldap_default_servers%&, or inline in
7311 the query. In the former case, you can have settings such as
7312 .code
7313 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7314 .endd
7315 When the pathname is given in the query, you have to escape the slashes as
7316 &`%2F`& to fit in with the LDAP URL syntax. For example:
7317 .code
7318 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7319 .endd
7320 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7321 a pathname, it uses the Unix domain socket code, even if the query actually
7322 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7323 socket connection. This behaviour means that you can use a setting of
7324 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7325 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7326 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7327 backup host.
7328
7329 If an explicit &`ldapi`& type is given in a query when a host name is
7330 specified, an error is diagnosed. However, if there are more items in
7331 &%ldap_default_servers%&, they are tried. In other words:
7332
7333 .ilist
7334 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7335 interface.
7336 .next
7337 Using &`ldapi`& with a host name causes an error.
7338 .endlist
7339
7340
7341 Using &`ldapi`& with no host or path in the query, and no setting of
7342 &%ldap_default_servers%&, does whatever the library does by default.
7343
7344
7345
7346 .section "LDAP authentication and control information" "SECID70"
7347 .cindex "LDAP" "authentication"
7348 The LDAP URL syntax provides no way of passing authentication and other control
7349 information to the server. To make this possible, the URL in an LDAP query may
7350 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7351 spaces. If a value contains spaces it must be enclosed in double quotes, and
7352 when double quotes are used, backslash is interpreted in the usual way inside
7353 them. The following names are recognized:
7354 .display
7355 &`DEREFERENCE`&  set the dereferencing parameter
7356 &`NETTIME    `&  set a timeout for a network operation
7357 &`USER       `&  set the DN, for authenticating the LDAP bind
7358 &`PASS       `&  set the password, likewise
7359 &`REFERRALS  `&  set the referrals parameter
7360 &`SERVERS    `&  set alternate server list for this query only
7361 &`SIZE       `&  set the limit for the number of entries returned
7362 &`TIME       `&  set the maximum waiting time for a query
7363 .endd
7364 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7365 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7366 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7367 library from trying to follow referrals issued by the LDAP server.
7368
7369 .cindex LDAP timeout
7370 .cindex timeout "LDAP lookup"
7371 The name CONNECT is an obsolete name for NETTIME, retained for
7372 backwards compatibility. This timeout (specified as a number of seconds) is
7373 enforced from the client end for operations that can be carried out over a
7374 network. Specifically, it applies to network connections and calls to the
7375 &'ldap_result()'& function. If the value is greater than zero, it is used if
7376 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7377 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7378 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7379 Netscape SDK; for OpenLDAP no action is taken.
7380
7381 The TIME parameter (also a number of seconds) is passed to the server to
7382 set a server-side limit on the time taken to complete a search.
7383
7384 The SERVERS parameter allows you to specify an alternate list of ldap servers
7385 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7386 default list of ldap servers, and a single lookup can specify a single ldap
7387 server to use.  But when you need to do a lookup with a list of servers that is
7388 different than the default list (maybe different order, maybe a completely
7389 different set of servers), the SERVERS parameter allows you to specify this
7390 alternate list (colon-separated).
7391
7392 Here is an example of an LDAP query in an Exim lookup that uses some of these
7393 values. This is a single line, folded to fit on the page:
7394 .code
7395 ${lookup ldap
7396   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7397   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7398   {$value}fail}
7399 .endd
7400 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7401 any of the auxiliary data. Exim configuration settings that include lookups
7402 which contain password information should be preceded by &"hide"& to prevent
7403 non-admin users from using the &%-bP%& option to see their values.
7404
7405 The auxiliary data items may be given in any order. The default is no
7406 connection timeout (the system timeout is used), no user or password, no limit
7407 on the number of entries returned, and no time limit on queries.
7408
7409 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7410 removes any URL quoting that it may contain before passing it LDAP. Apparently
7411 some libraries do this for themselves, but some do not. Removing the URL
7412 quoting has two advantages:
7413
7414 .ilist
7415 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7416 DNs as with DNs inside actual queries.
7417 .next
7418 It permits spaces inside USER= DNs.
7419 .endlist
7420
7421 For example, a setting such as
7422 .code
7423 USER=cn=${quote_ldap_dn:$1}
7424 .endd
7425 should work even if &$1$& contains spaces.
7426
7427 Expanded data for the PASS= value should be quoted using the &%quote%&
7428 expansion operator, rather than the LDAP quote operators. The only reason this
7429 field needs quoting is to ensure that it conforms to the Exim syntax, which
7430 does not allow unquoted spaces. For example:
7431 .code
7432 PASS=${quote:$3}
7433 .endd
7434 The LDAP authentication mechanism can be used to check passwords as part of
7435 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7436 &<<CHAPexpand>>&.
7437
7438
7439
7440 .section "Format of data returned by LDAP" "SECID71"
7441 .cindex "LDAP" "returned data formats"
7442 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7443 as a sequence of values, for example
7444 .code
7445 cn=manager,o=University of Cambridge,c=UK
7446 .endd
7447 The &(ldap)& lookup type generates an error if more than one entry matches the
7448 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7449 the result between the data from different entries. It is possible for multiple
7450 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7451 you know that whatever values are returned all came from a single entry in the
7452 directory.
7453
7454 In the common case where you specify a single attribute in your LDAP query, the
7455 result is not quoted, and does not contain the attribute name. If the attribute
7456 has multiple values, they are separated by commas. Any comma that is
7457 part of an attribute's value is doubled.
7458
7459 If you specify multiple attributes, the result contains space-separated, quoted
7460 strings, each preceded by the attribute name and an equals sign. Within the
7461 quotes, the quote character, backslash, and newline are escaped with
7462 backslashes, and commas are used to separate multiple values for the attribute.
7463 Any commas in attribute values are doubled
7464 (permitting treatment of the values as a comma-separated list).
7465 Apart from the escaping, the string within quotes takes the same form as the
7466 output when a single attribute is requested. Specifying no attributes is the
7467 same as specifying all of an entry's attributes.
7468
7469 Here are some examples of the output format. The first line of each pair is an
7470 LDAP query, and the second is the data that is returned. The attribute called
7471 &%attr1%& has two values, one of them with an embedded comma, whereas
7472 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7473 (they have SUP &%attr%& in their schema definitions).
7474
7475 .code
7476 ldap:///o=base?attr1?sub?(uid=fred)
7477 value1.1,value1,,2
7478
7479 ldap:///o=base?attr2?sub?(uid=fred)
7480 value two
7481
7482 ldap:///o=base?attr?sub?(uid=fred)
7483 value1.1,value1,,2,value two
7484
7485 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7486 attr1="value1.1,value1,,2" attr2="value two"
7487
7488 ldap:///o=base??sub?(uid=fred)
7489 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7490 .endd
7491 You can
7492 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7493 results of LDAP lookups.
7494 The &%extract%& operator in string expansions can be used to pick out
7495 individual fields from data that consists of &'key'&=&'value'& pairs.
7496 The &%listextract%& operator should be used to pick out individual values
7497 of attributes, even when only a single value is expected.
7498 The doubling of embedded commas allows you to use the returned data as a
7499 comma separated list (using the "<," syntax for changing the input list separator).
7500
7501
7502
7503
7504 .section "More about NIS+" "SECTnisplus"
7505 .cindex "NIS+ lookup type"
7506 .cindex "lookup" "NIS+"
7507 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7508 and field name. If this is given, the result of a successful query is the
7509 contents of the named field; otherwise the result consists of a concatenation
7510 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7511 values containing spaces are quoted. For example, the query
7512 .code
7513 [name=mg1456],passwd.org_dir
7514 .endd
7515 might return the string
7516 .code
7517 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7518 home=/home/mg1456 shell=/bin/bash shadow=""
7519 .endd
7520 (split over two lines here to fit on the page), whereas
7521 .code
7522 [name=mg1456],passwd.org_dir:gcos
7523 .endd
7524 would just return
7525 .code
7526 Martin Guerre
7527 .endd
7528 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7529 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7530 operator is to double any quote characters within the text.
7531
7532
7533
7534 .section "SQL lookups" "SECTsql"
7535 .cindex "SQL lookup types"
7536 .cindex "MySQL" "lookup type"
7537 .cindex "PostgreSQL lookup type"
7538 .cindex "lookup" "MySQL"
7539 .cindex "lookup" "PostgreSQL"
7540 .cindex "Oracle" "lookup type"
7541 .cindex "lookup" "Oracle"
7542 .cindex "InterBase lookup type"
7543 .cindex "lookup" "InterBase"
7544 .cindex "Redis lookup type"
7545 .cindex lookup Redis
7546 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7547 and SQLite
7548 databases. Queries for these databases contain SQL statements, so an example
7549 might be
7550 .code
7551 ${lookup mysql{select mailbox from users where id='userx'}\
7552   {$value}fail}
7553 .endd
7554 If the result of the query contains more than one field, the data for each
7555 field in the row is returned, preceded by its name, so the result of
7556 .code
7557 ${lookup pgsql{select home,name from users where id='userx'}\
7558   {$value}}
7559 .endd
7560 might be
7561 .code
7562 home=/home/userx name="Mister X"
7563 .endd
7564 Empty values and values containing spaces are double quoted, with embedded
7565 quotes escaped by a backslash. If the result of the query contains just one
7566 field, the value is passed back verbatim, without a field name, for example:
7567 .code
7568 Mister X
7569 .endd
7570 If the result of the query yields more than one row, it is all concatenated,
7571 with a newline between the data for each row.
7572
7573
7574 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7575 .cindex "MySQL" "lookup type"
7576 .cindex "PostgreSQL lookup type"
7577 .cindex "lookup" "MySQL"
7578 .cindex "lookup" "PostgreSQL"
7579 .cindex "Oracle" "lookup type"
7580 .cindex "lookup" "Oracle"
7581 .cindex "InterBase lookup type"
7582 .cindex "lookup" "InterBase"
7583 .cindex "Redis lookup type"
7584 .cindex lookup Redis
7585 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7586 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7587 or &%redis_servers%&
7588 option (as appropriate) must be set to a colon-separated list of server
7589 information.
7590 (For MySQL and PostgreSQL, the global option need not be set if all
7591 queries contain their own server information &-- see section
7592 &<<SECTspeserque>>&.)
7593 For all but Redis
7594 each item in the list is a slash-separated list of four
7595 items: host name, database name, user name, and password. In the case of
7596 Oracle, the host name field is used for the &"service name"&, and the database
7597 name field is not used and should be empty. For example:
7598 .code
7599 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7600 .endd
7601 Because password data is sensitive, you should always precede the setting with
7602 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7603 option. Here is an example where two MySQL servers are listed:
7604 .code
7605 hide mysql_servers = localhost/users/root/secret:\
7606                      otherhost/users/root/othersecret
7607 .endd
7608 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7609 because this is a colon-separated list, the colon has to be doubled. For each
7610 query, these parameter groups are tried in order until a connection is made and
7611 a query is successfully processed. The result of a query may be that no data is
7612 found, but that is still a successful query. In other words, the list of
7613 servers provides a backup facility, not a list of different places to look.
7614
7615 .new
7616 For Redis the global option need not be specified if all queries contain their
7617 own server information &-- see section &<<SECTspeserque>>&.
7618 If specified, the option must be set to a colon-separated list of server
7619 information.
7620 Each item in the list is a slash-separated list of three items:
7621 host, database number, and password.
7622 .olist
7623 The host is required and may be either an IPv4 address and optional
7624 port number (separated by a colon, which needs doubling due to the
7625 higher-level list), or a Unix socket pathname enclosed in parentheses
7626 .next
7627 The database number is optional; if present that number is selected in the backend
7628 .next
7629 The password is optional; if present it is used to authenticate to the backend
7630 .endlist
7631 .wen
7632
7633 .new
7634 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7635 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7636 respectively, and the characters single-quote, double-quote, and backslash
7637 itself are escaped with backslashes.
7638
7639 The &%quote_redis%& expansion operator
7640 escapes whitespace and backslash characters with a backslash.
7641 .wen
7642
7643 .section "Specifying the server in the query" "SECTspeserque"
7644 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7645 it is possible to specify a list of servers with an individual query. This is
7646 done by starting the query with
7647 .display
7648 &`servers=`&&'server1:server2:server3:...'&&`;`&
7649 .endd
7650 Each item in the list may take one of two forms:
7651 .olist
7652 If it contains no slashes it is assumed to be just a host name. The appropriate
7653 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7654 of the same name, and the remaining parameters (database, user, password) are
7655 taken from there.
7656 .next
7657 If it contains any slashes, it is taken as a complete parameter set.
7658 .endlist
7659 The list of servers is used in exactly the same way as the global list.
7660 Once a connection to a server has happened and a query has been
7661 successfully executed, processing of the lookup ceases.
7662
7663 This feature is intended for use in master/slave situations where updates
7664 are occurring and you want to update the master rather than a slave. If the
7665 master is in the list as a backup for reading, you might have a global setting
7666 like this:
7667 .code
7668 mysql_servers = slave1/db/name/pw:\
7669                 slave2/db/name/pw:\
7670                 master/db/name/pw
7671 .endd
7672 In an updating lookup, you could then write:
7673 .code
7674 ${lookup mysql{servers=master; UPDATE ...} }
7675 .endd
7676 That query would then be sent only to the master server. If, on the other hand,
7677 the master is not to be used for reading, and so is not present in the global
7678 option, you can still update it by a query of this form:
7679 .code
7680 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7681 .endd
7682
7683
7684 .section "Special MySQL features" "SECID73"
7685 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7686 causes a connection to the server on the local host by means of a Unix domain
7687 socket. An alternate socket can be specified in parentheses.
7688 .new
7689 An option group name for MySQL option files can be specified in square brackets;
7690 the default value is &"exim"&.
7691 .wen
7692 The full syntax of each item in &%mysql_servers%& is:
7693 .display
7694 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7695   <&'database'&>/<&'user'&>/<&'password'&>
7696 .endd
7697 Any of the four sub-parts of the first field can be omitted. For normal use on
7698 the local host it can be left blank or set to just &"localhost"&.
7699
7700 No database need be supplied &-- but if it is absent here, it must be given in
7701 the queries.
7702
7703 If a MySQL query is issued that does not request any data (an insert, update,
7704 or delete command), the result of the lookup is the number of rows affected.
7705
7706 &*Warning*&: This can be misleading. If an update does not actually change
7707 anything (for example, setting a field to the value it already has), the result
7708 is zero because no rows are affected.
7709
7710
7711 .section "Special PostgreSQL features" "SECID74"
7712 PostgreSQL lookups can also use Unix domain socket connections to the database.
7713 This is usually faster and costs less CPU time than a TCP/IP connection.
7714 However it can be used only if the mail server runs on the same machine as the
7715 database server. A configuration line for PostgreSQL via Unix domain sockets
7716 looks like this:
7717 .code
7718 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7719 .endd
7720 In other words, instead of supplying a host name, a path to the socket is
7721 given. The path name is enclosed in parentheses so that its slashes aren't
7722 visually confused with the delimiters for the other server parameters.
7723
7724 If a PostgreSQL query is issued that does not request any data (an insert,
7725 update, or delete command), the result of the lookup is the number of rows
7726 affected.
7727
7728 .section "More about SQLite" "SECTsqlite"
7729 .cindex "lookup" "SQLite"
7730 .cindex "sqlite lookup type"
7731 SQLite is different to the other SQL lookups because a file name is required in
7732 addition to the SQL query. An SQLite database is a single file, and there is no
7733 daemon as in the other SQL databases. The interface to Exim requires the name
7734 of the file, as an absolute path, to be given at the start of the query. It is
7735 separated from the query by white space. This means that the path name cannot
7736 contain white space. Here is a lookup expansion example:
7737 .code
7738 ${lookup sqlite {/some/thing/sqlitedb \
7739   select name from aliases where id='userx';}}
7740 .endd
7741 In a list, the syntax is similar. For example:
7742 .code
7743 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7744    select * from relays where ip='$sender_host_address';
7745 .endd
7746 The only character affected by the &%quote_sqlite%& operator is a single
7747 quote, which it doubles.
7748
7749 .cindex timeout SQLite
7750 .cindex sqlite "lookup timeout"
7751 The SQLite library handles multiple simultaneous accesses to the database
7752 internally. Multiple readers are permitted, but only one process can
7753 update at once. Attempts to access the database while it is being updated
7754 are rejected after a timeout period, during which the SQLite library
7755 waits for the lock to be released. In Exim, the default timeout is set
7756 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7757 option.
7758 .ecindex IIDfidalo1
7759 .ecindex IIDfidalo2
7760
7761
7762 . ////////////////////////////////////////////////////////////////////////////
7763 . ////////////////////////////////////////////////////////////////////////////
7764
7765 .chapter "Domain, host, address, and local part lists" &&&
7766          "CHAPdomhosaddlists" &&&
7767          "Domain, host, and address lists"
7768 .scindex IIDdohoadli "lists of domains; hosts; etc."
7769 A number of Exim configuration options contain lists of domains, hosts,
7770 email addresses, or local parts. For example, the &%hold_domains%& option
7771 contains a list of domains whose delivery is currently suspended. These lists
7772 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7773 arguments to expansion conditions such as &%match_domain%&.
7774
7775 Each item in one of these lists is a pattern to be matched against a domain,
7776 host, email address, or local part, respectively. In the sections below, the
7777 different types of pattern for each case are described, but first we cover some
7778 general facilities that apply to all four kinds of list.
7779
7780 Note that other parts of Exim use a &'string list'& which does not
7781 support all the complexity available in
7782 domain, host, address and local part lists.
7783
7784
7785
7786 .section "Expansion of lists" "SECTlistexpand"
7787 .cindex "expansion" "of lists"
7788 Each list is expanded as a single string before it is used. The result of
7789 expansion must be a list, possibly containing empty items, which is split up
7790 into separate items for matching. By default, colon is the separator character,
7791 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7792 &<<SECTempitelis>>& for details of the list syntax; the second of these
7793 discusses the way to specify empty list items.
7794
7795
7796 If the string expansion is forced to fail, Exim behaves as if the item it is
7797 testing (domain, host, address, or local part) is not in the list. Other
7798 expansion failures cause temporary errors.
7799
7800 If an item in a list is a regular expression, backslashes, dollars and possibly
7801 other special characters in the expression must be protected against
7802 misinterpretation by the string expander. The easiest way to do this is to use
7803 the &`\N`& expansion feature to indicate that the contents of the regular
7804 expression should not be expanded. For example, in an ACL you might have:
7805 .code
7806 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7807                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7808 .endd
7809 The first item is a regular expression that is protected from expansion by
7810 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7811 senders based on the receiving domain.
7812
7813
7814
7815
7816 .section "Negated items in lists" "SECID76"
7817 .cindex "list" "negation"
7818 .cindex "negation" "in lists"
7819 Items in a list may be positive or negative. Negative items are indicated by a
7820 leading exclamation mark, which may be followed by optional white space. A list
7821 defines a set of items (domains, etc). When Exim processes one of these lists,
7822 it is trying to find out whether a domain, host, address, or local part
7823 (respectively) is in the set that is defined by the list. It works like this:
7824
7825 The list is scanned from left to right. If a positive item is matched, the
7826 subject that is being checked is in the set; if a negative item is matched, the
7827 subject is not in the set. If the end of the list is reached without the
7828 subject having matched any of the patterns, it is in the set if the last item
7829 was a negative one, but not if it was a positive one. For example, the list in
7830 .code
7831 domainlist relay_to_domains = !a.b.c : *.b.c
7832 .endd
7833 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7834 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7835 list is positive. However, if the setting were
7836 .code
7837 domainlist relay_to_domains = !a.b.c
7838 .endd
7839 then all domains other than &'a.b.c'& would match because the last item in the
7840 list is negative. In other words, a list that ends with a negative item behaves
7841 as if it had an extra item &`:*`& on the end.
7842
7843 Another way of thinking about positive and negative items in lists is to read
7844 the connector as &"or"& after a positive item and as &"and"& after a negative
7845 item.
7846
7847
7848
7849 .section "File names in lists" "SECTfilnamlis"
7850 .cindex "list" "file name in"
7851 If an item in a domain, host, address, or local part list is an absolute file
7852 name (beginning with a slash character), each line of the file is read and
7853 processed as if it were an independent item in the list, except that further
7854 file names are not allowed,
7855 and no expansion of the data from the file takes place.
7856 Empty lines in the file are ignored, and the file may also contain comment
7857 lines:
7858
7859 .ilist
7860 For domain and host lists, if a # character appears anywhere in a line of the
7861 file, it and all following characters are ignored.
7862 .next
7863 Because local parts may legitimately contain # characters, a comment in an
7864 address list or local part list file is recognized only if # is preceded by
7865 white space or the start of the line. For example:
7866 .code
7867 not#comment@x.y.z   # but this is a comment
7868 .endd
7869 .endlist
7870
7871 Putting a file name in a list has the same effect as inserting each line of the
7872 file as an item in the list (blank lines and comments excepted). However, there
7873 is one important difference: the file is read each time the list is processed,
7874 so if its contents vary over time, Exim's behaviour changes.
7875
7876 If a file name is preceded by an exclamation mark, the sense of any match
7877 within the file is inverted. For example, if
7878 .code
7879 hold_domains = !/etc/nohold-domains
7880 .endd
7881 and the file contains the lines
7882 .code
7883 !a.b.c
7884 *.b.c
7885 .endd
7886 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7887 any domain matching &`*.b.c`& is not.
7888
7889
7890
7891 .section "An lsearch file is not an out-of-line list" "SECID77"
7892 As will be described in the sections that follow, lookups can be used in lists
7893 to provide indexed methods of checking list membership. There has been some
7894 confusion about the way &(lsearch)& lookups work in lists. Because
7895 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7896 sometimes thought that it is allowed to contain wild cards and other kinds of
7897 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7898 always fixed strings, just as for any other single-key lookup type.
7899
7900 If you want to use a file to contain wild-card patterns that form part of a
7901 list, just give the file name on its own, without a search type, as described
7902 in the previous section. You could also use the &(wildlsearch)& or
7903 &(nwildlsearch)&, but there is no advantage in doing this.
7904
7905
7906
7907
7908 .section "Named lists" "SECTnamedlists"
7909 .cindex "named lists"
7910 .cindex "list" "named"
7911 A list of domains, hosts, email addresses, or local parts can be given a name
7912 which is then used to refer to the list elsewhere in the configuration. This is
7913 particularly convenient if the same list is required in several different
7914 places. It also allows lists to be given meaningful names, which can improve
7915 the readability of the configuration. For example, it is conventional to define
7916 a domain list called &'local_domains'& for all the domains that are handled
7917 locally on a host, using a configuration line such as
7918 .code
7919 domainlist local_domains = localhost:my.dom.example
7920 .endd
7921 Named lists are referenced by giving their name preceded by a plus sign, so,
7922 for example, a router that is intended to handle local domains would be
7923 configured with the line
7924 .code
7925 domains = +local_domains
7926 .endd
7927 The first router in a configuration is often one that handles all domains
7928 except the local ones, using a configuration with a negated item like this:
7929 .code
7930 dnslookup:
7931   driver = dnslookup
7932   domains = ! +local_domains
7933   transport = remote_smtp
7934   no_more
7935 .endd
7936 The four kinds of named list are created by configuration lines starting with
7937 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7938 respectively. Then there follows the name that you are defining, followed by an
7939 equals sign and the list itself. For example:
7940 .code
7941 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7942 addresslist bad_senders = cdb;/etc/badsenders
7943 .endd
7944 A named list may refer to other named lists:
7945 .code
7946 domainlist  dom1 = first.example : second.example
7947 domainlist  dom2 = +dom1 : third.example
7948 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7949 .endd
7950 &*Warning*&: If the last item in a referenced list is a negative one, the
7951 effect may not be what you intended, because the negation does not propagate
7952 out to the higher level. For example, consider:
7953 .code
7954 domainlist  dom1 = !a.b
7955 domainlist  dom2 = +dom1 : *.b
7956 .endd
7957 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7958 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7959 means it matches the second list as well. The effect is not the same as
7960 .code
7961 domainlist  dom2 = !a.b : *.b
7962 .endd
7963 where &'x.y'& does not match. It's best to avoid negation altogether in
7964 referenced lists if you can.
7965
7966 Named lists may have a performance advantage. When Exim is routing an
7967 address or checking an incoming message, it caches the result of tests on named
7968 lists. So, if you have a setting such as
7969 .code
7970 domains = +local_domains
7971 .endd
7972 on several of your routers
7973 or in several ACL statements,
7974 the actual test is done only for the first one. However, the caching works only
7975 if there are no expansions within the list itself or any sublists that it
7976 references. In other words, caching happens only for lists that are known to be
7977 the same each time they are referenced.
7978
7979 By default, there may be up to 16 named lists of each type. This limit can be
7980 extended by changing a compile-time variable. The use of domain and host lists
7981 is recommended for concepts such as local domains, relay domains, and relay
7982 hosts. The default configuration is set up like this.
7983
7984
7985
7986 .section "Named lists compared with macros" "SECID78"
7987 .cindex "list" "named compared with macro"
7988 .cindex "macro" "compared with named list"
7989 At first sight, named lists might seem to be no different from macros in the
7990 configuration file. However, macros are just textual substitutions. If you
7991 write
7992 .code
7993 ALIST = host1 : host2
7994 auth_advertise_hosts = !ALIST
7995 .endd
7996 it probably won't do what you want, because that is exactly the same as
7997 .code
7998 auth_advertise_hosts = !host1 : host2
7999 .endd
8000 Notice that the second host name is not negated. However, if you use a host
8001 list, and write
8002 .code
8003 hostlist alist = host1 : host2
8004 auth_advertise_hosts = ! +alist
8005 .endd
8006 the negation applies to the whole list, and so that is equivalent to
8007 .code
8008 auth_advertise_hosts = !host1 : !host2
8009 .endd
8010
8011
8012 .section "Named list caching" "SECID79"
8013 .cindex "list" "caching of named"
8014 .cindex "caching" "named lists"
8015 While processing a message, Exim caches the result of checking a named list if
8016 it is sure that the list is the same each time. In practice, this means that
8017 the cache operates only if the list contains no $ characters, which guarantees
8018 that it will not change when it is expanded. Sometimes, however, you may have
8019 an expanded list that you know will be the same each time within a given
8020 message. For example:
8021 .code
8022 domainlist special_domains = \
8023            ${lookup{$sender_host_address}cdb{/some/file}}
8024 .endd
8025 This provides a list of domains that depends only on the sending host's IP
8026 address. If this domain list is referenced a number of times (for example,
8027 in several ACL lines, or in several routers) the result of the check is not
8028 cached by default, because Exim does not know that it is going to be the
8029 same list each time.
8030
8031 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8032 cache the result anyway. For example:
8033 .code
8034 domainlist_cache special_domains = ${lookup{...
8035 .endd
8036 If you do this, you should be absolutely sure that caching is going to do
8037 the right thing in all cases. When in doubt, leave it out.
8038
8039
8040
8041 .section "Domain lists" "SECTdomainlist"
8042 .cindex "domain list" "patterns for"
8043 .cindex "list" "domain list"
8044 Domain lists contain patterns that are to be matched against a mail domain.
8045 The following types of item may appear in domain lists:
8046
8047 .ilist
8048 .cindex "primary host name"
8049 .cindex "host name" "matched in domain list"
8050 .oindex "&%primary_hostname%&"
8051 .cindex "domain list" "matching primary host name"
8052 .cindex "@ in a domain list"
8053 If a pattern consists of a single @ character, it matches the local host name,
8054 as set by the &%primary_hostname%& option (or defaulted). This makes it
8055 possible to use the same configuration file on several different hosts that
8056 differ only in their names.
8057 .next
8058 .cindex "@[] in a domain list"
8059 .cindex "domain list" "matching local IP interfaces"
8060 .cindex "domain literal"
8061 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8062 in square brackets (as in an email address that contains a domain literal), but
8063 only if that IP address is recognized as local for email routing purposes. The
8064 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8065 control which of a host's several IP addresses are treated as local.
8066 In today's Internet, the use of domain literals is controversial.
8067 .next
8068 .cindex "@mx_any"
8069 .cindex "@mx_primary"
8070 .cindex "@mx_secondary"
8071 .cindex "domain list" "matching MX pointers to local host"
8072 If a pattern consists of the string &`@mx_any`& it matches any domain that
8073 has an MX record pointing to the local host or to any host that is listed in
8074 .oindex "&%hosts_treat_as_local%&"
8075 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8076 are similar, except that the first matches only when a primary MX target is the
8077 local host, and the second only when no primary MX target is the local host,
8078 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8079 preference value &-- there may of course be more than one of them.
8080
8081 The MX lookup that takes place when matching a pattern of this type is
8082 performed with the resolver options for widening names turned off. Thus, for
8083 example, a single-component domain will &'not'& be expanded by adding the
8084 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8085 options of the &(dnslookup)& router for a discussion of domain widening.
8086
8087 Sometimes you may want to ignore certain IP addresses when using one of these
8088 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8089 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8090 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8091 on a router). For example:
8092 .code
8093 domains = @mx_any/ignore=127.0.0.1
8094 .endd
8095 This example matches any domain that has an MX record pointing to one of
8096 the local host's IP addresses other than 127.0.0.1.
8097
8098 The list of IP addresses is in fact processed by the same code that processes
8099 host lists, so it may contain CIDR-coded network specifications and it may also
8100 contain negative items.
8101
8102 Because the list of IP addresses is a sublist within a domain list, you have to
8103 be careful about delimiters if there is more than one address. Like any other
8104 list, the default delimiter can be changed. Thus, you might have:
8105 .code
8106 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8107           an.other.domain : ...
8108 .endd
8109 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8110 involved, it is easiest to change the delimiter for the main list as well:
8111 .code
8112 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8113           an.other.domain ? ...
8114 .endd
8115 .next
8116 .cindex "asterisk" "in domain list"
8117 .cindex "domain list" "asterisk in"
8118 .cindex "domain list" "matching &""ends with""&"
8119 If a pattern starts with an asterisk, the remaining characters of the pattern
8120 are compared with the terminating characters of the domain. The use of &"*"& in
8121 domain lists differs from its use in partial matching lookups. In a domain
8122 list, the character following the asterisk need not be a dot, whereas partial
8123 matching works only in terms of dot-separated components. For example, a domain
8124 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8125 &'cipher.key.ex'&.
8126
8127 .next
8128 .cindex "regular expressions" "in domain list"
8129 .cindex "domain list" "matching regular expression"
8130 If a pattern starts with a circumflex character, it is treated as a regular
8131 expression, and matched against the domain using a regular expression matching
8132 function. The circumflex is treated as part of the regular expression.
8133 Email domains are case-independent, so this regular expression match is by
8134 default case-independent, but you can make it case-dependent by starting it
8135 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8136 are given in chapter &<<CHAPregexp>>&.
8137
8138 &*Warning*&: Because domain lists are expanded before being processed, you
8139 must escape any backslash and dollar characters in the regular expression, or
8140 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8141 it is not to be expanded (unless you really do want to build a regular
8142 expression by expansion, of course).
8143 .next
8144 .cindex "lookup" "in domain list"
8145 .cindex "domain list" "matching by lookup"
8146 If a pattern starts with the name of a single-key lookup type followed by a
8147 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8148 must be a file name in a suitable format for the lookup type. For example, for
8149 &"cdb;"& it must be an absolute path:
8150 .code
8151 domains = cdb;/etc/mail/local_domains.cdb
8152 .endd
8153 The appropriate type of lookup is done on the file using the domain name as the
8154 key. In most cases, the data that is looked up is not used; Exim is interested
8155 only in whether or not the key is present in the file. However, when a lookup
8156 is used for the &%domains%& option on a router
8157 or a &%domains%& condition in an ACL statement, the data is preserved in the
8158 &$domain_data$& variable and can be referred to in other router options or
8159 other statements in the same ACL.
8160
8161 .next
8162 Any of the single-key lookup type names may be preceded by
8163 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8164 .code
8165 domains = partial-dbm;/partial/domains
8166 .endd
8167 This causes partial matching logic to be invoked; a description of how this
8168 works is given in section &<<SECTpartiallookup>>&.
8169
8170 .next
8171 .cindex "asterisk" "in lookup type"
8172 Any of the single-key lookup types may be followed by an asterisk. This causes
8173 a default lookup for a key consisting of a single asterisk to be done if the
8174 original lookup fails. This is not a useful feature when using a domain list to
8175 select particular domains (because any domain would match), but it might have
8176 value if the result of the lookup is being used via the &$domain_data$&
8177 expansion variable.
8178 .next
8179 If the pattern starts with the name of a query-style lookup type followed by a
8180 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8181 pattern must be an appropriate query for the lookup type, as described in
8182 chapter &<<CHAPfdlookup>>&. For example:
8183 .code
8184 hold_domains = mysql;select domain from holdlist \
8185   where domain = '${quote_mysql:$domain}';
8186 .endd
8187 In most cases, the data that is looked up is not used (so for an SQL query, for
8188 example, it doesn't matter what field you select). Exim is interested only in
8189 whether or not the query succeeds. However, when a lookup is used for the
8190 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8191 variable and can be referred to in other options.
8192 .next
8193 .cindex "domain list" "matching literal domain name"
8194 If none of the above cases apply, a caseless textual comparison is made
8195 between the pattern and the domain.
8196 .endlist
8197
8198 Here is an example that uses several different kinds of pattern:
8199 .code
8200 domainlist funny_domains = \
8201   @ : \
8202   lib.unseen.edu : \
8203   *.foundation.fict.example : \
8204   \N^[1-2]\d{3}\.fict\.example$\N : \
8205   partial-dbm;/opt/data/penguin/book : \
8206   nis;domains.byname : \
8207   nisplus;[name=$domain,status=local],domains.org_dir
8208 .endd
8209 There are obvious processing trade-offs among the various matching modes. Using
8210 an asterisk is faster than a regular expression, and listing a few names
8211 explicitly probably is too. The use of a file or database lookup is expensive,
8212 but may be the only option if hundreds of names are required. Because the
8213 patterns are tested in order, it makes sense to put the most commonly matched
8214 patterns earlier.
8215
8216
8217
8218 .section "Host lists" "SECThostlist"
8219 .cindex "host list" "patterns in"
8220 .cindex "list" "host list"
8221 Host lists are used to control what remote hosts are allowed to do. For
8222 example, some hosts may be allowed to use the local host as a relay, and some
8223 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8224 two different ways, by name or by IP address. In a host list, some types of
8225 pattern are matched to a host name, and some are matched to an IP address.
8226 You need to be particularly careful with this when single-key lookups are
8227 involved, to ensure that the right value is being used as the key.
8228
8229
8230 .section "Special host list patterns" "SECID80"
8231 .cindex "empty item in hosts list"
8232 .cindex "host list" "empty string in"
8233 If a host list item is the empty string, it matches only when no remote host is
8234 involved. This is the case when a message is being received from a local
8235 process using SMTP on the standard input, that is, when a TCP/IP connection is
8236 not used.
8237
8238 .cindex "asterisk" "in host list"
8239 The special pattern &"*"& in a host list matches any host or no host. Neither
8240 the IP address nor the name is actually inspected.
8241
8242
8243
8244 .section "Host list patterns that match by IP address" "SECThoslispatip"
8245 .cindex "host list" "matching IP addresses"
8246 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8247 the incoming address actually appears in the IPv6 host as
8248 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8249 list, it is converted into a traditional IPv4 address first. (Not all operating
8250 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8251 concerns.)
8252
8253 The following types of pattern in a host list check the remote host by
8254 inspecting its IP address:
8255
8256 .ilist
8257 If the pattern is a plain domain name (not a regular expression, not starting
8258 with *, not a lookup of any kind), Exim calls the operating system function
8259 to find the associated IP address(es). Exim uses the newer
8260 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8261 This typically causes a forward DNS lookup of the name. The result is compared
8262 with the IP address of the subject host.
8263
8264 If there is a temporary problem (such as a DNS timeout) with the host name
8265 lookup, a temporary error occurs. For example, if the list is being used in an
8266 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8267 temporary SMTP error code. If no IP address can be found for the host name,
8268 what happens is described in section &<<SECTbehipnot>>& below.
8269
8270 .next
8271 .cindex "@ in a host list"
8272 If the pattern is &"@"&, the primary host name is substituted and used as a
8273 domain name, as just described.
8274
8275 .next
8276 If the pattern is an IP address, it is matched against the IP address of the
8277 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8278 IPv6 addresses can be given in colon-separated format, but the colons have to
8279 be doubled so as not to be taken as item separators when the default list
8280 separator is used. IPv6 addresses are recognized even when Exim is compiled
8281 without IPv6 support. This means that if they appear in a host list on an
8282 IPv4-only host, Exim will not treat them as host names. They are just addresses
8283 that can never match a client host.
8284
8285 .next
8286 .cindex "@[] in a host list"
8287 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8288 the local host. For example, if the local host is an IPv4 host with one
8289 interface address 10.45.23.56, these two ACL statements have the same effect:
8290 .code
8291 accept hosts = 127.0.0.1 : 10.45.23.56
8292 accept hosts = @[]
8293 .endd
8294 .next
8295 .cindex "CIDR notation"
8296 If the pattern is an IP address followed by a slash and a mask length (for
8297 example 10.11.42.0/24), it is matched against the IP address of the subject
8298 host under the given mask. This allows, an entire network of hosts to be
8299 included (or excluded) by a single item. The mask uses CIDR notation; it
8300 specifies the number of address bits that must match, starting from the most
8301 significant end of the address.
8302
8303 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8304 of a range of addresses. It is the number of bits in the network portion of the
8305 address. The above example specifies a 24-bit netmask, so it matches all 256
8306 addresses in the 10.11.42.0 network. An item such as
8307 .code
8308 192.168.23.236/31
8309 .endd
8310 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8311 32 for an IPv4 address is the same as no mask at all; just a single address
8312 matches.
8313
8314 Here is another example which shows an IPv4 and an IPv6 network:
8315 .code
8316 recipient_unqualified_hosts = 192.168.0.0/16: \
8317                               3ffe::ffff::836f::::/48
8318 .endd
8319 The doubling of list separator characters applies only when these items
8320 appear inline in a host list. It is not required when indirecting via a file.
8321 For example:
8322 .code
8323 recipient_unqualified_hosts = /opt/exim/unqualnets
8324 .endd
8325 could make use of a file containing
8326 .code
8327 172.16.0.0/12
8328 3ffe:ffff:836f::/48
8329 .endd
8330 to have exactly the same effect as the previous example. When listing IPv6
8331 addresses inline, it is usually more convenient to use the facility for
8332 changing separator characters. This list contains the same two networks:
8333 .code
8334 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8335                                  3ffe:ffff:836f::/48
8336 .endd
8337 The separator is changed to semicolon by the leading &"<;"& at the start of the
8338 list.
8339 .endlist
8340
8341
8342
8343 .section "Host list patterns for single-key lookups by host address" &&&
8344          "SECThoslispatsikey"
8345 .cindex "host list" "lookup of IP address"
8346 When a host is to be identified by a single-key lookup of its complete IP
8347 address, the pattern takes this form:
8348 .display
8349 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8350 .endd
8351 For example:
8352 .code
8353 hosts_lookup = net-cdb;/hosts-by-ip.db
8354 .endd
8355 The text form of the IP address of the subject host is used as the lookup key.
8356 IPv6 addresses are converted to an unabbreviated form, using lower case
8357 letters, with dots as separators because colon is the key terminator in
8358 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8359 quoting the keys, but this is a facility that was added later.] The data
8360 returned by the lookup is not used.
8361
8362 .cindex "IP address" "masking"
8363 .cindex "host list" "masked IP address"
8364 Single-key lookups can also be performed using masked IP addresses, using
8365 patterns of this form:
8366 .display
8367 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8368 .endd
8369 For example:
8370 .code
8371 net24-dbm;/networks.db
8372 .endd
8373 The IP address of the subject host is masked using <&'number'&> as the mask
8374 length. A textual string is constructed from the masked value, followed by the
8375 mask, and this is used as the lookup key. For example, if the host's IP address
8376 is 192.168.34.6, the key that is looked up for the above example is
8377 &"192.168.34.0/24"&.
8378
8379 When an IPv6 address is converted to a string, dots are normally used instead
8380 of colons, so that keys in &(lsearch)& files need not contain colons (which
8381 terminate &(lsearch)& keys). This was implemented some time before the ability
8382 to quote keys was made available in &(lsearch)& files. However, the more
8383 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8384 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8385 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8386 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8387 addresses are always used.
8388
8389 Ideally, it would be nice to tidy up this anomalous situation by changing to
8390 colons in all cases, given that quoting is now available for &(lsearch)&.
8391 However, this would be an incompatible change that might break some existing
8392 configurations.
8393
8394 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8395 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8396 the former case the key strings include the mask value, whereas in the latter
8397 case the IP address is used on its own.
8398
8399
8400
8401 .section "Host list patterns that match by host name" "SECThoslispatnam"
8402 .cindex "host" "lookup failures"
8403 .cindex "unknown host name"
8404 .cindex "host list" "matching host name"
8405 There are several types of pattern that require Exim to know the name of the
8406 remote host. These are either wildcard patterns or lookups by name. (If a
8407 complete hostname is given without any wildcarding, it is used to find an IP
8408 address to match against, as described in section &<<SECThoslispatip>>&
8409 above.)
8410
8411 If the remote host name is not already known when Exim encounters one of these
8412 patterns, it has to be found from the IP address.
8413 Although many sites on the Internet are conscientious about maintaining reverse
8414 DNS data for their hosts, there are also many that do not do this.
8415 Consequently, a name cannot always be found, and this may lead to unwanted
8416 effects. Take care when configuring host lists with wildcarded name patterns.
8417 Consider what will happen if a name cannot be found.
8418
8419 Because of the problems of determining host names from IP addresses, matching
8420 against host names is not as common as matching against IP addresses.
8421
8422 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8423 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8424 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8425 are done can be changed by setting the &%host_lookup_order%& option. For
8426 security, once Exim has found one or more names, it looks up the IP addresses
8427 for these names and compares them with the IP address that it started with.
8428 Only those names whose IP addresses match are accepted. Any other names are
8429 discarded. If no names are left, Exim behaves as if the host name cannot be
8430 found. In the most common case there is only one name and one IP address.
8431
8432 There are some options that control what happens if a host name cannot be
8433 found. These are described in section &<<SECTbehipnot>>& below.
8434
8435 .cindex "host" "alias for"
8436 .cindex "alias for host"
8437 As a result of aliasing, hosts may have more than one name. When processing any
8438 of the following types of pattern, all the host's names are checked:
8439
8440 .ilist
8441 .cindex "asterisk" "in host list"
8442 If a pattern starts with &"*"& the remainder of the item must match the end of
8443 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8444 &'.b.c'&. This special simple form is provided because this is a very common
8445 requirement. Other kinds of wildcarding require the use of a regular
8446 expression.
8447 .next
8448 .cindex "regular expressions" "in host list"
8449 .cindex "host list" "regular expression in"
8450 If the item starts with &"^"& it is taken to be a regular expression which is
8451 matched against the host name. Host names are case-independent, so this regular
8452 expression match is by default case-independent, but you can make it
8453 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8454 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8455 example,
8456 .code
8457 ^(a|b)\.c\.d$
8458 .endd
8459 is a regular expression that matches either of the two hosts &'a.c.d'& or
8460 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8461 that backslash and dollar characters are not misinterpreted as part of the
8462 string expansion. The simplest way to do this is to use &`\N`& to mark that
8463 part of the string as non-expandable. For example:
8464 .code
8465 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8466 .endd
8467 &*Warning*&: If you want to match a complete host name, you must include the
8468 &`$`& terminating metacharacter in the regular expression, as in the above
8469 example. Without it, a match at the start of the host name is all that is
8470 required.
8471 .endlist
8472
8473
8474
8475
8476 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8477 .cindex "host" "lookup failures, permanent"
8478 While processing a host list, Exim may need to look up an IP address from a
8479 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8480 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8481 behaviour when it fails to find the information it is seeking is the same.
8482
8483 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8484 apply to temporary DNS errors, whose handling is described in the next section.
8485
8486 .cindex "&`+include_unknown`&"
8487 .cindex "&`+ignore_unknown`&"
8488 Exim parses a host list from left to right. If it encounters a permanent
8489 lookup failure in any item in the host list before it has found a match,
8490 Exim treats it as a failure and the default behavior is as if the host
8491 does not match the list. This may not always be what you want to happen.
8492 To change Exim's behaviour, the special items &`+include_unknown`& or
8493 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8494 not recognized in an indirected file).
8495
8496 .ilist
8497 If any item that follows &`+include_unknown`& requires information that
8498 cannot found, Exim behaves as if the host does match the list. For example,
8499 .code
8500 host_reject_connection = +include_unknown:*.enemy.ex
8501 .endd
8502 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8503 any hosts whose name it cannot find.
8504
8505 .next
8506 If any item that follows &`+ignore_unknown`& requires information that cannot
8507 be found, Exim ignores that item and proceeds to the rest of the list. For
8508 example:
8509 .code
8510 accept hosts = +ignore_unknown : friend.example : \
8511                192.168.4.5
8512 .endd
8513 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8514 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8515 name can be found for 192.168.4.5, it is rejected.
8516 .endlist
8517
8518 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8519 list. The effect of each one lasts until the next, or until the end of the
8520 list.
8521
8522 .section "Mixing wildcarded host names and addresses in host lists" &&&
8523          "SECTmixwilhos"
8524 .cindex "host list" "mixing names and addresses in"
8525
8526 This section explains the host/ip processing logic with the same concepts
8527 as the previous section, but specifically addresses what happens when a
8528 wildcarded hostname is one of the items in the hostlist.
8529
8530 .ilist
8531 If you have name lookups or wildcarded host names and
8532 IP addresses in the same host list, you should normally put the IP
8533 addresses first. For example, in an ACL you could have:
8534 .code
8535 accept hosts = 10.9.8.7 : *.friend.example
8536 .endd
8537 The reason you normally would order it this way lies in the
8538 left-to-right way that Exim processes lists.  It can test IP addresses
8539 without doing any DNS lookups, but when it reaches an item that requires
8540 a host name, it fails if it cannot find a host name to compare with the
8541 pattern. If the above list is given in the opposite order, the
8542 &%accept%& statement fails for a host whose name cannot be found, even
8543 if its IP address is 10.9.8.7.
8544
8545 .next
8546 If you really do want to do the name check first, and still recognize the IP
8547 address, you can rewrite the ACL like this:
8548 .code
8549 accept hosts = *.friend.example
8550 accept hosts = 10.9.8.7
8551 .endd
8552 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8553 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8554 &`+ignore_unknown`&, which was discussed in depth in the first example in
8555 this section.
8556 .endlist
8557
8558
8559 .section "Temporary DNS errors when looking up host information" &&&
8560          "SECTtemdnserr"
8561 .cindex "host" "lookup failures, temporary"
8562 .cindex "&`+include_defer`&"
8563 .cindex "&`+ignore_defer`&"
8564 A temporary DNS lookup failure normally causes a defer action (except when
8565 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8566 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8567 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8568 section. These options should be used with care, probably only in non-critical
8569 host lists such as whitelists.
8570
8571
8572
8573 .section "Host list patterns for single-key lookups by host name" &&&
8574          "SECThoslispatnamsk"
8575 .cindex "unknown host name"
8576 .cindex "host list" "matching host name"
8577 If a pattern is of the form
8578 .display
8579 <&'single-key-search-type'&>;<&'search-data'&>
8580 .endd
8581 for example
8582 .code
8583 dbm;/host/accept/list
8584 .endd
8585 a single-key lookup is performed, using the host name as its key. If the
8586 lookup succeeds, the host matches the item. The actual data that is looked up
8587 is not used.
8588
8589 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8590 keys in the file, not IP addresses. If you want to do lookups based on IP
8591 addresses, you must precede the search type with &"net-"& (see section
8592 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8593 two items in the same list, one doing an address lookup and one doing a name
8594 lookup, both using the same file.
8595
8596
8597
8598 .section "Host list patterns for query-style lookups" "SECID81"
8599 If a pattern is of the form
8600 .display
8601 <&'query-style-search-type'&>;<&'query'&>
8602 .endd
8603 the query is obeyed, and if it succeeds, the host matches the item. The actual
8604 data that is looked up is not used. The variables &$sender_host_address$& and
8605 &$sender_host_name$& can be used in the query. For example:
8606 .code
8607 hosts_lookup = pgsql;\
8608   select ip from hostlist where ip='$sender_host_address'
8609 .endd
8610 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8611 can use the &%sg%& expansion item to change this if you need to. If you want to
8612 use masked IP addresses in database queries, you can use the &%mask%& expansion
8613 operator.
8614
8615 If the query contains a reference to &$sender_host_name$&, Exim automatically
8616 looks up the host name if it has not already done so. (See section
8617 &<<SECThoslispatnam>>& for comments on finding host names.)
8618
8619 Historical note: prior to release 4.30, Exim would always attempt to find a
8620 host name before running the query, unless the search type was preceded by
8621 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8622 still recognized for query-style lookups, but its presence or absence has no
8623 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8624 See section &<<SECThoslispatsikey>>&.)
8625
8626
8627
8628
8629
8630 .section "Address lists" "SECTaddresslist"
8631 .cindex "list" "address list"
8632 .cindex "address list" "empty item"
8633 .cindex "address list" "patterns"
8634 Address lists contain patterns that are matched against mail addresses. There
8635 is one special case to be considered: the sender address of a bounce message is
8636 always empty. You can test for this by providing an empty item in an address
8637 list. For example, you can set up a router to process bounce messages by
8638 using this option setting:
8639 .code
8640 senders = :
8641 .endd
8642 The presence of the colon creates an empty item. If you do not provide any
8643 data, the list is empty and matches nothing. The empty sender can also be
8644 detected by a regular expression that matches an empty string,
8645 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8646
8647 Non-empty items in an address list can be straightforward email addresses. For
8648 example:
8649 .code
8650 senders = jbc@askone.example : hs@anacreon.example
8651 .endd
8652 A certain amount of wildcarding is permitted. If a pattern contains an @
8653 character, but is not a regular expression and does not begin with a
8654 semicolon-terminated lookup type (described below), the local part of the
8655 subject address is compared with the local part of the pattern, which may start
8656 with an asterisk. If the local parts match, the domain is checked in exactly
8657 the same way as for a pattern in a domain list. For example, the domain can be
8658 wildcarded, refer to a named list, or be a lookup:
8659 .code
8660 deny senders = *@*.spamming.site:\
8661                *@+hostile_domains:\
8662                bozo@partial-lsearch;/list/of/dodgy/sites:\
8663                *@dbm;/bad/domains.db
8664 .endd
8665 .cindex "local part" "starting with !"
8666 .cindex "address list" "local part starting with !"
8667 If a local part that begins with an exclamation mark is required, it has to be
8668 specified using a regular expression, because otherwise the exclamation mark is
8669 treated as a sign of negation, as is standard in lists.
8670
8671 If a non-empty pattern that is not a regular expression or a lookup does not
8672 contain an @ character, it is matched against the domain part of the subject
8673 address. The only two formats that are recognized this way are a literal
8674 domain, or a domain pattern that starts with *. In both these cases, the effect
8675 is the same as if &`*@`& preceded the pattern. For example:
8676 .code
8677 deny senders = enemy.domain : *.enemy.domain
8678 .endd
8679
8680 The following kinds of more complicated address list pattern can match any
8681 address, including the empty address that is characteristic of bounce message
8682 senders:
8683
8684 .ilist
8685 .cindex "regular expressions" "in address list"
8686 .cindex "address list" "regular expression in"
8687 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8688 done against the complete address, with the pattern as the regular expression.
8689 You must take care that backslash and dollar characters are not misinterpreted
8690 as part of the string expansion. The simplest way to do this is to use &`\N`&
8691 to mark that part of the string as non-expandable. For example:
8692 .code
8693 deny senders = \N^.*this.*@example\.com$\N : \
8694                \N^\d{8}.+@spamhaus.example$\N : ...
8695 .endd
8696 The &`\N`& sequences are removed by the expansion, so these items do indeed
8697 start with &"^"& by the time they are being interpreted as address patterns.
8698
8699 .next
8700 .cindex "address list" "lookup for complete address"
8701 Complete addresses can be looked up by using a pattern that starts with a
8702 lookup type terminated by a semicolon, followed by the data for the lookup. For
8703 example:
8704 .code
8705 deny senders = cdb;/etc/blocked.senders : \
8706   mysql;select address from blocked where \
8707   address='${quote_mysql:$sender_address}'
8708 .endd
8709 Both query-style and single-key lookup types can be used. For a single-key
8710 lookup type, Exim uses the complete address as the key. However, empty keys are
8711 not supported for single-key lookups, so a match against the empty address
8712 always fails. This restriction does not apply to query-style lookups.
8713
8714 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8715 cannot be used, and is ignored if specified, with an entry being written to the
8716 panic log.
8717 .cindex "*@ with single-key lookup"
8718 However, you can configure lookup defaults, as described in section
8719 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8720 default. For example, with this lookup:
8721 .code
8722 accept senders = lsearch*@;/some/file
8723 .endd
8724 the file could contains lines like this:
8725 .code
8726 user1@domain1.example
8727 *@domain2.example
8728 .endd
8729 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8730 that are tried is:
8731 .code
8732 nimrod@jaeger.example
8733 *@jaeger.example
8734 *
8735 .endd
8736 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8737 would mean that every address matches, thus rendering the test useless.
8738
8739 &*Warning 2*&: Do not confuse these two kinds of item:
8740 .code
8741 deny recipients = dbm*@;/some/file
8742 deny recipients = *@dbm;/some/file
8743 .endd
8744 The first does a whole address lookup, with defaulting, as just described,
8745 because it starts with a lookup type. The second matches the local part and
8746 domain independently, as described in a bullet point below.
8747 .endlist
8748
8749
8750 The following kinds of address list pattern can match only non-empty addresses.
8751 If the subject address is empty, a match against any of these pattern types
8752 always fails.
8753
8754
8755 .ilist
8756 .cindex "@@ with single-key lookup"
8757 .cindex "address list" "@@ lookup type"
8758 .cindex "address list" "split local part and domain"
8759 If a pattern starts with &"@@"& followed by a single-key lookup item
8760 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8761 split into a local part and a domain. The domain is looked up in the file. If
8762 it is not found, there is no match. If it is found, the data that is looked up
8763 from the file is treated as a colon-separated list of local part patterns, each
8764 of which is matched against the subject local part in turn.
8765
8766 .cindex "asterisk" "in address list"
8767 The lookup may be a partial one, and/or one involving a search for a default
8768 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8769 patterns that are looked up can be regular expressions or begin with &"*"&, or
8770 even be further lookups. They may also be independently negated. For example,
8771 with
8772 .code
8773 deny senders = @@dbm;/etc/reject-by-domain
8774 .endd
8775 the data from which the DBM file is built could contain lines like
8776 .code
8777 baddomain.com:  !postmaster : *
8778 .endd
8779 to reject all senders except &%postmaster%& from that domain.
8780
8781 .cindex "local part" "starting with !"
8782 If a local part that actually begins with an exclamation mark is required, it
8783 has to be specified using a regular expression. In &(lsearch)& files, an entry
8784 may be split over several lines by indenting the second and subsequent lines,
8785 but the separating colon must still be included at line breaks. White space
8786 surrounding the colons is ignored. For example:
8787 .code
8788 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8789   spammer3 : spammer4
8790 .endd
8791 As in all colon-separated lists in Exim, a colon can be included in an item by
8792 doubling.
8793
8794 If the last item in the list starts with a right angle-bracket, the remainder
8795 of the item is taken as a new key to look up in order to obtain a continuation
8796 list of local parts. The new key can be any sequence of characters. Thus one
8797 might have entries like
8798 .code
8799 aol.com: spammer1 : spammer 2 : >*
8800 xyz.com: spammer3 : >*
8801 *:       ^\d{8}$
8802 .endd
8803 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8804 local parts for all domains, in addition to the specific local parts listed for
8805 each domain. Of course, using this feature costs another lookup each time a
8806 chain is followed, but the effort needed to maintain the data is reduced.
8807
8808 .cindex "loop" "in lookups"
8809 It is possible to construct loops using this facility, and in order to catch
8810 them, the chains may be no more than fifty items long.
8811
8812 .next
8813 The @@<&'lookup'&> style of item can also be used with a query-style
8814 lookup, but in this case, the chaining facility is not available. The lookup
8815 can only return a single list of local parts.
8816 .endlist
8817
8818 &*Warning*&: There is an important difference between the address list items
8819 in these two examples:
8820 .code
8821 senders = +my_list
8822 senders = *@+my_list
8823 .endd
8824 In the first one, &`my_list`& is a named address list, whereas in the second
8825 example it is a named domain list.
8826
8827
8828
8829
8830 .section "Case of letters in address lists" "SECTcasletadd"
8831 .cindex "case of local parts"
8832 .cindex "address list" "case forcing"
8833 .cindex "case forcing in address lists"
8834 Domains in email addresses are always handled caselessly, but for local parts
8835 case may be significant on some systems (see &%caseful_local_part%& for how
8836 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8837 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8838 blocking lists should be done in a case-independent manner. Since most address
8839 lists in Exim are used for this kind of control, Exim attempts to do this by
8840 default.
8841
8842 The domain portion of an address is always lowercased before matching it to an
8843 address list. The local part is lowercased by default, and any string
8844 comparisons that take place are done caselessly. This means that the data in
8845 the address list itself, in files included as plain file names, and in any file
8846 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8847 keys in files that are looked up by a search type other than &(lsearch)& (which
8848 works caselessly) must be in lower case, because these lookups are not
8849 case-independent.
8850
8851 .cindex "&`+caseful`&"
8852 To allow for the possibility of caseful address list matching, if an item in
8853 an address list is the string &"+caseful"&, the original case of the local
8854 part is restored for any comparisons that follow, and string comparisons are no
8855 longer case-independent. This does not affect the domain, which remains in
8856 lower case. However, although independent matches on the domain alone are still
8857 performed caselessly, regular expressions that match against an entire address
8858 become case-sensitive after &"+caseful"& has been seen.
8859
8860
8861
8862 .section "Local part lists" "SECTlocparlis"
8863 .cindex "list" "local part list"
8864 .cindex "local part" "list"
8865 Case-sensitivity in local part lists is handled in the same way as for address
8866 lists, as just described. The &"+caseful"& item can be used if required. In a
8867 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8868 set false, the subject is lowercased and the matching is initially
8869 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8870 matching in the local part list, but not elsewhere in the router. If
8871 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8872 option is case-sensitive from the start.
8873
8874 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8875 comments are handled in the same way as address lists &-- they are recognized
8876 only if the # is preceded by white space or the start of the line.
8877 Otherwise, local part lists are matched in the same way as domain lists, except
8878 that the special items that refer to the local host (&`@`&, &`@[]`&,
8879 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8880 Refer to section &<<SECTdomainlist>>& for details of the other available item
8881 types.
8882 .ecindex IIDdohoadli
8883
8884
8885
8886
8887 . ////////////////////////////////////////////////////////////////////////////
8888 . ////////////////////////////////////////////////////////////////////////////
8889
8890 .chapter "String expansions" "CHAPexpand"
8891 .scindex IIDstrexp "expansion" "of strings"
8892 Many strings in Exim's run time configuration are expanded before use. Some of
8893 them are expanded every time they are used; others are expanded only once.
8894
8895 When a string is being expanded it is copied verbatim from left to right except
8896 when a dollar or backslash character is encountered. A dollar specifies the
8897 start of a portion of the string that is interpreted and replaced as described
8898 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8899 escape character, as described in the following section.
8900
8901 Whether a string is expanded depends upon the context.  Usually this is solely
8902 dependent upon the option for which a value is sought; in this documentation,
8903 options for which string expansion is performed are marked with &dagger; after
8904 the data type.  ACL rules always expand strings.  A couple of expansion
8905 conditions do not expand some of the brace-delimited branches, for security
8906 reasons.
8907
8908
8909
8910 .section "Literal text in expanded strings" "SECTlittext"
8911 .cindex "expansion" "including literal text"
8912 An uninterpreted dollar can be included in an expanded string by putting a
8913 backslash in front of it. A backslash can be used to prevent any special
8914 character being treated specially in an expansion, including backslash itself.
8915 If the string appears in quotes in the configuration file, two backslashes are
8916 required because the quotes themselves cause interpretation of backslashes when
8917 the string is read in (see section &<<SECTstrings>>&).
8918
8919 .cindex "expansion" "non-expandable substrings"
8920 A portion of the string can specified as non-expandable by placing it between
8921 two occurrences of &`\N`&. This is particularly useful for protecting regular
8922 expressions, which often contain backslashes and dollar signs. For example:
8923 .code
8924 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8925 .endd
8926 On encountering the first &`\N`&, the expander copies subsequent characters
8927 without interpretation until it reaches the next &`\N`& or the end of the
8928 string.
8929
8930
8931
8932 .section "Character escape sequences in expanded strings" "SECID82"
8933 .cindex "expansion" "escape sequences"
8934 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8935 expanded string is recognized as an escape sequence for the character newline,
8936 carriage return, or tab, respectively. A backslash followed by up to three
8937 octal digits is recognized as an octal encoding for a single character, and a
8938 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8939 encoding.
8940
8941 These escape sequences are also recognized in quoted strings when they are read
8942 in. Their interpretation in expansions as well is useful for unquoted strings,
8943 and for other cases such as looked-up strings that are then expanded.
8944
8945
8946 .section "Testing string expansions" "SECID83"
8947 .cindex "expansion" "testing"
8948 .cindex "testing" "string expansion"
8949 .oindex "&%-be%&"
8950 Many expansions can be tested by calling Exim with the &%-be%& option. This
8951 takes the command arguments, or lines from the standard input if there are no
8952 arguments, runs them through the string expansion code, and writes the results
8953 to the standard output. Variables based on configuration values are set up, but
8954 since no message is being processed, variables such as &$local_part$& have no
8955 value. Nevertheless the &%-be%& option can be useful for checking out file and
8956 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8957 and &%nhash%&.
8958
8959 Exim gives up its root privilege when it is called with the &%-be%& option, and
8960 instead runs under the uid and gid it was called with, to prevent users from
8961 using &%-be%& for reading files to which they do not have access.
8962
8963 .oindex "&%-bem%&"
8964 If you want to test expansions that include variables whose values are taken
8965 from a message, there are two other options that can be used. The &%-bem%&
8966 option is like &%-be%& except that it is followed by a file name. The file is
8967 read as a message before doing the test expansions. For example:
8968 .code
8969 exim -bem /tmp/test.message '$h_subject:'
8970 .endd
8971 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8972 Exim message identifier. For example:
8973 .code
8974 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8975 .endd
8976 This loads the message from Exim's spool before doing the test expansions, and
8977 is therefore restricted to admin users.
8978
8979
8980 .section "Forced expansion failure" "SECTforexpfai"
8981 .cindex "expansion" "forced failure"
8982 A number of expansions that are described in the following section have
8983 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8984 (which are sometimes called &"curly brackets"&). Which of the two strings is
8985 used depends on some condition that is evaluated as part of the expansion. If,
8986 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8987 the entire string expansion fails in a way that can be detected by the code
8988 that requested the expansion. This is called &"forced expansion failure"&, and
8989 its consequences depend on the circumstances. In some cases it is no different
8990 from any other expansion failure, but in others a different action may be
8991 taken. Such variations are mentioned in the documentation of the option that is
8992 being expanded.
8993
8994
8995
8996
8997 .section "Expansion items" "SECTexpansionitems"
8998 The following items are recognized in expanded strings. White space may be used
8999 between sub-items that are keywords or substrings enclosed in braces inside an
9000 outer set of braces, to improve readability. &*Warning*&: Within braces,
9001 white space is significant.
9002
9003 .vlist
9004 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9005 .cindex "expansion" "variables"
9006 Substitute the contents of the named variable, for example:
9007 .code
9008 $local_part
9009 ${domain}
9010 .endd
9011 The second form can be used to separate the name from subsequent alphanumeric
9012 characters. This form (using braces) is available only for variables; it does
9013 &'not'& apply to message headers. The names of the variables are given in
9014 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9015 given, the expansion fails.
9016
9017 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9018 .cindex "expansion" "operators"
9019 The string is first itself expanded, and then the operation specified by
9020 <&'op'&> is applied to it. For example:
9021 .code
9022 ${lc:$local_part}
9023 .endd
9024 The string starts with the first character after the colon, which may be
9025 leading white space. A list of operators is given in section &<<SECTexpop>>&
9026 below. The operator notation is used for simple expansion items that have just
9027 one argument, because it reduces the number of braces and therefore makes the
9028 string easier to understand.
9029
9030 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9031 This item inserts &"basic"& header lines. It is described with the &%header%&
9032 expansion item below.
9033
9034
9035 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9036 .cindex "expansion" "calling an acl"
9037 .cindex "&%acl%&" "call from expansion"
9038 The name and zero to nine argument strings are first expanded separately.  The expanded
9039 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9040 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9041 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9042 and may use the variables; if another acl expansion is used the values
9043 are restored after it returns.  If the ACL sets
9044 a value using a "message =" modifier and returns accept or deny, the value becomes
9045 the result of the expansion.
9046 If no message is set and the ACL returns accept or deny
9047 the expansion result is an empty string.
9048 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9049
9050
9051 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9052        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9053 .cindex "expansion" "extracting cerificate fields"
9054 .cindex "&%certextract%&" "certificate fields"
9055 .cindex "certificate" "extracting fields"
9056 The <&'certificate'&> must be a variable of type certificate.
9057 The field name is expanded and used to retrieve the relevant field from
9058 the certificate.  Supported fields are:
9059 .display
9060 &`version        `&
9061 &`serial_number  `&
9062 &`subject        `& RFC4514 DN
9063 &`issuer         `& RFC4514 DN
9064 &`notbefore      `& time
9065 &`notafter       `& time
9066 &`sig_algorithm  `&
9067 &`signature      `&
9068 &`subj_altname   `& tagged list
9069 &`ocsp_uri       `& list
9070 &`crl_uri        `& list
9071 .endd
9072 If the field is found,
9073 <&'string2'&> is expanded, and replaces the whole item;
9074 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9075 variable &$value$& contains the value that has been extracted. Afterwards, it
9076 is restored to any previous value it might have had.
9077
9078 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9079 key is not found. If {<&'string2'&>} is also omitted, the value that was
9080 extracted is used.
9081
9082 Some field names take optional modifiers, appended and separated by commas.
9083
9084 The field selectors marked as "RFC4514" above
9085 output a Distinguished Name string which is
9086 not quite
9087 parseable by Exim as a comma-separated tagged list
9088 (the exceptions being elements containing commas).
9089 RDN elements of a single type may be selected by
9090 a modifier of the type label; if so the expansion
9091 result is a list (newline-separated by default).
9092 The separator may be changed by another modifier of
9093 a right angle-bracket followed immediately by the new separator.
9094 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9095
9096 The field selectors marked as "time" above
9097 take an optional modifier of "int"
9098 for which the result is the number of seconds since epoch.
9099 Otherwise the result is a human-readable string
9100 in the timezone selected by the main "timezone" option.
9101
9102 The field selectors marked as "list" above return a list,
9103 newline-separated by default,
9104 (embedded separator characters in elements are doubled).
9105 The separator may be changed by a modifier of
9106 a right angle-bracket followed immediately by the new separator.
9107
9108 The field selectors marked as "tagged" above
9109 prefix each list element with a type string and an equals sign.
9110 Elements of only one type may be selected by a modifier
9111 which is one of "dns", "uri" or "mail";
9112 if so the element tags are omitted.
9113
9114 If not otherwise noted field values are presented in human-readable form.
9115
9116 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9117        {*&<&'arg'&>&*}...}*&"
9118 .cindex &%dlfunc%&
9119 This expansion dynamically loads and then calls a locally-written C function.
9120 This functionality is available only if Exim is compiled with
9121 .code
9122 EXPAND_DLFUNC=yes
9123 .endd
9124 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9125 object so that it doesn't reload the same object file in the same Exim process
9126 (but of course Exim does start new processes frequently).
9127
9128 There may be from zero to eight arguments to the function. When compiling
9129 a local function that is to be called in this way, &_local_scan.h_& should be
9130 included. The Exim variables and functions that are defined by that API
9131 are also available for dynamically loaded functions. The function itself
9132 must have the following type:
9133 .code
9134 int dlfunction(uschar **yield, int argc, uschar *argv[])
9135 .endd
9136 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9137 function should return one of the following values:
9138
9139 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9140 into the expanded string that is being built.
9141
9142 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9143 from &'yield'&, if it is set.
9144
9145 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9146 taken from &'yield'& if it is set.
9147
9148 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9149
9150 When compiling a function that is to be used in this way with gcc,
9151 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9152 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9153
9154
9155 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9156 .cindex "expansion" "extracting value from environment"
9157 .cindex "environment" "values from"
9158 The key is first expanded separately, and leading and trailing white space
9159 removed.
9160 This is then searched for as a name in the environment.
9161 If a variable is found then its value is placed in &$value$&
9162 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9163
9164 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9165 appear, for example:
9166 .code
9167 ${env{USER}{$value} fail }
9168 .endd
9169 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9170 {<&'string1'&>} must be present for &"fail"& to be recognized.
9171
9172 If {<&'string2'&>} is omitted an empty string is substituted on
9173 search failure.
9174 If {<&'string1'&>} is omitted the search result is substituted on
9175 search success.
9176
9177 The environment is adjusted by the &%keep_environment%& and
9178 &%add_environment%& main section options.
9179
9180
9181 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9182        {*&<&'string3'&>&*}}*&"
9183 .cindex "expansion" "extracting substrings by key"
9184 .cindex "&%extract%&" "substrings by key"
9185 The key and <&'string1'&> are first expanded separately. Leading and trailing
9186 white space is removed from the key (but not from any of the strings). The key
9187 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9188 form:
9189 .display
9190 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9191 .endd
9192 .vindex "&$value$&"
9193 where the equals signs and spaces (but not both) are optional. If any of the
9194 values contain white space, they must be enclosed in double quotes, and any
9195 values that are enclosed in double quotes are subject to escape processing as
9196 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9197 for the value that corresponds to the key. The search is case-insensitive. If
9198 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9199 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9200 variable &$value$& contains the value that has been extracted. Afterwards, it
9201 is restored to any previous value it might have had.
9202
9203 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9204 key is not found. If {<&'string2'&>} is also omitted, the value that was
9205 extracted is used. Thus, for example, these two expansions are identical, and
9206 yield &"2001"&:
9207 .code
9208 ${extract{gid}{uid=1984 gid=2001}}
9209 ${extract{gid}{uid=1984 gid=2001}{$value}}
9210 .endd
9211 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9212 appear, for example:
9213 .code
9214 ${extract{Z}{A=... B=...}{$value} fail }
9215 .endd
9216 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9217 {<&'string2'&>} must be present for &"fail"& to be recognized.
9218
9219
9220 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9221         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9222 .cindex "expansion" "extracting substrings by number"
9223 .cindex "&%extract%&" "substrings by number"
9224 The <&'number'&> argument must consist entirely of decimal digits,
9225 apart from leading and trailing white space, which is ignored.
9226 This is what distinguishes this form of &%extract%& from the previous kind. It
9227 behaves in the same way, except that, instead of extracting a named field, it
9228 extracts from <&'string1'&> the field whose number is given as the first
9229 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9230 <&'string3'&> as before.
9231
9232 The fields in the string are separated by any one of the characters in the
9233 separator string. These may include space or tab characters.
9234 The first field is numbered one. If the number is negative, the fields are
9235 counted from the end of the string, with the rightmost one numbered -1. If the
9236 number given is zero, the entire string is returned. If the modulus of the
9237 number is greater than the number of fields in the string, the result is the
9238 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9239 provided. For example:
9240 .code
9241 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9242 .endd
9243 yields &"42"&, and
9244 .code
9245 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9246 .endd
9247 yields &"99"&. Two successive separators mean that the field between them is
9248 empty (for example, the fifth field above).
9249
9250
9251 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9252 .cindex "list" "selecting by condition"
9253 .cindex "expansion" "selecting from list by condition"
9254 .vindex "&$item$&"
9255 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9256 default, but the separator can be changed in the usual way. For each item
9257 in this list, its value is place in &$item$&, and then the condition is
9258 evaluated. If the condition is true, &$item$& is added to the output as an
9259 item in a new list; if the condition is false, the item is discarded. The
9260 separator used for the output list is the same as the one used for the
9261 input, but a separator setting is not included in the output. For example:
9262 .code
9263 ${filter{a:b:c}{!eq{$item}{b}}
9264 .endd
9265 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9266 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9267
9268
9269 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9270 .cindex "hash function" "textual"
9271 .cindex "expansion" "textual hash"
9272 This is a textual hashing function, and was the first to be implemented in
9273 early versions of Exim. In current releases, there are other hashing functions
9274 (numeric, MD5, and SHA-1), which are described below.
9275
9276 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9277 <&'n'&>. If you are using fixed values for these numbers, that is, if
9278 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9279 use the simpler operator notation that avoids some of the braces:
9280 .code
9281 ${hash_<n>_<m>:<string>}
9282 .endd
9283 The second number is optional (in both notations). If <&'n'&> is greater than
9284 or equal to the length of the string, the expansion item returns the string.
9285 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9286 function to the string. The new string consists of characters taken from the
9287 first <&'m'&> characters of the string
9288 .code
9289 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9290 .endd
9291 If <&'m'&> is not present the value 26 is used, so that only lower case
9292 letters appear. For example:
9293 .display
9294 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9295 &`$hash{5}{monty}}           `&   yields  &`monty`&
9296 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9297 .endd
9298
9299 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9300         &*$h_*&<&'header&~name'&>&*:*&" &&&
9301        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9302         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9303        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9304         &*$rh_*&<&'header&~name'&>&*:*&"
9305 .cindex "expansion" "header insertion"
9306 .vindex "&$header_$&"
9307 .vindex "&$bheader_$&"
9308 .vindex "&$rheader_$&"
9309 .cindex "header lines" "in expansion strings"
9310 .cindex "header lines" "character sets"
9311 .cindex "header lines" "decoding"
9312 Substitute the contents of the named message header line, for example
9313 .code
9314 $header_reply-to:
9315 .endd
9316 The newline that terminates a header line is not included in the expansion, but
9317 internal newlines (caused by splitting the header line over several physical
9318 lines) may be present.
9319
9320 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9321 the data in the header line is interpreted.
9322
9323 .ilist
9324 .cindex "white space" "in header lines"
9325 &%rheader%& gives the original &"raw"& content of the header line, with no
9326 processing at all, and without the removal of leading and trailing white space.
9327
9328 .next
9329 .cindex "base64 encoding" "in header lines"
9330 &%bheader%& removes leading and trailing white space, and then decodes base64
9331 or quoted-printable MIME &"words"& within the header text, but does no
9332 character set translation. If decoding of what looks superficially like a MIME
9333 &"word"& fails, the raw string is returned. If decoding
9334 .cindex "binary zero" "in header line"
9335 produces a binary zero character, it is replaced by a question mark &-- this is
9336 what Exim does for binary zeros that are actually received in header lines.
9337
9338 .next
9339 &%header%& tries to translate the string as decoded by &%bheader%& to a
9340 standard character set. This is an attempt to produce the same string as would
9341 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9342 returned. Translation is attempted only on operating systems that support the
9343 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9344 a system Makefile or in &_Local/Makefile_&.
9345 .endlist ilist
9346
9347 In a filter file, the target character set for &%header%& can be specified by a
9348 command of the following form:
9349 .code
9350 headers charset "UTF-8"
9351 .endd
9352 This command affects all references to &$h_$& (or &$header_$&) expansions in
9353 subsequently obeyed filter commands. In the absence of this command, the target
9354 character set in a filter is taken from the setting of the &%headers_charset%&
9355 option in the runtime configuration. The value of this option defaults to the
9356 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9357 ISO-8859-1.
9358
9359 Header names follow the syntax of RFC 2822, which states that they may contain
9360 any printing characters except space and colon. Consequently, curly brackets
9361 &'do not'& terminate header names, and should not be used to enclose them as
9362 if they were variables. Attempting to do so causes a syntax error.
9363
9364 Only header lines that are common to all copies of a message are visible to
9365 this mechanism. These are the original header lines that are received with the
9366 message, and any that are added by an ACL statement or by a system
9367 filter. Header lines that are added to a particular copy of a message by a
9368 router or transport are not accessible.
9369
9370 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9371 before the DATA ACL, because the header structure is not set up until the
9372 message is received. Header lines that are added in a RCPT ACL (for example)
9373 are saved until the message's incoming header lines are available, at which
9374 point they are added. When a DATA ACL is running, however, header lines added
9375 by earlier ACLs are visible.
9376
9377 Upper case and lower case letters are synonymous in header names. If the
9378 following character is white space, the terminating colon may be omitted, but
9379 this is not recommended, because you may then forget it when it is needed. When
9380 white space terminates the header name, this white space is included in the
9381 expanded string.  If the message does not contain the given header, the
9382 expansion item is replaced by an empty string. (See the &%def%& condition in
9383 section &<<SECTexpcond>>& for a means of testing for the existence of a
9384 header.)
9385
9386 If there is more than one header with the same name, they are all concatenated
9387 to form the substitution string, up to a maximum length of 64K. Unless
9388 &%rheader%& is being used, leading and trailing white space is removed from
9389 each header before concatenation, and a completely empty header is ignored. A
9390 newline character is then inserted between non-empty headers, but there is no
9391 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9392 those headers that contain lists of addresses, a comma is also inserted at the
9393 junctions between headers. This does not happen for the &%rheader%& expansion.
9394
9395
9396 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9397 .cindex "expansion" "hmac hashing"
9398 .cindex &%hmac%&
9399 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9400 shared secret and some text into a message authentication code, as specified in
9401 RFC 2104. This differs from &`${md5:secret_text...}`& or
9402 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9403 cryptographic hash, allowing for authentication that is not possible with MD5
9404 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9405 present. For example:
9406 .code
9407 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9408 .endd
9409 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9410 produces:
9411 .code
9412 dd97e3ba5d1a61b5006108f8c8252953
9413 .endd
9414 As an example of how this might be used, you might put in the main part of
9415 an Exim configuration:
9416 .code
9417 SPAMSCAN_SECRET=cohgheeLei2thahw
9418 .endd
9419 In a router or a transport you could then have:
9420 .code
9421 headers_add = \
9422   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9423   ${hmac{md5}{SPAMSCAN_SECRET}\
9424   {${primary_hostname},${message_exim_id},$h_message-id:}}
9425 .endd
9426 Then given a message, you can check where it was scanned by looking at the
9427 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9428 this header line is authentic by recomputing the authentication code from the
9429 host name, message ID and the &'Message-id:'& header line. This can be done
9430 using Exim's &%-be%& option, or by other means, for example by using the
9431 &'hmac_md5_hex()'& function in Perl.
9432
9433
9434 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9435 .cindex "expansion" "conditional"
9436 .cindex "&%if%&, expansion item"
9437 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9438 item; otherwise <&'string2'&> is used. The available conditions are described
9439 in section &<<SECTexpcond>>& below. For example:
9440 .code
9441 ${if eq {$local_part}{postmaster} {yes}{no} }
9442 .endd
9443 The second string need not be present; if it is not and the condition is not
9444 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9445 be present instead of the second string (without any curly brackets). In this
9446 case, the expansion is forced to fail if the condition is not true (see section
9447 &<<SECTforexpfai>>&).
9448
9449 If both strings are omitted, the result is the string &`true`& if the condition
9450 is true, and the empty string if the condition is false. This makes it less
9451 cumbersome to write custom ACL and router conditions. For example, instead of
9452 .code
9453 condition = ${if >{$acl_m4}{3}{true}{false}}
9454 .endd
9455 you can use
9456 .code
9457 condition = ${if >{$acl_m4}{3}}
9458 .endd
9459
9460
9461
9462 .new
9463 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9464 .cindex expansion "imap folder"
9465 .cindex "&%imapfolder%& expansion item"
9466 This item converts a (possibly multilevel, or with non-ASCII characters)
9467 folder specification to a Maildir name for filesystem use.
9468 For information on internationalisation support see &<<SECTi18nMDA>>&.
9469 .wen
9470
9471
9472
9473 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9474 .cindex "expansion" "string truncation"
9475 .cindex "&%length%& expansion item"
9476 The &%length%& item is used to extract the initial portion of a string. Both
9477 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9478 you are using a fixed value for the number, that is, if <&'string1'&> does not
9479 change when expanded, you can use the simpler operator notation that avoids
9480 some of the braces:
9481 .code
9482 ${length_<n>:<string>}
9483 .endd
9484 The result of this item is either the first <&'n'&> characters or the whole
9485 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9486 &%strlen%&, which gives the length of a string.
9487
9488
9489 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9490         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9491 .cindex "expansion" "extracting list elements by number"
9492 .cindex "&%listextract%&" "extract list elements by number"
9493 .cindex "list" "extracting elements by number"
9494 The <&'number'&> argument must consist entirely of decimal digits,
9495 apart from an optional leading minus,
9496 and leading and trailing white space (which is ignored).
9497
9498 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9499 default, but the separator can be changed in the usual way.
9500
9501 The first field of the list is numbered one.
9502 If the number is negative, the fields are
9503 counted from the end of the list, with the rightmost one numbered -1.
9504 The numbered element of the list is extracted and placed in &$value$&,
9505 then <&'string2'&> is expanded as the result.
9506
9507 If the modulus of the
9508 number is zero or greater than the number of fields in the string,
9509 the result is the expansion of <&'string3'&>.
9510
9511 For example:
9512 .code
9513 ${listextract{2}{x:42:99}}
9514 .endd
9515 yields &"42"&, and
9516 .code
9517 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9518 .endd
9519 yields &"result: 42"&.
9520
9521 If {<&'string3'&>} is omitted, an empty string is used for string3.
9522 If {<&'string2'&>} is also omitted, the value that was
9523 extracted is used.
9524 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9525
9526
9527 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9528         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9529 This is the first of one of two different types of lookup item, which are both
9530 described in the next item.
9531
9532 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9533         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9534 .cindex "expansion" "lookup in"
9535 .cindex "file" "lookups"
9536 .cindex "lookup" "in expanded string"
9537 The two forms of lookup item specify data lookups in files and databases, as
9538 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9539 lookups, and the second is used for query-style lookups. The <&'key'&>,
9540 <&'file'&>, and <&'query'&> strings are expanded before use.
9541
9542 If there is any white space in a lookup item which is part of a filter command,
9543 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9544 other place where white space is significant, the lookup item must be enclosed
9545 in double quotes. The use of data lookups in users' filter files may be locked
9546 out by the system administrator.
9547
9548 .vindex "&$value$&"
9549 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9550 During its expansion, the variable &$value$& contains the data returned by the
9551 lookup. Afterwards it reverts to the value it had previously (at the outer
9552 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9553 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9554 string on failure. If <&'string2'&> is provided, it can itself be a nested
9555 lookup, thus providing a mechanism for looking up a default value when the
9556 original lookup fails.
9557
9558 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9559 data for the outer lookup while the parameters of the second lookup are
9560 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9561 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9562 appear, and in this case, if the lookup fails, the entire expansion is forced
9563 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9564 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9565 successful lookup, and nothing in the case of failure.
9566
9567 For single-key lookups, the string &"partial"& is permitted to precede the
9568 search type in order to do partial matching, and * or *@ may follow a search
9569 type to request default lookups if the key does not match (see sections
9570 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9571
9572 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9573 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9574 and non-wild parts of the key during the expansion of the replacement text.
9575 They return to their previous values at the end of the lookup item.
9576
9577 This example looks up the postmaster alias in the conventional alias file:
9578 .code
9579 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9580 .endd
9581 This example uses NIS+ to look up the full name of the user corresponding to
9582 the local part of an address, forcing the expansion to fail if it is not found:
9583 .code
9584 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9585   {$value}fail}
9586 .endd
9587
9588
9589 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9590 .cindex "expansion" "list creation"
9591 .vindex "&$item$&"
9592 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9593 default, but the separator can be changed in the usual way. For each item
9594 in this list, its value is place in &$item$&, and then <&'string2'&> is
9595 expanded and added to the output as an item in a new list. The separator used
9596 for the output list is the same as the one used for the input, but a separator
9597 setting is not included in the output. For example:
9598 .code
9599 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9600 .endd
9601 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9602 value of &$item$& is restored to what it was before. See also the &*filter*&
9603 and &*reduce*& expansion items.
9604
9605 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9606 .cindex "expansion" "numeric hash"
9607 .cindex "hash function" "numeric"
9608 The three strings are expanded; the first two must yield numbers. Call them
9609 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9610 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9611 can use the simpler operator notation that avoids some of the braces:
9612 .code
9613 ${nhash_<n>_<m>:<string>}
9614 .endd
9615 The second number is optional (in both notations). If there is only one number,
9616 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9617 processed by a div/mod hash function that returns two numbers, separated by a
9618 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9619 example,
9620 .code
9621 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9622 .endd
9623 returns the string &"6/33"&.
9624
9625
9626
9627 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9628 .cindex "Perl" "use in expanded string"
9629 .cindex "expansion" "calling Perl from"
9630 This item is available only if Exim has been built to include an embedded Perl
9631 interpreter. The subroutine name and the arguments are first separately
9632 expanded, and then the Perl subroutine is called with those arguments. No
9633 additional arguments need be given; the maximum number permitted, including the
9634 name of the subroutine, is nine.
9635
9636 The return value of the subroutine is inserted into the expanded string, unless
9637 the return value is &%undef%&. In that case, the expansion fails in the same
9638 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9639 Whatever you return is evaluated in a scalar context. For example, if you
9640 return the name of a Perl vector, the return value is the size of the vector,
9641 not its contents.
9642
9643 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9644 with the error message that was passed to &%die%&. More details of the embedded
9645 Perl facility are given in chapter &<<CHAPperl>>&.
9646
9647 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9648 out the use of this expansion item in filter files.
9649
9650
9651 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9652 .cindex "&%prvs%& expansion item"
9653 The first argument is a complete email address and the second is secret
9654 keystring. The third argument, specifying a key number, is optional. If absent,
9655 it defaults to 0. The result of the expansion is a prvs-signed email address,
9656 to be typically used with the &%return_path%& option on an &(smtp)& transport
9657 as part of a bounce address tag validation (BATV) scheme. For more discussion
9658 and an example, see section &<<SECTverifyPRVS>>&.
9659
9660 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9661         {*&<&'string'&>&*}}*&"
9662 .cindex "&%prvscheck%& expansion item"
9663 This expansion item is the complement of the &%prvs%& item. It is used for
9664 checking prvs-signed addresses. If the expansion of the first argument does not
9665 yield a syntactically valid prvs-signed address, the whole item expands to the
9666 empty string. When the first argument does expand to a syntactically valid
9667 prvs-signed address, the second argument is expanded, with the prvs-decoded
9668 version of the address and the key number extracted from the address in the
9669 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9670
9671 These two variables can be used in the expansion of the second argument to
9672 retrieve the secret. The validity of the prvs-signed address is then checked
9673 against the secret. The result is stored in the variable &$prvscheck_result$&,
9674 which is empty for failure or &"1"& for success.
9675
9676 The third argument is optional; if it is missing, it defaults to an empty
9677 string. This argument is now expanded. If the result is an empty string, the
9678 result of the expansion is the decoded version of the address. This is the case
9679 whether or not the signature was valid. Otherwise, the result of the expansion
9680 is the expansion of the third argument.
9681
9682 All three variables can be used in the expansion of the third argument.
9683 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9684 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9685
9686 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9687 .cindex "expansion" "inserting an entire file"
9688 .cindex "file" "inserting into expansion"
9689 .cindex "&%readfile%& expansion item"
9690 The file name and end-of-line string are first expanded separately. The file is
9691 then read, and its contents replace the entire item. All newline characters in
9692 the file are replaced by the end-of-line string if it is present. Otherwise,
9693 newlines are left in the string.
9694 String expansion is not applied to the contents of the file. If you want this,
9695 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9696 the string expansion fails.
9697
9698 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9699 locks out the use of this expansion item in filter files.
9700
9701
9702
9703 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9704         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9705 .cindex "expansion" "inserting from a socket"
9706 .cindex "socket, use of in expansion"
9707 .cindex "&%readsocket%& expansion item"
9708 This item inserts data from a Unix domain or TCP socket into the expanded
9709 string. The minimal way of using it uses just two arguments, as in these
9710 examples:
9711 .code
9712 ${readsocket{/socket/name}{request string}}
9713 ${readsocket{inet:some.host:1234}{request string}}
9714 .endd
9715 For a Unix domain socket, the first substring must be the path to the socket.
9716 For an Internet socket, the first substring must contain &`inet:`& followed by
9717 a host name or IP address, followed by a colon and a port, which can be a
9718 number or the name of a TCP port in &_/etc/services_&. An IP address may
9719 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9720 example:
9721 .code
9722 ${readsocket{inet:[::1]:1234}{request string}}
9723 .endd
9724 Only a single host name may be given, but if looking it up yields more than
9725 one IP address, they are each tried in turn until a connection is made. For
9726 both kinds of socket, Exim makes a connection, writes the request string
9727 unless it is an empty string; and no terminating NUL is ever sent)
9728 and reads from the socket until an end-of-file
9729 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9730 extend what can be done. Firstly, you can vary the timeout. For example:
9731 .code
9732 ${readsocket{/socket/name}{request string}{3s}}
9733 .endd
9734 A fourth argument allows you to change any newlines that are in the data
9735 that is read, in the same way as for &%readfile%& (see above). This example
9736 turns them into spaces:
9737 .code
9738 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9739 .endd
9740 As with all expansions, the substrings are expanded before the processing
9741 happens. Errors in these sub-expansions cause the expansion to fail. In
9742 addition, the following errors can occur:
9743
9744 .ilist
9745 Failure to create a socket file descriptor;
9746 .next
9747 Failure to connect the socket;
9748 .next
9749 Failure to write the request string;
9750 .next
9751 Timeout on reading from the socket.
9752 .endlist
9753
9754 By default, any of these errors causes the expansion to fail. However, if
9755 you supply a fifth substring, it is expanded and used when any of the above
9756 errors occurs. For example:
9757 .code
9758 ${readsocket{/socket/name}{request string}{3s}{\n}\
9759   {socket failure}}
9760 .endd
9761 You can test for the existence of a Unix domain socket by wrapping this
9762 expansion in &`${if exists`&, but there is a race condition between that test
9763 and the actual opening of the socket, so it is safer to use the fifth argument
9764 if you want to be absolutely sure of avoiding an expansion error for a
9765 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9766
9767 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9768 locks out the use of this expansion item in filter files.
9769
9770
9771 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9772 .cindex "expansion" "reducing a list to a scalar"
9773 .cindex "list" "reducing to a scalar"
9774 .vindex "&$value$&"
9775 .vindex "&$item$&"
9776 This operation reduces a list to a single, scalar string. After expansion,
9777 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9778 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9779 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9780 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9781 them. The result of that expansion is assigned to &$value$& before the next
9782 iteration. When the end of the list is reached, the final value of &$value$& is
9783 added to the expansion output. The &*reduce*& expansion item can be used in a
9784 number of ways. For example, to add up a list of numbers:
9785 .code
9786 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9787 .endd
9788 The result of that expansion would be &`6`&. The maximum of a list of numbers
9789 can be found:
9790 .code
9791 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9792 .endd
9793 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9794 restored to what they were before. See also the &*filter*& and &*map*&
9795 expansion items.
9796
9797 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9798 This item inserts &"raw"& header lines. It is described with the &%header%&
9799 expansion item above.
9800
9801 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9802         {*&<&'string2'&>&*}}*&"
9803 .cindex "expansion" "running a command"
9804 .cindex "&%run%& expansion item"
9805 The command and its arguments are first expanded as one string. The string is
9806 split apart into individual arguments by spaces, and then the command is run
9807 in a separate process, but under the same uid and gid.  As in other command
9808 executions from Exim, a shell is not used by default. If the command requires
9809 a shell, you must explicitly code it.
9810
9811 Since the arguments are split by spaces, when there is a variable expansion
9812 which has an empty result, it will cause the situation that the argument will
9813 simply be omitted when the program is actually executed by Exim. If the
9814 script/program requires a specific number of arguments and the expanded
9815 variable could possibly result in this empty expansion, the variable must be
9816 quoted. This is more difficult if the expanded variable itself could result
9817 in a string containing quotes, because it would interfere with the quotes
9818 around the command arguments. A possible guard against this is to wrap the
9819 variable in the &%sg%& operator to change any quote marks to some other
9820 character.
9821
9822 The standard input for the command exists, but is empty. The standard output
9823 and standard error are set to the same file descriptor.
9824 .cindex "return code" "from &%run%& expansion"
9825 .vindex "&$value$&"
9826 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9827 and replaces the entire item; during this expansion, the standard output/error
9828 from the command is in the variable &$value$&. If the command fails,
9829 <&'string2'&>, if present, is expanded and used. Once again, during the
9830 expansion, the standard output/error from the command is in the variable
9831 &$value$&.
9832
9833 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9834 can be the word &"fail"& (not in braces) to force expansion failure if the
9835 command does not succeed. If both strings are omitted, the result is contents
9836 of the standard output/error on success, and nothing on failure.
9837
9838 .vindex "&$run_in_acl$&"
9839 The standard output/error of the command is put in the variable &$value$&.
9840 In this ACL example, the output of a command is logged for the admin to
9841 troubleshoot:
9842 .code
9843 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9844       log_message  = Output of id: $value
9845 .endd
9846 If the command requires shell idioms, such as the > redirect operator, the
9847 shell must be invoked directly, such as with:
9848 .code
9849 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9850 .endd
9851
9852 .vindex "&$runrc$&"
9853 The return code from the command is put in the variable &$runrc$&, and this
9854 remains set afterwards, so in a filter file you can do things like this:
9855 .code
9856 if "${run{x y z}{}}$runrc" is 1 then ...
9857   elif $runrc is 2 then ...
9858   ...
9859 endif
9860 .endd
9861 If execution of the command fails (for example, the command does not exist),
9862 the return code is 127 &-- the same code that shells use for non-existent
9863 commands.
9864
9865 &*Warning*&: In a router or transport, you cannot assume the order in which
9866 option values are expanded, except for those preconditions whose order of
9867 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9868 by the expansion of one option, and use it in another.
9869
9870 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9871 out the use of this expansion item in filter files.
9872
9873
9874 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9875 .cindex "expansion" "string substitution"
9876 .cindex "&%sg%& expansion item"
9877 This item works like Perl's substitution operator (s) with the global (/g)
9878 option; hence its name. However, unlike the Perl equivalent, Exim does not
9879 modify the subject string; instead it returns the modified string for insertion
9880 into the overall expansion. The item takes three arguments: the subject string,
9881 a regular expression, and a substitution string. For example:
9882 .code
9883 ${sg{abcdefabcdef}{abc}{xyz}}
9884 .endd
9885 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9886 if any $ or \ characters are required in the regular expression or in the
9887 substitution string, they have to be escaped. For example:
9888 .code
9889 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9890 .endd
9891 yields &"defabc"&, and
9892 .code
9893 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9894 .endd
9895 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9896 the regular expression from string expansion.
9897
9898
9899
9900 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9901 .cindex sorting "a list"
9902 .cindex list sorting
9903 .cindex expansion "list sorting"
9904 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9905 default, but the separator can be changed in the usual way.
9906 The <&'comparator'&> argument is interpreted as the operator
9907 of a two-argument expansion condition.
9908 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9909 The comparison should return true when applied to two values
9910 if the first value should sort before the second value.
9911 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9912 the element being placed in &$item$&,
9913 to give values for comparison.
9914
9915 The item result is a sorted list,
9916 with the original list separator,
9917 of the list elements (in full) of the original.
9918
9919 Examples:
9920 .code
9921 ${sort{3:2:1:4}{<}{$item}}
9922 .endd
9923 sorts a list of numbers, and
9924 .code
9925 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9926 .endd
9927 will sort an MX lookup into priority order.
9928
9929
9930 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9931 .cindex "&%substr%& expansion item"
9932 .cindex "substring extraction"
9933 .cindex "expansion" "substring extraction"
9934 The three strings are expanded; the first two must yield numbers. Call them
9935 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9936 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9937 can use the simpler operator notation that avoids some of the braces:
9938 .code
9939 ${substr_<n>_<m>:<string>}
9940 .endd
9941 The second number is optional (in both notations).
9942 If it is absent in the simpler format, the preceding underscore must also be
9943 omitted.
9944
9945 The &%substr%& item can be used to extract more general substrings than
9946 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9947 length required. For example
9948 .code
9949 ${substr{3}{2}{$local_part}}
9950 .endd
9951 If the starting offset is greater than the string length the result is the
9952 null string; if the length plus starting offset is greater than the string
9953 length, the result is the right-hand part of the string, starting from the
9954 given offset. The first character in the string has offset zero.
9955
9956 The &%substr%& expansion item can take negative offset values to count
9957 from the right-hand end of its operand. The last character is offset -1, the
9958 second-last is offset -2, and so on. Thus, for example,
9959 .code
9960 ${substr{-5}{2}{1234567}}
9961 .endd
9962 yields &"34"&. If the absolute value of a negative offset is greater than the
9963 length of the string, the substring starts at the beginning of the string, and
9964 the length is reduced by the amount of overshoot. Thus, for example,
9965 .code
9966 ${substr{-5}{2}{12}}
9967 .endd
9968 yields an empty string, but
9969 .code
9970 ${substr{-3}{2}{12}}
9971 .endd
9972 yields &"1"&.
9973
9974 When the second number is omitted from &%substr%&, the remainder of the string
9975 is taken if the offset is positive. If it is negative, all characters in the
9976 string preceding the offset point are taken. For example, an offset of -1 and
9977 no length, as in these semantically identical examples:
9978 .code
9979 ${substr_-1:abcde}
9980 ${substr{-1}{abcde}}
9981 .endd
9982 yields all but the last character of the string, that is, &"abcd"&.
9983
9984
9985
9986 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9987         {*&<&'replacements'&>&*}}*&"
9988 .cindex "expansion" "character translation"
9989 .cindex "&%tr%& expansion item"
9990 This item does single-character translation on its subject string. The second
9991 argument is a list of characters to be translated in the subject string. Each
9992 matching character is replaced by the corresponding character from the
9993 replacement list. For example
9994 .code
9995 ${tr{abcdea}{ac}{13}}
9996 .endd
9997 yields &`1b3de1`&. If there are duplicates in the second character string, the
9998 last occurrence is used. If the third string is shorter than the second, its
9999 last character is replicated. However, if it is empty, no translation takes
10000 place.
10001 .endlist
10002
10003
10004
10005 .section "Expansion operators" "SECTexpop"
10006 .cindex "expansion" "operators"
10007 For expansion items that perform transformations on a single argument string,
10008 the &"operator"& notation is used because it is simpler and uses fewer braces.
10009 The substring is first expanded before the operation is applied to it. The
10010 following operations can be performed:
10011
10012 .vlist
10013 .vitem &*${address:*&<&'string'&>&*}*&
10014 .cindex "expansion" "RFC 2822 address handling"
10015 .cindex "&%address%& expansion item"
10016 The string is interpreted as an RFC 2822 address, as it might appear in a
10017 header line, and the effective address is extracted from it. If the string does
10018 not parse successfully, the result is empty.
10019
10020
10021 .vitem &*${addresses:*&<&'string'&>&*}*&
10022 .cindex "expansion" "RFC 2822 address handling"
10023 .cindex "&%addresses%& expansion item"
10024 The string (after expansion) is interpreted as a list of addresses in RFC
10025 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10026 operative address (&'local-part@domain'&) is extracted from each item, and the
10027 result of the expansion is a colon-separated list, with appropriate
10028 doubling of colons should any happen to be present in the email addresses.
10029 Syntactically invalid RFC2822 address items are omitted from the output.
10030
10031 It is possible to specify a character other than colon for the output
10032 separator by starting the string with > followed by the new separator
10033 character. For example:
10034 .code
10035 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10036 .endd
10037 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10038 expansion item, which extracts the working address from a single RFC2822
10039 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10040 processing lists.
10041
10042 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10043 a strict interpretation of header line formatting.  Exim parses the bare,
10044 unquoted portion of an email address and if it finds a comma, treats it as an
10045 email address separator. For the example header line:
10046 .code
10047 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10048 .endd
10049 The first example below demonstrates that Q-encoded email addresses are parsed
10050 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10051 It does not see the comma because it's still encoded as "=2C".  The second
10052 example below is passed the contents of &`$header_from:`&, meaning it gets
10053 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10054 The third example shows that the presence of a comma is skipped when it is
10055 quoted.
10056 .code
10057 # exim -be '${addresses:From: \
10058 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10059 user@example.com
10060 # exim -be '${addresses:From: Last, First <user@example.com>}'
10061 Last:user@example.com
10062 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10063 user@example.com
10064 .endd
10065
10066 .vitem &*${base62:*&<&'digits'&>&*}*&
10067 .cindex "&%base62%& expansion item"
10068 .cindex "expansion" "conversion to base 62"
10069 The string must consist entirely of decimal digits. The number is converted to
10070 base 62 and output as a string of six characters, including leading zeros. In
10071 the few operating environments where Exim uses base 36 instead of base 62 for
10072 its message identifiers (because those systems do not have case-sensitive file
10073 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10074 be absolutely clear: this is &'not'& base64 encoding.
10075
10076 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10077 .cindex "&%base62d%& expansion item"
10078 .cindex "expansion" "conversion to base 62"
10079 The string must consist entirely of base-62 digits, or, in operating
10080 environments where Exim uses base 36 instead of base 62 for its message
10081 identifiers, base-36 digits. The number is converted to decimal and output as a
10082 string.
10083
10084 .new
10085 .vitem &*${base64:*&<&'string'&>&*}*&
10086 .cindex "expansion" "base64 encoding"
10087 .cindex "base64 encoding" "in string expansion"
10088 .cindex "&%base64%& expansion item"
10089 .cindex certificate "base64 of DER"
10090 This operator converts a string into one that is base64 encoded.
10091
10092 If the string is a single variable of type certificate,
10093 returns the base64 encoding of the DER form of the certificate.
10094
10095
10096 .vitem &*${base64d:*&<&'string'&>&*}*&
10097 .cindex "expansion" "base64 decoding"
10098 .cindex "base64 decoding" "in string expansion"
10099 .cindex "&%base64d%& expansion item"
10100 This operator converts a base64-encoded string into the un-coded form.
10101 .wen
10102
10103
10104 .vitem &*${domain:*&<&'string'&>&*}*&
10105 .cindex "domain" "extraction"
10106 .cindex "expansion" "domain extraction"
10107 The string is interpreted as an RFC 2822 address and the domain is extracted
10108 from it. If the string does not parse successfully, the result is empty.
10109
10110
10111 .vitem &*${escape:*&<&'string'&>&*}*&
10112 .cindex "expansion" "escaping non-printing characters"
10113 .cindex "&%escape%& expansion item"
10114 If the string contains any non-printing characters, they are converted to
10115 escape sequences starting with a backslash. Whether characters with the most
10116 significant bit set (so-called &"8-bit characters"&) count as printing or not
10117 is controlled by the &%print_topbitchars%& option.
10118
10119
10120 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10121 .cindex "expansion" "expression evaluation"
10122 .cindex "expansion" "arithmetic expression"
10123 .cindex "&%eval%& expansion item"
10124 These items supports simple arithmetic and bitwise logical operations in
10125 expansion strings. The string (after expansion) must be a conventional
10126 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10127 logical operators, and parentheses. All operations are carried out using
10128 integer arithmetic. The operator priorities are as follows (the same as in the
10129 C programming language):
10130 .table2 70pt 300pt
10131 .irow &'highest:'& "not (~), negate (-)"
10132 .irow ""   "multiply (*), divide (/), remainder (%)"
10133 .irow ""   "plus (+), minus (-)"
10134 .irow ""   "shift-left (<<), shift-right (>>)"
10135 .irow ""   "and (&&)"
10136 .irow ""   "xor (^)"
10137 .irow &'lowest:'&  "or (|)"
10138 .endtable
10139 Binary operators with the same priority are evaluated from left to right. White
10140 space is permitted before or after operators.
10141
10142 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10143 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10144 decimal, even if they start with a leading zero; hexadecimal numbers are not
10145 permitted. This can be useful when processing numbers extracted from dates or
10146 times, which often do have leading zeros.
10147
10148 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10149 or 1024*1024*1024,
10150 respectively. Negative numbers are supported. The result of the computation is
10151 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10152
10153 .display
10154 &`${eval:1+1}            `&  yields 2
10155 &`${eval:1+2*3}          `&  yields 7
10156 &`${eval:(1+2)*3}        `&  yields 9
10157 &`${eval:2+42%5}         `&  yields 4
10158 &`${eval:0xc&amp;5}          `&  yields 4
10159 &`${eval:0xc|5}          `&  yields 13
10160 &`${eval:0xc^5}          `&  yields 9
10161 &`${eval:0xc>>1}         `&  yields 6
10162 &`${eval:0xc<<1}         `&  yields 24
10163 &`${eval:~255&amp;0x1234}    `&  yields 4608
10164 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10165 .endd
10166
10167 As a more realistic example, in an ACL you might have
10168 .code
10169 deny   message = Too many bad recipients
10170        condition =                    \
10171          ${if and {                   \
10172            {>{$rcpt_count}{10}}       \
10173            {                          \
10174            <                          \
10175              {$recipients_count}      \
10176              {${eval:$rcpt_count/2}}  \
10177            }                          \
10178          }{yes}{no}}
10179 .endd
10180 The condition is true if there have been more than 10 RCPT commands and
10181 fewer than half of them have resulted in a valid recipient.
10182
10183
10184 .vitem &*${expand:*&<&'string'&>&*}*&
10185 .cindex "expansion" "re-expansion of substring"
10186 The &%expand%& operator causes a string to be expanded for a second time. For
10187 example,
10188 .code
10189 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10190 .endd
10191 first looks up a string in a file while expanding the operand for &%expand%&,
10192 and then re-expands what it has found.
10193
10194
10195 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10196 .cindex "Unicode"
10197 .cindex "UTF-8" "conversion from"
10198 .cindex "expansion" "UTF-8 conversion"
10199 .cindex "&%from_utf8%& expansion item"
10200 The world is slowly moving towards Unicode, although there are no standards for
10201 email yet. However, other applications (including some databases) are starting
10202 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10203 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10204 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10205 the result is an undefined sequence of bytes.
10206
10207 Unicode code points with values less than 256 are compatible with ASCII and
10208 ISO-8859-1 (also known as Latin-1).
10209 For example, character 169 is the copyright symbol in both cases, though the
10210 way it is encoded is different. In UTF-8, more than one byte is needed for
10211 characters with code values greater than 127, whereas ISO-8859-1 is a
10212 single-byte encoding (but thereby limited to 256 characters). This makes
10213 translation from UTF-8 to ISO-8859-1 straightforward.
10214
10215
10216 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10217 .cindex "hash function" "textual"
10218 .cindex "expansion" "textual hash"
10219 The &%hash%& operator is a simpler interface to the hashing function that can
10220 be used when the two parameters are fixed numbers (as opposed to strings that
10221 change when expanded). The effect is the same as
10222 .code
10223 ${hash{<n>}{<m>}{<string>}}
10224 .endd
10225 See the description of the general &%hash%& item above for details. The
10226 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10227
10228
10229
10230 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10231 .cindex "base64 encoding" "conversion from hex"
10232 .cindex "expansion" "hex to base64"
10233 .cindex "&%hex2b64%& expansion item"
10234 This operator converts a hex string into one that is base64 encoded. This can
10235 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10236
10237
10238
10239 .vitem &*${hexquote:*&<&'string'&>&*}*&
10240 .cindex "quoting" "hex-encoded unprintable characters"
10241 .cindex "&%hexquote%& expansion item"
10242 This operator converts non-printable characters in a string into a hex
10243 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10244 as is, and other byte values are converted to &`\xNN`&, for example a
10245 byte value 127 is converted to &`\x7f`&.
10246
10247
10248 .new
10249 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10250 .cindex "&%ipv6denorm%& expansion item"
10251 .cindex "IP address" normalisation
10252 This expands an IPv6 address to a full eight-element colon-separated set
10253 of hex digits including leading zeroes.
10254 A trailing ipv4-style dotted-decimal set is converted to hex.
10255 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10256
10257 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10258 .cindex "&%ipv6norm%& expansion item"
10259 .cindex "IP address" normalisation
10260 .cindex "IP address" "canonical form"
10261 This converts an IPv6 address to canonical form.
10262 Leading zeroes of groups are omitted, and the longest
10263 set of zero-valued groups is replaced with a double colon.
10264 A trailing ipv4-style dotted-decimal set is converted to hex.
10265 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10266 .wen
10267
10268
10269 .vitem &*${lc:*&<&'string'&>&*}*&
10270 .cindex "case forcing in strings"
10271 .cindex "string" "case forcing"
10272 .cindex "lower casing"
10273 .cindex "expansion" "case forcing"
10274 .cindex "&%lc%& expansion item"
10275 This forces the letters in the string into lower-case, for example:
10276 .code
10277 ${lc:$local_part}
10278 .endd
10279
10280 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10281 .cindex "expansion" "string truncation"
10282 .cindex "&%length%& expansion item"
10283 The &%length%& operator is a simpler interface to the &%length%& function that
10284 can be used when the parameter is a fixed number (as opposed to a string that
10285 changes when expanded). The effect is the same as
10286 .code
10287 ${length{<number>}{<string>}}
10288 .endd
10289 See the description of the general &%length%& item above for details. Note that
10290 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10291 when &%length%& is used as an operator.
10292
10293
10294 .vitem &*${listcount:*&<&'string'&>&*}*&
10295 .cindex "expansion" "list item count"
10296 .cindex "list" "item count"
10297 .cindex "list" "count of items"
10298 .cindex "&%listcount%& expansion item"
10299 The string is interpreted as a list and the number of items is returned.
10300
10301
10302 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10303 .cindex "expansion" "named list"
10304 .cindex "&%listnamed%& expansion item"
10305 The name is interpreted as a named list and the content of the list is returned,
10306 expanding any referenced lists, re-quoting as needed for colon-separation.
10307 If the optional type is given it must be one of "a", "d", "h" or "l"
10308 and selects address-, domain-, host- or localpart- lists to search among respectively.
10309 Otherwise all types are searched in an undefined order and the first
10310 matching list is returned.
10311
10312
10313 .vitem &*${local_part:*&<&'string'&>&*}*&
10314 .cindex "expansion" "local part extraction"
10315 .cindex "&%local_part%& expansion item"
10316 The string is interpreted as an RFC 2822 address and the local part is
10317 extracted from it. If the string does not parse successfully, the result is
10318 empty.
10319
10320
10321 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10322 .cindex "masked IP address"
10323 .cindex "IP address" "masking"
10324 .cindex "CIDR notation"
10325 .cindex "expansion" "IP address masking"
10326 .cindex "&%mask%& expansion item"
10327 If the form of the string to be operated on is not an IP address followed by a
10328 slash and an integer (that is, a network address in CIDR notation), the
10329 expansion fails. Otherwise, this operator converts the IP address to binary,
10330 masks off the least significant bits according to the bit count, and converts
10331 the result back to text, with mask appended. For example,
10332 .code
10333 ${mask:10.111.131.206/28}
10334 .endd
10335 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10336 be mostly used for looking up masked addresses in files, the result for an IPv6
10337 address uses dots to separate components instead of colons, because colon
10338 terminates a key string in lsearch files. So, for example,
10339 .code
10340 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10341 .endd
10342 returns the string
10343 .code
10344 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10345 .endd
10346 Letters in IPv6 addresses are always output in lower case.
10347
10348
10349 .vitem &*${md5:*&<&'string'&>&*}*&
10350 .cindex "MD5 hash"
10351 .cindex "expansion" "MD5 hash"
10352 .cindex certificate fingerprint
10353 .cindex "&%md5%& expansion item"
10354 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10355 as a 32-digit hexadecimal number, in which any letters are in lower case.
10356
10357 If the string is a single variable of type certificate,
10358 returns the MD5 hash fingerprint of the certificate.
10359
10360
10361 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10362 .cindex "expansion" "numeric hash"
10363 .cindex "hash function" "numeric"
10364 The &%nhash%& operator is a simpler interface to the numeric hashing function
10365 that can be used when the two parameters are fixed numbers (as opposed to
10366 strings that change when expanded). The effect is the same as
10367 .code
10368 ${nhash{<n>}{<m>}{<string>}}
10369 .endd
10370 See the description of the general &%nhash%& item above for details.
10371
10372
10373 .vitem &*${quote:*&<&'string'&>&*}*&
10374 .cindex "quoting" "in string expansions"
10375 .cindex "expansion" "quoting"
10376 .cindex "&%quote%& expansion item"
10377 The &%quote%& operator puts its argument into double quotes if it
10378 is an empty string or
10379 contains anything other than letters, digits, underscores, dots, and hyphens.
10380 Any occurrences of double quotes and backslashes are escaped with a backslash.
10381 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10382 respectively For example,
10383 .code
10384 ${quote:ab"*"cd}
10385 .endd
10386 becomes
10387 .code
10388 "ab\"*\"cd"
10389 .endd
10390 The place where this is useful is when the argument is a substitution from a
10391 variable or a message header.
10392
10393 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10394 .cindex "&%quote_local_part%& expansion item"
10395 This operator is like &%quote%&, except that it quotes the string only if
10396 required to do so by the rules of RFC 2822 for quoting local parts. For
10397 example, a plus sign would not cause quoting (but it would for &%quote%&).
10398 If you are creating a new email address from the contents of &$local_part$&
10399 (or any other unknown data), you should always use this operator.
10400
10401
10402 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10403 .cindex "quoting" "lookup-specific"
10404 This operator applies lookup-specific quoting rules to the string. Each
10405 query-style lookup type has its own quoting rules which are described with
10406 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10407 .code
10408 ${quote_ldap:two * two}
10409 .endd
10410 returns
10411 .code
10412 two%20%5C2A%20two
10413 .endd
10414 For single-key lookup types, no quoting is ever necessary and this operator
10415 yields an unchanged string.
10416
10417
10418 .vitem &*${randint:*&<&'n'&>&*}*&
10419 .cindex "random number"
10420 This operator returns a somewhat random number which is less than the
10421 supplied number and is at least 0.  The quality of this randomness depends
10422 on how Exim was built; the values are not suitable for keying material.
10423 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10424 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10425 for versions of GnuTLS with that function.
10426 Otherwise, the implementation may be arc4random(), random() seeded by
10427 srandomdev() or srandom(), or a custom implementation even weaker than
10428 random().
10429
10430
10431 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10432 .cindex "expansion" "IP address"
10433 This operator reverses an IP address; for IPv4 addresses, the result is in
10434 dotted-quad decimal form, while for IPv6 addresses the result is in
10435 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10436 for DNS.  For example,
10437 .code
10438 ${reverse_ip:192.0.2.4}
10439 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10440 .endd
10441 returns
10442 .code
10443 4.2.0.192
10444 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
10445 .endd
10446
10447
10448 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10449 .cindex "expansion" "RFC 2047"
10450 .cindex "RFC 2047" "expansion operator"
10451 .cindex "&%rfc2047%& expansion item"
10452 This operator encodes text according to the rules of RFC 2047. This is an
10453 encoding that is used in header lines to encode non-ASCII characters. It is
10454 assumed that the input string is in the encoding specified by the
10455 &%headers_charset%& option, which gets its default at build time. If the string
10456 contains only characters in the range 33&--126, and no instances of the
10457 characters
10458 .code
10459 ? = ( ) < > @ , ; : \ " . [ ] _
10460 .endd
10461 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10462 string, using as many &"encoded words"& as necessary to encode all the
10463 characters.
10464
10465
10466 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10467 .cindex "expansion" "RFC 2047"
10468 .cindex "RFC 2047" "decoding"
10469 .cindex "&%rfc2047d%& expansion item"
10470 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10471 bytes are replaced by question marks. Characters are converted into the
10472 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10473 not recognized unless &%check_rfc2047_length%& is set false.
10474
10475 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10476 access a header line, RFC 2047 decoding is done automatically. You do not need
10477 to use this operator as well.
10478
10479
10480
10481 .vitem &*${rxquote:*&<&'string'&>&*}*&
10482 .cindex "quoting" "in regular expressions"
10483 .cindex "regular expressions" "quoting"
10484 .cindex "&%rxquote%& expansion item"
10485 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10486 characters in its argument. This is useful when substituting the values of
10487 variables or headers inside regular expressions.
10488
10489
10490 .vitem &*${sha1:*&<&'string'&>&*}*&
10491 .cindex "SHA-1 hash"
10492 .cindex "expansion" "SHA-1 hashing"
10493 .cindex certificate fingerprint
10494 .cindex "&%sha2%& expansion item"
10495 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10496 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10497
10498 If the string is a single variable of type certificate,
10499 returns the SHA-1 hash fingerprint of the certificate.
10500
10501
10502 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10503 .cindex "SHA-256 hash"
10504 .cindex certificate fingerprint
10505 .cindex "expansion" "SHA-256 hashing"
10506 .cindex "&%sha256%& expansion item"
10507 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10508 certificate,
10509 and returns
10510 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10511 Only arguments which are a single variable of certificate type are supported.
10512
10513
10514 .vitem &*${stat:*&<&'string'&>&*}*&
10515 .cindex "expansion" "statting a file"
10516 .cindex "file" "extracting characteristics"
10517 .cindex "&%stat%& expansion item"
10518 The string, after expansion, must be a file path. A call to the &[stat()]&
10519 function is made for this path. If &[stat()]& fails, an error occurs and the
10520 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10521 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10522 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10523 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10524 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10525 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10526 can extract individual fields using the &%extract%& expansion item.
10527
10528 The use of the &%stat%& expansion in users' filter files can be locked out by
10529 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10530 systems for files larger than 2GB.
10531
10532 .vitem &*${str2b64:*&<&'string'&>&*}*&
10533 .cindex "&%str2b64%& expansion item"
10534 .new
10535 Now deprecated, a synonym for the &%base64%& expansion operator.
10536 .wen
10537
10538
10539
10540 .vitem &*${strlen:*&<&'string'&>&*}*&
10541 .cindex "expansion" "string length"
10542 .cindex "string" "length in expansion"
10543 .cindex "&%strlen%& expansion item"
10544 The item is replace by the length of the expanded string, expressed as a
10545 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10546
10547
10548 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10549 .cindex "&%substr%& expansion item"
10550 .cindex "substring extraction"
10551 .cindex "expansion" "substring expansion"
10552 The &%substr%& operator is a simpler interface to the &%substr%& function that
10553 can be used when the two parameters are fixed numbers (as opposed to strings
10554 that change when expanded). The effect is the same as
10555 .code
10556 ${substr{<start>}{<length>}{<string>}}
10557 .endd
10558 See the description of the general &%substr%& item above for details. The
10559 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10560
10561 .vitem &*${time_eval:*&<&'string'&>&*}*&
10562 .cindex "&%time_eval%& expansion item"
10563 .cindex "time interval" "decoding"
10564 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10565 seconds.
10566
10567 .vitem &*${time_interval:*&<&'string'&>&*}*&
10568 .cindex "&%time_interval%& expansion item"
10569 .cindex "time interval" "formatting"
10570 The argument (after sub-expansion) must be a sequence of decimal digits that
10571 represents an interval of time as a number of seconds. It is converted into a
10572 number of larger units and output in Exim's normal time format, for example,
10573 &`1w3d4h2m6s`&.
10574
10575 .vitem &*${uc:*&<&'string'&>&*}*&
10576 .cindex "case forcing in strings"
10577 .cindex "string" "case forcing"
10578 .cindex "upper casing"
10579 .cindex "expansion" "case forcing"
10580 .cindex "&%uc%& expansion item"
10581 This forces the letters in the string into upper-case.
10582
10583 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10584 .cindex "correction of invalid utf-8 sequences in strings"
10585 .cindex "utf-8" "utf-8 sequences"
10586 .cindex "incorrect utf-8"
10587 .cindex "expansion" "utf-8 forcing"
10588 .cindex "&%utf8clean%& expansion item"
10589 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10590
10591 .new
10592 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10593        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10594        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10595        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10596 .cindex expansion UTF-8
10597 .cindex UTF-8 expansion
10598 .cindex EAI
10599 .cindex internationalisation
10600 .cindex "&%utf8_domain_to_alabel%& expansion item"
10601 .cindex "&%utf8_domain_from_alabel%& expansion item"
10602 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10603 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10604 These convert EAI mail name components between UTF-8 and a-label forms.
10605 For information on internationalisation support see &<<SECTi18nMTA>>&.
10606 .wen
10607 .endlist
10608
10609
10610
10611
10612
10613
10614 .section "Expansion conditions" "SECTexpcond"
10615 .scindex IIDexpcond "expansion" "conditions"
10616 The following conditions are available for testing by the &%${if%& construct
10617 while expanding strings:
10618
10619 .vlist
10620 .vitem &*!*&<&'condition'&>
10621 .cindex "expansion" "negating a condition"
10622 .cindex "negation" "in expansion condition"
10623 Preceding any condition with an exclamation mark negates the result of the
10624 condition.
10625
10626 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10627 .cindex "numeric comparison"
10628 .cindex "expansion" "numeric comparison"
10629 There are a number of symbolic operators for doing numeric comparisons. They
10630 are:
10631 .display
10632 &`=   `&   equal
10633 &`==  `&   equal
10634 &`>   `&   greater
10635 &`>=  `&   greater or equal
10636 &`<   `&   less
10637 &`<=  `&   less or equal
10638 .endd
10639 For example:
10640 .code
10641 ${if >{$message_size}{10M} ...
10642 .endd
10643 Note that the general negation operator provides for inequality testing. The
10644 two strings must take the form of optionally signed decimal integers,
10645 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10646 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10647 As a special case, the numerical value of an empty string is taken as
10648 zero.
10649
10650 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10651 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10652 10M, not if 10M is larger than &$message_size$&.
10653
10654
10655 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10656         {*&<&'arg2'&>&*}...}*&
10657 .cindex "expansion" "calling an acl"
10658 .cindex "&%acl%&" "expansion condition"
10659 The name and zero to nine argument strings are first expanded separately.  The expanded
10660 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10661 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10662 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10663 and may use the variables; if another acl expansion is used the values
10664 are restored after it returns.  If the ACL sets
10665 a value using a "message =" modifier the variable $value becomes
10666 the result of the expansion, otherwise it is empty.
10667 If the ACL returns accept the condition is true; if deny, false.
10668 If the ACL returns defer the result is a forced-fail.
10669
10670 .vitem &*bool&~{*&<&'string'&>&*}*&
10671 .cindex "expansion" "boolean parsing"
10672 .cindex "&%bool%& expansion condition"
10673 This condition turns a string holding a true or false representation into
10674 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10675 (case-insensitively); also integer numbers map to true if non-zero,
10676 false if zero.
10677 An empty string is treated as false.
10678 Leading and trailing whitespace is ignored;
10679 thus a string consisting only of whitespace is false.
10680 All other string values will result in expansion failure.
10681
10682 When combined with ACL variables, this expansion condition will let you
10683 make decisions in one place and act on those decisions in another place.
10684 For example:
10685 .code
10686 ${if bool{$acl_m_privileged_sender} ...
10687 .endd
10688
10689
10690 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10691 .cindex "expansion" "boolean parsing"
10692 .cindex "&%bool_lax%& expansion condition"
10693 Like &%bool%&, this condition turns a string into a boolean state.  But
10694 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10695 loose definition that the Router &%condition%& option uses.  The empty string
10696 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10697 true.  Leading and trailing whitespace is ignored.
10698
10699 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10700
10701 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10702 .cindex "expansion" "encrypted comparison"
10703 .cindex "encrypted strings, comparing"
10704 .cindex "&%crypteq%& expansion condition"
10705 This condition is included in the Exim binary if it is built to support any
10706 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10707 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10708 included in the binary.
10709
10710 The &%crypteq%& condition has two arguments. The first is encrypted and
10711 compared against the second, which is already encrypted. The second string may
10712 be in the LDAP form for storing encrypted strings, which starts with the
10713 encryption type in curly brackets, followed by the data. If the second string
10714 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10715 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10716 Typically this will be a field from a password file. An example of an encrypted
10717 string in LDAP form is:
10718 .code
10719 {md5}CY9rzUYh03PK3k6DJie09g==
10720 .endd
10721 If such a string appears directly in an expansion, the curly brackets have to
10722 be quoted, because they are part of the expansion syntax. For example:
10723 .code
10724 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10725 .endd
10726 The following encryption types (whose names are matched case-independently) are
10727 supported:
10728
10729 .ilist
10730 .cindex "MD5 hash"
10731 .cindex "base64 encoding" "in encrypted password"
10732 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10733 printable characters to compare with the remainder of the second string. If the
10734 length of the comparison string is 24, Exim assumes that it is base64 encoded
10735 (as in the above example). If the length is 32, Exim assumes that it is a
10736 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10737 comparison fails.
10738
10739 .next
10740 .cindex "SHA-1 hash"
10741 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10742 printable characters to compare with the remainder of the second string. If the
10743 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10744 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10745 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10746
10747 .next
10748 .cindex "&[crypt()]&"
10749 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10750 only the first eight characters of the password. However, in modern operating
10751 systems this is no longer true, and in many cases the entire password is used,
10752 whatever its length.
10753
10754 .next
10755 .cindex "&[crypt16()]&"
10756 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10757 use up to 16 characters of the password in some operating systems. Again, in
10758 modern operating systems, more characters may be used.
10759 .endlist
10760 Exim has its own version of &[crypt16()]&, which is just a double call to
10761 &[crypt()]&. For operating systems that have their own version, setting
10762 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10763 operating system version instead of its own. This option is set by default in
10764 the OS-dependent &_Makefile_& for those operating systems that are known to
10765 support &[crypt16()]&.
10766
10767 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10768 it was not using the same algorithm as some operating systems' versions. It
10769 turns out that as well as &[crypt16()]& there is a function called
10770 &[bigcrypt()]& in some operating systems. This may or may not use the same
10771 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10772
10773 However, since there is now a move away from the traditional &[crypt()]&
10774 functions towards using SHA1 and other algorithms, tidying up this area of
10775 Exim is seen as very low priority.
10776
10777 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10778 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10779 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10780 default is &`{crypt}`&. Whatever the default, you can always use either
10781 function by specifying it explicitly in curly brackets.
10782
10783 .vitem &*def:*&<&'variable&~name'&>
10784 .cindex "expansion" "checking for empty variable"
10785 .cindex "&%def%& expansion condition"
10786 The &%def%& condition must be followed by the name of one of the expansion
10787 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10788 variable does not contain the empty string. For example:
10789 .code
10790 ${if def:sender_ident {from $sender_ident}}
10791 .endd
10792 Note that the variable name is given without a leading &%$%& character. If the
10793 variable does not exist, the expansion fails.
10794
10795 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10796         &~&*def:h_*&<&'header&~name'&>&*:*&"
10797 .cindex "expansion" "checking header line existence"
10798 This condition is true if a message is being processed and the named header
10799 exists in the message. For example,
10800 .code
10801 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10802 .endd
10803 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10804 the header name must be terminated by a colon if white space does not follow.
10805
10806 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10807        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10808 .cindex "string" "comparison"
10809 .cindex "expansion" "string comparison"
10810 .cindex "&%eq%& expansion condition"
10811 .cindex "&%eqi%& expansion condition"
10812 The two substrings are first expanded. The condition is true if the two
10813 resulting strings are identical. For &%eq%& the comparison includes the case of
10814 letters, whereas for &%eqi%& the comparison is case-independent.
10815
10816 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10817 .cindex "expansion" "file existence test"
10818 .cindex "file" "existence test"
10819 .cindex "&%exists%&, expansion condition"
10820 The substring is first expanded and then interpreted as an absolute path. The
10821 condition is true if the named file (or directory) exists. The existence test
10822 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10823 users' filter files may be locked out by the system administrator.
10824
10825 .vitem &*first_delivery*&
10826 .cindex "delivery" "first"
10827 .cindex "first delivery"
10828 .cindex "expansion" "first delivery test"
10829 .cindex "&%first_delivery%& expansion condition"
10830 This condition, which has no data, is true during a message's first delivery
10831 attempt. It is false during any subsequent delivery attempts.
10832
10833
10834 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10835        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10836 .cindex "list" "iterative conditions"
10837 .cindex "expansion" "&*forall*& condition"
10838 .cindex "expansion" "&*forany*& condition"
10839 .vindex "&$item$&"
10840 These conditions iterate over a list. The first argument is expanded to form
10841 the list. By default, the list separator is a colon, but it can be changed by
10842 the normal method. The second argument is interpreted as a condition that is to
10843 be applied to each item in the list in turn. During the interpretation of the
10844 condition, the current list item is placed in a variable called &$item$&.
10845 .ilist
10846 For &*forany*&, interpretation stops if the condition is true for any item, and
10847 the result of the whole condition is true. If the condition is false for all
10848 items in the list, the overall condition is false.
10849 .next
10850 For &*forall*&, interpretation stops if the condition is false for any item,
10851 and the result of the whole condition is false. If the condition is true for
10852 all items in the list, the overall condition is true.
10853 .endlist
10854 Note that negation of &*forany*& means that the condition must be false for all
10855 items for the overall condition to succeed, and negation of &*forall*& means
10856 that the condition must be false for at least one item. In this example, the
10857 list separator is changed to a comma:
10858 .code
10859 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10860 .endd
10861 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10862 being processed, to enable these expansion items to be nested.
10863
10864 To scan a named list, expand it with the &*listnamed*& operator.
10865
10866
10867 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10868        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10869 .cindex "string" "comparison"
10870 .cindex "expansion" "string comparison"
10871 .cindex "&%ge%& expansion condition"
10872 .cindex "&%gei%& expansion condition"
10873 The two substrings are first expanded. The condition is true if the first
10874 string is lexically greater than or equal to the second string. For &%ge%& the
10875 comparison includes the case of letters, whereas for &%gei%& the comparison is
10876 case-independent.
10877
10878 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10879        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10880 .cindex "string" "comparison"
10881 .cindex "expansion" "string comparison"
10882 .cindex "&%gt%& expansion condition"
10883 .cindex "&%gti%& expansion condition"
10884 The two substrings are first expanded. The condition is true if the first
10885 string is lexically greater than the second string. For &%gt%& the comparison
10886 includes the case of letters, whereas for &%gti%& the comparison is
10887 case-independent.
10888
10889 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10890        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10891 .cindex "string" "comparison"
10892 .cindex "list" "iterative conditions"
10893 Both strings are expanded; the second string is treated as a list of simple
10894 strings; if the first string is a member of the second, then the condition
10895 is true.
10896
10897 These are simpler to use versions of the more powerful &*forany*& condition.
10898 Examples, and the &*forany*& equivalents:
10899 .code
10900 ${if inlist{needle}{foo:needle:bar}}
10901   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10902 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10903   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10904 .endd
10905
10906 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10907        &*isip4&~{*&<&'string'&>&*}*& &&&
10908        &*isip6&~{*&<&'string'&>&*}*&
10909 .cindex "IP address" "testing string format"
10910 .cindex "string" "testing for IP address"
10911 .cindex "&%isip%& expansion condition"
10912 .cindex "&%isip4%& expansion condition"
10913 .cindex "&%isip6%& expansion condition"
10914 The substring is first expanded, and then tested to see if it has the form of
10915 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10916 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10917
10918 For an IPv4 address, the test is for four dot-separated components, each of
10919 which consists of from one to three digits. For an IPv6 address, up to eight
10920 colon-separated components are permitted, each containing from one to four
10921 hexadecimal digits. There may be fewer than eight components if an empty
10922 component (adjacent colons) is present. Only one empty component is permitted.
10923
10924 &*Note*&: The checks are just on the form of the address; actual numerical
10925 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10926 check. The main use of these tests is to distinguish between IP addresses and
10927 host names, or between IPv4 and IPv6 addresses. For example, you could use
10928 .code
10929 ${if isip4{$sender_host_address}...
10930 .endd
10931 to test which IP version an incoming SMTP connection is using.
10932
10933 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10934 .cindex "LDAP" "use for authentication"
10935 .cindex "expansion" "LDAP authentication test"
10936 .cindex "&%ldapauth%& expansion condition"
10937 This condition supports user authentication using LDAP. See section
10938 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10939 queries. For this use, the query must contain a user name and password. The
10940 query itself is not used, and can be empty. The condition is true if the
10941 password is not empty, and the user name and password are accepted by the LDAP
10942 server. An empty password is rejected without calling LDAP because LDAP binds
10943 with an empty password are considered anonymous regardless of the username, and
10944 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10945 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10946 this can be used.
10947
10948
10949 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10950        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10951 .cindex "string" "comparison"
10952 .cindex "expansion" "string comparison"
10953 .cindex "&%le%& expansion condition"
10954 .cindex "&%lei%& expansion condition"
10955 The two substrings are first expanded. The condition is true if the first
10956 string is lexically less than or equal to the second string. For &%le%& the
10957 comparison includes the case of letters, whereas for &%lei%& the comparison is
10958 case-independent.
10959
10960 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10961        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10962 .cindex "string" "comparison"
10963 .cindex "expansion" "string comparison"
10964 .cindex "&%lt%& expansion condition"
10965 .cindex "&%lti%& expansion condition"
10966 The two substrings are first expanded. The condition is true if the first
10967 string is lexically less than the second string. For &%lt%& the comparison
10968 includes the case of letters, whereas for &%lti%& the comparison is
10969 case-independent.
10970
10971
10972 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10973 .cindex "expansion" "regular expression comparison"
10974 .cindex "regular expressions" "match in expanded string"
10975 .cindex "&%match%& expansion condition"
10976 The two substrings are first expanded. The second is then treated as a regular
10977 expression and applied to the first. Because of the pre-expansion, if the
10978 regular expression contains dollar, or backslash characters, they must be
10979 escaped. Care must also be taken if the regular expression contains braces
10980 (curly brackets). A closing brace must be escaped so that it is not taken as a
10981 premature termination of <&'string2'&>. The easiest approach is to use the
10982 &`\N`& feature to disable expansion of the regular expression.
10983 For example,
10984 .code
10985 ${if match {$local_part}{\N^\d{3}\N} ...
10986 .endd
10987 If the whole expansion string is in double quotes, further escaping of
10988 backslashes is also required.
10989
10990 The condition is true if the regular expression match succeeds.
10991 The regular expression is not required to begin with a circumflex
10992 metacharacter, but if there is no circumflex, the expression is not anchored,
10993 and it may match anywhere in the subject, not just at the start. If you want
10994 the pattern to match at the end of the subject, you must include the &`$`&
10995 metacharacter at an appropriate point.
10996
10997 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10998 At the start of an &%if%& expansion the values of the numeric variable
10999 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11000 succeeds causes them to be reset to the substrings of that condition and they
11001 will have these values during the expansion of the success string. At the end
11002 of the &%if%& expansion, the previous values are restored. After testing a
11003 combination of conditions using &%or%&, the subsequent values of the numeric
11004 variables are those of the condition that succeeded.
11005
11006 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11007 .cindex "&%match_address%& expansion condition"
11008 See &*match_local_part*&.
11009
11010 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11011 .cindex "&%match_domain%& expansion condition"
11012 See &*match_local_part*&.
11013
11014 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11015 .cindex "&%match_ip%& expansion condition"
11016 This condition matches an IP address to a list of IP address patterns. It must
11017 be followed by two argument strings. The first (after expansion) must be an IP
11018 address or an empty string. The second (not expanded) is a restricted host
11019 list that can match only an IP address, not a host name. For example:
11020 .code
11021 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11022 .endd
11023 The specific types of host list item that are permitted in the list are:
11024
11025 .ilist
11026 An IP address, optionally with a CIDR mask.
11027 .next
11028 A single asterisk, which matches any IP address.
11029 .next
11030 An empty item, which matches only if the IP address is empty. This could be
11031 useful for testing for a locally submitted message or one from specific hosts
11032 in a single test such as
11033 . ==== As this is a nested list, any displays it contains must be indented
11034 . ==== as otherwise they are too far to the left. This comment applies to
11035 . ==== the use of xmlto plus fop. There's no problem when formatting with
11036 . ==== sdop, with or without the extra indent.
11037 .code
11038   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11039 .endd
11040 where the first item in the list is the empty string.
11041 .next
11042 The item @[] matches any of the local host's interface addresses.
11043 .next
11044 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11045 even if &`net-`& is not specified. There is never any attempt to turn the IP
11046 address into a host name. The most common type of linear search for
11047 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11048 masks. For example:
11049 .code
11050   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11051 .endd
11052 It is of course possible to use other kinds of lookup, and in such a case, you
11053 do need to specify the &`net-`& prefix if you want to specify a specific
11054 address mask, for example:
11055 .code
11056   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11057 .endd
11058 However, unless you are combining a &%match_ip%& condition with others, it is
11059 just as easy to use the fact that a lookup is itself a condition, and write:
11060 .code
11061   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11062 .endd
11063 .endlist ilist
11064
11065 Note that <&'string2'&> is not itself subject to string expansion, unless
11066 Exim was built with the EXPAND_LISTMATCH_RHS option.
11067
11068 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11069
11070 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11071 .cindex "domain list" "in expansion condition"
11072 .cindex "address list" "in expansion condition"
11073 .cindex "local part" "list, in expansion condition"
11074 .cindex "&%match_local_part%& expansion condition"
11075 This condition, together with &%match_address%& and &%match_domain%&, make it
11076 possible to test domain, address, and local part lists within expansions. Each
11077 condition requires two arguments: an item and a list to match. A trivial
11078 example is:
11079 .code
11080 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11081 .endd
11082 In each case, the second argument may contain any of the allowable items for a
11083 list of the appropriate type. Also, because the second argument (after
11084 expansion) is a standard form of list, it is possible to refer to a named list.
11085 Thus, you can use conditions like this:
11086 .code
11087 ${if match_domain{$domain}{+local_domains}{...
11088 .endd
11089 .cindex "&`+caseful`&"
11090 For address lists, the matching starts off caselessly, but the &`+caseful`&
11091 item can be used, as in all address lists, to cause subsequent items to
11092 have their local parts matched casefully. Domains are always matched
11093 caselessly.
11094
11095 Note that <&'string2'&> is not itself subject to string expansion, unless
11096 Exim was built with the EXPAND_LISTMATCH_RHS option.
11097
11098 &*Note*&: Host lists are &'not'& supported in this way. This is because
11099 hosts have two identities: a name and an IP address, and it is not clear
11100 how to specify cleanly how such a test would work. However, IP addresses can be
11101 matched using &%match_ip%&.
11102
11103 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11104 .cindex "PAM authentication"
11105 .cindex "AUTH" "with PAM"
11106 .cindex "Solaris" "PAM support"
11107 .cindex "expansion" "PAM authentication test"
11108 .cindex "&%pam%& expansion condition"
11109 &'Pluggable Authentication Modules'&
11110 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11111 available in the latest releases of Solaris and in some GNU/Linux
11112 distributions. The Exim support, which is intended for use in conjunction with
11113 the SMTP AUTH command, is available only if Exim is compiled with
11114 .code
11115 SUPPORT_PAM=yes
11116 .endd
11117 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11118 in some releases of GNU/Linux &%-ldl%& is also needed.
11119
11120 The argument string is first expanded, and the result must be a
11121 colon-separated list of strings. Leading and trailing white space is ignored.
11122 The PAM module is initialized with the service name &"exim"& and the user name
11123 taken from the first item in the colon-separated data string (<&'string1'&>).
11124 The remaining items in the data string are passed over in response to requests
11125 from the authentication function. In the simple case there will only be one
11126 request, for a password, so the data consists of just two strings.
11127
11128 There can be problems if any of the strings are permitted to contain colon
11129 characters. In the usual way, these have to be doubled to avoid being taken as
11130 separators. If the data is being inserted from a variable, the &%sg%& expansion
11131 item can be used to double any existing colons. For example, the configuration
11132 of a LOGIN authenticator might contain this setting:
11133 .code
11134 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11135 .endd
11136 For a PLAIN authenticator you could use:
11137 .code
11138 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11139 .endd
11140 In some operating systems, PAM authentication can be done only from a process
11141 running as root. Since Exim is running as the Exim user when receiving
11142 messages, this means that PAM cannot be used directly in those systems.
11143 A patched version of the &'pam_unix'& module that comes with the
11144 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11145 The patched module allows one special uid/gid combination, in addition to root,
11146 to authenticate. If you build the patched module to allow the Exim user and
11147 group, PAM can then be used from an Exim authenticator.
11148
11149
11150 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11151 .cindex "&'pwcheck'& daemon"
11152 .cindex "Cyrus"
11153 .cindex "expansion" "&'pwcheck'& authentication test"
11154 .cindex "&%pwcheck%& expansion condition"
11155 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11156 This is one way of making it possible for passwords to be checked by a process
11157 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11158 deprecated. Its replacement is &'saslauthd'& (see below).
11159
11160 The pwcheck support is not included in Exim by default. You need to specify
11161 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11162 building Exim. For example:
11163 .code
11164 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11165 .endd
11166 You do not need to install the full Cyrus software suite in order to use
11167 the pwcheck daemon. You can compile and install just the daemon alone
11168 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11169 access to the &_/var/pwcheck_& directory.
11170
11171 The &%pwcheck%& condition takes one argument, which must be the user name and
11172 password, separated by a colon. For example, in a LOGIN authenticator
11173 configuration, you might have this:
11174 .code
11175 server_condition = ${if pwcheck{$auth1:$auth2}}
11176 .endd
11177 Again, for a PLAIN authenticator configuration, this would be:
11178 .code
11179 server_condition = ${if pwcheck{$auth2:$auth3}}
11180 .endd
11181 .vitem &*queue_running*&
11182 .cindex "queue runner" "detecting when delivering from"
11183 .cindex "expansion" "queue runner test"
11184 .cindex "&%queue_running%& expansion condition"
11185 This condition, which has no data, is true during delivery attempts that are
11186 initiated by queue runner processes, and false otherwise.
11187
11188
11189 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11190 .cindex "Radius"
11191 .cindex "expansion" "Radius authentication"
11192 .cindex "&%radius%& expansion condition"
11193 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11194 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11195 the Radius client configuration file in order to build Exim with Radius
11196 support.
11197
11198 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11199 library, using the original API. If you are using release 0.4.0 or later of
11200 this library, you need to set
11201 .code
11202 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11203 .endd
11204 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11205 &%libradius%& library that comes with FreeBSD. To do this, set
11206 .code
11207 RADIUS_LIB_TYPE=RADLIB
11208 .endd
11209 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11210 You may also have to supply a suitable setting in EXTRALIBS so that the
11211 Radius library can be found when Exim is linked.
11212
11213 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11214 Radius client library, which calls the Radius server. The condition is true if
11215 the authentication is successful. For example:
11216 .code
11217 server_condition = ${if radius{<arguments>}}
11218 .endd
11219
11220
11221 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11222         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11223 .cindex "&'saslauthd'& daemon"
11224 .cindex "Cyrus"
11225 .cindex "expansion" "&'saslauthd'& authentication test"
11226 .cindex "&%saslauthd%& expansion condition"
11227 This condition supports user authentication using the Cyrus &'saslauthd'&
11228 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11229 Using this daemon is one way of making it possible for passwords to be checked
11230 by a process that is not running as root.
11231
11232 The saslauthd support is not included in Exim by default. You need to specify
11233 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11234 building Exim. For example:
11235 .code
11236 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11237 .endd
11238 You do not need to install the full Cyrus software suite in order to use
11239 the saslauthd daemon. You can compile and install just the daemon alone
11240 from the Cyrus SASL library.
11241
11242 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11243 two are mandatory. For example:
11244 .code
11245 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11246 .endd
11247 The service and the realm are optional (which is why the arguments are enclosed
11248 in their own set of braces). For details of the meaning of the service and
11249 realm, and how to run the daemon, consult the Cyrus documentation.
11250 .endlist vlist
11251
11252
11253
11254 .section "Combining expansion conditions" "SECID84"
11255 .cindex "expansion" "combining conditions"
11256 Several conditions can be tested at once by combining them using the &%and%&
11257 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11258 conditions on their own, and precede their lists of sub-conditions. Each
11259 sub-condition must be enclosed in braces within the overall braces that contain
11260 the list. No repetition of &%if%& is used.
11261
11262
11263 .vlist
11264 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11265 .cindex "&""or""& expansion condition"
11266 .cindex "expansion" "&""or""& of conditions"
11267 The sub-conditions are evaluated from left to right. The condition is true if
11268 any one of the sub-conditions is true.
11269 For example,
11270 .code
11271 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11272 .endd
11273 When a true sub-condition is found, the following ones are parsed but not
11274 evaluated. If there are several &"match"& sub-conditions the values of the
11275 numeric variables afterwards are taken from the first one that succeeds.
11276
11277 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11278 .cindex "&""and""& expansion condition"
11279 .cindex "expansion" "&""and""& of conditions"
11280 The sub-conditions are evaluated from left to right. The condition is true if
11281 all of the sub-conditions are true. If there are several &"match"&
11282 sub-conditions, the values of the numeric variables afterwards are taken from
11283 the last one. When a false sub-condition is found, the following ones are
11284 parsed but not evaluated.
11285 .endlist
11286 .ecindex IIDexpcond
11287
11288
11289
11290
11291 .section "Expansion variables" "SECTexpvar"
11292 .cindex "expansion" "variables, list of"
11293 This section contains an alphabetical list of all the expansion variables. Some
11294 of them are available only when Exim is compiled with specific options such as
11295 support for TLS or the content scanning extension.
11296
11297 .vlist
11298 .vitem "&$0$&, &$1$&, etc"
11299 .cindex "numerical variables (&$1$& &$2$& etc)"
11300 When a &%match%& expansion condition succeeds, these variables contain the
11301 captured substrings identified by the regular expression during subsequent
11302 processing of the success string of the containing &%if%& expansion item.
11303 In the expansion condition case
11304 they do not retain their values afterwards; in fact, their previous
11305 values are restored at the end of processing an &%if%& item. The numerical
11306 variables may also be set externally by some other matching process which
11307 precedes the expansion of the string. For example, the commands available in
11308 Exim filter files include an &%if%& command with its own regular expression
11309 matching condition.
11310
11311 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11312 Within an acl condition, expansion condition or expansion item
11313 any arguments are copied to these variables,
11314 any unused variables being made empty.
11315
11316 .vitem "&$acl_c...$&"
11317 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11318 can be given any name that starts with &$acl_c$& and is at least six characters
11319 long, but the sixth character must be either a digit or an underscore. For
11320 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11321 variables persist throughout the lifetime of an SMTP connection. They can be
11322 used to pass information between ACLs and between different invocations of the
11323 same ACL. When a message is received, the values of these variables are saved
11324 with the message, and can be accessed by filters, routers, and transports
11325 during subsequent delivery.
11326
11327 .vitem "&$acl_m...$&"
11328 These variables are like the &$acl_c...$& variables, except that their values
11329 are reset after a message has been received. Thus, if several messages are
11330 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11331 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11332 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11333 message is received, the values of these variables are saved with the message,
11334 and can be accessed by filters, routers, and transports during subsequent
11335 delivery.
11336
11337 .vitem &$acl_narg$&
11338 Within an acl condition, expansion condition or expansion item
11339 this variable has the number of arguments.
11340
11341 .vitem &$acl_verify_message$&
11342 .vindex "&$acl_verify_message$&"
11343 After an address verification has failed, this variable contains the failure
11344 message. It retains its value for use in subsequent modifiers. The message can
11345 be preserved by coding like this:
11346 .code
11347 warn !verify = sender
11348      set acl_m0 = $acl_verify_message
11349 .endd
11350 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11351 &%log_message%& modifiers, to include information about the verification
11352 failure.
11353
11354 .vitem &$address_data$&
11355 .vindex "&$address_data$&"
11356 This variable is set by means of the &%address_data%& option in routers. The
11357 value then remains with the address while it is processed by subsequent routers
11358 and eventually a transport. If the transport is handling multiple addresses,
11359 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11360 for more details. &*Note*&: The contents of &$address_data$& are visible in
11361 user filter files.
11362
11363 If &$address_data$& is set when the routers are called from an ACL to verify
11364 a recipient address, the final value is still in the variable for subsequent
11365 conditions and modifiers of the ACL statement. If routing the address caused it
11366 to be redirected to just one address, the child address is also routed as part
11367 of the verification, and in this case the final value of &$address_data$& is
11368 from the child's routing.
11369
11370 If &$address_data$& is set when the routers are called from an ACL to verify a
11371 sender address, the final value is also preserved, but this time in
11372 &$sender_address_data$&, to distinguish it from data from a recipient
11373 address.
11374
11375 In both cases (recipient and sender verification), the value does not persist
11376 after the end of the current ACL statement. If you want to preserve
11377 these values for longer, you can save them in ACL variables.
11378
11379 .vitem &$address_file$&
11380 .vindex "&$address_file$&"
11381 When, as a result of aliasing, forwarding, or filtering, a message is directed
11382 to a specific file, this variable holds the name of the file when the transport
11383 is running. At other times, the variable is empty. For example, using the
11384 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11385 .code
11386 /home/r2d2/savemail
11387 .endd
11388 then when the &(address_file)& transport is running, &$address_file$&
11389 contains the text string &`/home/r2d2/savemail`&.
11390 .cindex "Sieve filter" "value of &$address_file$&"
11391 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11392 then up to the transport configuration to generate an appropriate absolute path
11393 to the relevant file.
11394
11395 .vitem &$address_pipe$&
11396 .vindex "&$address_pipe$&"
11397 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11398 this variable holds the pipe command when the transport is running.
11399
11400 .vitem "&$auth1$& &-- &$auth3$&"
11401 .vindex "&$auth1$&, &$auth2$&, etc"
11402 These variables are used in SMTP authenticators (see chapters
11403 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11404
11405 .vitem &$authenticated_id$&
11406 .cindex "authentication" "id"
11407 .vindex "&$authenticated_id$&"
11408 When a server successfully authenticates a client it may be configured to
11409 preserve some of the authentication information in the variable
11410 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11411 user/password authenticator configuration might preserve the user name for use
11412 in the routers. Note that this is not the same information that is saved in
11413 &$sender_host_authenticated$&.
11414 When a message is submitted locally (that is, not over a TCP connection)
11415 the value of &$authenticated_id$& is normally the login name of the calling
11416 process. However, a trusted user can override this by means of the &%-oMai%&
11417 command line option.
11418
11419 .vitem &$authenticated_fail_id$&
11420 .cindex "authentication" "fail" "id"
11421 .vindex "&$authenticated_fail_id$&"
11422 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11423 will contain the failed authentication id. If more than one authentication
11424 id is attempted, it will contain only the last one. The variable is
11425 available for processing in the ACL's, generally the quit or notquit ACL.
11426 A message to a local recipient could still be accepted without requiring
11427 authentication, which means this variable could also be visible in all of
11428 the ACL's as well.
11429
11430
11431 .vitem &$authenticated_sender$&
11432 .cindex "sender" "authenticated"
11433 .cindex "authentication" "sender"
11434 .cindex "AUTH" "on MAIL command"
11435 .vindex "&$authenticated_sender$&"
11436 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11437 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11438 described in section &<<SECTauthparamail>>&. Unless the data is the string
11439 &"<>"&, it is set as the authenticated sender of the message, and the value is
11440 available during delivery in the &$authenticated_sender$& variable. If the
11441 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11442
11443 .vindex "&$qualify_domain$&"
11444 When a message is submitted locally (that is, not over a TCP connection), the
11445 value of &$authenticated_sender$& is an address constructed from the login
11446 name of the calling process and &$qualify_domain$&, except that a trusted user
11447 can override this by means of the &%-oMas%& command line option.
11448
11449
11450 .vitem &$authentication_failed$&
11451 .cindex "authentication" "failure"
11452 .vindex "&$authentication_failed$&"
11453 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11454 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11455 possible to distinguish between &"did not try to authenticate"&
11456 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11457 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11458 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11459 negative response to an AUTH command, including (for example) an attempt to use
11460 an undefined mechanism.
11461
11462 .vitem &$av_failed$&
11463 .cindex "content scanning" "AV scanner failure"
11464 This variable is available when Exim is compiled with the content-scanning
11465 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11466 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11467 the ACL malware condition.
11468
11469 .vitem &$body_linecount$&
11470 .cindex "message body" "line count"
11471 .cindex "body of message" "line count"
11472 .vindex "&$body_linecount$&"
11473 When a message is being received or delivered, this variable contains the
11474 number of lines in the message's body. See also &$message_linecount$&.
11475
11476 .vitem &$body_zerocount$&
11477 .cindex "message body" "binary zero count"
11478 .cindex "body of message" "binary zero count"
11479 .cindex "binary zero" "in message body"
11480 .vindex "&$body_zerocount$&"
11481 When a message is being received or delivered, this variable contains the
11482 number of binary zero bytes (ASCII NULs) in the message's body.
11483
11484 .vitem &$bounce_recipient$&
11485 .vindex "&$bounce_recipient$&"
11486 This is set to the recipient address of a bounce message while Exim is creating
11487 it. It is useful if a customized bounce message text file is in use (see
11488 chapter &<<CHAPemsgcust>>&).
11489
11490 .vitem &$bounce_return_size_limit$&
11491 .vindex "&$bounce_return_size_limit$&"
11492 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11493 up to a multiple of 1000. It is useful when a customized error message text
11494 file is in use (see chapter &<<CHAPemsgcust>>&).
11495
11496 .vitem &$caller_gid$&
11497 .cindex "gid (group id)" "caller"
11498 .vindex "&$caller_gid$&"
11499 The real group id under which the process that called Exim was running. This is
11500 not the same as the group id of the originator of a message (see
11501 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11502 incarnation normally contains the Exim gid.
11503
11504 .vitem &$caller_uid$&
11505 .cindex "uid (user id)" "caller"
11506 .vindex "&$caller_uid$&"
11507 The real user id under which the process that called Exim was running. This is
11508 not the same as the user id of the originator of a message (see
11509 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11510 incarnation normally contains the Exim uid.
11511
11512 .vitem &$callout_address$&
11513 .vindex "&$callout_address$&"
11514 After a callout for verification, spamd or malware daemon service, the
11515 address that was connected to.
11516
11517 .vitem &$compile_number$&
11518 .vindex "&$compile_number$&"
11519 The building process for Exim keeps a count of the number
11520 of times it has been compiled. This serves to distinguish different
11521 compilations of the same version of the program.
11522
11523 .vitem &$config_dir$&
11524 .vindex "&$config_dir$&"
11525 The directory name of the main configuration file. That is, the content of
11526 &$config_file$& with the last component stripped. The value does not
11527 contain the trailing slash. If &$config_file$& does not contain a slash,
11528 &$config_dir$& is ".".
11529
11530 .vitem &$config_file$&
11531 .vindex "&$config_file$&"
11532 The name of the main configuration file Exim is using.
11533
11534 .vitem &$demime_errorlevel$&
11535 .vindex "&$demime_errorlevel$&"
11536 This variable is available when Exim is compiled with
11537 the content-scanning extension and the obsolete &%demime%& condition. For
11538 details, see section &<<SECTdemimecond>>&.
11539
11540 .vitem &$demime_reason$&
11541 .vindex "&$demime_reason$&"
11542 This variable is available when Exim is compiled with the
11543 content-scanning extension and the obsolete &%demime%& condition. For details,
11544 see section &<<SECTdemimecond>>&.
11545
11546 .vitem &$dkim_cur_signer$& &&&
11547        &$dkim_verify_status$& &&&
11548        &$dkim_verify_reason$& &&&
11549        &$dkim_domain$& &&&
11550        &$dkim_identity$& &&&
11551        &$dkim_selector$& &&&
11552        &$dkim_algo$& &&&
11553        &$dkim_canon_body$& &&&
11554        &$dkim_canon_headers$& &&&
11555        &$dkim_copiedheaders$& &&&
11556        &$dkim_bodylength$& &&&
11557        &$dkim_created$& &&&
11558        &$dkim_expires$& &&&
11559        &$dkim_headernames$& &&&
11560        &$dkim_key_testing$& &&&
11561        &$dkim_key_nosubdomains$& &&&
11562        &$dkim_key_srvtype$& &&&
11563        &$dkim_key_granularity$& &&&
11564        &$dkim_key_notes$& &&&
11565        &$dkim_key_length$&
11566 These variables are only available within the DKIM ACL.
11567 For details see chapter &<<CHAPdkim>>&.
11568
11569 .vitem &$dkim_signers$&
11570 .vindex &$dkim_signers$&
11571 When a message has been received this variable contains
11572 a colon-separated list of signer domains and identities for the message.
11573 For details see chapter &<<CHAPdkim>>&.
11574
11575 .vitem &$dnslist_domain$& &&&
11576        &$dnslist_matched$& &&&
11577        &$dnslist_text$& &&&
11578        &$dnslist_value$&
11579 .vindex "&$dnslist_domain$&"
11580 .vindex "&$dnslist_matched$&"
11581 .vindex "&$dnslist_text$&"
11582 .vindex "&$dnslist_value$&"
11583 .cindex "black list (DNS)"
11584 When a DNS (black) list lookup succeeds, these variables are set to contain
11585 the following data from the lookup: the list's domain name, the key that was
11586 looked up, the contents of any associated TXT record, and the value from the
11587 main A record. See section &<<SECID204>>& for more details.
11588
11589 .vitem &$domain$&
11590 .vindex "&$domain$&"
11591 When an address is being routed, or delivered on its own, this variable
11592 contains the domain. Uppercase letters in the domain are converted into lower
11593 case for &$domain$&.
11594
11595 Global address rewriting happens when a message is received, so the value of
11596 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11597 is set during user filtering, but not during system filtering, because a
11598 message may have many recipients and the system filter is called just once.
11599
11600 When more than one address is being delivered at once (for example, several
11601 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11602 have the same domain. Transports can be restricted to handling only one domain
11603 at a time if the value of &$domain$& is required at transport time &-- this is
11604 the default for local transports. For further details of the environment in
11605 which local transports are run, see chapter &<<CHAPenvironment>>&.
11606
11607 .oindex "&%delay_warning_condition%&"
11608 At the end of a delivery, if all deferred addresses have the same domain, it is
11609 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11610
11611 The &$domain$& variable is also used in some other circumstances:
11612
11613 .ilist
11614 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11615 the recipient address. The domain of the &'sender'& address is in
11616 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11617 normally set during the running of the MAIL ACL. However, if the sender address
11618 is verified with a callout during the MAIL ACL, the sender domain is placed in
11619 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11620 the &(smtp)& transport.
11621
11622 .next
11623 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11624 &$domain$& contains the domain portion of the address that is being rewritten;
11625 it can be used in the expansion of the replacement address, for example, to
11626 rewrite domains by file lookup.
11627
11628 .next
11629 With one important exception, whenever a domain list is being scanned,
11630 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11631 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11632 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11633 that, in a RCPT ACL, the sender domain list can be dependent on the
11634 recipient domain (which is what is in &$domain$& at this time).
11635
11636 .next
11637 .cindex "ETRN" "value of &$domain$&"
11638 .oindex "&%smtp_etrn_command%&"
11639 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11640 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11641 .endlist
11642
11643
11644 .vitem &$domain_data$&
11645 .vindex "&$domain_data$&"
11646 When the &%domains%& option on a router matches a domain by
11647 means of a lookup, the data read by the lookup is available during the running
11648 of the router as &$domain_data$&. In addition, if the driver routes the
11649 address to a transport, the value is available in that transport. If the
11650 transport is handling multiple addresses, the value from the first address is
11651 used.
11652
11653 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11654 domain by means of a lookup. The data read by the lookup is available during
11655 the rest of the ACL statement. In all other situations, this variable expands
11656 to nothing.
11657
11658 .vitem &$exim_gid$&
11659 .vindex "&$exim_gid$&"
11660 This variable contains the numerical value of the Exim group id.
11661
11662 .vitem &$exim_path$&
11663 .vindex "&$exim_path$&"
11664 This variable contains the path to the Exim binary.
11665
11666 .vitem &$exim_uid$&
11667 .vindex "&$exim_uid$&"
11668 This variable contains the numerical value of the Exim user id.
11669
11670 .vitem &$exim_version$&
11671 .vindex "&$exim_version$&"
11672 This variable contains the version string of the Exim build.
11673 The first character is a major version number, currently 4.
11674 Then after a dot, the next group of digits is a minor version number.
11675 There may be other characters following the minor version.
11676
11677 .vitem &$found_extension$&
11678 .vindex "&$found_extension$&"
11679 This variable is available when Exim is compiled with the
11680 content-scanning extension and the obsolete &%demime%& condition. For details,
11681 see section &<<SECTdemimecond>>&.
11682
11683 .vitem &$header_$&<&'name'&>
11684 This is not strictly an expansion variable. It is expansion syntax for
11685 inserting the message header line with the given name. Note that the name must
11686 be terminated by colon or white space, because it may contain a wide variety of
11687 characters. Note also that braces must &'not'& be used.
11688
11689 .vitem &$headers_added$&
11690 .vindex "&$headers_added$&"
11691 Within an ACL this variable contains the headers added so far by
11692 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11693 The headers are a newline-separated list.
11694
11695 .vitem &$home$&
11696 .vindex "&$home$&"
11697 When the &%check_local_user%& option is set for a router, the user's home
11698 directory is placed in &$home$& when the check succeeds. In particular, this
11699 means it is set during the running of users' filter files. A router may also
11700 explicitly set a home directory for use by a transport; this can be overridden
11701 by a setting on the transport itself.
11702
11703 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11704 of the environment variable HOME, which is subject to the
11705 &%keep_environment%& and &%add_environment%& main config options.
11706
11707 .vitem &$host$&
11708 .vindex "&$host$&"
11709 If a router assigns an address to a transport (any transport), and passes a
11710 list of hosts with the address, the value of &$host$& when the transport starts
11711 to run is the name of the first host on the list. Note that this applies both
11712 to local and remote transports.
11713
11714 .cindex "transport" "filter"
11715 .cindex "filter" "transport filter"
11716 For the &(smtp)& transport, if there is more than one host, the value of
11717 &$host$& changes as the transport works its way through the list. In
11718 particular, when the &(smtp)& transport is expanding its options for encryption
11719 using TLS, or for specifying a transport filter (see chapter
11720 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11721 is connected.
11722
11723 When used in the client part of an authenticator configuration (see chapter
11724 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11725 client is connected.
11726
11727
11728 .vitem &$host_address$&
11729 .vindex "&$host_address$&"
11730 This variable is set to the remote host's IP address whenever &$host$& is set
11731 for a remote connection. It is also set to the IP address that is being checked
11732 when the &%ignore_target_hosts%& option is being processed.
11733
11734 .vitem &$host_data$&
11735 .vindex "&$host_data$&"
11736 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11737 result of the lookup is made available in the &$host_data$& variable. This
11738 allows you, for example, to do things like this:
11739 .code
11740 deny  hosts = net-lsearch;/some/file
11741 message = $host_data
11742 .endd
11743 .vitem &$host_lookup_deferred$&
11744 .cindex "host name" "lookup, failure of"
11745 .vindex "&$host_lookup_deferred$&"
11746 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11747 message comes from a remote host and there is an attempt to look up the host's
11748 name from its IP address, and the attempt is not successful, one of these
11749 variables is set to &"1"&.
11750
11751 .ilist
11752 If the lookup receives a definite negative response (for example, a DNS lookup
11753 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11754
11755 .next
11756 If there is any kind of problem during the lookup, such that Exim cannot
11757 tell whether or not the host name is defined (for example, a timeout for a DNS
11758 lookup), &$host_lookup_deferred$& is set to &"1"&.
11759 .endlist ilist
11760
11761 Looking up a host's name from its IP address consists of more than just a
11762 single reverse lookup. Exim checks that a forward lookup of at least one of the
11763 names it receives from a reverse lookup yields the original IP address. If this
11764 is not the case, Exim does not accept the looked up name(s), and
11765 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11766 IP address (for example, the existence of a PTR record in the DNS) is not
11767 sufficient on its own for the success of a host name lookup. If the reverse
11768 lookup succeeds, but there is a lookup problem such as a timeout when checking
11769 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11770 &"1"&. See also &$sender_host_name$&.
11771
11772 .vitem &$host_lookup_failed$&
11773 .vindex "&$host_lookup_failed$&"
11774 See &$host_lookup_deferred$&.
11775
11776 .vitem &$host_port$&
11777 .vindex "&$host_port$&"
11778 This variable is set to the remote host's TCP port whenever &$host$& is set
11779 for an outbound connection.
11780
11781 .vitem &$initial_cwd$&
11782 .vindex "&$initial_cwd$&
11783 This variable contains the full path name of the initial working
11784 directory of the current Exim process. This may differ from the current
11785 working directory, as Exim changes this to "/" during early startup, and
11786 to &$spool_directory$& later.
11787
11788 .vitem &$inode$&
11789 .vindex "&$inode$&"
11790 The only time this variable is set is while expanding the &%directory_file%&
11791 option in the &(appendfile)& transport. The variable contains the inode number
11792 of the temporary file which is about to be renamed. It can be used to construct
11793 a unique name for the file.
11794
11795 .vitem &$interface_address$&
11796 .vindex "&$interface_address$&"
11797 This is an obsolete name for &$received_ip_address$&.
11798
11799 .vitem &$interface_port$&
11800 .vindex "&$interface_port$&"
11801 This is an obsolete name for &$received_port$&.
11802
11803 .vitem &$item$&
11804 .vindex "&$item$&"
11805 This variable is used during the expansion of &*forall*& and &*forany*&
11806 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11807 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11808 empty.
11809
11810 .vitem &$ldap_dn$&
11811 .vindex "&$ldap_dn$&"
11812 This variable, which is available only when Exim is compiled with LDAP support,
11813 contains the DN from the last entry in the most recently successful LDAP
11814 lookup.
11815
11816 .vitem &$load_average$&
11817 .vindex "&$load_average$&"
11818 This variable contains the system load average, multiplied by 1000 so that it
11819 is an integer. For example, if the load average is 0.21, the value of the
11820 variable is 210. The value is recomputed every time the variable is referenced.
11821
11822 .vitem &$local_part$&
11823 .vindex "&$local_part$&"
11824 When an address is being routed, or delivered on its own, this
11825 variable contains the local part. When a number of addresses are being
11826 delivered together (for example, multiple RCPT commands in an SMTP
11827 session), &$local_part$& is not set.
11828
11829 Global address rewriting happens when a message is received, so the value of
11830 &$local_part$& during routing and delivery is the value after rewriting.
11831 &$local_part$& is set during user filtering, but not during system filtering,
11832 because a message may have many recipients and the system filter is called just
11833 once.
11834
11835 .vindex "&$local_part_prefix$&"
11836 .vindex "&$local_part_suffix$&"
11837 If a local part prefix or suffix has been recognized, it is not included in the
11838 value of &$local_part$& during routing and subsequent delivery. The values of
11839 any prefix or suffix are in &$local_part_prefix$& and
11840 &$local_part_suffix$&, respectively.
11841
11842 When a message is being delivered to a file, pipe, or autoreply transport as a
11843 result of aliasing or forwarding, &$local_part$& is set to the local part of
11844 the parent address, not to the file name or command (see &$address_file$& and
11845 &$address_pipe$&).
11846
11847 When an ACL is running for a RCPT command, &$local_part$& contains the
11848 local part of the recipient address.
11849
11850 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11851 &$local_part$& contains the local part of the address that is being rewritten;
11852 it can be used in the expansion of the replacement address, for example.
11853
11854 In all cases, all quoting is removed from the local part. For example, for both
11855 the addresses
11856 .code
11857 "abc:xyz"@test.example
11858 abc\:xyz@test.example
11859 .endd
11860 the value of &$local_part$& is
11861 .code
11862 abc:xyz
11863 .endd
11864 If you use &$local_part$& to create another address, you should always wrap it
11865 inside a quoting operator. For example, in a &(redirect)& router you could
11866 have:
11867 .code
11868 data = ${quote_local_part:$local_part}@new.domain.example
11869 .endd
11870 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11871 to process local parts in a case-dependent manner in a router, you can set the
11872 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11873
11874 .vitem &$local_part_data$&
11875 .vindex "&$local_part_data$&"
11876 When the &%local_parts%& option on a router matches a local part by means of a
11877 lookup, the data read by the lookup is available during the running of the
11878 router as &$local_part_data$&. In addition, if the driver routes the address
11879 to a transport, the value is available in that transport. If the transport is
11880 handling multiple addresses, the value from the first address is used.
11881
11882 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11883 matches a local part by means of a lookup. The data read by the lookup is
11884 available during the rest of the ACL statement. In all other situations, this
11885 variable expands to nothing.
11886
11887 .vitem &$local_part_prefix$&
11888 .vindex "&$local_part_prefix$&"
11889 When an address is being routed or delivered, and a
11890 specific prefix for the local part was recognized, it is available in this
11891 variable, having been removed from &$local_part$&.
11892
11893 .vitem &$local_part_suffix$&
11894 .vindex "&$local_part_suffix$&"
11895 When an address is being routed or delivered, and a
11896 specific suffix for the local part was recognized, it is available in this
11897 variable, having been removed from &$local_part$&.
11898
11899 .vitem &$local_scan_data$&
11900 .vindex "&$local_scan_data$&"
11901 This variable contains the text returned by the &[local_scan()]& function when
11902 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11903
11904 .vitem &$local_user_gid$&
11905 .vindex "&$local_user_gid$&"
11906 See &$local_user_uid$&.
11907
11908 .vitem &$local_user_uid$&
11909 .vindex "&$local_user_uid$&"
11910 This variable and &$local_user_gid$& are set to the uid and gid after the
11911 &%check_local_user%& router precondition succeeds. This means that their values
11912 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11913 and &%condition%&), for the &%address_data%& expansion, and for any
11914 router-specific expansions. At all other times, the values in these variables
11915 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11916
11917 .vitem &$localhost_number$&
11918 .vindex "&$localhost_number$&"
11919 This contains the expanded value of the
11920 &%localhost_number%& option. The expansion happens after the main options have
11921 been read.
11922
11923 .vitem &$log_inodes$&
11924 .vindex "&$log_inodes$&"
11925 The number of free inodes in the disk partition where Exim's
11926 log files are being written. The value is recalculated whenever the variable is
11927 referenced. If the relevant file system does not have the concept of inodes,
11928 the value of is -1. See also the &%check_log_inodes%& option.
11929
11930 .vitem &$log_space$&
11931 .vindex "&$log_space$&"
11932 The amount of free space (as a number of kilobytes) in the disk
11933 partition where Exim's log files are being written. The value is recalculated
11934 whenever the variable is referenced. If the operating system does not have the
11935 ability to find the amount of free space (only true for experimental systems),
11936 the space value is -1. See also the &%check_log_space%& option.
11937
11938
11939 .vitem &$lookup_dnssec_authenticated$&
11940 .vindex "&$lookup_dnssec_authenticated$&"
11941 This variable is set after a DNS lookup done by
11942 a dnsdb lookup expansion, dnslookup router or smtp transport.
11943 .cindex "DNS" "DNSSEC"
11944 It will be empty if &(DNSSEC)& was not requested,
11945 &"no"& if the result was not labelled as authenticated data
11946 and &"yes"& if it was.
11947 Results that are labelled as authoritative answer that match
11948 the &%dns_trust_aa%& configuration variable count also
11949 as authenticated data.
11950
11951 .vitem &$mailstore_basename$&
11952 .vindex "&$mailstore_basename$&"
11953 This variable is set only when doing deliveries in &"mailstore"& format in the
11954 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11955 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11956 contains the basename of the files that are being written, that is, the name
11957 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11958 variable is empty.
11959
11960 .vitem &$malware_name$&
11961 .vindex "&$malware_name$&"
11962 This variable is available when Exim is compiled with the
11963 content-scanning extension. It is set to the name of the virus that was found
11964 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11965
11966 .vitem &$max_received_linelength$&
11967 .vindex "&$max_received_linelength$&"
11968 .cindex "maximum" "line length"
11969 .cindex "line length" "maximum"
11970 This variable contains the number of bytes in the longest line that was
11971 received as part of the message, not counting the line termination
11972 character(s).
11973
11974 .vitem &$message_age$&
11975 .cindex "message" "age of"
11976 .vindex "&$message_age$&"
11977 This variable is set at the start of a delivery attempt to contain the number
11978 of seconds since the message was received. It does not change during a single
11979 delivery attempt.
11980
11981 .vitem &$message_body$&
11982 .cindex "body of message" "expansion variable"
11983 .cindex "message body" "in expansion"
11984 .cindex "binary zero" "in message body"
11985 .vindex "&$message_body$&"
11986 .oindex "&%message_body_visible%&"
11987 This variable contains the initial portion of a message's body while it is
11988 being delivered, and is intended mainly for use in filter files. The maximum
11989 number of characters of the body that are put into the variable is set by the
11990 &%message_body_visible%& configuration option; the default is 500.
11991
11992 .oindex "&%message_body_newlines%&"
11993 By default, newlines are converted into spaces in &$message_body$&, to make it
11994 easier to search for phrases that might be split over a line break. However,
11995 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11996 zeros are always converted into spaces.
11997
11998 .vitem &$message_body_end$&
11999 .cindex "body of message" "expansion variable"
12000 .cindex "message body" "in expansion"
12001 .vindex "&$message_body_end$&"
12002 This variable contains the final portion of a message's
12003 body while it is being delivered. The format and maximum size are as for
12004 &$message_body$&.
12005
12006 .vitem &$message_body_size$&
12007 .cindex "body of message" "size"
12008 .cindex "message body" "size"
12009 .vindex "&$message_body_size$&"
12010 When a message is being delivered, this variable contains the size of the body
12011 in bytes. The count starts from the character after the blank line that
12012 separates the body from the header. Newlines are included in the count. See
12013 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12014
12015 .vitem &$message_exim_id$&
12016 .vindex "&$message_exim_id$&"
12017 When a message is being received or delivered, this variable contains the
12018 unique message id that is generated and used by Exim to identify the message.
12019 An id is not created for a message until after its header has been successfully
12020 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12021 line; it is the local id that Exim assigns to the message, for example:
12022 &`1BXTIK-0001yO-VA`&.
12023
12024 .vitem &$message_headers$&
12025 .vindex &$message_headers$&
12026 This variable contains a concatenation of all the header lines when a message
12027 is being processed, except for lines added by routers or transports. The header
12028 lines are separated by newline characters. Their contents are decoded in the
12029 same way as a header line that is inserted by &%bheader%&.
12030
12031 .vitem &$message_headers_raw$&
12032 .vindex &$message_headers_raw$&
12033 This variable is like &$message_headers$& except that no processing of the
12034 contents of header lines is done.
12035
12036 .vitem &$message_id$&
12037 This is an old name for &$message_exim_id$&. It is now deprecated.
12038
12039 .vitem &$message_linecount$&
12040 .vindex "&$message_linecount$&"
12041 This variable contains the total number of lines in the header and body of the
12042 message. Compare &$body_linecount$&, which is the count for the body only.
12043 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12044 number of lines received. Before delivery happens (that is, before filters,
12045 routers, and transports run) the count is increased to include the
12046 &'Received:'& header line that Exim standardly adds, and also any other header
12047 lines that are added by ACLs. The blank line that separates the message header
12048 from the body is not counted.
12049
12050 As with the special case of &$message_size$&, during the expansion of the
12051 appendfile transport's maildir_tag option in maildir format, the value of
12052 &$message_linecount$& is the precise size of the number of newlines in the
12053 file that has been written (minus one for the blank line between the
12054 header and the body).
12055
12056 Here is an example of the use of this variable in a DATA ACL:
12057 .code
12058 deny message   = Too many lines in message header
12059      condition = \
12060       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12061 .endd
12062 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12063 message has not yet been received.
12064
12065 .vitem &$message_size$&
12066 .cindex "size" "of message"
12067 .cindex "message" "size"
12068 .vindex "&$message_size$&"
12069 When a message is being processed, this variable contains its size in bytes. In
12070 most cases, the size includes those headers that were received with the
12071 message, but not those (such as &'Envelope-to:'&) that are added to individual
12072 deliveries as they are written. However, there is one special case: during the
12073 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12074 doing a delivery in maildir format, the value of &$message_size$& is the
12075 precise size of the file that has been written. See also
12076 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12077
12078 .cindex "RCPT" "value of &$message_size$&"
12079 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12080 contains the size supplied on the MAIL command, or -1 if no size was given. The
12081 value may not, of course, be truthful.
12082
12083 .vitem &$mime_$&&'xxx'&
12084 A number of variables whose names start with &$mime$& are
12085 available when Exim is compiled with the content-scanning extension. For
12086 details, see section &<<SECTscanmimepart>>&.
12087
12088 .vitem "&$n0$& &-- &$n9$&"
12089 These variables are counters that can be incremented by means
12090 of the &%add%& command in filter files.
12091
12092 .vitem &$original_domain$&
12093 .vindex "&$domain$&"
12094 .vindex "&$original_domain$&"
12095 When a top-level address is being processed for delivery, this contains the
12096 same value as &$domain$&. However, if a &"child"& address (for example,
12097 generated by an alias, forward, or filter file) is being processed, this
12098 variable contains the domain of the original address (lower cased). This
12099 differs from &$parent_domain$& only when there is more than one level of
12100 aliasing or forwarding. When more than one address is being delivered in a
12101 single transport run, &$original_domain$& is not set.
12102
12103 If a new address is created by means of a &%deliver%& command in a system
12104 filter, it is set up with an artificial &"parent"& address. This has the local
12105 part &'system-filter'& and the default qualify domain.
12106
12107 .vitem &$original_local_part$&
12108 .vindex "&$local_part$&"
12109 .vindex "&$original_local_part$&"
12110 When a top-level address is being processed for delivery, this contains the
12111 same value as &$local_part$&, unless a prefix or suffix was removed from the
12112 local part, because &$original_local_part$& always contains the full local
12113 part. When a &"child"& address (for example, generated by an alias, forward, or
12114 filter file) is being processed, this variable contains the full local part of
12115 the original address.
12116
12117 If the router that did the redirection processed the local part
12118 case-insensitively, the value in &$original_local_part$& is in lower case.
12119 This variable differs from &$parent_local_part$& only when there is more than
12120 one level of aliasing or forwarding. When more than one address is being
12121 delivered in a single transport run, &$original_local_part$& is not set.
12122
12123 If a new address is created by means of a &%deliver%& command in a system
12124 filter, it is set up with an artificial &"parent"& address. This has the local
12125 part &'system-filter'& and the default qualify domain.
12126
12127 .vitem &$originator_gid$&
12128 .cindex "gid (group id)" "of originating user"
12129 .cindex "sender" "gid"
12130 .vindex "&$caller_gid$&"
12131 .vindex "&$originator_gid$&"
12132 This variable contains the value of &$caller_gid$& that was set when the
12133 message was received. For messages received via the command line, this is the
12134 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12135 normally the gid of the Exim user.
12136
12137 .vitem &$originator_uid$&
12138 .cindex "uid (user id)" "of originating user"
12139 .cindex "sender" "uid"
12140 .vindex "&$caller_uid$&"
12141 .vindex "&$originaltor_uid$&"
12142 The value of &$caller_uid$& that was set when the message was received. For
12143 messages received via the command line, this is the uid of the sending user.
12144 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12145 user.
12146
12147 .vitem &$parent_domain$&
12148 .vindex "&$parent_domain$&"
12149 This variable is similar to &$original_domain$& (see
12150 above), except that it refers to the immediately preceding parent address.
12151
12152 .vitem &$parent_local_part$&
12153 .vindex "&$parent_local_part$&"
12154 This variable is similar to &$original_local_part$&
12155 (see above), except that it refers to the immediately preceding parent address.
12156
12157 .vitem &$pid$&
12158 .cindex "pid (process id)" "of current process"
12159 .vindex "&$pid$&"
12160 This variable contains the current process id.
12161
12162 .vitem &$pipe_addresses$&
12163 .cindex "filter" "transport filter"
12164 .cindex "transport" "filter"
12165 .vindex "&$pipe_addresses$&"
12166 This is not an expansion variable, but is mentioned here because the string
12167 &`$pipe_addresses`& is handled specially in the command specification for the
12168 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12169 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12170 It cannot be used in general expansion strings, and provokes an &"unknown
12171 variable"& error if encountered.
12172
12173 .vitem &$primary_hostname$&
12174 .vindex "&$primary_hostname$&"
12175 This variable contains the value set by &%primary_hostname%& in the
12176 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12177 a single-component name, Exim calls &[gethostbyname()]& (or
12178 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12179 qualified host name. See also &$smtp_active_hostname$&.
12180
12181
12182 .new
12183 .vitem &$proxy_host_address$& &&&
12184        &$proxy_host_port$& &&&
12185        &$proxy_target_address$& &&&
12186        &$proxy_target_port$& &&&
12187        &$proxy_session$&
12188 These variables are only available when built with Proxy Protocol
12189 or Socks5 support
12190 For details see chapter &<<SECTproxyInbound>>&.
12191 .wen
12192
12193 .new
12194 .vitem &$prdr_requested$&
12195 .cindex "PRDR" "variable for"
12196 This variable is set to &"yes"& if PRDR was requested by the client for the
12197 current message, otherwise &"no"&.
12198 .wen
12199
12200 .vitem &$prvscheck_address$&
12201 This variable is used in conjunction with the &%prvscheck%& expansion item,
12202 which is described in sections &<<SECTexpansionitems>>& and
12203 &<<SECTverifyPRVS>>&.
12204
12205 .vitem &$prvscheck_keynum$&
12206 This variable is used in conjunction with the &%prvscheck%& expansion item,
12207 which is described in sections &<<SECTexpansionitems>>& and
12208 &<<SECTverifyPRVS>>&.
12209
12210 .vitem &$prvscheck_result$&
12211 This variable is used in conjunction with the &%prvscheck%& expansion item,
12212 which is described in sections &<<SECTexpansionitems>>& and
12213 &<<SECTverifyPRVS>>&.
12214
12215 .vitem &$qualify_domain$&
12216 .vindex "&$qualify_domain$&"
12217 The value set for the &%qualify_domain%& option in the configuration file.
12218
12219 .vitem &$qualify_recipient$&
12220 .vindex "&$qualify_recipient$&"
12221 The value set for the &%qualify_recipient%& option in the configuration file,
12222 or if not set, the value of &$qualify_domain$&.
12223
12224 .vitem &$rcpt_count$&
12225 .vindex "&$rcpt_count$&"
12226 When a message is being received by SMTP, this variable contains the number of
12227 RCPT commands received for the current message. If this variable is used in a
12228 RCPT ACL, its value includes the current command.
12229
12230 .vitem &$rcpt_defer_count$&
12231 .vindex "&$rcpt_defer_count$&"
12232 .cindex "4&'xx'& responses" "count of"
12233 When a message is being received by SMTP, this variable contains the number of
12234 RCPT commands in the current message that have previously been rejected with a
12235 temporary (4&'xx'&) response.
12236
12237 .vitem &$rcpt_fail_count$&
12238 .vindex "&$rcpt_fail_count$&"
12239 When a message is being received by SMTP, this variable contains the number of
12240 RCPT commands in the current message that have previously been rejected with a
12241 permanent (5&'xx'&) response.
12242
12243 .vitem &$received_count$&
12244 .vindex "&$received_count$&"
12245 This variable contains the number of &'Received:'& header lines in the message,
12246 including the one added by Exim (so its value is always greater than zero). It
12247 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12248 delivering.
12249
12250 .vitem &$received_for$&
12251 .vindex "&$received_for$&"
12252 If there is only a single recipient address in an incoming message, this
12253 variable contains that address when the &'Received:'& header line is being
12254 built. The value is copied after recipient rewriting has happened, but before
12255 the &[local_scan()]& function is run.
12256
12257 .vitem &$received_ip_address$&
12258 .vindex "&$received_ip_address$&"
12259 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12260 variable is set to the address of the local IP interface, and &$received_port$&
12261 is set to the local port number. (The remote IP address and port are in
12262 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12263 the port value is -1 unless it has been set using the &%-oMi%& command line
12264 option.
12265
12266 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12267 could be used, for example, to make the file name for a TLS certificate depend
12268 on which interface and/or port is being used for the incoming connection. The
12269 values of &$received_ip_address$& and &$received_port$& are saved with any
12270 messages that are received, thus making these variables available at delivery
12271 time.
12272 For outbound connections see &$sending_ip_address$&.
12273
12274 .vitem &$received_port$&
12275 .vindex "&$received_port$&"
12276 See &$received_ip_address$&.
12277
12278 .vitem &$received_protocol$&
12279 .vindex "&$received_protocol$&"
12280 When a message is being processed, this variable contains the name of the
12281 protocol by which it was received. Most of the names used by Exim are defined
12282 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12283 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12284 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12285 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12286 connection and the client was successfully authenticated.
12287
12288 Exim uses the protocol name &"smtps"& for the case when encryption is
12289 automatically set up on connection without the use of STARTTLS (see
12290 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12291 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12292 where the client initially uses EHLO, sets up an encrypted connection using
12293 STARTTLS, and then uses HELO afterwards.
12294
12295 The &%-oMr%& option provides a way of specifying a custom protocol name for
12296 messages that are injected locally by trusted callers. This is commonly used to
12297 identify messages that are being re-injected after some kind of scanning.
12298
12299 .vitem &$received_time$&
12300 .vindex "&$received_time$&"
12301 This variable contains the date and time when the current message was received,
12302 as a number of seconds since the start of the Unix epoch.
12303
12304 .vitem &$recipient_data$&
12305 .vindex "&$recipient_data$&"
12306 This variable is set after an indexing lookup success in an ACL &%recipients%&
12307 condition. It contains the data from the lookup, and the value remains set
12308 until the next &%recipients%& test. Thus, you can do things like this:
12309 .display
12310 &`require recipients  = cdb*@;/some/file`&
12311 &`deny    `&&'some further test involving'& &`$recipient_data`&
12312 .endd
12313 &*Warning*&: This variable is set only when a lookup is used as an indexing
12314 method in the address list, using the semicolon syntax as in the example above.
12315 The variable is not set for a lookup that is used as part of the string
12316 expansion that all such lists undergo before being interpreted.
12317
12318 .vitem &$recipient_verify_failure$&
12319 .vindex "&$recipient_verify_failure$&"
12320 In an ACL, when a recipient verification fails, this variable contains
12321 information about the failure. It is set to one of the following words:
12322
12323 .ilist
12324 &"qualify"&: The address was unqualified (no domain), and the message
12325 was neither local nor came from an exempted host.
12326
12327 .next
12328 &"route"&: Routing failed.
12329
12330 .next
12331 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12332 or before the MAIL command (that is, on initial connection, HELO, or
12333 MAIL).
12334
12335 .next
12336 &"recipient"&: The RCPT command in a callout was rejected.
12337 .next
12338
12339 &"postmaster"&: The postmaster check in a callout was rejected.
12340 .endlist
12341
12342 The main use of this variable is expected to be to distinguish between
12343 rejections of MAIL and rejections of RCPT.
12344
12345 .vitem &$recipients$&
12346 .vindex "&$recipients$&"
12347 This variable contains a list of envelope recipients for a message. A comma and
12348 a space separate the addresses in the replacement text. However, the variable
12349 is not generally available, to prevent exposure of Bcc recipients in
12350 unprivileged users' filter files. You can use &$recipients$& only in these
12351 cases:
12352
12353 .olist
12354 In a system filter file.
12355 .next
12356 In the ACLs associated with the DATA command and with non-SMTP messages, that
12357 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12358 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12359 &%acl_not_smtp_mime%&.
12360 .next
12361 From within a &[local_scan()]& function.
12362 .endlist
12363
12364
12365 .vitem &$recipients_count$&
12366 .vindex "&$recipients_count$&"
12367 When a message is being processed, this variable contains the number of
12368 envelope recipients that came with the message. Duplicates are not excluded
12369 from the count. While a message is being received over SMTP, the number
12370 increases for each accepted recipient. It can be referenced in an ACL.
12371
12372
12373 .vitem &$regex_match_string$&
12374 .vindex "&$regex_match_string$&"
12375 This variable is set to contain the matching regular expression after a
12376 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12377
12378 .vitem "&$regex1$&, &$regex2$&, etc"
12379 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12380 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12381 these variables contain the
12382 captured substrings identified by the regular expression.
12383
12384
12385 .vitem &$reply_address$&
12386 .vindex "&$reply_address$&"
12387 When a message is being processed, this variable contains the contents of the
12388 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12389 contents of the &'From:'& header line. Apart from the removal of leading
12390 white space, the value is not processed in any way. In particular, no RFC 2047
12391 decoding or character code translation takes place.
12392
12393 .vitem &$return_path$&
12394 .vindex "&$return_path$&"
12395 When a message is being delivered, this variable contains the return path &--
12396 the sender field that will be sent as part of the envelope. It is not enclosed
12397 in <> characters. At the start of routing an address, &$return_path$& has the
12398 same value as &$sender_address$&, but if, for example, an incoming message to a
12399 mailing list has been expanded by a router which specifies a different address
12400 for bounce messages, &$return_path$& subsequently contains the new bounce
12401 address, whereas &$sender_address$& always contains the original sender address
12402 that was received with the message. In other words, &$sender_address$& contains
12403 the incoming envelope sender, and &$return_path$& contains the outgoing
12404 envelope sender.
12405
12406 .vitem &$return_size_limit$&
12407 .vindex "&$return_size_limit$&"
12408 This is an obsolete name for &$bounce_return_size_limit$&.
12409
12410 .vitem &$router_name$&
12411 .cindex "router" "name"
12412 .cindex "name" "of router"
12413 .vindex "&$router_name$&"
12414 During the running of a router this variable contains its name.
12415
12416 .vitem &$runrc$&
12417 .cindex "return code" "from &%run%& expansion"
12418 .vindex "&$runrc$&"
12419 This variable contains the return code from a command that is run by the
12420 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12421 assume the order in which option values are expanded, except for those
12422 preconditions whose order of testing is documented. Therefore, you cannot
12423 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12424 another.
12425
12426 .vitem &$self_hostname$&
12427 .oindex "&%self%&" "value of host name"
12428 .vindex "&$self_hostname$&"
12429 When an address is routed to a supposedly remote host that turns out to be the
12430 local host, what happens is controlled by the &%self%& generic router option.
12431 One of its values causes the address to be passed to another router. When this
12432 happens, &$self_hostname$& is set to the name of the local host that the
12433 original router encountered. In other circumstances its contents are null.
12434
12435 .vitem &$sender_address$&
12436 .vindex "&$sender_address$&"
12437 When a message is being processed, this variable contains the sender's address
12438 that was received in the message's envelope. The case of letters in the address
12439 is retained, in both the local part and the domain. For bounce messages, the
12440 value of this variable is the empty string. See also &$return_path$&.
12441
12442 .vitem &$sender_address_data$&
12443 .vindex "&$address_data$&"
12444 .vindex "&$sender_address_data$&"
12445 If &$address_data$& is set when the routers are called from an ACL to verify a
12446 sender address, the final value is preserved in &$sender_address_data$&, to
12447 distinguish it from data from a recipient address. The value does not persist
12448 after the end of the current ACL statement. If you want to preserve it for
12449 longer, you can save it in an ACL variable.
12450
12451 .vitem &$sender_address_domain$&
12452 .vindex "&$sender_address_domain$&"
12453 The domain portion of &$sender_address$&.
12454
12455 .vitem &$sender_address_local_part$&
12456 .vindex "&$sender_address_local_part$&"
12457 The local part portion of &$sender_address$&.
12458
12459 .vitem &$sender_data$&
12460 .vindex "&$sender_data$&"
12461 This variable is set after a lookup success in an ACL &%senders%& condition or
12462 in a router &%senders%& option. It contains the data from the lookup, and the
12463 value remains set until the next &%senders%& test. Thus, you can do things like
12464 this:
12465 .display
12466 &`require senders      = cdb*@;/some/file`&
12467 &`deny    `&&'some further test involving'& &`$sender_data`&
12468 .endd
12469 &*Warning*&: This variable is set only when a lookup is used as an indexing
12470 method in the address list, using the semicolon syntax as in the example above.
12471 The variable is not set for a lookup that is used as part of the string
12472 expansion that all such lists undergo before being interpreted.
12473
12474 .vitem &$sender_fullhost$&
12475 .vindex "&$sender_fullhost$&"
12476 When a message is received from a remote host, this variable contains the host
12477 name and IP address in a single string. It ends with the IP address in square
12478 brackets, followed by a colon and a port number if the logging of ports is
12479 enabled. The format of the rest of the string depends on whether the host
12480 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12481 looking up its IP address. (Looking up the IP address can be forced by the
12482 &%host_lookup%& option, independent of verification.) A plain host name at the
12483 start of the string is a verified host name; if this is not present,
12484 verification either failed or was not requested. A host name in parentheses is
12485 the argument of a HELO or EHLO command. This is omitted if it is identical to
12486 the verified host name or to the host's IP address in square brackets.
12487
12488 .vitem &$sender_helo_dnssec$&
12489 .vindex "&$sender_helo_dnssec$&"
12490 This boolean variable is true if a successful HELO verification was
12491 .cindex "DNS" "DNSSEC"
12492 done using DNS information the resolver library stated was authenticated data.
12493
12494 .vitem &$sender_helo_name$&
12495 .vindex "&$sender_helo_name$&"
12496 When a message is received from a remote host that has issued a HELO or EHLO
12497 command, the argument of that command is placed in this variable. It is also
12498 set if HELO or EHLO is used when a message is received using SMTP locally via
12499 the &%-bs%& or &%-bS%& options.
12500
12501 .vitem &$sender_host_address$&
12502 .vindex "&$sender_host_address$&"
12503 When a message is received from a remote host using SMTP,
12504 this variable contains that
12505 host's IP address. For locally non-SMTP submitted messages, it is empty.
12506
12507 .vitem &$sender_host_authenticated$&
12508 .vindex "&$sender_host_authenticated$&"
12509 This variable contains the name (not the public name) of the authenticator
12510 driver that successfully authenticated the client from which the message was
12511 received. It is empty if there was no successful authentication. See also
12512 &$authenticated_id$&.
12513
12514 .vitem &$sender_host_dnssec$&
12515 .vindex "&$sender_host_dnssec$&"
12516 If an attempt to populate &$sender_host_name$& has been made
12517 (by reference, &%hosts_lookup%& or
12518 otherwise) then this boolean will have been set true if, and only if, the
12519 resolver library states that both
12520 the reverse and forward DNS were authenticated data.  At all
12521 other times, this variable is false.
12522
12523 .cindex "DNS" "DNSSEC"
12524 It is likely that you will need to coerce DNSSEC support on in the resolver
12525 library, by setting:
12526 .code
12527 dns_dnssec_ok = 1
12528 .endd
12529
12530 Exim does not perform DNSSEC validation itself, instead leaving that to a
12531 validating resolver (e.g. unbound, or bind with suitable configuration).
12532
12533 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12534 mechanism in the list, then this variable will be false.
12535
12536
12537 .vitem &$sender_host_name$&
12538 .vindex "&$sender_host_name$&"
12539 When a message is received from a remote host, this variable contains the
12540 host's name as obtained by looking up its IP address. For messages received by
12541 other means, this variable is empty.
12542
12543 .vindex "&$host_lookup_failed$&"
12544 If the host name has not previously been looked up, a reference to
12545 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12546 A looked up name is accepted only if it leads back to the original IP address
12547 via a forward lookup. If either the reverse or the forward lookup fails to find
12548 any data, or if the forward lookup does not yield the original IP address,
12549 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12550
12551 .vindex "&$host_lookup_deferred$&"
12552 However, if either of the lookups cannot be completed (for example, there is a
12553 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12554 &$host_lookup_failed$& remains set to &"0"&.
12555
12556 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12557 host name again if there is a subsequent reference to &$sender_host_name$&
12558 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12559 is set to &"1"&.
12560
12561 Exim does not automatically look up every calling host's name. If you want
12562 maximum efficiency, you should arrange your configuration so that it avoids
12563 these lookups altogether. The lookup happens only if one or more of the
12564 following are true:
12565
12566 .ilist
12567 A string containing &$sender_host_name$& is expanded.
12568 .next
12569 The calling host matches the list in &%host_lookup%&. In the default
12570 configuration, this option is set to *, so it must be changed if lookups are
12571 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12572 .next
12573 Exim needs the host name in order to test an item in a host list. The items
12574 that require this are described in sections &<<SECThoslispatnam>>& and
12575 &<<SECThoslispatnamsk>>&.
12576 .next
12577 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12578 In this case, the host name is required to compare with the name quoted in any
12579 EHLO or HELO commands that the client issues.
12580 .next
12581 The remote host issues a EHLO or HELO command that quotes one of the
12582 domains in &%helo_lookup_domains%&. The default value of this option is
12583 . ==== As this is a nested list, any displays it contains must be indented
12584 . ==== as otherwise they are too far to the left.
12585 .code
12586   helo_lookup_domains = @ : @[]
12587 .endd
12588 which causes a lookup if a remote host (incorrectly) gives the server's name or
12589 IP address in an EHLO or HELO command.
12590 .endlist
12591
12592
12593 .vitem &$sender_host_port$&
12594 .vindex "&$sender_host_port$&"
12595 When a message is received from a remote host, this variable contains the port
12596 number that was used on the remote host.
12597
12598 .vitem &$sender_ident$&
12599 .vindex "&$sender_ident$&"
12600 When a message is received from a remote host, this variable contains the
12601 identification received in response to an RFC 1413 request. When a message has
12602 been received locally, this variable contains the login name of the user that
12603 called Exim.
12604
12605 .vitem &$sender_rate_$&&'xxx'&
12606 A number of variables whose names begin &$sender_rate_$& are set as part of the
12607 &%ratelimit%& ACL condition. Details are given in section
12608 &<<SECTratelimiting>>&.
12609
12610 .vitem &$sender_rcvhost$&
12611 .cindex "DNS" "reverse lookup"
12612 .cindex "reverse DNS lookup"
12613 .vindex "&$sender_rcvhost$&"
12614 This is provided specifically for use in &'Received:'& headers. It starts with
12615 either the verified host name (as obtained from a reverse DNS lookup) or, if
12616 there is no verified host name, the IP address in square brackets. After that
12617 there may be text in parentheses. When the first item is a verified host name,
12618 the first thing in the parentheses is the IP address in square brackets,
12619 followed by a colon and a port number if port logging is enabled. When the
12620 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12621 the parentheses.
12622
12623 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12624 was used and its argument was not identical to the real host name or IP
12625 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12626 all three items are present in the parentheses, a newline and tab are inserted
12627 into the string, to improve the formatting of the &'Received:'& header.
12628
12629 .vitem &$sender_verify_failure$&
12630 .vindex "&$sender_verify_failure$&"
12631 In an ACL, when a sender verification fails, this variable contains information
12632 about the failure. The details are the same as for
12633 &$recipient_verify_failure$&.
12634
12635 .vitem &$sending_ip_address$&
12636 .vindex "&$sending_ip_address$&"
12637 This variable is set whenever an outgoing SMTP connection to another host has
12638 been set up. It contains the IP address of the local interface that is being
12639 used. This is useful if a host that has more than one IP address wants to take
12640 on different personalities depending on which one is being used. For incoming
12641 connections, see &$received_ip_address$&.
12642
12643 .vitem &$sending_port$&
12644 .vindex "&$sending_port$&"
12645 This variable is set whenever an outgoing SMTP connection to another host has
12646 been set up. It contains the local port that is being used. For incoming
12647 connections, see &$received_port$&.
12648
12649 .vitem &$smtp_active_hostname$&
12650 .vindex "&$smtp_active_hostname$&"
12651 During an incoming SMTP session, this variable contains the value of the active
12652 host name, as specified by the &%smtp_active_hostname%& option. The value of
12653 &$smtp_active_hostname$& is saved with any message that is received, so its
12654 value can be consulted during routing and delivery.
12655
12656 .vitem &$smtp_command$&
12657 .vindex "&$smtp_command$&"
12658 During the processing of an incoming SMTP command, this variable contains the
12659 entire command. This makes it possible to distinguish between HELO and EHLO in
12660 the HELO ACL, and also to distinguish between commands such as these:
12661 .code
12662 MAIL FROM:<>
12663 MAIL FROM: <>
12664 .endd
12665 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12666 command, the address in &$smtp_command$& is the original address before any
12667 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12668 the address after SMTP-time rewriting.
12669
12670 .vitem &$smtp_command_argument$&
12671 .cindex "SMTP" "command, argument for"
12672 .vindex "&$smtp_command_argument$&"
12673 While an ACL is running to check an SMTP command, this variable contains the
12674 argument, that is, the text that follows the command name, with leading white
12675 space removed. Following the introduction of &$smtp_command$&, this variable is
12676 somewhat redundant, but is retained for backwards compatibility.
12677
12678 .vitem &$smtp_count_at_connection_start$&
12679 .vindex "&$smtp_count_at_connection_start$&"
12680 This variable is set greater than zero only in processes spawned by the Exim
12681 daemon for handling incoming SMTP connections. The name is deliberately long,
12682 in order to emphasize what the contents are. When the daemon accepts a new
12683 connection, it increments this variable. A copy of the variable is passed to
12684 the child process that handles the connection, but its value is fixed, and
12685 never changes. It is only an approximation of how many incoming connections
12686 there actually are, because many other connections may come and go while a
12687 single connection is being processed. When a child process terminates, the
12688 daemon decrements its copy of the variable.
12689
12690 .vitem "&$sn0$& &-- &$sn9$&"
12691 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12692 that were current at the end of the system filter file. This allows a system
12693 filter file to set values that can be tested in users' filter files. For
12694 example, a system filter could set a value indicating how likely it is that a
12695 message is junk mail.
12696
12697 .vitem &$spam_$&&'xxx'&
12698 A number of variables whose names start with &$spam$& are available when Exim
12699 is compiled with the content-scanning extension. For details, see section
12700 &<<SECTscanspamass>>&.
12701
12702
12703 .vitem &$spool_directory$&
12704 .vindex "&$spool_directory$&"
12705 The name of Exim's spool directory.
12706
12707 .vitem &$spool_inodes$&
12708 .vindex "&$spool_inodes$&"
12709 The number of free inodes in the disk partition where Exim's spool files are
12710 being written. The value is recalculated whenever the variable is referenced.
12711 If the relevant file system does not have the concept of inodes, the value of
12712 is -1. See also the &%check_spool_inodes%& option.
12713
12714 .vitem &$spool_space$&
12715 .vindex "&$spool_space$&"
12716 The amount of free space (as a number of kilobytes) in the disk partition where
12717 Exim's spool files are being written. The value is recalculated whenever the
12718 variable is referenced. If the operating system does not have the ability to
12719 find the amount of free space (only true for experimental systems), the space
12720 value is -1. For example, to check in an ACL that there is at least 50
12721 megabytes free on the spool, you could write:
12722 .code
12723 condition = ${if > {$spool_space}{50000}}
12724 .endd
12725 See also the &%check_spool_space%& option.
12726
12727
12728 .vitem &$thisaddress$&
12729 .vindex "&$thisaddress$&"
12730 This variable is set only during the processing of the &%foranyaddress%&
12731 command in a filter file. Its use is explained in the description of that
12732 command, which can be found in the separate document entitled &'Exim's
12733 interfaces to mail filtering'&.
12734
12735 .vitem &$tls_in_bits$&
12736 .vindex "&$tls_in_bits$&"
12737 Contains an approximation of the TLS cipher's bit-strength
12738 on the inbound connection; the meaning of
12739 this depends upon the TLS implementation used.
12740 If TLS has not been negotiated, the value will be 0.
12741 The value of this is automatically fed into the Cyrus SASL authenticator
12742 when acting as a server, to specify the "external SSF" (a SASL term).
12743
12744 The deprecated &$tls_bits$& variable refers to the inbound side
12745 except when used in the context of an outbound SMTP delivery, when it refers to
12746 the outbound.
12747
12748 .vitem &$tls_out_bits$&
12749 .vindex "&$tls_out_bits$&"
12750 Contains an approximation of the TLS cipher's bit-strength
12751 on an outbound SMTP connection; the meaning of
12752 this depends upon the TLS implementation used.
12753 If TLS has not been negotiated, the value will be 0.
12754
12755 .vitem &$tls_in_ourcert$&
12756 .vindex "&$tls_in_ourcert$&"
12757 .cindex certificate veriables
12758 This variable refers to the certificate presented to the peer of an
12759 inbound connection when the message was received.
12760 It is only useful as the argument of a
12761 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12762 or a &%def%& condition.
12763
12764 .vitem &$tls_in_peercert$&
12765 .vindex "&$tls_in_peercert$&"
12766 This variable refers to the certificate presented by the peer of an
12767 inbound connection when the message was received.
12768 It is only useful as the argument of a
12769 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12770 or a &%def%& condition.
12771 If certificate verification fails it may refer to a failing chain element
12772 which is not the leaf.
12773
12774 .vitem &$tls_out_ourcert$&
12775 .vindex "&$tls_out_ourcert$&"
12776 This variable refers to the certificate presented to the peer of an
12777 outbound connection.  It is only useful as the argument of a
12778 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12779 or a &%def%& condition.
12780
12781 .vitem &$tls_out_peercert$&
12782 .vindex "&$tls_out_peercert$&"
12783 This variable refers to the certificate presented by the peer of an
12784 outbound connection.  It is only useful as the argument of a
12785 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12786 or a &%def%& condition.
12787 If certificate verification fails it may refer to a failing chain element
12788 which is not the leaf.
12789
12790 .vitem &$tls_in_certificate_verified$&
12791 .vindex "&$tls_in_certificate_verified$&"
12792 This variable is set to &"1"& if a TLS certificate was verified when the
12793 message was received, and &"0"& otherwise.
12794
12795 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12796 except when used in the context of an outbound SMTP delivery, when it refers to
12797 the outbound.
12798
12799 .vitem &$tls_out_certificate_verified$&
12800 .vindex "&$tls_out_certificate_verified$&"
12801 This variable is set to &"1"& if a TLS certificate was verified when an
12802 outbound SMTP connection was made,
12803 and &"0"& otherwise.
12804
12805 .vitem &$tls_in_cipher$&
12806 .vindex "&$tls_in_cipher$&"
12807 .vindex "&$tls_cipher$&"
12808 When a message is received from a remote host over an encrypted SMTP
12809 connection, this variable is set to the cipher suite that was negotiated, for
12810 example DES-CBC3-SHA. In other circumstances, in particular, for message
12811 received over unencrypted connections, the variable is empty. Testing
12812 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12813 non-encrypted connections during ACL processing.
12814
12815 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12816 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12817 becomes the same as &$tls_out_cipher$&.
12818
12819 .vitem &$tls_out_cipher$&
12820 .vindex "&$tls_out_cipher$&"
12821 This variable is
12822 cleared before any outgoing SMTP connection is made,
12823 and then set to the outgoing cipher suite if one is negotiated. See chapter
12824 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12825 details of the &(smtp)& transport.
12826
12827 .vitem &$tls_in_ocsp$&
12828 .vindex "&$tls_in_ocsp$&"
12829 When a message is received from a remote client connection
12830 the result of any OCSP request from the client is encoded in this variable:
12831 .code
12832 0 OCSP proof was not requested (default value)
12833 1 No response to request
12834 2 Response not verified
12835 3 Verification failed
12836 4 Verification succeeded
12837 .endd
12838
12839 .vitem &$tls_out_ocsp$&
12840 .vindex "&$tls_out_ocsp$&"
12841 When a message is sent to a remote host connection
12842 the result of any OCSP request made is encoded in this variable.
12843 See &$tls_in_ocsp$& for values.
12844
12845 .vitem &$tls_in_peerdn$&
12846 .vindex "&$tls_in_peerdn$&"
12847 .vindex "&$tls_peerdn$&"
12848 .cindex certificate "extracting fields"
12849 When a message is received from a remote host over an encrypted SMTP
12850 connection, and Exim is configured to request a certificate from the client,
12851 the value of the Distinguished Name of the certificate is made available in the
12852 &$tls_in_peerdn$& during subsequent processing.
12853 If certificate verification fails it may refer to a failing chain element
12854 which is not the leaf.
12855
12856 The deprecated &$tls_peerdn$& variable refers to the inbound side
12857 except when used in the context of an outbound SMTP delivery, when it refers to
12858 the outbound.
12859
12860 .vitem &$tls_out_peerdn$&
12861 .vindex "&$tls_out_peerdn$&"
12862 When a message is being delivered to a remote host over an encrypted SMTP
12863 connection, and Exim is configured to request a certificate from the server,
12864 the value of the Distinguished Name of the certificate is made available in the
12865 &$tls_out_peerdn$& during subsequent processing.
12866 If certificate verification fails it may refer to a failing chain element
12867 which is not the leaf.
12868
12869 .vitem &$tls_in_sni$&
12870 .vindex "&$tls_in_sni$&"
12871 .vindex "&$tls_sni$&"
12872 .cindex "TLS" "Server Name Indication"
12873 When a TLS session is being established, if the client sends the Server
12874 Name Indication extension, the value will be placed in this variable.
12875 If the variable appears in &%tls_certificate%& then this option and
12876 some others, described in &<<SECTtlssni>>&,
12877 will be re-expanded early in the TLS session, to permit
12878 a different certificate to be presented (and optionally a different key to be
12879 used) to the client, based upon the value of the SNI extension.
12880
12881 The deprecated &$tls_sni$& variable refers to the inbound side
12882 except when used in the context of an outbound SMTP delivery, when it refers to
12883 the outbound.
12884
12885 .vitem &$tls_out_sni$&
12886 .vindex "&$tls_out_sni$&"
12887 .cindex "TLS" "Server Name Indication"
12888 During outbound
12889 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12890 the transport.
12891
12892 .vitem &$tod_bsdinbox$&
12893 .vindex "&$tod_bsdinbox$&"
12894 The time of day and the date, in the format required for BSD-style mailbox
12895 files, for example: Thu Oct 17 17:14:09 1995.
12896
12897 .vitem &$tod_epoch$&
12898 .vindex "&$tod_epoch$&"
12899 The time and date as a number of seconds since the start of the Unix epoch.
12900
12901 .vitem &$tod_epoch_l$&
12902 .vindex "&$tod_epoch_l$&"
12903 The time and date as a number of microseconds since the start of the Unix epoch.
12904
12905 .vitem &$tod_full$&
12906 .vindex "&$tod_full$&"
12907 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12908 +0100. The timezone is always given as a numerical offset from UTC, with
12909 positive values used for timezones that are ahead (east) of UTC, and negative
12910 values for those that are behind (west).
12911
12912 .vitem &$tod_log$&
12913 .vindex "&$tod_log$&"
12914 The time and date in the format used for writing Exim's log files, for example:
12915 1995-10-12 15:32:29, but without a timezone.
12916
12917 .vitem &$tod_logfile$&
12918 .vindex "&$tod_logfile$&"
12919 This variable contains the date in the format yyyymmdd. This is the format that
12920 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12921 flag.
12922
12923 .vitem &$tod_zone$&
12924 .vindex "&$tod_zone$&"
12925 This variable contains the numerical value of the local timezone, for example:
12926 -0500.
12927
12928 .vitem &$tod_zulu$&
12929 .vindex "&$tod_zulu$&"
12930 This variable contains the UTC date and time in &"Zulu"& format, as specified
12931 by ISO 8601, for example: 20030221154023Z.
12932
12933 .vitem &$transport_name$&
12934 .cindex "transport" "name"
12935 .cindex "name" "of transport"
12936 .vindex "&$transport_name$&"
12937 During the running of a transport, this variable contains its name.
12938
12939 .vitem &$value$&
12940 .vindex "&$value$&"
12941 This variable contains the result of an expansion lookup, extraction operation,
12942 or external command, as described above. It is also used during a
12943 &*reduce*& expansion.
12944
12945 .vitem &$verify_mode$&
12946 .vindex "&$verify_mode$&"
12947 While a router or transport is being run in verify mode
12948 or for cutthrough delivery,
12949 contains "S" for sender-verification or "R" for recipient-verification.
12950 Otherwise, empty.
12951
12952 .vitem &$version_number$&
12953 .vindex "&$version_number$&"
12954 The version number of Exim.
12955
12956 .vitem &$warn_message_delay$&
12957 .vindex "&$warn_message_delay$&"
12958 This variable is set only during the creation of a message warning about a
12959 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12960
12961 .vitem &$warn_message_recipients$&
12962 .vindex "&$warn_message_recipients$&"
12963 This variable is set only during the creation of a message warning about a
12964 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12965 .endlist
12966 .ecindex IIDstrexp
12967
12968
12969
12970 . ////////////////////////////////////////////////////////////////////////////
12971 . ////////////////////////////////////////////////////////////////////////////
12972
12973 .chapter "Embedded Perl" "CHAPperl"
12974 .scindex IIDperl "Perl" "calling from Exim"
12975 Exim can be built to include an embedded Perl interpreter. When this is done,
12976 Perl subroutines can be called as part of the string expansion process. To make
12977 use of the Perl support, you need version 5.004 or later of Perl installed on
12978 your system. To include the embedded interpreter in the Exim binary, include
12979 the line
12980 .code
12981 EXIM_PERL = perl.o
12982 .endd
12983 in your &_Local/Makefile_& and then build Exim in the normal way.
12984
12985
12986 .section "Setting up so Perl can be used" "SECID85"
12987 .oindex "&%perl_startup%&"
12988 Access to Perl subroutines is via a global configuration option called
12989 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12990 no &%perl_startup%& option in the Exim configuration file then no Perl
12991 interpreter is started and there is almost no overhead for Exim (since none of
12992 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12993 option then the associated value is taken to be Perl code which is executed in
12994 a newly created Perl interpreter.
12995
12996 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12997 need backslashes before any characters to escape special meanings. The option
12998 should usually be something like
12999 .code
13000 perl_startup = do '/etc/exim.pl'
13001 .endd
13002 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13003 use from Exim. Exim can be configured either to start up a Perl interpreter as
13004 soon as it is entered, or to wait until the first time it is needed. Starting
13005 the interpreter at the beginning ensures that it is done while Exim still has
13006 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13007 fact used in a particular run. Also, note that this does not mean that Exim is
13008 necessarily running as root when Perl is called at a later time. By default,
13009 the interpreter is started only when it is needed, but this can be changed in
13010 two ways:
13011
13012 .ilist
13013 .oindex "&%perl_at_start%&"
13014 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13015 a startup when Exim is entered.
13016 .next
13017 The command line option &%-ps%& also requests a startup when Exim is entered,
13018 overriding the setting of &%perl_at_start%&.
13019 .endlist
13020
13021 There is also a command line option &%-pd%& (for delay) which suppresses the
13022 initial startup, even if &%perl_at_start%& is set.
13023
13024
13025 .section "Calling Perl subroutines" "SECID86"
13026 When the configuration file includes a &%perl_startup%& option you can make use
13027 of the string expansion item to call the Perl subroutines that are defined
13028 by the &%perl_startup%& code. The operator is used in any of the following
13029 forms:
13030 .code
13031 ${perl{foo}}
13032 ${perl{foo}{argument}}
13033 ${perl{foo}{argument1}{argument2} ... }
13034 .endd
13035 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13036 arguments may be passed. Passing more than this results in an expansion failure
13037 with an error message of the form
13038 .code
13039 Too many arguments passed to Perl subroutine "foo" (max is 8)
13040 .endd
13041 The return value of the Perl subroutine is evaluated in a scalar context before
13042 it is passed back to Exim to be inserted into the expanded string. If the
13043 return value is &'undef'&, the expansion is forced to fail in the same way as
13044 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13045 by obeying Perl's &%die%& function, the expansion fails with the error message
13046 that was passed to &%die%&.
13047
13048
13049 .section "Calling Exim functions from Perl" "SECID87"
13050 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13051 is available to call back into Exim's string expansion function. For example,
13052 the Perl code
13053 .code
13054 my $lp = Exim::expand_string('$local_part');
13055 .endd
13056 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13057 Note those are single quotes and not double quotes to protect against
13058 &$local_part$& being interpolated as a Perl variable.
13059
13060 If the string expansion is forced to fail by a &"fail"& item, the result of
13061 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13062 expansion string, the Perl call from the original expansion string fails with
13063 an appropriate error message, in the same way as if &%die%& were used.
13064
13065 .cindex "debugging" "from embedded Perl"
13066 .cindex "log" "writing from embedded Perl"
13067 Two other Exim functions are available for use from within Perl code.
13068 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13069 debugging is enabled. If you want a newline at the end, you must supply it.
13070 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13071 timestamp. In this case, you should not supply a terminating newline.
13072
13073
13074 .section "Use of standard output and error by Perl" "SECID88"
13075 .cindex "Perl" "standard output and error"
13076 You should not write to the standard error or output streams from within your
13077 Perl code, as it is not defined how these are set up. In versions of Exim
13078 before 4.50, it is possible for the standard output or error to refer to the
13079 SMTP connection during message reception via the daemon. Writing to this stream
13080 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13081 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13082 avoided, but the output is lost.
13083
13084 .cindex "Perl" "use of &%warn%&"
13085 The Perl &%warn%& statement writes to the standard error stream by default.
13086 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13087 you have no control. When Exim starts up the Perl interpreter, it arranges for
13088 output from the &%warn%& statement to be written to the Exim main log. You can
13089 change this by including appropriate Perl magic somewhere in your Perl code.
13090 For example, to discard &%warn%& output completely, you need this:
13091 .code
13092 $SIG{__WARN__} = sub { };
13093 .endd
13094 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13095 example, the code for the subroutine is empty, so it does nothing, but you can
13096 include any Perl code that you like. The text of the &%warn%& message is passed
13097 as the first subroutine argument.
13098 .ecindex IIDperl
13099
13100
13101 . ////////////////////////////////////////////////////////////////////////////
13102 . ////////////////////////////////////////////////////////////////////////////
13103
13104 .chapter "Starting the daemon and the use of network interfaces" &&&
13105          "CHAPinterfaces" &&&
13106          "Starting the daemon"
13107 .cindex "daemon" "starting"
13108 .cindex "interface" "listening"
13109 .cindex "network interface"
13110 .cindex "interface" "network"
13111 .cindex "IP address" "for listening"
13112 .cindex "daemon" "listening IP addresses"
13113 .cindex "TCP/IP" "setting listening interfaces"
13114 .cindex "TCP/IP" "setting listening ports"
13115 A host that is connected to a TCP/IP network may have one or more physical
13116 hardware network interfaces. Each of these interfaces may be configured as one
13117 or more &"logical"& interfaces, which are the entities that a program actually
13118 works with. Each of these logical interfaces is associated with an IP address.
13119 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13120 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13121 knowledge about the host's interfaces for use in three different circumstances:
13122
13123 .olist
13124 When a listening daemon is started, Exim needs to know which interfaces
13125 and ports to listen on.
13126 .next
13127 When Exim is routing an address, it needs to know which IP addresses
13128 are associated with local interfaces. This is required for the correct
13129 processing of MX lists by removing the local host and others with the
13130 same or higher priority values. Also, Exim needs to detect cases
13131 when an address is routed to an IP address that in fact belongs to the
13132 local host. Unless the &%self%& router option or the &%allow_localhost%&
13133 option of the smtp transport is set (as appropriate), this is treated
13134 as an error situation.
13135 .next
13136 When Exim connects to a remote host, it may need to know which interface to use
13137 for the outgoing connection.
13138 .endlist
13139
13140
13141 Exim's default behaviour is likely to be appropriate in the vast majority
13142 of cases. If your host has only one interface, and you want all its IP
13143 addresses to be treated in the same way, and you are using only the
13144 standard SMTP port, you should not need to take any special action. The
13145 rest of this chapter does not apply to you.
13146
13147 In a more complicated situation you may want to listen only on certain
13148 interfaces, or on different ports, and for this reason there are a number of
13149 options that can be used to influence Exim's behaviour. The rest of this
13150 chapter describes how they operate.
13151
13152 When a message is received over TCP/IP, the interface and port that were
13153 actually used are set in &$received_ip_address$& and &$received_port$&.
13154
13155
13156
13157 .section "Starting a listening daemon" "SECID89"
13158 When a listening daemon is started (by means of the &%-bd%& command line
13159 option), the interfaces and ports on which it listens are controlled by the
13160 following options:
13161
13162 .ilist
13163 &%daemon_smtp_ports%& contains a list of default ports
13164 or service names.
13165 (For backward compatibility, this option can also be specified in the singular.)
13166 .next
13167 &%local_interfaces%& contains list of interface IP addresses on which to
13168 listen. Each item may optionally also specify a port.
13169 .endlist
13170
13171 The default list separator in both cases is a colon, but this can be changed as
13172 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13173 it is usually best to change the separator to avoid having to double all the
13174 colons. For example:
13175 .code
13176 local_interfaces = <; 127.0.0.1 ; \
13177                       192.168.23.65 ; \
13178                       ::1 ; \
13179                       3ffe:ffff:836f::fe86:a061
13180 .endd
13181 There are two different formats for specifying a port along with an IP address
13182 in &%local_interfaces%&:
13183
13184 .olist
13185 The port is added onto the address with a dot separator. For example, to listen
13186 on port 1234 on two different IP addresses:
13187 .code
13188 local_interfaces = <; 192.168.23.65.1234 ; \
13189                       3ffe:ffff:836f::fe86:a061.1234
13190 .endd
13191 .next
13192 The IP address is enclosed in square brackets, and the port is added
13193 with a colon separator, for example:
13194 .code
13195 local_interfaces = <; [192.168.23.65]:1234 ; \
13196                       [3ffe:ffff:836f::fe86:a061]:1234
13197 .endd
13198 .endlist
13199
13200 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13201 default setting contains just one port:
13202 .code
13203 daemon_smtp_ports = smtp
13204 .endd
13205 If more than one port is listed, each interface that does not have its own port
13206 specified listens on all of them. Ports that are listed in
13207 &%daemon_smtp_ports%& can be identified either by name (defined in
13208 &_/etc/services_&) or by number. However, when ports are given with individual
13209 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13210
13211
13212
13213 .section "Special IP listening addresses" "SECID90"
13214 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13215 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13216 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13217 instead of setting up separate listening sockets for each interface. The
13218 default value of &%local_interfaces%& is
13219 .code
13220 local_interfaces = 0.0.0.0
13221 .endd
13222 when Exim is built without IPv6 support; otherwise it is:
13223 .code
13224 local_interfaces = <; ::0 ; 0.0.0.0
13225 .endd
13226 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13227
13228
13229
13230 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13231 The &%-oX%& command line option can be used to override the values of
13232 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13233 instance. Another way of doing this would be to use macros and the &%-D%&
13234 option. However, &%-oX%& can be used by any admin user, whereas modification of
13235 the runtime configuration by &%-D%& is allowed only when the caller is root or
13236 exim.
13237
13238 The value of &%-oX%& is a list of items. The default colon separator can be
13239 changed in the usual way if required. If there are any items that do not
13240 contain dots or colons (that is, are not IP addresses), the value of
13241 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13242 items that do contain dots or colons, the value of &%local_interfaces%& is
13243 replaced by those items. Thus, for example,
13244 .code
13245 -oX 1225
13246 .endd
13247 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13248 whereas
13249 .code
13250 -oX 192.168.34.5.1125
13251 .endd
13252 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13253 (However, since &%local_interfaces%& now contains no items without ports, the
13254 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13255
13256
13257
13258 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13259 .cindex "ssmtp protocol"
13260 .cindex "smtps protocol"
13261 .cindex "SMTP" "ssmtp protocol"
13262 .cindex "SMTP" "smtps protocol"
13263 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13264 before the STARTTLS command was standardized for SMTP. Some legacy clients
13265 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13266 list of port numbers or service names,
13267 connections to those ports must use SSMTP. The most
13268 common use of this option is expected to be
13269 .code
13270 tls_on_connect_ports = 465
13271 .endd
13272 because 465 is the usual port number used by the legacy clients. There is also
13273 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13274 this way when a daemon is started.
13275
13276 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13277 daemon to listen on those ports. You must still specify them in
13278 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13279 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13280 connections via the daemon.)
13281
13282
13283
13284
13285 .section "IPv6 address scopes" "SECID92"
13286 .cindex "IPv6" "address scopes"
13287 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13288 can, in principle, have the same link-local IPv6 address on different
13289 interfaces. Thus, additional information is needed, over and above the IP
13290 address, to distinguish individual interfaces. A convention of using a
13291 percent sign followed by something (often the interface name) has been
13292 adopted in some cases, leading to addresses like this:
13293 .code
13294 fe80::202:b3ff:fe03:45c1%eth0
13295 .endd
13296 To accommodate this usage, a percent sign followed by an arbitrary string is
13297 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13298 to convert a textual IPv6 address for actual use. This function recognizes the
13299 percent convention in operating systems that support it, and it processes the
13300 address appropriately. Unfortunately, some older libraries have problems with
13301 &[getaddrinfo()]&. If
13302 .code
13303 IPV6_USE_INET_PTON=yes
13304 .endd
13305 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13306 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13307 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13308 function.) Of course, this means that the additional functionality of
13309 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13310
13311 .section "Disabling IPv6" "SECID93"
13312 .cindex "IPv6" "disabling"
13313 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13314 run on a host whose kernel does not support IPv6. The binary will fall back to
13315 using IPv4, but it may waste resources looking up AAAA records, and trying to
13316 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13317 .oindex "&%disable_ipv6%&"
13318 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13319 activities take place. AAAA records are never looked up, and any IPv6 addresses
13320 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13321 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13322 to handle IPv6 literal addresses.
13323
13324 On the other hand, when IPv6 is in use, there may be times when you want to
13325 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13326 option to globally suppress the lookup of AAAA records for specified domains,
13327 and you can use the &%ignore_target_hosts%& generic router option to ignore
13328 IPv6 addresses in an individual router.
13329
13330
13331
13332 .section "Examples of starting a listening daemon" "SECID94"
13333 The default case in an IPv6 environment is
13334 .code
13335 daemon_smtp_ports = smtp
13336 local_interfaces = <; ::0 ; 0.0.0.0
13337 .endd
13338 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13339 Either one or two sockets may be used, depending on the characteristics of
13340 the TCP/IP stack. (This is complicated and messy; for more information,
13341 read the comments in the &_daemon.c_& source file.)
13342
13343 To specify listening on ports 25 and 26 on all interfaces:
13344 .code
13345 daemon_smtp_ports = 25 : 26
13346 .endd
13347 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13348 .code
13349 local_interfaces = <; ::0.25     ; ::0.26 \
13350                       0.0.0.0.25 ; 0.0.0.0.26
13351 .endd
13352 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13353 IPv4 loopback address only:
13354 .code
13355 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13356 .endd
13357 To specify listening on the default port on specific interfaces only:
13358 .code
13359 local_interfaces = 10.0.0.67 : 192.168.34.67
13360 .endd
13361 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13362
13363
13364
13365 .section "Recognizing the local host" "SECTreclocipadd"
13366 The &%local_interfaces%& option is also used when Exim needs to determine
13367 whether or not an IP address refers to the local host. That is, the IP
13368 addresses of all the interfaces on which a daemon is listening are always
13369 treated as local.
13370
13371 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13372 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13373 available interfaces from the operating system, and extracts the relevant
13374 (that is, IPv4 or IPv6) addresses to use for checking.
13375
13376 Some systems set up large numbers of virtual interfaces in order to provide
13377 many virtual web servers. In this situation, you may want to listen for
13378 email on only a few of the available interfaces, but nevertheless treat all
13379 interfaces as local when routing. You can do this by setting
13380 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13381 &"all"& wildcard values. These addresses are recognized as local, but are not
13382 used for listening. Consider this example:
13383 .code
13384 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13385                       192.168.53.235 ; \
13386                       3ffe:2101:12:1:a00:20ff:fe86:a061
13387
13388 extra_local_interfaces = <; ::0 ; 0.0.0.0
13389 .endd
13390 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13391 address, but all available interface addresses are treated as local when
13392 Exim is routing.
13393
13394 In some environments the local host name may be in an MX list, but with an IP
13395 address that is not assigned to any local interface. In other cases it may be
13396 desirable to treat other host names as if they referred to the local host. Both
13397 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13398 This contains host names rather than IP addresses. When a host is referenced
13399 during routing, either via an MX record or directly, it is treated as the local
13400 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13401 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13402
13403
13404
13405 .section "Delivering to a remote host" "SECID95"
13406 Delivery to a remote host is handled by the smtp transport. By default, it
13407 allows the system's TCP/IP functions to choose which interface to use (if
13408 there is more than one) when connecting to a remote host. However, the
13409 &%interface%& option can be set to specify which interface is used. See the
13410 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13411 details.
13412
13413
13414
13415
13416 . ////////////////////////////////////////////////////////////////////////////
13417 . ////////////////////////////////////////////////////////////////////////////
13418
13419 .chapter "Main configuration" "CHAPmainconfig"
13420 .scindex IIDconfima "configuration file" "main section"
13421 .scindex IIDmaiconf "main configuration"
13422 The first part of the run time configuration file contains three types of item:
13423
13424 .ilist
13425 Macro definitions: These lines start with an upper case letter. See section
13426 &<<SECTmacrodefs>>& for details of macro processing.
13427 .next
13428 Named list definitions: These lines start with one of the words &"domainlist"&,
13429 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13430 section &<<SECTnamedlists>>&.
13431 .next
13432 Main configuration settings: Each setting occupies one line of the file
13433 (with possible continuations). If any setting is preceded by the word
13434 &"hide"&, the &%-bP%& command line option displays its value to admin users
13435 only. See section &<<SECTcos>>& for a description of the syntax of these option
13436 settings.
13437 .endlist
13438
13439 This chapter specifies all the main configuration options, along with their
13440 types and default values. For ease of finding a particular option, they appear
13441 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13442 are now so many options, they are first listed briefly in functional groups, as
13443 an aid to finding the name of the option you are looking for. Some options are
13444 listed in more than one group.
13445
13446 .section "Miscellaneous" "SECID96"
13447 .table2
13448 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13449 .row &%disable_ipv6%&                "do no IPv6 processing"
13450 .row &%keep_malformed%&              "for broken files &-- should not happen"
13451 .row &%localhost_number%&            "for unique message ids in clusters"
13452 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13453 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13454 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13455 .row &%print_topbitchars%&           "top-bit characters are printing"
13456 .row &%timezone%&                    "force time zone"
13457 .endtable
13458
13459
13460 .section "Exim parameters" "SECID97"
13461 .table2
13462 .row &%exim_group%&                  "override compiled-in value"
13463 .row &%exim_path%&                   "override compiled-in value"
13464 .row &%exim_user%&                   "override compiled-in value"
13465 .row &%primary_hostname%&            "default from &[uname()]&"
13466 .row &%split_spool_directory%&       "use multiple directories"
13467 .row &%spool_directory%&             "override compiled-in value"
13468 .endtable
13469
13470
13471
13472 .section "Privilege controls" "SECID98"
13473 .table2
13474 .row &%admin_groups%&                "groups that are Exim admin users"
13475 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13476 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13477 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13478 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13479 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13480 .row &%never_users%&                 "do not run deliveries as these"
13481 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13482 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13483 .row &%trusted_groups%&              "groups that are trusted"
13484 .row &%trusted_users%&               "users that are trusted"
13485 .endtable
13486
13487
13488
13489 .section "Logging" "SECID99"
13490 .table2
13491 .row &%event_action%&                "custom logging"
13492 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13493 .row &%log_file_path%&               "override compiled-in value"
13494 .row &%log_selector%&                "set/unset optional logging"
13495 .row &%log_timezone%&                "add timezone to log lines"
13496 .row &%message_logs%&                "create per-message logs"
13497 .row &%preserve_message_logs%&       "after message completion"
13498 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13499 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13500 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13501 .row &%syslog_facility%&             "set syslog &""facility""& field"
13502 .row &%syslog_processname%&          "set syslog &""ident""& field"
13503 .row &%syslog_timestamp%&            "timestamp syslog lines"
13504 .row &%write_rejectlog%&             "control use of message log"
13505 .endtable
13506
13507
13508
13509 .section "Frozen messages" "SECID100"
13510 .table2
13511 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13512 .row &%freeze_tell%&                 "send message when freezing"
13513 .row &%move_frozen_messages%&        "to another directory"
13514 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13515 .endtable
13516
13517
13518
13519 .section "Data lookups" "SECID101"
13520 .table2
13521 .row &%ibase_servers%&               "InterBase servers"
13522 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13523 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13524 .row &%ldap_cert_file%&              "client cert file for LDAP"
13525 .row &%ldap_cert_key%&               "client key file for LDAP"
13526 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13527 .row &%ldap_default_servers%&        "used if no server in query"
13528 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13529 .row &%ldap_start_tls%&              "require TLS within LDAP"
13530 .row &%ldap_version%&                "set protocol version"
13531 .row &%lookup_open_max%&             "lookup files held open"
13532 .row &%mysql_servers%&               "default MySQL servers"
13533 .row &%oracle_servers%&              "Oracle servers"
13534 .row &%pgsql_servers%&               "default PostgreSQL servers"
13535 .row &%sqlite_lock_timeout%&         "as it says"
13536 .endtable
13537
13538
13539
13540 .section "Message ids" "SECID102"
13541 .table2
13542 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13543 .row &%message_id_header_text%&      "ditto"
13544 .endtable
13545
13546
13547
13548 .section "Embedded Perl Startup" "SECID103"
13549 .table2
13550 .row &%perl_at_start%&               "always start the interpreter"
13551 .row &%perl_startup%&                "code to obey when starting Perl"
13552 .endtable
13553
13554
13555
13556 .section "Daemon" "SECID104"
13557 .table2
13558 .row &%daemon_smtp_ports%&           "default ports"
13559 .row &%daemon_startup_retries%&      "number of times to retry"
13560 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13561 .row &%extra_local_interfaces%&      "not necessarily listened on"
13562 .row &%local_interfaces%&            "on which to listen, with optional ports"
13563 .row &%pid_file_path%&               "override compiled-in value"
13564 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13565 .endtable
13566
13567
13568
13569 .section "Resource control" "SECID105"
13570 .table2
13571 .row &%check_log_inodes%&            "before accepting a message"
13572 .row &%check_log_space%&             "before accepting a message"
13573 .row &%check_spool_inodes%&          "before accepting a message"
13574 .row &%check_spool_space%&           "before accepting a message"
13575 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13576 .row &%queue_only_load%&             "queue incoming if load high"
13577 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13578 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13579 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13580 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13581 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13582 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13583 .row &%smtp_accept_max_per_connection%& "messages per connection"
13584 .row &%smtp_accept_max_per_host%&    "connections from one host"
13585 .row &%smtp_accept_queue%&           "queue mail if more connections"
13586 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13587                                            connection"
13588 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13589 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13590 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13591 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13592 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13593 .endtable
13594
13595
13596
13597 .section "Policy controls" "SECID106"
13598 .table2
13599 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13600 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13601 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13602 .row &%acl_smtp_auth%&               "ACL for AUTH"
13603 .row &%acl_smtp_connect%&            "ACL for connection"
13604 .row &%acl_smtp_data%&               "ACL for DATA"
13605 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13606 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13607 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13608 .row &%acl_smtp_expn%&               "ACL for EXPN"
13609 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13610 .row &%acl_smtp_mail%&               "ACL for MAIL"
13611 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13612 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13613 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13614 .row &%acl_smtp_predata%&            "ACL for start of data"
13615 .row &%acl_smtp_quit%&               "ACL for QUIT"
13616 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13617 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13618 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13619 .row &%av_scanner%&                  "specify virus scanner"
13620 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13621                                       words""&"
13622 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13623 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13624 .row &%header_maxsize%&              "total size of message header"
13625 .row &%header_line_maxsize%&         "individual header line limit"
13626 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13627 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13628 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13629 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13630 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13631 .row &%host_lookup%&                 "host name looked up for these hosts"
13632 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13633 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13634 .row &%host_reject_connection%&      "reject connection from these hosts"
13635 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13636 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13637 .row &%message_size_limit%&          "for all messages"
13638 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13639 .row &%spamd_address%&               "set interface to SpamAssassin"
13640 .row &%strict_acl_vars%&             "object to unset ACL variables"
13641 .endtable
13642
13643
13644
13645 .section "Callout cache" "SECID107"
13646 .table2
13647 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13648                                          item"
13649 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13650                                          item"
13651 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13652 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13653 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13654 .endtable
13655
13656
13657
13658 .section "TLS" "SECID108"
13659 .table2
13660 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13661 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13662 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13663 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13664 .row &%tls_certificate%&             "location of server certificate"
13665 .row &%tls_crl%&                     "certificate revocation list"
13666 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13667 .row &%tls_dhparam%&                 "DH parameters for server"
13668 .row &%tls_eccurve%&                 "EC curve selection for server"
13669 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13670 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13671 .row &%tls_privatekey%&              "location of server private key"
13672 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13673 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13674 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13675 .row &%tls_verify_certificates%&     "expected client certificates"
13676 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13677 .endtable
13678
13679
13680
13681 .section "Local user handling" "SECID109"
13682 .table2
13683 .row &%finduser_retries%&            "useful in NIS environments"
13684 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13685 .row &%gecos_pattern%&               "ditto"
13686 .row &%max_username_length%&         "for systems that truncate"
13687 .row &%unknown_login%&               "used when no login name found"
13688 .row &%unknown_username%&            "ditto"
13689 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13690 .row &%uucp_from_sender%&            "ditto"
13691 .endtable
13692
13693
13694
13695 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13696 .table2
13697 .row &%header_maxsize%&              "total size of message header"
13698 .row &%header_line_maxsize%&         "individual header line limit"
13699 .row &%message_size_limit%&          "applies to all messages"
13700 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13701 .row &%received_header_text%&        "expanded to make &'Received:'&"
13702 .row &%received_headers_max%&        "for mail loop detection"
13703 .row &%recipients_max%&              "limit per message"
13704 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13705 .endtable
13706
13707
13708
13709
13710 .section "Non-SMTP incoming messages" "SECID111"
13711 .table2
13712 .row &%receive_timeout%&             "for non-SMTP messages"
13713 .endtable
13714
13715
13716
13717
13718
13719 .section "Incoming SMTP messages" "SECID112"
13720 See also the &'Policy controls'& section above.
13721
13722 .table2
13723 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13724 .row &%host_lookup%&                 "host name looked up for these hosts"
13725 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13726 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13727 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13728 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13729 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13730 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13731 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13732 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13733 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13734 .row &%smtp_accept_max_per_connection%& "messages per connection"
13735 .row &%smtp_accept_max_per_host%&    "connections from one host"
13736 .row &%smtp_accept_queue%&           "queue mail if more connections"
13737 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13738                                            connection"
13739 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13740 .row &%smtp_active_hostname%&        "host name to use in messages"
13741 .row &%smtp_banner%&                 "text for welcome banner"
13742 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13743 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13744 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13745 .row &%smtp_etrn_command%&           "what to run for ETRN"
13746 .row &%smtp_etrn_serialize%&         "only one at once"
13747 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13748 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13749 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13750 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13751 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13752 .row &%smtp_receive_timeout%&        "per command or data line"
13753 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13754 .row &%smtp_return_error_details%&   "give detail on rejections"
13755 .endtable
13756
13757
13758
13759 .section "SMTP extensions" "SECID113"
13760 .table2
13761 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13762 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13763 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13764 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13765 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13766 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13767 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13768 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13769 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13770 .endtable
13771
13772
13773
13774 .section "Processing messages" "SECID114"
13775 .table2
13776 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13777 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13778 .row &%allow_utf8_domains%&          "in addresses"
13779 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13780                                       words""&"
13781 .row &%delivery_date_remove%&        "from incoming messages"
13782 .row &%envelope_to_remove%&          "from incoming messages"
13783 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13784 .row &%headers_charset%&             "default for translations"
13785 .row &%qualify_domain%&              "default for senders"
13786 .row &%qualify_recipient%&           "default for recipients"
13787 .row &%return_path_remove%&          "from incoming messages"
13788 .row &%strip_excess_angle_brackets%& "in addresses"
13789 .row &%strip_trailing_dot%&          "at end of addresses"
13790 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13791 .endtable
13792
13793
13794
13795 .section "System filter" "SECID115"
13796 .table2
13797 .row &%system_filter%&               "locate system filter"
13798 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13799                                             directory"
13800 .row &%system_filter_file_transport%& "transport for delivery to a file"
13801 .row &%system_filter_group%&         "group for filter running"
13802 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13803 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13804 .row &%system_filter_user%&          "user for filter running"
13805 .endtable
13806
13807
13808
13809 .section "Routing and delivery" "SECID116"
13810 .table2
13811 .row &%disable_ipv6%&                "do no IPv6 processing"
13812 .row &%dns_again_means_nonexist%&    "for broken domains"
13813 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13814 .row &%dns_dnssec_ok%&               "parameter for resolver"
13815 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13816 .row &%dns_retrans%&                 "parameter for resolver"
13817 .row &%dns_retry%&                   "parameter for resolver"
13818 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13819 .row &%dns_use_edns0%&               "parameter for resolver"
13820 .row &%hold_domains%&                "hold delivery for these domains"
13821 .row &%local_interfaces%&            "for routing checks"
13822 .row &%queue_domains%&               "no immediate delivery for these"
13823 .row &%queue_only%&                  "no immediate delivery at all"
13824 .row &%queue_only_file%&             "no immediate delivery if file exists"
13825 .row &%queue_only_load%&             "no immediate delivery if load is high"
13826 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13827 .row &%queue_only_override%&         "allow command line to override"
13828 .row &%queue_run_in_order%&          "order of arrival"
13829 .row &%queue_run_max%&               "of simultaneous queue runners"
13830 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13831 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13832 .row &%remote_sort_domains%&         "order of remote deliveries"
13833 .row &%retry_data_expire%&           "timeout for retry data"
13834 .row &%retry_interval_max%&          "safety net for retry rules"
13835 .endtable
13836
13837
13838
13839 .section "Bounce and warning messages" "SECID117"
13840 .table2
13841 .row &%bounce_message_file%&         "content of bounce"
13842 .row &%bounce_message_text%&         "content of bounce"
13843 .row &%bounce_return_body%&          "include body if returning message"
13844 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13845 .row &%bounce_return_message%&       "include original message in bounce"
13846 .row &%bounce_return_size_limit%&    "limit on returned message"
13847 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13848 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13849 .row &%errors_copy%&                 "copy bounce messages"
13850 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13851 .row &%delay_warning%&               "time schedule"
13852 .row &%delay_warning_condition%&     "condition for warning messages"
13853 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13854 .row &%smtp_return_error_details%&   "give detail on rejections"
13855 .row &%warn_message_file%&           "content of warning message"
13856 .endtable
13857
13858
13859
13860 .section "Alphabetical list of main options" "SECTalomo"
13861 Those options that undergo string expansion before use are marked with
13862 &dagger;.
13863
13864 .option accept_8bitmime main boolean true
13865 .cindex "8BITMIME"
13866 .cindex "8-bit characters"
13867 .cindex "log" "selectors"
13868 .cindex "log" "8BITMIME"
13869 This option causes Exim to send 8BITMIME in its response to an SMTP
13870 EHLO command, and to accept the BODY= parameter on MAIL commands.
13871 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13872 takes no steps to do anything special with messages received by this route.
13873
13874 Historically Exim kept this option off by default, but the maintainers
13875 feel that in today's Internet, this causes more problems than it solves.
13876 It now defaults to true.
13877 A more detailed analysis of the issues is provided by Dan Bernstein:
13878 .display
13879 &url(http://cr.yp.to/smtp/8bitmime.html)
13880 .endd
13881
13882 To log received 8BITMIME status use
13883 .code
13884 log_selector = +8bitmime
13885 .endd
13886
13887 .option acl_not_smtp main string&!! unset
13888 .cindex "&ACL;" "for non-SMTP messages"
13889 .cindex "non-SMTP messages" "ACLs for"
13890 This option defines the ACL that is run when a non-SMTP message has been
13891 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13892 further details.
13893
13894 .option acl_not_smtp_mime main string&!! unset
13895 This option defines the ACL that is run for individual MIME parts of non-SMTP
13896 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13897 SMTP messages.
13898
13899 .option acl_not_smtp_start main string&!! unset
13900 .cindex "&ACL;" "at start of non-SMTP message"
13901 .cindex "non-SMTP messages" "ACLs for"
13902 This option defines the ACL that is run before Exim starts reading a
13903 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13904
13905 .option acl_smtp_auth main string&!! unset
13906 .cindex "&ACL;" "setting up for SMTP commands"
13907 .cindex "AUTH" "ACL for"
13908 This option defines the ACL that is run when an SMTP AUTH command is
13909 received. See chapter &<<CHAPACL>>& for further details.
13910
13911 .option acl_smtp_connect main string&!! unset
13912 .cindex "&ACL;" "on SMTP connection"
13913 This option defines the ACL that is run when an SMTP connection is received.
13914 See chapter &<<CHAPACL>>& for further details.
13915
13916 .option acl_smtp_data main string&!! unset
13917 .cindex "DATA" "ACL for"
13918 This option defines the ACL that is run after an SMTP DATA command has been
13919 processed and the message itself has been received, but before the final
13920 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13921
13922 .option acl_smtp_data_prdr main string&!! accept
13923 .cindex "PRDR" "ACL for"
13924 .cindex "DATA" "PRDR ACL for"
13925 .cindex "&ACL;" "PRDR-related"
13926 .cindex "&ACL;" "per-user data processing"
13927 This option defines the ACL that,
13928 if the PRDR feature has been negotiated,
13929 is run for each recipient after an SMTP DATA command has been
13930 processed and the message itself has been received, but before the
13931 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13932
13933 .option acl_smtp_dkim main string&!! unset
13934 .cindex DKIM "ACL for"
13935 This option defines the ACL that is run for each DKIM signature
13936 of a received message.
13937 See chapter &<<CHAPdkim>>& for further details.
13938
13939 .option acl_smtp_etrn main string&!! unset
13940 .cindex "ETRN" "ACL for"
13941 This option defines the ACL that is run when an SMTP ETRN command is
13942 received. See chapter &<<CHAPACL>>& for further details.
13943
13944 .option acl_smtp_expn main string&!! unset
13945 .cindex "EXPN" "ACL for"
13946 This option defines the ACL that is run when an SMTP EXPN command is
13947 received. See chapter &<<CHAPACL>>& for further details.
13948
13949 .option acl_smtp_helo main string&!! unset
13950 .cindex "EHLO" "ACL for"
13951 .cindex "HELO" "ACL for"
13952 This option defines the ACL that is run when an SMTP EHLO or HELO
13953 command is received. See chapter &<<CHAPACL>>& for further details.
13954
13955
13956 .option acl_smtp_mail main string&!! unset
13957 .cindex "MAIL" "ACL for"
13958 This option defines the ACL that is run when an SMTP MAIL command is
13959 received. See chapter &<<CHAPACL>>& for further details.
13960
13961 .option acl_smtp_mailauth main string&!! unset
13962 .cindex "AUTH" "on MAIL command"
13963 This option defines the ACL that is run when there is an AUTH parameter on
13964 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13965 &<<CHAPSMTPAUTH>>& for details of authentication.
13966
13967 .option acl_smtp_mime main string&!! unset
13968 .cindex "MIME content scanning" "ACL for"
13969 This option is available when Exim is built with the content-scanning
13970 extension. It defines the ACL that is run for each MIME part in a message. See
13971 section &<<SECTscanmimepart>>& for details.
13972
13973 .option acl_smtp_notquit main string&!! unset
13974 .cindex "not-QUIT, ACL for"
13975 This option defines the ACL that is run when an SMTP session
13976 ends without a QUIT command being received.
13977 See chapter &<<CHAPACL>>& for further details.
13978
13979 .option acl_smtp_predata main string&!! unset
13980 This option defines the ACL that is run when an SMTP DATA command is
13981 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13982 further details.
13983
13984 .option acl_smtp_quit main string&!! unset
13985 .cindex "QUIT, ACL for"
13986 This option defines the ACL that is run when an SMTP QUIT command is
13987 received. See chapter &<<CHAPACL>>& for further details.
13988
13989 .option acl_smtp_rcpt main string&!! unset
13990 .cindex "RCPT" "ACL for"
13991 This option defines the ACL that is run when an SMTP RCPT command is
13992 received. See chapter &<<CHAPACL>>& for further details.
13993
13994 .option acl_smtp_starttls main string&!! unset
13995 .cindex "STARTTLS, ACL for"
13996 This option defines the ACL that is run when an SMTP STARTTLS command is
13997 received. See chapter &<<CHAPACL>>& for further details.
13998
13999 .option acl_smtp_vrfy main string&!! unset
14000 .cindex "VRFY" "ACL for"
14001 This option defines the ACL that is run when an SMTP VRFY command is
14002 received. See chapter &<<CHAPACL>>& for further details.
14003
14004 .new
14005 .option add_environment main "string list" empty
14006 .cindex "environment" "set values"
14007 This option allows to set individual environment variables that the
14008 currently linked libraries and programs in child processes use. The
14009 default list is empty,
14010 .wen
14011
14012 .option admin_groups main "string list&!!" unset
14013 .cindex "admin user"
14014 This option is expanded just once, at the start of Exim's processing. If the
14015 current group or any of the supplementary groups of an Exim caller is in this
14016 colon-separated list, the caller has admin privileges. If all your system
14017 programmers are in a specific group, for example, you can give them all Exim
14018 admin privileges by putting that group in &%admin_groups%&. However, this does
14019 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14020 To permit this, you have to add individuals to the Exim group.
14021
14022 .option allow_domain_literals main boolean false
14023 .cindex "domain literal"
14024 If this option is set, the RFC 2822 domain literal format is permitted in
14025 email addresses. The option is not set by default, because the domain literal
14026 format is not normally required these days, and few people know about it. It
14027 has, however, been exploited by mail abusers.
14028
14029 Unfortunately, it seems that some DNS black list maintainers are using this
14030 format to report black listing to postmasters. If you want to accept messages
14031 addressed to your hosts by IP address, you need to set
14032 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14033 domains (defined in the named domain list &%local_domains%& in the default
14034 configuration). This &"magic string"& matches the domain literal form of all
14035 the local host's IP addresses.
14036
14037
14038 .option allow_mx_to_ip main boolean false
14039 .cindex "MX record" "pointing to IP address"
14040 It appears that more and more DNS zone administrators are breaking the rules
14041 and putting domain names that look like IP addresses on the right hand side of
14042 MX records. Exim follows the rules and rejects this, giving an error message
14043 that explains the misconfiguration. However, some other MTAs support this
14044 practice, so to avoid &"Why can't Exim do this?"& complaints,
14045 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14046 recommended, except when you have no other choice.
14047
14048 .option allow_utf8_domains main boolean false
14049 .cindex "domain" "UTF-8 characters in"
14050 .cindex "UTF-8" "in domain name"
14051 Lots of discussion is going on about internationalized domain names. One
14052 camp is strongly in favour of just using UTF-8 characters, and it seems
14053 that at least two other MTAs permit this. This option allows Exim users to
14054 experiment if they wish.
14055
14056 If it is set true, Exim's domain parsing function allows valid
14057 UTF-8 multicharacters to appear in domain name components, in addition to
14058 letters, digits, and hyphens. However, just setting this option is not
14059 enough; if you want to look up these domain names in the DNS, you must also
14060 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14061 suitable setting is:
14062 .code
14063 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14064   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14065 .endd
14066 Alternatively, you can just disable this feature by setting
14067 .code
14068 dns_check_names_pattern =
14069 .endd
14070 That is, set the option to an empty string so that no check is done.
14071
14072
14073 .option auth_advertise_hosts main "host list&!!" *
14074 .cindex "authentication" "advertising"
14075 .cindex "AUTH" "advertising"
14076 If any server authentication mechanisms are configured, Exim advertises them in
14077 response to an EHLO command only if the calling host matches this list.
14078 Otherwise, Exim does not advertise AUTH.
14079 Exim does not accept AUTH commands from clients to which it has not
14080 advertised the availability of AUTH. The advertising of individual
14081 authentication mechanisms can be controlled by the use of the
14082 &%server_advertise_condition%& generic authenticator option on the individual
14083 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14084
14085 Certain mail clients (for example, Netscape) require the user to provide a name
14086 and password for authentication if AUTH is advertised, even though it may
14087 not be needed (the host may accept messages from hosts on its local LAN without
14088 authentication, for example). The &%auth_advertise_hosts%& option can be used
14089 to make these clients more friendly by excluding them from the set of hosts to
14090 which Exim advertises AUTH.
14091
14092 .cindex "AUTH" "advertising when encrypted"
14093 If you want to advertise the availability of AUTH only when the connection
14094 is encrypted using TLS, you can make use of the fact that the value of this
14095 option is expanded, with a setting like this:
14096 .code
14097 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14098 .endd
14099 .vindex "&$tls_in_cipher$&"
14100 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14101 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14102 expansion is *, which matches all hosts.
14103
14104
14105 .option auto_thaw main time 0s
14106 .cindex "thawing messages"
14107 .cindex "unfreezing messages"
14108 If this option is set to a time greater than zero, a queue runner will try a
14109 new delivery attempt on any frozen message, other than a bounce message, if
14110 this much time has passed since it was frozen. This may result in the message
14111 being re-frozen if nothing has changed since the last attempt. It is a way of
14112 saying &"keep on trying, even though there are big problems"&.
14113
14114 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14115 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14116 thought to be very useful any more, and its use should probably be avoided.
14117
14118
14119 .option av_scanner main string "see below"
14120 This option is available if Exim is built with the content-scanning extension.
14121 It specifies which anti-virus scanner to use. The default value is:
14122 .code
14123 sophie:/var/run/sophie
14124 .endd
14125 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14126 before use. See section &<<SECTscanvirus>>& for further details.
14127
14128
14129 .option bi_command main string unset
14130 .oindex "&%-bi%&"
14131 This option supplies the name of a command that is run when Exim is called with
14132 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14133 just the command name, it is not a complete command line. If an argument is
14134 required, it must come from the &%-oA%& command line option.
14135
14136
14137 .option bounce_message_file main string unset
14138 .cindex "bounce message" "customizing"
14139 .cindex "customizing" "bounce message"
14140 This option defines a template file containing paragraphs of text to be used
14141 for constructing bounce messages.  Details of the file's contents are given in
14142 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14143
14144
14145 .option bounce_message_text main string unset
14146 When this option is set, its contents are included in the default bounce
14147 message immediately after &"This message was created automatically by mail
14148 delivery software."& It is not used if &%bounce_message_file%& is set.
14149
14150 .option bounce_return_body main boolean true
14151 .cindex "bounce message" "including body"
14152 This option controls whether the body of an incoming message is included in a
14153 bounce message when &%bounce_return_message%& is true. The default setting
14154 causes the entire message, both header and body, to be returned (subject to the
14155 value of &%bounce_return_size_limit%&). If this option is false, only the
14156 message header is included. In the case of a non-SMTP message containing an
14157 error that is detected during reception, only those header lines preceding the
14158 point at which the error was detected are returned.
14159 .cindex "bounce message" "including original"
14160
14161 .option bounce_return_linesize_limit main integer 998
14162 .cindex "size" "of bounce lines, limit"
14163 .cindex "bounce message" "line length limit"
14164 .cindex "limit" "bounce message line length"
14165 This option sets a limit in bytes on the line length of messages
14166 that are returned to senders due to delivery problems,
14167 when &%bounce_return_message%& is true.
14168 The default value corresponds to RFC limits.
14169 If the message being returned has lines longer than this value it is
14170 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14171
14172 The option also applies to bounces returned when an error is detected
14173 during reception of a messsage.
14174 In this case lines from the original are truncated.
14175
14176 The option does not apply to messages generated by an &(autoreply)& transport.
14177
14178
14179 .option bounce_return_message main boolean true
14180 If this option is set false, none of the original message is included in
14181 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14182 &%bounce_return_body%&.
14183
14184
14185 .option bounce_return_size_limit main integer 100K
14186 .cindex "size" "of bounce, limit"
14187 .cindex "bounce message" "size limit"
14188 .cindex "limit" "bounce message size"
14189 This option sets a limit in bytes on the size of messages that are returned to
14190 senders as part of bounce messages when &%bounce_return_message%& is true. The
14191 limit should be less than the value of the global &%message_size_limit%& and of
14192 any &%message_size_limit%& settings on transports, to allow for the bounce text
14193 that Exim generates. If this option is set to zero there is no limit.
14194
14195 When the body of any message that is to be included in a bounce message is
14196 greater than the limit, it is truncated, and a comment pointing this out is
14197 added at the top. The actual cutoff may be greater than the value given, owing
14198 to the use of buffering for transferring the message in chunks (typically 8K in
14199 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14200 messages.
14201
14202 .option bounce_sender_authentication main string unset
14203 .cindex "bounce message" "sender authentication"
14204 .cindex "authentication" "bounce message"
14205 .cindex "AUTH" "on bounce message"
14206 This option provides an authenticated sender address that is sent with any
14207 bounce messages generated by Exim that are sent over an authenticated SMTP
14208 connection. A typical setting might be:
14209 .code
14210 bounce_sender_authentication = mailer-daemon@my.domain.example
14211 .endd
14212 which would cause bounce messages to be sent using the SMTP command:
14213 .code
14214 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14215 .endd
14216 The value of &%bounce_sender_authentication%& must always be a complete email
14217 address.
14218
14219 .option callout_domain_negative_expire main time 3h
14220 .cindex "caching" "callout timeouts"
14221 .cindex "callout" "caching timeouts"
14222 This option specifies the expiry time for negative callout cache data for a
14223 domain. See section &<<SECTcallver>>& for details of callout verification, and
14224 section &<<SECTcallvercache>>& for details of the caching.
14225
14226
14227 .option callout_domain_positive_expire main time 7d
14228 This option specifies the expiry time for positive callout cache data for a
14229 domain. See section &<<SECTcallver>>& for details of callout verification, and
14230 section &<<SECTcallvercache>>& for details of the caching.
14231
14232
14233 .option callout_negative_expire main time 2h
14234 This option specifies the expiry time for negative callout cache data for an
14235 address. See section &<<SECTcallver>>& for details of callout verification, and
14236 section &<<SECTcallvercache>>& for details of the caching.
14237
14238
14239 .option callout_positive_expire main time 24h
14240 This option specifies the expiry time for positive callout cache data for an
14241 address. See section &<<SECTcallver>>& for details of callout verification, and
14242 section &<<SECTcallvercache>>& for details of the caching.
14243
14244
14245 .option callout_random_local_part main string&!! "see below"
14246 This option defines the &"random"& local part that can be used as part of
14247 callout verification. The default value is
14248 .code
14249 $primary_hostname-$tod_epoch-testing
14250 .endd
14251 See section &<<CALLaddparcall>>& for details of how this value is used.
14252
14253
14254 .option check_log_inodes main integer 0
14255 See &%check_spool_space%& below.
14256
14257
14258 .option check_log_space main integer 0
14259 See &%check_spool_space%& below.
14260
14261 .oindex "&%check_rfc2047_length%&"
14262 .cindex "RFC 2047" "disabling length check"
14263 .option check_rfc2047_length main boolean true
14264 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14265 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14266 word; strings to be encoded that exceed this length are supposed to use
14267 multiple encoded words. By default, Exim does not recognize encoded words that
14268 exceed the maximum length. However, it seems that some software, in violation
14269 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14270 set false, Exim recognizes encoded words of any length.
14271
14272
14273 .option check_spool_inodes main integer 0
14274 See &%check_spool_space%& below.
14275
14276
14277 .option check_spool_space main integer 0
14278 .cindex "checking disk space"
14279 .cindex "disk space, checking"
14280 .cindex "spool directory" "checking space"
14281 The four &%check_...%& options allow for checking of disk resources before a
14282 message is accepted.
14283
14284 .vindex "&$log_inodes$&"
14285 .vindex "&$log_space$&"
14286 .vindex "&$spool_inodes$&"
14287 .vindex "&$spool_space$&"
14288 When any of these options are set, they apply to all incoming messages. If you
14289 want to apply different checks to different kinds of message, you can do so by
14290 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14291 &$spool_space$& in an ACL with appropriate additional conditions.
14292
14293
14294 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14295 either value is greater than zero, for example:
14296 .code
14297 check_spool_space = 10M
14298 check_spool_inodes = 100
14299 .endd
14300 The spool partition is the one that contains the directory defined by
14301 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14302 transit.
14303
14304 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14305 files are written if either is greater than zero. These should be set only if
14306 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14307
14308 If there is less space or fewer inodes than requested, Exim refuses to accept
14309 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14310 error response to the MAIL command. If ESMTP is in use and there was a
14311 SIZE parameter on the MAIL command, its value is added to the
14312 &%check_spool_space%& value, and the check is performed even if
14313 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14314
14315 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14316 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14317
14318 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14319 failure a message is written to stderr and Exim exits with a non-zero code, as
14320 it obviously cannot send an error message of any kind.
14321
14322 .option daemon_smtp_ports main string &`smtp`&
14323 .cindex "port" "for daemon"
14324 .cindex "TCP/IP" "setting listening ports"
14325 This option specifies one or more default SMTP ports on which the Exim daemon
14326 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14327 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14328
14329 .option daemon_startup_retries main integer 9
14330 .cindex "daemon startup, retrying"
14331 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14332 the daemon at startup when it cannot immediately bind a listening socket
14333 (typically because the socket is already in use): &%daemon_startup_retries%&
14334 defines the number of retries after the first failure, and
14335 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14336
14337 .option daemon_startup_sleep main time 30s
14338 See &%daemon_startup_retries%&.
14339
14340 .option delay_warning main "time list" 24h
14341 .cindex "warning of delay"
14342 .cindex "delay warning, specifying"
14343 When a message is delayed, Exim sends a warning message to the sender at
14344 intervals specified by this option. The data is a colon-separated list of times
14345 after which to send warning messages. If the value of the option is an empty
14346 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14347 message has been on the queue for longer than the last time, the last interval
14348 between the times is used to compute subsequent warning times. For example,
14349 with
14350 .code
14351 delay_warning = 4h:8h:24h
14352 .endd
14353 the first message is sent after 4 hours, the second after 8 hours, and
14354 the third one after 24 hours. After that, messages are sent every 16 hours,
14355 because that is the interval between the last two times on the list. If you set
14356 just one time, it specifies the repeat interval. For example, with:
14357 .code
14358 delay_warning = 6h
14359 .endd
14360 messages are repeated every six hours. To stop warnings after a given time, set
14361 a very large time at the end of the list. For example:
14362 .code
14363 delay_warning = 2h:12h:99d
14364 .endd
14365 Note that the option is only evaluated at the time a delivery attempt fails,
14366 which depends on retry and queue-runner configuration.
14367 Typically retries will be configured more frequently than warning messages.
14368
14369 .option delay_warning_condition main string&!! "see below"
14370 .vindex "&$domain$&"
14371 The string is expanded at the time a warning message might be sent. If all the
14372 deferred addresses have the same domain, it is set in &$domain$& during the
14373 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14374 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14375 &"false"& (the comparison being done caselessly) then the warning message is
14376 not sent. The default is:
14377 .code
14378 delay_warning_condition = ${if or {\
14379   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14380   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14381   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14382   } {no}{yes}}
14383 .endd
14384 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14385 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14386 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14387 &"auto-replied"& in an &'Auto-Submitted:'& header.
14388
14389 .option deliver_drop_privilege main boolean false
14390 .cindex "unprivileged delivery"
14391 .cindex "delivery" "unprivileged"
14392 If this option is set true, Exim drops its root privilege at the start of a
14393 delivery process, and runs as the Exim user throughout. This severely restricts
14394 the kinds of local delivery that are possible, but is viable in certain types
14395 of configuration. There is a discussion about the use of root privilege in
14396 chapter &<<CHAPsecurity>>&.
14397
14398 .option deliver_queue_load_max main fixed-point unset
14399 .cindex "load average"
14400 .cindex "queue runner" "abandoning"
14401 When this option is set, a queue run is abandoned if the system load average
14402 becomes greater than the value of the option. The option has no effect on
14403 ancient operating systems on which Exim cannot determine the load average.
14404 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14405
14406
14407 .option delivery_date_remove main boolean true
14408 .cindex "&'Delivery-date:'& header line"
14409 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14410 message when it is delivered, in exactly the same way as &'Return-path:'& is
14411 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14412 should not be present in incoming messages, and this option causes them to be
14413 removed at the time the message is received, to avoid any problems that might
14414 occur when a delivered message is subsequently sent on to some other recipient.
14415
14416 .option disable_fsync main boolean false
14417 .cindex "&[fsync()]&, disabling"
14418 This option is available only if Exim was built with the compile-time option
14419 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14420 a runtime configuration generates an &"unknown option"& error. You should not
14421 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14422 really, really, really understand what you are doing. &'No pre-compiled
14423 distributions of Exim should ever make this option available.'&
14424
14425 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14426 updated files' data to be written to disc before continuing. Unexpected events
14427 such as crashes and power outages may cause data to be lost or scrambled.
14428 Here be Dragons. &*Beware.*&
14429
14430
14431 .option disable_ipv6 main boolean false
14432 .cindex "IPv6" "disabling"
14433 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14434 activities take place. AAAA records are never looked up, and any IPv6 addresses
14435 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14436 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14437 to handle IPv6 literal addresses.
14438
14439
14440 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14441 .cindex DKIM "controlling calls to the ACL"
14442 This option gives a list of DKIM domains for which the DKIM ACL is run.
14443 It is expanded after the message is received; by default it runs
14444 the ACL once for each signature in the message.
14445 See chapter &<<CHAPdkim>>&.
14446
14447
14448 .option dns_again_means_nonexist main "domain list&!!" unset
14449 .cindex "DNS" "&""try again""& response; overriding"
14450 DNS lookups give a &"try again"& response for the DNS errors
14451 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14452 keep trying to deliver a message, or to give repeated temporary errors to
14453 incoming mail. Sometimes the effect is caused by a badly set up name server and
14454 may persist for a long time. If a domain which exhibits this problem matches
14455 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14456 This option should be used with care. You can make it apply to reverse lookups
14457 by a setting such as this:
14458 .code
14459 dns_again_means_nonexist = *.in-addr.arpa
14460 .endd
14461 This option applies to all DNS lookups that Exim does. It also applies when the
14462 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14463 since these are most likely to be caused by DNS lookup problems. The
14464 &(dnslookup)& router has some options of its own for controlling what happens
14465 when lookups for MX or SRV records give temporary errors. These more specific
14466 options are applied after this global option.
14467
14468 .option dns_check_names_pattern main string "see below"
14469 .cindex "DNS" "pre-check of name syntax"
14470 When this option is set to a non-empty string, it causes Exim to check domain
14471 names for characters that are not allowed in host names before handing them to
14472 the DNS resolver, because some resolvers give temporary errors for names that
14473 contain unusual characters. If a domain name contains any unwanted characters,
14474 a &"not found"& result is forced, and the resolver is not called. The check is
14475 done by matching the domain name against a regular expression, which is the
14476 value of this option. The default pattern is
14477 .code
14478 dns_check_names_pattern = \
14479   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14480 .endd
14481 which permits only letters, digits, slashes, and hyphens in components, but
14482 they must start and end with a letter or digit. Slashes are not, in fact,
14483 permitted in host names, but they are found in certain NS records (which can be
14484 accessed in Exim by using a &%dnsdb%& lookup). If you set
14485 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14486 empty string.
14487
14488 .option dns_csa_search_limit main integer 5
14489 This option controls the depth of parental searching for CSA SRV records in the
14490 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14491
14492 .option dns_csa_use_reverse main boolean true
14493 This option controls whether or not an IP address, given as a CSA domain, is
14494 reversed and looked up in the reverse DNS, as described in more detail in
14495 section &<<SECTverifyCSA>>&.
14496
14497
14498 .option dns_dnssec_ok main integer -1
14499 .cindex "DNS" "resolver options"
14500 .cindex "DNS" "DNSSEC"
14501 If this option is set to a non-negative number then Exim will initialise the
14502 DNS resolver library to either use or not use DNSSEC, overriding the system
14503 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14504
14505 If the resolver library does not support DNSSEC then this option has no effect.
14506
14507
14508 .option dns_ipv4_lookup main "domain list&!!" unset
14509 .cindex "IPv6" "DNS lookup for AAAA records"
14510 .cindex "DNS" "IPv6 lookup for AAAA records"
14511 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14512 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14513 (A records) when trying to find IP addresses for hosts, unless the host's
14514 domain matches this list.
14515
14516 This is a fudge to help with name servers that give big delays or otherwise do
14517 not work for the AAAA record type. In due course, when the world's name
14518 servers have all been upgraded, there should be no need for this option.
14519
14520
14521 .option dns_retrans main time 0s
14522 .cindex "DNS" "resolver options"
14523 .cindex timeout "dns lookup"
14524 .cindex "DNS" timeout
14525 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14526 retransmission and retry parameters for DNS lookups. Values of zero (the
14527 defaults) leave the system default settings unchanged. The first value is the
14528 time between retries, and the second is the number of retries. It isn't
14529 totally clear exactly how these settings affect the total time a DNS lookup may
14530 take. I haven't found any documentation about timeouts on DNS lookups; these
14531 parameter values are available in the external resolver interface structure,
14532 but nowhere does it seem to describe how they are used or what you might want
14533 to set in them.
14534 See also the &%slow_lookup_log%& option.
14535
14536
14537 .option dns_retry main integer 0
14538 See &%dns_retrans%& above.
14539
14540
14541 .option dns_trust_aa main "domain list&!!" unset
14542 .cindex "DNS" "resolver options"
14543 .cindex "DNS" "DNSSEC"
14544 If this option is set then lookup results marked with the AA bit
14545 (Authoritative Answer) are trusted the same way as if they were
14546 DNSSEC-verified. The authority section's name of the answer must
14547 match with this expanded domain list.
14548
14549 Use this option only if you talk directly to a resolver that is
14550 authoritative for some zones and does not set the AD (Authentic Data)
14551 bit in the answer. Some DNS servers may have an configuration option to
14552 mark the answers from their own zones as verified (they set the AD bit).
14553 Others do not have this option. It is considered as poor practice using
14554 a resolver that is an authoritative server for some zones.
14555
14556 Use this option only if you really have to (e.g. if you want
14557 to use DANE for remote delivery to a server that is listed in the DNS
14558 zones that your resolver is authoritative for).
14559
14560 If the DNS answer packet has the AA bit set and contains resource record
14561 in the answer section, the name of the first NS record appearing in the
14562 authority section is compared against the list. If the answer packet is
14563 authoritative but the answer section is empty, the name of the first SOA
14564 record in the authoritative section is used instead.
14565
14566 .cindex "DNS" "resolver options"
14567 .option dns_use_edns0 main integer -1
14568 .cindex "DNS" "resolver options"
14569 .cindex "DNS" "EDNS0"
14570 If this option is set to a non-negative number then Exim will initialise the
14571 DNS resolver library to either use or not use EDNS0 extensions, overriding
14572 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14573 on.
14574
14575 If the resolver library does not support EDNS0 then this option has no effect.
14576
14577
14578 .option drop_cr main boolean false
14579 This is an obsolete option that is now a no-op. It used to affect the way Exim
14580 handled CR and LF characters in incoming messages. What happens now is
14581 described in section &<<SECTlineendings>>&.
14582
14583 .option dsn_advertise_hosts main "host list&!!" unset
14584 .cindex "bounce messages" "success"
14585 .cindex "DSN" "success"
14586 .cindex "Delivery Status Notification" "success"
14587 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14588 and accepted from, these hosts.
14589 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14590 and RET and ORCPT options on MAIL FROM commands.
14591 A NOTIFY=SUCCESS option requests success-DSN messages.
14592 A NOTIFY= option with no argument requests that no delay or failure DSNs
14593 are sent.
14594
14595 .option dsn_from main "string&!!" "see below"
14596 .cindex "&'From:'& header line" "in bounces"
14597 .cindex "bounce messages" "&'From:'& line, specifying"
14598 This option can be used to vary the contents of &'From:'& header lines in
14599 bounces and other automatically generated messages (&"Delivery Status
14600 Notifications"& &-- hence the name of the option). The default setting is:
14601 .code
14602 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14603 .endd
14604 The value is expanded every time it is needed. If the expansion fails, a
14605 panic is logged, and the default value is used.
14606
14607 .option envelope_to_remove main boolean true
14608 .cindex "&'Envelope-to:'& header line"
14609 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14610 message when it is delivered, in exactly the same way as &'Return-path:'& is
14611 handled. &'Envelope-to:'& records the original recipient address from the
14612 message's envelope that caused the delivery to happen. Such headers should not
14613 be present in incoming messages, and this option causes them to be removed at
14614 the time the message is received, to avoid any problems that might occur when a
14615 delivered message is subsequently sent on to some other recipient.
14616
14617
14618 .option errors_copy main "string list&!!" unset
14619 .cindex "bounce message" "copy to other address"
14620 .cindex "copy of bounce message"
14621 Setting this option causes Exim to send bcc copies of bounce messages that it
14622 generates to other addresses. &*Note*&: This does not apply to bounce messages
14623 coming from elsewhere. The value of the option is a colon-separated list of
14624 items. Each item consists of a pattern, terminated by white space, followed by
14625 a comma-separated list of email addresses. If a pattern contains spaces, it
14626 must be enclosed in double quotes.
14627
14628 Each pattern is processed in the same way as a single item in an address list
14629 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14630 the bounce message, the message is copied to the addresses on the list. The
14631 items are scanned in order, and once a matching one is found, no further items
14632 are examined. For example:
14633 .code
14634 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14635               rqps@mydomain   hostmaster@mydomain.example,\
14636                               postmaster@mydomain.example
14637 .endd
14638 .vindex "&$domain$&"
14639 .vindex "&$local_part$&"
14640 The address list is expanded before use. The expansion variables &$local_part$&
14641 and &$domain$& are set from the original recipient of the error message, and if
14642 there was any wildcard matching in the pattern, the expansion
14643 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14644 variables &$0$&, &$1$&, etc. are set in the normal way.
14645
14646
14647 .option errors_reply_to main string unset
14648 .cindex "bounce message" "&'Reply-to:'& in"
14649 By default, Exim's bounce and delivery warning messages contain the header line
14650 .display
14651 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14652 .endd
14653 .oindex &%quota_warn_message%&
14654 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14655 A warning message that is generated by the &%quota_warn_message%& option in an
14656 &(appendfile)& transport may contain its own &'From:'& header line that
14657 overrides the default.
14658
14659 Experience shows that people reply to bounce messages. If the
14660 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14661 and warning messages. For example:
14662 .code
14663 errors_reply_to = postmaster@my.domain.example
14664 .endd
14665 The value of the option is not expanded. It must specify a valid RFC 2822
14666 address. However, if a warning message that is generated by the
14667 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14668 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14669 not used.
14670
14671
14672 .new
14673 .option event_action main string&!! unset
14674 .cindex events
14675 This option declares a string to be expanded for Exim's events mechanism.
14676 For details see &<<CHAPevents>>&.
14677 .wen
14678
14679
14680 .option exim_group main string "compile-time configured"
14681 .cindex "gid (group id)" "Exim's own"
14682 .cindex "Exim group"
14683 This option changes the gid under which Exim runs when it gives up root
14684 privilege. The default value is compiled into the binary. The value of this
14685 option is used only when &%exim_user%& is also set. Unless it consists entirely
14686 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14687 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14688 security issues.
14689
14690
14691 .option exim_path main string "see below"
14692 .cindex "Exim binary, path name"
14693 This option specifies the path name of the Exim binary, which is used when Exim
14694 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14695 the directory configured at compile time by the BIN_DIRECTORY setting. It
14696 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14697 other place.
14698 &*Warning*&: Do not use a macro to define the value of this option, because
14699 you will break those Exim utilities that scan the configuration file to find
14700 where the binary is. (They then use the &%-bP%& option to extract option
14701 settings such as the value of &%spool_directory%&.)
14702
14703
14704 .option exim_user main string "compile-time configured"
14705 .cindex "uid (user id)" "Exim's own"
14706 .cindex "Exim user"
14707 This option changes the uid under which Exim runs when it gives up root
14708 privilege. The default value is compiled into the binary. Ownership of the run
14709 time configuration file and the use of the &%-C%& and &%-D%& command line
14710 options is checked against the values in the binary, not what is set here.
14711
14712 Unless it consists entirely of digits, the string is looked up using
14713 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14714 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14715 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14716
14717
14718 .option extra_local_interfaces main "string list" unset
14719 This option defines network interfaces that are to be considered local when
14720 routing, but which are not used for listening by the daemon. See section
14721 &<<SECTreclocipadd>>& for details.
14722
14723
14724 . Allow this long option name to split; give it unsplit as a fifth argument
14725 . for the automatic .oindex that is generated by .option.
14726
14727 .option "extract_addresses_remove_arguments" main boolean true &&&
14728          extract_addresses_remove_arguments
14729 .oindex "&%-t%&"
14730 .cindex "command line" "addresses with &%-t%&"
14731 .cindex "Sendmail compatibility" "&%-t%& option"
14732 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14733 are present on the command line when the &%-t%& option is used to build an
14734 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14735 line addresses are removed from the recipients list. This is also how Smail
14736 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14737 command line addresses are added to those obtained from the header lines. When
14738 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14739 argument headers. If it is set false, Exim adds rather than removes argument
14740 addresses.
14741
14742
14743 .option finduser_retries main integer 0
14744 .cindex "NIS, retrying user lookups"
14745 On systems running NIS or other schemes in which user and group information is
14746 distributed from a remote system, there can be times when &[getpwnam()]& and
14747 related functions fail, even when given valid data, because things time out.
14748 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14749 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14750 many extra times to find a user or a group, waiting for one second between
14751 retries.
14752
14753 .cindex "&_/etc/passwd_&" "multiple reading of"
14754 You should not set this option greater than zero if your user information is in
14755 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14756 search the file multiple times for non-existent users, and also cause delay.
14757
14758
14759
14760 .option freeze_tell main "string list, comma separated" unset
14761 .cindex "freezing messages" "sending a message when freezing"
14762 On encountering certain errors, or when configured to do so in a system filter,
14763 ACL, or special router, Exim freezes a message. This means that no further
14764 delivery attempts take place until an administrator thaws the message, or the
14765 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14766 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14767 warning message whenever it freezes something, unless the message it is
14768 freezing is a locally-generated bounce message. (Without this exception there
14769 is the possibility of looping.) The warning message is sent to the addresses
14770 supplied as the comma-separated value of this option. If several of the
14771 message's addresses cause freezing, only a single message is sent. If the
14772 freezing was automatic, the reason(s) for freezing can be found in the message
14773 log. If you configure freezing in a filter or ACL, you must arrange for any
14774 logging that you require.
14775
14776
14777 .option gecos_name main string&!! unset
14778 .cindex "HP-UX"
14779 .cindex "&""gecos""& field, parsing"
14780 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14781 password file to hold other information in addition to users' real names. Exim
14782 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14783 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14784 of the field are used unchanged, except that, if an ampersand is encountered,
14785 it is replaced by the user's login name with the first character forced to
14786 upper case, since this is a convention that is observed on many systems.
14787
14788 When these options are set, &%gecos_pattern%& is treated as a regular
14789 expression that is to be applied to the field (again with && replaced by the
14790 login name), and if it matches, &%gecos_name%& is expanded and used as the
14791 user's name.
14792
14793 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14794 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14795 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14796 name terminates at the first comma, the following can be used:
14797 .code
14798 gecos_pattern = ([^,]*)
14799 gecos_name = $1
14800 .endd
14801
14802 .option gecos_pattern main string unset
14803 See &%gecos_name%& above.
14804
14805
14806 .option gnutls_compat_mode main boolean unset
14807 This option controls whether GnuTLS is used in compatibility mode in an Exim
14808 server. This reduces security slightly, but improves interworking with older
14809 implementations of TLS.
14810
14811
14812 option gnutls_allow_auto_pkcs11 main boolean unset
14813 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14814 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14815
14816 See
14817 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14818 for documentation.
14819
14820
14821
14822 .option headers_charset main string "see below"
14823 This option sets a default character set for translating from encoded MIME
14824 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14825 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14826 ultimate default is ISO-8859-1. For more details see the description of header
14827 insertions in section &<<SECTexpansionitems>>&.
14828
14829
14830
14831 .option header_maxsize main integer "see below"
14832 .cindex "header section" "maximum size of"
14833 .cindex "limit" "size of message header section"
14834 This option controls the overall maximum size of a message's header
14835 section. The default is the value of HEADER_MAXSIZE in
14836 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14837 sections are rejected.
14838
14839
14840 .option header_line_maxsize main integer 0
14841 .cindex "header lines" "maximum size of"
14842 .cindex "limit" "size of one header line"
14843 This option limits the length of any individual header line in a message, after
14844 all the continuations have been joined together. Messages with individual
14845 header lines that are longer than the limit are rejected. The default value of
14846 zero means &"no limit"&.
14847
14848
14849
14850
14851 .option helo_accept_junk_hosts main "host list&!!" unset
14852 .cindex "HELO" "accepting junk data"
14853 .cindex "EHLO" "accepting junk data"
14854 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14855 mail, and gives an error response for invalid data. Unfortunately, there are
14856 some SMTP clients that send syntactic junk. They can be accommodated by setting
14857 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14858 if you want to do semantic checking.
14859 See also &%helo_allow_chars%& for a way of extending the permitted character
14860 set.
14861
14862
14863 .option helo_allow_chars main string unset
14864 .cindex "HELO" "underscores in"
14865 .cindex "EHLO" "underscores in"
14866 .cindex "underscore in EHLO/HELO"
14867 This option can be set to a string of rogue characters that are permitted in
14868 all EHLO and HELO names in addition to the standard letters, digits,
14869 hyphens, and dots. If you really must allow underscores, you can set
14870 .code
14871 helo_allow_chars = _
14872 .endd
14873 Note that the value is one string, not a list.
14874
14875
14876 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14877 .cindex "HELO" "forcing reverse lookup"
14878 .cindex "EHLO" "forcing reverse lookup"
14879 If the domain given by a client in a HELO or EHLO command matches this
14880 list, a reverse lookup is done in order to establish the host's true name. The
14881 default forces a lookup if the client host gives the server's name or any of
14882 its IP addresses (in brackets), something that broken clients have been seen to
14883 do.
14884
14885
14886 .option helo_try_verify_hosts main "host list&!!" unset
14887 .cindex "HELO verifying" "optional"
14888 .cindex "EHLO" "verifying, optional"
14889 By default, Exim just checks the syntax of HELO and EHLO commands (see
14890 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14891 to do more extensive checking of the data supplied by these commands. The ACL
14892 condition &`verify = helo`& is provided to make this possible.
14893 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14894 to force the check to occur. From release 4.53 onwards, this is no longer
14895 necessary. If the check has not been done before &`verify = helo`& is
14896 encountered, it is done at that time. Consequently, this option is obsolete.
14897 Its specification is retained here for backwards compatibility.
14898
14899 When an EHLO or HELO command is received, if the calling host matches
14900 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14901 EHLO command either:
14902
14903 .ilist
14904 is an IP literal matching the calling address of the host, or
14905 .next
14906 .cindex "DNS" "reverse lookup"
14907 .cindex "reverse DNS lookup"
14908 matches the host name that Exim obtains by doing a reverse lookup of the
14909 calling host address, or
14910 .next
14911 when looked up in DNS yields the calling host address.
14912 .endlist
14913
14914 However, the EHLO or HELO command is not rejected if any of the checks
14915 fail. Processing continues, but the result of the check is remembered, and can
14916 be detected later in an ACL by the &`verify = helo`& condition.
14917
14918 If DNS was used for successful verification, the variable
14919 .cindex "DNS" "DNSSEC"
14920 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14921
14922 .option helo_verify_hosts main "host list&!!" unset
14923 .cindex "HELO verifying" "mandatory"
14924 .cindex "EHLO" "verifying, mandatory"
14925 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14926 backwards compatibility. For hosts that match this option, Exim checks the host
14927 name given in the HELO or EHLO in the same way as for
14928 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14929 rejected with a 550 error, and entries are written to the main and reject logs.
14930 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14931 error.
14932
14933 .option hold_domains main "domain list&!!" unset
14934 .cindex "domain" "delaying delivery"
14935 .cindex "delivery" "delaying certain domains"
14936 This option allows mail for particular domains to be held on the queue
14937 manually. The option is overridden if a message delivery is forced with the
14938 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14939 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14940 item in &%hold_domains%&, no routing or delivery for that address is done, and
14941 it is deferred every time the message is looked at.
14942
14943 This option is intended as a temporary operational measure for delaying the
14944 delivery of mail while some problem is being sorted out, or some new
14945 configuration tested. If you just want to delay the processing of some
14946 domains until a queue run occurs, you should use &%queue_domains%& or
14947 &%queue_smtp_domains%&, not &%hold_domains%&.
14948
14949 A setting of &%hold_domains%& does not override Exim's code for removing
14950 messages from the queue if they have been there longer than the longest retry
14951 time in any retry rule. If you want to hold messages for longer than the normal
14952 retry times, insert a dummy retry rule with a long retry time.
14953
14954
14955 .option host_lookup main "host list&!!" unset
14956 .cindex "host name" "lookup, forcing"
14957 Exim does not look up the name of a calling host from its IP address unless it
14958 is required to compare against some host list, or the host matches
14959 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14960 option (which normally contains IP addresses rather than host names). The
14961 default configuration file contains
14962 .code
14963 host_lookup = *
14964 .endd
14965 which causes a lookup to happen for all hosts. If the expense of these lookups
14966 is felt to be too great, the setting can be changed or removed.
14967
14968 After a successful reverse lookup, Exim does a forward lookup on the name it
14969 has obtained, to verify that it yields the IP address that it started with. If
14970 this check fails, Exim behaves as if the name lookup failed.
14971
14972 .vindex "&$host_lookup_failed$&"
14973 .vindex "&$sender_host_name$&"
14974 After any kind of failure, the host name (in &$sender_host_name$&) remains
14975 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14976 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14977 &`verify = reverse_host_lookup`& in ACLs.
14978
14979
14980 .option host_lookup_order main "string list" &`bydns:byaddr`&
14981 This option specifies the order of different lookup methods when Exim is trying
14982 to find a host name from an IP address. The default is to do a DNS lookup
14983 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14984 if that fails. You can change the order of these lookups, or omit one entirely,
14985 if you want.
14986
14987 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14988 multiple PTR records in the DNS and the IP address is not listed in
14989 &_/etc/hosts_&. Different operating systems give different results in this
14990 case. That is why the default tries a DNS lookup first.
14991
14992
14993
14994 .option host_reject_connection main "host list&!!" unset
14995 .cindex "host" "rejecting connections from"
14996 If this option is set, incoming SMTP calls from the hosts listed are rejected
14997 as soon as the connection is made.
14998 This option is obsolete, and retained only for backward compatibility, because
14999 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15000 connections immediately.
15001
15002 The ability to give an immediate rejection (either by this option or using an
15003 ACL) is provided for use in unusual cases. Many hosts will just try again,
15004 sometimes without much delay. Normally, it is better to use an ACL to reject
15005 incoming messages at a later stage, such as after RCPT commands. See
15006 chapter &<<CHAPACL>>&.
15007
15008
15009 .option hosts_connection_nolog main "host list&!!" unset
15010 .cindex "host" "not logging connections from"
15011 This option defines a list of hosts for which connection logging does not
15012 happen, even though the &%smtp_connection%& log selector is set. For example,
15013 you might want not to log SMTP connections from local processes, or from
15014 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15015 the daemon; you should therefore strive to restrict its value to a short inline
15016 list of IP addresses and networks. To disable logging SMTP connections from
15017 local processes, you must create a host list with an empty item. For example:
15018 .code
15019 hosts_connection_nolog = :
15020 .endd
15021 If the &%smtp_connection%& log selector is not set, this option has no effect.
15022
15023
15024
15025 .new
15026 .option hosts_proxy main "host list&!!" unset
15027 .cindex proxy "proxy protocol"
15028 This option enables use of Proxy Protocol proxies for incoming
15029 connections.  For details see &<<SECTproxyInbound>>&.
15030 .wen
15031
15032
15033 .option hosts_treat_as_local main "domain list&!!" unset
15034 .cindex "local host" "domains treated as"
15035 .cindex "host" "treated as local"
15036 If this option is set, any host names that match the domain list are treated as
15037 if they were the local host when Exim is scanning host lists obtained from MX
15038 records
15039 or other sources. Note that the value of this option is a domain list, not a
15040 host list, because it is always used to check host names, not IP addresses.
15041
15042 This option also applies when Exim is matching the special items
15043 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15044 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15045 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15046 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15047 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15048 interfaces and recognizing the local host.
15049
15050
15051 .option ibase_servers main "string list" unset
15052 .cindex "InterBase" "server list"
15053 This option provides a list of InterBase servers and associated connection data,
15054 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15055 The option is available only if Exim has been built with InterBase support.
15056
15057
15058
15059 .option ignore_bounce_errors_after main time 10w
15060 .cindex "bounce message" "discarding"
15061 .cindex "discarding bounce message"
15062 This option affects the processing of bounce messages that cannot be delivered,
15063 that is, those that suffer a permanent delivery failure. (Bounce messages that
15064 suffer temporary delivery failures are of course retried in the usual way.)
15065
15066 After a permanent delivery failure, bounce messages are frozen,
15067 because there is no sender to whom they can be returned. When a frozen bounce
15068 message has been on the queue for more than the given time, it is unfrozen at
15069 the next queue run, and a further delivery is attempted. If delivery fails
15070 again, the bounce message is discarded. This makes it possible to keep failed
15071 bounce messages around for a shorter time than the normal maximum retry time
15072 for frozen messages. For example,
15073 .code
15074 ignore_bounce_errors_after = 12h
15075 .endd
15076 retries failed bounce message deliveries after 12 hours, discarding any further
15077 failures. If the value of this option is set to a zero time period, bounce
15078 failures are discarded immediately. Setting a very long time (as in the default
15079 value) has the effect of disabling this option. For ways of automatically
15080 dealing with other kinds of frozen message, see &%auto_thaw%& and
15081 &%timeout_frozen_after%&.
15082
15083
15084 .option ignore_fromline_hosts main "host list&!!" unset
15085 .cindex "&""From""& line"
15086 .cindex "UUCP" "&""From""& line"
15087 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15088 the headers of a message. By default this is treated as the start of the
15089 message's body, which means that any following headers are not recognized as
15090 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15091 match those hosts that insist on sending it. If the sender is actually a local
15092 process rather than a remote host, and is using &%-bs%& to inject the messages,
15093 &%ignore_fromline_local%& must be set to achieve this effect.
15094
15095
15096 .option ignore_fromline_local main boolean false
15097 See &%ignore_fromline_hosts%& above.
15098
15099 .new
15100 .option keep_environment main "string list" unset
15101 .cindex "environment" "values from"
15102 This option contains a string list of environment variables to keep.
15103 You have to trust these variables or you have to be sure that
15104 these variables do not impose any security risk. Keep in mind that
15105 during the startup phase Exim is running with an effective UID 0 in most
15106 installations. As the default value is an empty list, the default
15107 environment for using libraries, running embedded Perl code, or running
15108 external binaries is empty, and does not not even contain PATH or HOME.
15109
15110 Actually the list is interpreted as a list of patterns
15111 (&<<SECTlistexpand>>&), except that it is not expanded first.
15112
15113 WARNING: Macro substitution is still done first, so having a macro
15114 FOO and having FOO_HOME in your &%keep_environment%& option may have
15115 unexpected results. You may work around this using a regular expression
15116 that does not match the macro name: ^[F]OO_HOME$.
15117
15118 Current versions of Exim issue a warning during startupif you do not mention
15119 &%keep_environment%& or &%add_environment%& in your runtime configuration
15120 file.
15121 .wen
15122
15123
15124 .option keep_malformed main time 4d
15125 This option specifies the length of time to keep messages whose spool files
15126 have been corrupted in some way. This should, of course, never happen. At the
15127 next attempt to deliver such a message, it gets removed. The incident is
15128 logged.
15129
15130
15131 .option ldap_ca_cert_dir main string unset
15132 .cindex "LDAP", "TLS CA certificate directory"
15133 .cindex certificate "directory for LDAP"
15134 This option indicates which directory contains CA certificates for verifying
15135 a TLS certificate presented by an LDAP server.
15136 While Exim does not provide a default value, your SSL library may.
15137 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15138 and constrained to be a directory.
15139
15140
15141 .option ldap_ca_cert_file main string unset
15142 .cindex "LDAP", "TLS CA certificate file"
15143 .cindex certificate "file for LDAP"
15144 This option indicates which file contains CA certificates for verifying
15145 a TLS certificate presented by an LDAP server.
15146 While Exim does not provide a default value, your SSL library may.
15147 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15148 and constrained to be a file.
15149
15150
15151 .option ldap_cert_file main string unset
15152 .cindex "LDAP" "TLS client certificate file"
15153 .cindex certificate "file for LDAP"
15154 This option indicates which file contains an TLS client certificate which
15155 Exim should present to the LDAP server during TLS negotiation.
15156 Should be used together with &%ldap_cert_key%&.
15157
15158
15159 .option ldap_cert_key main string unset
15160 .cindex "LDAP" "TLS client key file"
15161 .cindex certificate "key for LDAP"
15162 This option indicates which file contains the secret/private key to use
15163 to prove identity to the LDAP server during TLS negotiation.
15164 Should be used together with &%ldap_cert_file%&, which contains the
15165 identity to be proven.
15166
15167
15168 .option ldap_cipher_suite main string unset
15169 .cindex "LDAP" "TLS cipher suite"
15170 This controls the TLS cipher-suite negotiation during TLS negotiation with
15171 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15172 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15173
15174
15175 .option ldap_default_servers main "string list" unset
15176 .cindex "LDAP" "default servers"
15177 This option provides a list of LDAP servers which are tried in turn when an
15178 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15179 details of LDAP queries. This option is available only when Exim has been built
15180 with LDAP support.
15181
15182
15183 .option ldap_require_cert main string unset.
15184 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15185 This should be one of the values "hard", "demand", "allow", "try" or "never".
15186 A value other than one of these is interpreted as "never".
15187 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15188 Although Exim does not set a default, the LDAP library probably defaults
15189 to hard/demand.
15190
15191
15192 .option ldap_start_tls main boolean false
15193 .cindex "LDAP" "whether or not to negotiate TLS"
15194 If set, Exim will attempt to negotiate TLS with the LDAP server when
15195 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15196 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15197 of SSL-on-connect.
15198 In the event of failure to negotiate TLS, the action taken is controlled
15199 by &%ldap_require_cert%&.
15200
15201
15202 .option ldap_version main integer unset
15203 .cindex "LDAP" "protocol version, forcing"
15204 This option can be used to force Exim to set a specific protocol version for
15205 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15206 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15207 the LDAP headers; otherwise it is 2. This option is available only when Exim
15208 has been built with LDAP support.
15209
15210
15211
15212 .option local_from_check main boolean true
15213 .cindex "&'Sender:'& header line" "disabling addition of"
15214 .cindex "&'From:'& header line" "disabling checking of"
15215 When a message is submitted locally (that is, not over a TCP/IP connection) by
15216 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15217 checks that the &'From:'& header line matches the login of the calling user and
15218 the domain specified by &%qualify_domain%&.
15219
15220 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15221 locally submitted message is automatically qualified by Exim, unless the
15222 &%-bnq%& command line option is used.
15223
15224 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15225 on the local part. If the &'From:'& header line does not match, Exim adds a
15226 &'Sender:'& header with an address constructed from the calling user's login
15227 and the default qualify domain.
15228
15229 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15230 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15231 &'Sender:'& header lines supplied by untrusted users, you must also set
15232 &%local_sender_retain%& to be true.
15233
15234 .cindex "envelope sender"
15235 These options affect only the header lines in the message. The envelope sender
15236 is still forced to be the login id at the qualify domain unless
15237 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15238
15239 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15240 request similar header line checking. See section &<<SECTthesenhea>>&, which
15241 has more details about &'Sender:'& processing.
15242
15243
15244
15245
15246 .option local_from_prefix main string unset
15247 When Exim checks the &'From:'& header line of locally submitted messages for
15248 matching the login id (see &%local_from_check%& above), it can be configured to
15249 ignore certain prefixes and suffixes in the local part of the address. This is
15250 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15251 appropriate lists, in the same form as the &%local_part_prefix%& and
15252 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15253 example, if
15254 .code
15255 local_from_prefix = *-
15256 .endd
15257 is set, a &'From:'& line containing
15258 .code
15259 From: anything-user@your.domain.example
15260 .endd
15261 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15262 matches the actual sender address that is constructed from the login name and
15263 qualify domain.
15264
15265
15266 .option local_from_suffix main string unset
15267 See &%local_from_prefix%& above.
15268
15269
15270 .option local_interfaces main "string list" "see below"
15271 This option controls which network interfaces are used by the daemon for
15272 listening; they are also used to identify the local host when routing. Chapter
15273 &<<CHAPinterfaces>>& contains a full description of this option and the related
15274 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15275 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15276 &%local_interfaces%& is
15277 .code
15278 local_interfaces = 0.0.0.0
15279 .endd
15280 when Exim is built without IPv6 support; otherwise it is
15281 .code
15282 local_interfaces = <; ::0 ; 0.0.0.0
15283 .endd
15284
15285 .option local_scan_timeout main time 5m
15286 .cindex "timeout" "for &[local_scan()]& function"
15287 .cindex "&[local_scan()]& function" "timeout"
15288 This timeout applies to the &[local_scan()]& function (see chapter
15289 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15290 the incoming message is rejected with a temporary error if it is an SMTP
15291 message. For a non-SMTP message, the message is dropped and Exim ends with a
15292 non-zero code. The incident is logged on the main and reject logs.
15293
15294
15295
15296 .option local_sender_retain main boolean false
15297 .cindex "&'Sender:'& header line" "retaining from local submission"
15298 When a message is submitted locally (that is, not over a TCP/IP connection) by
15299 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15300 do not want this to happen, you must set &%local_sender_retain%&, and you must
15301 also set &%local_from_check%& to be false (Exim will complain if you do not).
15302 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15303 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15304
15305
15306
15307
15308 .option localhost_number main string&!! unset
15309 .cindex "host" "locally unique number for"
15310 .cindex "message ids" "with multiple hosts"
15311 .vindex "&$localhost_number$&"
15312 Exim's message ids are normally unique only within the local host. If
15313 uniqueness among a set of hosts is required, each host must set a different
15314 value for the &%localhost_number%& option. The string is expanded immediately
15315 after reading the configuration file (so that a number can be computed from the
15316 host name, for example) and the result of the expansion must be a number in the
15317 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15318 systems). This is available in subsequent string expansions via the variable
15319 &$localhost_number$&. When &%localhost_number is set%&, the final two
15320 characters of the message id, instead of just being a fractional part of the
15321 time, are computed from the time and the local host number as described in
15322 section &<<SECTmessiden>>&.
15323
15324
15325
15326 .option log_file_path main "string list&!!" "set at compile time"
15327 .cindex "log" "file path for"
15328 This option sets the path which is used to determine the names of Exim's log
15329 files, or indicates that logging is to be to syslog, or both. It is expanded
15330 when Exim is entered, so it can, for example, contain a reference to the host
15331 name. If no specific path is set for the log files at compile or run time,
15332 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15333 they are written in a sub-directory called &_log_& in Exim's spool directory.
15334 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15335 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15336 used. If this string is fixed at your installation (contains no expansion
15337 variables) it is recommended that you do not set this option in the
15338 configuration file, but instead supply the path using LOG_FILE_PATH in
15339 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15340 early on &-- in particular, failure to read the configuration file.
15341
15342
15343 .option log_selector main string unset
15344 .cindex "log" "selectors"
15345 This option can be used to reduce or increase the number of things that Exim
15346 writes to its log files. Its argument is made up of names preceded by plus or
15347 minus characters. For example:
15348 .code
15349 log_selector = +arguments -retry_defer
15350 .endd
15351 A list of possible names and what they control is given in the chapter on
15352 logging, in section &<<SECTlogselector>>&.
15353
15354
15355 .option log_timezone main boolean false
15356 .cindex "log" "timezone for entries"
15357 .vindex "&$tod_log$&"
15358 .vindex "&$tod_zone$&"
15359 By default, the timestamps on log lines are in local time without the
15360 timezone. This means that if your timezone changes twice a year, the timestamps
15361 in log lines are ambiguous for an hour when the clocks go back. One way of
15362 avoiding this problem is to set the timezone to UTC. An alternative is to set
15363 &%log_timezone%& true. This turns on the addition of the timezone offset to
15364 timestamps in log lines. Turning on this option can add quite a lot to the size
15365 of log files because each line is extended by 6 characters. Note that the
15366 &$tod_log$& variable contains the log timestamp without the zone, but there is
15367 another variable called &$tod_zone$& that contains just the timezone offset.
15368
15369
15370 .option lookup_open_max main integer 25
15371 .cindex "too many open files"
15372 .cindex "open files, too many"
15373 .cindex "file" "too many open"
15374 .cindex "lookup" "maximum open files"
15375 .cindex "limit" "open files for lookups"
15376 This option limits the number of simultaneously open files for single-key
15377 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15378 Exim normally keeps these files open during routing, because often the same
15379 file is required several times. If the limit is reached, Exim closes the least
15380 recently used file. Note that if you are using the &'ndbm'& library, it
15381 actually opens two files for each logical DBM database, though it still counts
15382 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15383 open files"& errors with NDBM, you need to reduce the value of
15384 &%lookup_open_max%&.
15385
15386
15387 .option max_username_length main integer 0
15388 .cindex "length of login name"
15389 .cindex "user name" "maximum length"
15390 .cindex "limit" "user name length"
15391 Some operating systems are broken in that they truncate long arguments to
15392 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15393 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15394 an argument that is longer behaves as if &[getpwnam()]& failed.
15395
15396
15397 .option message_body_newlines main bool false
15398 .cindex "message body" "newlines in variables"
15399 .cindex "newline" "in message body variables"
15400 .vindex "&$message_body$&"
15401 .vindex "&$message_body_end$&"
15402 By default, newlines in the message body are replaced by spaces when setting
15403 the &$message_body$& and &$message_body_end$& expansion variables. If this
15404 option is set true, this no longer happens.
15405
15406
15407 .option message_body_visible main integer 500
15408 .cindex "body of message" "visible size"
15409 .cindex "message body" "visible size"
15410 .vindex "&$message_body$&"
15411 .vindex "&$message_body_end$&"
15412 This option specifies how much of a message's body is to be included in the
15413 &$message_body$& and &$message_body_end$& expansion variables.
15414
15415
15416 .option message_id_header_domain main string&!! unset
15417 .cindex "&'Message-ID:'& header line"
15418 If this option is set, the string is expanded and used as the right hand side
15419 (domain) of the &'Message-ID:'& header that Exim creates if a
15420 locally-originated incoming message does not have one. &"Locally-originated"&
15421 means &"not received over TCP/IP."&
15422 Otherwise, the primary host name is used.
15423 Only letters, digits, dot and hyphen are accepted; any other characters are
15424 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15425 empty string, the option is ignored.
15426
15427
15428 .option message_id_header_text main string&!! unset
15429 If this variable is set, the string is expanded and used to augment the text of
15430 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15431 message does not have one. The text of this header is required by RFC 2822 to
15432 take the form of an address. By default, Exim uses its internal message id as
15433 the local part, and the primary host name as the domain. If this option is set,
15434 it is expanded, and provided the expansion is not forced to fail, and does not
15435 yield an empty string, the result is inserted into the header immediately
15436 before the @, separated from the internal message id by a dot. Any characters
15437 that are illegal in an address are automatically converted into hyphens. This
15438 means that variables such as &$tod_log$& can be used, because the spaces and
15439 colons will become hyphens.
15440
15441
15442 .option message_logs main boolean true
15443 .cindex "message logs" "disabling"
15444 .cindex "log" "message log; disabling"
15445 If this option is turned off, per-message log files are not created in the
15446 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15447 Exim, by reducing the number of files involved in handling a message from a
15448 minimum of four (header spool file, body spool file, delivery journal, and
15449 per-message log) to three. The other major I/O activity is Exim's main log,
15450 which is not affected by this option.
15451
15452
15453 .option message_size_limit main string&!! 50M
15454 .cindex "message" "size limit"
15455 .cindex "limit" "message size"
15456 .cindex "size" "of message, limit"
15457 This option limits the maximum size of message that Exim will process. The
15458 value is expanded for each incoming connection so, for example, it can be made
15459 to depend on the IP address of the remote host for messages arriving via
15460 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15461 optionally followed by K or M.
15462
15463 &*Note*&: This limit cannot be made to depend on a message's sender or any
15464 other properties of an individual message, because it has to be advertised in
15465 the server's response to EHLO. String expansion failure causes a temporary
15466 error. A value of zero means no limit, but its use is not recommended. See also
15467 &%bounce_return_size_limit%&.
15468
15469 Incoming SMTP messages are failed with a 552 error if the limit is
15470 exceeded; locally-generated messages either get a stderr message or a delivery
15471 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15472 an oversized message is logged in both the main and the reject logs. See also
15473 the generic transport option &%message_size_limit%&, which limits the size of
15474 message that an individual transport can process.
15475
15476 If you use a virus-scanner and set this option to to a value larger than the
15477 maximum size that your virus-scanner is configured to support, you may get
15478 failures triggered by large mails.  The right size to configure for the
15479 virus-scanner depends upon what data is passed and the options in use but it's
15480 probably safest to just set it to a little larger than this value.  E.g., with a
15481 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15482 some problems may result.
15483
15484 A value of 0 will disable size limit checking; Exim will still advertise the
15485 SIZE extension in an EHLO response, but without a limit, so as to permit
15486 SMTP clients to still indicate the message size along with the MAIL verb.
15487
15488
15489 .option move_frozen_messages main boolean false
15490 .cindex "frozen messages" "moving"
15491 This option, which is available only if Exim has been built with the setting
15492 .code
15493 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15494 .endd
15495 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15496 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15497 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15498 standard utilities for handling such moved messages, and they do not show up in
15499 lists generated by &%-bp%& or by the Exim monitor.
15500
15501
15502 .option mua_wrapper main boolean false
15503 Setting this option true causes Exim to run in a very restrictive mode in which
15504 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15505 contains a full description of this facility.
15506
15507
15508
15509 .option mysql_servers main "string list" unset
15510 .cindex "MySQL" "server list"
15511 This option provides a list of MySQL servers and associated connection data, to
15512 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15513 option is available only if Exim has been built with MySQL support.
15514
15515
15516 .option never_users main "string list&!!" unset
15517 This option is expanded just once, at the start of Exim's processing. Local
15518 message deliveries are normally run in processes that are setuid to the
15519 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15520 It is usually desirable to prevent any deliveries from running as root, as a
15521 safety precaution.
15522
15523 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15524 list of users that must not be used for local deliveries. This list is fixed in
15525 the binary and cannot be overridden by the configuration file. By default, it
15526 contains just the single user name &"root"&. The &%never_users%& runtime option
15527 can be used to add more users to the fixed list.
15528
15529 If a message is to be delivered as one of the users on the fixed list or the
15530 &%never_users%& list, an error occurs, and delivery is deferred. A common
15531 example is
15532 .code
15533 never_users = root:daemon:bin
15534 .endd
15535 Including root is redundant if it is also on the fixed list, but it does no
15536 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15537 transport driver.
15538
15539
15540 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15541 .cindex "OpenSSL "compatibility options"
15542 This option allows an administrator to adjust the SSL options applied
15543 by OpenSSL to connections.  It is given as a space-separated list of items,
15544 each one to be +added or -subtracted from the current value.
15545
15546 This option is only available if Exim is built against OpenSSL.  The values
15547 available for this option vary according to the age of your OpenSSL install.
15548 The &"all"& value controls a subset of flags which are available, typically
15549 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15550 list the values known on your system and Exim should support all the
15551 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15552 names lose the leading &"SSL_OP_"& and are lower-cased.
15553
15554 Note that adjusting the options can have severe impact upon the security of
15555 SSL as used by Exim.  It is possible to disable safety checks and shoot
15556 yourself in the foot in various unpleasant ways.  This option should not be
15557 adjusted lightly.  An unrecognised item will be detected at startup, by
15558 invoking Exim with the &%-bV%& flag.
15559
15560 The option affects Exim operating both as a server and as a client.
15561
15562 Historical note: prior to release 4.80, Exim defaulted this value to
15563 "+dont_insert_empty_fragments", which may still be needed for compatibility
15564 with some clients, but which lowers security by increasing exposure to
15565 some now infamous attacks.
15566
15567 Examples:
15568 .code
15569 # Make both old MS and old Eudora happy:
15570 openssl_options = -all +microsoft_big_sslv3_buffer \
15571                        +dont_insert_empty_fragments
15572
15573 # Disable older protocol versions:
15574 openssl_options = +no_sslv2 +no_sslv3
15575 .endd
15576
15577 Possible options may include:
15578 .ilist
15579 &`all`&
15580 .next
15581 &`allow_unsafe_legacy_renegotiation`&
15582 .next
15583 &`cipher_server_preference`&
15584 .next
15585 &`dont_insert_empty_fragments`&
15586 .next
15587 &`ephemeral_rsa`&
15588 .next
15589 &`legacy_server_connect`&
15590 .next
15591 &`microsoft_big_sslv3_buffer`&
15592 .next
15593 &`microsoft_sess_id_bug`&
15594 .next
15595 &`msie_sslv2_rsa_padding`&
15596 .next
15597 &`netscape_challenge_bug`&
15598 .next
15599 &`netscape_reuse_cipher_change_bug`&
15600 .next
15601 &`no_compression`&
15602 .next
15603 &`no_session_resumption_on_renegotiation`&
15604 .next
15605 &`no_sslv2`&
15606 .next
15607 &`no_sslv3`&
15608 .next
15609 &`no_ticket`&
15610 .next
15611 &`no_tlsv1`&
15612 .next
15613 &`no_tlsv1_1`&
15614 .next
15615 &`no_tlsv1_2`&
15616 .next
15617 &`safari_ecdhe_ecdsa_bug`&
15618 .next
15619 &`single_dh_use`&
15620 .next
15621 &`single_ecdh_use`&
15622 .next
15623 &`ssleay_080_client_dh_bug`&
15624 .next
15625 &`sslref2_reuse_cert_type_bug`&
15626 .next
15627 &`tls_block_padding_bug`&
15628 .next
15629 &`tls_d5_bug`&
15630 .next
15631 &`tls_rollback_bug`&
15632 .endlist
15633
15634 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15635 all clients connecting using the MacOS SecureTransport TLS facility prior
15636 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15637 to negotiate TLS then this option value might help, provided that your OpenSSL
15638 release is new enough to contain this work-around.  This may be a situation
15639 where you have to upgrade OpenSSL to get buggy clients working.
15640
15641
15642 .option oracle_servers main "string list" unset
15643 .cindex "Oracle" "server list"
15644 This option provides a list of Oracle servers and associated connection data,
15645 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15646 The option is available only if Exim has been built with Oracle support.
15647
15648
15649 .option percent_hack_domains main "domain list&!!" unset
15650 .cindex "&""percent hack""&"
15651 .cindex "source routing" "in email address"
15652 .cindex "address" "source-routed"
15653 The &"percent hack"& is the convention whereby a local part containing a
15654 percent sign is re-interpreted as a new email address, with the percent
15655 replaced by @. This is sometimes called &"source routing"&, though that term is
15656 also applied to RFC 2822 addresses that begin with an @ character. If this
15657 option is set, Exim implements the percent facility for those domains listed,
15658 but no others. This happens before an incoming SMTP address is tested against
15659 an ACL.
15660
15661 &*Warning*&: The &"percent hack"& has often been abused by people who are
15662 trying to get round relaying restrictions. For this reason, it is best avoided
15663 if at all possible. Unfortunately, a number of less security-conscious MTAs
15664 implement it unconditionally. If you are running Exim on a gateway host, and
15665 routing mail through to internal MTAs without processing the local parts, it is
15666 a good idea to reject recipient addresses with percent characters in their
15667 local parts. Exim's default configuration does this.
15668
15669
15670 .option perl_at_start main boolean false
15671 This option is available only when Exim is built with an embedded Perl
15672 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15673
15674
15675 .option perl_startup main string unset
15676 This option is available only when Exim is built with an embedded Perl
15677 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15678
15679
15680 .option pgsql_servers main "string list" unset
15681 .cindex "PostgreSQL lookup type" "server list"
15682 This option provides a list of PostgreSQL servers and associated connection
15683 data, to be used in conjunction with &(pgsql)& lookups (see section
15684 &<<SECID72>>&). The option is available only if Exim has been built with
15685 PostgreSQL support.
15686
15687
15688 .option pid_file_path main string&!! "set at compile time"
15689 .cindex "daemon" "pid file path"
15690 .cindex "pid file, path for"
15691 This option sets the name of the file to which the Exim daemon writes its
15692 process id. The string is expanded, so it can contain, for example, references
15693 to the host name:
15694 .code
15695 pid_file_path = /var/log/$primary_hostname/exim.pid
15696 .endd
15697 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15698 spool directory.
15699 The value set by the option can be overridden by the &%-oP%& command line
15700 option. A pid file is not written if a &"non-standard"& daemon is run by means
15701 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15702
15703
15704 .option pipelining_advertise_hosts main "host list&!!" *
15705 .cindex "PIPELINING" "suppressing advertising"
15706 This option can be used to suppress the advertisement of the SMTP
15707 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15708 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15709 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15710 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15711 that clients will use it; &"out of order"& commands that are &"expected"& do
15712 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15713
15714
15715 .option prdr_enable main boolean false
15716 .cindex "PRDR" "enabling on server"
15717 This option can be used to enable the Per-Recipient Data Response extension
15718 to SMTP, defined by Eric Hall.
15719 If the option is set, PRDR is advertised by Exim when operating as a server.
15720 If the client requests PRDR, and more than one recipient, for a message
15721 an additional ACL is called for each recipient after the message content
15722 is received.  See section &<<SECTPRDRACL>>&.
15723
15724 .option preserve_message_logs main boolean false
15725 .cindex "message logs" "preserving"
15726 If this option is set, message log files are not deleted when messages are
15727 completed. Instead, they are moved to a sub-directory of the spool directory
15728 called &_msglog.OLD_&, where they remain available for statistical or debugging
15729 purposes. This is a dangerous option to set on systems with any appreciable
15730 volume of mail. Use with care!
15731
15732
15733 .option primary_hostname main string "see below"
15734 .cindex "name" "of local host"
15735 .cindex "host" "name of local"
15736 .cindex "local host" "name of"
15737 .vindex "&$primary_hostname$&"
15738 This specifies the name of the current host. It is used in the default EHLO or
15739 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15740 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15741 The value is also used by default in some SMTP response messages from an Exim
15742 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15743
15744 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15745 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15746 contains only one component, Exim passes it to &[gethostbyname()]& (or
15747 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15748 version. The variable &$primary_hostname$& contains the host name, whether set
15749 explicitly by this option, or defaulted.
15750
15751
15752 .option print_topbitchars main boolean false
15753 .cindex "printing characters"
15754 .cindex "8-bit characters"
15755 By default, Exim considers only those characters whose codes lie in the range
15756 32&--126 to be printing characters. In a number of circumstances (for example,
15757 when writing log entries) non-printing characters are converted into escape
15758 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15759 is set, code values of 128 and above are also considered to be printing
15760 characters.
15761
15762 This option also affects the header syntax checks performed by the
15763 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15764 the user's full name when constructing From: and Sender: addresses (as
15765 described in section &<<SECTconstr>>&). Setting this option can cause
15766 Exim to generate eight bit message headers that do not conform to the
15767 standards.
15768
15769
15770 .option process_log_path main string unset
15771 .cindex "process log path"
15772 .cindex "log" "process log"
15773 .cindex "&'exiwhat'&"
15774 This option sets the name of the file to which an Exim process writes its
15775 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15776 utility script. If this option is unset, the file called &_exim-process.info_&
15777 in Exim's spool directory is used. The ability to specify the name explicitly
15778 can be useful in environments where two different Exims are running, using
15779 different spool directories.
15780
15781
15782 .option prod_requires_admin main boolean true
15783 .oindex "&%-M%&"
15784 .oindex "&%-R%&"
15785 .oindex "&%-q%&"
15786 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15787 admin user unless &%prod_requires_admin%& is set false. See also
15788 &%queue_list_requires_admin%&.
15789
15790
15791 .option qualify_domain main string "see below"
15792 .cindex "domain" "for qualifying addresses"
15793 .cindex "address" "qualification"
15794 This option specifies the domain name that is added to any envelope sender
15795 addresses that do not have a domain qualification. It also applies to
15796 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15797 are accepted by default only for locally-generated messages. Qualification is
15798 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15799 locally-generated messages, unless the &%-bnq%& command line option is used.
15800
15801 Messages from external sources must always contain fully qualified addresses,
15802 unless the sending host matches &%sender_unqualified_hosts%& or
15803 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15804 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15805 necessary. Internally, Exim always works with fully qualified envelope
15806 addresses. If &%qualify_domain%& is not set, it defaults to the
15807 &%primary_hostname%& value.
15808
15809
15810 .option qualify_recipient main string "see below"
15811 This option allows you to specify a different domain for qualifying recipient
15812 addresses to the one that is used for senders. See &%qualify_domain%& above.
15813
15814
15815
15816 .option queue_domains main "domain list&!!" unset
15817 .cindex "domain" "specifying non-immediate delivery"
15818 .cindex "queueing incoming messages"
15819 .cindex "message" "queueing certain domains"
15820 This option lists domains for which immediate delivery is not required.
15821 A delivery process is started whenever a message is received, but only those
15822 domains that do not match are processed. All other deliveries wait until the
15823 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15824
15825
15826 .option queue_list_requires_admin main boolean true
15827 .oindex "&%-bp%&"
15828 The &%-bp%& command-line option, which lists the messages that are on the
15829 queue, requires the caller to be an admin user unless
15830 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15831
15832
15833 .option queue_only main boolean false
15834 .cindex "queueing incoming messages"
15835 .cindex "message" "queueing unconditionally"
15836 If &%queue_only%& is set, a delivery process is not automatically started
15837 whenever a message is received. Instead, the message waits on the queue for the
15838 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15839 delivered immediately when certain conditions (such as heavy load) occur.
15840
15841 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15842 and &%-odi%& command line options override &%queue_only%& unless
15843 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15844 &%queue_only_load%&, and &%smtp_accept_queue%&.
15845
15846
15847 .option queue_only_file main string unset
15848 .cindex "queueing incoming messages"
15849 .cindex "message" "queueing by file existence"
15850 This option can be set to a colon-separated list of absolute path names, each
15851 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15852 it tests for the existence of each listed path using a call to &[stat()]&. For
15853 each path that exists, the corresponding queueing option is set.
15854 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15855 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15856 .code
15857 queue_only_file = smtp/some/file
15858 .endd
15859 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15860 &_/some/file_& exists.
15861
15862
15863 .option queue_only_load main fixed-point unset
15864 .cindex "load average"
15865 .cindex "queueing incoming messages"
15866 .cindex "message" "queueing by load"
15867 If the system load average is higher than this value, incoming messages from
15868 all sources are queued, and no automatic deliveries are started. If this
15869 happens during local or remote SMTP input, all subsequent messages received on
15870 the same SMTP connection are queued by default, whatever happens to the load in
15871 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15872 false.
15873
15874 Deliveries will subsequently be performed by queue runner processes. This
15875 option has no effect on ancient operating systems on which Exim cannot
15876 determine the load average. See also &%deliver_queue_load_max%& and
15877 &%smtp_load_reserve%&.
15878
15879
15880 .option queue_only_load_latch main boolean true
15881 .cindex "load average" "re-evaluating per message"
15882 When this option is true (the default), once one message has been queued
15883 because the load average is higher than the value set by &%queue_only_load%&,
15884 all subsequent messages received on the same SMTP connection are also queued.
15885 This is a deliberate choice; even though the load average may fall below the
15886 threshold, it doesn't seem right to deliver later messages on the same
15887 connection when not delivering earlier ones. However, there are special
15888 circumstances such as very long-lived connections from scanning appliances
15889 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15890 should be set false. This causes the value of the load average to be
15891 re-evaluated for each message.
15892
15893
15894 .option queue_only_override main boolean true
15895 .cindex "queueing incoming messages"
15896 When this option is true, the &%-od%&&'x'& command line options override the
15897 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15898 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15899 to override; they are accepted, but ignored.
15900
15901
15902 .option queue_run_in_order main boolean false
15903 .cindex "queue runner" "processing messages in order"
15904 If this option is set, queue runs happen in order of message arrival instead of
15905 in an arbitrary order. For this to happen, a complete list of the entire queue
15906 must be set up before the deliveries start. When the queue is all held in a
15907 single directory (the default), a single list is created for both the ordered
15908 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15909 single list is not created when &%queue_run_in_order%& is false. In this case,
15910 the sub-directories are processed one at a time (in a random order), and this
15911 avoids setting up one huge list for the whole queue. Thus, setting
15912 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15913 when the queue is large, because of the extra work in setting up the single,
15914 large list. In most situations, &%queue_run_in_order%& should not be set.
15915
15916
15917
15918 .option queue_run_max main integer 5
15919 .cindex "queue runner" "maximum number of"
15920 This controls the maximum number of queue runner processes that an Exim daemon
15921 can run simultaneously. This does not mean that it starts them all at once,
15922 but rather that if the maximum number are still running when the time comes to
15923 start another one, it refrains from starting another one. This can happen with
15924 very large queues and/or very sluggish deliveries. This option does not,
15925 however, interlock with other processes, so additional queue runners can be
15926 started by other means, or by killing and restarting the daemon.
15927
15928 Setting this option to zero does not suppress queue runs; rather, it disables
15929 the limit, allowing any number of simultaneous queue runner processes to be
15930 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15931 the daemon's command line.
15932
15933 .option queue_smtp_domains main "domain list&!!" unset
15934 .cindex "queueing incoming messages"
15935 .cindex "message" "queueing remote deliveries"
15936 When this option is set, a delivery process is started whenever a message is
15937 received, routing is performed, and local deliveries take place.
15938 However, if any SMTP deliveries are required for domains that match
15939 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15940 message waits on the queue for the next queue run. Since routing of the message
15941 has taken place, Exim knows to which remote hosts it must be delivered, and so
15942 when the queue run happens, multiple messages for the same host are delivered
15943 over a single SMTP connection. The &%-odqs%& command line option causes all
15944 SMTP deliveries to be queued in this way, and is equivalent to setting
15945 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15946 &%queue_domains%&.
15947
15948
15949 .option receive_timeout main time 0s
15950 .cindex "timeout" "for non-SMTP input"
15951 This option sets the timeout for accepting a non-SMTP message, that is, the
15952 maximum time that Exim waits when reading a message on the standard input. If
15953 the value is zero, it will wait for ever. This setting is overridden by the
15954 &%-or%& command line option. The timeout for incoming SMTP messages is
15955 controlled by &%smtp_receive_timeout%&.
15956
15957 .option received_header_text main string&!! "see below"
15958 .cindex "customizing" "&'Received:'& header"
15959 .cindex "&'Received:'& header line" "customizing"
15960 This string defines the contents of the &'Received:'& message header that is
15961 added to each message, except for the timestamp, which is automatically added
15962 on at the end (preceded by a semicolon). The string is expanded each time it is
15963 used. If the expansion yields an empty string, no &'Received:'& header line is
15964 added to the message. Otherwise, the string should start with the text
15965 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15966 header lines. The default setting is:
15967
15968 .code
15969 received_header_text = Received: \
15970   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15971   {${if def:sender_ident \
15972   {from ${quote_local_part:$sender_ident} }}\
15973   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15974   by $primary_hostname \
15975   ${if def:received_protocol {with $received_protocol}} \
15976   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15977   (Exim $version_number)\n\t\
15978   ${if def:sender_address \
15979   {(envelope-from <$sender_address>)\n\t}}\
15980   id $message_exim_id\
15981   ${if def:received_for {\n\tfor $received_for}}
15982 .endd
15983
15984 The reference to the TLS cipher is omitted when Exim is built without TLS
15985 support. The use of conditional expansions ensures that this works for both
15986 locally generated messages and messages received from remote hosts, giving
15987 header lines such as the following:
15988 .code
15989 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15990 by marley.carol.example with esmtp (Exim 4.00)
15991 (envelope-from <bob@carol.example>)
15992 id 16IOWa-00019l-00
15993 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15994 Received: by scrooge.carol.example with local (Exim 4.00)
15995 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15996 .endd
15997 Until the body of the message has been received, the timestamp is the time when
15998 the message started to be received. Once the body has arrived, and all policy
15999 checks have taken place, the timestamp is updated to the time at which the
16000 message was accepted.
16001
16002
16003 .option received_headers_max main integer 30
16004 .cindex "loop" "prevention"
16005 .cindex "mail loop prevention"
16006 .cindex "&'Received:'& header line" "counting"
16007 When a message is to be delivered, the number of &'Received:'& headers is
16008 counted, and if it is greater than this parameter, a mail loop is assumed to
16009 have occurred, the delivery is abandoned, and an error message is generated.
16010 This applies to both local and remote deliveries.
16011
16012
16013 .option recipient_unqualified_hosts main "host list&!!" unset
16014 .cindex "unqualified addresses"
16015 .cindex "host" "unqualified addresses from"
16016 This option lists those hosts from which Exim is prepared to accept unqualified
16017 recipient addresses in message envelopes. The addresses are made fully
16018 qualified by the addition of the &%qualify_recipient%& value. This option also
16019 affects message header lines. Exim does not reject unqualified recipient
16020 addresses in headers, but it qualifies them only if the message came from a
16021 host that matches &%recipient_unqualified_hosts%&,
16022 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16023 option was not set.
16024
16025
16026 .option recipients_max main integer 0
16027 .cindex "limit" "number of recipients"
16028 .cindex "recipient" "maximum number"
16029 If this option is set greater than zero, it specifies the maximum number of
16030 original recipients for any message. Additional recipients that are generated
16031 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16032 all recipients over the limit; earlier recipients are delivered as normal.
16033 Non-SMTP messages with too many recipients are failed, and no deliveries are
16034 done.
16035
16036 .cindex "RCPT" "maximum number of incoming"
16037 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16038 RCPT commands in a single message.
16039
16040
16041 .option recipients_max_reject main boolean false
16042 If this option is set true, Exim rejects SMTP messages containing too many
16043 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16044 error to the eventual DATA command. Otherwise (the default) it gives a 452
16045 error to the surplus RCPT commands and accepts the message on behalf of the
16046 initial set of recipients. The remote server should then re-send the message
16047 for the remaining recipients at a later time.
16048
16049
16050 .option remote_max_parallel main integer 2
16051 .cindex "delivery" "parallelism for remote"
16052 This option controls parallel delivery of one message to a number of remote
16053 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16054 does all the remote deliveries for a message one by one. Otherwise, if a single
16055 message has to be delivered to more than one remote host, or if several copies
16056 have to be sent to the same remote host, up to &%remote_max_parallel%&
16057 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16058 deliveries are required, the maximum number of processes are started, and as
16059 each one finishes, another is begun. The order of starting processes is the
16060 same as if sequential delivery were being done, and can be controlled by the
16061 &%remote_sort_domains%& option. If parallel delivery takes place while running
16062 with debugging turned on, the debugging output from each delivery process is
16063 tagged with its process id.
16064
16065 This option controls only the maximum number of parallel deliveries for one
16066 message in one Exim delivery process. Because Exim has no central queue
16067 manager, there is no way of controlling the total number of simultaneous
16068 deliveries if the configuration allows a delivery attempt as soon as a message
16069 is received.
16070
16071 .cindex "number of deliveries"
16072 .cindex "delivery" "maximum number of"
16073 If you want to control the total number of deliveries on the system, you
16074 need to set the &%queue_only%& option. This ensures that all incoming messages
16075 are added to the queue without starting a delivery process. Then set up an Exim
16076 daemon to start queue runner processes at appropriate intervals (probably
16077 fairly often, for example, every minute), and limit the total number of queue
16078 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16079 delivers only one message at a time, the maximum number of deliveries that can
16080 then take place at once is &%queue_run_max%& multiplied by
16081 &%remote_max_parallel%&.
16082
16083 If it is purely remote deliveries you want to control, use
16084 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16085 doing the SMTP routing before queueing, so that several messages for the same
16086 host will eventually get delivered down the same connection.
16087
16088
16089 .option remote_sort_domains main "domain list&!!" unset
16090 .cindex "sorting remote deliveries"
16091 .cindex "delivery" "sorting remote"
16092 When there are a number of remote deliveries for a message, they are sorted by
16093 domain into the order given by this list. For example,
16094 .code
16095 remote_sort_domains = *.cam.ac.uk:*.uk
16096 .endd
16097 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16098 then to those in the &%uk%& domain, then to any others.
16099
16100
16101 .option retry_data_expire main time 7d
16102 .cindex "hints database" "data expiry"
16103 This option sets a &"use before"& time on retry information in Exim's hints
16104 database. Any older retry data is ignored. This means that, for example, once a
16105 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16106 past failures.
16107
16108
16109 .option retry_interval_max main time 24h
16110 .cindex "retry" "limit on interval"
16111 .cindex "limit" "on retry interval"
16112 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16113 intervals between delivery attempts for messages that cannot be delivered
16114 straight away. This option sets an overall limit to the length of time between
16115 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16116 the default value.
16117
16118
16119 .option return_path_remove main boolean true
16120 .cindex "&'Return-path:'& header line" "removing"
16121 RFC 2821, section 4.4, states that an SMTP server must insert a
16122 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16123 The &'Return-path:'& header preserves the sender address as received in the
16124 MAIL command. This description implies that this header should not be present
16125 in an incoming message. If &%return_path_remove%& is true, any existing
16126 &'Return-path:'& headers are removed from messages at the time they are
16127 received. Exim's transports have options for adding &'Return-path:'& headers at
16128 the time of delivery. They are normally used only for final local deliveries.
16129
16130
16131 .option return_size_limit main integer 100K
16132 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16133
16134
16135 .option rfc1413_hosts main "host list&!!" @[]
16136 .cindex "RFC 1413"
16137 .cindex "host" "for RFC 1413 calls"
16138 RFC 1413 identification calls are made to any client host which matches
16139 an item in the list.
16140 The default value specifies just this host, being any local interface
16141 for the system.
16142
16143 .option rfc1413_query_timeout main time 0s
16144 .cindex "RFC 1413" "query timeout"
16145 .cindex "timeout" "for RFC 1413 call"
16146 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16147 no RFC 1413 calls are ever made.
16148
16149
16150 .option sender_unqualified_hosts main "host list&!!" unset
16151 .cindex "unqualified addresses"
16152 .cindex "host" "unqualified addresses from"
16153 This option lists those hosts from which Exim is prepared to accept unqualified
16154 sender addresses. The addresses are made fully qualified by the addition of
16155 &%qualify_domain%&. This option also affects message header lines. Exim does
16156 not reject unqualified addresses in headers that contain sender addresses, but
16157 it qualifies them only if the message came from a host that matches
16158 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16159 using TCP/IP), and the &%-bnq%& option was not set.
16160
16161 .option set_environment main "string list" empty
16162 .cindex "environment"
16163 This option allows to set individual environment variables that the
16164 currently linked libraries and programs in child processes use. The
16165 default list is empty,
16166
16167
16168 .option slow_lookup_log main integer 0
16169 .cindex "logging" "slow lookups"
16170 .cindex "dns" "logging slow lookups"
16171 This option controls logging of slow lookups.
16172 If the value is nonzero it is taken as a number of milliseconds
16173 and lookups taking longer than this are logged.
16174 Currently this applies only to DNS lookups.
16175
16176
16177
16178 .option smtp_accept_keepalive main boolean true
16179 .cindex "keepalive" "on incoming connection"
16180 This option controls the setting of the SO_KEEPALIVE option on incoming
16181 TCP/IP socket connections. When set, it causes the kernel to probe idle
16182 connections periodically, by sending packets with &"old"& sequence numbers. The
16183 other end of the connection should send an acknowledgment if the connection is
16184 still okay or a reset if the connection has been aborted. The reason for doing
16185 this is that it has the beneficial effect of freeing up certain types of
16186 connection that can get stuck when the remote host is disconnected without
16187 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16188 hours to detect unreachable hosts.
16189
16190
16191
16192 .option smtp_accept_max main integer 20
16193 .cindex "limit" "incoming SMTP connections"
16194 .cindex "SMTP" "incoming connection count"
16195 .cindex "inetd"
16196 This option specifies the maximum number of simultaneous incoming SMTP calls
16197 that Exim will accept. It applies only to the listening daemon; there is no
16198 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16199 value is set to zero, no limit is applied. However, it is required to be
16200 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16201 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16202
16203 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16204 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16205 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16206 and &%smtp_load_reserve%& are then checked before accepting the connection.
16207
16208
16209 .option smtp_accept_max_nonmail main integer 10
16210 .cindex "limit" "non-mail SMTP commands"
16211 .cindex "SMTP" "limiting non-mail commands"
16212 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16213 the connection if there are too many. This option defines &"too many"&. The
16214 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16215 client looping sending EHLO, for example. The check is applied only if the
16216 client host matches &%smtp_accept_max_nonmail_hosts%&.
16217
16218 When a new message is expected, one occurrence of RSET is not counted. This
16219 allows a client to send one RSET between messages (this is not necessary,
16220 but some clients do it). Exim also allows one uncounted occurrence of HELO
16221 or EHLO, and one occurrence of STARTTLS between messages. After
16222 starting up a TLS session, another EHLO is expected, and so it too is not
16223 counted. The first occurrence of AUTH in a connection, or immediately
16224 following STARTTLS is not counted. Otherwise, all commands other than
16225 MAIL, RCPT, DATA, and QUIT are counted.
16226
16227
16228 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16229 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16230 check by setting this option. The default value makes it apply to all hosts. By
16231 changing the value, you can exclude any badly-behaved hosts that you have to
16232 live with.
16233
16234
16235 . Allow this long option name to split; give it unsplit as a fifth argument
16236 . for the automatic .oindex that is generated by .option.
16237 . We insert " &~&~" which is both pretty nasty visually and results in
16238 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16239 . zero-width-space, which would be nicer visually and results in (at least)
16240 . html that Firefox will split on when it's forced to reflow (rather than
16241 . inserting a horizontal scrollbar).  However, the text is still not
16242 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16243 . the option name to split.
16244
16245 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16246          smtp_accept_max_per_connection
16247 .cindex "SMTP" "limiting incoming message count"
16248 .cindex "limit" "messages per SMTP connection"
16249 The value of this option limits the number of MAIL commands that Exim is
16250 prepared to accept over a single SMTP connection, whether or not each command
16251 results in the transfer of a message. After the limit is reached, a 421
16252 response is given to subsequent MAIL commands. This limit is a safety
16253 precaution against a client that goes mad (incidents of this type have been
16254 seen).
16255
16256
16257 .option smtp_accept_max_per_host main string&!! unset
16258 .cindex "limit" "SMTP connections from one host"
16259 .cindex "host" "limiting SMTP connections from"
16260 This option restricts the number of simultaneous IP connections from a single
16261 host (strictly, from a single IP address) to the Exim daemon. The option is
16262 expanded, to enable different limits to be applied to different hosts by
16263 reference to &$sender_host_address$&. Once the limit is reached, additional
16264 connection attempts from the same host are rejected with error code 421. This
16265 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16266 of zero imposes no limit. If this option is set greater than zero, it is
16267 required that &%smtp_accept_max%& be non-zero.
16268
16269 &*Warning*&: When setting this option you should not use any expansion
16270 constructions that take an appreciable amount of time. The expansion and test
16271 happen in the main daemon loop, in order to reject additional connections
16272 without forking additional processes (otherwise a denial-of-service attack
16273 could cause a vast number or processes to be created). While the daemon is
16274 doing this processing, it cannot accept any other incoming connections.
16275
16276
16277
16278 .option smtp_accept_queue main integer 0
16279 .cindex "SMTP" "incoming connection count"
16280 .cindex "queueing incoming messages"
16281 .cindex "message" "queueing by SMTP connection count"
16282 If the number of simultaneous incoming SMTP connections being handled via the
16283 listening daemon exceeds this value, messages received by SMTP are just placed
16284 on the queue; no delivery processes are started automatically. The count is
16285 fixed at the start of an SMTP connection. It cannot be updated in the
16286 subprocess that receives messages, and so the queueing or not queueing applies
16287 to all messages received in the same connection.
16288
16289 A value of zero implies no limit, and clearly any non-zero value is useful only
16290 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16291 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16292 various &%-od%&&'x'& command line options.
16293
16294
16295 . See the comment on smtp_accept_max_per_connection
16296
16297 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16298          smtp_accept_queue_per_connection
16299 .cindex "queueing incoming messages"
16300 .cindex "message" "queueing by message count"
16301 This option limits the number of delivery processes that Exim starts
16302 automatically when receiving messages via SMTP, whether via the daemon or by
16303 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16304 and the number of messages received in a single SMTP session exceeds this
16305 number, subsequent messages are placed on the queue, but no delivery processes
16306 are started. This helps to limit the number of Exim processes when a server
16307 restarts after downtime and there is a lot of mail waiting for it on other
16308 systems. On large systems, the default should probably be increased, and on
16309 dial-in client systems it should probably be set to zero (that is, disabled).
16310
16311
16312 .option smtp_accept_reserve main integer 0
16313 .cindex "SMTP" "incoming call count"
16314 .cindex "host" "reserved"
16315 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16316 number of SMTP connections that are reserved for connections from the hosts
16317 that are specified in &%smtp_reserve_hosts%&. The value set in
16318 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16319 restricted to this number of connections; the option specifies a minimum number
16320 of connection slots for them, not a maximum. It is a guarantee that this group
16321 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16322 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16323 individual host.
16324
16325 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16326 set to 5, once there are 45 active connections (from any hosts), new
16327 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16328 provided the other criteria for acceptance are met.
16329
16330
16331 .option smtp_active_hostname main string&!! unset
16332 .cindex "host" "name in SMTP responses"
16333 .cindex "SMTP" "host name in responses"
16334 .vindex "&$primary_hostname$&"
16335 This option is provided for multi-homed servers that want to masquerade as
16336 several different hosts. At the start of an incoming SMTP connection, its value
16337 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16338 responses. For example, it is used as domain name in the response to an
16339 incoming HELO or EHLO command.
16340
16341 .vindex "&$smtp_active_hostname$&"
16342 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16343 is saved with any messages that are received. It is therefore available for use
16344 in routers and transports when the message is later delivered.
16345
16346 If this option is unset, or if its expansion is forced to fail, or if the
16347 expansion results in an empty string, the value of &$primary_hostname$& is
16348 used. Other expansion failures cause a message to be written to the main and
16349 panic logs, and the SMTP command receives a temporary error. Typically, the
16350 value of &%smtp_active_hostname%& depends on the incoming interface address.
16351 For example:
16352 .code
16353 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16354   {cox.mydomain}{box.mydomain}}
16355 .endd
16356
16357 Although &$smtp_active_hostname$& is primarily concerned with incoming
16358 messages, it is also used as the default for HELO commands in callout
16359 verification if there is no remote transport from which to obtain a
16360 &%helo_data%& value.
16361
16362 .option smtp_banner main string&!! "see below"
16363 .cindex "SMTP" "welcome banner"
16364 .cindex "banner for SMTP"
16365 .cindex "welcome banner for SMTP"
16366 .cindex "customizing" "SMTP banner"
16367 This string, which is expanded every time it is used, is output as the initial
16368 positive response to an SMTP connection. The default setting is:
16369 .code
16370 smtp_banner = $smtp_active_hostname ESMTP Exim \
16371   $version_number $tod_full
16372 .endd
16373 Failure to expand the string causes a panic error. If you want to create a
16374 multiline response to the initial SMTP connection, use &"\n"& in the string at
16375 appropriate points, but not at the end. Note that the 220 code is not included
16376 in this string. Exim adds it automatically (several times in the case of a
16377 multiline response).
16378
16379
16380 .option smtp_check_spool_space main boolean true
16381 .cindex "checking disk space"
16382 .cindex "disk space, checking"
16383 .cindex "spool directory" "checking space"
16384 When this option is set, if an incoming SMTP session encounters the SIZE
16385 option on a MAIL command, it checks that there is enough space in the
16386 spool directory's partition to accept a message of that size, while still
16387 leaving free the amount specified by &%check_spool_space%& (even if that value
16388 is zero). If there isn't enough space, a temporary error code is returned.
16389
16390
16391 .option smtp_connect_backlog main integer 20
16392 .cindex "connection backlog"
16393 .cindex "SMTP" "connection backlog"
16394 .cindex "backlog of connections"
16395 This option specifies a maximum number of waiting SMTP connections. Exim passes
16396 this value to the TCP/IP system when it sets up its listener. Once this number
16397 of connections are waiting for the daemon's attention, subsequent connection
16398 attempts are refused at the TCP/IP level. At least, that is what the manuals
16399 say; in some circumstances such connection attempts have been observed to time
16400 out instead. For large systems it is probably a good idea to increase the
16401 value (to 50, say). It also gives some protection against denial-of-service
16402 attacks by SYN flooding.
16403
16404
16405 .option smtp_enforce_sync main boolean true
16406 .cindex "SMTP" "synchronization checking"
16407 .cindex "synchronization checking in SMTP"
16408 The SMTP protocol specification requires the client to wait for a response from
16409 the server at certain points in the dialogue. Without PIPELINING these
16410 synchronization points are after every command; with PIPELINING they are
16411 fewer, but they still exist.
16412
16413 Some spamming sites send out a complete set of SMTP commands without waiting
16414 for any response. Exim protects against this by rejecting a message if the
16415 client has sent further input when it should not have. The error response &"554
16416 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16417 for this error cannot be perfect because of transmission delays (unexpected
16418 input may be on its way but not yet received when Exim checks). However, it
16419 does detect many instances.
16420
16421 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16422 If you want to disable the check selectively (for example, only for certain
16423 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16424 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16425
16426
16427
16428 .option smtp_etrn_command main string&!! unset
16429 .cindex "ETRN" "command to be run"
16430 .vindex "&$domain$&"
16431 If this option is set, the given command is run whenever an SMTP ETRN
16432 command is received from a host that is permitted to issue such commands (see
16433 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16434 are independently expanded. The expansion variable &$domain$& is set to the
16435 argument of the ETRN command, and no syntax checking is done on it. For
16436 example:
16437 .code
16438 smtp_etrn_command = /etc/etrn_command $domain \
16439                     $sender_host_address
16440 .endd
16441 A new process is created to run the command, but Exim does not wait for it to
16442 complete. Consequently, its status cannot be checked. If the command cannot be
16443 run, a line is written to the panic log, but the ETRN caller still receives
16444 a 250 success response. Exim is normally running under its own uid when
16445 receiving SMTP, so it is not possible for it to change the uid before running
16446 the command.
16447
16448
16449 .option smtp_etrn_serialize main boolean true
16450 .cindex "ETRN" "serializing"
16451 When this option is set, it prevents the simultaneous execution of more than
16452 one identical command as a result of ETRN in an SMTP connection. See
16453 section &<<SECTETRN>>& for details.
16454
16455
16456 .option smtp_load_reserve main fixed-point unset
16457 .cindex "load average"
16458 If the system load average ever gets higher than this, incoming SMTP calls are
16459 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16460 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16461 the load is over the limit. The option has no effect on ancient operating
16462 systems on which Exim cannot determine the load average. See also
16463 &%deliver_queue_load_max%& and &%queue_only_load%&.
16464
16465
16466
16467 .option smtp_max_synprot_errors main integer 3
16468 .cindex "SMTP" "limiting syntax and protocol errors"
16469 .cindex "limit" "SMTP syntax and protocol errors"
16470 Exim rejects SMTP commands that contain syntax or protocol errors. In
16471 particular, a syntactically invalid email address, as in this command:
16472 .code
16473 RCPT TO:<abc xyz@a.b.c>
16474 .endd
16475 causes immediate rejection of the command, before any other tests are done.
16476 (The ACL cannot be run if there is no valid address to set up for it.) An
16477 example of a protocol error is receiving RCPT before MAIL. If there are
16478 too many syntax or protocol errors in one SMTP session, the connection is
16479 dropped. The limit is set by this option.
16480
16481 .cindex "PIPELINING" "expected errors"
16482 When the PIPELINING extension to SMTP is in use, some protocol errors are
16483 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16484 Exim assumes that PIPELINING will be used if it advertises it (see
16485 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16486 not count towards the limit.
16487
16488
16489
16490 .option smtp_max_unknown_commands main integer 3
16491 .cindex "SMTP" "limiting unknown commands"
16492 .cindex "limit" "unknown SMTP commands"
16493 If there are too many unrecognized commands in an incoming SMTP session, an
16494 Exim server drops the connection. This is a defence against some kinds of abuse
16495 that subvert web
16496 clients
16497 into making connections to SMTP ports; in these circumstances, a number of
16498 non-SMTP command lines are sent first.
16499
16500
16501
16502 .option smtp_ratelimit_hosts main "host list&!!" unset
16503 .cindex "SMTP" "rate limiting"
16504 .cindex "limit" "rate of message arrival"
16505 .cindex "RCPT" "rate limiting"
16506 Some sites find it helpful to be able to limit the rate at which certain hosts
16507 can send them messages, and the rate at which an individual message can specify
16508 recipients.
16509
16510 Exim has two rate-limiting facilities. This section describes the older
16511 facility, which can limit rates within a single connection. The newer
16512 &%ratelimit%& ACL condition can limit rates across all connections. See section
16513 &<<SECTratelimiting>>& for details of the newer facility.
16514
16515 When a host matches &%smtp_ratelimit_hosts%&, the values of
16516 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16517 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16518 respectively. Each option, if set, must contain a set of four comma-separated
16519 values:
16520
16521 .ilist
16522 A threshold, before which there is no rate limiting.
16523 .next
16524 An initial time delay. Unlike other times in Exim, numbers with decimal
16525 fractional parts are allowed here.
16526 .next
16527 A factor by which to increase the delay each time.
16528 .next
16529 A maximum value for the delay. This should normally be less than 5 minutes,
16530 because after that time, the client is liable to timeout the SMTP command.
16531 .endlist
16532
16533 For example, these settings have been used successfully at the site which
16534 first suggested this feature, for controlling mail from their customers:
16535 .code
16536 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16537 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16538 .endd
16539 The first setting specifies delays that are applied to MAIL commands after
16540 two have been received over a single connection. The initial delay is 0.5
16541 seconds, increasing by a factor of 1.05 each time. The second setting applies
16542 delays to RCPT commands when more than four occur in a single message.
16543
16544
16545 .option smtp_ratelimit_mail main string unset
16546 See &%smtp_ratelimit_hosts%& above.
16547
16548
16549 .option smtp_ratelimit_rcpt main string unset
16550 See &%smtp_ratelimit_hosts%& above.
16551
16552
16553 .option smtp_receive_timeout main time&!! 5m
16554 .cindex "timeout" "for SMTP input"
16555 .cindex "SMTP" "input timeout"
16556 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16557 input, including batch SMTP. If a line of input (either an SMTP command or a
16558 data line) is not received within this time, the SMTP connection is dropped and
16559 the message is abandoned.
16560 A line is written to the log containing one of the following messages:
16561 .code
16562 SMTP command timeout on connection from...
16563 SMTP data timeout on connection from...
16564 .endd
16565 The former means that Exim was expecting to read an SMTP command; the latter
16566 means that it was in the DATA phase, reading the contents of a message.
16567
16568 If the first character of the option is a &"$"& the option is
16569 expanded before use and may depend on
16570 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16571
16572
16573 .oindex "&%-os%&"
16574 The value set by this option can be overridden by the
16575 &%-os%& command-line option. A setting of zero time disables the timeout, but
16576 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16577 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16578 timeout is controlled by &%receive_timeout%& and &%-or%&.
16579
16580
16581 .option smtp_reserve_hosts main "host list&!!" unset
16582 This option defines hosts for which SMTP connections are reserved; see
16583 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16584
16585
16586 .option smtp_return_error_details main boolean false
16587 .cindex "SMTP" "details policy failures"
16588 .cindex "policy control" "rejection, returning details"
16589 In the default state, Exim uses bland messages such as
16590 &"Administrative prohibition"& when it rejects SMTP commands for policy
16591 reasons. Many sysadmins like this because it gives away little information
16592 to spammers. However, some other sysadmins who are applying strict checking
16593 policies want to give out much fuller information about failures. Setting
16594 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16595 example, instead of &"Administrative prohibition"&, it might give:
16596 .code
16597 550-Rejected after DATA: '>' missing at end of address:
16598 550 failing address in "From" header is: <user@dom.ain
16599 .endd
16600
16601
16602 .new
16603 .option smtputf8_advertise_hosts main "host list&!!" *
16604 .cindex "SMTPUTF8" "advertising"
16605 When Exim is built with support for internationalised mail names,
16606 the availability therof is advertised in
16607 response to EHLO only to those client hosts that match this option. See
16608 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16609 .wen
16610
16611
16612 .option spamd_address main string "see below"
16613 This option is available when Exim is compiled with the content-scanning
16614 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16615 The default value is
16616 .code
16617 127.0.0.1 783
16618 .endd
16619 See section &<<SECTscanspamass>>& for more details.
16620
16621
16622
16623 .option split_spool_directory main boolean false
16624 .cindex "multiple spool directories"
16625 .cindex "spool directory" "split"
16626 .cindex "directories, multiple"
16627 If this option is set, it causes Exim to split its input directory into 62
16628 subdirectories, each with a single alphanumeric character as its name. The
16629 sixth character of the message id is used to allocate messages to
16630 subdirectories; this is the least significant base-62 digit of the time of
16631 arrival of the message.
16632
16633 Splitting up the spool in this way may provide better performance on systems
16634 where there are long mail queues, by reducing the number of files in any one
16635 directory. The msglog directory is also split up in a similar way to the input
16636 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16637 are still placed in the single directory &_msglog.OLD_&.
16638
16639 It is not necessary to take any special action for existing messages when
16640 changing &%split_spool_directory%&. Exim notices messages that are in the
16641 &"wrong"& place, and continues to process them. If the option is turned off
16642 after a period of being on, the subdirectories will eventually empty and be
16643 automatically deleted.
16644
16645 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16646 changes. Instead of creating a list of all messages in the queue, and then
16647 trying to deliver each one in turn, it constructs a list of those in one
16648 sub-directory and tries to deliver them, before moving on to the next
16649 sub-directory. The sub-directories are processed in a random order. This
16650 spreads out the scanning of the input directories, and uses less memory. It is
16651 particularly beneficial when there are lots of messages on the queue. However,
16652 if &%queue_run_in_order%& is set, none of this new processing happens. The
16653 entire queue has to be scanned and sorted before any deliveries can start.
16654
16655
16656 .option spool_directory main string&!! "set at compile time"
16657 .cindex "spool directory" "path to"
16658 This defines the directory in which Exim keeps its spool, that is, the messages
16659 it is waiting to deliver. The default value is taken from the compile-time
16660 configuration setting, if there is one. If not, this option must be set. The
16661 string is expanded, so it can contain, for example, a reference to
16662 &$primary_hostname$&.
16663
16664 If the spool directory name is fixed on your installation, it is recommended
16665 that you set it at build time rather than from this option, particularly if the
16666 log files are being written to the spool directory (see &%log_file_path%&).
16667 Otherwise log files cannot be used for errors that are detected early on, such
16668 as failures in the configuration file.
16669
16670 By using this option to override the compiled-in path, it is possible to run
16671 tests of Exim without using the standard spool.
16672
16673 .option sqlite_lock_timeout main time 5s
16674 .cindex "sqlite lookup type" "lock timeout"
16675 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16676 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16677
16678 .option strict_acl_vars main boolean false
16679 .cindex "&ACL;" "variables, handling unset"
16680 This option controls what happens if a syntactically valid but undefined ACL
16681 variable is referenced. If it is false (the default), an empty string
16682 is substituted; if it is true, an error is generated. See section
16683 &<<SECTaclvariables>>& for details of ACL variables.
16684
16685 .option strip_excess_angle_brackets main boolean false
16686 .cindex "angle brackets, excess"
16687 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16688 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16689 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16690 passed on to another MTA, the excess angle brackets are not passed on. If this
16691 option is not set, multiple pairs of angle brackets cause a syntax error.
16692
16693
16694 .option strip_trailing_dot main boolean false
16695 .cindex "trailing dot on domain"
16696 .cindex "dot" "trailing on domain"
16697 If this option is set, a trailing dot at the end of a domain in an address is
16698 ignored. If this is in the envelope and the message is passed on to another
16699 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16700 domain causes a syntax error.
16701 However, addresses in header lines are checked only when an ACL requests header
16702 syntax checking.
16703
16704
16705 .option syslog_duplication main boolean true
16706 .cindex "syslog" "duplicate log lines; suppressing"
16707 When Exim is logging to syslog, it writes the log lines for its three
16708 separate logs at different syslog priorities so that they can in principle
16709 be separated on the logging hosts. Some installations do not require this
16710 separation, and in those cases, the duplication of certain log lines is a
16711 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16712 particular log line is written to syslog. For lines that normally go to
16713 both the main log and the reject log, the reject log version (possibly
16714 containing message header lines) is written, at LOG_NOTICE priority.
16715 Lines that normally go to both the main and the panic log are written at
16716 the LOG_ALERT priority.
16717
16718
16719 .option syslog_facility main string unset
16720 .cindex "syslog" "facility; setting"
16721 This option sets the syslog &"facility"& name, used when Exim is logging to
16722 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16723 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16724 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16725 details of Exim's logging.
16726
16727
16728
16729 .option syslog_processname main string &`exim`&
16730 .cindex "syslog" "process name; setting"
16731 This option sets the syslog &"ident"& name, used when Exim is logging to
16732 syslog. The value must be no longer than 32 characters. See chapter
16733 &<<CHAPlog>>& for details of Exim's logging.
16734
16735
16736
16737 .option syslog_timestamp main boolean true
16738 .cindex "syslog" "timestamps"
16739 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16740 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16741 details of Exim's logging.
16742
16743
16744 .option system_filter main string&!! unset
16745 .cindex "filter" "system filter"
16746 .cindex "system filter" "specifying"
16747 .cindex "Sieve filter" "not available for system filter"
16748 This option specifies an Exim filter file that is applied to all messages at
16749 the start of each delivery attempt, before any routing is done. System filters
16750 must be Exim filters; they cannot be Sieve filters. If the system filter
16751 generates any deliveries to files or pipes, or any new mail messages, the
16752 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16753 which transports are to be used. Details of this facility are given in chapter
16754 &<<CHAPsystemfilter>>&.
16755
16756
16757 .option system_filter_directory_transport main string&!! unset
16758 .vindex "&$address_file$&"
16759 This sets the name of the transport driver that is to be used when the
16760 &%save%& command in a system message filter specifies a path ending in &"/"&,
16761 implying delivery of each message into a separate file in some directory.
16762 During the delivery, the variable &$address_file$& contains the path name.
16763
16764
16765 .option system_filter_file_transport main string&!! unset
16766 .cindex "file" "transport for system filter"
16767 This sets the name of the transport driver that is to be used when the &%save%&
16768 command in a system message filter specifies a path not ending in &"/"&. During
16769 the delivery, the variable &$address_file$& contains the path name.
16770
16771 .option system_filter_group main string unset
16772 .cindex "gid (group id)" "system filter"
16773 This option is used only when &%system_filter_user%& is also set. It sets the
16774 gid under which the system filter is run, overriding any gid that is associated
16775 with the user. The value may be numerical or symbolic.
16776
16777 .option system_filter_pipe_transport main string&!! unset
16778 .cindex "&(pipe)& transport" "for system filter"
16779 .vindex "&$address_pipe$&"
16780 This specifies the transport driver that is to be used when a &%pipe%& command
16781 is used in a system filter. During the delivery, the variable &$address_pipe$&
16782 contains the pipe command.
16783
16784
16785 .option system_filter_reply_transport main string&!! unset
16786 .cindex "&(autoreply)& transport" "for system filter"
16787 This specifies the transport driver that is to be used when a &%mail%& command
16788 is used in a system filter.
16789
16790
16791 .option system_filter_user main string unset
16792 .cindex "uid (user id)" "system filter"
16793 If this option is set to root, the system filter is run in the main Exim
16794 delivery process, as root.  Otherwise, the system filter runs in a separate
16795 process, as the given user, defaulting to the Exim run-time user.
16796 Unless the string consists entirely of digits, it
16797 is looked up in the password data. Failure to find the named user causes a
16798 configuration error. The gid is either taken from the password data, or
16799 specified by &%system_filter_group%&. When the uid is specified numerically,
16800 &%system_filter_group%& is required to be set.
16801
16802 If the system filter generates any pipe, file, or reply deliveries, the uid
16803 under which the filter is run is used when transporting them, unless a
16804 transport option overrides.
16805
16806
16807 .option tcp_nodelay main boolean true
16808 .cindex "daemon" "TCP_NODELAY on sockets"
16809 .cindex "Nagle algorithm"
16810 .cindex "TCP_NODELAY on listening sockets"
16811 If this option is set false, it stops the Exim daemon setting the
16812 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16813 turns off the &"Nagle algorithm"&, which is a way of improving network
16814 performance in interactive (character-by-character) situations. Turning it off
16815 should improve Exim's performance a bit, so that is what happens by default.
16816 However, it appears that some broken clients cannot cope, and time out. Hence
16817 this option. It affects only those sockets that are set up for listening by the
16818 daemon. Sockets created by the smtp transport for delivering mail always set
16819 TCP_NODELAY.
16820
16821
16822 .option timeout_frozen_after main time 0s
16823 .cindex "frozen messages" "timing out"
16824 .cindex "timeout" "frozen messages"
16825 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16826 message of any kind that has been on the queue for longer than the given time
16827 is automatically cancelled at the next queue run. If the frozen message is a
16828 bounce message, it is just discarded; otherwise, a bounce is sent to the
16829 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16830 If you want to timeout frozen bounce messages earlier than other kinds of
16831 frozen message, see &%ignore_bounce_errors_after%&.
16832
16833 &*Note:*& the default value of zero means no timeouts; with this setting,
16834 frozen messages remain on the queue forever (except for any frozen bounce
16835 messages that are released by &%ignore_bounce_errors_after%&).
16836
16837
16838 .option timezone main string unset
16839 .cindex "timezone, setting"
16840 .cindex "environment" "values from"
16841 The value of &%timezone%& is used to set the environment variable TZ while
16842 running Exim (if it is different on entry). This ensures that all timestamps
16843 created by Exim are in the required timezone. If you want all your timestamps
16844 to be in UTC (aka GMT) you should set
16845 .code
16846 timezone = UTC
16847 .endd
16848 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16849 or, if that is not set, from the value of the TZ environment variable when Exim
16850 is built. If &%timezone%& is set to the empty string, either at build or run
16851 time, any existing TZ variable is removed from the environment when Exim
16852 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16853 unfortunately not all, operating systems.
16854
16855
16856 .new
16857 .option tls_advertise_hosts main "host list&!!" *
16858 .wen
16859 .cindex "TLS" "advertising"
16860 .cindex "encryption" "on SMTP connection"
16861 .cindex "SMTP" "encrypted connection"
16862 When Exim is built with support for TLS encrypted connections, the availability
16863 of the STARTTLS command to set up an encrypted session is advertised in
16864 response to EHLO only to those client hosts that match this option. See
16865 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16866 .new
16867 Note that the default value requires that a certificate be supplied
16868 using the &%tls_certificate%& option.  If no certificate is available then
16869 the &%tls_advertise_hosts%& option should be set empty.
16870 .wen
16871
16872
16873 .option tls_certificate main string&!! unset
16874 .cindex "TLS" "server certificate; location of"
16875 .cindex "certificate" "server, location of"
16876 The value of this option is expanded, and must then be the absolute path to a
16877 file which contains the server's certificates. The server's private key is also
16878 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16879 &<<CHAPTLS>>& for further details.
16880
16881 &*Note*&: The certificates defined by this option are used only when Exim is
16882 receiving incoming messages as a server. If you want to supply certificates for
16883 use when sending messages as a client, you must set the &%tls_certificate%&
16884 option in the relevant &(smtp)& transport.
16885
16886 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16887 if the OpenSSL build supports TLS extensions and the TLS client sends the
16888 Server Name Indication extension, then this option and others documented in
16889 &<<SECTtlssni>>& will be re-expanded.
16890
16891 .option tls_crl main string&!! unset
16892 .cindex "TLS" "server certificate revocation list"
16893 .cindex "certificate" "revocation list for server"
16894 This option specifies a certificate revocation list. The expanded value must
16895 be the name of a file that contains a CRL in PEM format.
16896
16897 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16898
16899
16900 .option tls_dh_max_bits main integer 2236
16901 .cindex "TLS" "D-H bit count"
16902 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16903 the chosen TLS library.  That value might prove to be too high for
16904 interoperability.  This option provides a maximum clamp on the value
16905 suggested, trading off security for interoperability.
16906
16907 The value must be at least 1024.
16908
16909 The value 2236 was chosen because, at time of adding the option, it was the
16910 hard-coded maximum value supported by the NSS cryptographic library, as used
16911 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16912
16913 If you prefer more security and are willing to break some clients, raise this
16914 number.
16915
16916 Note that the value passed to GnuTLS for *generating* a new prime may be a
16917 little less than this figure, because GnuTLS is inexact and may produce a
16918 larger prime than requested.
16919
16920
16921 .option tls_dhparam main string&!! unset
16922 .cindex "TLS" "D-H parameters for server"
16923 The value of this option is expanded and indicates the source of DH parameters
16924 to be used by Exim.
16925
16926 If it is a filename starting with a &`/`&, then it names a file from which DH
16927 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16928 PKCS#3 representation of the DH prime.  If the file does not exist, for
16929 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16930 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16931 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16932 and treated as though the &%tls_dhparam%& were set to "none".
16933
16934 If this option expands to the string "none", then no DH parameters will be
16935 loaded by Exim.
16936
16937 If this option expands to the string "historic" and Exim is using GnuTLS, then
16938 Exim will attempt to load a file from inside the spool directory.  If the file
16939 does not exist, Exim will attempt to create it.
16940 See section &<<SECTgnutlsparam>>& for further details.
16941
16942 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16943 a default DH prime; the default is the 2048 bit prime described in section
16944 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16945 in IKE is assigned number 23.
16946
16947 Otherwise, the option must expand to the name used by Exim for any of a number
16948 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16949 "ike" followed by the number used by IKE, of "default" which corresponds to
16950 "ike23".
16951
16952 The available primes are:
16953 &`ike1`&, &`ike2`&, &`ike5`&,
16954 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16955 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16956
16957 Some of these will be too small to be accepted by clients.
16958 Some may be too large to be accepted by clients.
16959
16960 The TLS protocol does not negotiate an acceptable size for this; clients tend
16961 to hard-drop connections if what is offered by the server is unacceptable,
16962 whether too large or too small, and there's no provision for the client to
16963 tell the server what these constraints are.  Thus, as a server operator, you
16964 need to make an educated guess as to what is most likely to work for your
16965 userbase.
16966
16967 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16968 is most likely to maximise interoperability.  The upper bound comes from
16969 applications using the Mozilla Network Security Services (NSS) library, which
16970 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16971 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16972 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16973 acceptable bound from 1024 to 2048.
16974
16975
16976 .option tls_eccurve main string&!! prime256v1
16977 .cindex TLS "EC cryptography"
16978 If built with a recent-enough version of OpenSSL,
16979 this option selects a EC curve for use by Exim.
16980
16981 Curve names of the form &'prime256v1'& are accepted.
16982 For even more-recent library versions, names of the form &'P-512'&
16983 are also accepted, plus the special value &'auto'&
16984 which tells the library to choose.
16985
16986 If the option is set to an empty string, no EC curves will be enabled.
16987
16988
16989 .option tls_ocsp_file main string&!! unset
16990 .cindex TLS "certificate status"
16991 .cindex TLS "OCSP proof file"
16992 This option
16993 must if set expand to the absolute path to a file which contains a current
16994 status proof for the server's certificate, as obtained from the
16995 Certificate Authority.
16996
16997 .new
16998 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16999 .wen
17000
17001
17002 .option tls_on_connect_ports main "string list" unset
17003 .cindex SSMTP
17004 .cindex SMTPS
17005 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17006 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17007 set up without waiting for the client to issue a STARTTLS command. For
17008 further details, see section &<<SECTsupobssmt>>&.
17009
17010
17011
17012 .option tls_privatekey main string&!! unset
17013 .cindex "TLS" "server private key; location of"
17014 The value of this option is expanded, and must then be the absolute path to a
17015 file which contains the server's private key. If this option is unset, or if
17016 the expansion is forced to fail, or the result is an empty string, the private
17017 key is assumed to be in the same file as the server's certificates. See chapter
17018 &<<CHAPTLS>>& for further details.
17019
17020 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17021
17022
17023 .option tls_remember_esmtp main boolean false
17024 .cindex "TLS" "esmtp state; remembering"
17025 .cindex "TLS" "broken clients"
17026 If this option is set true, Exim violates the RFCs by remembering that it is in
17027 &"esmtp"& state after successfully negotiating a TLS session. This provides
17028 support for broken clients that fail to send a new EHLO after starting a
17029 TLS session.
17030
17031
17032 .option tls_require_ciphers main string&!! unset
17033 .cindex "TLS" "requiring specific ciphers"
17034 .cindex "cipher" "requiring specific"
17035 This option controls which ciphers can be used for incoming TLS connections.
17036 The &(smtp)& transport has an option of the same name for controlling outgoing
17037 connections. This option is expanded for each connection, so can be varied for
17038 different clients if required. The value of this option must be a list of
17039 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17040 in somewhat different ways. If GnuTLS is being used, the client controls the
17041 preference order of the available ciphers. Details are given in sections
17042 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17043
17044
17045 .option tls_try_verify_hosts main "host list&!!" unset
17046 .cindex "TLS" "client certificate verification"
17047 .cindex "certificate" "verification of client"
17048 See &%tls_verify_hosts%& below.
17049
17050
17051 .option tls_verify_certificates main string&!! system
17052 .cindex "TLS" "client certificate verification"
17053 .cindex "certificate" "verification of client"
17054 The value of this option is expanded, and must then be either the
17055 word "system"
17056 or the absolute path to
17057 a file or directory containing permitted certificates for clients that
17058 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17059
17060 The "system" value for the option will use a
17061 system default location compiled into the SSL library.
17062 This is not available for GnuTLS versions preceding 3.0.20,
17063 and will be taken as empty; an explicit location
17064 must be specified.
17065
17066 The use of a directory for the option value is not available for GnuTLS versions
17067 preceding 3.3.6 and a single file must be used.
17068
17069 With OpenSSL the certificates specified
17070 explicitly
17071 either by file or directory
17072 are added to those given by the system default location.
17073
17074 These certificates should be for the certificate authorities trusted, rather
17075 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17076 the value is a file then the certificates are sent by Exim as a server to
17077 connecting clients, defining the list of accepted certificate authorities.
17078 Thus the values defined should be considered public data.  To avoid this,
17079 use the explicit directory version.
17080
17081 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17082
17083 A forced expansion failure or setting to an empty string is equivalent to
17084 being unset.
17085
17086
17087 .option tls_verify_hosts main "host list&!!" unset
17088 .cindex "TLS" "client certificate verification"
17089 .cindex "certificate" "verification of client"
17090 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17091 certificates from clients. The expected certificates are defined by
17092 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17093 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17094 &%tls_verify_certificates%& is not set.
17095
17096 Any client that matches &%tls_verify_hosts%& is constrained by
17097 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17098 present one of the listed certificates. If it does not, the connection is
17099 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17100 the host to use TLS. It can still send SMTP commands through unencrypted
17101 connections. Forcing a client to use TLS has to be done separately using an
17102 ACL to reject inappropriate commands when the connection is not encrypted.
17103
17104 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17105 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17106 certificate and checks it against &%tls_verify_certificates%&, but does not
17107 abort the connection if there is no certificate or if it does not match. This
17108 state can be detected in an ACL, which makes it possible to implement policies
17109 such as &"accept for relay only if a verified certificate has been received,
17110 but accept for local delivery if encrypted, even without a verified
17111 certificate"&.
17112
17113 Client hosts that match neither of these lists are not asked to present
17114 certificates.
17115
17116
17117 .option trusted_groups main "string list&!!" unset
17118 .cindex "trusted groups"
17119 .cindex "groups" "trusted"
17120 This option is expanded just once, at the start of Exim's processing. If this
17121 option is set, any process that is running in one of the listed groups, or
17122 which has one of them as a supplementary group, is trusted. The groups can be
17123 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17124 details of what trusted callers are permitted to do. If neither
17125 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17126 are trusted.
17127
17128 .option trusted_users main "string list&!!" unset
17129 .cindex "trusted users"
17130 .cindex "user" "trusted"
17131 This option is expanded just once, at the start of Exim's processing. If this
17132 option is set, any process that is running as one of the listed users is
17133 trusted. The users can be specified numerically or by name. See section
17134 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17135 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17136 Exim user are trusted.
17137
17138 .option unknown_login main string&!! unset
17139 .cindex "uid (user id)" "unknown caller"
17140 .vindex "&$caller_uid$&"
17141 This is a specialized feature for use in unusual configurations. By default, if
17142 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17143 gives up. The &%unknown_login%& option can be used to set a login name to be
17144 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17145 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17146 is used for the user's real name (gecos field), unless this has been set by the
17147 &%-F%& option.
17148
17149 .option unknown_username main string unset
17150 See &%unknown_login%&.
17151
17152 .option untrusted_set_sender main "address list&!!" unset
17153 .cindex "trusted users"
17154 .cindex "sender" "setting by untrusted user"
17155 .cindex "untrusted user setting sender"
17156 .cindex "user" "untrusted setting sender"
17157 .cindex "envelope sender"
17158 When an untrusted user submits a message to Exim using the standard input, Exim
17159 normally creates an envelope sender address from the user's login and the
17160 default qualification domain. Data from the &%-f%& option (for setting envelope
17161 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17162 is used) is ignored.
17163
17164 However, untrusted users are permitted to set an empty envelope sender address,
17165 to declare that a message should never generate any bounces. For example:
17166 .code
17167 exim -f '<>' user@domain.example
17168 .endd
17169 .vindex "&$sender_ident$&"
17170 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17171 other envelope sender addresses in a controlled way. When it is set, untrusted
17172 users are allowed to set envelope sender addresses that match any of the
17173 patterns in the list. Like all address lists, the string is expanded. The
17174 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17175 users to setting senders that start with their login ids
17176 followed by a hyphen
17177 by a setting like this:
17178 .code
17179 untrusted_set_sender = ^$sender_ident-
17180 .endd
17181 If you want to allow untrusted users to set envelope sender addresses without
17182 restriction, you can use
17183 .code
17184 untrusted_set_sender = *
17185 .endd
17186 The &%untrusted_set_sender%& option applies to all forms of local input, but
17187 only to the setting of the envelope sender. It does not permit untrusted users
17188 to use the other options which trusted user can use to override message
17189 parameters. Furthermore, it does not stop Exim from removing an existing
17190 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17191 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17192 overriding these actions. The handling of the &'Sender:'& header is also
17193 described in section &<<SECTthesenhea>>&.
17194
17195 The log line for a message's arrival shows the envelope sender following
17196 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17197 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17198 envelope sender address, the user's login is shown in parentheses after the
17199 sender address.
17200
17201
17202 .option uucp_from_pattern main string "see below"
17203 .cindex "&""From""& line"
17204 .cindex "UUCP" "&""From""& line"
17205 Some applications that pass messages to an MTA via a command line interface use
17206 an initial line starting with &"From&~"& to pass the envelope sender. In
17207 particular, this is used by UUCP software. Exim recognizes such a line by means
17208 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17209 matches, the sender address is constructed by expanding the contents of
17210 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17211 default pattern recognizes lines in the following two forms:
17212 .code
17213 From ph10 Fri Jan  5 12:35 GMT 1996
17214 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17215 .endd
17216 The pattern can be seen by running
17217 .code
17218 exim -bP uucp_from_pattern
17219 .endd
17220 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17221 year in the second case. The first word after &"From&~"& is matched in the
17222 regular expression by a parenthesized subpattern. The default value for
17223 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17224 (&"ph10"& in the example above) as the message's sender. See also
17225 &%ignore_fromline_hosts%&.
17226
17227
17228 .option uucp_from_sender main string&!! &`$1`&
17229 See &%uucp_from_pattern%& above.
17230
17231
17232 .option warn_message_file main string unset
17233 .cindex "warning of delay" "customizing the message"
17234 .cindex "customizing" "warning message"
17235 This option defines a template file containing paragraphs of text to be used
17236 for constructing the warning message which is sent by Exim when a message has
17237 been on the queue for a specified amount of time, as specified by
17238 &%delay_warning%&. Details of the file's contents are given in chapter
17239 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17240
17241
17242 .option write_rejectlog main boolean true
17243 .cindex "reject log" "disabling"
17244 If this option is set false, Exim no longer writes anything to the reject log.
17245 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17246 .ecindex IIDconfima
17247 .ecindex IIDmaiconf
17248
17249
17250
17251
17252 . ////////////////////////////////////////////////////////////////////////////
17253 . ////////////////////////////////////////////////////////////////////////////
17254
17255 .chapter "Generic options for routers" "CHAProutergeneric"
17256 .scindex IIDgenoprou1 "options" "generic; for routers"
17257 .scindex IIDgenoprou2 "generic options" "router"
17258 This chapter describes the generic options that apply to all routers.
17259 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17260
17261 For a general description of how a router operates, see sections
17262 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17263 which the preconditions are tested. The order of expansion of the options that
17264 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17265 &%headers_remove%&, &%transport%&.
17266
17267
17268
17269 .option address_data routers string&!! unset
17270 .cindex "router" "data attached to address"
17271 The string is expanded just before the router is run, that is, after all the
17272 precondition tests have succeeded. If the expansion is forced to fail, the
17273 router declines, the value of &%address_data%& remains unchanged, and the
17274 &%more%& option controls what happens next. Other expansion failures cause
17275 delivery of the address to be deferred.
17276
17277 .vindex "&$address_data$&"
17278 When the expansion succeeds, the value is retained with the address, and can be
17279 accessed using the variable &$address_data$& in the current router, subsequent
17280 routers, and the eventual transport.
17281
17282 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17283 that runs a user's filter file, the contents of &$address_data$& are accessible
17284 in the filter. This is not normally a problem, because such data is usually
17285 either not confidential or it &"belongs"& to the current user, but if you do
17286 put confidential data into &$address_data$& you need to remember this point.
17287
17288 Even if the router declines or passes, the value of &$address_data$& remains
17289 with the address, though it can be changed by another &%address_data%& setting
17290 on a subsequent router. If a router generates child addresses, the value of
17291 &$address_data$& propagates to them. This also applies to the special kind of
17292 &"child"& that is generated by a router with the &%unseen%& option.
17293
17294 The idea of &%address_data%& is that you can use it to look up a lot of data
17295 for the address once, and then pick out parts of the data later. For example,
17296 you could use a single LDAP lookup to return a string of the form
17297 .code
17298 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17299 .endd
17300 In the transport you could pick out the mailbox by a setting such as
17301 .code
17302 file = ${extract{mailbox}{$address_data}}
17303 .endd
17304 This makes the configuration file less messy, and also reduces the number of
17305 lookups (though Exim does cache lookups).
17306
17307 .vindex "&$sender_address_data$&"
17308 .vindex "&$address_data$&"
17309 The &%address_data%& facility is also useful as a means of passing information
17310 from one router to another, and from a router to a transport. In addition, if
17311 &$address_data$& is set by a router when verifying a recipient address from an
17312 ACL, it remains available for use in the rest of the ACL statement. After
17313 verifying a sender, the value is transferred to &$sender_address_data$&.
17314
17315
17316
17317 .option address_test routers&!? boolean true
17318 .oindex "&%-bt%&"
17319 .cindex "router" "skipping when address testing"
17320 If this option is set false, the router is skipped when routing is being tested
17321 by means of the &%-bt%& command line option. This can be a convenience when
17322 your first router sends messages to an external scanner, because it saves you
17323 having to set the &"already scanned"& indicator when testing real address
17324 routing.
17325
17326
17327
17328 .option cannot_route_message routers string&!! unset
17329 .cindex "router" "customizing &""cannot route""& message"
17330 .cindex "customizing" "&""cannot route""& message"
17331 This option specifies a text message that is used when an address cannot be
17332 routed because Exim has run out of routers. The default message is
17333 &"Unrouteable address"&. This option is useful only on routers that have
17334 &%more%& set false, or on the very last router in a configuration, because the
17335 value that is used is taken from the last router that is considered. This
17336 includes a router that is skipped because its preconditions are not met, as
17337 well as a router that declines. For example, using the default configuration,
17338 you could put:
17339 .code
17340 cannot_route_message = Remote domain not found in DNS
17341 .endd
17342 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17343 and
17344 .code
17345 cannot_route_message = Unknown local user
17346 .endd
17347 on the final router that checks for local users. If string expansion fails for
17348 this option, the default message is used. Unless the expansion failure was
17349 explicitly forced, a message about the failure is written to the main and panic
17350 logs, in addition to the normal message about the routing failure.
17351
17352
17353 .option caseful_local_part routers boolean false
17354 .cindex "case of local parts"
17355 .cindex "router" "case of local parts"
17356 By default, routers handle the local parts of addresses in a case-insensitive
17357 manner, though the actual case is preserved for transmission with the message.
17358 If you want the case of letters to be significant in a router, you must set
17359 this option true. For individual router options that contain address or local
17360 part lists (for example, &%local_parts%&), case-sensitive matching can be
17361 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17362 more details.
17363
17364 .vindex "&$local_part$&"
17365 .vindex "&$original_local_part$&"
17366 .vindex "&$parent_local_part$&"
17367 The value of the &$local_part$& variable is forced to lower case while a
17368 router is running unless &%caseful_local_part%& is set. When a router assigns
17369 an address to a transport, the value of &$local_part$& when the transport runs
17370 is the same as it was in the router. Similarly, when a router generates child
17371 addresses by aliasing or forwarding, the values of &$original_local_part$&
17372 and &$parent_local_part$& are those that were used by the redirecting router.
17373
17374 This option applies to the processing of an address by a router. When a
17375 recipient address is being processed in an ACL, there is a separate &%control%&
17376 modifier that can be used to specify case-sensitive processing within the ACL
17377 (see section &<<SECTcontrols>>&).
17378
17379
17380
17381 .option check_local_user routers&!? boolean false
17382 .cindex "local user, checking in router"
17383 .cindex "router" "checking for local user"
17384 .cindex "&_/etc/passwd_&"
17385 .vindex "&$home$&"
17386 When this option is true, Exim checks that the local part of the recipient
17387 address (with affixes removed if relevant) is the name of an account on the
17388 local system. The check is done by calling the &[getpwnam()]& function rather
17389 than trying to read &_/etc/passwd_& directly. This means that other methods of
17390 holding password data (such as NIS) are supported. If the local part is a local
17391 user, &$home$& is set from the password data, and can be tested in other
17392 preconditions that are evaluated after this one (the order of evaluation is
17393 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17394 overridden by &%router_home_directory%&. If the local part is not a local user,
17395 the router is skipped.
17396
17397 If you want to check that the local part is either the name of a local user
17398 or matches something else, you cannot combine &%check_local_user%& with a
17399 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17400 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17401 setting to achieve this. For example:
17402 .code
17403 local_parts = passwd;$local_part : lsearch;/etc/other/users
17404 .endd
17405 Note, however, that the side effects of &%check_local_user%& (such as setting
17406 up a home directory) do not occur when a &(passwd)& lookup is used in a
17407 &%local_parts%& (or any other) precondition.
17408
17409
17410
17411 .option condition routers&!? string&!! unset
17412 .cindex "router" "customized precondition"
17413 This option specifies a general precondition test that has to succeed for the
17414 router to be called. The &%condition%& option is the last precondition to be
17415 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17416 result is a forced failure, or an empty string, or one of the strings &"0"& or
17417 &"no"& or &"false"& (checked without regard to the case of the letters), the
17418 router is skipped, and the address is offered to the next one.
17419
17420 If the result is any other value, the router is run (as this is the last
17421 precondition to be evaluated, all the other preconditions must be true).
17422
17423 This option is unusual in that multiple &%condition%& options may be present.
17424 All &%condition%& options must succeed.
17425
17426 The &%condition%& option provides a means of applying custom conditions to the
17427 running of routers. Note that in the case of a simple conditional expansion,
17428 the default expansion values are exactly what is wanted. For example:
17429 .code
17430 condition = ${if >{$message_age}{600}}
17431 .endd
17432 Because of the default behaviour of the string expansion, this is equivalent to
17433 .code
17434 condition = ${if >{$message_age}{600}{true}{}}
17435 .endd
17436
17437 A multiple condition example, which succeeds:
17438 .code
17439 condition = ${if >{$message_age}{600}}
17440 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17441 condition = foobar
17442 .endd
17443
17444 If the expansion fails (other than forced failure) delivery is deferred. Some
17445 of the other precondition options are common special cases that could in fact
17446 be specified using &%condition%&.
17447
17448 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17449 are far older, and use one set of semantics.  ACLs are newer and when
17450 they were created, the ACL &%condition%& process was given far stricter
17451 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17452 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17453 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17454 Router rules processing behavior.
17455
17456 This is best illustrated in an example:
17457 .code
17458 # If used in an ACL condition will fail with a syntax error, but
17459 # in a router condition any extra characters are treated as a string
17460
17461 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17462 true {yes} {no}}
17463
17464 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17465  {yes} {no}}
17466 .endd
17467 In each example above, the &%if%& statement actually ends after
17468 &"{google.com}}"&.  Since no true or false braces were defined, the
17469 default &%if%& behavior is to return a boolean true or a null answer
17470 (which evaluates to false). The rest of the line is then treated as a
17471 string. So the first example resulted in the boolean answer &"true"&
17472 with the string &" {yes} {no}}"& appended to it. The second example
17473 resulted in the null output (indicating false) with the string
17474 &" {yes} {no}}"& appended to it.
17475
17476 In fact you can put excess forward braces in too.  In the router
17477 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17478 mean something, like after a &"$"& or when required as part of a
17479 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17480 string characters.
17481
17482 Thus, in a Router, the above expansion strings will both always evaluate
17483 true, as the result of expansion is a non-empty string which doesn't
17484 match an explicit false value.  This can be tricky to debug.  By
17485 contrast, in an ACL either of those strings will always result in an
17486 expansion error because the result doesn't look sufficiently boolean.
17487
17488
17489 .option debug_print routers string&!! unset
17490 .cindex "testing" "variables in drivers"
17491 If this option is set and debugging is enabled (see the &%-d%& command line
17492 option) or in address-testing mode (see the &%-bt%& command line option),
17493 the string is expanded and included in the debugging output.
17494 If expansion of the string fails, the error message is written to the debugging
17495 output, and Exim carries on processing.
17496 This option is provided to help with checking out the values of variables and
17497 so on when debugging router configurations. For example, if a &%condition%&
17498 option appears not to be working, &%debug_print%& can be used to output the
17499 variables it references. The output happens after checks for &%domains%&,
17500 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17501 are tested. A newline is added to the text if it does not end with one.
17502 The variable &$router_name$& contains the name of the router.
17503
17504
17505
17506 .option disable_logging routers boolean false
17507 If this option is set true, nothing is logged for any routing errors
17508 or for any deliveries caused by this router. You should not set this option
17509 unless you really, really know what you are doing. See also the generic
17510 transport option of the same name.
17511
17512 .option dnssec_request_domains routers "domain list&!!" unset
17513 .cindex "MX record" "security"
17514 .cindex "DNSSEC" "MX lookup"
17515 .cindex "security" "MX lookup"
17516 .cindex "DNS" "DNSSEC"
17517 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17518 the dnssec request bit set.
17519 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17520
17521 .option dnssec_require_domains routers "domain list&!!" unset
17522 .cindex "MX record" "security"
17523 .cindex "DNSSEC" "MX lookup"
17524 .cindex "security" "MX lookup"
17525 .cindex "DNS" "DNSSEC"
17526 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17527 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17528 (AD bit) set will be ignored and logged as a host-lookup failure.
17529 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17530
17531
17532 .option domains routers&!? "domain list&!!" unset
17533 .cindex "router" "restricting to specific domains"
17534 .vindex "&$domain_data$&"
17535 If this option is set, the router is skipped unless the current domain matches
17536 the list. If the match is achieved by means of a file lookup, the data that the
17537 lookup returned for the domain is placed in &$domain_data$& for use in string
17538 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17539 a list of the order in which preconditions are evaluated.
17540
17541
17542
17543 .option driver routers string unset
17544 This option must always be set. It specifies which of the available routers is
17545 to be used.
17546
17547
17548 .option dsn_lasthop routers boolean false
17549 .cindex "DSN" "success"
17550 .cindex "Delivery Status Notification" "success"
17551 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17552 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17553 instead send a success DSN as if the next hop does not support DSN.
17554 Not effective on redirect routers.
17555
17556
17557
17558 .option errors_to routers string&!! unset
17559 .cindex "envelope sender"
17560 .cindex "router" "changing address for errors"
17561 If a router successfully handles an address, it may assign the address to a
17562 transport for delivery or it may generate child addresses. In both cases, if
17563 there is a delivery problem during later processing, the resulting bounce
17564 message is sent to the address that results from expanding this string,
17565 provided that the address verifies successfully. The &%errors_to%& option is
17566 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17567
17568 The &%errors_to%& setting associated with an address can be overridden if it
17569 subsequently passes through other routers that have their own &%errors_to%&
17570 settings, or if the message is delivered by a transport with a &%return_path%&
17571 setting.
17572
17573 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17574 the expansion fails to verify, the errors address associated with the incoming
17575 address is used. At top level, this is the envelope sender. A non-forced
17576 expansion failure causes delivery to be deferred.
17577
17578 If an address for which &%errors_to%& has been set ends up being delivered over
17579 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17580 any bounces that are generated by other MTAs on the delivery route are also
17581 sent there. You can set &%errors_to%& to the empty string by either of these
17582 settings:
17583 .code
17584 errors_to =
17585 errors_to = ""
17586 .endd
17587 An expansion item that yields an empty string has the same effect. If you do
17588 this, a locally detected delivery error for addresses processed by this router
17589 no longer gives rise to a bounce message; the error is discarded. If the
17590 address is delivered to a remote host, the return path is set to &`<>`&, unless
17591 overridden by the &%return_path%& option on the transport.
17592
17593 .vindex "&$address_data$&"
17594 If for some reason you want to discard local errors, but use a non-empty
17595 MAIL command for remote delivery, you can preserve the original return
17596 path in &$address_data$& in the router, and reinstate it in the transport by
17597 setting &%return_path%&.
17598
17599 The most common use of &%errors_to%& is to direct mailing list bounces to the
17600 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17601 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17602
17603
17604
17605 .option expn routers&!? boolean true
17606 .cindex "address" "testing"
17607 .cindex "testing" "addresses"
17608 .cindex "EXPN" "router skipping"
17609 .cindex "router" "skipping for EXPN"
17610 If this option is turned off, the router is skipped when testing an address
17611 as a result of processing an SMTP EXPN command. You might, for example,
17612 want to turn it off on a router for users' &_.forward_& files, while leaving it
17613 on for the system alias file.
17614 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17615 are evaluated.
17616
17617 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17618 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17619 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17620
17621
17622
17623 .option fail_verify routers boolean false
17624 .cindex "router" "forcing verification failure"
17625 Setting this option has the effect of setting both &%fail_verify_sender%& and
17626 &%fail_verify_recipient%& to the same value.
17627
17628
17629
17630 .option fail_verify_recipient routers boolean false
17631 If this option is true and an address is accepted by this router when
17632 verifying a recipient, verification fails.
17633
17634
17635
17636 .option fail_verify_sender routers boolean false
17637 If this option is true and an address is accepted by this router when
17638 verifying a sender, verification fails.
17639
17640
17641
17642 .option fallback_hosts routers "string list" unset
17643 .cindex "router" "fallback hosts"
17644 .cindex "fallback" "hosts specified on router"
17645 String expansion is not applied to this option. The argument must be a
17646 colon-separated list of host names or IP addresses. The list separator can be
17647 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17648 each name or address. In fact, the format of each item is exactly the same as
17649 defined for the list of hosts in a &(manualroute)& router (see section
17650 &<<SECTformatonehostitem>>&).
17651
17652 If a router queues an address for a remote transport, this host list is
17653 associated with the address, and used instead of the transport's fallback host
17654 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17655 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17656 transport for further details.
17657
17658
17659 .option group routers string&!! "see below"
17660 .cindex "gid (group id)" "local delivery"
17661 .cindex "local transports" "uid and gid"
17662 .cindex "transport" "local"
17663 .cindex "router" "setting group"
17664 When a router queues an address for a transport, and the transport does not
17665 specify a group, the group given here is used when running the delivery
17666 process.
17667 The group may be specified numerically or by name. If expansion fails, the
17668 error is logged and delivery is deferred.
17669 The default is unset, unless &%check_local_user%& is set, when the default
17670 is taken from the password information. See also &%initgroups%& and &%user%&
17671 and the discussion in chapter &<<CHAPenvironment>>&.
17672
17673
17674
17675 .option headers_add routers list&!! unset
17676 .cindex "header lines" "adding"
17677 .cindex "router" "adding header lines"
17678 This option specifies a list of text headers,
17679 newline-separated (by default, changeable in the usual way),
17680 that is associated with any addresses that are accepted by the router.
17681 Each item is separately expanded, at routing time.  However, this
17682 option has no effect when an address is just being verified. The way in which
17683 the text is used to add header lines at transport time is described in section
17684 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17685 message is in the process of being transported. This means that references to
17686 header lines in string expansions in the transport's configuration do not
17687 &"see"& the added header lines.
17688
17689 The &%headers_add%& option is expanded after &%errors_to%&, but before
17690 &%headers_remove%& and &%transport%&. If an item is empty, or if
17691 an item expansion is forced to fail, the item has no effect. Other expansion
17692 failures are treated as configuration errors.
17693
17694 Unlike most options, &%headers_add%& can be specified multiple times
17695 for a router; all listed headers are added.
17696
17697 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17698 router that has the &%one_time%& option set.
17699
17700 .cindex "duplicate addresses"
17701 .oindex "&%unseen%&"
17702 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17703 additions are deleted when the address is passed on to subsequent routers.
17704 For a &%redirect%& router, if a generated address is the same as the incoming
17705 address, this can lead to duplicate addresses with different header
17706 modifications. Exim does not do duplicate deliveries (except, in certain
17707 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17708 which of the duplicates is discarded, so this ambiguous situation should be
17709 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17710
17711
17712
17713 .option headers_remove routers list&!! unset
17714 .cindex "header lines" "removing"
17715 .cindex "router" "removing header lines"
17716 This option specifies a list of text headers,
17717 colon-separated (by default, changeable in the usual way),
17718 that is associated with any addresses that are accepted by the router.
17719 Each item is separately expanded, at routing time.  However, this
17720 option has no effect when an address is just being verified. The way in which
17721 the text is used to remove header lines at transport time is described in
17722 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17723 the message is in the process of being transported. This means that references
17724 to header lines in string expansions in the transport's configuration still
17725 &"see"& the original header lines.
17726
17727 The &%headers_remove%& option is expanded after &%errors_to%& and
17728 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17729 the item has no effect. Other expansion failures are treated as configuration
17730 errors.
17731
17732 Unlike most options, &%headers_remove%& can be specified multiple times
17733 for a router; all listed headers are removed.
17734
17735 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17736 router that has the &%one_time%& option set.
17737
17738 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17739 removal requests are deleted when the address is passed on to subsequent
17740 routers, and this can lead to problems with duplicates -- see the similar
17741 warning for &%headers_add%& above.
17742
17743 &*Warning 3*&: Because of the separate expansion of the list items,
17744 items that contain a list separator must have it doubled.
17745 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17746
17747
17748
17749 .option ignore_target_hosts routers "host list&!!" unset
17750 .cindex "IP address" "discarding"
17751 .cindex "router" "discarding IP addresses"
17752 Although this option is a host list, it should normally contain IP address
17753 entries rather than names. If any host that is looked up by the router has an
17754 IP address that matches an item in this list, Exim behaves as if that IP
17755 address did not exist. This option allows you to cope with rogue DNS entries
17756 like
17757 .code
17758 remote.domain.example.  A  127.0.0.1
17759 .endd
17760 by setting
17761 .code
17762 ignore_target_hosts = 127.0.0.1
17763 .endd
17764 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17765 discarded in this way, the router declines. In a conventional configuration, an
17766 attempt to mail to such a domain would normally provoke the &"unrouteable
17767 domain"& error, and an attempt to verify an address in the domain would fail.
17768 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17769 router declines if presented with one of the listed addresses.
17770
17771 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17772 means of the first or the second of the following settings, respectively:
17773 .code
17774 ignore_target_hosts = 0.0.0.0/0
17775 ignore_target_hosts = <; 0::0/0
17776 .endd
17777 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17778 in the second line matches all IPv6 addresses.
17779
17780 This option may also be useful for ignoring link-local and site-local IPv6
17781 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17782 is expanded before use as a list, it is possible to make it dependent on the
17783 domain that is being routed.
17784
17785 .vindex "&$host_address$&"
17786 During its expansion, &$host_address$& is set to the IP address that is being
17787 checked.
17788
17789 .option initgroups routers boolean false
17790 .cindex "additional groups"
17791 .cindex "groups" "additional"
17792 .cindex "local transports" "uid and gid"
17793 .cindex "transport" "local"
17794 If the router queues an address for a transport, and this option is true, and
17795 the uid supplied by the router is not overridden by the transport, the
17796 &[initgroups()]& function is called when running the transport to ensure that
17797 any additional groups associated with the uid are set up. See also &%group%&
17798 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17799
17800
17801
17802 .option local_part_prefix routers&!? "string list" unset
17803 .cindex "router" "prefix for local part"
17804 .cindex "prefix" "for local part, used in router"
17805 If this option is set, the router is skipped unless the local part starts with
17806 one of the given strings, or &%local_part_prefix_optional%& is true. See
17807 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17808 evaluated.
17809
17810 The list is scanned from left to right, and the first prefix that matches is
17811 used. A limited form of wildcard is available; if the prefix begins with an
17812 asterisk, it matches the longest possible sequence of arbitrary characters at
17813 the start of the local part. An asterisk should therefore always be followed by
17814 some character that does not occur in normal local parts.
17815 .cindex "multiple mailboxes"
17816 .cindex "mailbox" "multiple"
17817 Wildcarding can be used to set up multiple user mailboxes, as described in
17818 section &<<SECTmulbox>>&.
17819
17820 .vindex "&$local_part$&"
17821 .vindex "&$local_part_prefix$&"
17822 During the testing of the &%local_parts%& option, and while the router is
17823 running, the prefix is removed from the local part, and is available in the
17824 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17825 the router accepts the address, this remains true during subsequent delivery by
17826 a transport. In particular, the local part that is transmitted in the RCPT
17827 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17828 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17829 the relevant transport.
17830
17831 When an address is being verified, &%local_part_prefix%& affects only the
17832 behaviour of the router. If the callout feature of verification is in use, this
17833 means that the full address, including the prefix, will be used during the
17834 callout.
17835
17836 The prefix facility is commonly used to handle local parts of the form
17837 &%owner-something%&. Another common use is to support local parts of the form
17838 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17839 to tell a user their forwarding is broken &-- by placing a router like this one
17840 immediately before the router that handles &_.forward_& files:
17841 .code
17842 real_localuser:
17843   driver = accept
17844   local_part_prefix = real-
17845   check_local_user
17846   transport = local_delivery
17847 .endd
17848 For security, it would probably be a good idea to restrict the use of this
17849 router to locally-generated messages, using a condition such as this:
17850 .code
17851   condition = ${if match {$sender_host_address}\
17852                          {\N^(|127\.0\.0\.1)$\N}}
17853 .endd
17854
17855 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17856 both conditions must be met if not optional. Care must be taken if wildcards
17857 are used in both a prefix and a suffix on the same router. Different
17858 separator characters must be used to avoid ambiguity.
17859
17860
17861 .option local_part_prefix_optional routers boolean false
17862 See &%local_part_prefix%& above.
17863
17864
17865
17866 .option local_part_suffix routers&!? "string list" unset
17867 .cindex "router" "suffix for local part"
17868 .cindex "suffix for local part" "used in router"
17869 This option operates in the same way as &%local_part_prefix%&, except that the
17870 local part must end (rather than start) with the given string, the
17871 &%local_part_suffix_optional%& option determines whether the suffix is
17872 mandatory, and the wildcard * character, if present, must be the last
17873 character of the suffix. This option facility is commonly used to handle local
17874 parts of the form &%something-request%& and multiple user mailboxes of the form
17875 &%username-foo%&.
17876
17877
17878 .option local_part_suffix_optional routers boolean false
17879 See &%local_part_suffix%& above.
17880
17881
17882
17883 .option local_parts routers&!? "local part list&!!" unset
17884 .cindex "router" "restricting to specific local parts"
17885 .cindex "local part" "checking in router"
17886 The router is run only if the local part of the address matches the list.
17887 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17888 are evaluated, and
17889 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17890 string is expanded, it is possible to make it depend on the domain, for
17891 example:
17892 .code
17893 local_parts = dbm;/usr/local/specials/$domain
17894 .endd
17895 .vindex "&$local_part_data$&"
17896 If the match is achieved by a lookup, the data that the lookup returned
17897 for the local part is placed in the variable &$local_part_data$& for use in
17898 expansions of the router's private options. You might use this option, for
17899 example, if you have a large number of local virtual domains, and you want to
17900 send all postmaster mail to the same place without having to set up an alias in
17901 each virtual domain:
17902 .code
17903 postmaster:
17904   driver = redirect
17905   local_parts = postmaster
17906   data = postmaster@real.domain.example
17907 .endd
17908
17909
17910 .option log_as_local routers boolean "see below"
17911 .cindex "log" "delivery line"
17912 .cindex "delivery" "log line format"
17913 Exim has two logging styles for delivery, the idea being to make local
17914 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17915 recipient address is given just as the local part, without a domain. The use of
17916 this style is controlled by this option. It defaults to true for the &(accept)&
17917 router, and false for all the others. This option applies only when a
17918 router assigns an address to a transport. It has no effect on routers that
17919 redirect addresses.
17920
17921
17922
17923 .option more routers boolean&!! true
17924 The result of string expansion for this option must be a valid boolean value,
17925 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17926 result causes an error, and delivery is deferred. If the expansion is forced to
17927 fail, the default value for the option (true) is used. Other failures cause
17928 delivery to be deferred.
17929
17930 If this option is set false, and the router declines to handle the address, no
17931 further routers are tried, routing fails, and the address is bounced.
17932 .oindex "&%self%&"
17933 However, if the router explicitly passes an address to the following router by
17934 means of the setting
17935 .code
17936 self = pass
17937 .endd
17938 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17939 does not affect the behaviour if one of the precondition tests fails. In that
17940 case, the address is always passed to the next router.
17941
17942 Note that &%address_data%& is not considered to be a precondition. If its
17943 expansion is forced to fail, the router declines, and the value of &%more%&
17944 controls what happens next.
17945
17946
17947 .option pass_on_timeout routers boolean false
17948 .cindex "timeout" "of router"
17949 .cindex "router" "timeout"
17950 If a router times out during a host lookup, it normally causes deferral of the
17951 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17952 router, overriding &%no_more%&. This may be helpful for systems that are
17953 intermittently connected to the Internet, or those that want to pass to a smart
17954 host any messages that cannot immediately be delivered.
17955
17956 There are occasional other temporary errors that can occur while doing DNS
17957 lookups. They are treated in the same way as a timeout, and this option
17958 applies to all of them.
17959
17960
17961
17962 .option pass_router routers string unset
17963 .cindex "router" "go to after &""pass""&"
17964 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17965 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17966 routing to continue, and overriding a false setting of &%more%&. When one of
17967 these routers returns &"pass"&, the address is normally handed on to the next
17968 router in sequence. This can be changed by setting &%pass_router%& to the name
17969 of another router. However (unlike &%redirect_router%&) the named router must
17970 be below the current router, to avoid loops. Note that this option applies only
17971 to the special case of &"pass"&. It does not apply when a router returns
17972 &"decline"& because it cannot handle an address.
17973
17974
17975
17976 .option redirect_router routers string unset
17977 .cindex "router" "start at after redirection"
17978 Sometimes an administrator knows that it is pointless to reprocess addresses
17979 generated from alias or forward files with the same router again. For
17980 example, if an alias file translates real names into login ids there is no
17981 point searching the alias file a second time, especially if it is a large file.
17982
17983 The &%redirect_router%& option can be set to the name of any router instance.
17984 It causes the routing of any generated addresses to start at the named router
17985 instead of at the first router. This option has no effect if the router in
17986 which it is set does not generate new addresses.
17987
17988
17989
17990 .option require_files routers&!? "string list&!!" unset
17991 .cindex "file" "requiring for router"
17992 .cindex "router" "requiring file existence"
17993 This option provides a general mechanism for predicating the running of a
17994 router on the existence or non-existence of certain files or directories.
17995 Before running a router, as one of its precondition tests, Exim works its way
17996 through the &%require_files%& list, expanding each item separately.
17997
17998 Because the list is split before expansion, any colons in expansion items must
17999 be doubled, or the facility for using a different list separator must be used.
18000 If any expansion is forced to fail, the item is ignored. Other expansion
18001 failures cause routing of the address to be deferred.
18002
18003 If any expanded string is empty, it is ignored. Otherwise, except as described
18004 below, each string must be a fully qualified file path, optionally preceded by
18005 &"!"&. The paths are passed to the &[stat()]& function to test for the
18006 existence of the files or directories. The router is skipped if any paths not
18007 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18008
18009 .cindex "NFS"
18010 If &[stat()]& cannot determine whether a file exists or not, delivery of
18011 the message is deferred. This can happen when NFS-mounted filesystems are
18012 unavailable.
18013
18014 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18015 options, so you cannot use it to check for the existence of a file in which to
18016 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18017 full list of the order in which preconditions are evaluated.) However, as
18018 these options are all expanded, you can use the &%exists%& expansion condition
18019 to make such tests. The &%require_files%& option is intended for checking files
18020 that the router may be going to use internally, or which are needed by a
18021 transport (for example &_.procmailrc_&).
18022
18023 During delivery, the &[stat()]& function is run as root, but there is a
18024 facility for some checking of the accessibility of a file by another user.
18025 This is not a proper permissions check, but just a &"rough"& check that
18026 operates as follows:
18027
18028 If an item in a &%require_files%& list does not contain any forward slash
18029 characters, it is taken to be the user (and optional group, separated by a
18030 comma) to be checked for subsequent files in the list. If no group is specified
18031 but the user is specified symbolically, the gid associated with the uid is
18032 used. For example:
18033 .code
18034 require_files = mail:/some/file
18035 require_files = $local_part:$home/.procmailrc
18036 .endd
18037 If a user or group name in a &%require_files%& list does not exist, the
18038 &%require_files%& condition fails.
18039
18040 Exim performs the check by scanning along the components of the file path, and
18041 checking the access for the given uid and gid. It checks for &"x"& access on
18042 directories, and &"r"& access on the final file. Note that this means that file
18043 access control lists, if the operating system has them, are ignored.
18044
18045 &*Warning 1*&: When the router is being run to verify addresses for an
18046 incoming SMTP message, Exim is not running as root, but under its own uid. This
18047 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18048 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18049 user is not permitted to read one of the directories on the file's path.
18050
18051 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18052 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18053 without root access. In this case, if a check for access by a particular user
18054 is requested, Exim creates a subprocess that runs as that user, and tries the
18055 check again in that process.
18056
18057 The default action for handling an unresolved EACCES is to consider it to
18058 be caused by a configuration error, and routing is deferred because the
18059 existence or non-existence of the file cannot be determined. However, in some
18060 circumstances it may be desirable to treat this condition as if the file did
18061 not exist. If the file name (or the exclamation mark that precedes the file
18062 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18063 as if the file did not exist. For example:
18064 .code
18065 require_files = +/some/file
18066 .endd
18067 If the router is not an essential part of verification (for example, it
18068 handles users' &_.forward_& files), another solution is to set the &%verify%&
18069 option false so that the router is skipped when verifying.
18070
18071
18072
18073 .option retry_use_local_part routers boolean "see below"
18074 .cindex "hints database" "retry keys"
18075 .cindex "local part" "in retry keys"
18076 When a delivery suffers a temporary routing failure, a retry record is created
18077 in Exim's hints database. For addresses whose routing depends only on the
18078 domain, the key for the retry record should not involve the local part, but for
18079 other addresses, both the domain and the local part should be included.
18080 Usually, remote routing is of the former kind, and local routing is of the
18081 latter kind.
18082
18083 This option controls whether the local part is used to form the key for retry
18084 hints for addresses that suffer temporary errors while being handled by this
18085 router. The default value is true for any router that has &%check_local_user%&
18086 set, and false otherwise. Note that this option does not apply to hints keys
18087 for transport delays; they are controlled by a generic transport option of the
18088 same name.
18089
18090 The setting of &%retry_use_local_part%& applies only to the router on which it
18091 appears. If the router generates child addresses, they are routed
18092 independently; this setting does not become attached to them.
18093
18094
18095
18096 .option router_home_directory routers string&!! unset
18097 .cindex "router" "home directory for"
18098 .cindex "home directory" "for router"
18099 .vindex "&$home$&"
18100 This option sets a home directory for use while the router is running. (Compare
18101 &%transport_home_directory%&, which sets a home directory for later
18102 transporting.) In particular, if used on a &(redirect)& router, this option
18103 sets a value for &$home$& while a filter is running. The value is expanded;
18104 forced expansion failure causes the option to be ignored &-- other failures
18105 cause the router to defer.
18106
18107 Expansion of &%router_home_directory%& happens immediately after the
18108 &%check_local_user%& test (if configured), before any further expansions take
18109 place.
18110 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18111 are evaluated.)
18112 While the router is running, &%router_home_directory%& overrides the value of
18113 &$home$& that came from &%check_local_user%&.
18114
18115 When a router accepts an address and assigns it to a local transport (including
18116 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18117 delivery), the home directory setting for the transport is taken from the first
18118 of these values that is set:
18119
18120 .ilist
18121 The &%home_directory%& option on the transport;
18122 .next
18123 The &%transport_home_directory%& option on the router;
18124 .next
18125 The password data if &%check_local_user%& is set on the router;
18126 .next
18127 The &%router_home_directory%& option on the router.
18128 .endlist
18129
18130 In other words, &%router_home_directory%& overrides the password data for the
18131 router, but not for the transport.
18132
18133
18134
18135 .option self routers string freeze
18136 .cindex "MX record" "pointing to local host"
18137 .cindex "local host" "MX pointing to"
18138 This option applies to those routers that use a recipient address to find a
18139 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18140 and &(manualroute)& routers.
18141 Certain configurations of the &(queryprogram)& router can also specify a list
18142 of remote hosts.
18143 Usually such routers are configured to send the message to a remote host via an
18144 &(smtp)& transport. The &%self%& option specifies what happens when the first
18145 host on the list turns out to be the local host.
18146 The way in which Exim checks for the local host is described in section
18147 &<<SECTreclocipadd>>&.
18148
18149 Normally this situation indicates either an error in Exim's configuration (for
18150 example, the router should be configured not to process this domain), or an
18151 error in the DNS (for example, the MX should not point to this host). For this
18152 reason, the default action is to log the incident, defer the address, and
18153 freeze the message. The following alternatives are provided for use in special
18154 cases:
18155
18156 .vlist
18157 .vitem &%defer%&
18158 Delivery of the message is tried again later, but the message is not frozen.
18159
18160 .vitem "&%reroute%&: <&'domain'&>"
18161 The domain is changed to the given domain, and the address is passed back to
18162 be reprocessed by the routers. No rewriting of headers takes place. This
18163 behaviour is essentially a redirection.
18164
18165 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18166 The domain is changed to the given domain, and the address is passed back to be
18167 reprocessed by the routers. Any headers that contain the original domain are
18168 rewritten.
18169
18170 .vitem &%pass%&
18171 .oindex "&%more%&"
18172 .vindex "&$self_hostname$&"
18173 The router passes the address to the next router, or to the router named in the
18174 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18175 subsequent routing and delivery, the variable &$self_hostname$& contains the
18176 name of the local host that the router encountered. This can be used to
18177 distinguish between different cases for hosts with multiple names. The
18178 combination
18179 .code
18180 self = pass
18181 no_more
18182 .endd
18183 ensures that only those addresses that routed to the local host are passed on.
18184 Without &%no_more%&, addresses that were declined for other reasons would also
18185 be passed to the next router.
18186
18187 .vitem &%fail%&
18188 Delivery fails and an error report is generated.
18189
18190 .vitem &%send%&
18191 .cindex "local host" "sending to"
18192 The anomaly is ignored and the address is queued for the transport. This
18193 setting should be used with extreme caution. For an &(smtp)& transport, it
18194 makes sense only in cases where the program that is listening on the SMTP port
18195 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18196 different configuration file that handles the domain in another way.
18197 .endlist
18198
18199
18200
18201 .option senders routers&!? "address list&!!" unset
18202 .cindex "router" "checking senders"
18203 If this option is set, the router is skipped unless the message's sender
18204 address matches something on the list.
18205 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18206 are evaluated.
18207
18208 There are issues concerning verification when the running of routers is
18209 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18210 setting, it sets the sender to the null string. When using the &%-bt%& option
18211 to check a configuration file, it is necessary also to use the &%-f%& option to
18212 set an appropriate sender. For incoming mail, the sender is unset when
18213 verifying the sender, but is available when verifying any recipients. If the
18214 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18215 matters.
18216
18217
18218 .option translate_ip_address routers string&!! unset
18219 .cindex "IP address" "translating"
18220 .cindex "packet radio"
18221 .cindex "router" "IP address translation"
18222 There exist some rare networking situations (for example, packet radio) where
18223 it is helpful to be able to translate IP addresses generated by normal routing
18224 mechanisms into other IP addresses, thus performing a kind of manual IP
18225 routing. This should be done only if the normal IP routing of the TCP/IP stack
18226 is inadequate or broken. Because this is an extremely uncommon requirement, the
18227 code to support this option is not included in the Exim binary unless
18228 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18229
18230 .vindex "&$host_address$&"
18231 The &%translate_ip_address%& string is expanded for every IP address generated
18232 by the router, with the generated address set in &$host_address$&. If the
18233 expansion is forced to fail, no action is taken.
18234 For any other expansion error, delivery of the message is deferred.
18235 If the result of the expansion is an IP address, that replaces the original
18236 address; otherwise the result is assumed to be a host name &-- this is looked
18237 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18238 produce one or more replacement IP addresses. For example, to subvert all IP
18239 addresses in some specific networks, this could be added to a router:
18240 .code
18241 translate_ip_address = \
18242   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18243     {$value}fail}}
18244 .endd
18245 The file would contain lines like
18246 .code
18247 10.2.3.128/26    some.host
18248 10.8.4.34/26     10.44.8.15
18249 .endd
18250 You should not make use of this facility unless you really understand what you
18251 are doing.
18252
18253
18254
18255 .option transport routers string&!! unset
18256 This option specifies the transport to be used when a router accepts an address
18257 and sets it up for delivery. A transport is never needed if a router is used
18258 only for verification. The value of the option is expanded at routing time,
18259 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18260 and result must be the name of one of the configured transports. If it is not,
18261 delivery is deferred.
18262
18263 The &%transport%& option is not used by the &(redirect)& router, but it does
18264 have some private options that set up transports for pipe and file deliveries
18265 (see chapter &<<CHAPredirect>>&).
18266
18267
18268
18269 .option transport_current_directory routers string&!! unset
18270 .cindex "current directory for local transport"
18271 This option associates a current directory with any address that is routed
18272 to a local transport. This can happen either because a transport is
18273 explicitly configured for the router, or because it generates a delivery to a
18274 file or a pipe. During the delivery process (that is, at transport time), this
18275 option string is expanded and is set as the current directory, unless
18276 overridden by a setting on the transport.
18277 If the expansion fails for any reason, including forced failure, an error is
18278 logged, and delivery is deferred.
18279 See chapter &<<CHAPenvironment>>& for details of the local delivery
18280 environment.
18281
18282
18283
18284
18285 .option transport_home_directory routers string&!! "see below"
18286 .cindex "home directory" "for local transport"
18287 This option associates a home directory with any address that is routed to a
18288 local transport. This can happen either because a transport is explicitly
18289 configured for the router, or because it generates a delivery to a file or a
18290 pipe. During the delivery process (that is, at transport time), the option
18291 string is expanded and is set as the home directory, unless overridden by a
18292 setting of &%home_directory%& on the transport.
18293 If the expansion fails for any reason, including forced failure, an error is
18294 logged, and delivery is deferred.
18295
18296 If the transport does not specify a home directory, and
18297 &%transport_home_directory%& is not set for the router, the home directory for
18298 the transport is taken from the password data if &%check_local_user%& is set for
18299 the router. Otherwise it is taken from &%router_home_directory%& if that option
18300 is set; if not, no home directory is set for the transport.
18301
18302 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18303 environment.
18304
18305
18306
18307
18308 .option unseen routers boolean&!! false
18309 .cindex "router" "carrying on after success"
18310 The result of string expansion for this option must be a valid boolean value,
18311 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18312 result causes an error, and delivery is deferred. If the expansion is forced to
18313 fail, the default value for the option (false) is used. Other failures cause
18314 delivery to be deferred.
18315
18316 When this option is set true, routing does not cease if the router accepts the
18317 address. Instead, a copy of the incoming address is passed to the next router,
18318 overriding a false setting of &%more%&. There is little point in setting
18319 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18320 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18321 sometimes true and sometimes false).
18322
18323 .cindex "copy of message (&%unseen%& option)"
18324 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18325 qualifier in filter files. It can be used to cause copies of messages to be
18326 delivered to some other destination, while also carrying out a normal delivery.
18327 In effect, the current address is made into a &"parent"& that has two children
18328 &-- one that is delivered as specified by this router, and a clone that goes on
18329 to be routed further. For this reason, &%unseen%& may not be combined with the
18330 &%one_time%& option in a &(redirect)& router.
18331
18332 &*Warning*&: Header lines added to the address (or specified for removal) by
18333 this router or by previous routers affect the &"unseen"& copy of the message
18334 only. The clone that continues to be processed by further routers starts with
18335 no added headers and none specified for removal. For a &%redirect%& router, if
18336 a generated address is the same as the incoming address, this can lead to
18337 duplicate addresses with different header modifications. Exim does not do
18338 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18339 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18340 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18341 &%redirect%& router may be of help.
18342
18343 Unlike the handling of header modifications, any data that was set by the
18344 &%address_data%& option in the current or previous routers &'is'& passed on to
18345 subsequent routers.
18346
18347
18348 .option user routers string&!! "see below"
18349 .cindex "uid (user id)" "local delivery"
18350 .cindex "local transports" "uid and gid"
18351 .cindex "transport" "local"
18352 .cindex "router" "user for filter processing"
18353 .cindex "filter" "user for processing"
18354 When a router queues an address for a transport, and the transport does not
18355 specify a user, the user given here is used when running the delivery process.
18356 The user may be specified numerically or by name. If expansion fails, the
18357 error is logged and delivery is deferred.
18358 This user is also used by the &(redirect)& router when running a filter file.
18359 The default is unset, except when &%check_local_user%& is set. In this case,
18360 the default is taken from the password information. If the user is specified as
18361 a name, and &%group%& is not set, the group associated with the user is used.
18362 See also &%initgroups%& and &%group%& and the discussion in chapter
18363 &<<CHAPenvironment>>&.
18364
18365
18366
18367 .option verify routers&!? boolean true
18368 Setting this option has the effect of setting &%verify_sender%& and
18369 &%verify_recipient%& to the same value.
18370
18371
18372 .option verify_only routers&!? boolean false
18373 .cindex "EXPN" "with &%verify_only%&"
18374 .oindex "&%-bv%&"
18375 .cindex "router" "used only when verifying"
18376 If this option is set, the router is used only when verifying an address,
18377 delivering in cutthrough mode or
18378 testing with the &%-bv%& option, not when actually doing a delivery, testing
18379 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18380 restricted to verifying only senders or recipients by means of
18381 &%verify_sender%& and &%verify_recipient%&.
18382
18383 &*Warning*&: When the router is being run to verify addresses for an incoming
18384 SMTP message, Exim is not running as root, but under its own uid. If the router
18385 accesses any files, you need to make sure that they are accessible to the Exim
18386 user or group.
18387
18388
18389 .option verify_recipient routers&!? boolean true
18390 If this option is false, the router is skipped when verifying recipient
18391 addresses,
18392 delivering in cutthrough mode
18393 or testing recipient verification using &%-bv%&.
18394 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18395 are evaluated.
18396 See also the &$verify_mode$& variable.
18397
18398
18399 .option verify_sender routers&!? boolean true
18400 If this option is false, the router is skipped when verifying sender addresses
18401 or testing sender verification using &%-bvs%&.
18402 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18403 are evaluated.
18404 See also the &$verify_mode$& variable.
18405 .ecindex IIDgenoprou1
18406 .ecindex IIDgenoprou2
18407
18408
18409
18410
18411
18412
18413 . ////////////////////////////////////////////////////////////////////////////
18414 . ////////////////////////////////////////////////////////////////////////////
18415
18416 .chapter "The accept router" "CHID4"
18417 .cindex "&(accept)& router"
18418 .cindex "routers" "&(accept)&"
18419 The &(accept)& router has no private options of its own. Unless it is being
18420 used purely for verification (see &%verify_only%&) a transport is required to
18421 be defined by the generic &%transport%& option. If the preconditions that are
18422 specified by generic options are met, the router accepts the address and queues
18423 it for the given transport. The most common use of this router is for setting
18424 up deliveries to local mailboxes. For example:
18425 .code
18426 localusers:
18427   driver = accept
18428   domains = mydomain.example
18429   check_local_user
18430   transport = local_delivery
18431 .endd
18432 The &%domains%& condition in this example checks the domain of the address, and
18433 &%check_local_user%& checks that the local part is the login of a local user.
18434 When both preconditions are met, the &(accept)& router runs, and queues the
18435 address for the &(local_delivery)& transport.
18436
18437
18438
18439
18440
18441
18442 . ////////////////////////////////////////////////////////////////////////////
18443 . ////////////////////////////////////////////////////////////////////////////
18444
18445 .chapter "The dnslookup router" "CHAPdnslookup"
18446 .scindex IIDdnsrou1 "&(dnslookup)& router"
18447 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18448 The &(dnslookup)& router looks up the hosts that handle mail for the
18449 recipient's domain in the DNS. A transport must always be set for this router,
18450 unless &%verify_only%& is set.
18451
18452 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18453 SRV records. If none are found, or if SRV support is not configured,
18454 MX records are looked up. If no MX records exist, address records are sought.
18455 However, &%mx_domains%& can be set to disable the direct use of address
18456 records.
18457
18458 MX records of equal priority are sorted by Exim into a random order. Exim then
18459 looks for address records for the host names obtained from MX or SRV records.
18460 When a host has more than one IP address, they are sorted into a random order,
18461 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18462 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18463 generic option, the router declines.
18464
18465 Unless they have the highest priority (lowest MX value), MX records that point
18466 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18467 are discarded, together with any other MX records of equal or lower priority.
18468
18469 .cindex "MX record" "pointing to local host"
18470 .cindex "local host" "MX pointing to"
18471 .oindex "&%self%&" "in &(dnslookup)& router"
18472 If the host pointed to by the highest priority MX record, or looked up as an
18473 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18474 happens is controlled by the generic &%self%& option.
18475
18476
18477 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18478 There have been problems with DNS servers when SRV records are looked up.
18479 Some misbehaving servers return a DNS error or timeout when a non-existent
18480 SRV record is sought. Similar problems have in the past been reported for
18481 MX records. The global &%dns_again_means_nonexist%& option can help with this
18482 problem, but it is heavy-handed because it is a global option.
18483
18484 For this reason, there are two options, &%srv_fail_domains%& and
18485 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18486 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18487 an attempt to look up an SRV or MX record causes one of these results, and the
18488 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18489 such record"&. In the case of an SRV lookup, this means that the router
18490 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18491 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18492 case routing fails.
18493
18494
18495 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18496 .cindex "&(dnslookup)& router" "declines"
18497 There are a few cases where a &(dnslookup)& router will decline to accept
18498 an address; if such a router is expected to handle "all remaining non-local
18499 domains", then it is important to set &%no_more%&.
18500
18501 The router will defer rather than decline if the domain
18502 is found in the &%fail_defer_domains%& router option.
18503
18504 Reasons for a &(dnslookup)& router to decline currently include:
18505 .ilist
18506 The domain does not exist in DNS
18507 .next
18508 The domain exists but the MX record's host part is just "."; this is a common
18509 convention (borrowed from SRV) used to indicate that there is no such service
18510 for this domain and to not fall back to trying A/AAAA records.
18511 .next
18512 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18513 .next
18514 MX record points to a non-existent host.
18515 .next
18516 MX record points to an IP address and the main section option
18517 &%allow_mx_to_ip%& is not set.
18518 .next
18519 MX records exist and point to valid hosts, but all hosts resolve only to
18520 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18521 .next
18522 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18523 &%dns_check_names_pattern%& for handling one variant of this)
18524 .next
18525 &%check_secondary_mx%& is set on this router but the local host can
18526 not be found in the MX records (see below)
18527 .endlist
18528
18529
18530
18531
18532 .section "Private options for dnslookup" "SECID118"
18533 .cindex "options" "&(dnslookup)& router"
18534 The private options for the &(dnslookup)& router are as follows:
18535
18536 .option check_secondary_mx dnslookup boolean false
18537 .cindex "MX record" "checking for secondary"
18538 If this option is set, the router declines unless the local host is found in
18539 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18540 process domains for which the local host is a secondary mail exchanger
18541 differently to other domains. The way in which Exim decides whether a host is
18542 the local host is described in section &<<SECTreclocipadd>>&.
18543
18544
18545 .option check_srv dnslookup string&!! unset
18546 .cindex "SRV record" "enabling use of"
18547 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18548 addition to MX and address records. The support is disabled by default. To
18549 enable SRV support, set the &%check_srv%& option to the name of the service
18550 required. For example,
18551 .code
18552 check_srv = smtp
18553 .endd
18554 looks for SRV records that refer to the normal smtp service. The option is
18555 expanded, so the service name can vary from message to message or address
18556 to address. This might be helpful if SRV records are being used for a
18557 submission service. If the expansion is forced to fail, the &%check_srv%&
18558 option is ignored, and the router proceeds to look for MX records in the
18559 normal way.
18560
18561 When the expansion succeeds, the router searches first for SRV records for
18562 the given service (it assumes TCP protocol). A single SRV record with a
18563 host name that consists of just a single dot indicates &"no such service for
18564 this domain"&; if this is encountered, the router declines. If other kinds of
18565 SRV record are found, they are used to construct a host list for delivery
18566 according to the rules of RFC 2782. MX records are not sought in this case.
18567
18568 When no SRV records are found, MX records (and address records) are sought in
18569 the traditional way. In other words, SRV records take precedence over MX
18570 records, just as MX records take precedence over address records. Note that
18571 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18572 defined it. It is apparently believed that MX records are sufficient for email
18573 and that SRV records should not be used for this purpose. However, SRV records
18574 have an additional &"weight"& feature which some people might find useful when
18575 trying to split an SMTP load between hosts of different power.
18576
18577 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18578 when there is a DNS lookup error.
18579
18580
18581
18582
18583 .option fail_defer_domains dnslookup "domain list&!!" unset
18584 .cindex "MX record" "not found"
18585 DNS lookups for domains matching &%fail_defer_domains%&
18586 which find no matching record will cause the router to defer
18587 rather than the default behaviour of decline.
18588 This maybe be useful for queueing messages for a newly created
18589 domain while the DNS configuration is not ready.
18590 However, it will result in any message with mistyped domains
18591 also being queued.
18592
18593
18594 .option mx_domains dnslookup "domain list&!!" unset
18595 .cindex "MX record" "required to exist"
18596 .cindex "SRV record" "required to exist"
18597 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18598 record in order to be recognized. (The name of this option could be improved.)
18599 For example, if all the mail hosts in &'fict.example'& are known to have MX
18600 records, except for those in &'discworld.fict.example'&, you could use this
18601 setting:
18602 .code
18603 mx_domains = ! *.discworld.fict.example : *.fict.example
18604 .endd
18605 This specifies that messages addressed to a domain that matches the list but
18606 has no MX record should be bounced immediately instead of being routed using
18607 the address record.
18608
18609
18610 .option mx_fail_domains dnslookup "domain list&!!" unset
18611 If the DNS lookup for MX records for one of the domains in this list causes a
18612 DNS lookup error, Exim behaves as if no MX records were found. See section
18613 &<<SECTprowitdnsloo>>& for more discussion.
18614
18615
18616
18617
18618 .option qualify_single dnslookup boolean true
18619 .cindex "DNS" "resolver options"
18620 .cindex "DNS" "qualifying single-component names"
18621 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18622 lookups. Typically, but not standardly, this causes the resolver to qualify
18623 single-component names with the default domain. For example, on a machine
18624 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18625 &'thesaurus.ref.example'& inside the resolver. For details of what your
18626 resolver actually does, consult your man pages for &'resolver'& and
18627 &'resolv.conf'&.
18628
18629
18630
18631 .option rewrite_headers dnslookup boolean true
18632 .cindex "rewriting" "header lines"
18633 .cindex "header lines" "rewriting"
18634 If the domain name in the address that is being processed is not fully
18635 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18636 an address is specified as &'dormouse@teaparty'&, the domain might be
18637 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18638 occur as a result of setting the &%widen_domains%& option. If
18639 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18640 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18641 header lines of the message are rewritten with the full domain name.
18642
18643 This option should be turned off only when it is known that no message is
18644 ever going to be sent outside an environment where the abbreviation makes
18645 sense.
18646
18647 When an MX record is looked up in the DNS and matches a wildcard record, name
18648 servers normally return a record containing the name that has been looked up,
18649 making it impossible to detect whether a wildcard was present or not. However,
18650 some name servers have recently been seen to return the wildcard entry. If the
18651 name returned by a DNS lookup begins with an asterisk, it is not used for
18652 header rewriting.
18653
18654
18655 .option same_domain_copy_routing dnslookup boolean false
18656 .cindex "address" "copying routing"
18657 Addresses with the same domain are normally routed by the &(dnslookup)& router
18658 to the same list of hosts. However, this cannot be presumed, because the router
18659 options and preconditions may refer to the local part of the address. By
18660 default, therefore, Exim routes each address in a message independently. DNS
18661 servers run caches, so repeated DNS lookups are not normally expensive, and in
18662 any case, personal messages rarely have more than a few recipients.
18663
18664 If you are running mailing lists with large numbers of subscribers at the same
18665 domain, and you are using a &(dnslookup)& router which is independent of the
18666 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18667 lookups for identical domains in one message. In this case, when &(dnslookup)&
18668 routes an address to a remote transport, any other unrouted addresses in the
18669 message that have the same domain are automatically given the same routing
18670 without processing them independently,
18671 provided the following conditions are met:
18672
18673 .ilist
18674 No router that processed the address specified &%headers_add%& or
18675 &%headers_remove%&.
18676 .next
18677 The router did not change the address in any way, for example, by &"widening"&
18678 the domain.
18679 .endlist
18680
18681
18682
18683
18684 .option search_parents dnslookup boolean false
18685 .cindex "DNS" "resolver options"
18686 When this option is true, the resolver option RES_DNSRCH is set for DNS
18687 lookups. This is different from the &%qualify_single%& option in that it
18688 applies to domains containing dots. Typically, but not standardly, it causes
18689 the resolver to search for the name in the current domain and in parent
18690 domains. For example, on a machine in the &'fict.example'& domain, if looking
18691 up &'teaparty.wonderland'& failed, the resolver would try
18692 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18693 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18694
18695 Setting this option true can cause problems in domains that have a wildcard MX
18696 record, because any domain that does not have its own MX record matches the
18697 local wildcard.
18698
18699
18700
18701 .option srv_fail_domains dnslookup "domain list&!!" unset
18702 If the DNS lookup for SRV records for one of the domains in this list causes a
18703 DNS lookup error, Exim behaves as if no SRV records were found. See section
18704 &<<SECTprowitdnsloo>>& for more discussion.
18705
18706
18707
18708
18709 .option widen_domains dnslookup "string list" unset
18710 .cindex "domain" "partial; widening"
18711 If a DNS lookup fails and this option is set, each of its strings in turn is
18712 added onto the end of the domain, and the lookup is tried again. For example,
18713 if
18714 .code
18715 widen_domains = fict.example:ref.example
18716 .endd
18717 is set and a lookup of &'klingon.dictionary'& fails,
18718 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18719 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18720 and &%search_parents%& options can cause some widening to be undertaken inside
18721 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18722 when verifying, unless &%rewrite_headers%& is false (not the default).
18723
18724
18725 .section "Effect of qualify_single and search_parents" "SECID119"
18726 When a domain from an envelope recipient is changed by the resolver as a result
18727 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18728 corresponding address in the message's header lines unless &%rewrite_headers%&
18729 is set false. Exim then re-routes the address, using the full domain.
18730
18731 These two options affect only the DNS lookup that takes place inside the router
18732 for the domain of the address that is being routed. They do not affect lookups
18733 such as that implied by
18734 .code
18735 domains = @mx_any
18736 .endd
18737 that may happen while processing a router precondition before the router is
18738 entered. No widening ever takes place for these lookups.
18739 .ecindex IIDdnsrou1
18740 .ecindex IIDdnsrou2
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750 . ////////////////////////////////////////////////////////////////////////////
18751 . ////////////////////////////////////////////////////////////////////////////
18752
18753 .chapter "The ipliteral router" "CHID5"
18754 .cindex "&(ipliteral)& router"
18755 .cindex "domain literal" "routing"
18756 .cindex "routers" "&(ipliteral)&"
18757 This router has no private options. Unless it is being used purely for
18758 verification (see &%verify_only%&) a transport is required to be defined by the
18759 generic &%transport%& option. The router accepts the address if its domain part
18760 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18761 router handles the address
18762 .code
18763 root@[192.168.1.1]
18764 .endd
18765 by setting up delivery to the host with that IP address. IPv4 domain literals
18766 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18767 are similar, but the address is preceded by &`ipv6:`&. For example:
18768 .code
18769 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18770 .endd
18771 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18772 grounds that sooner or later somebody will try it.
18773
18774 .oindex "&%self%&" "in &(ipliteral)& router"
18775 If the IP address matches something in &%ignore_target_hosts%&, the router
18776 declines. If an IP literal turns out to refer to the local host, the generic
18777 &%self%& option determines what happens.
18778
18779 The RFCs require support for domain literals; however, their use is
18780 controversial in today's Internet. If you want to use this router, you must
18781 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18782 Exim will not recognize the domain literal syntax in addresses.
18783
18784
18785
18786 . ////////////////////////////////////////////////////////////////////////////
18787 . ////////////////////////////////////////////////////////////////////////////
18788
18789 .chapter "The iplookup router" "CHID6"
18790 .cindex "&(iplookup)& router"
18791 .cindex "routers" "&(iplookup)&"
18792 The &(iplookup)& router was written to fulfil a specific requirement in
18793 Cambridge University (which in fact no longer exists). For this reason, it is
18794 not included in the binary of Exim by default. If you want to include it, you
18795 must set
18796 .code
18797 ROUTER_IPLOOKUP=yes
18798 .endd
18799 in your &_Local/Makefile_& configuration file.
18800
18801 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18802 connection to one or more specific hosts. The host can then return the same or
18803 a different address &-- in effect rewriting the recipient address in the
18804 message's envelope. The new address is then passed on to subsequent routers. If
18805 this process fails, the address can be passed on to other routers, or delivery
18806 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18807 must not be specified for it.
18808
18809 .cindex "options" "&(iplookup)& router"
18810 .option hosts iplookup string unset
18811 This option must be supplied. Its value is a colon-separated list of host
18812 names. The hosts are looked up using &[gethostbyname()]&
18813 (or &[getipnodebyname()]& when available)
18814 and are tried in order until one responds to the query. If none respond, what
18815 happens is controlled by &%optional%&.
18816
18817
18818 .option optional iplookup boolean false
18819 If &%optional%& is true, if no response is obtained from any host, the address
18820 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18821 delivery to the address is deferred.
18822
18823
18824 .option port iplookup integer 0
18825 .cindex "port" "&(iplookup)& router"
18826 This option must be supplied. It specifies the port number for the TCP or UDP
18827 call.
18828
18829
18830 .option protocol iplookup string udp
18831 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18832 protocols is to be used.
18833
18834
18835 .option query iplookup string&!! "see below"
18836 This defines the content of the query that is sent to the remote hosts. The
18837 default value is:
18838 .code
18839 $local_part@$domain $local_part@$domain
18840 .endd
18841 The repetition serves as a way of checking that a response is to the correct
18842 query in the default case (see &%response_pattern%& below).
18843
18844
18845 .option reroute iplookup string&!! unset
18846 If this option is not set, the rerouted address is precisely the byte string
18847 returned by the remote host, up to the first white space, if any. If set, the
18848 string is expanded to form the rerouted address. It can include parts matched
18849 in the response by &%response_pattern%& by means of numeric variables such as
18850 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18851 whether or not a pattern is in use. In all cases, the rerouted address must end
18852 up in the form &'local_part@domain'&.
18853
18854
18855 .option response_pattern iplookup string unset
18856 This option can be set to a regular expression that is applied to the string
18857 returned from the remote host. If the pattern does not match the response, the
18858 router declines. If &%response_pattern%& is not set, no checking of the
18859 response is done, unless the query was defaulted, in which case there is a
18860 check that the text returned after the first white space is the original
18861 address. This checks that the answer that has been received is in response to
18862 the correct question. For example, if the response is just a new domain, the
18863 following could be used:
18864 .code
18865 response_pattern = ^([^@]+)$
18866 reroute = $local_part@$1
18867 .endd
18868
18869 .option timeout iplookup time 5s
18870 This specifies the amount of time to wait for a response from the remote
18871 machine. The same timeout is used for the &[connect()]& function for a TCP
18872 call. It does not apply to UDP.
18873
18874
18875
18876
18877 . ////////////////////////////////////////////////////////////////////////////
18878 . ////////////////////////////////////////////////////////////////////////////
18879
18880 .chapter "The manualroute router" "CHID7"
18881 .scindex IIDmanrou1 "&(manualroute)& router"
18882 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18883 .cindex "domain" "manually routing"
18884 The &(manualroute)& router is so-called because it provides a way of manually
18885 routing an address according to its domain. It is mainly used when you want to
18886 route addresses to remote hosts according to your own rules, bypassing the
18887 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18888 route to local transports, a facility that may be useful if you want to save
18889 messages for dial-in hosts in local files.
18890
18891 The &(manualroute)& router compares a list of domain patterns with the domain
18892 it is trying to route. If there is no match, the router declines. Each pattern
18893 has associated with it a list of hosts and some other optional data, which may
18894 include a transport. The combination of a pattern and its data is called a
18895 &"routing rule"&. For patterns that do not have an associated transport, the
18896 generic &%transport%& option must specify a transport, unless the router is
18897 being used purely for verification (see &%verify_only%&).
18898
18899 .vindex "&$host$&"
18900 In the case of verification, matching the domain pattern is sufficient for the
18901 router to accept the address. When actually routing an address for delivery,
18902 an address that matches a domain pattern is queued for the associated
18903 transport. If the transport is not a local one, a host list must be associated
18904 with the pattern; IP addresses are looked up for the hosts, and these are
18905 passed to the transport along with the mail address. For local transports, a
18906 host list is optional. If it is present, it is passed in &$host$& as a single
18907 text string.
18908
18909 The list of routing rules can be provided as an inline string in
18910 &%route_list%&, or the data can be obtained by looking up the domain in a file
18911 or database by setting &%route_data%&. Only one of these settings may appear in
18912 any one instance of &(manualroute)&. The format of routing rules is described
18913 below, following the list of private options.
18914
18915
18916 .section "Private options for manualroute" "SECTprioptman"
18917
18918 .cindex "options" "&(manualroute)& router"
18919 The private options for the &(manualroute)& router are as follows:
18920
18921 .option host_all_ignored manualroute string defer
18922 See &%host_find_failed%&.
18923
18924 .option host_find_failed manualroute string freeze
18925 This option controls what happens when &(manualroute)& tries to find an IP
18926 address for a host, and the host does not exist. The option can be set to one
18927 of the following values:
18928 .code
18929 decline
18930 defer
18931 fail
18932 freeze
18933 ignore
18934 pass
18935 .endd
18936 The default (&"freeze"&) assumes that this state is a serious configuration
18937 error. The difference between &"pass"& and &"decline"& is that the former
18938 forces the address to be passed to the next router (or the router defined by
18939 &%pass_router%&),
18940 .oindex "&%more%&"
18941 overriding &%no_more%&, whereas the latter passes the address to the next
18942 router only if &%more%& is true.
18943
18944 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18945 cannot be found. If all the hosts in the list are ignored, the behaviour is
18946 controlled by the &%host_all_ignored%& option. This takes the same values
18947 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18948
18949 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18950 state; if a host lookup gets a temporary error, delivery is deferred unless the
18951 generic &%pass_on_timeout%& option is set.
18952
18953
18954 .option hosts_randomize manualroute boolean false
18955 .cindex "randomized host list"
18956 .cindex "host" "list of; randomized"
18957 If this option is set, the order of the items in a host list in a routing rule
18958 is randomized each time the list is used, unless an option in the routing rule
18959 overrides (see below). Randomizing the order of a host list can be used to do
18960 crude load sharing. However, if more than one mail address is routed by the
18961 same router to the same host list, the host lists are considered to be the same
18962 (even though they may be randomized into different orders) for the purpose of
18963 deciding whether to batch the deliveries into a single SMTP transaction.
18964
18965 When &%hosts_randomize%& is true, a host list may be split
18966 into groups whose order is separately randomized. This makes it possible to
18967 set up MX-like behaviour. The boundaries between groups are indicated by an
18968 item that is just &`+`& in the host list. For example:
18969 .code
18970 route_list = * host1:host2:host3:+:host4:host5
18971 .endd
18972 The order of the first three hosts and the order of the last two hosts is
18973 randomized for each use, but the first three always end up before the last two.
18974 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18975 randomized host list is passed to an &(smtp)& transport that also has
18976 &%hosts_randomize set%&, the list is not re-randomized.
18977
18978
18979 .option route_data manualroute string&!! unset
18980 If this option is set, it must expand to yield the data part of a routing rule.
18981 Typically, the expansion string includes a lookup based on the domain. For
18982 example:
18983 .code
18984 route_data = ${lookup{$domain}dbm{/etc/routes}}
18985 .endd
18986 If the expansion is forced to fail, or the result is an empty string, the
18987 router declines. Other kinds of expansion failure cause delivery to be
18988 deferred.
18989
18990
18991 .option route_list manualroute "string list" unset
18992 This string is a list of routing rules, in the form defined below. Note that,
18993 unlike most string lists, the items are separated by semicolons. This is so
18994 that they may contain colon-separated host lists.
18995
18996
18997 .option same_domain_copy_routing manualroute boolean false
18998 .cindex "address" "copying routing"
18999 Addresses with the same domain are normally routed by the &(manualroute)&
19000 router to the same list of hosts. However, this cannot be presumed, because the
19001 router options and preconditions may refer to the local part of the address. By
19002 default, therefore, Exim routes each address in a message independently. DNS
19003 servers run caches, so repeated DNS lookups are not normally expensive, and in
19004 any case, personal messages rarely have more than a few recipients.
19005
19006 If you are running mailing lists with large numbers of subscribers at the same
19007 domain, and you are using a &(manualroute)& router which is independent of the
19008 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19009 lookups for identical domains in one message. In this case, when
19010 &(manualroute)& routes an address to a remote transport, any other unrouted
19011 addresses in the message that have the same domain are automatically given the
19012 same routing without processing them independently. However, this is only done
19013 if &%headers_add%& and &%headers_remove%& are unset.
19014
19015
19016
19017
19018 .section "Routing rules in route_list" "SECID120"
19019 The value of &%route_list%& is a string consisting of a sequence of routing
19020 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19021 entered as two semicolons. Alternatively, the list separator can be changed as
19022 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19023 Empty rules are ignored. The format of each rule is
19024 .display
19025 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19026 .endd
19027 The following example contains two rules, each with a simple domain pattern and
19028 no options:
19029 .code
19030 route_list = \
19031   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19032   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19033 .endd
19034 The three parts of a rule are separated by white space. The pattern and the
19035 list of hosts can be enclosed in quotes if necessary, and if they are, the
19036 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19037 single domain pattern, which is the only mandatory item in the rule. The
19038 pattern is in the same format as one item in a domain list (see section
19039 &<<SECTdomainlist>>&),
19040 except that it may not be the name of an interpolated file.
19041 That is, it may be wildcarded, or a regular expression, or a file or database
19042 lookup (with semicolons doubled, because of the use of semicolon as a separator
19043 in a &%route_list%&).
19044
19045 The rules in &%route_list%& are searched in order until one of the patterns
19046 matches the domain that is being routed. The list of hosts and then options are
19047 then used as described below. If there is no match, the router declines. When
19048 &%route_list%& is set, &%route_data%& must not be set.
19049
19050
19051
19052 .section "Routing rules in route_data" "SECID121"
19053 The use of &%route_list%& is convenient when there are only a small number of
19054 routing rules. For larger numbers, it is easier to use a file or database to
19055 hold the routing information, and use the &%route_data%& option instead.
19056 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19057 Most commonly, &%route_data%& is set as a string that contains an
19058 expansion lookup. For example, suppose we place two routing rules in a file
19059 like this:
19060 .code
19061 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19062 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19063 .endd
19064 This data can be accessed by setting
19065 .code
19066 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19067 .endd
19068 Failure of the lookup results in an empty string, causing the router to
19069 decline. However, you do not have to use a lookup in &%route_data%&. The only
19070 requirement is that the result of expanding the string is a list of hosts,
19071 possibly followed by options, separated by white space. The list of hosts must
19072 be enclosed in quotes if it contains white space.
19073
19074
19075
19076
19077 .section "Format of the list of hosts" "SECID122"
19078 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19079 always separately expanded before use. If the expansion fails, the router
19080 declines. The result of the expansion must be a colon-separated list of names
19081 and/or IP addresses, optionally also including ports. The format of each item
19082 in the list is described in the next section. The list separator can be changed
19083 as described in section &<<SECTlistconstruct>>&.
19084
19085 If the list of hosts was obtained from a &%route_list%& item, the following
19086 variables are set during its expansion:
19087
19088 .ilist
19089 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19090 If the domain was matched against a regular expression, the numeric variables
19091 &$1$&, &$2$&, etc. may be set. For example:
19092 .code
19093 route_list = ^domain(\d+)   host-$1.text.example
19094 .endd
19095 .next
19096 &$0$& is always set to the entire domain.
19097 .next
19098 &$1$& is also set when partial matching is done in a file lookup.
19099
19100 .next
19101 .vindex "&$value$&"
19102 If the pattern that matched the domain was a lookup item, the data that was
19103 looked up is available in the expansion variable &$value$&. For example:
19104 .code
19105 route_list = lsearch;;/some/file.routes  $value
19106 .endd
19107 .endlist
19108
19109 Note the doubling of the semicolon in the pattern that is necessary because
19110 semicolon is the default route list separator.
19111
19112
19113
19114 .section "Format of one host item" "SECTformatonehostitem"
19115 Each item in the list of hosts is either a host name or an IP address,
19116 optionally with an attached port number. When no port is given, an IP address
19117 is not enclosed in brackets. When a port is specified, it overrides the port
19118 specification on the transport. The port is separated from the name or address
19119 by a colon. This leads to some complications:
19120
19121 .ilist
19122 Because colon is the default separator for the list of hosts, either
19123 the colon that specifies a port must be doubled, or the list separator must
19124 be changed. The following two examples have the same effect:
19125 .code
19126 route_list = * "host1.tld::1225 : host2.tld::1226"
19127 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19128 .endd
19129 .next
19130 When IPv6 addresses are involved, it gets worse, because they contain
19131 colons of their own. To make this case easier, it is permitted to
19132 enclose an IP address (either v4 or v6) in square brackets if a port
19133 number follows. For example:
19134 .code
19135 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19136 .endd
19137 .endlist
19138
19139 .section "How the list of hosts is used" "SECThostshowused"
19140 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19141 the hosts is tried, in the order specified, when carrying out the SMTP
19142 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19143 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19144 transport.
19145
19146 Hosts may be listed by name or by IP address. An unadorned name in the list of
19147 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19148 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19149 records in the DNS. For example:
19150 .code
19151 route_list = *  x.y.z:p.q.r/MX:e.f.g
19152 .endd
19153 If this feature is used with a port specifier, the port must come last. For
19154 example:
19155 .code
19156 route_list = *  dom1.tld/mx::1225
19157 .endd
19158 If the &%hosts_randomize%& option is set, the order of the items in the list is
19159 randomized before any lookups are done. Exim then scans the list; for any name
19160 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19161 be an interface on the local host and the item is not the first in the list,
19162 Exim discards it and any subsequent items. If it is the first item, what
19163 happens is controlled by the
19164 .oindex "&%self%&" "in &(manualroute)& router"
19165 &%self%& option of the router.
19166
19167 A name on the list that is followed by &`/MX`& is replaced with the list of
19168 hosts obtained by looking up MX records for the name. This is always a DNS
19169 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19170 below) are not relevant here. The order of these hosts is determined by the
19171 preference values in the MX records, according to the usual rules. Because
19172 randomizing happens before the MX lookup, it does not affect the order that is
19173 defined by MX preferences.
19174
19175 If the local host is present in the sublist obtained from MX records, but is
19176 not the most preferred host in that list, it and any equally or less
19177 preferred hosts are removed before the sublist is inserted into the main list.
19178
19179 If the local host is the most preferred host in the MX list, what happens
19180 depends on where in the original list of hosts the &`/MX`& item appears. If it
19181 is not the first item (that is, there are previous hosts in the main list),
19182 Exim discards this name and any subsequent items in the main list.
19183
19184 If the MX item is first in the list of hosts, and the local host is the
19185 most preferred host, what happens is controlled by the &%self%& option of the
19186 router.
19187
19188 DNS failures when lookup up the MX records are treated in the same way as DNS
19189 failures when looking up IP addresses: &%pass_on_timeout%& and
19190 &%host_find_failed%& are used when relevant.
19191
19192 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19193 whether obtained from an MX lookup or not.
19194
19195
19196
19197 .section "How the options are used" "SECThowoptused"
19198 The options are a sequence of words; in practice no more than three are ever
19199 present. One of the words can be the name of a transport; this overrides the
19200 &%transport%& option on the router for this particular routing rule only. The
19201 other words (if present) control randomization of the list of hosts on a
19202 per-rule basis, and how the IP addresses of the hosts are to be found when
19203 routing to a remote transport. These options are as follows:
19204
19205 .ilist
19206 &%randomize%&: randomize the order of the hosts in this list, overriding the
19207 setting of &%hosts_randomize%& for this routing rule only.
19208 .next
19209 &%no_randomize%&: do not randomize the order of the hosts in this list,
19210 overriding the setting of &%hosts_randomize%& for this routing rule only.
19211 .next
19212 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19213 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19214 also look in &_/etc/hosts_& or other sources of information.
19215 .next
19216 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19217 no address records are found. If there is a temporary DNS error (such as a
19218 timeout), delivery is deferred.
19219 .endlist
19220
19221 For example:
19222 .code
19223 route_list = domain1  host1:host2:host3  randomize bydns;\
19224              domain2  host4:host5
19225 .endd
19226 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19227 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19228 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19229 or &[gethostbyname()]&, and the result of the lookup is the result of that
19230 call.
19231
19232 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19233 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19234 instead of TRY_AGAIN. That is why the default action is to try a DNS
19235 lookup first. Only if that gives a definite &"no such host"& is the local
19236 function called.
19237
19238
19239
19240 If no IP address for a host can be found, what happens is controlled by the
19241 &%host_find_failed%& option.
19242
19243 .vindex "&$host$&"
19244 When an address is routed to a local transport, IP addresses are not looked up.
19245 The host list is passed to the transport in the &$host$& variable.
19246
19247
19248
19249 .section "Manualroute examples" "SECID123"
19250 In some of the examples that follow, the presence of the &%remote_smtp%&
19251 transport, as defined in the default configuration file, is assumed:
19252
19253 .ilist
19254 .cindex "smart host" "example router"
19255 The &(manualroute)& router can be used to forward all external mail to a
19256 &'smart host'&. If you have set up, in the main part of the configuration, a
19257 named domain list that contains your local domains, for example:
19258 .code
19259 domainlist local_domains = my.domain.example
19260 .endd
19261 You can arrange for all other domains to be routed to a smart host by making
19262 your first router something like this:
19263 .code
19264 smart_route:
19265   driver = manualroute
19266   domains = !+local_domains
19267   transport = remote_smtp
19268   route_list = * smarthost.ref.example
19269 .endd
19270 This causes all non-local addresses to be sent to the single host
19271 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19272 they are tried in order
19273 (but you can use &%hosts_randomize%& to vary the order each time).
19274 Another way of configuring the same thing is this:
19275 .code
19276 smart_route:
19277   driver = manualroute
19278   transport = remote_smtp
19279   route_list = !+local_domains  smarthost.ref.example
19280 .endd
19281 There is no difference in behaviour between these two routers as they stand.
19282 However, they behave differently if &%no_more%& is added to them. In the first
19283 example, the router is skipped if the domain does not match the &%domains%&
19284 precondition; the following router is always tried. If the router runs, it
19285 always matches the domain and so can never decline. Therefore, &%no_more%&
19286 would have no effect. In the second case, the router is never skipped; it
19287 always runs. However, if it doesn't match the domain, it declines. In this case
19288 &%no_more%& would prevent subsequent routers from running.
19289
19290 .next
19291 .cindex "mail hub example"
19292 A &'mail hub'& is a host which receives mail for a number of domains via MX
19293 records in the DNS and delivers it via its own private routing mechanism. Often
19294 the final destinations are behind a firewall, with the mail hub being the one
19295 machine that can connect to machines both inside and outside the firewall. The
19296 &(manualroute)& router is usually used on a mail hub to route incoming messages
19297 to the correct hosts. For a small number of domains, the routing can be inline,
19298 using the &%route_list%& option, but for a larger number a file or database
19299 lookup is easier to manage.
19300
19301 If the domain names are in fact the names of the machines to which the mail is
19302 to be sent by the mail hub, the configuration can be quite simple. For
19303 example:
19304 .code
19305 hub_route:
19306   driver = manualroute
19307   transport = remote_smtp
19308   route_list = *.rhodes.tvs.example  $domain
19309 .endd
19310 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19311 whose names are the same as the mail domains. A similar approach can be taken
19312 if the host name can be obtained from the domain name by a string manipulation
19313 that the expansion facilities can handle. Otherwise, a lookup based on the
19314 domain can be used to find the host:
19315 .code
19316 through_firewall:
19317   driver = manualroute
19318   transport = remote_smtp
19319   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19320 .endd
19321 The result of the lookup must be the name or IP address of the host (or
19322 hosts) to which the address is to be routed. If the lookup fails, the route
19323 data is empty, causing the router to decline. The address then passes to the
19324 next router.
19325
19326 .next
19327 .cindex "batched SMTP output example"
19328 .cindex "SMTP" "batched outgoing; example"
19329 You can use &(manualroute)& to deliver messages to pipes or files in batched
19330 SMTP format for onward transportation by some other means. This is one way of
19331 storing mail for a dial-up host when it is not connected. The route list entry
19332 can be as simple as a single domain name in a configuration like this:
19333 .code
19334 save_in_file:
19335   driver = manualroute
19336   transport = batchsmtp_appendfile
19337   route_list = saved.domain.example
19338 .endd
19339 though often a pattern is used to pick up more than one domain. If there are
19340 several domains or groups of domains with different transport requirements,
19341 different transports can be listed in the routing information:
19342 .code
19343 save_in_file:
19344   driver = manualroute
19345   route_list = \
19346     *.saved.domain1.example  $domain  batch_appendfile; \
19347     *.saved.domain2.example  \
19348       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19349       batch_pipe
19350 .endd
19351 .vindex "&$domain$&"
19352 .vindex "&$host$&"
19353 The first of these just passes the domain in the &$host$& variable, which
19354 doesn't achieve much (since it is also in &$domain$&), but the second does a
19355 file lookup to find a value to pass, causing the router to decline to handle
19356 the address if the lookup fails.
19357
19358 .next
19359 .cindex "UUCP" "example of router for"
19360 Routing mail directly to UUCP software is a specific case of the use of
19361 &(manualroute)& in a gateway to another mail environment. This is an example of
19362 one way it can be done:
19363 .code
19364 # Transport
19365 uucp:
19366   driver = pipe
19367   user = nobody
19368   command = /usr/local/bin/uux -r - \
19369     ${substr_-5:$host}!rmail ${local_part}
19370   return_fail_output = true
19371
19372 # Router
19373 uucphost:
19374   transport = uucp
19375   driver = manualroute
19376   route_data = \
19377     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19378 .endd
19379 The file &_/usr/local/exim/uucphosts_& contains entries like
19380 .code
19381 darksite.ethereal.example:           darksite.UUCP
19382 .endd
19383 It can be set up more simply without adding and removing &".UUCP"& but this way
19384 makes clear the distinction between the domain name
19385 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19386 .endlist
19387 .ecindex IIDmanrou1
19388 .ecindex IIDmanrou2
19389
19390
19391
19392
19393
19394
19395
19396
19397 . ////////////////////////////////////////////////////////////////////////////
19398 . ////////////////////////////////////////////////////////////////////////////
19399
19400 .chapter "The queryprogram router" "CHAPdriverlast"
19401 .scindex IIDquerou1 "&(queryprogram)& router"
19402 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19403 .cindex "routing" "by external program"
19404 The &(queryprogram)& router routes an address by running an external command
19405 and acting on its output. This is an expensive way to route, and is intended
19406 mainly for use in lightly-loaded systems, or for performing experiments.
19407 However, if it is possible to use the precondition options (&%domains%&,
19408 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19409 be used in special cases, even on a busy host. There are the following private
19410 options:
19411 .cindex "options" "&(queryprogram)& router"
19412
19413 .option command queryprogram string&!! unset
19414 This option must be set. It specifies the command that is to be run. The
19415 command is split up into a command name and arguments, and then each is
19416 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19417 &<<CHAPpipetransport>>&).
19418
19419
19420 .option command_group queryprogram string unset
19421 .cindex "gid (group id)" "in &(queryprogram)& router"
19422 This option specifies a gid to be set when running the command while routing an
19423 address for deliver. It must be set if &%command_user%& specifies a numerical
19424 uid. If it begins with a digit, it is interpreted as the numerical value of the
19425 gid. Otherwise it is looked up using &[getgrnam()]&.
19426
19427
19428 .option command_user queryprogram string unset
19429 .cindex "uid (user id)" "for &(queryprogram)&"
19430 This option must be set. It specifies the uid which is set when running the
19431 command while routing an address for delivery. If the value begins with a digit,
19432 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19433 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19434 not set, a value for the gid also.
19435
19436 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19437 root, which it does during a normal delivery in a conventional configuration.
19438 However, when an address is being verified during message reception, Exim is
19439 usually running as the Exim user, not as root. If the &(queryprogram)& router
19440 is called from a non-root process, Exim cannot change uid or gid before running
19441 the command. In this circumstance the command runs under the current uid and
19442 gid.
19443
19444
19445 .option current_directory queryprogram string /
19446 This option specifies an absolute path which is made the current directory
19447 before running the command.
19448
19449
19450 .option timeout queryprogram time 1h
19451 If the command does not complete within the timeout period, its process group
19452 is killed and the message is frozen. A value of zero time specifies no
19453 timeout.
19454
19455
19456 The standard output of the command is connected to a pipe, which is read when
19457 the command terminates. It should consist of a single line of output,
19458 containing up to five fields, separated by white space. The maximum length of
19459 the line is 1023 characters. Longer lines are silently truncated. The first
19460 field is one of the following words (case-insensitive):
19461
19462 .ilist
19463 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19464 below).
19465 .next
19466 &'Decline'&: the router declines; pass the address to the next router, unless
19467 &%no_more%& is set.
19468 .next
19469 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19470 subsequent text on the line is an error message. If the router is run as part
19471 of address verification during an incoming SMTP message, the message is
19472 included in the SMTP response.
19473 .next
19474 &'Defer'&: routing could not be completed at this time; try again later. Any
19475 subsequent text on the line is an error message which is logged. It is not
19476 included in any SMTP response.
19477 .next
19478 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19479 .next
19480 &'Pass'&: pass the address to the next router (or the router specified by
19481 &%pass_router%&), overriding &%no_more%&.
19482 .next
19483 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19484 new addresses, which are routed independently, starting with the first router,
19485 or the router specified by &%redirect_router%&, if set.
19486 .endlist
19487
19488 When the first word is &'accept'&, the remainder of the line consists of a
19489 number of keyed data values, as follows (split into two lines here, to fit on
19490 the page):
19491 .code
19492 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19493 LOOKUP=byname|bydns DATA=<text>
19494 .endd
19495 The data items can be given in any order, and all are optional. If no transport
19496 is included, the transport specified by the generic &%transport%& option is
19497 used. The list of hosts and the lookup type are needed only if the transport is
19498 an &(smtp)& transport that does not itself supply a list of hosts.
19499
19500 The format of the list of hosts is the same as for the &(manualroute)& router.
19501 As well as host names and IP addresses with optional port numbers, as described
19502 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19503 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19504 (see section &<<SECThostshowused>>&).
19505
19506 If the lookup type is not specified, Exim behaves as follows when trying to
19507 find an IP address for each host: First, a DNS lookup is done. If this yields
19508 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19509 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19510 result of the lookup is the result of that call.
19511
19512 .vindex "&$address_data$&"
19513 If the DATA field is set, its value is placed in the &$address_data$&
19514 variable. For example, this return line
19515 .code
19516 accept hosts=x1.y.example:x2.y.example data="rule1"
19517 .endd
19518 routes the address to the default transport, passing a list of two hosts. When
19519 the transport runs, the string &"rule1"& is in &$address_data$&.
19520 .ecindex IIDquerou1
19521 .ecindex IIDquerou2
19522
19523
19524
19525
19526 . ////////////////////////////////////////////////////////////////////////////
19527 . ////////////////////////////////////////////////////////////////////////////
19528
19529 .chapter "The redirect router" "CHAPredirect"
19530 .scindex IIDredrou1 "&(redirect)& router"
19531 .scindex IIDredrou2 "routers" "&(redirect)&"
19532 .cindex "alias file" "in a &(redirect)& router"
19533 .cindex "address redirection" "&(redirect)& router"
19534 The &(redirect)& router handles several kinds of address redirection. Its most
19535 common uses are for resolving local part aliases from a central alias file
19536 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19537 files, but it has many other potential uses. The incoming address can be
19538 redirected in several different ways:
19539
19540 .ilist
19541 It can be replaced by one or more new addresses which are themselves routed
19542 independently.
19543 .next
19544 It can be routed to be delivered to a given file or directory.
19545 .next
19546 It can be routed to be delivered to a specified pipe command.
19547 .next
19548 It can cause an automatic reply to be generated.
19549 .next
19550 It can be forced to fail, optionally with a custom error message.
19551 .next
19552 It can be temporarily deferred, optionally with a custom message.
19553 .next
19554 It can be discarded.
19555 .endlist
19556
19557 The generic &%transport%& option must not be set for &(redirect)& routers.
19558 However, there are some private options which define transports for delivery to
19559 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19560 &%pipe_transport%& and &%reply_transport%& descriptions below.
19561
19562 If success DSNs have been requested
19563 .cindex "DSN" "success"
19564 .cindex "Delivery Status Notification" "success"
19565 redirection triggers one and the DSN options are not passed any further.
19566
19567
19568
19569 .section "Redirection data" "SECID124"
19570 The router operates by interpreting a text string which it obtains either by
19571 expanding the contents of the &%data%& option, or by reading the entire
19572 contents of a file whose name is given in the &%file%& option. These two
19573 options are mutually exclusive. The first is commonly used for handling system
19574 aliases, in a configuration like this:
19575 .code
19576 system_aliases:
19577   driver = redirect
19578   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19579 .endd
19580 If the lookup fails, the expanded string in this example is empty. When the
19581 expansion of &%data%& results in an empty string, the router declines. A forced
19582 expansion failure also causes the router to decline; other expansion failures
19583 cause delivery to be deferred.
19584
19585 A configuration using &%file%& is commonly used for handling users'
19586 &_.forward_& files, like this:
19587 .code
19588 userforward:
19589   driver = redirect
19590   check_local_user
19591   file = $home/.forward
19592   no_verify
19593 .endd
19594 If the file does not exist, or causes no action to be taken (for example, it is
19595 empty or consists only of comments), the router declines. &*Warning*&: This
19596 is not the case when the file contains syntactically valid items that happen to
19597 yield empty addresses, for example, items containing only RFC 2822 address
19598 comments.
19599
19600
19601
19602 .section "Forward files and address verification" "SECID125"
19603 .cindex "address redirection" "while verifying"
19604 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19605 &_.forward_& files, as in the example above. There are two reasons for this:
19606
19607 .ilist
19608 When Exim is receiving an incoming SMTP message from a remote host, it is
19609 running under the Exim uid, not as root. Exim is unable to change uid to read
19610 the file as the user, and it may not be able to read it as the Exim user. So in
19611 practice the router may not be able to operate.
19612 .next
19613 However, even when the router can operate, the existence of a &_.forward_& file
19614 is unimportant when verifying an address. What should be checked is whether the
19615 local part is a valid user name or not. Cutting out the redirection processing
19616 saves some resources.
19617 .endlist
19618
19619
19620
19621
19622
19623
19624 .section "Interpreting redirection data" "SECID126"
19625 .cindex "Sieve filter" "specifying in redirection data"
19626 .cindex "filter" "specifying in redirection data"
19627 The contents of the data string, whether obtained from &%data%& or &%file%&,
19628 can be interpreted in two different ways:
19629
19630 .ilist
19631 If the &%allow_filter%& option is set true, and the data begins with the text
19632 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19633 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19634 respectively. Details of the syntax and semantics of filter files are described
19635 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19636 document is intended for use by end users.
19637 .next
19638 Otherwise, the data must be a comma-separated list of redirection items, as
19639 described in the next section.
19640 .endlist
19641
19642 When a message is redirected to a file (a &"mail folder"&), the file name given
19643 in a non-filter redirection list must always be an absolute path. A filter may
19644 generate a relative path &-- how this is handled depends on the transport's
19645 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19646 for the &(appendfile)& transport.
19647
19648
19649
19650 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19651 .cindex "address redirection" "non-filter list items"
19652 When the redirection data is not an Exim or Sieve filter, for example, if it
19653 comes from a conventional alias or forward file, it consists of a list of
19654 addresses, file names, pipe commands, or certain special items (see section
19655 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19656 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19657 depending on their default values. The items in the list are separated by
19658 commas or newlines.
19659 If a comma is required in an item, the entire item must be enclosed in double
19660 quotes.
19661
19662 Lines starting with a # character are comments, and are ignored, and # may
19663 also appear following a comma, in which case everything between the # and the
19664 next newline character is ignored.
19665
19666 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19667 double quotes are retained because some forms of mail address require their use
19668 (but never to enclose the entire address). In the following description,
19669 &"item"& refers to what remains after any surrounding double quotes have been
19670 removed.
19671
19672 .vindex "&$local_part$&"
19673 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19674 and the expansion contains a reference to &$local_part$&, you should make use
19675 of the &%quote_local_part%& expansion operator, in case the local part contains
19676 special characters. For example, to redirect all mail for the domain
19677 &'obsolete.example'&, retaining the existing local part, you could use this
19678 setting:
19679 .code
19680 data = ${quote_local_part:$local_part}@newdomain.example
19681 .endd
19682
19683
19684 .section "Redirecting to a local mailbox" "SECTredlocmai"
19685 .cindex "routing" "loops in"
19686 .cindex "loop" "while routing, avoidance of"
19687 .cindex "address redirection" "to local mailbox"
19688 A redirection item may safely be the same as the address currently under
19689 consideration. This does not cause a routing loop, because a router is
19690 automatically skipped if any ancestor of the address that is being processed
19691 is the same as the current address and was processed by the current router.
19692 Such an address is therefore passed to the following routers, so it is handled
19693 as if there were no redirection. When making this loop-avoidance test, the
19694 complete local part, including any prefix or suffix, is used.
19695
19696 .cindex "address redirection" "local part without domain"
19697 Specifying the same local part without a domain is a common usage in personal
19698 filter files when the user wants to have messages delivered to the local
19699 mailbox and also forwarded elsewhere. For example, the user whose login is
19700 &'cleo'& might have a &_.forward_& file containing this:
19701 .code
19702 cleo, cleopatra@egypt.example
19703 .endd
19704 .cindex "backslash in alias file"
19705 .cindex "alias file" "backslash in"
19706 For compatibility with other MTAs, such unqualified local parts may be
19707 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19708 it does make a difference if more than one domain is being handled
19709 synonymously.
19710
19711 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19712 2822 address that does not include a domain, the item is qualified using the
19713 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19714 addresses are qualified using the value in &%qualify_recipient%&, but you can
19715 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19716
19717 Care must be taken if there are alias names for local users.
19718 Consider an MTA handling a single local domain where the system alias file
19719 contains:
19720 .code
19721 Sam.Reman: spqr
19722 .endd
19723 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19724 messages in the local mailbox, and also forward copies elsewhere. He creates
19725 this forward file:
19726 .code
19727 Sam.Reman, spqr@reme.elsewhere.example
19728 .endd
19729 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19730 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19731 second time round, because it has previously routed it,
19732 and the following routers presumably cannot handle the alias. The forward file
19733 should really contain
19734 .code
19735 spqr, spqr@reme.elsewhere.example
19736 .endd
19737 but because this is such a common error, the &%check_ancestor%& option (see
19738 below) exists to provide a way to get round it. This is normally set on a
19739 &(redirect)& router that is handling users' &_.forward_& files.
19740
19741
19742
19743 .section "Special items in redirection lists" "SECTspecitredli"
19744 In addition to addresses, the following types of item may appear in redirection
19745 lists (that is, in non-filter redirection data):
19746
19747 .ilist
19748 .cindex "pipe" "in redirection list"
19749 .cindex "address redirection" "to pipe"
19750 An item is treated as a pipe command if it begins with &"|"& and does not parse
19751 as a valid RFC 2822 address that includes a domain. A transport for running the
19752 command must be specified by the &%pipe_transport%& option.
19753 Normally, either the router or the transport specifies a user and a group under
19754 which to run the delivery. The default is to use the Exim user and group.
19755
19756 Single or double quotes can be used for enclosing the individual arguments of
19757 the pipe command; no interpretation of escapes is done for single quotes. If
19758 the command contains a comma character, it is necessary to put the whole item
19759 in double quotes, for example:
19760 .code
19761 "|/some/command ready,steady,go"
19762 .endd
19763 since items in redirection lists are terminated by commas. Do not, however,
19764 quote just the command. An item such as
19765 .code
19766 |"/some/command ready,steady,go"
19767 .endd
19768 is interpreted as a pipe with a rather strange command name, and no arguments.
19769
19770 Note that the above example assumes that the text comes from a lookup source
19771 of some sort, so that the quotes are part of the data.  If composing a
19772 redirect router with a &%data%& option directly specifying this command, the
19773 quotes will be used by the configuration parser to define the extent of one
19774 string, but will not be passed down into the redirect router itself.  There
19775 are two main approaches to get around this: escape quotes to be part of the
19776 data itself, or avoid using this mechanism and instead create a custom
19777 transport with the &%command%& option set and reference that transport from
19778 an &%accept%& router.
19779
19780 .next
19781 .cindex "file" "in redirection list"
19782 .cindex "address redirection" "to file"
19783 An item is interpreted as a path name if it begins with &"/"& and does not
19784 parse as a valid RFC 2822 address that includes a domain. For example,
19785 .code
19786 /home/world/minbari
19787 .endd
19788 is treated as a file name, but
19789 .code
19790 /s=molari/o=babylon/@x400gate.way
19791 .endd
19792 is treated as an address. For a file name, a transport must be specified using
19793 the &%file_transport%& option. However, if the generated path name ends with a
19794 forward slash character, it is interpreted as a directory name rather than a
19795 file name, and &%directory_transport%& is used instead.
19796
19797 Normally, either the router or the transport specifies a user and a group under
19798 which to run the delivery. The default is to use the Exim user and group.
19799
19800 .cindex "&_/dev/null_&"
19801 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19802 bypassed at a high level, and the log entry shows &"**bypassed**"&
19803 instead of a transport name. In this case the user and group are not used.
19804
19805 .next
19806 .cindex "included address list"
19807 .cindex "address redirection" "included external list"
19808 If an item is of the form
19809 .code
19810 :include:<path name>
19811 .endd
19812 a list of further items is taken from the given file and included at that
19813 point. &*Note*&: Such a file can not be a filter file; it is just an
19814 out-of-line addition to the list. The items in the included list are separated
19815 by commas or newlines and are not subject to expansion. If this is the first
19816 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19817 the alias name. This example is incorrect:
19818 .code
19819 list1    :include:/opt/lists/list1
19820 .endd
19821 It must be given as
19822 .code
19823 list1:   :include:/opt/lists/list1
19824 .endd
19825 .next
19826 .cindex "address redirection" "to black hole"
19827 Sometimes you want to throw away mail to a particular local part. Making the
19828 &%data%& option expand to an empty string does not work, because that causes
19829 the router to decline. Instead, the alias item
19830 .cindex "black hole"
19831 .cindex "abandoning mail"
19832 &':blackhole:'& can be used. It does what its name implies. No delivery is
19833 done, and no error message is generated. This has the same effect as specifying
19834 &_/dev/null_& as a destination, but it can be independently disabled.
19835
19836 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19837 delivery is done for the original local part, even if other redirection items
19838 are present. If you are generating a multi-item list (for example, by reading a
19839 database) and need the ability to provide a no-op item, you must use
19840 &_/dev/null_&.
19841
19842 .next
19843 .cindex "delivery" "forcing failure"
19844 .cindex "delivery" "forcing deferral"
19845 .cindex "failing delivery" "forcing"
19846 .cindex "deferred delivery, forcing"
19847 .cindex "customizing" "failure message"
19848 An attempt to deliver a particular address can be deferred or forced to fail by
19849 redirection items of the form
19850 .code
19851 :defer:
19852 :fail:
19853 .endd
19854 respectively. When a redirection list contains such an item, it applies
19855 to the entire redirection; any other items in the list are ignored. Any
19856 text following &':fail:'& or &':defer:'& is placed in the error text
19857 associated with the failure. For example, an alias file might contain:
19858 .code
19859 X.Employee:  :fail: Gone away, no forwarding address
19860 .endd
19861 In the case of an address that is being verified from an ACL or as the subject
19862 of a
19863 .cindex "VRFY" "error text, display of"
19864 VRFY command, the text is included in the SMTP error response by
19865 default.
19866 .cindex "EXPN" "error text, display of"
19867 The text is not included in the response to an EXPN command. In non-SMTP cases
19868 the text is included in the error message that Exim generates.
19869
19870 .cindex "SMTP" "error codes"
19871 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19872 &':fail:'&. However, if the message starts with three digits followed by a
19873 space, optionally followed by an extended code of the form &'n.n.n'&, also
19874 followed by a space, and the very first digit is the same as the default error
19875 code, the code from the message is used instead. If the very first digit is
19876 incorrect, a panic error is logged, and the default code is used. You can
19877 suppress the use of the supplied code in a redirect router by setting the
19878 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19879 ignored.
19880
19881 .vindex "&$acl_verify_message$&"
19882 In an ACL, an explicitly provided message overrides the default, but the
19883 default message is available in the variable &$acl_verify_message$& and can
19884 therefore be included in a custom message if this is desired.
19885
19886 Normally the error text is the rest of the redirection list &-- a comma does
19887 not terminate it &-- but a newline does act as a terminator. Newlines are not
19888 normally present in alias expansions. In &(lsearch)& lookups they are removed
19889 as part of the continuation process, but they may exist in other kinds of
19890 lookup and in &':include:'& files.
19891
19892 During routing for message delivery (as opposed to verification), a redirection
19893 containing &':fail:'& causes an immediate failure of the incoming address,
19894 whereas &':defer:'& causes the message to remain on the queue so that a
19895 subsequent delivery attempt can happen at a later time. If an address is
19896 deferred for too long, it will ultimately fail, because the normal retry
19897 rules still apply.
19898
19899 .next
19900 .cindex "alias file" "exception to default"
19901 Sometimes it is useful to use a single-key search type with a default (see
19902 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19903 for exceptions to the default. These can be handled by aliasing them to
19904 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19905 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19906 results in an empty redirection list has the same effect.
19907 .endlist
19908
19909
19910 .section "Duplicate addresses" "SECTdupaddr"
19911 .cindex "duplicate addresses"
19912 .cindex "address duplicate, discarding"
19913 .cindex "pipe" "duplicated"
19914 Exim removes duplicate addresses from the list to which it is delivering, so as
19915 to deliver just one copy to each address. This does not apply to deliveries
19916 routed to pipes by different immediate parent addresses, but an indirect
19917 aliasing scheme of the type
19918 .code
19919 pipe:       |/some/command $local_part
19920 localpart1: pipe
19921 localpart2: pipe
19922 .endd
19923 does not work with a message that is addressed to both local parts, because
19924 when the second is aliased to the intermediate local part &"pipe"& it gets
19925 discarded as being the same as a previously handled address. However, a scheme
19926 such as
19927 .code
19928 localpart1: |/some/command $local_part
19929 localpart2: |/some/command $local_part
19930 .endd
19931 does result in two different pipe deliveries, because the immediate parents of
19932 the pipes are distinct.
19933
19934
19935
19936 .section "Repeated redirection expansion" "SECID128"
19937 .cindex "repeated redirection expansion"
19938 .cindex "address redirection" "repeated for each delivery attempt"
19939 When a message cannot be delivered to all of its recipients immediately,
19940 leading to two or more delivery attempts, redirection expansion is carried out
19941 afresh each time for those addresses whose children were not all previously
19942 delivered. If redirection is being used as a mailing list, this can lead to new
19943 members of the list receiving copies of old messages. The &%one_time%& option
19944 can be used to avoid this.
19945
19946
19947 .section "Errors in redirection lists" "SECID129"
19948 .cindex "address redirection" "errors"
19949 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19950 error is skipped, and an entry is written to the main log. This may be useful
19951 for mailing lists that are automatically managed. Otherwise, if an error is
19952 detected while generating the list of new addresses, the original address is
19953 deferred. See also &%syntax_errors_to%&.
19954
19955
19956
19957 .section "Private options for the redirect router" "SECID130"
19958
19959 .cindex "options" "&(redirect)& router"
19960 The private options for the &(redirect)& router are as follows:
19961
19962
19963 .option allow_defer redirect boolean false
19964 Setting this option allows the use of &':defer:'& in non-filter redirection
19965 data, or the &%defer%& command in an Exim filter file.
19966
19967
19968 .option allow_fail redirect boolean false
19969 .cindex "failing delivery" "from filter"
19970 If this option is true, the &':fail:'& item can be used in a redirection list,
19971 and the &%fail%& command may be used in an Exim filter file.
19972
19973
19974 .option allow_filter redirect boolean false
19975 .cindex "filter" "enabling use of"
19976 .cindex "Sieve filter" "enabling use of"
19977 Setting this option allows Exim to interpret redirection data that starts with
19978 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19979 are some features of Exim filter files that some administrators may wish to
19980 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19981
19982 It is also possible to lock out Exim filters or Sieve filters while allowing
19983 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19984
19985
19986 The filter is run using the uid and gid set by the generic &%user%& and
19987 &%group%& options. These take their defaults from the password data if
19988 &%check_local_user%& is set, so in the normal case of users' personal filter
19989 files, the filter is run as the relevant user. When &%allow_filter%& is set
19990 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19991
19992
19993
19994 .option allow_freeze redirect boolean false
19995 .cindex "freezing messages" "allowing in filter"
19996 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19997 This command is more normally encountered in system filters, and is disabled by
19998 default for redirection filters because it isn't something you usually want to
19999 let ordinary users do.
20000
20001
20002
20003 .option check_ancestor redirect boolean false
20004 This option is concerned with handling generated addresses that are the same
20005 as some address in the list of redirection ancestors of the current address.
20006 Although it is turned off by default in the code, it is set in the default
20007 configuration file for handling users' &_.forward_& files. It is recommended
20008 for this use of the &(redirect)& router.
20009
20010 When &%check_ancestor%& is set, if a generated address (including the domain)
20011 is the same as any ancestor of the current address, it is replaced by a copy of
20012 the current address. This helps in the case where local part A is aliased to B,
20013 and B has a &_.forward_& file pointing back to A. For example, within a single
20014 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20015 &_&~jb/.forward_& contains:
20016 .code
20017 \Joe.Bloggs, <other item(s)>
20018 .endd
20019 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20020 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20021 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20022 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20023 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20024 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20025 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20026 original address. See also the &%repeat_use%& option below.
20027
20028
20029 .option check_group redirect boolean "see below"
20030 When the &%file%& option is used, the group owner of the file is checked only
20031 when this option is set. The permitted groups are those listed in the
20032 &%owngroups%& option, together with the user's default group if
20033 &%check_local_user%& is set. If the file has the wrong group, routing is
20034 deferred. The default setting for this option is true if &%check_local_user%&
20035 is set and the &%modemask%& option permits the group write bit, or if the
20036 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20037
20038
20039
20040 .option check_owner redirect boolean "see below"
20041 When the &%file%& option is used, the owner of the file is checked only when
20042 this option is set. If &%check_local_user%& is set, the local user is
20043 permitted; otherwise the owner must be one of those listed in the &%owners%&
20044 option. The default value for this option is true if &%check_local_user%& or
20045 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20046
20047
20048 .option data redirect string&!! unset
20049 This option is mutually exclusive with &%file%&. One or other of them must be
20050 set, but not both. The contents of &%data%& are expanded, and then used as the
20051 list of forwarding items, or as a set of filtering instructions. If the
20052 expansion is forced to fail, or the result is an empty string or a string that
20053 has no effect (consists entirely of comments), the router declines.
20054
20055 When filtering instructions are used, the string must begin with &"#Exim
20056 filter"&, and all comments in the string, including this initial one, must be
20057 terminated with newline characters. For example:
20058 .code
20059 data = #Exim filter\n\
20060        if $h_to: contains Exim then save $home/mail/exim endif
20061 .endd
20062 If you are reading the data from a database where newlines cannot be included,
20063 you can use the &${sg}$& expansion item to turn the escape string of your
20064 choice into a newline.
20065
20066
20067 .option directory_transport redirect string&!! unset
20068 A &(redirect)& router sets up a direct delivery to a directory when a path name
20069 ending with a slash is specified as a new &"address"&. The transport used is
20070 specified by this option, which, after expansion, must be the name of a
20071 configured transport. This should normally be an &(appendfile)& transport.
20072
20073
20074 .option file redirect string&!! unset
20075 This option specifies the name of a file that contains the redirection data. It
20076 is mutually exclusive with the &%data%& option. The string is expanded before
20077 use; if the expansion is forced to fail, the router declines. Other expansion
20078 failures cause delivery to be deferred. The result of a successful expansion
20079 must be an absolute path. The entire file is read and used as the redirection
20080 data. If the data is an empty string or a string that has no effect (consists
20081 entirely of comments), the router declines.
20082
20083 .cindex "NFS" "checking for file existence"
20084 If the attempt to open the file fails with a &"does not exist"& error, Exim
20085 runs a check on the containing directory,
20086 unless &%ignore_enotdir%& is true (see below).
20087 If the directory does not appear to exist, delivery is deferred. This can
20088 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20089 is a mount problem. If the containing directory does exist, but the file does
20090 not, the router declines.
20091
20092
20093 .option file_transport redirect string&!! unset
20094 .vindex "&$address_file$&"
20095 A &(redirect)& router sets up a direct delivery to a file when a path name not
20096 ending in a slash is specified as a new &"address"&. The transport used is
20097 specified by this option, which, after expansion, must be the name of a
20098 configured transport. This should normally be an &(appendfile)& transport. When
20099 it is running, the file name is in &$address_file$&.
20100
20101
20102 .option filter_prepend_home redirect boolean true
20103 When this option is true, if a &(save)& command in an Exim filter specifies a
20104 relative path, and &$home$& is defined, it is automatically prepended to the
20105 relative path. If this option is set false, this action does not happen. The
20106 relative path is then passed to the transport unmodified.
20107
20108
20109 .option forbid_blackhole redirect boolean false
20110 If this option is true, the &':blackhole:'& item may not appear in a
20111 redirection list.
20112
20113
20114 .option forbid_exim_filter redirect boolean false
20115 If this option is set true, only Sieve filters are permitted when
20116 &%allow_filter%& is true.
20117
20118
20119
20120
20121 .option forbid_file redirect boolean false
20122 .cindex "delivery" "to file; forbidding"
20123 .cindex "Sieve filter" "forbidding delivery to a file"
20124 .cindex "Sieve filter" "&""keep""& facility; disabling"
20125 If this option is true, this router may not generate a new address that
20126 specifies delivery to a local file or directory, either from a filter or from a
20127 conventional forward file. This option is forced to be true if &%one_time%& is
20128 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20129 locks out the Sieve's &"keep"& facility.
20130
20131
20132 .option forbid_filter_dlfunc redirect boolean false
20133 .cindex "filter" "locking out certain features"
20134 If this option is true, string expansions in Exim filters are not allowed to
20135 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20136 functions.
20137
20138 .option forbid_filter_existstest redirect boolean false
20139 .cindex "expansion" "statting a file"
20140 If this option is true, string expansions in Exim filters are not allowed to
20141 make use of the &%exists%& condition or the &%stat%& expansion item.
20142
20143 .option forbid_filter_logwrite redirect boolean false
20144 If this option is true, use of the logging facility in Exim filters is not
20145 permitted. Logging is in any case available only if the filter is being run
20146 under some unprivileged uid (which is normally the case for ordinary users'
20147 &_.forward_& files).
20148
20149
20150 .option forbid_filter_lookup redirect boolean false
20151 If this option is true, string expansions in Exim filter files are not allowed
20152 to make use of &%lookup%& items.
20153
20154
20155 .option forbid_filter_perl redirect boolean false
20156 This option has an effect only if Exim is built with embedded Perl support. If
20157 it is true, string expansions in Exim filter files are not allowed to make use
20158 of the embedded Perl support.
20159
20160
20161 .option forbid_filter_readfile redirect boolean false
20162 If this option is true, string expansions in Exim filter files are not allowed
20163 to make use of &%readfile%& items.
20164
20165
20166 .option forbid_filter_readsocket redirect boolean false
20167 If this option is true, string expansions in Exim filter files are not allowed
20168 to make use of &%readsocket%& items.
20169
20170
20171 .option forbid_filter_reply redirect boolean false
20172 If this option is true, this router may not generate an automatic reply
20173 message. Automatic replies can be generated only from Exim or Sieve filter
20174 files, not from traditional forward files. This option is forced to be true if
20175 &%one_time%& is set.
20176
20177
20178 .option forbid_filter_run redirect boolean false
20179 If this option is true, string expansions in Exim filter files are not allowed
20180 to make use of &%run%& items.
20181
20182
20183 .option forbid_include redirect boolean false
20184 If this option is true, items of the form
20185 .code
20186 :include:<path name>
20187 .endd
20188 are not permitted in non-filter redirection lists.
20189
20190
20191 .option forbid_pipe redirect boolean false
20192 .cindex "delivery" "to pipe; forbidding"
20193 If this option is true, this router may not generate a new address which
20194 specifies delivery to a pipe, either from an Exim filter or from a conventional
20195 forward file. This option is forced to be true if &%one_time%& is set.
20196
20197
20198 .option forbid_sieve_filter redirect boolean false
20199 If this option is set true, only Exim filters are permitted when
20200 &%allow_filter%& is true.
20201
20202
20203 .cindex "SMTP" "error codes"
20204 .option forbid_smtp_code redirect boolean false
20205 If this option is set true, any SMTP error codes that are present at the start
20206 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20207 the default codes (451 and 550, respectively) are always used.
20208
20209
20210
20211
20212 .option hide_child_in_errmsg redirect boolean false
20213 .cindex "bounce message" "redirection details; suppressing"
20214 If this option is true, it prevents Exim from quoting a child address if it
20215 generates a bounce or delay message for it. Instead it says &"an address
20216 generated from <&'the top level address'&>"&. Of course, this applies only to
20217 bounces generated locally. If a message is forwarded to another host, &'its'&
20218 bounce may well quote the generated address.
20219
20220
20221 .option ignore_eacces redirect boolean false
20222 .cindex "EACCES"
20223 If this option is set and an attempt to open a redirection file yields the
20224 EACCES error (permission denied), the &(redirect)& router behaves as if the
20225 file did not exist.
20226
20227
20228 .option ignore_enotdir redirect boolean false
20229 .cindex "ENOTDIR"
20230 If this option is set and an attempt to open a redirection file yields the
20231 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20232 router behaves as if the file did not exist.
20233
20234 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20235 router that has the &%file%& option set discovers that the file does not exist
20236 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20237 against unmounted NFS directories. If the parent can not be statted, delivery
20238 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20239 is set, because that option tells Exim to ignore &"something on the path is not
20240 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20241 that some operating systems give ENOENT where others give ENOTDIR.
20242
20243
20244
20245 .option include_directory redirect string unset
20246 If this option is set, the path names of any &':include:'& items in a
20247 redirection list must start with this directory.
20248
20249
20250 .option modemask redirect "octal integer" 022
20251 This specifies mode bits which must not be set for a file specified by the
20252 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20253
20254
20255 .option one_time redirect boolean false
20256 .cindex "one-time aliasing/forwarding expansion"
20257 .cindex "alias file" "one-time expansion"
20258 .cindex "forward file" "one-time expansion"
20259 .cindex "mailing lists" "one-time expansion"
20260 .cindex "address redirection" "one-time expansion"
20261 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20262 files each time it tries to deliver a message causes a problem when one or more
20263 of the generated addresses fails be delivered at the first attempt. The problem
20264 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20265 but of what happens when the redirection list changes during the time that the
20266 message is on Exim's queue. This is particularly true in the case of mailing
20267 lists, where new subscribers might receive copies of messages that were posted
20268 before they subscribed.
20269
20270 If &%one_time%& is set and any addresses generated by the router fail to
20271 deliver at the first attempt, the failing addresses are added to the message as
20272 &"top level"& addresses, and the parent address that generated them is marked
20273 &"delivered"&. Thus, redirection does not happen again at the next delivery
20274 attempt.
20275
20276 &*Warning 1*&: Any header line addition or removal that is specified by this
20277 router would be lost if delivery did not succeed at the first attempt. For this
20278 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20279 permitted when &%one_time%& is set.
20280
20281 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20282 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20283 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20284
20285 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20286 &%one_time%&.
20287
20288 The original top-level address is remembered with each of the generated
20289 addresses, and is output in any log messages. However, any intermediate parent
20290 addresses are not recorded. This makes a difference to the log only if
20291 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20292 typically be used for mailing lists, where there is normally just one level of
20293 expansion.
20294
20295
20296 .option owners redirect "string list" unset
20297 .cindex "ownership" "alias file"
20298 .cindex "ownership" "forward file"
20299 .cindex "alias file" "ownership"
20300 .cindex "forward file" "ownership"
20301 This specifies a list of permitted owners for the file specified by &%file%&.
20302 This list is in addition to the local user when &%check_local_user%& is set.
20303 See &%check_owner%& above.
20304
20305
20306 .option owngroups redirect "string list" unset
20307 This specifies a list of permitted groups for the file specified by &%file%&.
20308 The list is in addition to the local user's primary group when
20309 &%check_local_user%& is set. See &%check_group%& above.
20310
20311
20312 .option pipe_transport redirect string&!! unset
20313 .vindex "&$address_pipe$&"
20314 A &(redirect)& router sets up a direct delivery to a pipe when a string
20315 starting with a vertical bar character is specified as a new &"address"&. The
20316 transport used is specified by this option, which, after expansion, must be the
20317 name of a configured transport. This should normally be a &(pipe)& transport.
20318 When the transport is run, the pipe command is in &$address_pipe$&.
20319
20320
20321 .option qualify_domain redirect string&!! unset
20322 .vindex "&$qualify_recipient$&"
20323 If this option is set, and an unqualified address (one without a domain) is
20324 generated, and that address would normally be qualified by the global setting
20325 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20326 expanding this string. If the expansion fails, the router declines. If you want
20327 to revert to the default, you can have the expansion generate
20328 &$qualify_recipient$&.
20329
20330 This option applies to all unqualified addresses generated by Exim filters,
20331 but for traditional &_.forward_& files, it applies only to addresses that are
20332 not preceded by a backslash. Sieve filters cannot generate unqualified
20333 addresses.
20334
20335 .option qualify_preserve_domain redirect boolean false
20336 .cindex "domain" "in redirection; preserving"
20337 .cindex "preserving domain in redirection"
20338 .cindex "address redirection" "domain; preserving"
20339 If this option is set, the router's local &%qualify_domain%& option must not be
20340 set (a configuration error occurs if it is). If an unqualified address (one
20341 without a domain) is generated, it is qualified with the domain of the parent
20342 address (the immediately preceding ancestor) instead of the global
20343 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20344 this applies whether or not the address is preceded by a backslash.
20345
20346
20347 .option repeat_use redirect boolean true
20348 If this option is set false, the router is skipped for a child address that has
20349 any ancestor that was routed by this router. This test happens before any of
20350 the other preconditions are tested. Exim's default anti-looping rules skip
20351 only when the ancestor is the same as the current address. See also
20352 &%check_ancestor%& above and the generic &%redirect_router%& option.
20353
20354
20355 .option reply_transport redirect string&!! unset
20356 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20357 &%vacation%& command is used in a filter file. The transport used is specified
20358 by this option, which, after expansion, must be the name of a configured
20359 transport. This should normally be an &(autoreply)& transport. Other transports
20360 are unlikely to do anything sensible or useful.
20361
20362
20363 .option rewrite redirect boolean true
20364 .cindex "address redirection" "disabling rewriting"
20365 If this option is set false, addresses generated by the router are not
20366 subject to address rewriting. Otherwise, they are treated like new addresses
20367 and are rewritten according to the global rewriting rules.
20368
20369
20370 .option sieve_subaddress redirect string&!! unset
20371 The value of this option is passed to a Sieve filter to specify the
20372 :subaddress part of an address.
20373
20374 .option sieve_useraddress redirect string&!! unset
20375 The value of this option is passed to a Sieve filter to specify the :user part
20376 of an address. However, if it is unset, the entire original local part
20377 (including any prefix or suffix) is used for :user.
20378
20379
20380 .option sieve_vacation_directory redirect string&!! unset
20381 .cindex "Sieve filter" "vacation directory"
20382 To enable the &"vacation"& extension for Sieve filters, you must set
20383 &%sieve_vacation_directory%& to the directory where vacation databases are held
20384 (do not put anything else in that directory), and ensure that the
20385 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20386 needs their own directory; Exim will create it if necessary.
20387
20388
20389
20390 .option skip_syntax_errors redirect boolean false
20391 .cindex "forward file" "broken"
20392 .cindex "address redirection" "broken files"
20393 .cindex "alias file" "broken"
20394 .cindex "broken alias or forward files"
20395 .cindex "ignoring faulty addresses"
20396 .cindex "skipping faulty addresses"
20397 .cindex "error" "skipping bad syntax"
20398 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20399 non-filter redirection data are skipped, and each failing address is logged. If
20400 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20401 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20402 are expanded and placed at the head of the error message generated by
20403 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20404 be the same address as the generic &%errors_to%& option. The
20405 &%skip_syntax_errors%& option is often used when handling mailing lists.
20406
20407 If all the addresses in a redirection list are skipped because of syntax
20408 errors, the router declines to handle the original address, and it is passed to
20409 the following routers.
20410
20411 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20412 error in the filter causes filtering to be abandoned without any action being
20413 taken. The incident is logged, and the router declines to handle the address,
20414 so it is passed to the following routers.
20415
20416 .cindex "Sieve filter" "syntax errors in"
20417 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20418 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20419 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20420
20421 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20422 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20423 option, used with an address that does not get redirected, can be used to
20424 notify users of these errors, by means of a router like this:
20425 .code
20426 userforward:
20427   driver = redirect
20428   allow_filter
20429   check_local_user
20430   file = $home/.forward
20431   file_transport = address_file
20432   pipe_transport = address_pipe
20433   reply_transport = address_reply
20434   no_verify
20435   skip_syntax_errors
20436   syntax_errors_to = real-$local_part@$domain
20437   syntax_errors_text = \
20438    This is an automatically generated message. An error has\n\
20439    been found in your .forward file. Details of the error are\n\
20440    reported below. While this error persists, you will receive\n\
20441    a copy of this message for every message that is addressed\n\
20442    to you. If your .forward file is a filter file, or if it is\n\
20443    a non-filter file containing no valid forwarding addresses,\n\
20444    a copy of each incoming message will be put in your normal\n\
20445    mailbox. If a non-filter file contains at least one valid\n\
20446    forwarding address, forwarding to the valid addresses will\n\
20447    happen, and those will be the only deliveries that occur.
20448 .endd
20449 You also need a router to ensure that local addresses that are prefixed by
20450 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20451 put this immediately before the &(userforward)& router:
20452 .code
20453 real_localuser:
20454   driver = accept
20455   check_local_user
20456   local_part_prefix = real-
20457   transport = local_delivery
20458 .endd
20459 For security, it would probably be a good idea to restrict the use of this
20460 router to locally-generated messages, using a condition such as this:
20461 .code
20462   condition = ${if match {$sender_host_address}\
20463                          {\N^(|127\.0\.0\.1)$\N}}
20464 .endd
20465
20466
20467 .option syntax_errors_text redirect string&!! unset
20468 See &%skip_syntax_errors%& above.
20469
20470
20471 .option syntax_errors_to redirect string unset
20472 See &%skip_syntax_errors%& above.
20473 .ecindex IIDredrou1
20474 .ecindex IIDredrou2
20475
20476
20477
20478
20479
20480
20481 . ////////////////////////////////////////////////////////////////////////////
20482 . ////////////////////////////////////////////////////////////////////////////
20483
20484 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20485          "Environment for local transports"
20486 .scindex IIDenvlotra1 "local transports" "environment for"
20487 .scindex IIDenvlotra2 "environment for local transports"
20488 .scindex IIDenvlotra3 "transport" "local; environment for"
20489 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20490 transport can be thought of as similar to a pipe.) Exim always runs transports
20491 in subprocesses, under specified uids and gids. Typical deliveries to local
20492 mailboxes run under the uid and gid of the local user.
20493
20494 Exim also sets a specific current directory while running the transport; for
20495 some transports a home directory setting is also relevant. The &(pipe)&
20496 transport is the only one that sets up environment variables; see section
20497 &<<SECTpipeenv>>& for details.
20498
20499 The values used for the uid, gid, and the directories may come from several
20500 different places. In many cases, the router that handles the address associates
20501 settings with that address as a result of its &%check_local_user%&, &%group%&,
20502 or &%user%& options. However, values may also be given in the transport's own
20503 configuration, and these override anything that comes from the router.
20504
20505
20506
20507 .section "Concurrent deliveries" "SECID131"
20508 .cindex "concurrent deliveries"
20509 .cindex "simultaneous deliveries"
20510 If two different messages for the same local recipient arrive more or less
20511 simultaneously, the two delivery processes are likely to run concurrently. When
20512 the &(appendfile)& transport is used to write to a file, Exim applies locking
20513 rules to stop concurrent processes from writing to the same file at the same
20514 time.
20515
20516 However, when you use a &(pipe)& transport, it is up to you to arrange any
20517 locking that is needed. Here is a silly example:
20518 .code
20519 my_transport:
20520   driver = pipe
20521   command = /bin/sh -c 'cat >>/some/file'
20522 .endd
20523 This is supposed to write the message at the end of the file. However, if two
20524 messages arrive at the same time, the file will be scrambled. You can use the
20525 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20526 file using the same algorithm that Exim itself uses.
20527
20528
20529
20530
20531 .section "Uids and gids" "SECTenvuidgid"
20532 .cindex "local transports" "uid and gid"
20533 .cindex "transport" "local; uid and gid"
20534 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20535 overrides any group that the router set in the address, even if &%user%& is not
20536 set for the transport. This makes it possible, for example, to run local mail
20537 delivery under the uid of the recipient (set by the router), but in a special
20538 group (set by the transport). For example:
20539 .code
20540 # Routers ...
20541 # User/group are set by check_local_user in this router
20542 local_users:
20543   driver = accept
20544   check_local_user
20545   transport = group_delivery
20546
20547 # Transports ...
20548 # This transport overrides the group
20549 group_delivery:
20550   driver = appendfile
20551   file = /var/spool/mail/$local_part
20552   group = mail
20553 .endd
20554 If &%user%& is set for a transport, its value overrides what is set in the
20555 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20556 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20557 set.
20558
20559 .oindex "&%initgroups%&"
20560 When the uid is taken from the transport's configuration, the &[initgroups()]&
20561 function is called for the groups associated with that uid if the
20562 &%initgroups%& option is set for the transport. When the uid is not specified
20563 by the transport, but is associated with the address by a router, the option
20564 for calling &[initgroups()]& is taken from the router configuration.
20565
20566 .cindex "&(pipe)& transport" "uid for"
20567 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20568 is set and &%user%& is not set, the uid of the process that called Exim to
20569 receive the message is used, and if &%group%& is not set, the corresponding
20570 original gid is also used.
20571
20572 This is the detailed preference order for obtaining a gid; the first of the
20573 following that is set is used:
20574
20575 .ilist
20576 A &%group%& setting of the transport;
20577 .next
20578 A &%group%& setting of the router;
20579 .next
20580 A gid associated with a user setting of the router, either as a result of
20581 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20582 .next
20583 The group associated with a non-numeric &%user%& setting of the transport;
20584 .next
20585 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20586 the uid is the creator's uid;
20587 .next
20588 The Exim gid if the Exim uid is being used as a default.
20589 .endlist
20590
20591 If, for example, the user is specified numerically on the router and there are
20592 no group settings, no gid is available. In this situation, an error occurs.
20593 This is different for the uid, for which there always is an ultimate default.
20594 The first of the following that is set is used:
20595
20596 .ilist
20597 A &%user%& setting of the transport;
20598 .next
20599 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20600 .next
20601 A &%user%& setting of the router;
20602 .next
20603 A &%check_local_user%& setting of the router;
20604 .next
20605 The Exim uid.
20606 .endlist
20607
20608 Of course, an error will still occur if the uid that is chosen is on the
20609 &%never_users%& list.
20610
20611
20612
20613
20614
20615 .section "Current and home directories" "SECID132"
20616 .cindex "current directory for local transport"
20617 .cindex "home directory" "for local transport"
20618 .cindex "transport" "local; home directory for"
20619 .cindex "transport" "local; current directory for"
20620 Routers may set current and home directories for local transports by means of
20621 the &%transport_current_directory%& and &%transport_home_directory%& options.
20622 However, if the transport's &%current_directory%& or &%home_directory%& options
20623 are set, they override the router's values. In detail, the home directory
20624 for a local transport is taken from the first of these values that is set:
20625
20626 .ilist
20627 The &%home_directory%& option on the transport;
20628 .next
20629 The &%transport_home_directory%& option on the router;
20630 .next
20631 The password data if &%check_local_user%& is set on the router;
20632 .next
20633 The &%router_home_directory%& option on the router.
20634 .endlist
20635
20636 The current directory is taken from the first of these values that is set:
20637
20638 .ilist
20639 The &%current_directory%& option on the transport;
20640 .next
20641 The &%transport_current_directory%& option on the router.
20642 .endlist
20643
20644
20645 If neither the router nor the transport sets a current directory, Exim uses the
20646 value of the home directory, if it is set. Otherwise it sets the current
20647 directory to &_/_& before running a local transport.
20648
20649
20650
20651 .section "Expansion variables derived from the address" "SECID133"
20652 .vindex "&$domain$&"
20653 .vindex "&$local_part$&"
20654 .vindex "&$original_domain$&"
20655 Normally a local delivery is handling a single address, and in that case the
20656 variables such as &$domain$& and &$local_part$& are set during local
20657 deliveries. However, in some circumstances more than one address may be handled
20658 at once (for example, while writing batch SMTP for onward transmission by some
20659 other means). In this case, the variables associated with the local part are
20660 never set, &$domain$& is set only if all the addresses have the same domain,
20661 and &$original_domain$& is never set.
20662 .ecindex IIDenvlotra1
20663 .ecindex IIDenvlotra2
20664 .ecindex IIDenvlotra3
20665
20666
20667
20668
20669
20670
20671
20672 . ////////////////////////////////////////////////////////////////////////////
20673 . ////////////////////////////////////////////////////////////////////////////
20674
20675 .chapter "Generic options for transports" "CHAPtransportgeneric"
20676 .scindex IIDgenoptra1 "generic options" "transport"
20677 .scindex IIDgenoptra2 "options" "generic; for transports"
20678 .scindex IIDgenoptra3 "transport" "generic options for"
20679 The following generic options apply to all transports:
20680
20681
20682 .option body_only transports boolean false
20683 .cindex "transport" "body only"
20684 .cindex "message" "transporting body only"
20685 .cindex "body of message" "transporting"
20686 If this option is set, the message's headers are not transported. It is
20687 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20688 or &(pipe)& transports, the settings of &%message_prefix%& and
20689 &%message_suffix%& should be checked, because this option does not
20690 automatically suppress them.
20691
20692
20693 .option current_directory transports string&!! unset
20694 .cindex "transport" "current directory for"
20695 This specifies the current directory that is to be set while running the
20696 transport, overriding any value that may have been set by the router.
20697 If the expansion fails for any reason, including forced failure, an error is
20698 logged, and delivery is deferred.
20699
20700
20701 .option disable_logging transports boolean false
20702 If this option is set true, nothing is logged for any
20703 deliveries by the transport or for any
20704 transport errors. You should not set this option unless you really, really know
20705 what you are doing.
20706
20707
20708 .option debug_print transports string&!! unset
20709 .cindex "testing" "variables in drivers"
20710 If this option is set and debugging is enabled (see the &%-d%& command line
20711 option), the string is expanded and included in the debugging output when the
20712 transport is run.
20713 If expansion of the string fails, the error message is written to the debugging
20714 output, and Exim carries on processing.
20715 This facility is provided to help with checking out the values of variables and
20716 so on when debugging driver configurations. For example, if a &%headers_add%&
20717 option is not working properly, &%debug_print%& could be used to output the
20718 variables it references. A newline is added to the text if it does not end with
20719 one.
20720 The variables &$transport_name$& and &$router_name$& contain the name of the
20721 transport and the router that called it.
20722
20723 .option delivery_date_add transports boolean false
20724 .cindex "&'Delivery-date:'& header line"
20725 If this option is true, a &'Delivery-date:'& header is added to the message.
20726 This gives the actual time the delivery was made. As this is not a standard
20727 header, Exim has a configuration option (&%delivery_date_remove%&) which
20728 requests its removal from incoming messages, so that delivered messages can
20729 safely be resent to other recipients.
20730
20731
20732 .option driver transports string unset
20733 This specifies which of the available transport drivers is to be used.
20734 There is no default, and this option must be set for every transport.
20735
20736
20737 .option envelope_to_add transports boolean false
20738 .cindex "&'Envelope-to:'& header line"
20739 If this option is true, an &'Envelope-to:'& header is added to the message.
20740 This gives the original address(es) in the incoming envelope that caused this
20741 delivery to happen. More than one address may be present if the transport is
20742 configured to handle several addresses at once, or if more than one original
20743 address was redirected to the same final address. As this is not a standard
20744 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20745 its removal from incoming messages, so that delivered messages can safely be
20746 resent to other recipients.
20747
20748
20749 .option event_action transports string&!! unset
20750 .cindex events
20751 This option declares a string to be expanded for Exim's events mechanism.
20752 For details see &<<CHAPevents>>&.
20753 .wen
20754
20755
20756 .option group transports string&!! "Exim group"
20757 .cindex "transport" "group; specifying"
20758 This option specifies a gid for running the transport process, overriding any
20759 value that the router supplies, and also overriding any value associated with
20760 &%user%& (see below).
20761
20762
20763 .option headers_add transports list&!! unset
20764 .cindex "header lines" "adding in transport"
20765 .cindex "transport" "header lines; adding"
20766 This option specifies a list of text headers,
20767 newline-separated (by default, changeable in the usual way),
20768 which are (separately) expanded and added to the header
20769 portion of a message as it is transported, as described in section
20770 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20771 routers. If the result of the expansion is an empty string, or if the expansion
20772 is forced to fail, no action is taken. Other expansion failures are treated as
20773 errors and cause the delivery to be deferred.
20774
20775 Unlike most options, &%headers_add%& can be specified multiple times
20776 for a transport; all listed headers are added.
20777
20778
20779 .option headers_only transports boolean false
20780 .cindex "transport" "header lines only"
20781 .cindex "message" "transporting headers only"
20782 .cindex "header lines" "transporting"
20783 If this option is set, the message's body is not transported. It is mutually
20784 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20785 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20786 checked, since this option does not automatically suppress them.
20787
20788
20789 .option headers_remove transports list&!! unset
20790 .cindex "header lines" "removing"
20791 .cindex "transport" "header lines; removing"
20792 This option specifies a list of header names,
20793 colon-separated (by default, changeable in the usual way);
20794 these headers are omitted from the message as it is transported, as described
20795 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20796 routers.
20797 Each list item is separately expanded.
20798 If the result of the expansion is an empty string, or if the expansion
20799 is forced to fail, no action is taken. Other expansion failures are treated as
20800 errors and cause the delivery to be deferred.
20801
20802 Unlike most options, &%headers_remove%& can be specified multiple times
20803 for a router; all listed headers are removed.
20804
20805 &*Warning*&: Because of the separate expansion of the list items,
20806 items that contain a list separator must have it doubled.
20807 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20808
20809
20810
20811 .option headers_rewrite transports string unset
20812 .cindex "transport" "header lines; rewriting"
20813 .cindex "rewriting" "at transport time"
20814 This option allows addresses in header lines to be rewritten at transport time,
20815 that is, as the message is being copied to its destination. The contents of the
20816 option are a colon-separated list of rewriting rules. Each rule is in exactly
20817 the same form as one of the general rewriting rules that are applied when a
20818 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20819 example,
20820 .code
20821 headers_rewrite = a@b c@d f : \
20822                   x@y w@z
20823 .endd
20824 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20825 &'w@z'& in all address-bearing header lines. The rules are applied to the
20826 header lines just before they are written out at transport time, so they affect
20827 only those copies of the message that pass through the transport. However, only
20828 the message's original header lines, and any that were added by a system
20829 filter, are rewritten. If a router or transport adds header lines, they are not
20830 affected by this option. These rewriting rules are &'not'& applied to the
20831 envelope. You can change the return path using &%return_path%&, but you cannot
20832 change envelope recipients at this time.
20833
20834
20835 .option home_directory transports string&!! unset
20836 .cindex "transport" "home directory for"
20837 .vindex "&$home$&"
20838 This option specifies a home directory setting for a local transport,
20839 overriding any value that may be set by the router. The home directory is
20840 placed in &$home$& while expanding the transport's private options. It is also
20841 used as the current directory if no current directory is set by the
20842 &%current_directory%& option on the transport or the
20843 &%transport_current_directory%& option on the router. If the expansion fails
20844 for any reason, including forced failure, an error is logged, and delivery is
20845 deferred.
20846
20847
20848 .option initgroups transports boolean false
20849 .cindex "additional groups"
20850 .cindex "groups" "additional"
20851 .cindex "transport" "group; additional"
20852 If this option is true and the uid for the delivery process is provided by the
20853 transport, the &[initgroups()]& function is called when running the transport
20854 to ensure that any additional groups associated with the uid are set up.
20855
20856
20857 .new
20858 .option max_parallel transports integer&!! unset
20859 .cindex limit "transport parallelism"
20860 .cindex transport "parallel processes"
20861 .cindex transport "concurrency limit"
20862 .cindex "delivery" "parallelism for transport"
20863 If this option is set and expands to an integer greater than zero
20864 it limits the number of concurrent runs of the transport.
20865 The control does not apply to shadow transports.
20866
20867 .cindex "hints database" "transport concurrency control"
20868 Exim implements this control by means of a hints database in which a record is
20869 incremented whenever a transport process is beaing created. The record
20870 is decremented and possibly removed when the process terminates.
20871 Obviously there is scope for
20872 records to get left lying around if there is a system or program crash. To
20873 guard against this, Exim ignores any records that are more than six hours old.
20874
20875 If you use this option, you should also arrange to delete the
20876 relevant hints database whenever your system reboots. The names of the files
20877 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20878 may be one or two files, depending on the type of DBM in use. The same files
20879 are used for ETRN and smtp transport serialization.
20880 .wen
20881
20882
20883 .option message_size_limit transports string&!! 0
20884 .cindex "limit" "message size per transport"
20885 .cindex "size" "of message, limit"
20886 .cindex "transport" "message size; limiting"
20887 This option controls the size of messages passed through the transport. It is
20888 expanded before use; the result of the expansion must be a sequence of decimal
20889 digits, optionally followed by K or M. If the expansion fails for any reason,
20890 including forced failure, or if the result is not of the required form,
20891 delivery is deferred. If the value is greater than zero and the size of a
20892 message exceeds this limit, the address is failed. If there is any chance that
20893 the resulting bounce message could be routed to the same transport, you should
20894 ensure that &%return_size_limit%& is less than the transport's
20895 &%message_size_limit%&, as otherwise the bounce message will fail to get
20896 delivered.
20897
20898
20899
20900 .option rcpt_include_affixes transports boolean false
20901 .cindex "prefix" "for local part, including in envelope"
20902 .cindex "suffix for local part" "including in envelope"
20903 .cindex "local part" "prefix"
20904 .cindex "local part" "suffix"
20905 When this option is false (the default), and an address that has had any
20906 affixes (prefixes or suffixes) removed from the local part is delivered by any
20907 form of SMTP or LMTP, the affixes are not included. For example, if a router
20908 that contains
20909 .code
20910 local_part_prefix = *-
20911 .endd
20912 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20913 is delivered with
20914 .code
20915 RCPT TO:<xyz@some.domain>
20916 .endd
20917 This is also the case when an ACL-time callout is being used to verify a
20918 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20919 whole local part is included in the RCPT command. This option applies to BSMTP
20920 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20921 &(lmtp)& and &(smtp)& transports.
20922
20923
20924 .option retry_use_local_part transports boolean "see below"
20925 .cindex "hints database" "retry keys"
20926 When a delivery suffers a temporary failure, a retry record is created
20927 in Exim's hints database. For remote deliveries, the key for the retry record
20928 is based on the name and/or IP address of the failing remote host. For local
20929 deliveries, the key is normally the entire address, including both the local
20930 part and the domain. This is suitable for most common cases of local delivery
20931 temporary failure &-- for example, exceeding a mailbox quota should delay only
20932 deliveries to that mailbox, not to the whole domain.
20933
20934 However, in some special cases you may want to treat a temporary local delivery
20935 as a failure associated with the domain, and not with a particular local part.
20936 (For example, if you are storing all mail for some domain in files.) You can do
20937 this by setting &%retry_use_local_part%& false.
20938
20939 For all the local transports, its default value is true. For remote transports,
20940 the default value is false for tidiness, but changing the value has no effect
20941 on a remote transport in the current implementation.
20942
20943
20944 .option return_path transports string&!! unset
20945 .cindex "envelope sender"
20946 .cindex "transport" "return path; changing"
20947 .cindex "return path" "changing in transport"
20948 If this option is set, the string is expanded at transport time and replaces
20949 the existing return path (envelope sender) value in the copy of the message
20950 that is being delivered. An empty return path is permitted. This feature is
20951 designed for remote deliveries, where the value of this option is used in the
20952 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20953 only effect is to change the address that is placed in the &'Return-path:'&
20954 header line, if one is added to the message (see the next option).
20955
20956 &*Note:*& A changed return path is not logged unless you add
20957 &%return_path_on_delivery%& to the log selector.
20958
20959 .vindex "&$return_path$&"
20960 The expansion can refer to the existing value via &$return_path$&. This is
20961 either the message's envelope sender, or an address set by the
20962 &%errors_to%& option on a router. If the expansion is forced to fail, no
20963 replacement occurs; if it fails for another reason, delivery is deferred. This
20964 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20965 section &<<SECTverp>>&.
20966
20967 &*Note*&: If a delivery error is detected locally, including the case when a
20968 remote server rejects a message at SMTP time, the bounce message is not sent to
20969 the value of this option. It is sent to the previously set errors address.
20970 This defaults to the incoming sender address, but can be changed by setting
20971 &%errors_to%& in a router.
20972
20973
20974
20975 .option return_path_add transports boolean false
20976 .cindex "&'Return-path:'& header line"
20977 If this option is true, a &'Return-path:'& header is added to the message.
20978 Although the return path is normally available in the prefix line of BSD
20979 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20980 have easy access to it.
20981
20982 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20983 the delivery SMTP server makes the final delivery"&. This implies that this
20984 header should not be present in incoming messages. Exim has a configuration
20985 option, &%return_path_remove%&, which requests removal of this header from
20986 incoming messages, so that delivered messages can safely be resent to other
20987 recipients.
20988
20989
20990 .option shadow_condition transports string&!! unset
20991 See &%shadow_transport%& below.
20992
20993
20994 .option shadow_transport transports string unset
20995 .cindex "shadow transport"
20996 .cindex "transport" "shadow"
20997 A local transport may set the &%shadow_transport%& option to the name of
20998 another local transport. Shadow remote transports are not supported.
20999
21000 Whenever a delivery to the main transport succeeds, and either
21001 &%shadow_condition%& is unset, or its expansion does not result in the empty
21002 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21003 passed to the shadow transport, with the same delivery address or addresses. If
21004 expansion fails, no action is taken except that non-forced expansion failures
21005 cause a log line to be written.
21006
21007 The result of the shadow transport is discarded and does not affect the
21008 subsequent processing of the message. Only a single level of shadowing is
21009 provided; the &%shadow_transport%& option is ignored on any transport when it
21010 is running as a shadow. Options concerned with output from pipes are also
21011 ignored. The log line for the successful delivery has an item added on the end,
21012 of the form
21013 .code
21014 ST=<shadow transport name>
21015 .endd
21016 If the shadow transport did not succeed, the error message is put in
21017 parentheses afterwards. Shadow transports can be used for a number of different
21018 purposes, including keeping more detailed log information than Exim normally
21019 provides, and implementing automatic acknowledgment policies based on message
21020 headers that some sites insist on.
21021
21022
21023 .option transport_filter transports string&!! unset
21024 .cindex "transport" "filter"
21025 .cindex "filter" "transport filter"
21026 This option sets up a filtering (in the Unix shell sense) process for messages
21027 at transport time. It should not be confused with mail filtering as set up by
21028 individual users or via a system filter.
21029 .new
21030 If unset, or expanding to an empty string, no filtering is done.
21031 .wen
21032
21033 When the message is about to be written out, the command specified by
21034 &%transport_filter%& is started up in a separate, parallel process, and
21035 the entire message, including the header lines, is passed to it on its standard
21036 input (this in fact is done from a third process, to avoid deadlock). The
21037 command must be specified as an absolute path.
21038
21039 The lines of the message that are written to the transport filter are
21040 terminated by newline (&"\n"&). The message is passed to the filter before any
21041 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21042 lines beginning with a dot, and also before any processing implied by the
21043 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21044 &(pipe)& transports.
21045
21046 The standard error for the filter process is set to the same destination as its
21047 standard output; this is read and written to the message's ultimate
21048 destination. The process that writes the message to the filter, the
21049 filter itself, and the original process that reads the result and delivers it
21050 are all run in parallel, like a shell pipeline.
21051
21052 The filter can perform any transformations it likes, but of course should take
21053 care not to break RFC 2822 syntax. Exim does not check the result, except to
21054 test for a final newline when SMTP is in use. All messages transmitted over
21055 SMTP must end with a newline, so Exim supplies one if it is missing.
21056
21057 .cindex "content scanning" "per user"
21058 A transport filter can be used to provide content-scanning on a per-user basis
21059 at delivery time if the only required effect of the scan is to modify the
21060 message. For example, a content scan could insert a new header line containing
21061 a spam score. This could be interpreted by a filter in the user's MUA. It is
21062 not possible to discard a message at this stage.
21063
21064 .cindex "SMTP" "SIZE"
21065 A problem might arise if the filter increases the size of a message that is
21066 being sent down an SMTP connection. If the receiving SMTP server has indicated
21067 support for the SIZE parameter, Exim will have sent the size of the message
21068 at the start of the SMTP session. If what is actually sent is substantially
21069 more, the server might reject the message. This can be worked round by setting
21070 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21071 additions to the message, or to disable the use of SIZE altogether.
21072
21073 .vindex "&$pipe_addresses$&"
21074 The value of the &%transport_filter%& option is the command string for starting
21075 the filter, which is run directly from Exim, not under a shell. The string is
21076 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21077 Exim breaks it up into arguments and then expands each argument separately (see
21078 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21079 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21080 of arguments, one for each address that applies to this delivery. (This isn't
21081 an ideal name for this feature here, but as it was already implemented for the
21082 &(pipe)& transport, it seemed sensible not to change it.)
21083
21084 .vindex "&$host$&"
21085 .vindex "&$host_address$&"
21086 The expansion variables &$host$& and &$host_address$& are available when the
21087 transport is a remote one. They contain the name and IP address of the host to
21088 which the message is being sent. For example:
21089 .code
21090 transport_filter = /some/directory/transport-filter.pl \
21091   $host $host_address $sender_address $pipe_addresses
21092 .endd
21093
21094 Two problems arise if you want to use more complicated expansion items to
21095 generate transport filter commands, both of which due to the fact that the
21096 command is split up &'before'& expansion.
21097 .ilist
21098 If an expansion item contains white space, you must quote it, so that it is all
21099 part of the same command item. If the entire option setting is one such
21100 expansion item, you have to take care what kind of quoting you use. For
21101 example:
21102 .code
21103 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21104 .endd
21105 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21106 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21107 stripped by Exim when it read the option's value. When the value is used, if
21108 the single quotes were missing, the line would be split into two items,
21109 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21110 Exim tried to expand the first one.
21111 .next
21112 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21113 expansion cannot generate multiple arguments, or a command name followed by
21114 arguments. Consider this example:
21115 .code
21116 transport_filter = ${lookup{$host}lsearch{/a/file}\
21117                     {$value}{/bin/cat}}
21118 .endd
21119 The result of the lookup is interpreted as the name of the command, even
21120 if it contains white space. The simplest way round this is to use a shell:
21121 .code
21122 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21123                                {$value}{/bin/cat}}
21124 .endd
21125 .endlist
21126
21127 The filter process is run under the same uid and gid as the normal delivery.
21128 For remote deliveries this is the Exim uid/gid by default. The command should
21129 normally yield a zero return code. Transport filters are not supposed to fail.
21130 A non-zero code is taken to mean that the transport filter encountered some
21131 serious problem. Delivery of the message is deferred; the message remains on
21132 the queue and is tried again later. It is not possible to cause a message to be
21133 bounced from a transport filter.
21134
21135 If a transport filter is set on an autoreply transport, the original message is
21136 passed through the filter as it is being copied into the newly generated
21137 message, which happens if the &%return_message%& option is set.
21138
21139
21140 .option transport_filter_timeout transports time 5m
21141 .cindex "transport" "filter, timeout"
21142 When Exim is reading the output of a transport filter, it applies a timeout
21143 that can be set by this option. Exceeding the timeout is normally treated as a
21144 temporary delivery failure. However, if a transport filter is used with a
21145 &(pipe)& transport, a timeout in the transport filter is treated in the same
21146 way as a timeout in the pipe command itself. By default, a timeout is a hard
21147 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21148 becomes a temporary error.
21149
21150
21151 .option user transports string&!! "Exim user"
21152 .cindex "uid (user id)" "local delivery"
21153 .cindex "transport" "user, specifying"
21154 This option specifies the user under whose uid the delivery process is to be
21155 run, overriding any uid that may have been set by the router. If the user is
21156 given as a name, the uid is looked up from the password data, and the
21157 associated group is taken as the value of the gid to be used if the &%group%&
21158 option is not set.
21159
21160 For deliveries that use local transports, a user and group are normally
21161 specified explicitly or implicitly (for example, as a result of
21162 &%check_local_user%&) by the router or transport.
21163
21164 .cindex "hints database" "access by remote transport"
21165 For remote transports, you should leave this option unset unless you really are
21166 sure you know what you are doing. When a remote transport is running, it needs
21167 to be able to access Exim's hints databases, because each host may have its own
21168 retry data.
21169 .ecindex IIDgenoptra1
21170 .ecindex IIDgenoptra2
21171 .ecindex IIDgenoptra3
21172
21173
21174
21175
21176
21177
21178 . ////////////////////////////////////////////////////////////////////////////
21179 . ////////////////////////////////////////////////////////////////////////////
21180
21181 .chapter "Address batching in local transports" "CHAPbatching" &&&
21182          "Address batching"
21183 .cindex "transport" "local; address batching in"
21184 The only remote transport (&(smtp)&) is normally configured to handle more than
21185 one address at a time, so that when several addresses are routed to the same
21186 remote host, just one copy of the message is sent. Local transports, however,
21187 normally handle one address at a time. That is, a separate instance of the
21188 transport is run for each address that is routed to the transport. A separate
21189 copy of the message is delivered each time.
21190
21191 .cindex "batched local delivery"
21192 .oindex "&%batch_max%&"
21193 .oindex "&%batch_id%&"
21194 In special cases, it may be desirable to handle several addresses at once in a
21195 local transport, for example:
21196
21197 .ilist
21198 In an &(appendfile)& transport, when storing messages in files for later
21199 delivery by some other means, a single copy of the message with multiple
21200 recipients saves space.
21201 .next
21202 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21203 a single copy saves time, and is the normal way LMTP is expected to work.
21204 .next
21205 In a &(pipe)& transport, when passing the message
21206 to a scanner program or
21207 to some other delivery mechanism such as UUCP, multiple recipients may be
21208 acceptable.
21209 .endlist
21210
21211 These three local transports all have the same options for controlling multiple
21212 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21213 repeating the information for each transport, these options are described here.
21214
21215 The &%batch_max%& option specifies the maximum number of addresses that can be
21216 delivered together in a single run of the transport. Its default value is one
21217 (no batching). When more than one address is routed to a transport that has a
21218 &%batch_max%& value greater than one, the addresses are delivered in a batch
21219 (that is, in a single run of the transport with multiple recipients), subject
21220 to certain conditions:
21221
21222 .ilist
21223 .vindex "&$local_part$&"
21224 If any of the transport's options contain a reference to &$local_part$&, no
21225 batching is possible.
21226 .next
21227 .vindex "&$domain$&"
21228 If any of the transport's options contain a reference to &$domain$&, only
21229 addresses with the same domain are batched.
21230 .next
21231 .cindex "customizing" "batching condition"
21232 If &%batch_id%& is set, it is expanded for each address, and only those
21233 addresses with the same expanded value are batched. This allows you to specify
21234 customized batching conditions. Failure of the expansion for any reason,
21235 including forced failure, disables batching, but it does not stop the delivery
21236 from taking place.
21237 .next
21238 Batched addresses must also have the same errors address (where to send
21239 delivery errors), the same header additions and removals, the same user and
21240 group for the transport, and if a host list is present, the first host must
21241 be the same.
21242 .endlist
21243
21244 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21245 both when the file or pipe command is specified in the transport, and when it
21246 is specified by a &(redirect)& router, but all the batched addresses must of
21247 course be routed to the same file or pipe command. These two transports have an
21248 option called &%use_bsmtp%&, which causes them to deliver the message in
21249 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21250 &%check_string%& and &%escape_string%& options are forced to the values
21251 .code
21252 check_string = "."
21253 escape_string = ".."
21254 .endd
21255 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21256 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21257 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21258
21259 .cindex "&'Envelope-to:'& header line"
21260 If the generic &%envelope_to_add%& option is set for a batching transport, the
21261 &'Envelope-to:'& header that is added to the message contains all the addresses
21262 that are being processed together. If you are using a batching &(appendfile)&
21263 transport without &%use_bsmtp%&, the only way to preserve the recipient
21264 addresses is to set the &%envelope_to_add%& option.
21265
21266 .cindex "&(pipe)& transport" "with multiple addresses"
21267 .vindex "&$pipe_addresses$&"
21268 If you are using a &(pipe)& transport without BSMTP, and setting the
21269 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21270 the command. This is not a true variable; it is a bit of magic that causes each
21271 of the recipient addresses to be inserted into the command as a separate
21272 argument. This provides a way of accessing all the addresses that are being
21273 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21274 are specified by a &(redirect)& router.
21275
21276
21277
21278
21279 . ////////////////////////////////////////////////////////////////////////////
21280 . ////////////////////////////////////////////////////////////////////////////
21281
21282 .chapter "The appendfile transport" "CHAPappendfile"
21283 .scindex IIDapptra1 "&(appendfile)& transport"
21284 .scindex IIDapptra2 "transports" "&(appendfile)&"
21285 .cindex "directory creation"
21286 .cindex "creating directories"
21287 The &(appendfile)& transport delivers a message by appending it to an existing
21288 file, or by creating an entirely new file in a specified directory. Single
21289 files to which messages are appended can be in the traditional Unix mailbox
21290 format, or optionally in the MBX format supported by the Pine MUA and
21291 University of Washington IMAP daemon, &'inter alia'&. When each message is
21292 being delivered as a separate file, &"maildir"& format can optionally be used
21293 to give added protection against failures that happen part-way through the
21294 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21295 supported. For all file formats, Exim attempts to create as many levels of
21296 directory as necessary, provided that &%create_directory%& is set.
21297
21298 The code for the optional formats is not included in the Exim binary by
21299 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21300 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21301 included.
21302
21303 .cindex "quota" "system"
21304 Exim recognizes system quota errors, and generates an appropriate message. Exim
21305 also supports its own quota control within the transport, for use when the
21306 system facility is unavailable or cannot be used for some reason.
21307
21308 If there is an error while appending to a file (for example, quota exceeded or
21309 partition filled), Exim attempts to reset the file's length and last
21310 modification time back to what they were before. If there is an error while
21311 creating an entirely new file, the new file is removed.
21312
21313 Before appending to a file, a number of security checks are made, and the
21314 file is locked. A detailed description is given below, after the list of
21315 private options.
21316
21317 The &(appendfile)& transport is most commonly used for local deliveries to
21318 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21319 putting messages into files for remote delivery by some means other than Exim.
21320 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21321 option).
21322
21323
21324
21325 .section "The file and directory options" "SECTfildiropt"
21326 The &%file%& option specifies a single file, to which the message is appended;
21327 the &%directory%& option specifies a directory, in which a new file containing
21328 the message is created. Only one of these two options can be set, and for
21329 normal deliveries to mailboxes, one of them &'must'& be set.
21330
21331 .vindex "&$address_file$&"
21332 .vindex "&$local_part$&"
21333 However, &(appendfile)& is also used for delivering messages to files or
21334 directories whose names (or parts of names) are obtained from alias,
21335 forwarding, or filtering operations (for example, a &%save%& command in a
21336 user's Exim filter). When such a transport is running, &$local_part$& contains
21337 the local part that was aliased or forwarded, and &$address_file$& contains the
21338 name (or partial name) of the file or directory generated by the redirection
21339 operation. There are two cases:
21340
21341 .ilist
21342 If neither &%file%& nor &%directory%& is set, the redirection operation
21343 must specify an absolute path (one that begins with &`/`&). This is the most
21344 common case when users with local accounts use filtering to sort mail into
21345 different folders. See for example, the &(address_file)& transport in the
21346 default configuration. If the path ends with a slash, it is assumed to be the
21347 name of a directory. A delivery to a directory can also be forced by setting
21348 &%maildir_format%& or &%mailstore_format%&.
21349 .next
21350 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21351 used to determine the file or directory name for the delivery. Normally, the
21352 contents of &$address_file$& are used in some way in the string expansion.
21353 .endlist
21354
21355
21356 .cindex "Sieve filter" "configuring &(appendfile)&"
21357 .cindex "Sieve filter" "relative mailbox path handling"
21358 As an example of the second case, consider an environment where users do not
21359 have home directories. They may be permitted to use Exim filter commands of the
21360 form:
21361 .code
21362 save folder23
21363 .endd
21364 or Sieve filter commands of the form:
21365 .code
21366 require "fileinto";
21367 fileinto "folder23";
21368 .endd
21369 In this situation, the expansion of &%file%& or &%directory%& in the transport
21370 must transform the relative path into an appropriate absolute file name. In the
21371 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21372 is used as a result of a &"keep"& action in the filter. This example shows one
21373 way of handling this requirement:
21374 .code
21375 file = ${if eq{$address_file}{inbox} \
21376             {/var/mail/$local_part} \
21377             {${if eq{${substr_0_1:$address_file}}{/} \
21378                   {$address_file} \
21379                   {$home/mail/$address_file} \
21380             }} \
21381        }
21382 .endd
21383 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21384 location, absolute paths are used without change, and other folders are in the
21385 &_mail_& directory within the home directory.
21386
21387 &*Note 1*&: While processing an Exim filter, a relative path such as
21388 &_folder23_& is turned into an absolute path if a home directory is known to
21389 the router. In particular, this is the case if &%check_local_user%& is set. If
21390 you want to prevent this happening at routing time, you can set
21391 &%router_home_directory%& empty. This forces the router to pass the relative
21392 path to the transport.
21393
21394 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21395 the &%file%& or &%directory%& option is still used if it is set.
21396
21397
21398
21399
21400 .section "Private options for appendfile" "SECID134"
21401 .cindex "options" "&(appendfile)& transport"
21402
21403
21404
21405 .option allow_fifo appendfile boolean false
21406 .cindex "fifo (named pipe)"
21407 .cindex "named pipe (fifo)"
21408 .cindex "pipe" "named (fifo)"
21409 Setting this option permits delivery to named pipes (FIFOs) as well as to
21410 regular files. If no process is reading the named pipe at delivery time, the
21411 delivery is deferred.
21412
21413
21414 .option allow_symlink appendfile boolean false
21415 .cindex "symbolic link" "to mailbox"
21416 .cindex "mailbox" "symbolic link"
21417 By default, &(appendfile)& will not deliver if the path name for the file is
21418 that of a symbolic link. Setting this option relaxes that constraint, but there
21419 are security issues involved in the use of symbolic links. Be sure you know
21420 what you are doing if you set this. Details of exactly what this option affects
21421 are included in the discussion which follows this list of options.
21422
21423
21424 .option batch_id appendfile string&!! unset
21425 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21426 However, batching is automatically disabled for &(appendfile)& deliveries that
21427 happen as a result of forwarding or aliasing or other redirection directly to a
21428 file.
21429
21430
21431 .option batch_max appendfile integer 1
21432 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21433
21434
21435 .option check_group appendfile boolean false
21436 When this option is set, the group owner of the file defined by the &%file%&
21437 option is checked to see that it is the same as the group under which the
21438 delivery process is running. The default setting is false because the default
21439 file mode is 0600, which means that the group is irrelevant.
21440
21441
21442 .option check_owner appendfile boolean true
21443 When this option is set, the owner of the file defined by the &%file%& option
21444 is checked to ensure that it is the same as the user under which the delivery
21445 process is running.
21446
21447
21448 .option check_string appendfile string "see below"
21449 .cindex "&""From""& line"
21450 As &(appendfile)& writes the message, the start of each line is tested for
21451 matching &%check_string%&, and if it does, the initial matching characters are
21452 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21453 a literal string, not a regular expression, and the case of any letters it
21454 contains is significant.
21455
21456 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21457 are forced to &"."& and &".."& respectively, and any settings in the
21458 configuration are ignored. Otherwise, they default to &"From&~"& and
21459 &">From&~"& when the &%file%& option is set, and unset when any of the
21460 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21461
21462 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21463 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21464 &"From&~"& indicates the start of a new message. All four options need changing
21465 if another format is used. For example, to deliver to mailboxes in MMDF format:
21466 .cindex "MMDF format mailbox"
21467 .cindex "mailbox" "MMDF format"
21468 .code
21469 check_string = "\1\1\1\1\n"
21470 escape_string = "\1\1\1\1 \n"
21471 message_prefix = "\1\1\1\1\n"
21472 message_suffix = "\1\1\1\1\n"
21473 .endd
21474 .option create_directory appendfile boolean true
21475 .cindex "directory creation"
21476 When this option is true, Exim attempts to create any missing superior
21477 directories for the file that it is about to write. A created directory's mode
21478 is given by the &%directory_mode%& option.
21479
21480 The group ownership of a newly created directory is highly dependent on the
21481 operating system (and possibly the file system) that is being used. For
21482 example, in Solaris, if the parent directory has the setgid bit set, its group
21483 is propagated to the child; if not, the currently set group is used. However,
21484 in FreeBSD, the parent's group is always used.
21485
21486
21487
21488 .option create_file appendfile string anywhere
21489 This option constrains the location of files and directories that are created
21490 by this transport. It applies to files defined by the &%file%& option and
21491 directories defined by the &%directory%& option. In the case of maildir
21492 delivery, it applies to the top level directory, not the maildir directories
21493 beneath.
21494
21495 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21496 &"belowhome"&. In the second and third cases, a home directory must have been
21497 set for the transport. This option is not useful when an explicit file name is
21498 given for normal mailbox deliveries. It is intended for the case when file
21499 names are generated from users' &_.forward_& files. These are usually handled
21500 by an &(appendfile)& transport called &%address_file%&. See also
21501 &%file_must_exist%&.
21502
21503
21504 .option directory appendfile string&!! unset
21505 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21506 or &%directory%& must be set, unless the delivery is the direct result of a
21507 redirection (see section &<<SECTfildiropt>>&).
21508
21509 When &%directory%& is set, the string is expanded, and the message is delivered
21510 into a new file or files in or below the given directory, instead of being
21511 appended to a single mailbox file. A number of different formats are provided
21512 (see &%maildir_format%& and &%mailstore_format%&), and see section
21513 &<<SECTopdir>>& for further details of this form of delivery.
21514
21515
21516 .option directory_file appendfile string&!! "see below"
21517 .cindex "base62"
21518 .vindex "&$inode$&"
21519 When &%directory%& is set, but neither &%maildir_format%& nor
21520 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21521 whose name is obtained by expanding this string. The default value is:
21522 .code
21523 q${base62:$tod_epoch}-$inode
21524 .endd
21525 This generates a unique name from the current time, in base 62 form, and the
21526 inode of the file. The variable &$inode$& is available only when expanding this
21527 option.
21528
21529
21530 .option directory_mode appendfile "octal integer" 0700
21531 If &(appendfile)& creates any directories as a result of the
21532 &%create_directory%& option, their mode is specified by this option.
21533
21534
21535 .option escape_string appendfile string "see description"
21536 See &%check_string%& above.
21537
21538
21539 .option file appendfile string&!! unset
21540 This option is mutually exclusive with the &%directory%& option, but one of
21541 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21542 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21543 specifies a single file, to which the message is appended. One or more of
21544 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21545 &%file%&.
21546
21547 .cindex "NFS" "lock file"
21548 .cindex "locking files"
21549 .cindex "lock files"
21550 If you are using more than one host to deliver over NFS into the same
21551 mailboxes, you should always use lock files.
21552
21553 The string value is expanded for each delivery, and must yield an absolute
21554 path. The most common settings of this option are variations on one of these
21555 examples:
21556 .code
21557 file = /var/spool/mail/$local_part
21558 file = /home/$local_part/inbox
21559 file = $home/inbox
21560 .endd
21561 .cindex "&""sticky""& bit"
21562 In the first example, all deliveries are done into the same directory. If Exim
21563 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21564 create a file in the directory, so the &"sticky"& bit must be turned on for
21565 deliveries to be possible, or alternatively the &%group%& option can be used to
21566 run the delivery under a group id which has write access to the directory.
21567
21568
21569
21570 .option file_format appendfile string unset
21571 .cindex "file" "mailbox; checking existing format"
21572 This option requests the transport to check the format of an existing file
21573 before adding to it. The check consists of matching a specific string at the
21574 start of the file. The value of the option consists of an even number of
21575 colon-separated strings. The first of each pair is the test string, and the
21576 second is the name of a transport. If the transport associated with a matched
21577 string is not the current transport, control is passed over to the other
21578 transport. For example, suppose the standard &(local_delivery)& transport has
21579 this added to it:
21580 .code
21581 file_format = "From       : local_delivery :\
21582                \1\1\1\1\n : local_mmdf_delivery"
21583 .endd
21584 Mailboxes that begin with &"From"& are still handled by this transport, but if
21585 a mailbox begins with four binary ones followed by a newline, control is passed
21586 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21587 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21588 is assumed to match the current transport. If the start of a mailbox doesn't
21589 match any string, or if the transport named for a given string is not defined,
21590 delivery is deferred.
21591
21592
21593 .option file_must_exist appendfile boolean false
21594 If this option is true, the file specified by the &%file%& option must exist.
21595 A temporary error occurs if it does not, causing delivery to be deferred.
21596 If this option is false, the file is created if it does not exist.
21597
21598
21599 .option lock_fcntl_timeout appendfile time 0s
21600 .cindex "timeout" "mailbox locking"
21601 .cindex "mailbox" "locking, blocking and non-blocking"
21602 .cindex "locking files"
21603 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21604 when locking an open mailbox file. If the call fails, the delivery process
21605 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21606 Non-blocking calls are used so that the file is not kept open during the wait
21607 for the lock; the reason for this is to make it as safe as possible for
21608 deliveries over NFS in the case when processes might be accessing an NFS
21609 mailbox without using a lock file. This should not be done, but
21610 misunderstandings and hence misconfigurations are not unknown.
21611
21612 On a busy system, however, the performance of a non-blocking lock approach is
21613 not as good as using a blocking lock with a timeout. In this case, the waiting
21614 is done inside the system call, and Exim's delivery process acquires the lock
21615 and can proceed as soon as the previous lock holder releases it.
21616
21617 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21618 timeout, are used. There may still be some retrying: the maximum number of
21619 retries is
21620 .code
21621 (lock_retries * lock_interval) / lock_fcntl_timeout
21622 .endd
21623 rounded up to the next whole number. In other words, the total time during
21624 which &(appendfile)& is trying to get a lock is roughly the same, unless
21625 &%lock_fcntl_timeout%& is set very large.
21626
21627 You should consider setting this option if you are getting a lot of delayed
21628 local deliveries because of errors of the form
21629 .code
21630 failed to lock mailbox /some/file (fcntl)
21631 .endd
21632
21633 .option lock_flock_timeout appendfile time 0s
21634 This timeout applies to file locking when using &[flock()]& (see
21635 &%use_flock%&); the timeout operates in a similar manner to
21636 &%lock_fcntl_timeout%&.
21637
21638
21639 .option lock_interval appendfile time 3s
21640 This specifies the time to wait between attempts to lock the file. See below
21641 for details of locking.
21642
21643
21644 .option lock_retries appendfile integer 10
21645 This specifies the maximum number of attempts to lock the file. A value of zero
21646 is treated as 1. See below for details of locking.
21647
21648
21649 .option lockfile_mode appendfile "octal integer" 0600
21650 This specifies the mode of the created lock file, when a lock file is being
21651 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21652
21653
21654 .option lockfile_timeout appendfile time 30m
21655 .cindex "timeout" "mailbox locking"
21656 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21657 exists and is older than this value, it is assumed to have been left behind by
21658 accident, and Exim attempts to remove it.
21659
21660
21661 .option mailbox_filecount appendfile string&!! unset
21662 .cindex "mailbox" "specifying size of"
21663 .cindex "size" "of mailbox"
21664 If this option is set, it is expanded, and the result is taken as the current
21665 number of files in the mailbox. It must be a decimal number, optionally
21666 followed by K or M. This provides a way of obtaining this information from an
21667 external source that maintains the data.
21668
21669
21670 .option mailbox_size appendfile string&!! unset
21671 .cindex "mailbox" "specifying size of"
21672 .cindex "size" "of mailbox"
21673 If this option is set, it is expanded, and the result is taken as the current
21674 size the mailbox. It must be a decimal number, optionally followed by K or M.
21675 This provides a way of obtaining this information from an external source that
21676 maintains the data. This is likely to be helpful for maildir deliveries where
21677 it is computationally expensive to compute the size of a mailbox.
21678
21679
21680
21681 .option maildir_format appendfile boolean false
21682 .cindex "maildir format" "specifying"
21683 If this option is set with the &%directory%& option, the delivery is into a new
21684 file, in the &"maildir"& format that is used by other mail software. When the
21685 transport is activated directly from a &(redirect)& router (for example, the
21686 &(address_file)& transport in the default configuration), setting
21687 &%maildir_format%& causes the path received from the router to be treated as a
21688 directory, whether or not it ends with &`/`&. This option is available only if
21689 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21690 &<<SECTmaildirdelivery>>& below for further details.
21691
21692
21693 .option maildir_quota_directory_regex appendfile string "See below"
21694 .cindex "maildir format" "quota; directories included in"
21695 .cindex "quota" "maildir; directories included in"
21696 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21697 a regular expression for specifying directories, relative to the quota
21698 directory (see &%quota_directory%&), that should be included in the quota
21699 calculation. The default value is:
21700 .code
21701 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21702 .endd
21703 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21704 (directories whose names begin with a dot). If you want to exclude the
21705 &_Trash_&
21706 folder from the count (as some sites do), you need to change this setting to
21707 .code
21708 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21709 .endd
21710 This uses a negative lookahead in the regular expression to exclude the
21711 directory whose name is &_.Trash_&. When a directory is excluded from quota
21712 calculations, quota processing is bypassed for any messages that are delivered
21713 directly into that directory.
21714
21715
21716 .option maildir_retries appendfile integer 10
21717 This option specifies the number of times to retry when writing a file in
21718 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21719
21720
21721 .option maildir_tag appendfile string&!! unset
21722 This option applies only to deliveries in maildir format, and is described in
21723 section &<<SECTmaildirdelivery>>& below.
21724
21725
21726 .option maildir_use_size_file appendfile&!! boolean false
21727 .cindex "maildir format" "&_maildirsize_& file"
21728 The result of string expansion for this option must be a valid boolean value.
21729 If it is true, it enables support for &_maildirsize_& files. Exim
21730 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21731 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21732 value is zero. See &%maildir_quota_directory_regex%& above and section
21733 &<<SECTmaildirdelivery>>& below for further details.
21734
21735 .option maildirfolder_create_regex appendfile string unset
21736 .cindex "maildir format" "&_maildirfolder_& file"
21737 .cindex "&_maildirfolder_&, creating"
21738 The value of this option is a regular expression. If it is unset, it has no
21739 effect. Otherwise, before a maildir delivery takes place, the pattern is
21740 matched against the name of the maildir directory, that is, the directory
21741 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21742 delivery. If there is a match, Exim checks for the existence of a file called
21743 &_maildirfolder_& in the directory, and creates it if it does not exist.
21744 See section &<<SECTmaildirdelivery>>& for more details.
21745
21746
21747 .option mailstore_format appendfile boolean false
21748 .cindex "mailstore format" "specifying"
21749 If this option is set with the &%directory%& option, the delivery is into two
21750 new files in  &"mailstore"& format. The option is available only if
21751 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21752 below for further details.
21753
21754
21755 .option mailstore_prefix appendfile string&!! unset
21756 This option applies only to deliveries in mailstore format, and is described in
21757 section &<<SECTopdir>>& below.
21758
21759
21760 .option mailstore_suffix appendfile string&!! unset
21761 This option applies only to deliveries in mailstore format, and is described in
21762 section &<<SECTopdir>>& below.
21763
21764
21765 .option mbx_format appendfile boolean false
21766 .cindex "locking files"
21767 .cindex "file" "locking"
21768 .cindex "file" "MBX format"
21769 .cindex "MBX format, specifying"
21770 This option is available only if Exim has been compiled with SUPPORT_MBX
21771 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21772 the message is appended to the mailbox file in MBX format instead of
21773 traditional Unix format. This format is supported by Pine4 and its associated
21774 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21775
21776 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21777 automatically changed by the use of &%mbx_format%&. They should normally be set
21778 empty when using MBX format, so this option almost always appears in this
21779 combination:
21780 .code
21781 mbx_format = true
21782 message_prefix =
21783 message_suffix =
21784 .endd
21785 If none of the locking options are mentioned in the configuration,
21786 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21787 is possible to specify the other kinds of locking with &%mbx_format%&, but
21788 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21789 interworks with &'c-client'&, providing for shared access to the mailbox. It
21790 should not be used if any program that does not use this form of locking is
21791 going to access the mailbox, nor should it be used if the mailbox file is NFS
21792 mounted, because it works only when the mailbox is accessed from a single host.
21793
21794 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21795 the standard version of &'c-client'&, because as long as it has a mailbox open
21796 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21797 append messages to it.
21798
21799
21800 .option message_prefix appendfile string&!! "see below"
21801 .cindex "&""From""& line"
21802 The string specified here is expanded and output at the start of every message.
21803 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21804 in which case it is:
21805 .code
21806 message_prefix = "From ${if def:return_path{$return_path}\
21807   {MAILER-DAEMON}} $tod_bsdinbox\n"
21808 .endd
21809 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21810 &`\n`& to &`\r\n`& in &%message_prefix%&.
21811
21812 .option message_suffix appendfile string&!! "see below"
21813 The string specified here is expanded and output at the end of every message.
21814 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21815 in which case it is a single newline character. The suffix can be suppressed by
21816 setting
21817 .code
21818 message_suffix =
21819 .endd
21820 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21821 &`\n`& to &`\r\n`& in &%message_suffix%&.
21822
21823 .option mode appendfile "octal integer" 0600
21824 If the output file is created, it is given this mode. If it already exists and
21825 has wider permissions, they are reduced to this mode. If it has narrower
21826 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21827 if the delivery is the result of a &%save%& command in a filter file specifying
21828 a particular mode, the mode of the output file is always forced to take that
21829 value, and this option is ignored.
21830
21831
21832 .option mode_fail_narrower appendfile boolean true
21833 This option applies in the case when an existing mailbox file has a narrower
21834 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21835 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21836 continues with the delivery attempt, using the existing mode of the file.
21837
21838
21839 .option notify_comsat appendfile boolean false
21840 If this option is true, the &'comsat'& daemon is notified after every
21841 successful delivery to a user mailbox. This is the daemon that notifies logged
21842 on users about incoming mail.
21843
21844
21845 .option quota appendfile string&!! unset
21846 .cindex "quota" "imposed by Exim"
21847 This option imposes a limit on the size of the file to which Exim is appending,
21848 or to the total space used in the directory tree when the &%directory%& option
21849 is set. In the latter case, computation of the space used is expensive, because
21850 all the files in the directory (and any sub-directories) have to be
21851 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21852 &%maildir_use_size_file%& for ways to avoid this in environments where users
21853 have no shell access to their mailboxes).
21854
21855 As there is no interlock against two simultaneous deliveries into a
21856 multi-file mailbox, it is possible for the quota to be overrun in this case.
21857 For single-file mailboxes, of course, an interlock is a necessity.
21858
21859 A file's size is taken as its &'used'& value. Because of blocking effects, this
21860 may be a lot less than the actual amount of disk space allocated to the file.
21861 If the sizes of a number of files are being added up, the rounding effect can
21862 become quite noticeable, especially on systems that have large block sizes.
21863 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21864 the obvious value which users understand most easily.
21865
21866 The value of the option is expanded, and must then be a numerical value
21867 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21868 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21869 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21870 be handled.
21871
21872 &*Note*&: A value of zero is interpreted as &"no quota"&.
21873
21874 The expansion happens while Exim is running as root, before it changes uid for
21875 the delivery. This means that files that are inaccessible to the end user can
21876 be used to hold quota values that are looked up in the expansion. When delivery
21877 fails because this quota is exceeded, the handling of the error is as for
21878 system quota failures.
21879
21880 By default, Exim's quota checking mimics system quotas, and restricts the
21881 mailbox to the specified maximum size, though the value is not accurate to the
21882 last byte, owing to separator lines and additional headers that may get added
21883 during message delivery. When a mailbox is nearly full, large messages may get
21884 refused even though small ones are accepted, because the size of the current
21885 message is added to the quota when the check is made. This behaviour can be
21886 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21887 for exceeding the quota does not include the current message. Thus, deliveries
21888 continue until the quota has been exceeded; thereafter, no further messages are
21889 delivered. See also &%quota_warn_threshold%&.
21890
21891
21892 .option quota_directory appendfile string&!! unset
21893 This option defines the directory to check for quota purposes when delivering
21894 into individual files. The default is the delivery directory, or, if a file
21895 called &_maildirfolder_& exists in a maildir directory, the parent of the
21896 delivery directory.
21897
21898
21899 .option quota_filecount appendfile string&!! 0
21900 This option applies when the &%directory%& option is set. It limits the total
21901 number of files in the directory (compare the inode limit in system quotas). It
21902 can only be used if &%quota%& is also set. The value is expanded; an expansion
21903 failure causes delivery to be deferred. A value of zero is interpreted as
21904 &"no quota"&.
21905
21906
21907 .option quota_is_inclusive appendfile boolean true
21908 See &%quota%& above.
21909
21910
21911 .option quota_size_regex appendfile string unset
21912 This option applies when one of the delivery modes that writes a separate file
21913 for each message is being used. When Exim wants to find the size of one of
21914 these files in order to test the quota, it first checks &%quota_size_regex%&.
21915 If this is set to a regular expression that matches the file name, and it
21916 captures one string, that string is interpreted as a representation of the
21917 file's size. The value of &%quota_size_regex%& is not expanded.
21918
21919 This feature is useful only when users have no shell access to their mailboxes
21920 &-- otherwise they could defeat the quota simply by renaming the files. This
21921 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21922 the file length to the file name. For example:
21923 .code
21924 maildir_tag = ,S=$message_size
21925 quota_size_regex = ,S=(\d+)
21926 .endd
21927 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21928 number of lines in the message.
21929
21930 The regular expression should not assume that the length is at the end of the
21931 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21932 sometimes add other information onto the ends of message file names.
21933
21934 Section &<<SECID136>>& contains further information.
21935
21936
21937 .option quota_warn_message appendfile string&!! "see below"
21938 See below for the use of this option. If it is not set when
21939 &%quota_warn_threshold%& is set, it defaults to
21940 .code
21941 quota_warn_message = "\
21942   To: $local_part@$domain\n\
21943   Subject: Your mailbox\n\n\
21944   This message is automatically created \
21945   by mail delivery software.\n\n\
21946   The size of your mailbox has exceeded \
21947   a warning threshold that is\n\
21948   set by the system administrator.\n"
21949 .endd
21950
21951
21952 .option quota_warn_threshold appendfile string&!! 0
21953 .cindex "quota" "warning threshold"
21954 .cindex "mailbox" "size warning"
21955 .cindex "size" "of mailbox"
21956 This option is expanded in the same way as &%quota%& (see above). If the
21957 resulting value is greater than zero, and delivery of the message causes the
21958 size of the file or total space in the directory tree to cross the given
21959 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21960 may be specified as a percentage of it by following the value with a percent
21961 sign. For example:
21962 .code
21963 quota = 10M
21964 quota_warn_threshold = 75%
21965 .endd
21966 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21967 percent sign is ignored.
21968
21969 The warning message itself is specified by the &%quota_warn_message%& option,
21970 and it must start with a &'To:'& header line containing the recipient(s) of the
21971 warning message. These do not necessarily have to include the recipient(s) of
21972 the original message. A &'Subject:'& line should also normally be supplied. You
21973 can include any other header lines that you want. If you do not include a
21974 &'From:'& line, the default is:
21975 .code
21976 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21977 .endd
21978 .oindex &%errors_reply_to%&
21979 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21980 option.
21981
21982 The &%quota%& option does not have to be set in order to use this option; they
21983 are independent of one another except when the threshold is specified as a
21984 percentage.
21985
21986
21987 .option use_bsmtp appendfile boolean false
21988 .cindex "envelope sender"
21989 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21990 format, with the envelope sender and recipient(s) included as SMTP commands. If
21991 you want to include a leading HELO command with such messages, you can do
21992 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21993 for details of batch SMTP.
21994
21995
21996 .option use_crlf appendfile boolean false
21997 .cindex "carriage return"
21998 .cindex "linefeed"
21999 This option causes lines to be terminated with the two-character CRLF sequence
22000 (carriage return, linefeed) instead of just a linefeed character. In the case
22001 of batched SMTP, the byte sequence written to the file is then an exact image
22002 of what would be sent down a real SMTP connection.
22003
22004 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22005 (which are used to supply the traditional &"From&~"& and blank line separators
22006 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22007 carriage return characters if these are needed. In cases where these options
22008 have non-empty defaults, the values end with a single linefeed, so they must be
22009 changed to end with &`\r\n`& if &%use_crlf%& is set.
22010
22011
22012 .option use_fcntl_lock appendfile boolean "see below"
22013 This option controls the use of the &[fcntl()]& function to lock a file for
22014 exclusive use when a message is being appended. It is set by default unless
22015 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22016 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22017 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22018
22019
22020 .option use_flock_lock appendfile boolean false
22021 This option is provided to support the use of &[flock()]& for file locking, for
22022 the few situations where it is needed. Most modern operating systems support
22023 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22024 each other. Exim uses &[fcntl()]& locking by default.
22025
22026 This option is required only if you are using an operating system where
22027 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22028 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22029 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22030
22031 .cindex "Solaris" "&[flock()]& support"
22032 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22033 have it (and some, I think, provide a not quite right version built on top of
22034 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22035 the ability to use it, and any attempt to do so will cause a configuration
22036 error.
22037
22038 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22039 is just being mapped onto &[fcntl()]& by the OS).
22040
22041
22042 .option use_lockfile appendfile boolean "see below"
22043 If this option is turned off, Exim does not attempt to create a lock file when
22044 appending to a mailbox file. In this situation, the only locking is by
22045 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22046 sure that every MUA that is ever going to look at your users' mailboxes uses
22047 &[fcntl()]& rather than a lock file, and even then only when you are not
22048 delivering over NFS from more than one host.
22049
22050 .cindex "NFS" "lock file"
22051 In order to append to an NFS file safely from more than one host, it is
22052 necessary to take out a lock &'before'& opening the file, and the lock file
22053 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22054 file corruption.
22055
22056 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22057 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22058 except when &%mbx_format%& is set.
22059
22060
22061 .option use_mbx_lock appendfile boolean "see below"
22062 This option is available only if Exim has been compiled with SUPPORT_MBX
22063 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22064 locking rules be used. It is set by default if &%mbx_format%& is set and none
22065 of the locking options are mentioned in the configuration. The locking rules
22066 are the same as are used by the &'c-client'& library that underlies Pine and
22067 the IMAP4 and POP daemons that come with it (see the discussion below). The
22068 rules allow for shared access to the mailbox. However, this kind of locking
22069 does not work when the mailbox is NFS mounted.
22070
22071 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22072 &%use_flock_lock%& to control what kind of locking is used in implementing the
22073 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22074 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22075
22076
22077
22078
22079 .section "Operational details for appending" "SECTopappend"
22080 .cindex "appending to a file"
22081 .cindex "file" "appending"
22082 Before appending to a file, the following preparations are made:
22083
22084 .ilist
22085 If the name of the file is &_/dev/null_&, no action is taken, and a success
22086 return is given.
22087
22088 .next
22089 .cindex "directory creation"
22090 If any directories on the file's path are missing, Exim creates them if the
22091 &%create_directory%& option is set. A created directory's mode is given by the
22092 &%directory_mode%& option.
22093
22094 .next
22095 If &%file_format%& is set, the format of an existing file is checked. If this
22096 indicates that a different transport should be used, control is passed to that
22097 transport.
22098
22099 .next
22100 .cindex "file" "locking"
22101 .cindex "locking files"
22102 .cindex "NFS" "lock file"
22103 If &%use_lockfile%& is set, a lock file is built in a way that will work
22104 reliably over NFS, as follows:
22105
22106 .olist
22107 Create a &"hitching post"& file whose name is that of the lock file with the
22108 current time, primary host name, and process id added, by opening for writing
22109 as a new file. If this fails with an access error, delivery is deferred.
22110 .next
22111 Close the hitching post file, and hard link it to the lock file name.
22112 .next
22113 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22114 Unlink the hitching post name.
22115 .next
22116 Otherwise, use &[stat()]& to get information about the hitching post file, and
22117 then unlink hitching post name. If the number of links is exactly two, creation
22118 of the lock file succeeded but something (for example, an NFS server crash and
22119 restart) caused this fact not to be communicated to the &[link()]& call.
22120 .next
22121 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22122 up to &%lock_retries%& times. However, since any program that writes to a
22123 mailbox should complete its task very quickly, it is reasonable to time out old
22124 lock files that are normally the result of user agent and system crashes. If an
22125 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22126 it before trying again.
22127 .endlist olist
22128
22129 .next
22130 A call is made to &[lstat()]& to discover whether the main file exists, and if
22131 so, what its characteristics are. If &[lstat()]& fails for any reason other
22132 than non-existence, delivery is deferred.
22133
22134 .next
22135 .cindex "symbolic link" "to mailbox"
22136 .cindex "mailbox" "symbolic link"
22137 If the file does exist and is a symbolic link, delivery is deferred, unless the
22138 &%allow_symlink%& option is set, in which case the ownership of the link is
22139 checked, and then &[stat()]& is called to find out about the real file, which
22140 is then subjected to the checks below. The check on the top-level link
22141 ownership prevents one user creating a link for another's mailbox in a sticky
22142 directory, though allowing symbolic links in this case is definitely not a good
22143 idea. If there is a chain of symbolic links, the intermediate ones are not
22144 checked.
22145
22146 .next
22147 If the file already exists but is not a regular file, or if the file's owner
22148 and group (if the group is being checked &-- see &%check_group%& above) are
22149 different from the user and group under which the delivery is running,
22150 delivery is deferred.
22151
22152 .next
22153 If the file's permissions are more generous than specified, they are reduced.
22154 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22155 is set false, in which case the delivery is tried using the existing
22156 permissions.
22157
22158 .next
22159 The file's inode number is saved, and the file is then opened for appending.
22160 If this fails because the file has vanished, &(appendfile)& behaves as if it
22161 hadn't existed (see below). For any other failures, delivery is deferred.
22162
22163 .next
22164 If the file is opened successfully, check that the inode number hasn't
22165 changed, that it is still a regular file, and that the owner and permissions
22166 have not changed. If anything is wrong, defer delivery and freeze the message.
22167
22168 .next
22169 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22170 option is set. Otherwise, check that the file is being created in a permitted
22171 directory if the &%create_file%& option is set (deferring on failure), and then
22172 open for writing as a new file, with the O_EXCL and O_CREAT options,
22173 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22174 set). In this case, which can happen if the link points to a non-existent file,
22175 the file is opened for writing using O_CREAT but not O_EXCL, because
22176 that prevents link following.
22177
22178 .next
22179 .cindex "loop" "while file testing"
22180 If opening fails because the file exists, obey the tests given above for
22181 existing files. However, to avoid looping in a situation where the file is
22182 being continuously created and destroyed, the exists/not-exists loop is broken
22183 after 10 repetitions, and the message is then frozen.
22184
22185 .next
22186 If opening fails with any other error, defer delivery.
22187
22188 .next
22189 .cindex "file" "locking"
22190 .cindex "locking files"
22191 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22192 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22193 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22194 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22195 file, and an exclusive lock on the file whose name is
22196 .code
22197 /tmp/.<device-number>.<inode-number>
22198 .endd
22199 using the device and inode numbers of the open mailbox file, in accordance with
22200 the MBX locking rules. This file is created with a mode that is specified by
22201 the &%lockfile_mode%& option.
22202
22203 If Exim fails to lock the file, there are two possible courses of action,
22204 depending on the value of the locking timeout. This is obtained from
22205 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22206
22207 If the timeout value is zero, the file is closed, Exim waits for
22208 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22209 to lock it again. This happens up to &%lock_retries%& times, after which the
22210 delivery is deferred.
22211
22212 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22213 &[flock()]& are used (with the given timeout), so there has already been some
22214 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22215 immediately. It retries up to
22216 .code
22217 (lock_retries * lock_interval) / <timeout>
22218 .endd
22219 times (rounded up).
22220 .endlist
22221
22222 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22223 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22224
22225
22226 .section "Operational details for delivery to a new file" "SECTopdir"
22227 .cindex "delivery" "to single file"
22228 .cindex "&""From""& line"
22229 When the &%directory%& option is set instead of &%file%&, each message is
22230 delivered into a newly-created file or set of files. When &(appendfile)& is
22231 activated directly from a &(redirect)& router, neither &%file%& nor
22232 &%directory%& is normally set, because the path for delivery is supplied by the
22233 router. (See for example, the &(address_file)& transport in the default
22234 configuration.) In this case, delivery is to a new file if either the path name
22235 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22236
22237 No locking is required while writing the message to a new file, so the various
22238 locking options of the transport are ignored. The &"From"& line that by default
22239 separates messages in a single file is not normally needed, nor is the escaping
22240 of message lines that start with &"From"&, and there is no need to ensure a
22241 newline at the end of each message. Consequently, the default values for
22242 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22243 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22244
22245 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22246 the files in the delivery directory by default. However, you can specify a
22247 different directory by setting &%quota_directory%&. Also, for maildir
22248 deliveries (see below) the &_maildirfolder_& convention is honoured.
22249
22250
22251 .cindex "maildir format"
22252 .cindex "mailstore format"
22253 There are three different ways in which delivery to individual files can be
22254 done, controlled by the settings of the &%maildir_format%& and
22255 &%mailstore_format%& options. Note that code to support maildir or mailstore
22256 formats is not included in the binary unless SUPPORT_MAILDIR or
22257 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22258
22259 .cindex "directory creation"
22260 In all three cases an attempt is made to create the directory and any necessary
22261 sub-directories if they do not exist, provided that the &%create_directory%&
22262 option is set (the default). The location of a created directory can be
22263 constrained by setting &%create_file%&. A created directory's mode is given by
22264 the &%directory_mode%& option. If creation fails, or if the
22265 &%create_directory%& option is not set when creation is required, delivery is
22266 deferred.
22267
22268
22269
22270 .section "Maildir delivery" "SECTmaildirdelivery"
22271 .cindex "maildir format" "description of"
22272 If the &%maildir_format%& option is true, Exim delivers each message by writing
22273 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22274 directory that is defined by the &%directory%& option (the &"delivery
22275 directory"&). If the delivery is successful, the file is renamed into the
22276 &_new_& subdirectory.
22277
22278 In the file name, <&'stime'&> is the current time of day in seconds, and
22279 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22280 Exim checks that the time-of-day clock has moved on by at least one microsecond
22281 before terminating the delivery process. This guarantees uniqueness for the
22282 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22283 opening it. If any response other than ENOENT (does not exist) is given,
22284 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22285
22286 Before Exim carries out a maildir delivery, it ensures that subdirectories
22287 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22288 do not exist, Exim tries to create them and any superior directories in their
22289 path, subject to the &%create_directory%& and &%create_file%& options. If the
22290 &%maildirfolder_create_regex%& option is set, and the regular expression it
22291 contains matches the delivery directory, Exim also ensures that a file called
22292 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22293 &_maildirfolder_& file cannot be created, delivery is deferred.
22294
22295 These features make it possible to use Exim to create all the necessary files
22296 and directories in a maildir mailbox, including subdirectories for maildir++
22297 folders. Consider this example:
22298 .code
22299 maildir_format = true
22300 directory = /var/mail/$local_part\
22301            ${if eq{$local_part_suffix}{}{}\
22302            {/.${substr_1:$local_part_suffix}}}
22303 maildirfolder_create_regex = /\.[^/]+$
22304 .endd
22305 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22306 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22307 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22308 not match this name, so Exim will not look for or create the file
22309 &_/var/mail/pimbo/maildirfolder_&, though it will create
22310 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22311
22312 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22313 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22314 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22315 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22316 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22317
22318 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22319 not inadvertently match the toplevel maildir directory, because a
22320 &_maildirfolder_& file at top level would completely break quota calculations.
22321
22322 .cindex "quota" "in maildir delivery"
22323 .cindex "maildir++"
22324 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22325 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22326 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22327 Exim assumes the directory is a maildir++ folder directory, which is one level
22328 down from the user's top level mailbox directory. This causes it to start at
22329 the parent directory instead of the current directory when calculating the
22330 amount of space used.
22331
22332 One problem with delivering into a multi-file mailbox is that it is
22333 computationally expensive to compute the size of the mailbox for quota
22334 checking. Various approaches have been taken to reduce the amount of work
22335 needed. The next two sections describe two of them. A third alternative is to
22336 use some external process for maintaining the size data, and use the expansion
22337 of the &%mailbox_size%& option as a way of importing it into Exim.
22338
22339
22340
22341
22342 .section "Using tags to record message sizes" "SECID135"
22343 If &%maildir_tag%& is set, the string is expanded for each delivery.
22344 When the maildir file is renamed into the &_new_& sub-directory, the
22345 tag is added to its name. However, if adding the tag takes the length of the
22346 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22347 the tag is dropped and the maildir file is created with no tag.
22348
22349
22350 .vindex "&$message_size$&"
22351 Tags can be used to encode the size of files in their names; see
22352 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22353 happens after the message has been written. The value of the &$message_size$&
22354 variable is set to the number of bytes actually written. If the expansion is
22355 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22356 be deferred. The expanded tag may contain any printing characters except &"/"&.
22357 Non-printing characters in the string are ignored; if the resulting string is
22358 empty, it is ignored. If it starts with an alphanumeric character, a leading
22359 colon is inserted; this default has not proven to be the path that popular
22360 maildir implementations have chosen (but changing it in Exim would break
22361 backwards compatibility).
22362
22363 For one common implementation, you might set:
22364 .code
22365 maildir_tag = ,S=${message_size}
22366 .endd
22367 but you should check the documentation of the other software to be sure.
22368
22369 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22370 as this allows Exim to extract the size from your tag, instead of having to
22371 &[stat()]& each message file.
22372
22373
22374 .section "Using a maildirsize file" "SECID136"
22375 .cindex "quota" "in maildir delivery"
22376 .cindex "maildir format" "&_maildirsize_& file"
22377 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22378 storing quota and message size information in a file called &_maildirsize_&
22379 within the toplevel maildir directory. If this file does not exist, Exim
22380 creates it, setting the quota from the &%quota%& option of the transport. If
22381 the maildir directory itself does not exist, it is created before any attempt
22382 to write a &_maildirsize_& file.
22383
22384 The &_maildirsize_& file is used to hold information about the sizes of
22385 messages in the maildir, thus speeding up quota calculations. The quota value
22386 in the file is just a cache; if the quota is changed in the transport, the new
22387 value overrides the cached value when the next message is delivered. The cache
22388 is maintained for the benefit of other programs that access the maildir and
22389 need to know the quota.
22390
22391 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22392 file is maintained (with a zero quota setting), but no quota is imposed.
22393
22394 A regular expression is available for controlling which directories in the
22395 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22396 See the description of the &%maildir_quota_directory_regex%& option above for
22397 details.
22398
22399
22400 .section "Mailstore delivery" "SECID137"
22401 .cindex "mailstore format" "description of"
22402 If the &%mailstore_format%& option is true, each message is written as two
22403 files in the given directory. A unique base name is constructed from the
22404 message id and the current delivery process, and the files that are written use
22405 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22406 contains the message's envelope, and the &_.msg_& file contains the message
22407 itself. The base name is placed in the variable &$mailstore_basename$&.
22408
22409 During delivery, the envelope is first written to a file with the suffix
22410 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22411 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22412 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22413 file before accessing either of them. An alternative approach is to wait for
22414 the absence of a &_.tmp_& file.
22415
22416 The envelope file starts with any text defined by the &%mailstore_prefix%&
22417 option, expanded and terminated by a newline if there isn't one. Then follows
22418 the sender address on one line, then all the recipient addresses, one per line.
22419 There can be more than one recipient only if the &%batch_max%& option is set
22420 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22421 appended to the file, followed by a newline if it does not end with one.
22422
22423 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22424 failure, it is ignored. Other expansion errors are treated as serious
22425 configuration errors, and delivery is deferred. The variable
22426 &$mailstore_basename$& is available for use during these expansions.
22427
22428
22429 .section "Non-special new file delivery" "SECID138"
22430 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22431 file is created directly in the named directory. For example, when delivering
22432 messages into files in batched SMTP format for later delivery to some host (see
22433 section &<<SECTbatchSMTP>>&), a setting such as
22434 .code
22435 directory = /var/bsmtp/$host
22436 .endd
22437 might be used. A message is written to a file with a temporary name, which is
22438 then renamed when the delivery is complete. The final name is obtained by
22439 expanding the contents of the &%directory_file%& option.
22440 .ecindex IIDapptra1
22441 .ecindex IIDapptra2
22442
22443
22444
22445
22446
22447
22448 . ////////////////////////////////////////////////////////////////////////////
22449 . ////////////////////////////////////////////////////////////////////////////
22450
22451 .chapter "The autoreply transport" "CHID8"
22452 .scindex IIDauttra1 "transports" "&(autoreply)&"
22453 .scindex IIDauttra2 "&(autoreply)& transport"
22454 The &(autoreply)& transport is not a true transport in that it does not cause
22455 the message to be transmitted. Instead, it generates a new mail message as an
22456 automatic reply to the incoming message. &'References:'& and
22457 &'Auto-Submitted:'& header lines are included. These are constructed according
22458 to the rules in RFCs 2822 and 3834, respectively.
22459
22460 If the router that passes the message to this transport does not have the
22461 &%unseen%& option set, the original message (for the current recipient) is not
22462 delivered anywhere. However, when the &%unseen%& option is set on the router
22463 that passes the message to this transport, routing of the address continues, so
22464 another router can set up a normal message delivery.
22465
22466
22467 The &(autoreply)& transport is usually run as the result of mail filtering, a
22468 &"vacation"& message being the standard example. However, it can also be run
22469 directly from a router like any other transport. To reduce the possibility of
22470 message cascades, messages created by the &(autoreply)& transport always have
22471 empty envelope sender addresses, like bounce messages.
22472
22473 The parameters of the message to be sent can be specified in the configuration
22474 by options described below. However, these are used only when the address
22475 passed to the transport does not contain its own reply information. When the
22476 transport is run as a consequence of a
22477 &%mail%&
22478 or &%vacation%& command in a filter file, the parameters of the message are
22479 supplied by the filter, and passed with the address. The transport's options
22480 that define the message are then ignored (so they are not usually set in this
22481 case). The message is specified entirely by the filter or by the transport; it
22482 is never built from a mixture of options. However, the &%file_optional%&,
22483 &%mode%&, and &%return_message%& options apply in all cases.
22484
22485 &(Autoreply)& is implemented as a local transport. When used as a result of a
22486 command in a user's filter file, &(autoreply)& normally runs under the uid and
22487 gid of the user, and with appropriate current and home directories (see chapter
22488 &<<CHAPenvironment>>&).
22489
22490 There is a subtle difference between routing a message to a &(pipe)& transport
22491 that generates some text to be returned to the sender, and routing it to an
22492 &(autoreply)& transport. This difference is noticeable only if more than one
22493 address from the same message is so handled. In the case of a pipe, the
22494 separate outputs from the different addresses are gathered up and returned to
22495 the sender in a single message, whereas if &(autoreply)& is used, a separate
22496 message is generated for each address that is passed to it.
22497
22498 Non-printing characters are not permitted in the header lines generated for the
22499 message that &(autoreply)& creates, with the exception of newlines that are
22500 immediately followed by white space. If any non-printing characters are found,
22501 the transport defers.
22502 Whether characters with the top bit set count as printing characters or not is
22503 controlled by the &%print_topbitchars%& global option.
22504
22505 If any of the generic options for manipulating headers (for example,
22506 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22507 of the original message that is included in the generated message when
22508 &%return_message%& is set. They do not apply to the generated message itself.
22509
22510 .vindex "&$sender_address$&"
22511 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22512 the message, indicating that there were no recipients, it does not treat this
22513 as an error. This means that autoreplies sent to &$sender_address$& when this
22514 is empty (because the incoming message is a bounce message) do not cause
22515 problems. They are just discarded.
22516
22517
22518
22519 .section "Private options for autoreply" "SECID139"
22520 .cindex "options" "&(autoreply)& transport"
22521
22522 .option bcc autoreply string&!! unset
22523 This specifies the addresses that are to receive &"blind carbon copies"& of the
22524 message when the message is specified by the transport.
22525
22526
22527 .option cc autoreply string&!! unset
22528 This specifies recipients of the message and the contents of the &'Cc:'& header
22529 when the message is specified by the transport.
22530
22531
22532 .option file autoreply string&!! unset
22533 The contents of the file are sent as the body of the message when the message
22534 is specified by the transport. If both &%file%& and &%text%& are set, the text
22535 string comes first.
22536
22537
22538 .option file_expand autoreply boolean false
22539 If this is set, the contents of the file named by the &%file%& option are
22540 subjected to string expansion as they are added to the message.
22541
22542
22543 .option file_optional autoreply boolean false
22544 If this option is true, no error is generated if the file named by the &%file%&
22545 option or passed with the address does not exist or cannot be read.
22546
22547
22548 .option from autoreply string&!! unset
22549 This specifies the contents of the &'From:'& header when the message is
22550 specified by the transport.
22551
22552
22553 .option headers autoreply string&!! unset
22554 This specifies additional RFC 2822 headers that are to be added to the message
22555 when the message is specified by the transport. Several can be given by using
22556 &"\n"& to separate them. There is no check on the format.
22557
22558
22559 .option log autoreply string&!! unset
22560 This option names a file in which a record of every message sent is logged when
22561 the message is specified by the transport.
22562
22563
22564 .option mode autoreply "octal integer" 0600
22565 If either the log file or the &"once"& file has to be created, this mode is
22566 used.
22567
22568
22569 .option never_mail autoreply "address list&!!" unset
22570 If any run of the transport creates a message with a recipient that matches any
22571 item in the list, that recipient is quietly discarded. If all recipients are
22572 discarded, no message is created. This applies both when the recipients are
22573 generated by a filter and when they are specified in the transport.
22574
22575
22576
22577 .option once autoreply string&!! unset
22578 This option names a file or DBM database in which a record of each &'To:'&
22579 recipient is kept when the message is specified by the transport. &*Note*&:
22580 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22581
22582 If &%once%& is unset, or is set to an empty string, the message is always sent.
22583 By default, if &%once%& is set to a non-empty file name, the message
22584 is not sent if a potential recipient is already listed in the database.
22585 However, if the &%once_repeat%& option specifies a time greater than zero, the
22586 message is sent if that much time has elapsed since a message was last sent to
22587 this recipient. A setting of zero time for &%once_repeat%& (the default)
22588 prevents a message from being sent a second time &-- in this case, zero means
22589 infinity.
22590
22591 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22592 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22593 greater than zero, it changes the way Exim implements the &%once%& option.
22594 Instead of using a DBM file to record every recipient it sends to, it uses a
22595 regular file, whose size will never get larger than the given value.
22596
22597 In the file, Exim keeps a linear list of recipient addresses and the times at
22598 which they were sent messages. If the file is full when a new address needs to
22599 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22600 means that a given recipient may receive multiple messages, but at
22601 unpredictable intervals that depend on the rate of turnover of addresses in the
22602 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22603
22604
22605 .option once_file_size autoreply integer 0
22606 See &%once%& above.
22607
22608
22609 .option once_repeat autoreply time&!! 0s
22610 See &%once%& above.
22611 After expansion, the value of this option must be a valid time value.
22612
22613
22614 .option reply_to autoreply string&!! unset
22615 This specifies the contents of the &'Reply-To:'& header when the message is
22616 specified by the transport.
22617
22618
22619 .option return_message autoreply boolean false
22620 If this is set, a copy of the original message is returned with the new
22621 message, subject to the maximum size set in the &%return_size_limit%& global
22622 configuration option.
22623
22624
22625 .option subject autoreply string&!! unset
22626 This specifies the contents of the &'Subject:'& header when the message is
22627 specified by the transport. It is tempting to quote the original subject in
22628 automatic responses. For example:
22629 .code
22630 subject = Re: $h_subject:
22631 .endd
22632 There is a danger in doing this, however. It may allow a third party to
22633 subscribe your users to an opt-in mailing list, provided that the list accepts
22634 bounce messages as subscription confirmations. Well-managed lists require a
22635 non-bounce message to confirm a subscription, so the danger is relatively
22636 small.
22637
22638
22639
22640 .option text autoreply string&!! unset
22641 This specifies a single string to be used as the body of the message when the
22642 message is specified by the transport. If both &%text%& and &%file%& are set,
22643 the text comes first.
22644
22645
22646 .option to autoreply string&!! unset
22647 This specifies recipients of the message and the contents of the &'To:'& header
22648 when the message is specified by the transport.
22649 .ecindex IIDauttra1
22650 .ecindex IIDauttra2
22651
22652
22653
22654
22655 . ////////////////////////////////////////////////////////////////////////////
22656 . ////////////////////////////////////////////////////////////////////////////
22657
22658 .chapter "The lmtp transport" "CHAPLMTP"
22659 .cindex "transports" "&(lmtp)&"
22660 .cindex "&(lmtp)& transport"
22661 .cindex "LMTP" "over a pipe"
22662 .cindex "LMTP" "over a socket"
22663 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22664 specified command
22665 or by interacting with a Unix domain socket.
22666 This transport is something of a cross between the &(pipe)& and &(smtp)&
22667 transports. Exim also has support for using LMTP over TCP/IP; this is
22668 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22669 to be of minority interest, the default build-time configure in &_src/EDITME_&
22670 has it commented out. You need to ensure that
22671 .code
22672 TRANSPORT_LMTP=yes
22673 .endd
22674 .cindex "options" "&(lmtp)& transport"
22675 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22676 included in the Exim binary. The private options of the &(lmtp)& transport are
22677 as follows:
22678
22679 .option batch_id lmtp string&!! unset
22680 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22681
22682
22683 .option batch_max lmtp integer 1
22684 This limits the number of addresses that can be handled in a single delivery.
22685 Most LMTP servers can handle several addresses at once, so it is normally a
22686 good idea to increase this value. See the description of local delivery
22687 batching in chapter &<<CHAPbatching>>&.
22688
22689
22690 .option command lmtp string&!! unset
22691 This option must be set if &%socket%& is not set. The string is a command which
22692 is run in a separate process. It is split up into a command name and list of
22693 arguments, each of which is separately expanded (so expansion cannot change the
22694 number of arguments). The command is run directly, not via a shell. The message
22695 is passed to the new process using the standard input and output to operate the
22696 LMTP protocol.
22697
22698 .option ignore_quota lmtp boolean false
22699 .cindex "LMTP" "ignoring quota errors"
22700 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22701 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22702 in its response to the LHLO command.
22703
22704 .option socket lmtp string&!! unset
22705 This option must be set if &%command%& is not set. The result of expansion must
22706 be the name of a Unix domain socket. The transport connects to the socket and
22707 delivers the message to it using the LMTP protocol.
22708
22709
22710 .option timeout lmtp time 5m
22711 The transport is aborted if the created process or Unix domain socket does not
22712 respond to LMTP commands or message input within this timeout. Delivery
22713 is deferred, and will be tried again later. Here is an example of a typical
22714 LMTP transport:
22715 .code
22716 lmtp:
22717   driver = lmtp
22718   command = /some/local/lmtp/delivery/program
22719   batch_max = 20
22720   user = exim
22721 .endd
22722 This delivers up to 20 addresses at a time, in a mixture of domains if
22723 necessary, running as the user &'exim'&.
22724
22725
22726
22727 . ////////////////////////////////////////////////////////////////////////////
22728 . ////////////////////////////////////////////////////////////////////////////
22729
22730 .chapter "The pipe transport" "CHAPpipetransport"
22731 .scindex IIDpiptra1 "transports" "&(pipe)&"
22732 .scindex IIDpiptra2 "&(pipe)& transport"
22733 The &(pipe)& transport is used to deliver messages via a pipe to a command
22734 running in another process. One example is the use of &(pipe)& as a
22735 pseudo-remote transport for passing messages to some other delivery mechanism
22736 (such as UUCP). Another is the use by individual users to automatically process
22737 their incoming messages. The &(pipe)& transport can be used in one of the
22738 following ways:
22739
22740 .ilist
22741 .vindex "&$local_part$&"
22742 A router routes one address to a transport in the normal way, and the
22743 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22744 contains the local part of the address (as usual), and the command that is run
22745 is specified by the &%command%& option on the transport.
22746 .next
22747 .vindex "&$pipe_addresses$&"
22748 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22749 transport can handle more than one address in a single run. In this case, when
22750 more than one address is routed to the transport, &$local_part$& is not set
22751 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22752 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22753 that are routed to the transport.
22754 .next
22755 .vindex "&$address_pipe$&"
22756 A router redirects an address directly to a pipe command (for example, from an
22757 alias or forward file). In this case, &$address_pipe$& contains the text of the
22758 pipe command, and the &%command%& option on the transport is ignored unless
22759 &%force_command%& is set. If only one address is being transported
22760 (&%batch_max%& is not greater than one, or only one address was redirected to
22761 this pipe command), &$local_part$& contains the local part that was redirected.
22762 .endlist
22763
22764
22765 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22766 deliver messages over pipes using the LMTP interactive protocol. This is
22767 implemented by the &(lmtp)& transport.
22768
22769 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22770 &_.forward_& file, the command runs under the uid and gid of that user. In
22771 other cases, the uid and gid have to be specified explicitly, either on the
22772 transport or on the router that handles the address. Current and &"home"&
22773 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22774 details of the local delivery environment and chapter &<<CHAPbatching>>&
22775 for a discussion of local delivery batching.
22776
22777
22778 .section "Concurrent delivery" "SECID140"
22779 If two messages arrive at almost the same time, and both are routed to a pipe
22780 delivery, the two pipe transports may be run concurrently. You must ensure that
22781 any pipe commands you set up are robust against this happening. If the commands
22782 write to a file, the &%exim_lock%& utility might be of use.
22783 .new
22784 Alternatively the &%max_parallel%& option could be used with a value
22785 of "1" to enforce serialization.
22786 .wen
22787
22788
22789
22790
22791 .section "Returned status and data" "SECID141"
22792 .cindex "&(pipe)& transport" "returned data"
22793 If the command exits with a non-zero return code, the delivery is deemed to
22794 have failed, unless either the &%ignore_status%& option is set (in which case
22795 the return code is treated as zero), or the return code is one of those listed
22796 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22797 later"&. In this case, delivery is deferred. Details of a permanent failure are
22798 logged, but are not included in the bounce message, which merely contains
22799 &"local delivery failed"&.
22800
22801 If the command exits on a signal and the &%freeze_signal%& option is set then
22802 the message will be frozen in the queue. If that option is not set, a bounce
22803 will be sent as normal.
22804
22805 If the return code is greater than 128 and the command being run is a shell
22806 script, it normally means that the script was terminated by a signal whose
22807 value is the return code minus 128. The &%freeze_signal%& option does not
22808 apply in this case.
22809
22810 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22811 return code is set to 127. This is the value that a shell returns if it is
22812 asked to run a non-existent command. The wording for the log line suggests that
22813 a non-existent command may be the problem.
22814
22815 The &%return_output%& option can affect the result of a pipe delivery. If it is
22816 set and the command produces any output on its standard output or standard
22817 error streams, the command is considered to have failed, even if it gave a zero
22818 return code or if &%ignore_status%& is set. The output from the command is
22819 included as part of the bounce message. The &%return_fail_output%& option is
22820 similar, except that output is returned only when the command exits with a
22821 failure return code, that is, a value other than zero or a code that matches
22822 &%temp_errors%&.
22823
22824
22825
22826 .section "How the command is run" "SECThowcommandrun"
22827 .cindex "&(pipe)& transport" "path for command"
22828 The command line is (by default) broken down into a command name and arguments
22829 by the &(pipe)& transport itself. The &%allow_commands%& and
22830 &%restrict_to_path%& options can be used to restrict the commands that may be
22831 run.
22832
22833 .cindex "quoting" "in pipe command"
22834 Unquoted arguments are delimited by white space. If an argument appears in
22835 double quotes, backslash is interpreted as an escape character in the usual
22836 way. If an argument appears in single quotes, no escaping is done.
22837
22838 String expansion is applied to the command line except when it comes from a
22839 traditional &_.forward_& file (commands from a filter file are expanded). The
22840 expansion is applied to each argument in turn rather than to the whole line.
22841 For this reason, any string expansion item that contains white space must be
22842 quoted so as to be contained within a single argument. A setting such as
22843 .code
22844 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22845 .endd
22846 will not work, because the expansion item gets split between several
22847 arguments. You have to write
22848 .code
22849 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22850 .endd
22851 to ensure that it is all in one argument. The expansion is done in this way,
22852 argument by argument, so that the number of arguments cannot be changed as a
22853 result of expansion, and quotes or backslashes in inserted variables do not
22854 interact with external quoting. However, this leads to problems if you want to
22855 generate multiple arguments (or the command name plus arguments) from a single
22856 expansion. In this situation, the simplest solution is to use a shell. For
22857 example:
22858 .code
22859 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22860 .endd
22861
22862 .cindex "transport" "filter"
22863 .cindex "filter" "transport filter"
22864 .vindex "&$pipe_addresses$&"
22865 Special handling takes place when an argument consists of precisely the text
22866 &`$pipe_addresses`&. This is not a general expansion variable; the only
22867 place this string is recognized is when it appears as an argument for a pipe or
22868 transport filter command. It causes each address that is being handled to be
22869 inserted in the argument list at that point &'as a separate argument'&. This
22870 avoids any problems with spaces or shell metacharacters, and is of use when a
22871 &(pipe)& transport is handling groups of addresses in a batch.
22872
22873 If &%force_command%& is enabled on the transport, Special handling takes place
22874 for an argument that consists of precisely the text &`$address_pipe`&.  It
22875 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22876 argument is inserted in the argument list at that point
22877 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22878 the only item in the argument; in fact, if it were then &%force_command%&
22879 should behave as a no-op.  Rather, it should be used to adjust the command
22880 run while preserving the argument vector separation.
22881
22882 After splitting up into arguments and expansion, the resulting command is run
22883 in a subprocess directly from the transport, &'not'& under a shell. The
22884 message that is being delivered is supplied on the standard input, and the
22885 standard output and standard error are both connected to a single pipe that is
22886 read by Exim. The &%max_output%& option controls how much output the command
22887 may produce, and the &%return_output%& and &%return_fail_output%& options
22888 control what is done with it.
22889
22890 Not running the command under a shell (by default) lessens the security risks
22891 in cases when a command from a user's filter file is built out of data that was
22892 taken from an incoming message. If a shell is required, it can of course be
22893 explicitly specified as the command to be run. However, there are circumstances
22894 where existing commands (for example, in &_.forward_& files) expect to be run
22895 under a shell and cannot easily be modified. To allow for these cases, there is
22896 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22897 works. Instead of breaking up the command line as just described, it expands it
22898 as a single string and passes the result to &_/bin/sh_&. The
22899 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22900 with &%use_shell%&, and the whole mechanism is inherently less secure.
22901
22902
22903
22904 .section "Environment variables" "SECTpipeenv"
22905 .cindex "&(pipe)& transport" "environment for command"
22906 .cindex "environment for pipe transport"
22907 The environment variables listed below are set up when the command is invoked.
22908 This list is a compromise for maximum compatibility with other MTAs. Note that
22909 the &%environment%& option can be used to add additional variables to this
22910 environment.
22911 .display
22912 &`DOMAIN            `&   the domain of the address
22913 &`HOME              `&   the home directory, if set
22914 &`HOST              `&   the host name when called from a router (see below)
22915 &`LOCAL_PART        `&   see below
22916 &`LOCAL_PART_PREFIX `&   see below
22917 &`LOCAL_PART_SUFFIX `&   see below
22918 &`LOGNAME           `&   see below
22919 &`MESSAGE_ID        `&   Exim's local ID for the message
22920 &`PATH              `&   as specified by the &%path%& option below
22921 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22922 &`RECIPIENT         `&   the complete recipient address
22923 &`SENDER            `&   the sender of the message (empty if a bounce)
22924 &`SHELL             `&   &`/bin/sh`&
22925 &`TZ                `&   the value of the &%timezone%& option, if set
22926 &`USER              `&   see below
22927 .endd
22928 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22929 router, LOCAL_PART is set to the local part of the address. When it is
22930 called as a result of a forward or alias expansion, LOCAL_PART is set to
22931 the local part of the address that was expanded. In both cases, any affixes are
22932 removed from the local part, and made available in LOCAL_PART_PREFIX and
22933 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22934 same value as LOCAL_PART for compatibility with other MTAs.
22935
22936 .cindex "HOST"
22937 HOST is set only when a &(pipe)& transport is called from a router that
22938 associates hosts with an address, typically when using &(pipe)& as a
22939 pseudo-remote transport. HOST is set to the first host name specified by
22940 the router.
22941
22942 .cindex "HOME"
22943 If the transport's generic &%home_directory%& option is set, its value is used
22944 for the HOME environment variable. Otherwise, a home directory may be set
22945 by the router's &%transport_home_directory%& option, which defaults to the
22946 user's home directory if &%check_local_user%& is set.
22947
22948
22949 .section "Private options for pipe" "SECID142"
22950 .cindex "options" "&(pipe)& transport"
22951
22952
22953
22954 .option allow_commands pipe "string list&!!" unset
22955 .cindex "&(pipe)& transport" "permitted commands"
22956 The string is expanded, and is then interpreted as a colon-separated list of
22957 permitted commands. If &%restrict_to_path%& is not set, the only commands
22958 permitted are those in the &%allow_commands%& list. They need not be absolute
22959 paths; the &%path%& option is still used for relative paths. If
22960 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22961 in the &%allow_commands%& list, or a name without any slashes that is found on
22962 the path. In other words, if neither &%allow_commands%& nor
22963 &%restrict_to_path%& is set, there is no restriction on the command, but
22964 otherwise only commands that are permitted by one or the other are allowed. For
22965 example, if
22966 .code
22967 allow_commands = /usr/bin/vacation
22968 .endd
22969 and &%restrict_to_path%& is not set, the only permitted command is
22970 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22971 &%use_shell%& is set.
22972
22973
22974 .option batch_id pipe string&!! unset
22975 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22976
22977
22978 .option batch_max pipe integer 1
22979 This limits the number of addresses that can be handled in a single delivery.
22980 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22981
22982
22983 .option check_string pipe string unset
22984 As &(pipe)& writes the message, the start of each line is tested for matching
22985 &%check_string%&, and if it does, the initial matching characters are replaced
22986 by the contents of &%escape_string%&, provided both are set. The value of
22987 &%check_string%& is a literal string, not a regular expression, and the case of
22988 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22989 of &%check_string%& and &%escape_string%& are forced to values that implement
22990 the SMTP escaping protocol. Any settings made in the configuration file are
22991 ignored.
22992
22993
22994 .option command pipe string&!! unset
22995 This option need not be set when &(pipe)& is being used to deliver to pipes
22996 obtained directly from address redirections. In other cases, the option must be
22997 set, to provide a command to be run. It need not yield an absolute path (see
22998 the &%path%& option below). The command is split up into separate arguments by
22999 Exim, and each argument is separately expanded, as described in section
23000 &<<SECThowcommandrun>>& above.
23001
23002
23003 .option environment pipe string&!! unset
23004 .cindex "&(pipe)& transport" "environment for command"
23005 .cindex "environment for &(pipe)& transport"
23006 This option is used to add additional variables to the environment in which the
23007 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23008 a string which is expanded, and then interpreted as a colon-separated list of
23009 environment settings of the form <&'name'&>=<&'value'&>.
23010
23011
23012 .option escape_string pipe string unset
23013 See &%check_string%& above.
23014
23015
23016 .option freeze_exec_fail pipe boolean false
23017 .cindex "exec failure"
23018 .cindex "failure of exec"
23019 .cindex "&(pipe)& transport" "failure of exec"
23020 Failure to exec the command in a pipe transport is by default treated like
23021 any other failure while running the command. However, if &%freeze_exec_fail%&
23022 is set, failure to exec is treated specially, and causes the message to be
23023 frozen, whatever the setting of &%ignore_status%&.
23024
23025
23026 .option freeze_signal pipe boolean false
23027 .cindex "signal exit"
23028 .cindex "&(pipe)& transport", "signal exit"
23029 Normally if the process run by a command in a pipe transport exits on a signal,
23030 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23031 frozen in Exim's queue instead.
23032
23033
23034 .option force_command pipe boolean false
23035 .cindex "force command"
23036 .cindex "&(pipe)& transport", "force command"
23037 Normally when a router redirects an address directly to a pipe command
23038 the &%command%& option on the transport is ignored.  If &%force_command%&
23039 is set, the &%command%& option will used. This is especially
23040 useful for forcing a wrapper or additional argument to be added to the
23041 command. For example:
23042 .code
23043 command = /usr/bin/remote_exec myhost -- $address_pipe
23044 force_command
23045 .endd
23046
23047 Note that &$address_pipe$& is handled specially in &%command%& when
23048 &%force_command%& is set, expanding out to the original argument vector as
23049 separate items, similarly to a Unix shell &`"$@"`& construct.
23050
23051
23052 .option ignore_status pipe boolean false
23053 If this option is true, the status returned by the subprocess that is set up to
23054 run the command is ignored, and Exim behaves as if zero had been returned.
23055 Otherwise, a non-zero status or termination by signal causes an error return
23056 from the transport unless the status value is one of those listed in
23057 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23058
23059 &*Note*&: This option does not apply to timeouts, which do not return a status.
23060 See the &%timeout_defer%& option for how timeouts are handled.
23061
23062
23063 .option log_defer_output pipe boolean false
23064 .cindex "&(pipe)& transport" "logging output"
23065 If this option is set, and the status returned by the command is
23066 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23067 and any output was produced on stdout or stderr, the first line of it is
23068 written to the main log.
23069
23070
23071 .option log_fail_output pipe boolean false
23072 If this option is set, and the command returns any output on stdout or
23073 stderr, and also ends with a return code that is neither zero nor one of
23074 the return codes listed in &%temp_errors%& (that is, the delivery
23075 failed), the first line of output is written to the main log. This
23076 option and &%log_output%& are mutually exclusive.  Only one of them may
23077 be set.
23078
23079
23080 .option log_output pipe boolean false
23081 If this option is set and the command returns any output on stdout or
23082 stderr, the first line of output is written to the main log, whatever
23083 the return code. This option and &%log_fail_output%& are mutually
23084 exclusive. Only one of them may be set.
23085
23086
23087 .option max_output pipe integer 20K
23088 This specifies the maximum amount of output that the command may produce on its
23089 standard output and standard error file combined. If the limit is exceeded, the
23090 process running the command is killed. This is intended as a safety measure to
23091 catch runaway processes. The limit is applied independently of the settings of
23092 the options that control what is done with such output (for example,
23093 &%return_output%&). Because of buffering effects, the amount of output may
23094 exceed the limit by a small amount before Exim notices.
23095
23096
23097 .option message_prefix pipe string&!! "see below"
23098 The string specified here is expanded and output at the start of every message.
23099 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23100 .code
23101 message_prefix = \
23102   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23103   ${tod_bsdinbox}\n
23104 .endd
23105 .cindex "Cyrus"
23106 .cindex "&%tmail%&"
23107 .cindex "&""From""& line"
23108 This is required by the commonly used &_/usr/bin/vacation_& program.
23109 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23110 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23111 setting
23112 .code
23113 message_prefix =
23114 .endd
23115 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23116 &`\n`& to &`\r\n`& in &%message_prefix%&.
23117
23118
23119 .option message_suffix pipe string&!! "see below"
23120 The string specified here is expanded and output at the end of every message.
23121 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23122 The suffix can be suppressed by setting
23123 .code
23124 message_suffix =
23125 .endd
23126 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23127 &`\n`& to &`\r\n`& in &%message_suffix%&.
23128
23129
23130 .option path pipe string "see below"
23131 This option specifies the string that is set up in the PATH environment
23132 variable of the subprocess. The default is:
23133 .code
23134 /bin:/usr/bin
23135 .endd
23136 If the &%command%& option does not yield an absolute path name, the command is
23137 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23138 apply to a command specified as a transport filter.
23139
23140
23141 .option permit_coredump pipe boolean false
23142 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23143 a core-dump of a pipe command, enable this command.  This enables core-dumps
23144 during delivery and affects both the Exim binary and the pipe command run.
23145 It is recommended that this option remain off unless and until you have a need
23146 for it and that this only be enabled when needed, as the risk of excessive
23147 resource consumption can be quite high.  Note also that Exim is typically
23148 installed as a setuid binary and most operating systems will inhibit coredumps
23149 of these by default, so further OS-specific action may be required.
23150
23151
23152 .option pipe_as_creator pipe boolean false
23153 .cindex "uid (user id)" "local delivery"
23154 If the generic &%user%& option is not set and this option is true, the delivery
23155 process is run under the uid that was in force when Exim was originally called
23156 to accept the message. If the group id is not otherwise set (via the generic
23157 &%group%& option), the gid that was in force when Exim was originally called to
23158 accept the message is used.
23159
23160
23161 .option restrict_to_path pipe boolean false
23162 When this option is set, any command name not listed in &%allow_commands%& must
23163 contain no slashes. The command is searched for only in the directories listed
23164 in the &%path%& option. This option is intended for use in the case when a pipe
23165 command has been generated from a user's &_.forward_& file. This is usually
23166 handled by a &(pipe)& transport called &%address_pipe%&.
23167
23168
23169 .option return_fail_output pipe boolean false
23170 If this option is true, and the command produced any output and ended with a
23171 return code other than zero or one of the codes listed in &%temp_errors%& (that
23172 is, the delivery failed), the output is returned in the bounce message.
23173 However, if the message has a null sender (that is, it is itself a bounce
23174 message), output from the command is discarded. This option and
23175 &%return_output%& are mutually exclusive. Only one of them may be set.
23176
23177
23178
23179 .option return_output pipe boolean false
23180 If this option is true, and the command produced any output, the delivery is
23181 deemed to have failed whatever the return code from the command, and the output
23182 is returned in the bounce message. Otherwise, the output is just discarded.
23183 However, if the message has a null sender (that is, it is a bounce message),
23184 output from the command is always discarded, whatever the setting of this
23185 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23186 of them may be set.
23187
23188
23189
23190 .option temp_errors pipe "string list" "see below"
23191 .cindex "&(pipe)& transport" "temporary failure"
23192 This option contains either a colon-separated list of numbers, or a single
23193 asterisk. If &%ignore_status%& is false
23194 and &%return_output%& is not set,
23195 and the command exits with a non-zero return code, the failure is treated as
23196 temporary and the delivery is deferred if the return code matches one of the
23197 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23198 codes are treated as permanent errors. The default setting contains the codes
23199 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23200 compiled on a system that does not define these macros, it assumes values of 75
23201 and 73, respectively.
23202
23203
23204 .option timeout pipe time 1h
23205 If the command fails to complete within this time, it is killed. This normally
23206 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23207 specifies no timeout. In order to ensure that any subprocesses created by the
23208 command are also killed, Exim makes the initial process a process group leader,
23209 and kills the whole process group on a timeout. However, this can be defeated
23210 if one of the processes starts a new process group.
23211
23212 .option timeout_defer pipe boolean false
23213 A timeout in a &(pipe)& transport, either in the command that the transport
23214 runs, or in a transport filter that is associated with it, is by default
23215 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23216 is set true, both kinds of timeout become temporary errors, causing the
23217 delivery to be deferred.
23218
23219 .option umask pipe "octal integer" 022
23220 This specifies the umask setting for the subprocess that runs the command.
23221
23222
23223 .option use_bsmtp pipe boolean false
23224 .cindex "envelope sender"
23225 If this option is set true, the &(pipe)& transport writes messages in &"batch
23226 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23227 commands. If you want to include a leading HELO command with such messages,
23228 you can do so by setting the &%message_prefix%& option. See section
23229 &<<SECTbatchSMTP>>& for details of batch SMTP.
23230
23231 .option use_classresources pipe boolean false
23232 .cindex "class resources (BSD)"
23233 This option is available only when Exim is running on FreeBSD, NetBSD, or
23234 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23235 resource limits when a &(pipe)& transport is run to perform a delivery. The
23236 limits for the uid under which the pipe is to run are obtained from the login
23237 class database.
23238
23239
23240 .option use_crlf pipe boolean false
23241 .cindex "carriage return"
23242 .cindex "linefeed"
23243 This option causes lines to be terminated with the two-character CRLF sequence
23244 (carriage return, linefeed) instead of just a linefeed character. In the case
23245 of batched SMTP, the byte sequence written to the pipe is then an exact image
23246 of what would be sent down a real SMTP connection.
23247
23248 The contents of the &%message_prefix%& and &%message_suffix%& options are
23249 written verbatim, so must contain their own carriage return characters if these
23250 are needed. When &%use_bsmtp%& is not set, the default values for both
23251 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23252 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23253
23254
23255 .option use_shell pipe boolean false
23256 .vindex "&$pipe_addresses$&"
23257 If this option is set, it causes the command to be passed to &_/bin/sh_&
23258 instead of being run directly from the transport, as described in section
23259 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23260 where the command is expected to be run under a shell and cannot easily be
23261 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23262 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23263 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23264 its &%-c%& option.
23265
23266
23267
23268 .section "Using an external local delivery agent" "SECID143"
23269 .cindex "local delivery" "using an external agent"
23270 .cindex "&'procmail'&"
23271 .cindex "external local delivery"
23272 .cindex "delivery" "&'procmail'&"
23273 .cindex "delivery" "by external agent"
23274 The &(pipe)& transport can be used to pass all messages that require local
23275 delivery to a separate local delivery agent such as &%procmail%&. When doing
23276 this, care must be taken to ensure that the pipe is run under an appropriate
23277 uid and gid. In some configurations one wants this to be a uid that is trusted
23278 by the delivery agent to supply the correct sender of the message. It may be
23279 necessary to recompile or reconfigure the delivery agent so that it trusts an
23280 appropriate user. The following is an example transport and router
23281 configuration for &%procmail%&:
23282 .code
23283 # transport
23284 procmail_pipe:
23285   driver = pipe
23286   command = /usr/local/bin/procmail -d $local_part
23287   return_path_add
23288   delivery_date_add
23289   envelope_to_add
23290   check_string = "From "
23291   escape_string = ">From "
23292   umask = 077
23293   user = $local_part
23294   group = mail
23295
23296 # router
23297 procmail:
23298   driver = accept
23299   check_local_user
23300   transport = procmail_pipe
23301 .endd
23302 In this example, the pipe is run as the local user, but with the group set to
23303 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23304 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23305 user to supply a correct sender address. If you do not specify either a
23306 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23307 home directory is the user's home directory by default.
23308
23309 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23310 .code
23311 IFS=" "
23312 .endd
23313 as shown in some &%procmail%& documentation, because Exim does not by default
23314 use a shell to run pipe commands.
23315
23316 .cindex "Cyrus"
23317 The next example shows a transport and a router for a system where local
23318 deliveries are handled by the Cyrus IMAP server.
23319 .code
23320 # transport
23321 local_delivery_cyrus:
23322   driver = pipe
23323   command = /usr/cyrus/bin/deliver \
23324             -m ${substr_1:$local_part_suffix} -- $local_part
23325   user = cyrus
23326   group = mail
23327   return_output
23328   log_output
23329   message_prefix =
23330   message_suffix =
23331
23332 # router
23333 local_user_cyrus:
23334   driver = accept
23335   check_local_user
23336   local_part_suffix = .*
23337   transport = local_delivery_cyrus
23338 .endd
23339 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23340 &%return_output%& to cause any text written by Cyrus to be returned to the
23341 sender.
23342 .ecindex IIDpiptra1
23343 .ecindex IIDpiptra2
23344
23345
23346 . ////////////////////////////////////////////////////////////////////////////
23347 . ////////////////////////////////////////////////////////////////////////////
23348
23349 .chapter "The smtp transport" "CHAPsmtptrans"
23350 .scindex IIDsmttra1 "transports" "&(smtp)&"
23351 .scindex IIDsmttra2 "&(smtp)& transport"
23352 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23353 or LMTP protocol. The list of hosts to try can either be taken from the address
23354 that is being processed (having been set up by the router), or specified
23355 explicitly for the transport. Timeout and retry processing (see chapter
23356 &<<CHAPretry>>&) is applied to each IP address independently.
23357
23358
23359 .section "Multiple messages on a single connection" "SECID144"
23360 The sending of multiple messages over a single TCP/IP connection can arise in
23361 two ways:
23362
23363 .ilist
23364 If a message contains more than &%max_rcpt%& (see below) addresses that are
23365 routed to the same host, more than one copy of the message has to be sent to
23366 that host. In this situation, multiple copies may be sent in a single run of
23367 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23368 does when it has too many addresses to send in one message also depends on the
23369 value of the global &%remote_max_parallel%& option. Details are given in
23370 section &<<SECToutSMTPTCP>>&.)
23371 .next
23372 .cindex "hints database" "remembering routing"
23373 When a message has been successfully delivered over a TCP/IP connection, Exim
23374 looks in its hints database to see if there are any other messages awaiting a
23375 connection to the same host. If there are, a new delivery process is started
23376 for one of them, and the current TCP/IP connection is passed on to it. The new
23377 process may in turn send multiple copies and possibly create yet another
23378 process.
23379 .endlist
23380
23381
23382 For each copy sent over the same TCP/IP connection, a sequence counter is
23383 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23384 no further messages are sent over that connection.
23385
23386
23387
23388 .section "Use of the $host and $host_address variables" "SECID145"
23389 .vindex "&$host$&"
23390 .vindex "&$host_address$&"
23391 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23392 &$host_address$& are the name and IP address of the first host on the host list
23393 passed by the router. However, when the transport is about to connect to a
23394 specific host, and while it is connected to that host, &$host$& and
23395 &$host_address$& are set to the values for that host. These are the values
23396 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23397 &%serialize_hosts%&, and the various TLS options are expanded.
23398
23399
23400 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23401 .vindex &$tls_bits$&
23402 .vindex &$tls_cipher$&
23403 .vindex &$tls_peerdn$&
23404 .vindex &$tls_sni$&
23405 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23406 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23407 are the values that were set when the message was received.
23408 These are the values that are used for options that are expanded before any
23409 SMTP connections are made. Just before each connection is made, these four
23410 variables are emptied. If TLS is subsequently started, they are set to the
23411 appropriate values for the outgoing connection, and these are the values that
23412 are in force when any authenticators are run and when the
23413 &%authenticated_sender%& option is expanded.
23414
23415 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23416 and will be removed in a future release.
23417
23418
23419 .section "Private options for smtp" "SECID146"
23420 .cindex "options" "&(smtp)& transport"
23421 The private options of the &(smtp)& transport are as follows:
23422
23423
23424 .option address_retry_include_sender smtp boolean true
23425 .cindex "4&'xx'& responses" "retrying after"
23426 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23427 is the combination of sender and recipient that is delayed in subsequent queue
23428 runs until the retry time is reached. You can delay the recipient without
23429 reference to the sender (which is what earlier versions of Exim did), by
23430 setting &%address_retry_include_sender%& false. However, this can lead to
23431 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23432
23433 .option allow_localhost smtp boolean false
23434 .cindex "local host" "sending to"
23435 .cindex "fallback" "hosts specified on transport"
23436 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23437 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23438 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23439 the delivery anyway. This should be used only in special cases when the
23440 configuration ensures that no looping will result (for example, a differently
23441 configured Exim is listening on the port to which the message is sent).
23442
23443
23444 .option authenticated_sender smtp string&!! unset
23445 .cindex "Cyrus"
23446 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23447 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23448 overriding any existing authenticated sender value. If the string expansion is
23449 forced to fail, the option is ignored. Other expansion failures cause delivery
23450 to be deferred. If the result of expansion is an empty string, that is also
23451 ignored.
23452
23453 The expansion happens after the outgoing connection has been made and TLS
23454 started, if required. This means that the &$host$&, &$host_address$&,
23455 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23456 particular connection.
23457
23458 If the SMTP session is not authenticated, the expansion of
23459 &%authenticated_sender%& still happens (and can cause the delivery to be
23460 deferred if it fails), but no AUTH= item is added to MAIL commands
23461 unless &%authenticated_sender_force%& is true.
23462
23463 This option allows you to use the &(smtp)& transport in LMTP mode to
23464 deliver mail to Cyrus IMAP and provide the proper local part as the
23465 &"authenticated sender"&, via a setting such as:
23466 .code
23467 authenticated_sender = $local_part
23468 .endd
23469 This removes the need for IMAP subfolders to be assigned special ACLs to
23470 allow direct delivery to those subfolders.
23471
23472 Because of expected uses such as that just described for Cyrus (when no
23473 domain is involved), there is no checking on the syntax of the provided
23474 value.
23475
23476
23477 .option authenticated_sender_force smtp boolean false
23478 If this option is set true, the &%authenticated_sender%& option's value
23479 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23480 authenticated as a client.
23481
23482
23483 .option command_timeout smtp time 5m
23484 This sets a timeout for receiving a response to an SMTP command that has been
23485 sent out. It is also used when waiting for the initial banner line from the
23486 remote host. Its value must not be zero.
23487
23488
23489 .option connect_timeout smtp time 5m
23490 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23491 to a remote host. A setting of zero allows the system timeout (typically
23492 several minutes) to act. To have any effect, the value of this option must be
23493 less than the system timeout. However, it has been observed that on some
23494 systems there is no system timeout, which is why the default value for this
23495 option is 5 minutes, a value recommended by RFC 1123.
23496
23497
23498 .option connection_max_messages smtp integer 500
23499 .cindex "SMTP" "passed connection"
23500 .cindex "SMTP" "multiple deliveries"
23501 .cindex "multiple SMTP deliveries"
23502 This controls the maximum number of separate message deliveries that are sent
23503 over a single TCP/IP connection. If the value is zero, there is no limit.
23504 For testing purposes, this value can be overridden by the &%-oB%& command line
23505 option.
23506
23507
23508 .option data_timeout smtp time 5m
23509 This sets a timeout for the transmission of each block in the data portion of
23510 the message. As a result, the overall timeout for a message depends on the size
23511 of the message. Its value must not be zero. See also &%final_timeout%&.
23512
23513
23514 .option dkim_domain smtp string&!! unset
23515 .option dkim_selector smtp string&!! unset
23516 .option dkim_private_key smtp string&!! unset
23517 .option dkim_canon smtp string&!! unset
23518 .option dkim_strict smtp string&!! unset
23519 .option dkim_sign_headers smtp string&!! unset
23520 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23521
23522
23523 .option delay_after_cutoff smtp boolean true
23524 This option controls what happens when all remote IP addresses for a given
23525 domain have been inaccessible for so long that they have passed their retry
23526 cutoff times.
23527
23528 In the default state, if the next retry time has not been reached for any of
23529 them, the address is bounced without trying any deliveries. In other words,
23530 Exim delays retrying an IP address after the final cutoff time until a new
23531 retry time is reached, and can therefore bounce an address without ever trying
23532 a delivery, when machines have been down for a long time. Some people are
23533 unhappy at this prospect, so...
23534
23535 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23536 addresses are past their final cutoff time, Exim tries to deliver to those
23537 IP addresses that have not been tried since the message arrived. If there are
23538 none, of if they all fail, the address is bounced. In other words, it does not
23539 delay when a new message arrives, but immediately tries those expired IP
23540 addresses that haven't been tried since the message arrived. If there is a
23541 continuous stream of messages for the dead hosts, unsetting
23542 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23543 to them.
23544
23545
23546 .option dns_qualify_single smtp boolean true
23547 If the &%hosts%& or &%fallback_hosts%& option is being used,
23548 and the &%gethostbyname%& option is false,
23549 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23550 in chapter &<<CHAPdnslookup>>& for more details.
23551
23552
23553 .option dns_search_parents smtp boolean false
23554 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23555 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23556 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23557 details.
23558
23559
23560 .option dnssec_request_domains smtp "domain list&!!" unset
23561 .cindex "MX record" "security"
23562 .cindex "DNSSEC" "MX lookup"
23563 .cindex "security" "MX lookup"
23564 .cindex "DNS" "DNSSEC"
23565 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23566 the dnssec request bit set.
23567 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23568
23569
23570
23571 .option dnssec_require_domains smtp "domain list&!!" unset
23572 .cindex "MX record" "security"
23573 .cindex "DNSSEC" "MX lookup"
23574 .cindex "security" "MX lookup"
23575 .cindex "DNS" "DNSSEC"
23576 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23577 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23578 (AD bit) set will be ignored and logged as a host-lookup failure.
23579 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23580
23581
23582
23583 .option dscp smtp string&!! unset
23584 .cindex "DCSP" "outbound"
23585 This option causes the DSCP value associated with a socket to be set to one
23586 of a number of fixed strings or to numeric value.
23587 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23588 Common values include &`throughput`&, &`mincost`&, and on newer systems
23589 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23590
23591 The outbound packets from Exim will be marked with this value in the header
23592 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23593 that these values will have any effect, not be stripped by networking
23594 equipment, or do much of anything without cooperation with your Network
23595 Engineer and those of all network operators between the source and destination.
23596
23597
23598 .option fallback_hosts smtp "string list" unset
23599 .cindex "fallback" "hosts specified on transport"
23600 String expansion is not applied to this option. The argument must be a
23601 colon-separated list of host names or IP addresses, optionally also including
23602 port numbers, though the separator can be changed, as described in section
23603 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23604 item in a &%route_list%& setting for the &(manualroute)& router, as described
23605 in section &<<SECTformatonehostitem>>&.
23606
23607 Fallback hosts can also be specified on routers, which associate them with the
23608 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23609 &%fallback_hosts%& specified on the transport is used only if the address does
23610 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23611 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23612 However, &%hosts_randomize%& does apply to fallback host lists.
23613
23614 If Exim is unable to deliver to any of the hosts for a particular address, and
23615 the errors are not permanent rejections, the address is put on a separate
23616 transport queue with its host list replaced by the fallback hosts, unless the
23617 address was routed via MX records and the current host was in the original MX
23618 list. In that situation, the fallback host list is not used.
23619
23620 Once normal deliveries are complete, the fallback queue is delivered by
23621 re-running the same transports with the new host lists. If several failing
23622 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23623 copy of the message is sent.
23624
23625 The resolution of the host names on the fallback list is controlled by the
23626 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23627 both to cases when the host list comes with the address and when it is taken
23628 from &%hosts%&. This option provides a &"use a smart host only if delivery
23629 fails"& facility.
23630
23631
23632 .option final_timeout smtp time 10m
23633 This is the timeout that applies while waiting for the response to the final
23634 line containing just &"."& that terminates a message. Its value must not be
23635 zero.
23636
23637 .option gethostbyname smtp boolean false
23638 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23639 being used, names are looked up using &[gethostbyname()]&
23640 (or &[getipnodebyname()]& when available)
23641 instead of using the DNS. Of course, that function may in fact use the DNS, but
23642 it may also consult other sources of information such as &_/etc/hosts_&.
23643
23644 .option gnutls_compat_mode smtp boolean unset
23645 This option controls whether GnuTLS is used in compatibility mode in an Exim
23646 server. This reduces security slightly, but improves interworking with older
23647 implementations of TLS.
23648
23649 .option helo_data smtp string&!! "see below"
23650 .cindex "HELO" "argument, setting"
23651 .cindex "EHLO" "argument, setting"
23652 .cindex "LHLO argument setting"
23653 The value of this option is expanded after a connection to a another host has
23654 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23655 command that starts the outgoing SMTP or LMTP session. The default value of the
23656 option is:
23657 .code
23658 $primary_hostname
23659 .endd
23660 During the expansion, the variables &$host$& and &$host_address$& are set to
23661 the identity of the remote host, and the variables &$sending_ip_address$& and
23662 &$sending_port$& are set to the local IP address and port number that are being
23663 used. These variables can be used to generate different values for different
23664 servers or different local IP addresses. For example, if you want the string
23665 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23666 interface address, you could use this:
23667 .code
23668 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23669   {$primary_hostname}}
23670 .endd
23671 The use of &%helo_data%& applies both to sending messages and when doing
23672 callouts.
23673
23674 .option hosts smtp "string list&!!" unset
23675 Hosts are associated with an address by a router such as &(dnslookup)&, which
23676 finds the hosts by looking up the address domain in the DNS, or by
23677 &(manualroute)&, which has lists of hosts in its configuration. However,
23678 email addresses can be passed to the &(smtp)& transport by any router, and not
23679 all of them can provide an associated list of hosts.
23680
23681 The &%hosts%& option specifies a list of hosts to be used if the address being
23682 processed does not have any hosts associated with it. The hosts specified by
23683 &%hosts%& are also used, whether or not the address has its own hosts, if
23684 &%hosts_override%& is set.
23685
23686 The string is first expanded, before being interpreted as a colon-separated
23687 list of host names or IP addresses, possibly including port numbers. The
23688 separator may be changed to something other than colon, as described in section
23689 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23690 item in a &%route_list%& setting for the &(manualroute)& router, as described
23691 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23692 of the &(manualroute)& router is not available here.
23693
23694 If the expansion fails, delivery is deferred. Unless the failure was caused by
23695 the inability to complete a lookup, the error is logged to the panic log as
23696 well as the main log. Host names are looked up either by searching directly for
23697 address records in the DNS or by calling &[gethostbyname()]& (or
23698 &[getipnodebyname()]& when available), depending on the setting of the
23699 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23700 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23701 address are used.
23702
23703 During delivery, the hosts are tried in order, subject to their retry status,
23704 unless &%hosts_randomize%& is set.
23705
23706
23707 .option hosts_avoid_esmtp smtp "host list&!!" unset
23708 .cindex "ESMTP, avoiding use of"
23709 .cindex "HELO" "forcing use of"
23710 .cindex "EHLO" "avoiding use of"
23711 .cindex "PIPELINING" "avoiding the use of"
23712 This option is for use with broken hosts that announce ESMTP facilities (for
23713 example, PIPELINING) and then fail to implement them properly. When a host
23714 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23715 start of the SMTP session. This means that it cannot use any of the ESMTP
23716 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23717
23718
23719 .option hosts_avoid_pipelining smtp "host list&!!" unset
23720 .cindex "PIPELINING" "avoiding the use of"
23721 Exim will not use the SMTP PIPELINING extension when delivering to any host
23722 that matches this list, even if the server host advertises PIPELINING support.
23723
23724
23725 .option hosts_avoid_tls smtp "host list&!!" unset
23726 .cindex "TLS" "avoiding for certain hosts"
23727 Exim will not try to start a TLS session when delivering to any host that
23728 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23729
23730 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23731 .cindex "TLS" "avoiding for certain hosts"
23732 Exim will not try to start a TLS session for a verify callout,
23733 or when delivering in cutthrough mode,
23734 to any host that matches this list.
23735
23736
23737 .option hosts_max_try smtp integer 5
23738 .cindex "host" "maximum number to try"
23739 .cindex "limit" "number of hosts tried"
23740 .cindex "limit" "number of MX tried"
23741 .cindex "MX record" "maximum tried"
23742 This option limits the number of IP addresses that are tried for any one
23743 delivery in cases where there are temporary delivery errors. Section
23744 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23745
23746
23747 .option hosts_max_try_hardlimit smtp integer 50
23748 This is an additional check on the maximum number of IP addresses that Exim
23749 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23750 why it exists.
23751
23752
23753
23754 .option hosts_nopass_tls smtp "host list&!!" unset
23755 .cindex "TLS" "passing connection"
23756 .cindex "multiple SMTP deliveries"
23757 .cindex "TLS" "multiple message deliveries"
23758 For any host that matches this list, a connection on which a TLS session has
23759 been started will not be passed to a new delivery process for sending another
23760 message on the same connection. See section &<<SECTmulmessam>>& for an
23761 explanation of when this might be needed.
23762
23763
23764 .option hosts_override smtp boolean false
23765 If this option is set and the &%hosts%& option is also set, any hosts that are
23766 attached to the address are ignored, and instead the hosts specified by the
23767 &%hosts%& option are always used. This option does not apply to
23768 &%fallback_hosts%&.
23769
23770
23771 .option hosts_randomize smtp boolean false
23772 .cindex "randomized host list"
23773 .cindex "host" "list of; randomized"
23774 .cindex "fallback" "randomized hosts"
23775 If this option is set, and either the list of hosts is taken from the
23776 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23777 were not obtained from MX records (this includes fallback hosts from the
23778 router), and were not randomized by the router, the order of trying the hosts
23779 is randomized each time the transport runs. Randomizing the order of a host
23780 list can be used to do crude load sharing.
23781
23782 When &%hosts_randomize%& is true, a host list may be split into groups whose
23783 order is separately randomized. This makes it possible to set up MX-like
23784 behaviour. The boundaries between groups are indicated by an item that is just
23785 &`+`& in the host list. For example:
23786 .code
23787 hosts = host1:host2:host3:+:host4:host5
23788 .endd
23789 The order of the first three hosts and the order of the last two hosts is
23790 randomized for each use, but the first three always end up before the last two.
23791 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23792
23793 .option hosts_require_auth smtp "host list&!!" unset
23794 .cindex "authentication" "required by client"
23795 This option provides a list of servers for which authentication must succeed
23796 before Exim will try to transfer a message. If authentication fails for
23797 servers which are not in this list, Exim tries to send unauthenticated. If
23798 authentication fails for one of these servers, delivery is deferred. This
23799 temporary error is detectable in the retry rules, so it can be turned into a
23800 hard failure if required. See also &%hosts_try_auth%&, and chapter
23801 &<<CHAPSMTPAUTH>>& for details of authentication.
23802
23803
23804 .option hosts_request_ocsp smtp "host list&!!" *
23805 .cindex "TLS" "requiring for certain servers"
23806 Exim will request a Certificate Status on a
23807 TLS session for any host that matches this list.
23808 &%tls_verify_certificates%& should also be set for the transport.
23809
23810 .option hosts_require_ocsp smtp "host list&!!" unset
23811 .cindex "TLS" "requiring for certain servers"
23812 Exim will request, and check for a valid Certificate Status being given, on a
23813 TLS session for any host that matches this list.
23814 &%tls_verify_certificates%& should also be set for the transport.
23815
23816 .option hosts_require_tls smtp "host list&!!" unset
23817 .cindex "TLS" "requiring for certain servers"
23818 Exim will insist on using a TLS session when delivering to any host that
23819 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23820 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23821 incoming messages, use an appropriate ACL.
23822
23823 .option hosts_try_auth smtp "host list&!!" unset
23824 .cindex "authentication" "optional in client"
23825 This option provides a list of servers to which, provided they announce
23826 authentication support, Exim will attempt to authenticate as a client when it
23827 connects. If authentication fails, Exim will try to transfer the message
23828 unauthenticated. See also &%hosts_require_auth%&, and chapter
23829 &<<CHAPSMTPAUTH>>& for details of authentication.
23830
23831 .option hosts_try_prdr smtp "host list&!!" *
23832 .cindex "PRDR" "enabling, optional in client"
23833 This option provides a list of servers to which, provided they announce
23834 PRDR support, Exim will attempt to negotiate PRDR
23835 for multi-recipient messages.
23836 The option can usually be left as default.
23837
23838 .option interface smtp "string list&!!" unset
23839 .cindex "bind IP address"
23840 .cindex "IP address" "binding"
23841 .vindex "&$host$&"
23842 .vindex "&$host_address$&"
23843 This option specifies which interface to bind to when making an outgoing SMTP
23844 call. The value is an IP address, not an interface name such as
23845 &`eth0`&. Do not confuse this with the interface address that was used when a
23846 message was received, which is in &$received_ip_address$&, formerly known as
23847 &$interface_address$&. The name was changed to minimize confusion with the
23848 outgoing interface address. There is no variable that contains an outgoing
23849 interface address because, unless it is set by this option, its value is
23850 unknown.
23851
23852 During the expansion of the &%interface%& option the variables &$host$& and
23853 &$host_address$& refer to the host to which a connection is about to be made
23854 during the expansion of the string. Forced expansion failure, or an empty
23855 string result causes the option to be ignored. Otherwise, after expansion, the
23856 string must be a list of IP addresses, colon-separated by default, but the
23857 separator can be changed in the usual way. For example:
23858 .code
23859 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23860 .endd
23861 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23862 connection. If none of them are the correct type, the option is ignored. If
23863 &%interface%& is not set, or is ignored, the system's IP functions choose which
23864 interface to use if the host has more than one.
23865
23866
23867 .option keepalive smtp boolean true
23868 .cindex "keepalive" "on outgoing connection"
23869 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23870 connections. When set, it causes the kernel to probe idle connections
23871 periodically, by sending packets with &"old"& sequence numbers. The other end
23872 of the connection should send a acknowledgment if the connection is still okay
23873 or a reset if the connection has been aborted. The reason for doing this is
23874 that it has the beneficial effect of freeing up certain types of connection
23875 that can get stuck when the remote host is disconnected without tidying up the
23876 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23877 unreachable hosts.
23878
23879
23880 .option lmtp_ignore_quota smtp boolean false
23881 .cindex "LMTP" "ignoring quota errors"
23882 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23883 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23884 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23885
23886 .option max_rcpt smtp integer 100
23887 .cindex "RCPT" "maximum number of outgoing"
23888 This option limits the number of RCPT commands that are sent in a single
23889 SMTP message transaction. Each set of addresses is treated independently, and
23890 so can cause parallel connections to the same host if &%remote_max_parallel%&
23891 permits this.
23892
23893
23894 .option multi_domain smtp boolean&!! true
23895 .vindex "&$domain$&"
23896 When this option is set, the &(smtp)& transport can handle a number of
23897 addresses containing a mixture of different domains provided they all resolve
23898 to the same list of hosts. Turning the option off restricts the transport to
23899 handling only one domain at a time. This is useful if you want to use
23900 &$domain$& in an expansion for the transport, because it is set only when there
23901 is a single domain involved in a remote delivery.
23902
23903 It is expanded per-address and can depend on any of
23904 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23905 &$host$&, &$host_address$& and &$host_port$&.
23906
23907 .option port smtp string&!! "see below"
23908 .cindex "port" "sending TCP/IP"
23909 .cindex "TCP/IP" "setting outgoing port"
23910 This option specifies the TCP/IP port on the server to which Exim connects.
23911 &*Note:*& Do not confuse this with the port that was used when a message was
23912 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23913 The name was changed to minimize confusion with the outgoing port. There is no
23914 variable that contains an outgoing port.
23915
23916 If the value of this option begins with a digit it is taken as a port number;
23917 otherwise it is looked up using &[getservbyname()]&. The default value is
23918 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23919 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23920 is deferred.
23921
23922
23923
23924 .option protocol smtp string smtp
23925 .cindex "LMTP" "over TCP/IP"
23926 .cindex "ssmtp protocol" "outbound"
23927 .cindex "TLS" "SSL-on-connect outbound"
23928 .vindex "&$port$&"
23929 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23930 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23931 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23932 deliveries into closed message stores. Exim also has support for running LMTP
23933 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23934
23935 If this option is set to &"smtps"&, the default value for the &%port%& option
23936 changes to &"smtps"&, and the transport initiates TLS immediately after
23937 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23938 The Internet standards bodies strongly discourage use of this mode.
23939
23940
23941 .option retry_include_ip_address smtp boolean&!! true
23942 Exim normally includes both the host name and the IP address in the key it
23943 constructs for indexing retry data after a temporary delivery failure. This
23944 means that when one of several IP addresses for a host is failing, it gets
23945 tried periodically (controlled by the retry rules), but use of the other IP
23946 addresses is not affected.
23947
23948 However, in some dialup environments hosts are assigned a different IP address
23949 each time they connect. In this situation the use of the IP address as part of
23950 the retry key leads to undesirable behaviour. Setting this option false causes
23951 Exim to use only the host name.
23952 Since it is expanded it can be made to depend on the host or domain.
23953
23954
23955 .option serialize_hosts smtp "host list&!!" unset
23956 .cindex "serializing connections"
23957 .cindex "host" "serializing connections"
23958 Because Exim operates in a distributed manner, if several messages for the same
23959 host arrive at around the same time, more than one simultaneous connection to
23960 the remote host can occur. This is not usually a problem except when there is a
23961 slow link between the hosts. In that situation it may be helpful to restrict
23962 Exim to one connection at a time. This can be done by setting
23963 &%serialize_hosts%& to match the relevant hosts.
23964
23965 .cindex "hints database" "serializing deliveries to a host"
23966 Exim implements serialization by means of a hints database in which a record is
23967 written whenever a process connects to one of the restricted hosts. The record
23968 is deleted when the connection is completed. Obviously there is scope for
23969 records to get left lying around if there is a system or program crash. To
23970 guard against this, Exim ignores any records that are more than six hours old.
23971
23972 If you set up this kind of serialization, you should also arrange to delete the
23973 relevant hints database whenever your system reboots. The names of the files
23974 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23975 may be one or two files, depending on the type of DBM in use. The same files
23976 are used for ETRN serialization.
23977
23978 .new
23979 See also the &%max_parallel%& generic transport option.
23980 .wen
23981
23982
23983 .option size_addition smtp integer 1024
23984 .cindex "SMTP" "SIZE"
23985 .cindex "message" "size issue for transport filter"
23986 .cindex "size" "of message"
23987 .cindex "transport" "filter"
23988 .cindex "filter" "transport filter"
23989 If a remote SMTP server indicates that it supports the SIZE option of the
23990 MAIL command, Exim uses this to pass over the message size at the start of
23991 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23992 sends, to allow for headers and other text that may be added during delivery by
23993 configuration options or in a transport filter. It may be necessary to increase
23994 this if a lot of text is added to messages.
23995
23996 Alternatively, if the value of &%size_addition%& is set negative, it disables
23997 the use of the SIZE option altogether.
23998
23999
24000 .new
24001 .option socks_proxy smtp string&!! unset
24002 .cindex proxy SOCKS
24003 This option enables use of SOCKS proxies for connections made by the
24004 transport.  For details see &<<SECTproxySOCKS>>&.
24005 .wen
24006
24007
24008 .option tls_certificate smtp string&!! unset
24009 .cindex "TLS" "client certificate, location of"
24010 .cindex "certificate" "client, location of"
24011 .vindex "&$host$&"
24012 .vindex "&$host_address$&"
24013 The value of this option must be the absolute path to a file which contains the
24014 client's certificate, for possible use when sending a message over an encrypted
24015 connection. The values of &$host$& and &$host_address$& are set to the name and
24016 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24017 details of TLS.
24018
24019 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24020 certificate when sending messages as a client. The global option of the same
24021 name specifies the certificate for Exim as a server; it is not automatically
24022 assumed that the same certificate should be used when Exim is operating as a
24023 client.
24024
24025
24026 .option tls_crl smtp string&!! unset
24027 .cindex "TLS" "client certificate revocation list"
24028 .cindex "certificate" "revocation list for client"
24029 This option specifies a certificate revocation list. The expanded value must
24030 be the name of a file that contains a CRL in PEM format.
24031
24032
24033 .option tls_dh_min_bits smtp integer 1024
24034 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24035 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24036 key agreement is negotiated, the server will provide a large prime number
24037 for use.  This option establishes the minimum acceptable size of that number.
24038 If the parameter offered by the server is too small, then the TLS handshake
24039 will fail.
24040
24041 Only supported when using GnuTLS.
24042
24043
24044 .option tls_privatekey smtp string&!! unset
24045 .cindex "TLS" "client private key, location of"
24046 .vindex "&$host$&"
24047 .vindex "&$host_address$&"
24048 The value of this option must be the absolute path to a file which contains the
24049 client's private key. This is used when sending a message over an encrypted
24050 connection using a client certificate. The values of &$host$& and
24051 &$host_address$& are set to the name and address of the server during the
24052 expansion. If this option is unset, or the expansion is forced to fail, or the
24053 result is an empty string, the private key is assumed to be in the same file as
24054 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24055
24056
24057 .option tls_require_ciphers smtp string&!! unset
24058 .cindex "TLS" "requiring specific ciphers"
24059 .cindex "cipher" "requiring specific"
24060 .vindex "&$host$&"
24061 .vindex "&$host_address$&"
24062 The value of this option must be a list of permitted cipher suites, for use
24063 when setting up an outgoing encrypted connection. (There is a global option of
24064 the same name for controlling incoming connections.) The values of &$host$& and
24065 &$host_address$& are set to the name and address of the server during the
24066 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24067 is used in different ways by OpenSSL and GnuTLS (see sections
24068 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24069 ciphers is a preference order.
24070
24071
24072
24073 .option tls_sni smtp string&!! unset
24074 .cindex "TLS" "Server Name Indication"
24075 .vindex "&$tls_sni$&"
24076 If this option is set then it sets the $tls_out_sni variable and causes any
24077 TLS session to pass this value as the Server Name Indication extension to
24078 the remote side, which can be used by the remote side to select an appropriate
24079 certificate and private key for the session.
24080
24081 See &<<SECTtlssni>>& for more information.
24082
24083 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24084 TLS extensions.
24085
24086
24087
24088
24089 .option tls_tempfail_tryclear smtp boolean true
24090 .cindex "4&'xx'& responses" "to STARTTLS"
24091 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24092 setting up a TLS session, this option determines whether or not Exim should try
24093 to deliver the message unencrypted. If it is set false, delivery to the
24094 current host is deferred; if there are other hosts, they are tried. If this
24095 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24096 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24097 TLS negotiation fails, Exim closes the current connection (because it is in an
24098 unknown state), opens a new one to the same host, and then tries the delivery
24099 in clear.
24100
24101
24102 .option tls_try_verify_hosts smtp "host list&!!" *
24103 .cindex "TLS" "server certificate verification"
24104 .cindex "certificate" "verification of server"
24105 This option gives a list of hosts for which, on encrypted connections,
24106 certificate verification will be tried but need not succeed.
24107 The &%tls_verify_certificates%& option must also be set.
24108 Note that unless the host is in this list
24109 TLS connections will be denied to hosts using self-signed certificates
24110 when &%tls_verify_certificates%& is matched.
24111 The &$tls_out_certificate_verified$& variable is set when
24112 certificate verification succeeds.
24113
24114
24115 .option tls_verify_cert_hostnames smtp "host list&!!" *
24116 .cindex "TLS" "server certificate hostname verification"
24117 .cindex "certificate" "verification of server"
24118 This option give a list of hosts for which,
24119 while verifying the server certificate,
24120 checks will be included on the host name
24121 (note that this will generally be the result of a DNS MX lookup)
24122 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24123 limited to being the initial component of a 3-or-more component FQDN.
24124
24125 There is no equivalent checking on client certificates.
24126
24127
24128 .option tls_verify_certificates smtp string&!! system
24129 .cindex "TLS" "server certificate verification"
24130 .cindex "certificate" "verification of server"
24131 .vindex "&$host$&"
24132 .vindex "&$host_address$&"
24133 The value of this option must be either the
24134 word "system"
24135 or the absolute path to
24136 a file or directory containing permitted certificates for servers,
24137 for use when setting up an encrypted connection.
24138
24139 The "system" value for the option will use a location compiled into the SSL library.
24140 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24141 is taken as empty and an explicit location
24142 must be specified.
24143
24144 The use of a directory for the option value is not available for GnuTLS versions
24145 preceding 3.3.6 and a single file must be used.
24146
24147 With OpenSSL the certificates specified
24148 explicitly
24149 either by file or directory
24150 are added to those given by the system default location.
24151
24152 The values of &$host$& and
24153 &$host_address$& are set to the name and address of the server during the
24154 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24155
24156 For back-compatibility,
24157 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24158 (a single-colon empty list counts as being set)
24159 and certificate verification fails the TLS connection is closed.
24160
24161
24162 .option tls_verify_hosts smtp "host list&!!" unset
24163 .cindex "TLS" "server certificate verification"
24164 .cindex "certificate" "verification of server"
24165 This option gives a list of hosts for which, on encrypted connections,
24166 certificate verification must succeed.
24167 The &%tls_verify_certificates%& option must also be set.
24168 If both this option and &%tls_try_verify_hosts%& are unset
24169 operation is as if this option selected all hosts.
24170
24171
24172
24173
24174 .section "How the limits for the number of hosts to try are used" &&&
24175          "SECTvalhosmax"
24176 .cindex "host" "maximum number to try"
24177 .cindex "limit" "hosts; maximum number tried"
24178 There are two options that are concerned with the number of hosts that are
24179 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24180 &%hosts_max_try_hardlimit%&.
24181
24182
24183 The &%hosts_max_try%& option limits the number of hosts that are tried
24184 for a single delivery. However, despite the term &"host"& in its name, the
24185 option actually applies to each IP address independently. In other words, a
24186 multihomed host is treated as several independent hosts, just as it is for
24187 retrying.
24188
24189 Many of the larger ISPs have multiple MX records which often point to
24190 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24191 created as a result of routing one of these domains.
24192
24193 Trying every single IP address on such a long list does not seem sensible; if
24194 several at the top of the list fail, it is reasonable to assume there is some
24195 problem that is likely to affect all of them. Roughly speaking, the value of
24196 &%hosts_max_try%& is the maximum number that are tried before deferring the
24197 delivery. However, the logic cannot be quite that simple.
24198
24199 Firstly, IP addresses that are skipped because their retry times have not
24200 arrived do not count, and in addition, addresses that are past their retry
24201 limits are also not counted, even when they are tried. This means that when
24202 some IP addresses are past their retry limits, more than the value of
24203 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24204 that all IP addresses are considered before timing out an email address (but
24205 see below for an exception).
24206
24207 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24208 list to see if there is a subsequent host with a different (higher valued) MX.
24209 If there is, that host is considered next, and the current IP address is used
24210 but not counted. This behaviour helps in the case of a domain with a retry rule
24211 that hardly ever delays any hosts, as is now explained:
24212
24213 Consider the case of a long list of hosts with one MX value, and a few with a
24214 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24215 hosts at the top of the list are tried at first. With the default retry rule,
24216 which specifies increasing retry times, the higher MX hosts are eventually
24217 tried when those at the top of the list are skipped because they have not
24218 reached their retry times.
24219
24220 However, it is common practice to put a fixed short retry time on domains for
24221 large ISPs, on the grounds that their servers are rarely down for very long.
24222 Unfortunately, these are exactly the domains that tend to resolve to long lists
24223 of hosts. The short retry time means that the lowest MX hosts are tried every
24224 time. The attempts may be in a different order because of random sorting, but
24225 without the special MX check, the higher MX hosts would never be tried until
24226 all the lower MX hosts had timed out (which might be several days), because
24227 there are always some lower MX hosts that have reached their retry times. With
24228 the special check, Exim considers at least one IP address from each MX value at
24229 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24230 reached.
24231
24232 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24233 particular, Exim normally eventually tries all the IP addresses before timing
24234 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24235 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24236 been set up with hundreds of IP addresses for some domains. It can
24237 take a very long time indeed for an address to time out in these cases.
24238
24239 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24240 Exim never tries more than this number of IP addresses; if it hits this limit
24241 and they are all timed out, the email address is bounced, even though not all
24242 possible IP addresses have been tried.
24243 .ecindex IIDsmttra1
24244 .ecindex IIDsmttra2
24245
24246
24247
24248
24249
24250 . ////////////////////////////////////////////////////////////////////////////
24251 . ////////////////////////////////////////////////////////////////////////////
24252
24253 .chapter "Address rewriting" "CHAPrewrite"
24254 .scindex IIDaddrew "rewriting" "addresses"
24255 There are some circumstances in which Exim automatically rewrites domains in
24256 addresses. The two most common are when an address is given without a domain
24257 (referred to as an &"unqualified address"&) or when an address contains an
24258 abbreviated domain that is expanded by DNS lookup.
24259
24260 Unqualified envelope addresses are accepted only for locally submitted
24261 messages, or for messages that are received from hosts matching
24262 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24263 appropriate. Unqualified addresses in header lines are qualified if they are in
24264 locally submitted messages, or messages from hosts that are permitted to send
24265 unqualified envelope addresses. Otherwise, unqualified addresses in header
24266 lines are neither qualified nor rewritten.
24267
24268 One situation in which Exim does &'not'& automatically rewrite a domain is
24269 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24270 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24271 do this. The new RFCs do not contain this suggestion.
24272
24273
24274 .section "Explicitly configured address rewriting" "SECID147"
24275 This chapter describes the rewriting rules that can be used in the
24276 main rewrite section of the configuration file, and also in the generic
24277 &%headers_rewrite%& option that can be set on any transport.
24278
24279 Some people believe that configured address rewriting is a Mortal Sin.
24280 Others believe that life is not possible without it. Exim provides the
24281 facility; you do not have to use it.
24282
24283 The main rewriting rules that appear in the &"rewrite"& section of the
24284 configuration file are applied to addresses in incoming messages, both envelope
24285 addresses and addresses in header lines. Each rule specifies the types of
24286 address to which it applies.
24287
24288 Whether or not addresses in header lines are rewritten depends on the origin of
24289 the headers and the type of rewriting. Global rewriting, that is, rewriting
24290 rules from the rewrite section of the configuration file, is applied only to
24291 those headers that were received with the message. Header lines that are added
24292 by ACLs or by a system filter or by individual routers or transports (which
24293 are specific to individual recipient addresses) are not rewritten by the global
24294 rules.
24295
24296 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24297 applies all headers except those added by routers and transports. That is, as
24298 well as the headers that were received with the message, it also applies to
24299 headers that were added by an ACL or a system filter.
24300
24301
24302 In general, rewriting addresses from your own system or domain has some
24303 legitimacy. Rewriting other addresses should be done only with great care and
24304 in special circumstances. The author of Exim believes that rewriting should be
24305 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24306 Although it can sometimes be used as a routing tool, this is very strongly
24307 discouraged.
24308
24309 There are two commonly encountered circumstances where rewriting is used, as
24310 illustrated by these examples:
24311
24312 .ilist
24313 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24314 exchange mail with each other behind a firewall, but there is only a single
24315 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24316 &'hitch.fict.example'& when sending mail off-site.
24317 .next
24318 A host rewrites the local parts of its own users so that, for example,
24319 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24320 .endlist
24321
24322
24323
24324 .section "When does rewriting happen?" "SECID148"
24325 .cindex "rewriting" "timing of"
24326 .cindex "&ACL;" "rewriting addresses in"
24327 Configured address rewriting can take place at several different stages of a
24328 message's processing.
24329
24330 .vindex "&$sender_address$&"
24331 At the start of an ACL for MAIL, the sender address may have been rewritten
24332 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24333 ordinary rewrite rules have yet been applied. If, however, the sender address
24334 is verified in the ACL, it is rewritten before verification, and remains
24335 rewritten thereafter. The subsequent value of &$sender_address$& is the
24336 rewritten address. This also applies if sender verification happens in a
24337 RCPT ACL. Otherwise, when the sender address is not verified, it is
24338 rewritten as soon as a message's header lines have been received.
24339
24340 .vindex "&$domain$&"
24341 .vindex "&$local_part$&"
24342 Similarly, at the start of an ACL for RCPT, the current recipient's address
24343 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24344 rewrite rules have yet been applied to it. However, the behaviour is different
24345 from the sender address when a recipient is verified. The address is rewritten
24346 for the verification, but the rewriting is not remembered at this stage. The
24347 value of &$local_part$& and &$domain$& after verification are always the same
24348 as they were before (that is, they contain the unrewritten &-- except for
24349 SMTP-time rewriting &-- address).
24350
24351 As soon as a message's header lines have been received, all the envelope
24352 recipient addresses are permanently rewritten, and rewriting is also applied to
24353 the addresses in the header lines (if configured). This happens before adding
24354 any header lines that were specified in MAIL or RCPT ACLs, and
24355 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24356 before the DATA ACL and &[local_scan()]& functions are run.
24357
24358 When an address is being routed, either for delivery or for verification,
24359 rewriting is applied immediately to child addresses that are generated by
24360 redirection, unless &%no_rewrite%& is set on the router.
24361
24362 .cindex "envelope sender" "rewriting at transport time"
24363 .cindex "rewriting" "at transport time"
24364 .cindex "header lines" "rewriting at transport time"
24365 At transport time, additional rewriting of addresses in header lines can be
24366 specified by setting the generic &%headers_rewrite%& option on a transport.
24367 This option contains rules that are identical in form to those in the rewrite
24368 section of the configuration file. They are applied to the original message
24369 header lines and any that were added by ACLs or a system filter. They are not
24370 applied to header lines that are added by routers or the transport.
24371
24372 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24373 transport option. However, it is not possible to rewrite envelope recipients at
24374 transport time.
24375
24376
24377
24378
24379 .section "Testing the rewriting rules that apply on input" "SECID149"
24380 .cindex "rewriting" "testing"
24381 .cindex "testing" "rewriting"
24382 Exim's input rewriting configuration appears in a part of the run time
24383 configuration file headed by &"begin rewrite"&. It can be tested by the
24384 &%-brw%& command line option. This takes an address (which can be a full RFC
24385 2822 address) as its argument. The output is a list of how the address would be
24386 transformed by the rewriting rules for each of the different places it might
24387 appear in an incoming message, that is, for each different header and for the
24388 envelope sender and recipient fields. For example,
24389 .code
24390 exim -brw ph10@exim.workshop.example
24391 .endd
24392 might produce the output
24393 .code
24394 sender: Philip.Hazel@exim.workshop.example
24395 from: Philip.Hazel@exim.workshop.example
24396 to: ph10@exim.workshop.example
24397 cc: ph10@exim.workshop.example
24398 bcc: ph10@exim.workshop.example
24399 reply-to: Philip.Hazel@exim.workshop.example
24400 env-from: Philip.Hazel@exim.workshop.example
24401 env-to: ph10@exim.workshop.example
24402 .endd
24403 which shows that rewriting has been set up for that address when used in any of
24404 the source fields, but not when it appears as a recipient address. At the
24405 present time, there is no equivalent way of testing rewriting rules that are
24406 set for a particular transport.
24407
24408
24409 .section "Rewriting rules" "SECID150"
24410 .cindex "rewriting" "rules"
24411 The rewrite section of the configuration file consists of lines of rewriting
24412 rules in the form
24413 .display
24414 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24415 .endd
24416 Rewriting rules that are specified for the &%headers_rewrite%& generic
24417 transport option are given as a colon-separated list. Each item in the list
24418 takes the same form as a line in the main rewriting configuration (except that
24419 any colons must be doubled, of course).
24420
24421 The formats of source patterns and replacement strings are described below.
24422 Each is terminated by white space, unless enclosed in double quotes, in which
24423 case normal quoting conventions apply inside the quotes. The flags are single
24424 characters which may appear in any order. Spaces and tabs between them are
24425 ignored.
24426
24427 For each address that could potentially be rewritten, the rules are scanned in
24428 order, and replacements for the address from earlier rules can themselves be
24429 replaced by later rules (but see the &"q"& and &"R"& flags).
24430
24431 The order in which addresses are rewritten is undefined, may change between
24432 releases, and must not be relied on, with one exception: when a message is
24433 received, the envelope sender is always rewritten first, before any header
24434 lines are rewritten. For example, the replacement string for a rewrite of an
24435 address in &'To:'& must not assume that the message's address in &'From:'& has
24436 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24437 that the envelope sender has already been rewritten.
24438
24439 .vindex "&$domain$&"
24440 .vindex "&$local_part$&"
24441 The variables &$local_part$& and &$domain$& can be used in the replacement
24442 string to refer to the address that is being rewritten. Note that lookup-driven
24443 rewriting can be done by a rule of the form
24444 .code
24445 *@*   ${lookup ...
24446 .endd
24447 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24448 refer to the address that is being rewritten.
24449
24450
24451 .section "Rewriting patterns" "SECID151"
24452 .cindex "rewriting" "patterns"
24453 .cindex "address list" "in a rewriting pattern"
24454 The source pattern in a rewriting rule is any item which may appear in an
24455 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24456 single-item address list, which means that it is expanded before being tested
24457 against the address. As always, if you use a regular expression as a pattern,
24458 you must take care to escape dollar and backslash characters, or use the &`\N`&
24459 facility to suppress string expansion within the regular expression.
24460
24461 Domains in patterns should be given in lower case. Local parts in patterns are
24462 case-sensitive. If you want to do case-insensitive matching of local parts, you
24463 can use a regular expression that starts with &`^(?i)`&.
24464
24465 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24466 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24467 depending on the type of match which occurred. These can be used in the
24468 replacement string to insert portions of the incoming address. &$0$& always
24469 refers to the complete incoming address. When a regular expression is used, the
24470 numerical variables are set from its capturing subexpressions. For other types
24471 of pattern they are set as follows:
24472
24473 .ilist
24474 If a local part or domain starts with an asterisk, the numerical variables
24475 refer to the character strings matched by asterisks, with &$1$& associated with
24476 the first asterisk, and &$2$& with the second, if present. For example, if the
24477 pattern
24478 .code
24479 *queen@*.fict.example
24480 .endd
24481 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24482 .code
24483 $0 = hearts-queen@wonderland.fict.example
24484 $1 = hearts-
24485 $2 = wonderland
24486 .endd
24487 Note that if the local part does not start with an asterisk, but the domain
24488 does, it is &$1$& that contains the wild part of the domain.
24489
24490 .next
24491 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24492 of the domain are placed in the next available numerical variables. Suppose,
24493 for example, that the address &'foo@bar.baz.example'& is processed by a
24494 rewriting rule of the form
24495 .display
24496 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24497 .endd
24498 and the key in the file that matches the domain is &`*.baz.example`&. Then
24499 .code
24500 $1 = foo
24501 $2 = bar
24502 $3 = baz.example
24503 .endd
24504 If the address &'foo@baz.example'& is looked up, this matches the same
24505 wildcard file entry, and in this case &$2$& is set to the empty string, but
24506 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24507 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24508 whole domain. For non-partial domain lookups, no numerical variables are set.
24509 .endlist
24510
24511
24512 .section "Rewriting replacements" "SECID152"
24513 .cindex "rewriting" "replacements"
24514 If the replacement string for a rule is a single asterisk, addresses that
24515 match the pattern and the flags are &'not'& rewritten, and no subsequent
24516 rewriting rules are scanned. For example,
24517 .code
24518 hatta@lookingglass.fict.example  *  f
24519 .endd
24520 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24521 &'From:'& headers.
24522
24523 .vindex "&$domain$&"
24524 .vindex "&$local_part$&"
24525 If the replacement string is not a single asterisk, it is expanded, and must
24526 yield a fully qualified address. Within the expansion, the variables
24527 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24528 Any letters they contain retain their original case &-- they are not lower
24529 cased. The numerical variables are set up according to the type of pattern that
24530 matched the address, as described above. If the expansion is forced to fail by
24531 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24532 current rule is abandoned, but subsequent rules may take effect. Any other
24533 expansion failure causes the entire rewriting operation to be abandoned, and an
24534 entry written to the panic log.
24535
24536
24537
24538 .section "Rewriting flags" "SECID153"
24539 There are three different kinds of flag that may appear on rewriting rules:
24540
24541 .ilist
24542 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24543 c, f, h, r, s, t.
24544 .next
24545 A flag that specifies rewriting at SMTP time: S.
24546 .next
24547 Flags that control the rewriting process: Q, q, R, w.
24548 .endlist
24549
24550 For rules that are part of the &%headers_rewrite%& generic transport option,
24551 E, F, T, and S are not permitted.
24552
24553
24554
24555 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24556          "SECID154"
24557 .cindex "rewriting" "flags"
24558 If none of the following flag letters, nor the &"S"& flag (see section
24559 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24560 and to both the sender and recipient fields of the envelope, whereas a
24561 transport-time rewriting rule just applies to all headers. Otherwise, the
24562 rewriting rule is skipped unless the relevant addresses are being processed.
24563 .display
24564 &`E`&       rewrite all envelope fields
24565 &`F`&       rewrite the envelope From field
24566 &`T`&       rewrite the envelope To field
24567 &`b`&       rewrite the &'Bcc:'& header
24568 &`c`&       rewrite the &'Cc:'& header
24569 &`f`&       rewrite the &'From:'& header
24570 &`h`&       rewrite all headers
24571 &`r`&       rewrite the &'Reply-To:'& header
24572 &`s`&       rewrite the &'Sender:'& header
24573 &`t`&       rewrite the &'To:'& header
24574 .endd
24575 "All headers" means all of the headers listed above that can be selected
24576 individually, plus their &'Resent-'& versions. It does not include
24577 other headers such as &'Subject:'& etc.
24578
24579 You should be particularly careful about rewriting &'Sender:'& headers, and
24580 restrict this to special known cases in your own domains.
24581
24582
24583 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24584 .cindex "SMTP" "rewriting malformed addresses"
24585 .cindex "RCPT" "rewriting argument of"
24586 .cindex "MAIL" "rewriting argument of"
24587 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24588 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24589 before any other processing; even before syntax checking. The pattern is
24590 required to be a regular expression, and it is matched against the whole of the
24591 data for the command, including any surrounding angle brackets.
24592
24593 .vindex "&$domain$&"
24594 .vindex "&$local_part$&"
24595 This form of rewrite rule allows for the handling of addresses that are not
24596 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24597 input). Because the input is not required to be a syntactically valid address,
24598 the variables &$local_part$& and &$domain$& are not available during the
24599 expansion of the replacement string. The result of rewriting replaces the
24600 original address in the MAIL or RCPT command.
24601
24602
24603 .section "Flags controlling the rewriting process" "SECID155"
24604 There are four flags which control the way the rewriting process works. These
24605 take effect only when a rule is invoked, that is, when the address is of the
24606 correct type (matches the flags) and matches the pattern:
24607
24608 .ilist
24609 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24610 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24611 absence of &"Q"& the rewritten address must always include a domain.
24612 .next
24613 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24614 even if no rewriting actually takes place because of a &"fail"& in the
24615 expansion. The &"q"& flag is not effective if the address is of the wrong type
24616 (does not match the flags) or does not match the pattern.
24617 .next
24618 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24619 address, up to ten times. It can be combined with the &"q"& flag, to stop
24620 rewriting once it fails to match (after at least one successful rewrite).
24621 .next
24622 .cindex "rewriting" "whole addresses"
24623 When an address in a header is rewritten, the rewriting normally applies only
24624 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24625 left unchanged. For example, rewriting might change
24626 .code
24627 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24628 .endd
24629 into
24630 .code
24631 From: Ford Prefect <prefectf@hitch.fict.example>
24632 .endd
24633 .cindex "RFC 2047"
24634 Sometimes there is a need to replace the whole address item, and this can be
24635 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24636 causes an address in a header line to be rewritten, the entire address is
24637 replaced, not just the working part. The replacement must be a complete RFC
24638 2822 address, including the angle brackets if necessary. If text outside angle
24639 brackets contains a character whose value is greater than 126 or less than 32
24640 (except for tab), the text is encoded according to RFC 2047. The character set
24641 is taken from &%headers_charset%&, which gets its default at build time.
24642
24643 When the &"w"& flag is set on a rule that causes an envelope address to be
24644 rewritten, all but the working part of the replacement address is discarded.
24645 .endlist
24646
24647
24648 .section "Rewriting examples" "SECID156"
24649 Here is an example of the two common rewriting paradigms:
24650 .code
24651 *@*.hitch.fict.example  $1@hitch.fict.example
24652 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24653                      {$value}fail}@hitch.fict.example bctfrF
24654 .endd
24655 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24656 the string expansion to fail if the lookup does not succeed. In this context it
24657 has the effect of leaving the original address unchanged, but Exim goes on to
24658 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24659 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24660 explicitly, which would cause the rewritten address to be the same as before,
24661 at the cost of a small bit of processing. Not supplying either of these is an
24662 error, since the rewritten address would then contain no local part.
24663
24664 The first example above replaces the domain with a superior, more general
24665 domain. This may not be desirable for certain local parts. If the rule
24666 .code
24667 root@*.hitch.fict.example  *
24668 .endd
24669 were inserted before the first rule, rewriting would be suppressed for the
24670 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24671
24672 Rewriting can be made conditional on a number of tests, by making use of
24673 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24674 messages that originate outside the local host:
24675 .code
24676 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24677                          {$1@hitch.fict.example}fail}"
24678 .endd
24679 The replacement string is quoted in this example because it contains white
24680 space.
24681
24682 .cindex "rewriting" "bang paths"
24683 .cindex "bang paths" "rewriting"
24684 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24685 an address it treats it as an unqualified local part which it qualifies with
24686 the local qualification domain (if the source of the message is local or if the
24687 remote host is permitted to send unqualified addresses). Rewriting can
24688 sometimes be used to handle simple bang paths with a fixed number of
24689 components. For example, the rule
24690 .code
24691 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24692 .endd
24693 rewrites a two-component bang path &'host.name!user'& as the domain address
24694 &'user@host.name'&. However, there is a security implication in using this as
24695 a global rewriting rule for envelope addresses. It can provide a backdoor
24696 method for using your system as a relay, because the incoming addresses appear
24697 to be local. If the bang path addresses are received via SMTP, it is safer to
24698 use the &"S"& flag to rewrite them as they are received, so that relay checking
24699 can be done on the rewritten addresses.
24700 .ecindex IIDaddrew
24701
24702
24703
24704
24705
24706 . ////////////////////////////////////////////////////////////////////////////
24707 . ////////////////////////////////////////////////////////////////////////////
24708
24709 .chapter "Retry configuration" "CHAPretry"
24710 .scindex IIDretconf1 "retry" "configuration, description of"
24711 .scindex IIDregconf2 "configuration file" "retry section"
24712 The &"retry"& section of the runtime configuration file contains a list of
24713 retry rules that control how often Exim tries to deliver messages that cannot
24714 be delivered at the first attempt. If there are no retry rules (the section is
24715 empty or not present), there are no retries. In this situation, temporary
24716 errors are treated as permanent. The default configuration contains a single,
24717 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24718 line option can be used to test which retry rule will be used for a given
24719 address, domain and error.
24720
24721 The most common cause of retries is temporary failure to deliver to a remote
24722 host because the host is down, or inaccessible because of a network problem.
24723 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24724 address) basis, not on a per-message basis. Thus, if one message has recently
24725 been delayed, delivery of a new message to the same host is not immediately
24726 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24727 log selector is set, the message
24728 .cindex "retry" "time not reached"
24729 &"retry time not reached"& is written to the main log whenever a delivery is
24730 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24731 the handling of errors during remote deliveries.
24732
24733 Retry processing applies to routing as well as to delivering, except as covered
24734 in the next paragraph. The retry rules do not distinguish between these
24735 actions. It is not possible, for example, to specify different behaviour for
24736 failures to route the domain &'snark.fict.example'& and failures to deliver to
24737 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24738 added complication, so did not implement it. However, although they share the
24739 same retry rule, the actual retry times for routing and transporting a given
24740 domain are maintained independently.
24741
24742 When a delivery is not part of a queue run (typically an immediate delivery on
24743 receipt of a message), the routers are always run, and local deliveries are
24744 always attempted, even if retry times are set for them. This makes for better
24745 behaviour if one particular message is causing problems (for example, causing
24746 quota overflow, or provoking an error in a filter file). If such a delivery
24747 suffers a temporary failure, the retry data is updated as normal, and
24748 subsequent delivery attempts from queue runs occur only when the retry time for
24749 the local address is reached.
24750
24751 .section "Changing retry rules" "SECID157"
24752 If you change the retry rules in your configuration, you should consider
24753 whether or not to delete the retry data that is stored in Exim's spool area in
24754 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24755 always safe; that is why they are called &"hints"&.
24756
24757 The hints retry data contains suggested retry times based on the previous
24758 rules. In the case of a long-running problem with a remote host, it might
24759 record the fact that the host has timed out. If your new rules increase the
24760 timeout time for such a host, you should definitely remove the old retry data
24761 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24762 messages that it should now be retaining.
24763
24764
24765
24766 .section "Format of retry rules" "SECID158"
24767 .cindex "retry" "rules"
24768 Each retry rule occupies one line and consists of three or four parts,
24769 separated by white space: a pattern, an error name, an optional list of sender
24770 addresses, and a list of retry parameters. The pattern and sender lists must be
24771 enclosed in double quotes if they contain white space. The rules are searched
24772 in order until one is found where the pattern, error name, and sender list (if
24773 present) match the failing host or address, the error that occurred, and the
24774 message's sender, respectively.
24775
24776
24777 The pattern is any single item that may appear in an address list (see section
24778 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24779 which means that it is expanded before being tested against the address that
24780 has been delayed. A negated address list item is permitted. Address
24781 list processing treats a plain domain name as if it were preceded by &"*@"&,
24782 which makes it possible for many retry rules to start with just a domain. For
24783 example,
24784 .code
24785 lookingglass.fict.example        *  F,24h,30m;
24786 .endd
24787 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24788 whereas
24789 .code
24790 alice@lookingglass.fict.example  *  F,24h,30m;
24791 .endd
24792 applies only to temporary failures involving the local part &%alice%&.
24793 In practice, almost all rules start with a domain name pattern without a local
24794 part.
24795
24796 .cindex "regular expressions" "in retry rules"
24797 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24798 must match a complete address, not just a domain, because that is how regular
24799 expressions work in address lists.
24800 .display
24801 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24802 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24803 .endd
24804
24805
24806 .section "Choosing which retry rule to use for address errors" "SECID159"
24807 When Exim is looking for a retry rule after a routing attempt has failed (for
24808 example, after a DNS timeout), each line in the retry configuration is tested
24809 against the complete address only if &%retry_use_local_part%& is set for the
24810 router. Otherwise, only the domain is used, except when matching against a
24811 regular expression, when the local part of the address is replaced with &"*"&.
24812 A domain on its own can match a domain pattern, or a pattern that starts with
24813 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24814 &%check_local_user%& is true, and false for other routers.
24815
24816 Similarly, when Exim is looking for a retry rule after a local delivery has
24817 failed (for example, after a mailbox full error), each line in the retry
24818 configuration is tested against the complete address only if
24819 &%retry_use_local_part%& is set for the transport (it defaults true for all
24820 local transports).
24821
24822 .cindex "4&'xx'& responses" "retry rules for"
24823 However, when Exim is looking for a retry rule after a remote delivery attempt
24824 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24825 whole address is always used as the key when searching the retry rules. The
24826 rule that is found is used to create a retry time for the combination of the
24827 failing address and the message's sender. It is the combination of sender and
24828 recipient that is delayed in subsequent queue runs until its retry time is
24829 reached. You can delay the recipient without regard to the sender by setting
24830 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24831 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24832 commands.
24833
24834
24835
24836 .section "Choosing which retry rule to use for host and message errors" &&&
24837          "SECID160"
24838 For a temporary error that is not related to an individual address (for
24839 example, a connection timeout), each line in the retry configuration is checked
24840 twice. First, the name of the remote host is used as a domain name (preceded by
24841 &"*@"& when matching a regular expression). If this does not match the line,
24842 the domain from the email address is tried in a similar fashion. For example,
24843 suppose the MX records for &'a.b.c.example'& are
24844 .code
24845 a.b.c.example  MX  5  x.y.z.example
24846                MX  6  p.q.r.example
24847                MX  7  m.n.o.example
24848 .endd
24849 and the retry rules are
24850 .code
24851 p.q.r.example    *      F,24h,30m;
24852 a.b.c.example    *      F,4d,45m;
24853 .endd
24854 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24855 first rule matches neither the host nor the domain, so Exim looks at the second
24856 rule. This does not match the host, but it does match the domain, so it is used
24857 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24858 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24859 first retry rule is used, because it matches the host.
24860
24861 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24862 first rule to determine retry times, but for all the other hosts for the domain
24863 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24864 routing to &'a.b.c.example'& suffers a temporary failure.
24865
24866 &*Note*&: The host name is used when matching the patterns, not its IP address.
24867 However, if a message is routed directly to an IP address without the use of a
24868 host name, for example, if a &(manualroute)& router contains a setting such as:
24869 .code
24870 route_list = *.a.example  192.168.34.23
24871 .endd
24872 then the &"host name"& that is used when searching for a retry rule is the
24873 textual form of the IP address.
24874
24875 .section "Retry rules for specific errors" "SECID161"
24876 .cindex "retry" "specific errors; specifying"
24877 The second field in a retry rule is the name of a particular error, or an
24878 asterisk, which matches any error. The errors that can be tested for are:
24879
24880 .vlist
24881 .vitem &%auth_failed%&
24882 Authentication failed when trying to send to a host in the
24883 &%hosts_require_auth%& list in an &(smtp)& transport.
24884
24885 .vitem &%data_4xx%&
24886 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24887 after the command, or after sending the message's data.
24888
24889 .vitem &%mail_4xx%&
24890 A 4&'xx'& error was received for an outgoing MAIL command.
24891
24892 .vitem &%rcpt_4xx%&
24893 A 4&'xx'& error was received for an outgoing RCPT command.
24894 .endlist
24895
24896 For the three 4&'xx'& errors, either the first or both of the x's can be given
24897 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24898 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24899 and have retries every ten minutes with a one-hour timeout, you could set up a
24900 retry rule of this form:
24901 .code
24902 the.domain.name  rcpt_452   F,1h,10m
24903 .endd
24904 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24905 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24906
24907 .vlist
24908 .vitem &%lost_connection%&
24909 A server unexpectedly closed the SMTP connection. There may, of course,
24910 legitimate reasons for this (host died, network died), but if it repeats a lot
24911 for the same host, it indicates something odd.
24912
24913 .vitem &%lookup%&
24914 A DNS lookup for a host failed.
24915 Note that a &%dnslookup%& router will need to have matched
24916 its &%fail_defer_domains%& option for this retry type to be usable.
24917 Also note that a &%manualroute%& router will probably need
24918 its &%host_find_failed%& option set to &%defer%&.
24919
24920 .vitem &%refused_MX%&
24921 A connection to a host obtained from an MX record was refused.
24922
24923 .vitem &%refused_A%&
24924 A connection to a host not obtained from an MX record was refused.
24925
24926 .vitem &%refused%&
24927 A connection was refused.
24928
24929 .vitem &%timeout_connect_MX%&
24930 A connection attempt to a host obtained from an MX record timed out.
24931
24932 .vitem &%timeout_connect_A%&
24933 A connection attempt to a host not obtained from an MX record timed out.
24934
24935 .vitem &%timeout_connect%&
24936 A connection attempt timed out.
24937
24938 .vitem &%timeout_MX%&
24939 There was a timeout while connecting or during an SMTP session with a host
24940 obtained from an MX record.
24941
24942 .vitem &%timeout_A%&
24943 There was a timeout while connecting or during an SMTP session with a host not
24944 obtained from an MX record.
24945
24946 .vitem &%timeout%&
24947 There was a timeout while connecting or during an SMTP session.
24948
24949 .vitem &%tls_required%&
24950 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24951 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24952 to STARTTLS, or there was a problem setting up the TLS connection.
24953
24954 .vitem &%quota%&
24955 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24956 transport.
24957
24958 .vitem &%quota_%&<&'time'&>
24959 .cindex "quota" "error testing in retry rule"
24960 .cindex "retry" "quota error testing"
24961 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24962 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24963 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24964 for four days.
24965 .endlist
24966
24967 .cindex "mailbox" "time of last read"
24968 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24969 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24970 it should be based on the last time that the user accessed the mailbox.
24971 However, it is not always possible to determine this. Exim uses the following
24972 heuristic rules:
24973
24974 .ilist
24975 If the mailbox is a single file, the time of last access (the &"atime"&) is
24976 used. As no new messages are being delivered (because the mailbox is over
24977 quota), Exim does not access the file, so this is the time of last user access.
24978 .next
24979 .cindex "maildir format" "time of last read"
24980 For a maildir delivery, the time of last modification of the &_new_&
24981 subdirectory is used. As the mailbox is over quota, no new files are created in
24982 the &_new_& subdirectory, because no new messages are being delivered. Any
24983 change to the &_new_& subdirectory is therefore assumed to be the result of an
24984 MUA moving a new message to the &_cur_& directory when it is first read. The
24985 time that is used is therefore the last time that the user read a new message.
24986 .next
24987 For other kinds of multi-file mailbox, the time of last access cannot be
24988 obtained, so a retry rule that uses this type of error field is never matched.
24989 .endlist
24990
24991 The quota errors apply both to system-enforced quotas and to Exim's own quota
24992 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24993 when a local delivery is deferred because a partition is full (the ENOSPC
24994 error).
24995
24996
24997
24998 .section "Retry rules for specified senders" "SECID162"
24999 .cindex "retry" "rules; sender-specific"
25000 You can specify retry rules that apply only when the failing message has a
25001 specific sender. In particular, this can be used to define retry rules that
25002 apply only to bounce messages. The third item in a retry rule can be of this
25003 form:
25004 .display
25005 &`senders=`&<&'address list'&>
25006 .endd
25007 The retry timings themselves are then the fourth item. For example:
25008 .code
25009 *   rcpt_4xx   senders=:   F,1h,30m
25010 .endd
25011 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25012 host. If the address list contains white space, it must be enclosed in quotes.
25013 For example:
25014 .code
25015 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25016 .endd
25017 &*Warning*&: This facility can be unhelpful if it is used for host errors
25018 (which do not depend on the recipient). The reason is that the sender is used
25019 only to match the retry rule. Once the rule has been found for a host error,
25020 its contents are used to set a retry time for the host, and this will apply to
25021 all messages, not just those with specific senders.
25022
25023 When testing retry rules using &%-brt%&, you can supply a sender using the
25024 &%-f%& command line option, like this:
25025 .code
25026 exim -f "" -brt user@dom.ain
25027 .endd
25028 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25029 list is never matched.
25030
25031
25032
25033
25034
25035 .section "Retry parameters" "SECID163"
25036 .cindex "retry" "parameters in rules"
25037 The third (or fourth, if a senders list is present) field in a retry rule is a
25038 sequence of retry parameter sets, separated by semicolons. Each set consists of
25039 .display
25040 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25041 .endd
25042 The letter identifies the algorithm for computing a new retry time; the cutoff
25043 time is the time beyond which this algorithm no longer applies, and the
25044 arguments vary the algorithm's action. The cutoff time is measured from the
25045 time that the first failure for the domain (combined with the local part if
25046 relevant) was detected, not from the time the message was received.
25047
25048 .cindex "retry" "algorithms"
25049 .cindex "retry" "fixed intervals"
25050 .cindex "retry" "increasing intervals"
25051 .cindex "retry" "random intervals"
25052 The available algorithms are:
25053
25054 .ilist
25055 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25056 the interval.
25057 .next
25058 &'G'&: retry at geometrically increasing intervals. The first argument
25059 specifies a starting value for the interval, and the second a multiplier, which
25060 is used to increase the size of the interval at each retry.
25061 .next
25062 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25063 retry, the previous interval is multiplied by the factor in order to get a
25064 maximum for the next interval. The minimum interval is the first argument of
25065 the parameter, and an actual interval is chosen randomly between them. Such a
25066 rule has been found to be helpful in cluster configurations when all the
25067 members of the cluster restart at once, and may therefore synchronize their
25068 queue processing times.
25069 .endlist
25070
25071 When computing the next retry time, the algorithm definitions are scanned in
25072 order until one whose cutoff time has not yet passed is reached. This is then
25073 used to compute a new retry time that is later than the current time. In the
25074 case of fixed interval retries, this simply means adding the interval to the
25075 current time. For geometrically increasing intervals, retry intervals are
25076 computed from the rule's parameters until one that is greater than the previous
25077 interval is found. The main configuration variable
25078 .cindex "limit" "retry interval"
25079 .cindex "retry" "interval, maximum"
25080 .oindex "&%retry_interval_max%&"
25081 &%retry_interval_max%& limits the maximum interval between retries. It
25082 cannot be set greater than &`24h`&, which is its default value.
25083
25084 A single remote domain may have a number of hosts associated with it, and each
25085 host may have more than one IP address. Retry algorithms are selected on the
25086 basis of the domain name, but are applied to each IP address independently. If,
25087 for example, a host has two IP addresses and one is unusable, Exim will
25088 generate retry times for it and will not try to use it until its next retry
25089 time comes. Thus the good IP address is likely to be tried first most of the
25090 time.
25091
25092 .cindex "hints database" "use for retrying"
25093 Retry times are hints rather than promises. Exim does not make any attempt to
25094 run deliveries exactly at the computed times. Instead, a queue runner process
25095 starts delivery processes for delayed messages periodically, and these attempt
25096 new deliveries only for those addresses that have passed their next retry time.
25097 If a new message arrives for a deferred address, an immediate delivery attempt
25098 occurs only if the address has passed its retry time. In the absence of new
25099 messages, the minimum time between retries is the interval between queue runner
25100 processes. There is not much point in setting retry times of five minutes if
25101 your queue runners happen only once an hour, unless there are a significant
25102 number of incoming messages (which might be the case on a system that is
25103 sending everything to a smart host, for example).
25104
25105 The data in the retry hints database can be inspected by using the
25106 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25107 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25108 &'exinext'& utility script can be used to find out what the next retry times
25109 are for the hosts associated with a particular mail domain, and also for local
25110 deliveries that have been deferred.
25111
25112
25113 .section "Retry rule examples" "SECID164"
25114 Here are some example retry rules:
25115 .code
25116 alice@wonderland.fict.example quota_5d  F,7d,3h
25117 wonderland.fict.example       quota_5d
25118 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25119 lookingglass.fict.example     *         F,24h,30m;
25120 *                 refused_A   F,2h,20m;
25121 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25122 .endd
25123 The first rule sets up special handling for mail to
25124 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25125 mailbox has not been read for at least 5 days. Retries continue every three
25126 hours for 7 days. The second rule handles over-quota errors for all other local
25127 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25128 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25129 fail are bounced immediately if the mailbox has not been read for at least 5
25130 days.
25131
25132 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25133 happen every 15 minutes for an hour, then with geometrically increasing
25134 intervals until two days have passed since a delivery first failed. After the
25135 first hour there is a delay of one hour, then two hours, then four hours, and
25136 so on (this is a rather extreme example).
25137
25138 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25139 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25140 all other domains, with special action for connection refusal from hosts that
25141 were not obtained from an MX record.
25142
25143 The final rule in a retry configuration should always have asterisks in the
25144 first two fields so as to provide a general catch-all for any addresses that do
25145 not have their own special handling. This example tries every 15 minutes for 2
25146 hours, then with intervals starting at one hour and increasing by a factor of
25147 1.5 up to 16 hours, then every 8 hours up to 5 days.
25148
25149
25150
25151 .section "Timeout of retry data" "SECID165"
25152 .cindex "timeout" "of retry data"
25153 .oindex "&%retry_data_expire%&"
25154 .cindex "hints database" "data expiry"
25155 .cindex "retry" "timeout of data"
25156 Exim timestamps the data that it writes to its retry hints database. When it
25157 consults the data during a delivery it ignores any that is older than the value
25158 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25159 been tried for 7 days, Exim will try to deliver to it immediately a message
25160 arrives, and if that fails, it will calculate a retry time as if it were
25161 failing for the first time.
25162
25163 This improves the behaviour for messages routed to rarely-used hosts such as MX
25164 backups. If such a host was down at one time, and happens to be down again when
25165 Exim tries a month later, using the old retry data would imply that it had been
25166 down all the time, which is not a justified assumption.
25167
25168 If a host really is permanently dead, this behaviour causes a burst of retries
25169 every now and again, but only if messages routed to it are rare. If there is a
25170 message at least once every 7 days the retry data never expires.
25171
25172
25173
25174
25175 .section "Long-term failures" "SECID166"
25176 .cindex "delivery failure, long-term"
25177 .cindex "retry" "after long-term failure"
25178 Special processing happens when an email address has been failing for so long
25179 that the cutoff time for the last algorithm is reached. For example, using the
25180 default retry rule:
25181 .code
25182 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25183 .endd
25184 the cutoff time is four days. Reaching the retry cutoff is independent of how
25185 long any specific message has been failing; it is the length of continuous
25186 failure for the recipient address that counts.
25187
25188 When the cutoff time is reached for a local delivery, or for all the IP
25189 addresses associated with a remote delivery, a subsequent delivery failure
25190 causes Exim to give up on the address, and a bounce message is generated.
25191 In order to cater for new messages that use the failing address, a next retry
25192 time is still computed from the final algorithm, and is used as follows:
25193
25194 For local deliveries, one delivery attempt is always made for any subsequent
25195 messages. If this delivery fails, the address fails immediately. The
25196 post-cutoff retry time is not used.
25197
25198 If the delivery is remote, there are two possibilities, controlled by the
25199 .oindex "&%delay_after_cutoff%&"
25200 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25201 default. Until the post-cutoff retry time for one of the IP addresses is
25202 reached, the failing email address is bounced immediately, without a delivery
25203 attempt taking place. After that time, one new delivery attempt is made to
25204 those IP addresses that are past their retry times, and if that still fails,
25205 the address is bounced and new retry times are computed.
25206
25207 In other words, when all the hosts for a given email address have been failing
25208 for a long time, Exim bounces rather then defers until one of the hosts' retry
25209 times is reached. Then it tries once, and bounces if that attempt fails. This
25210 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25211 to a broken destination, but if the host does recover, Exim will eventually
25212 notice.
25213
25214 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25215 addresses are past their final cutoff time, Exim tries to deliver to those IP
25216 addresses that have not been tried since the message arrived. If there are
25217 no suitable IP addresses, or if they all fail, the address is bounced. In other
25218 words, it does not delay when a new message arrives, but tries the expired
25219 addresses immediately, unless they have been tried since the message arrived.
25220 If there is a continuous stream of messages for the failing domains, setting
25221 &%delay_after_cutoff%& false means that there will be many more attempts to
25222 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25223 true.
25224
25225 .section "Deliveries that work intermittently" "SECID167"
25226 .cindex "retry" "intermittently working deliveries"
25227 Some additional logic is needed to cope with cases where a host is
25228 intermittently available, or when a message has some attribute that prevents
25229 its delivery when others to the same address get through. In this situation,
25230 because some messages are successfully delivered, the &"retry clock"& for the
25231 host or address keeps getting reset by the successful deliveries, and so
25232 failing messages remain on the queue for ever because the cutoff time is never
25233 reached.
25234
25235 Two exceptional actions are applied to prevent this happening. The first
25236 applies to errors that are related to a message rather than a remote host.
25237 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25238 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25239 commands, and quota failures. For this type of error, if a message's arrival
25240 time is earlier than the &"first failed"& time for the error, the earlier time
25241 is used when scanning the retry rules to decide when to try next and when to
25242 time out the address.
25243
25244 The exceptional second action applies in all cases. If a message has been on
25245 the queue for longer than the cutoff time of any applicable retry rule for a
25246 given address, a delivery is attempted for that address, even if it is not yet
25247 time, and if this delivery fails, the address is timed out. A new retry time is
25248 not computed in this case, so that other messages for the same address are
25249 considered immediately.
25250 .ecindex IIDretconf1
25251 .ecindex IIDregconf2
25252
25253
25254
25255
25256
25257
25258 . ////////////////////////////////////////////////////////////////////////////
25259 . ////////////////////////////////////////////////////////////////////////////
25260
25261 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25262 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25263 .scindex IIDauthconf2 "authentication"
25264 The &"authenticators"& section of Exim's run time configuration is concerned
25265 with SMTP authentication. This facility is an extension to the SMTP protocol,
25266 described in RFC 2554, which allows a client SMTP host to authenticate itself
25267 to a server. This is a common way for a server to recognize clients that are
25268 permitted to use it as a relay. SMTP authentication is not of relevance to the
25269 transfer of mail between servers that have no managerial connection with each
25270 other.
25271
25272 .cindex "AUTH" "description of"
25273 Very briefly, the way SMTP authentication works is as follows:
25274
25275 .ilist
25276 The server advertises a number of authentication &'mechanisms'& in response to
25277 the client's EHLO command.
25278 .next
25279 The client issues an AUTH command, naming a specific mechanism. The command
25280 may, optionally, contain some authentication data.
25281 .next
25282 The server may issue one or more &'challenges'&, to which the client must send
25283 appropriate responses. In simple authentication mechanisms, the challenges are
25284 just prompts for user names and passwords. The server does not have to issue
25285 any challenges &-- in some mechanisms the relevant data may all be transmitted
25286 with the AUTH command.
25287 .next
25288 The server either accepts or denies authentication.
25289 .next
25290 If authentication succeeds, the client may optionally make use of the AUTH
25291 option on the MAIL command to pass an authenticated sender in subsequent
25292 mail transactions. Authentication lasts for the remainder of the SMTP
25293 connection.
25294 .next
25295 If authentication fails, the client may give up, or it may try a different
25296 authentication mechanism, or it may try transferring mail over the
25297 unauthenticated connection.
25298 .endlist
25299
25300 If you are setting up a client, and want to know which authentication
25301 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25302 SMTP port) on the server, and issue an EHLO command. The response to this
25303 includes the list of supported mechanisms. For example:
25304 .display
25305 &`$ `&&*&`telnet server.example 25`&*&
25306 &`Trying 192.168.34.25...`&
25307 &`Connected to server.example.`&
25308 &`Escape character is &#x0027;^]&#x0027;.`&
25309 &`220 server.example ESMTP Exim 4.20 ...`&
25310 &*&`ehlo client.example`&*&
25311 &`250-server.example Hello client.example [10.8.4.5]`&
25312 &`250-SIZE 52428800`&
25313 &`250-PIPELINING`&
25314 &`250-AUTH PLAIN`&
25315 &`250 HELP`&
25316 .endd
25317 The second-last line of this example output shows that the server supports
25318 authentication using the PLAIN mechanism. In Exim, the different authentication
25319 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25320 routers and transports, which authenticators are included in the binary is
25321 controlled by build-time definitions. The following are currently available,
25322 included by setting
25323 .code
25324 AUTH_CRAM_MD5=yes
25325 AUTH_CYRUS_SASL=yes
25326 AUTH_DOVECOT=yes
25327 AUTH_GSASL=yes
25328 AUTH_HEIMDAL_GSSAPI=yes
25329 AUTH_PLAINTEXT=yes
25330 AUTH_SPA=yes
25331 AUTH_TLS=yes
25332 .endd
25333 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25334 authentication mechanism (RFC 2195), and the second provides an interface to
25335 the Cyrus SASL authentication library.
25336 The third is an interface to Dovecot's authentication system, delegating the
25337 work via a socket interface.
25338 The fourth provides an interface to the GNU SASL authentication library, which
25339 provides mechanisms but typically not data sources.
25340 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25341 supporting setting a server keytab.
25342 The sixth can be configured to support
25343 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25344 not formally documented, but used by several MUAs. The seventh authenticator
25345 supports Microsoft's &'Secure Password Authentication'& mechanism.
25346 The eighth is an Exim authenticator but not an SMTP one;
25347 instead it can use information from a TLS negotiation.
25348
25349 The authenticators are configured using the same syntax as other drivers (see
25350 section &<<SECTfordricon>>&). If no authenticators are required, no
25351 authentication section need be present in the configuration file. Each
25352 authenticator can in principle have both server and client functions. When Exim
25353 is receiving SMTP mail, it is acting as a server; when it is sending out
25354 messages over SMTP, it is acting as a client. Authenticator configuration
25355 options are provided for use in both these circumstances.
25356
25357 To make it clear which options apply to which situation, the prefixes
25358 &%server_%& and &%client_%& are used on option names that are specific to
25359 either the server or the client function, respectively. Server and client
25360 functions are disabled if none of their options are set. If an authenticator is
25361 to be used for both server and client functions, a single definition, using
25362 both sets of options, is required. For example:
25363 .code
25364 cram:
25365   driver = cram_md5
25366   public_name = CRAM-MD5
25367   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25368   client_name = ph10
25369   client_secret = secret2
25370 .endd
25371 The &%server_%& option is used when Exim is acting as a server, and the
25372 &%client_%& options when it is acting as a client.
25373
25374 Descriptions of the individual authenticators are given in subsequent chapters.
25375 The remainder of this chapter covers the generic options for the
25376 authenticators, followed by general discussion of the way authentication works
25377 in Exim.
25378
25379 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25380 per-mechanism basis.  Please read carefully to determine which variables hold
25381 account labels such as usercodes and which hold passwords or other
25382 authenticating data.
25383
25384 Note that some mechanisms support two different identifiers for accounts: the
25385 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25386 and &'authz'& are commonly encountered.  The American spelling is standard here.
25387 Conceptually, authentication data such as passwords are tied to the identifier
25388 used to authenticate; servers may have rules to permit one user to act as a
25389 second user, so that after login the session is treated as though that second
25390 user had logged in.  That second user is the &'authorization id'&.  A robust
25391 configuration might confirm that the &'authz'& field is empty or matches the
25392 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25393 as verified data, the &'authz'& as an unverified request which the server might
25394 choose to honour.
25395
25396 A &'realm'& is a text string, typically a domain name, presented by a server
25397 to a client to help it select an account and credentials to use.  In some
25398 mechanisms, the client and server provably agree on the realm, but clients
25399 typically can not treat the realm as secure data to be blindly trusted.
25400
25401
25402
25403 .section "Generic options for authenticators" "SECID168"
25404 .cindex "authentication" "generic options"
25405 .cindex "options" "generic; for authenticators"
25406
25407 .option client_condition authenticators string&!! unset
25408 When Exim is authenticating as a client, it skips any authenticator whose
25409 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25410 used, for example, to skip plain text authenticators when the connection is not
25411 encrypted by a setting such as:
25412 .code
25413 client_condition = ${if !eq{$tls_out_cipher}{}}
25414 .endd
25415
25416
25417 .option client_set_id authenticators string&!! unset
25418 When client authentication succeeds, this condition is expanded; the
25419 result is used in the log lines for outbound messages.
25420 Typically it will be the user name used for authentication.
25421
25422
25423 .option driver authenticators string unset
25424 This option must always be set. It specifies which of the available
25425 authenticators is to be used.
25426
25427
25428 .option public_name authenticators string unset
25429 This option specifies the name of the authentication mechanism that the driver
25430 implements, and by which it is known to the outside world. These names should
25431 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25432 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25433 defaults to the driver's instance name.
25434
25435
25436 .option server_advertise_condition authenticators string&!! unset
25437 When a server is about to advertise an authentication mechanism, the condition
25438 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25439 mechanism is not advertised.
25440 If the expansion fails, the mechanism is not advertised. If the failure was not
25441 forced, and was not caused by a lookup defer, the incident is logged.
25442 See section &<<SECTauthexiser>>& below for further discussion.
25443
25444
25445 .option server_condition authenticators string&!! unset
25446 This option must be set for a &%plaintext%& server authenticator, where it
25447 is used directly to control authentication. See section &<<SECTplainserver>>&
25448 for details.
25449
25450 For the &(gsasl)& authenticator, this option is required for various
25451 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25452
25453 For the other authenticators, &%server_condition%& can be used as an additional
25454 authentication or authorization mechanism that is applied after the other
25455 authenticator conditions succeed. If it is set, it is expanded when the
25456 authenticator would otherwise return a success code. If the expansion is forced
25457 to fail, authentication fails. Any other expansion failure causes a temporary
25458 error code to be returned. If the result of a successful expansion is an empty
25459 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25460 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25461 other result, a temporary error code is returned, with the expanded string as
25462 the error text.
25463
25464
25465 .option server_debug_print authenticators string&!! unset
25466 If this option is set and authentication debugging is enabled (see the &%-d%&
25467 command line option), the string is expanded and included in the debugging
25468 output when the authenticator is run as a server. This can help with checking
25469 out the values of variables.
25470 If expansion of the string fails, the error message is written to the debugging
25471 output, and Exim carries on processing.
25472
25473
25474 .option server_set_id authenticators string&!! unset
25475 .vindex "&$authenticated_id$&"
25476 When an Exim server successfully authenticates a client, this string is
25477 expanded using data from the authentication, and preserved for any incoming
25478 messages in the variable &$authenticated_id$&. It is also included in the log
25479 lines for incoming messages. For example, a user/password authenticator
25480 configuration might preserve the user name that was used to authenticate, and
25481 refer to it subsequently during delivery of the message.
25482 If expansion fails, the option is ignored.
25483
25484
25485 .option server_mail_auth_condition authenticators string&!! unset
25486 This option allows a server to discard authenticated sender addresses supplied
25487 as part of MAIL commands in SMTP connections that are authenticated by the
25488 driver on which &%server_mail_auth_condition%& is set. The option is not used
25489 as part of the authentication process; instead its (unexpanded) value is
25490 remembered for later use.
25491 How it is used is described in the following section.
25492
25493
25494
25495
25496
25497 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25498 .cindex "authentication" "sender; authenticated"
25499 .cindex "AUTH" "on MAIL command"
25500 When a client supplied an AUTH= item on a MAIL command, Exim applies
25501 the following checks before accepting it as the authenticated sender of the
25502 message:
25503
25504 .ilist
25505 If the connection is not using extended SMTP (that is, HELO was used rather
25506 than EHLO), the use of AUTH= is a syntax error.
25507 .next
25508 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25509 .next
25510 .vindex "&$authenticated_sender$&"
25511 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25512 running, the value of &$authenticated_sender$& is set to the value obtained
25513 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25514 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25515 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25516 given for the MAIL command.
25517 .next
25518 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25519 is accepted and placed in &$authenticated_sender$& only if the client has
25520 authenticated.
25521 .next
25522 If the AUTH= value was accepted by either of the two previous rules, and
25523 the client has authenticated, and the authenticator has a setting for the
25524 &%server_mail_auth_condition%&, the condition is checked at this point. The
25525 valued that was saved from the authenticator is expanded. If the expansion
25526 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25527 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25528 the value of &$authenticated_sender$& is retained and passed on with the
25529 message.
25530 .endlist
25531
25532
25533 When &$authenticated_sender$& is set for a message, it is passed on to other
25534 hosts to which Exim authenticates as a client. Do not confuse this value with
25535 &$authenticated_id$&, which is a string obtained from the authentication
25536 process, and which is not usually a complete email address.
25537
25538 .vindex "&$sender_address$&"
25539 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25540 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25541 therefore make use of &$authenticated_sender$&. The converse is not true: the
25542 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25543 ACL is run.
25544
25545
25546
25547 .section "Authentication on an Exim server" "SECTauthexiser"
25548 .cindex "authentication" "on an Exim server"
25549 When Exim receives an EHLO command, it advertises the public names of those
25550 authenticators that are configured as servers, subject to the following
25551 conditions:
25552
25553 .ilist
25554 The client host must match &%auth_advertise_hosts%& (default *).
25555 .next
25556 It the &%server_advertise_condition%& option is set, its expansion must not
25557 yield the empty string, &"0"&, &"no"&, or &"false"&.
25558 .endlist
25559
25560 The order in which the authenticators are defined controls the order in which
25561 the mechanisms are advertised.
25562
25563 Some mail clients (for example, some versions of Netscape) require the user to
25564 provide a name and password for authentication whenever AUTH is advertised,
25565 even though authentication may not in fact be needed (for example, Exim may be
25566 set up to allow unconditional relaying from the client by an IP address check).
25567 You can make such clients more friendly by not advertising AUTH to them.
25568 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25569 that runs for RCPT) to relay without authentication, you should set
25570 .code
25571 auth_advertise_hosts = ! 10.9.8.0/24
25572 .endd
25573 so that no authentication mechanisms are advertised to them.
25574
25575 The &%server_advertise_condition%& controls the advertisement of individual
25576 authentication mechanisms. For example, it can be used to restrict the
25577 advertisement of a particular mechanism to encrypted connections, by a setting
25578 such as:
25579 .code
25580 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25581 .endd
25582 .vindex "&$tls_in_cipher$&"
25583 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25584 yields &"yes"&, which allows the advertisement to happen.
25585
25586 When an Exim server receives an AUTH command from a client, it rejects it
25587 immediately if AUTH was not advertised in response to an earlier EHLO
25588 command. This is the case if
25589
25590 .ilist
25591 The client host does not match &%auth_advertise_hosts%&; or
25592 .next
25593 No authenticators are configured with server options; or
25594 .next
25595 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25596 server authenticators.
25597 .endlist
25598
25599
25600 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25601 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25602 AUTH is accepted from any client host.
25603
25604 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25605 server authentication mechanism that was advertised in response to EHLO and
25606 that matches the one named in the AUTH command. If it finds one, it runs
25607 the appropriate authentication protocol, and authentication either succeeds or
25608 fails. If there is no matching advertised mechanism, the AUTH command is
25609 rejected with a 504 error.
25610
25611 .vindex "&$received_protocol$&"
25612 .vindex "&$sender_host_authenticated$&"
25613 When a message is received from an authenticated host, the value of
25614 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25615 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25616 public name) of the authenticator driver that successfully authenticated the
25617 client from which the message was received. This variable is empty if there was
25618 no successful authentication.
25619
25620
25621
25622
25623 .section "Testing server authentication" "SECID169"
25624 .cindex "authentication" "testing a server"
25625 .cindex "AUTH" "testing a server"
25626 .cindex "base64 encoding" "creating authentication test data"
25627 Exim's &%-bh%& option can be useful for testing server authentication
25628 configurations. The data for the AUTH command has to be sent using base64
25629 encoding. A quick way to produce such data for testing is the following Perl
25630 script:
25631 .code
25632 use MIME::Base64;
25633 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25634 .endd
25635 .cindex "binary zero" "in authentication data"
25636 This interprets its argument as a Perl string, and then encodes it. The
25637 interpretation as a Perl string allows binary zeros, which are required for
25638 some kinds of authentication, to be included in the data. For example, a
25639 command line to run this script on such data might be
25640 .code
25641 encode '\0user\0password'
25642 .endd
25643 Note the use of single quotes to prevent the shell interpreting the
25644 backslashes, so that they can be interpreted by Perl to specify characters
25645 whose code value is zero.
25646
25647 &*Warning 1*&: If either of the user or password strings starts with an octal
25648 digit, you must use three zeros instead of one after the leading backslash. If
25649 you do not, the octal digit that starts your string will be incorrectly
25650 interpreted as part of the code for the first character.
25651
25652 &*Warning 2*&: If there are characters in the strings that Perl interprets
25653 specially, you must use a Perl escape to prevent them being misinterpreted. For
25654 example, a command such as
25655 .code
25656 encode '\0user@domain.com\0pas$$word'
25657 .endd
25658 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25659
25660 If you have the &%mimencode%& command installed, another way to do produce
25661 base64-encoded strings is to run the command
25662 .code
25663 echo -e -n `\0user\0password' | mimencode
25664 .endd
25665 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25666 in the argument, and the &%-n%& option specifies no newline at the end of its
25667 output. However, not all versions of &%echo%& recognize these options, so you
25668 should check your version before relying on this suggestion.
25669
25670
25671
25672 .section "Authentication by an Exim client" "SECID170"
25673 .cindex "authentication" "on an Exim client"
25674 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25675 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25676 announces support for authentication, and the host matches an entry in either
25677 of these options, Exim (as a client) tries to authenticate as follows:
25678
25679 .ilist
25680 For each authenticator that is configured as a client, in the order in which
25681 they are defined in the configuration, it searches the authentication
25682 mechanisms announced by the server for one whose name matches the public name
25683 of the authenticator.
25684 .next
25685 .vindex "&$host$&"
25686 .vindex "&$host_address$&"
25687 When it finds one that matches, it runs the authenticator's client code. The
25688 variables &$host$& and &$host_address$& are available for any string expansions
25689 that the client might do. They are set to the server's name and IP address. If
25690 any expansion is forced to fail, the authentication attempt is abandoned, and
25691 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25692 delivery to be deferred.
25693 .next
25694 If the result of the authentication attempt is a temporary error or a timeout,
25695 Exim abandons trying to send the message to the host for the moment. It will
25696 try again later. If there are any backup hosts available, they are tried in the
25697 usual way.
25698 .next
25699 If the response to authentication is a permanent error (5&'xx'& code), Exim
25700 carries on searching the list of authenticators and tries another one if
25701 possible. If all authentication attempts give permanent errors, or if there are
25702 no attempts because no mechanisms match (or option expansions force failure),
25703 what happens depends on whether the host matches &%hosts_require_auth%& or
25704 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25705 delivery is deferred. The error can be detected in the retry rules, and thereby
25706 turned into a permanent error if you wish. In the second case, Exim tries to
25707 deliver the message unauthenticated.
25708 .endlist
25709
25710 .cindex "AUTH" "on MAIL command"
25711 When Exim has authenticated itself to a remote server, it adds the AUTH
25712 parameter to the MAIL commands it sends, if it has an authenticated sender for
25713 the message. If the message came from a remote host, the authenticated sender
25714 is the one that was receiving on an incoming MAIL command, provided that the
25715 incoming connection was authenticated and the &%server_mail_auth%& condition
25716 allowed the authenticated sender to be retained. If a local process calls Exim
25717 to send a message, the sender address that is built from the login name and
25718 &%qualify_domain%& is treated as authenticated. However, if the
25719 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25720 the authenticated sender that was received with the message.
25721 .ecindex IIDauthconf1
25722 .ecindex IIDauthconf2
25723
25724
25725
25726
25727
25728
25729 . ////////////////////////////////////////////////////////////////////////////
25730 . ////////////////////////////////////////////////////////////////////////////
25731
25732 .chapter "The plaintext authenticator" "CHAPplaintext"
25733 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25734 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25735 The &(plaintext)& authenticator can be configured to support the PLAIN and
25736 LOGIN authentication mechanisms, both of which transfer authentication data as
25737 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25738 security risk; you are strongly advised to insist on the use of SMTP encryption
25739 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25740 use unencrypted plain text, you should not use the same passwords for SMTP
25741 connections as you do for login accounts.
25742
25743 .section "Plaintext options" "SECID171"
25744 .cindex "options" "&(plaintext)& authenticator (server)"
25745 When configured as a server, &(plaintext)& uses the following options:
25746
25747 .option server_condition authenticators string&!! unset
25748 This is actually a global authentication option, but it must be set in order to
25749 configure the &(plaintext)& driver as a server. Its use is described below.
25750
25751 .option server_prompts plaintext string&!! unset
25752 The contents of this option, after expansion, must be a colon-separated list of
25753 prompt strings. If expansion fails, a temporary authentication rejection is
25754 given.
25755
25756 .section "Using plaintext in a server" "SECTplainserver"
25757 .cindex "AUTH" "in &(plaintext)& authenticator"
25758 .cindex "binary zero" "in &(plaintext)& authenticator"
25759 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25760         "in &(plaintext)& authenticator"
25761 .vindex "&$auth1$&, &$auth2$&, etc"
25762 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25763
25764 When running as a server, &(plaintext)& performs the authentication test by
25765 expanding a string. The data sent by the client with the AUTH command, or in
25766 response to subsequent prompts, is base64 encoded, and so may contain any byte
25767 values when decoded. If any data is supplied with the command, it is treated as
25768 a list of strings, separated by NULs (binary zeros), the first three of which
25769 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25770 (neither LOGIN nor PLAIN uses more than three strings).
25771
25772 For compatibility with previous releases of Exim, the values are also placed in
25773 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25774 variables for this purpose is now deprecated, as it can lead to confusion in
25775 string expansions that also use them for other things.
25776
25777 If there are more strings in &%server_prompts%& than the number of strings
25778 supplied with the AUTH command, the remaining prompts are used to obtain more
25779 data. Each response from the client may be a list of NUL-separated strings.
25780
25781 .vindex "&$authenticated_id$&"
25782 Once a sufficient number of data strings have been received,
25783 &%server_condition%& is expanded. If the expansion is forced to fail,
25784 authentication fails. Any other expansion failure causes a temporary error code
25785 to be returned. If the result of a successful expansion is an empty string,
25786 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25787 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25788 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25789 For any other result, a temporary error code is returned, with the expanded
25790 string as the error text
25791
25792 &*Warning*&: If you use a lookup in the expansion to find the user's
25793 password, be sure to make the authentication fail if the user is unknown.
25794 There are good and bad examples at the end of the next section.
25795
25796
25797
25798 .section "The PLAIN authentication mechanism" "SECID172"
25799 .cindex "PLAIN authentication mechanism"
25800 .cindex "authentication" "PLAIN mechanism"
25801 .cindex "binary zero" "in &(plaintext)& authenticator"
25802 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25803 sent as one item of data (that is, one combined string containing two NUL
25804 separators). The data is sent either as part of the AUTH command, or
25805 subsequently in response to an empty prompt from the server.
25806
25807 The second and third strings are a user name and a corresponding password.
25808 Using a single fixed user name and password as an example, this could be
25809 configured as follows:
25810 .code
25811 fixed_plain:
25812   driver = plaintext
25813   public_name = PLAIN
25814   server_prompts = :
25815   server_condition = \
25816     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25817   server_set_id = $auth2
25818 .endd
25819 Note that the default result strings from &%if%& (&"true"& or an empty string)
25820 are exactly what we want here, so they need not be specified. Obviously, if the
25821 password contains expansion-significant characters such as dollar, backslash,
25822 or closing brace, they have to be escaped.
25823
25824 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25825 the end of a string list are ignored). If all the data comes as part of the
25826 AUTH command, as is commonly the case, the prompt is not used. This
25827 authenticator is advertised in the response to EHLO as
25828 .code
25829 250-AUTH PLAIN
25830 .endd
25831 and a client host can authenticate itself by sending the command
25832 .code
25833 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25834 .endd
25835 As this contains three strings (more than the number of prompts), no further
25836 data is required from the client. Alternatively, the client may just send
25837 .code
25838 AUTH PLAIN
25839 .endd
25840 to initiate authentication, in which case the server replies with an empty
25841 prompt. The client must respond with the combined data string.
25842
25843 The data string is base64 encoded, as required by the RFC. This example,
25844 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25845 represents a zero byte. This is split up into three strings, the first of which
25846 is empty. The &%server_condition%& option in the authenticator checks that the
25847 second two are &`username`& and &`mysecret`& respectively.
25848
25849 Having just one fixed user name and password, as in this example, is not very
25850 realistic, though for a small organization with only a handful of
25851 authenticating clients it could make sense.
25852
25853 A more sophisticated instance of this authenticator could use the user name in
25854 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25855 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25856 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25857 This is an incorrect example:
25858 .code
25859 server_condition = \
25860   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25861 .endd
25862 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25863 which it then compares to the supplied password (&$auth3$&). Why is this example
25864 incorrect? It works fine for existing users, but consider what happens if a
25865 non-existent user name is given. The lookup fails, but as no success/failure
25866 strings are given for the lookup, it yields an empty string. Thus, to defeat
25867 the authentication, all a client has to do is to supply a non-existent user
25868 name and an empty password. The correct way of writing this test is:
25869 .code
25870 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25871   {${if eq{$value}{$auth3}}} {false}}
25872 .endd
25873 In this case, if the lookup succeeds, the result is checked; if the lookup
25874 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25875 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25876 always fails if its second argument is empty. However, the second way of
25877 writing the test makes the logic clearer.
25878
25879
25880 .section "The LOGIN authentication mechanism" "SECID173"
25881 .cindex "LOGIN authentication mechanism"
25882 .cindex "authentication" "LOGIN mechanism"
25883 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25884 in a number of programs. No data is sent with the AUTH command. Instead, a
25885 user name and password are supplied separately, in response to prompts. The
25886 plaintext authenticator can be configured to support this as in this example:
25887 .code
25888 fixed_login:
25889   driver = plaintext
25890   public_name = LOGIN
25891   server_prompts = User Name : Password
25892   server_condition = \
25893     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25894   server_set_id = $auth1
25895 .endd
25896 Because of the way plaintext operates, this authenticator accepts data supplied
25897 with the AUTH command (in contravention of the specification of LOGIN), but
25898 if the client does not supply it (as is the case for LOGIN clients), the prompt
25899 strings are used to obtain two data items.
25900
25901 Some clients are very particular about the precise text of the prompts. For
25902 example, Outlook Express is reported to recognize only &"Username:"& and
25903 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25904 strings. It uses the &%ldapauth%& expansion condition to check the user
25905 name and password by binding to an LDAP server:
25906 .code
25907 login:
25908   driver = plaintext
25909   public_name = LOGIN
25910   server_prompts = Username:: : Password::
25911   server_condition = ${if and{{ \
25912     !eq{}{$auth1} }{ \
25913     ldapauth{\
25914       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25915       pass=${quote:$auth2} \
25916       ldap://ldap.example.org/} }} }
25917   server_set_id = uid=$auth1,ou=people,o=example.org
25918 .endd
25919 We have to check that the username is not empty before using it, because LDAP
25920 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25921 operator to correctly quote the DN for authentication. However, the basic
25922 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25923 correct one to use for the password, because quoting is needed only to make
25924 the password conform to the Exim syntax. At the LDAP level, the password is an
25925 uninterpreted string.
25926
25927
25928 .section "Support for different kinds of authentication" "SECID174"
25929 A number of string expansion features are provided for the purpose of
25930 interfacing to different ways of user authentication. These include checking
25931 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25932 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25933 &<<SECTexpcond>>&.
25934
25935
25936
25937
25938 .section "Using plaintext in a client" "SECID175"
25939 .cindex "options" "&(plaintext)& authenticator (client)"
25940 The &(plaintext)& authenticator has two client options:
25941
25942 .option client_ignore_invalid_base64 plaintext boolean false
25943 If the client receives a server prompt that is not a valid base64 string,
25944 authentication is abandoned by default. However, if this option is set true,
25945 the error in the challenge is ignored and the client sends the response as
25946 usual.
25947
25948 .option client_send plaintext string&!! unset
25949 The string is a colon-separated list of authentication data strings. Each
25950 string is independently expanded before being sent to the server. The first
25951 string is sent with the AUTH command; any more strings are sent in response
25952 to prompts from the server. Before each string is expanded, the value of the
25953 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25954 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25955 way. Thus, the prompt that is received in response to sending the first string
25956 (with the AUTH command) can be used in the expansion of the second string, and
25957 so on. If an invalid base64 string is received when
25958 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25959 &$auth$&<&'n'&> variable.
25960
25961 &*Note*&: You cannot use expansion to create multiple strings, because
25962 splitting takes priority and happens first.
25963
25964 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25965 the data, further processing is applied to each string before it is sent. If
25966 there are any single circumflex characters in the string, they are converted to
25967 NULs. Should an actual circumflex be required as data, it must be doubled in
25968 the string.
25969
25970 This is an example of a client configuration that implements the PLAIN
25971 authentication mechanism with a fixed user name and password:
25972 .code
25973 fixed_plain:
25974   driver = plaintext
25975   public_name = PLAIN
25976   client_send = ^username^mysecret
25977 .endd
25978 The lack of colons means that the entire text is sent with the AUTH
25979 command, with the circumflex characters converted to NULs. A similar example
25980 that uses the LOGIN mechanism is:
25981 .code
25982 fixed_login:
25983   driver = plaintext
25984   public_name = LOGIN
25985   client_send = : username : mysecret
25986 .endd
25987 The initial colon means that the first string is empty, so no data is sent with
25988 the AUTH command itself. The remaining strings are sent in response to
25989 prompts.
25990 .ecindex IIDplaiauth1
25991 .ecindex IIDplaiauth2
25992
25993
25994
25995
25996 . ////////////////////////////////////////////////////////////////////////////
25997 . ////////////////////////////////////////////////////////////////////////////
25998
25999 .chapter "The cram_md5 authenticator" "CHID9"
26000 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26001 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26002 .cindex "CRAM-MD5 authentication mechanism"
26003 .cindex "authentication" "CRAM-MD5 mechanism"
26004 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26005 sends a challenge string to the client, and the response consists of a user
26006 name and the CRAM-MD5 digest of the challenge string combined with a secret
26007 string (password) which is known to both server and client. Thus, the secret
26008 is not sent over the network as plain text, which makes this authenticator more
26009 secure than &(plaintext)&. However, the downside is that the secret has to be
26010 available in plain text at either end.
26011
26012
26013 .section "Using cram_md5 as a server" "SECID176"
26014 .cindex "options" "&(cram_md5)& authenticator (server)"
26015 This authenticator has one server option, which must be set to configure the
26016 authenticator as a server:
26017
26018 .option server_secret cram_md5 string&!! unset
26019 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26020 When the server receives the client's response, the user name is placed in
26021 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26022 obtain the password for that user. The server then computes the CRAM-MD5 digest
26023 that the client should have sent, and checks that it received the correct
26024 string. If the expansion of &%server_secret%& is forced to fail, authentication
26025 fails. If the expansion fails for some other reason, a temporary error code is
26026 returned to the client.
26027
26028 For compatibility with previous releases of Exim, the user name is also placed
26029 in &$1$&. However, the use of this variables for this purpose is now
26030 deprecated, as it can lead to confusion in string expansions that also use
26031 numeric variables for other things.
26032
26033 For example, the following authenticator checks that the user name given by the
26034 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26035 user name, authentication fails.
26036 .code
26037 fixed_cram:
26038   driver = cram_md5
26039   public_name = CRAM-MD5
26040   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26041   server_set_id = $auth1
26042 .endd
26043 .vindex "&$authenticated_id$&"
26044 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26045 name in &$authenticated_id$&. A more typical configuration might look up the
26046 secret string in a file, using the user name as the key. For example:
26047 .code
26048 lookup_cram:
26049   driver = cram_md5
26050   public_name = CRAM-MD5
26051   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26052                   {$value}fail}
26053   server_set_id = $auth1
26054 .endd
26055 Note that this expansion explicitly forces failure if the lookup fails
26056 because &$auth1$& contains an unknown user name.
26057
26058 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26059 using the relevant libraries, you need to know the realm to specify in the
26060 lookup and then ask for the &"userPassword"& attribute for that user in that
26061 realm, with:
26062 .code
26063 cyrusless_crammd5:
26064   driver = cram_md5
26065   public_name = CRAM-MD5
26066   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26067                   dbmjz{/etc/sasldb2}{$value}fail}
26068   server_set_id = $auth1
26069 .endd
26070
26071 .section "Using cram_md5 as a client" "SECID177"
26072 .cindex "options" "&(cram_md5)& authenticator (client)"
26073 When used as a client, the &(cram_md5)& authenticator has two options:
26074
26075
26076
26077 .option client_name cram_md5 string&!! "the primary host name"
26078 This string is expanded, and the result used as the user name data when
26079 computing the response to the server's challenge.
26080
26081
26082 .option client_secret cram_md5 string&!! unset
26083 This option must be set for the authenticator to work as a client. Its value is
26084 expanded and the result used as the secret string when computing the response.
26085
26086
26087 .vindex "&$host$&"
26088 .vindex "&$host_address$&"
26089 Different user names and secrets can be used for different servers by referring
26090 to &$host$& or &$host_address$& in the options. Forced failure of either
26091 expansion string is treated as an indication that this authenticator is not
26092 prepared to handle this case. Exim moves on to the next configured client
26093 authenticator. Any other expansion failure causes Exim to give up trying to
26094 send the message to the current server.
26095
26096 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26097 strings, is:
26098 .code
26099 fixed_cram:
26100   driver = cram_md5
26101   public_name = CRAM-MD5
26102   client_name = ph10
26103   client_secret = secret
26104 .endd
26105 .ecindex IIDcramauth1
26106 .ecindex IIDcramauth2
26107
26108
26109
26110 . ////////////////////////////////////////////////////////////////////////////
26111 . ////////////////////////////////////////////////////////////////////////////
26112
26113 .chapter "The cyrus_sasl authenticator" "CHID10"
26114 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26115 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26116 .cindex "Cyrus" "SASL library"
26117 .cindex "Kerberos"
26118 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26119 Digital Ltd (&url(http://www.aldigital.co.uk)).
26120
26121 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26122 library implementation of the RFC 2222 (&"Simple Authentication and Security
26123 Layer"&). This library supports a number of authentication mechanisms,
26124 including PLAIN and LOGIN, but also several others that Exim does not support
26125 directly. In particular, there is support for Kerberos authentication.
26126
26127 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26128 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26129 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26130 name of the driver to determine which mechanism to support.
26131
26132 Where access to some kind of secret file is required, for example in GSSAPI
26133 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26134 user, and that the Cyrus SASL library has no way of escalating privileges
26135 by default. You may also find you need to set environment variables,
26136 depending on the driver you are using.
26137
26138 The application name provided by Exim is &"exim"&, so various SASL options may
26139 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26140 Kerberos, note that because of limitations in the GSSAPI interface,
26141 changing the server keytab might need to be communicated down to the Kerberos
26142 layer independently. The mechanism for doing so is dependent upon the Kerberos
26143 implementation.
26144
26145 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26146 may be set to point to an alternative keytab file. Exim will pass this
26147 variable through from its own inherited environment when started as root or the
26148 Exim user. The keytab file needs to be readable by the Exim user.
26149 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26150 environment variable.  In practice, for those releases, the Cyrus authenticator
26151 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26152 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26153
26154
26155 .section "Using cyrus_sasl as a server" "SECID178"
26156 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26157 (on a successful authentication) into &$auth1$&. For compatibility with
26158 previous releases of Exim, the username is also placed in &$1$&. However, the
26159 use of this variable for this purpose is now deprecated, as it can lead to
26160 confusion in string expansions that also use numeric variables for other
26161 things.
26162
26163
26164 .option server_hostname cyrus_sasl string&!! "see below"
26165 This option selects the hostname that is used when communicating with the
26166 library. The default value is &`$primary_hostname`&. It is up to the underlying
26167 SASL plug-in what it does with this data.
26168
26169
26170 .option server_mech cyrus_sasl string "see below"
26171 This option selects the authentication mechanism this driver should use. The
26172 default is the value of the generic &%public_name%& option. This option allows
26173 you to use a different underlying mechanism from the advertised name. For
26174 example:
26175 .code
26176 sasl:
26177   driver = cyrus_sasl
26178   public_name = X-ANYTHING
26179   server_mech = CRAM-MD5
26180   server_set_id = $auth1
26181 .endd
26182
26183 .option server_realm cyrus_sasl string&!! unset
26184 This specifies the SASL realm that the server claims to be in.
26185
26186
26187 .option server_service cyrus_sasl string &`smtp`&
26188 This is the SASL service that the server claims to implement.
26189
26190
26191 For straightforward cases, you do not need to set any of the authenticator's
26192 private options. All you need to do is to specify an appropriate mechanism as
26193 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26194 PLAIN, you could have two authenticators as follows:
26195 .code
26196 sasl_cram_md5:
26197   driver = cyrus_sasl
26198   public_name = CRAM-MD5
26199   server_set_id = $auth1
26200
26201 sasl_plain:
26202   driver = cyrus_sasl
26203   public_name = PLAIN
26204   server_set_id = $auth2
26205 .endd
26206 Cyrus SASL does implement the LOGIN authentication method, even though it is
26207 not a standard method. It is disabled by default in the source distribution,
26208 but it is present in many binary distributions.
26209 .ecindex IIDcyrauth1
26210 .ecindex IIDcyrauth2
26211
26212
26213
26214
26215 . ////////////////////////////////////////////////////////////////////////////
26216 . ////////////////////////////////////////////////////////////////////////////
26217 .chapter "The dovecot authenticator" "CHAPdovecot"
26218 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26219 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26220 This authenticator is an interface to the authentication facility of the
26221 Dovecot POP/IMAP server, which can support a number of authentication methods.
26222 Note that Dovecot must be configured to use auth-client not auth-userdb.
26223 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26224 to use the same mechanisms for SMTP authentication. This is a server
26225 authenticator only. There is only one option:
26226
26227 .option server_socket dovecot string unset
26228
26229 This option must specify the socket that is the interface to Dovecot
26230 authentication. The &%public_name%& option must specify an authentication
26231 mechanism that Dovecot is configured to support. You can have several
26232 authenticators for different mechanisms. For example:
26233 .code
26234 dovecot_plain:
26235   driver = dovecot
26236   public_name = PLAIN
26237   server_socket = /var/run/dovecot/auth-client
26238   server_set_id = $auth1
26239
26240 dovecot_ntlm:
26241   driver = dovecot
26242   public_name = NTLM
26243   server_socket = /var/run/dovecot/auth-client
26244   server_set_id = $auth1
26245 .endd
26246 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26247 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26248 option is passed in the Dovecot authentication command. If, for a TLS
26249 connection, a client certificate has been verified, the &"valid-client-cert"&
26250 option is passed. When authentication succeeds, the identity of the user
26251 who authenticated is placed in &$auth1$&.
26252 .ecindex IIDdcotauth1
26253 .ecindex IIDdcotauth2
26254
26255
26256 . ////////////////////////////////////////////////////////////////////////////
26257 . ////////////////////////////////////////////////////////////////////////////
26258 .chapter "The gsasl authenticator" "CHAPgsasl"
26259 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26260 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26261 .cindex "authentication" "GNU SASL"
26262 .cindex "authentication" "SASL"
26263 .cindex "authentication" "EXTERNAL"
26264 .cindex "authentication" "ANONYMOUS"
26265 .cindex "authentication" "PLAIN"
26266 .cindex "authentication" "LOGIN"
26267 .cindex "authentication" "DIGEST-MD5"
26268 .cindex "authentication" "CRAM-MD5"
26269 .cindex "authentication" "SCRAM-SHA-1"
26270 The &(gsasl)& authenticator provides server integration for the GNU SASL
26271 library and the mechanisms it provides.  This is new as of the 4.80 release
26272 and there are a few areas where the library does not let Exim smoothly
26273 scale to handle future authentication mechanisms, so no guarantee can be
26274 made that any particular new authentication mechanism will be supported
26275 without code changes in Exim.
26276
26277
26278 .option server_channelbinding gsasl boolean false
26279 Some authentication mechanisms are able to use external context at both ends
26280 of the session to bind the authentication to that context, and fail the
26281 authentication process if that context differs.  Specifically, some TLS
26282 ciphersuites can provide identifying information about the cryptographic
26283 context.
26284
26285 This means that certificate identity and verification becomes a non-issue,
26286 as a man-in-the-middle attack will cause the correct client and server to
26287 see different identifiers and authentication will fail.
26288
26289 This is currently only supported when using the GnuTLS library.  This is
26290 only usable by mechanisms which support "channel binding"; at time of
26291 writing, that's the SCRAM family.
26292
26293 This defaults off to ensure smooth upgrade across Exim releases, in case
26294 this option causes some clients to start failing.  Some future release
26295 of Exim may switch the default to be true.
26296
26297
26298 .option server_hostname gsasl string&!! "see below"
26299 This option selects the hostname that is used when communicating with the
26300 library. The default value is &`$primary_hostname`&.
26301 Some mechanisms will use this data.
26302
26303
26304 .option server_mech gsasl string "see below"
26305 This option selects the authentication mechanism this driver should use. The
26306 default is the value of the generic &%public_name%& option. This option allows
26307 you to use a different underlying mechanism from the advertised name. For
26308 example:
26309 .code
26310 sasl:
26311   driver = gsasl
26312   public_name = X-ANYTHING
26313   server_mech = CRAM-MD5
26314   server_set_id = $auth1
26315 .endd
26316
26317
26318 .option server_password gsasl string&!! unset
26319 Various mechanisms need access to the cleartext password on the server, so
26320 that proof-of-possession can be demonstrated on the wire, without sending
26321 the password itself.
26322
26323 The data available for lookup varies per mechanism.
26324 In all cases, &$auth1$& is set to the &'authentication id'&.
26325 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26326 if available, else the empty string.
26327 The &$auth3$& variable will always be the &'realm'& if available,
26328 else the empty string.
26329
26330 A forced failure will cause authentication to defer.
26331
26332 If using this option, it may make sense to set the &%server_condition%&
26333 option to be simply "true".
26334
26335
26336 .option server_realm gsasl string&!! unset
26337 This specifies the SASL realm that the server claims to be in.
26338 Some mechanisms will use this data.
26339
26340
26341 .option server_scram_iter gsasl string&!! unset
26342 This option provides data for the SCRAM family of mechanisms.
26343 &$auth1$& is not available at evaluation time.
26344 (This may change, as we receive feedback on use)
26345
26346
26347 .option server_scram_salt gsasl string&!! unset
26348 This option provides data for the SCRAM family of mechanisms.
26349 &$auth1$& is not available at evaluation time.
26350 (This may change, as we receive feedback on use)
26351
26352
26353 .option server_service gsasl string &`smtp`&
26354 This is the SASL service that the server claims to implement.
26355 Some mechanisms will use this data.
26356
26357
26358 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26359 .vindex "&$auth1$&, &$auth2$&, etc"
26360 These may be set when evaluating specific options, as detailed above.
26361 They will also be set when evaluating &%server_condition%&.
26362
26363 Unless otherwise stated below, the &(gsasl)& integration will use the following
26364 meanings for these variables:
26365
26366 .ilist
26367 .vindex "&$auth1$&"
26368 &$auth1$&: the &'authentication id'&
26369 .next
26370 .vindex "&$auth2$&"
26371 &$auth2$&: the &'authorization id'&
26372 .next
26373 .vindex "&$auth3$&"
26374 &$auth3$&: the &'realm'&
26375 .endlist
26376
26377 On a per-mechanism basis:
26378
26379 .ilist
26380 .cindex "authentication" "EXTERNAL"
26381 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26382 the &%server_condition%& option must be present.
26383 .next
26384 .cindex "authentication" "ANONYMOUS"
26385 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26386 the &%server_condition%& option must be present.
26387 .next
26388 .cindex "authentication" "GSSAPI"
26389 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26390 &$auth2$& will be set to the &'authorization id'&,
26391 the &%server_condition%& option must be present.
26392 .endlist
26393
26394 An &'anonymous token'& is something passed along as an unauthenticated
26395 identifier; this is analogous to FTP anonymous authentication passing an
26396 email address, or software-identifier@, as the "password".
26397
26398
26399 An example showing the password having the realm specified in the callback
26400 and demonstrating a Cyrus SASL to GSASL migration approach is:
26401 .code
26402 gsasl_cyrusless_crammd5:
26403   driver = gsasl
26404   public_name = CRAM-MD5
26405   server_realm = imap.example.org
26406   server_password = ${lookup{$auth1:$auth3:userPassword}\
26407                     dbmjz{/etc/sasldb2}{$value}fail}
26408   server_set_id = ${quote:$auth1}
26409   server_condition = yes
26410 .endd
26411
26412
26413 . ////////////////////////////////////////////////////////////////////////////
26414 . ////////////////////////////////////////////////////////////////////////////
26415
26416 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26417 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26418 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26419 .cindex "authentication" "GSSAPI"
26420 .cindex "authentication" "Kerberos"
26421 The &(heimdal_gssapi)& authenticator provides server integration for the
26422 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26423 reliably.
26424
26425 .option server_hostname heimdal_gssapi string&!! "see below"
26426 This option selects the hostname that is used, with &%server_service%&,
26427 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26428 identifier.  The default value is &`$primary_hostname`&.
26429
26430 .option server_keytab heimdal_gssapi string&!! unset
26431 If set, then Heimdal will not use the system default keytab (typically
26432 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26433 The value should be a pathname, with no &"file:"& prefix.
26434
26435 .option server_service heimdal_gssapi string&!! "smtp"
26436 This option specifies the service identifier used, in conjunction with
26437 &%server_hostname%&, for building the identifier for finding credentials
26438 from the keytab.
26439
26440
26441 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26442 Beware that these variables will typically include a realm, thus will appear
26443 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26444 not verified, so a malicious client can set it to anything.
26445
26446 The &$auth1$& field should be safely trustable as a value from the Key
26447 Distribution Center.  Note that these are not quite email addresses.
26448 Each identifier is for a role, and so the left-hand-side may include a
26449 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26450
26451 .vindex "&$auth1$&, &$auth2$&, etc"
26452 .ilist
26453 .vindex "&$auth1$&"
26454 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26455 .next
26456 .vindex "&$auth2$&"
26457 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26458 authentication.  If that was empty, this will also be set to the
26459 GSS Display Name.
26460 .endlist
26461
26462
26463 . ////////////////////////////////////////////////////////////////////////////
26464 . ////////////////////////////////////////////////////////////////////////////
26465
26466 .chapter "The spa authenticator" "CHAPspa"
26467 .scindex IIDspaauth1 "&(spa)& authenticator"
26468 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26469 .cindex "authentication" "Microsoft Secure Password"
26470 .cindex "authentication" "NTLM"
26471 .cindex "Microsoft Secure Password Authentication"
26472 .cindex "NTLM authentication"
26473 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26474 Password Authentication'& mechanism,
26475 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26476 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26477 taken from the Samba project (&url(http://www.samba.org)). The code for the
26478 server side was subsequently contributed by Tom Kistner. The mechanism works as
26479 follows:
26480
26481 .ilist
26482 After the AUTH command has been accepted, the client sends an SPA
26483 authentication request based on the user name and optional domain.
26484 .next
26485 The server sends back a challenge.
26486 .next
26487 The client builds a challenge response which makes use of the user's password
26488 and sends it to the server, which then accepts or rejects it.
26489 .endlist
26490
26491 Encryption is used to protect the password in transit.
26492
26493
26494
26495 .section "Using spa as a server" "SECID179"
26496 .cindex "options" "&(spa)& authenticator (server)"
26497 The &(spa)& authenticator has just one server option:
26498
26499 .option server_password spa string&!! unset
26500 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26501 This option is expanded, and the result must be the cleartext password for the
26502 authenticating user, whose name is at this point in &$auth1$&. For
26503 compatibility with previous releases of Exim, the user name is also placed in
26504 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26505 it can lead to confusion in string expansions that also use numeric variables
26506 for other things. For example:
26507 .code
26508 spa:
26509   driver = spa
26510   public_name = NTLM
26511   server_password = \
26512     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26513 .endd
26514 If the expansion is forced to fail, authentication fails. Any other expansion
26515 failure causes a temporary error code to be returned.
26516
26517
26518
26519
26520
26521 .section "Using spa as a client" "SECID180"
26522 .cindex "options" "&(spa)& authenticator (client)"
26523 The &(spa)& authenticator has the following client options:
26524
26525
26526
26527 .option client_domain spa string&!! unset
26528 This option specifies an optional domain for the authentication.
26529
26530
26531 .option client_password spa string&!! unset
26532 This option specifies the user's password, and must be set.
26533
26534
26535 .option client_username spa string&!! unset
26536 This option specifies the user name, and must be set. Here is an example of a
26537 configuration of this authenticator for use with the mail servers at
26538 &'msn.com'&:
26539 .code
26540 msn:
26541   driver = spa
26542   public_name = MSN
26543   client_username = msn/msn_username
26544   client_password = msn_plaintext_password
26545   client_domain = DOMAIN_OR_UNSET
26546 .endd
26547 .ecindex IIDspaauth1
26548 .ecindex IIDspaauth2
26549
26550
26551
26552
26553
26554 . ////////////////////////////////////////////////////////////////////////////
26555 . ////////////////////////////////////////////////////////////////////////////
26556
26557 .chapter "The tls authenticator" "CHAPtlsauth"
26558 .scindex IIDtlsauth1 "&(tls)& authenticator"
26559 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26560 .cindex "authentication" "Client Certificate"
26561 .cindex "authentication" "X509"
26562 .cindex "Certificate-based authentication"
26563 The &(tls)& authenticator provides server support for
26564 authentication based on client certificates.
26565
26566 It is not an SMTP authentication mechanism and is not
26567 advertised by the server as part of the SMTP EHLO response.
26568 It is an Exim authenticator in the sense that it affects
26569 the protocol element of the log line, can be tested for
26570 by the &%authenticated%& ACL condition, and can set
26571 the &$authenticated_id$& variable.
26572
26573 The client must present a verifiable certificate,
26574 for which it must have been requested via the
26575 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26576 (see &<<CHAPTLS>>&).
26577
26578 If an authenticator of this type is configured it is
26579 run before any SMTP-level communication is done,
26580 and can authenticate the connection.
26581 If it does, SMTP authentication is not offered.
26582
26583 A maximum of one authenticator of this type may be present.
26584
26585
26586 .cindex "options" "&(tls)& authenticator (server)"
26587 The &(tls)& authenticator has three server options:
26588
26589 .option server_param1 tls string&!! unset
26590 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26591 This option is expanded after the TLS negotiation and
26592 the result is placed in &$auth1$&.
26593 If the expansion is forced to fail, authentication fails. Any other expansion
26594 failure causes a temporary error code to be returned.
26595
26596 .option server_param2 tls string&!! unset
26597 .option server_param3 tls string&!! unset
26598 As above, for &$auth2$& and &$auth3$&.
26599
26600 &%server_param1%& may also be spelled &%server_param%&.
26601
26602
26603 Example:
26604 .code
26605 tls:
26606   driver = tls
26607   server_param1 =     ${certextract {subj_altname,mail,>:} \
26608                                     {$tls_in_peercert}}
26609   server_condition =  ${if forany {$auth1} \
26610                             {!= {0} \
26611                                 {${lookup ldap{ldap:///\
26612                          mailname=${quote_ldap_dn:${lc:$item}},\
26613                          ou=users,LDAP_DC?mailid} {$value}{0} \
26614                        }    }   } }
26615   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26616 .endd
26617 This accepts a client certificate that is verifiable against any
26618 of your configured trust-anchors
26619 which usually means the full set of public CAs)
26620 and which has a SAN with a good account name.
26621 Note that the client cert is on the wire in-clear, including the SAN,
26622 whereas a plaintext SMTP AUTH done inside TLS is not.
26623
26624 . An alternative might use
26625 . .code
26626 .   server_param1 = ${sha256:$tls_in_peercert}
26627 . .endd
26628 . to require one of a set of specific certs that define a given account
26629 . (the verification is still required, but mostly irrelevant).
26630 . This would help for per-device use.
26631
26632 . However, for the future we really need support for checking a
26633 . user cert in LDAP - which probably wants a base-64 DER.
26634
26635 .ecindex IIDtlsauth1
26636 .ecindex IIDtlsauth2
26637
26638
26639 Note that because authentication is traditionally an SMTP operation,
26640 the &%authenticated%& ACL condition cannot be used in
26641 a connect- or helo-ACL.
26642
26643
26644
26645 . ////////////////////////////////////////////////////////////////////////////
26646 . ////////////////////////////////////////////////////////////////////////////
26647
26648 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26649          "Encrypted SMTP connections"
26650 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26651 .scindex IIDencsmtp2 "SMTP" "encryption"
26652 .cindex "TLS" "on SMTP connection"
26653 .cindex "OpenSSL"
26654 .cindex "GnuTLS"
26655 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26656 Sockets Layer), is implemented by making use of the OpenSSL library or the
26657 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26658 cryptographic code in the Exim distribution itself for implementing TLS. In
26659 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26660 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26661 You also need to understand the basic concepts of encryption at a managerial
26662 level, and in particular, the way that public keys, private keys, and
26663 certificates are used.
26664
26665 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26666 connection is established, the client issues a STARTTLS command. If the
26667 server accepts this, the client and the server negotiate an encryption
26668 mechanism. If the negotiation succeeds, the data that subsequently passes
26669 between them is encrypted.
26670
26671 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26672 and if so, what cipher suite is in use, whether the client supplied a
26673 certificate, and whether or not that certificate was verified. This makes it
26674 possible for an Exim server to deny or accept certain commands based on the
26675 encryption state.
26676
26677 &*Warning*&: Certain types of firewall and certain anti-virus products can
26678 disrupt TLS connections. You need to turn off SMTP scanning for these products
26679 in order to get TLS to work.
26680
26681
26682
26683 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26684          "SECID284"
26685 .cindex "ssmtp protocol"
26686 .cindex "smtps protocol"
26687 .cindex "SMTP" "ssmtp protocol"
26688 .cindex "SMTP" "smtps protocol"
26689 Early implementations of encrypted SMTP used a different TCP port from normal
26690 SMTP, and expected an encryption negotiation to start immediately, instead of
26691 waiting for a STARTTLS command from the client using the standard SMTP
26692 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26693 allocated for this purpose.
26694
26695 This approach was abandoned when encrypted SMTP was standardized, but there are
26696 still some legacy clients that use it. Exim supports these clients by means of
26697 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26698 numbers; the most common use is expected to be:
26699 .code
26700 tls_on_connect_ports = 465
26701 .endd
26702 The port numbers specified by this option apply to all SMTP connections, both
26703 via the daemon and via &'inetd'&. You still need to specify all the ports that
26704 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26705 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26706 an extra port &-- rather, it specifies different behaviour on a port that is
26707 defined elsewhere.
26708
26709 There is also a &%-tls-on-connect%& command line option. This overrides
26710 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26711
26712
26713
26714
26715
26716
26717 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26718 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26719 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26720 followed later, when the first versions of GnuTLS were released. To build Exim
26721 to use GnuTLS, you need to set
26722 .code
26723 USE_GNUTLS=yes
26724 .endd
26725 in Local/Makefile, in addition to
26726 .code
26727 SUPPORT_TLS=yes
26728 .endd
26729 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26730 include files and libraries for GnuTLS can be found.
26731
26732 There are some differences in usage when using GnuTLS instead of OpenSSL:
26733
26734 .ilist
26735 The &%tls_verify_certificates%& option
26736 cannot be the path of a directory
26737 for GnuTLS versions before 3.3.6
26738 (for later versions, or OpenSSL, it can be either).
26739 .next
26740 The default value for &%tls_dhparam%& differs for historical reasons.
26741 .next
26742 .vindex "&$tls_in_peerdn$&"
26743 .vindex "&$tls_out_peerdn$&"
26744 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26745 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26746 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26747 .next
26748 OpenSSL identifies cipher suites using hyphens as separators, for example:
26749 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26750 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26751 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26752 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26753 to handle its own older variants) when processing lists of cipher suites in the
26754 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26755 option).
26756 .next
26757 The &%tls_require_ciphers%& options operate differently, as described in the
26758 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26759 .next
26760 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26761 When using OpenSSL, this option is ignored.
26762 (If an API is found to let OpenSSL be configured in this way,
26763 let the Exim Maintainers know and we'll likely use it).
26764 .next
26765 Some other recently added features may only be available in one or the other.
26766 This should be documented with the feature.  If the documentation does not
26767 explicitly state that the feature is infeasible in the other TLS
26768 implementation, then patches are welcome.
26769 .endlist
26770
26771
26772 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26773 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26774 an explicit path; if the latter, then the text about generation still applies,
26775 but not the chosen filename.
26776 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26777 See the documentation of &%tls_dhparam%& for more information.
26778
26779 GnuTLS uses D-H parameters that may take a substantial amount of time
26780 to compute. It is unreasonable to re-compute them for every TLS session.
26781 Therefore, Exim keeps this data in a file in its spool directory, called
26782 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26783 of bits requested.
26784 The file is owned by the Exim user and is readable only by
26785 its owner. Every Exim process that start up GnuTLS reads the D-H
26786 parameters from this file. If the file does not exist, the first Exim process
26787 that needs it computes the data and writes it to a temporary file which is
26788 renamed once it is complete. It does not matter if several Exim processes do
26789 this simultaneously (apart from wasting a few resources). Once a file is in
26790 place, new Exim processes immediately start using it.
26791
26792 For maximum security, the parameters that are stored in this file should be
26793 recalculated periodically, the frequency depending on your paranoia level.
26794 If you are avoiding using the fixed D-H primes published in RFCs, then you
26795 are concerned about some advanced attacks and will wish to do this; if you do
26796 not regenerate then you might as well stick to the standard primes.
26797
26798 Arranging this is easy in principle; just delete the file when you want new
26799 values to be computed. However, there may be a problem. The calculation of new
26800 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26801 If the system is not very active, &_/dev/random_& may delay returning data
26802 until enough randomness (entropy) is available. This may cause Exim to hang for
26803 a substantial amount of time, causing timeouts on incoming connections.
26804
26805 The solution is to generate the parameters externally to Exim. They are stored
26806 in &_gnutls-params-N_& in PEM format, which means that they can be
26807 generated externally using the &(certtool)& command that is part of GnuTLS.
26808
26809 To replace the parameters with new ones, instead of deleting the file
26810 and letting Exim re-create it, you can generate new parameters using
26811 &(certtool)& and, when this has been done, replace Exim's cache file by
26812 renaming. The relevant commands are something like this:
26813 .code
26814 # ls
26815 [ look for file; assume gnutls-params-2236 is the most recent ]
26816 # rm -f new-params
26817 # touch new-params
26818 # chown exim:exim new-params
26819 # chmod 0600 new-params
26820 # certtool --generate-dh-params --bits 2236 >>new-params
26821 # openssl dhparam -noout -text -in new-params | head
26822 [ check the first line, make sure it's not more than 2236;
26823   if it is, then go back to the start ("rm") and repeat
26824   until the size generated is at most the size requested ]
26825 # chmod 0400 new-params
26826 # mv new-params gnutls-params-2236
26827 .endd
26828 If Exim never has to generate the parameters itself, the possibility of
26829 stalling is removed.
26830
26831 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26832 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26833 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26834 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26835 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26836 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26837 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26838 which applies to all D-H usage, client or server.  If the value returned by
26839 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26840 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26841 limit, which is still much higher than Exim historically used.
26842
26843 The filename and bits used will change as the GnuTLS maintainers change the
26844 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26845 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26846 2432 bits, while NSS is limited to 2236 bits.
26847
26848 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26849 increase the chance of the generated prime actually being within acceptable
26850 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26851 procedure above.  There is no sane procedure available to Exim to double-check
26852 the size of the generated prime, so it might still be too large.
26853
26854
26855 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26856 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26857 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26858 There is a function in the OpenSSL library that can be passed a list of cipher
26859 suites before the cipher negotiation takes place. This specifies which ciphers
26860 are acceptable. The list is colon separated and may contain names like
26861 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26862 directly to this function call.
26863 Many systems will install the OpenSSL manual-pages, so you may have
26864 &'ciphers(1)'& available to you.
26865 The following quotation from the OpenSSL
26866 documentation specifies what forms of item are allowed in the cipher string:
26867
26868 .ilist
26869 It can consist of a single cipher suite such as RC4-SHA.
26870 .next
26871 It can represent a list of cipher suites containing a certain algorithm,
26872 or cipher suites of a certain type. For example SHA1 represents all
26873 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26874 SSL v3 algorithms.
26875 .next
26876 Lists of cipher suites can be combined in a single cipher string using
26877 the + character. This is used as a logical and operation. For example
26878 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26879 algorithms.
26880 .endlist
26881
26882 Each cipher string can be optionally preceded by one of the characters &`!`&,
26883 &`-`& or &`+`&.
26884 .ilist
26885 If &`!`& is used, the ciphers are permanently deleted from the list. The
26886 ciphers deleted can never reappear in the list even if they are explicitly
26887 stated.
26888 .next
26889 If &`-`& is used, the ciphers are deleted from the list, but some or all
26890 of the ciphers can be added again by later options.
26891 .next
26892 If &`+`& is used, the ciphers are moved to the end of the list. This
26893 option does not add any new ciphers; it just moves matching existing ones.
26894 .endlist
26895
26896 If none of these characters is present, the string is interpreted as
26897 a list of ciphers to be appended to the current preference list. If the list
26898 includes any ciphers already present they will be ignored: that is, they will
26899 not be moved to the end of the list.
26900 .endlist
26901
26902 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26903 string:
26904 .code
26905 # note single-quotes to get ! past any shell history expansion
26906 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26907 .endd
26908
26909 This example will let the library defaults be permitted on the MX port, where
26910 there's probably no identity verification anyway, but ups the ante on the
26911 submission ports where the administrator might have some influence on the
26912 choice of clients used:
26913 .code
26914 # OpenSSL variant; see man ciphers(1)
26915 tls_require_ciphers = ${if =={$received_port}{25}\
26916                            {DEFAULT}\
26917                            {HIGH:!MD5:!SHA1}}
26918 .endd
26919
26920
26921
26922 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26923          "SECTreqciphgnu"
26924 .cindex "GnuTLS" "specifying parameters for"
26925 .cindex "TLS" "specifying ciphers (GnuTLS)"
26926 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26927 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26928 .cindex "TLS" "specifying protocols (GnuTLS)"
26929 .cindex "TLS" "specifying priority string (GnuTLS)"
26930 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26931 The GnuTLS library allows the caller to provide a "priority string", documented
26932 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26933 ciphersuite specification in OpenSSL.
26934
26935 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26936 and controls both protocols and ciphers.
26937
26938 The &%tls_require_ciphers%& option is available both as an global option,
26939 controlling how Exim behaves as a server, and also as an option of the
26940 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26941 the value is string expanded.  The resulting string is not an Exim list and
26942 the string is given to the GnuTLS library, so that Exim does not need to be
26943 aware of future feature enhancements of GnuTLS.
26944
26945 Documentation of the strings accepted may be found in the GnuTLS manual, under
26946 "Priority strings".  This is online as
26947 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26948 but beware that this relates to GnuTLS 3, which may be newer than the version
26949 installed on your system.  If you are using GnuTLS 3,
26950 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26951 on that site can be used to test a given string.
26952
26953 For example:
26954 .code
26955 # Disable older versions of protocols
26956 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26957 .endd
26958
26959 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26960 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26961 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26962
26963 This example will let the library defaults be permitted on the MX port, where
26964 there's probably no identity verification anyway, and lowers security further
26965 by increasing compatibility; but this ups the ante on the submission ports
26966 where the administrator might have some influence on the choice of clients
26967 used:
26968 .code
26969 # GnuTLS variant
26970 tls_require_ciphers = ${if =={$received_port}{25}\
26971                            {NORMAL:%COMPAT}\
26972                            {SECURE128}}
26973 .endd
26974
26975
26976 .section "Configuring an Exim server to use TLS" "SECID182"
26977 .cindex "TLS" "configuring an Exim server"
26978 When Exim has been built with TLS support, it advertises the availability of
26979 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26980 but not to any others. The default value of this option is unset, which means
26981 that STARTTLS is not advertised at all. This default is chosen because you
26982 need to set some other options in order to make TLS available, and also it is
26983 sensible for systems that want to use TLS only as a client.
26984
26985 If a client issues a STARTTLS command and there is some configuration
26986 problem in the server, the command is rejected with a 454 error. If the client
26987 persists in trying to issue SMTP commands, all except QUIT are rejected
26988 with the error
26989 .code
26990 554 Security failure
26991 .endd
26992 If a STARTTLS command is issued within an existing TLS session, it is
26993 rejected with a 554 error code.
26994
26995 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26996 match some hosts. You can, of course, set it to * to match all hosts.
26997 However, this is not all you need to do. TLS sessions to a server won't work
26998 without some further configuration at the server end.
26999
27000 It is rumoured that all existing clients that support TLS/SSL use RSA
27001 encryption. To make this work you need to set, in the server,
27002 .code
27003 tls_certificate = /some/file/name
27004 tls_privatekey = /some/file/name
27005 .endd
27006 These options are, in fact, expanded strings, so you can make them depend on
27007 the identity of the client that is connected if you wish. The first file
27008 contains the server's X509 certificate, and the second contains the private key
27009 that goes with it. These files need to be
27010 PEM format and readable by the Exim user, and must
27011 always be given as full path names.
27012 The key must not be password-protected.
27013 They can be the same file if both the
27014 certificate and the key are contained within it. If &%tls_privatekey%& is not
27015 set, or if its expansion is forced to fail or results in an empty string, this
27016 is assumed to be the case. The certificate file may also contain intermediate
27017 certificates that need to be sent to the client to enable it to authenticate
27018 the server's certificate.
27019
27020 If you do not understand about certificates and keys, please try to find a
27021 source of this background information, which is not Exim-specific. (There are a
27022 few comments below in section &<<SECTcerandall>>&.)
27023
27024 &*Note*&: These options do not apply when Exim is operating as a client &--
27025 they apply only in the case of a server. If you need to use a certificate in an
27026 Exim client, you must set the options of the same names in an &(smtp)&
27027 transport.
27028
27029 With just these options, an Exim server will be able to use TLS. It does not
27030 require the client to have a certificate (but see below for how to insist on
27031 this). There is one other option that may be needed in other situations. If
27032 .code
27033 tls_dhparam = /some/file/name
27034 .endd
27035 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27036 with the parameters contained in the file.
27037 Set this to &`none`& to disable use of DH entirely, by making no prime
27038 available:
27039 .code
27040 tls_dhparam = none
27041 .endd
27042 This may also be set to a string identifying a standard prime to be used for
27043 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27044 used is &`ike23`&.  There are a few standard primes available, see the
27045 documentation for &%tls_dhparam%& for the complete list.
27046
27047 See the command
27048 .code
27049 openssl dhparam
27050 .endd
27051 for a way of generating file data.
27052
27053 The strings supplied for these three options are expanded every time a client
27054 host connects. It is therefore possible to use different certificates and keys
27055 for different hosts, if you so wish, by making use of the client's IP address
27056 in &$sender_host_address$& to control the expansion. If a string expansion is
27057 forced to fail, Exim behaves as if the option is not set.
27058
27059 .cindex "cipher" "logging"
27060 .cindex "log" "TLS cipher"
27061 .vindex "&$tls_in_cipher$&"
27062 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27063 an incoming TLS connection. It is included in the &'Received:'& header of an
27064 incoming message (by default &-- you can, of course, change this), and it is
27065 also included in the log line that records a message's arrival, keyed by
27066 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27067 condition can be used to test for specific cipher suites in ACLs.
27068
27069 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27070 can check the name of the cipher suite and vary their actions accordingly. The
27071 cipher suite names vary, depending on which TLS library is being used. For
27072 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27073 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27074 documentation for more details.
27075
27076 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27077 (again depending on the &%tls_cipher%& log selector).
27078
27079
27080 .section "Requesting and verifying client certificates" "SECID183"
27081 .cindex "certificate" "verification of client"
27082 .cindex "TLS" "client certificate verification"
27083 If you want an Exim server to request a certificate when negotiating a TLS
27084 session with a client, you must set either &%tls_verify_hosts%& or
27085 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27086 apply to all TLS connections. For any host that matches one of these options,
27087 Exim requests a certificate as part of the setup of the TLS session. The
27088 contents of the certificate are verified by comparing it with a list of
27089 expected certificates.
27090 These may be the system default set (depending on library version),
27091 an explicit file or,
27092 depending on library version, a directory, identified by
27093 &%tls_verify_certificates%&.
27094
27095 A file can contain multiple certificates, concatenated end to end. If a
27096 directory is used
27097 (OpenSSL only),
27098 each certificate must be in a separate file, with a name (or a symbolic link)
27099 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27100 certificate. You can compute the relevant hash by running the command
27101 .code
27102 openssl x509 -hash -noout -in /cert/file
27103 .endd
27104 where &_/cert/file_& contains a single certificate.
27105
27106 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27107 what happens if the client does not supply a certificate, or if the certificate
27108 does not match any of the certificates in the collection named by
27109 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27110 attempt to set up a TLS session is aborted, and the incoming connection is
27111 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27112 session continues. ACLs that run for subsequent SMTP commands can detect the
27113 fact that no certificate was verified, and vary their actions accordingly. For
27114 example, you can insist on a certificate before accepting a message for
27115 relaying, but not when the message is destined for local delivery.
27116
27117 .vindex "&$tls_in_peerdn$&"
27118 When a client supplies a certificate (whether it verifies or not), the value of
27119 the Distinguished Name of the certificate is made available in the variable
27120 &$tls_in_peerdn$& during subsequent processing of the message.
27121
27122 .cindex "log" "distinguished name"
27123 Because it is often a long text string, it is not included in the log line or
27124 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27125 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27126 &%received_header_text%& to change the &'Received:'& header. When no
27127 certificate is supplied, &$tls_in_peerdn$& is empty.
27128
27129
27130 .section "Revoked certificates" "SECID184"
27131 .cindex "TLS" "revoked certificates"
27132 .cindex "revocation list"
27133 .cindex "certificate" "revocation list"
27134 .cindex "OCSP" "stapling"
27135 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27136 certificates are revoked. If you have such a list, you can pass it to an Exim
27137 server using the global option called &%tls_crl%& and to an Exim client using
27138 an identically named option for the &(smtp)& transport. In each case, the value
27139 of the option is expanded and must then be the name of a file that contains a
27140 CRL in PEM format.
27141 The downside is that clients have to periodically re-download a potentially huge
27142 file from every certificate authority they know of.
27143
27144 The way with most moving parts at query time is Online Certificate
27145 Status Protocol (OCSP), where the client verifies the certificate
27146 against an OCSP server run by the CA.  This lets the CA track all
27147 usage of the certs.  It requires running software with access to the
27148 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27149 is based on HTTP and can be proxied accordingly.
27150
27151 The only widespread OCSP server implementation (known to this writer)
27152 comes as part of OpenSSL and aborts on an invalid request, such as
27153 connecting to the port and then disconnecting.  This requires
27154 re-entering the passphrase each time some random client does this.
27155
27156 The third way is OCSP Stapling; in this, the server using a certificate
27157 issued by the CA periodically requests an OCSP proof of validity from
27158 the OCSP server, then serves it up inline as part of the TLS
27159 negotiation.   This approach adds no extra round trips, does not let the
27160 CA track users, scales well with number of certs issued by the CA and is
27161 resilient to temporary OCSP server failures, as long as the server
27162 starts retrying to fetch an OCSP proof some time before its current
27163 proof expires.  The downside is that it requires server support.
27164
27165 Unless Exim is built with the support disabled,
27166 .new
27167 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27168 .wen
27169 support for OCSP stapling is included.
27170
27171 There is a global option called &%tls_ocsp_file%&.
27172 The file specified therein is expected to be in DER format, and contain
27173 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27174 option will be re-expanded for SNI, if the &%tls_certificate%& option
27175 contains &`tls_in_sni`&, as per other TLS options.
27176
27177 Exim does not at this time implement any support for fetching a new OCSP
27178 proof.  The burden is on the administrator to handle this, outside of
27179 Exim.  The file specified should be replaced atomically, so that the
27180 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27181 on each connection, so a new file will be handled transparently on the
27182 next connection.
27183
27184 When built with OpenSSL Exim will check for a valid next update timestamp
27185 in the OCSP proof; if not present, or if the proof has expired, it will be
27186 ignored.
27187
27188 For the client to be able to verify the stapled OCSP the server must
27189 also supply, in its stapled information, any intermediate
27190 certificates for the chain leading to the OCSP proof from the signer
27191 of the server certificate.  There may be zero or one such. These
27192 intermediate certificates should be added to the server OCSP stapling
27193 file named by &%tls_ocsp_file%&.
27194
27195 Note that the proof only covers the terminal server certificate,
27196 not any of the chain from CA to it.
27197
27198 There is no current way to staple a proof for a client certificate.
27199
27200 .code
27201   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27202   OCSP server is supplied.  The server URL may be included in the
27203   server certificate, if the CA is helpful.
27204
27205   One failure mode seen was the OCSP Signer cert expiring before the end
27206   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27207   noted this as invalid overall, but the re-fetch script did not.
27208 .endd
27209
27210
27211
27212
27213 .section "Configuring an Exim client to use TLS" "SECID185"
27214 .cindex "cipher" "logging"
27215 .cindex "log" "TLS cipher"
27216 .cindex "log" "distinguished name"
27217 .cindex "TLS" "configuring an Exim client"
27218 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27219 deliveries as well as to incoming, the latter one causing logging of the
27220 server certificate's DN. The remaining client configuration for TLS is all
27221 within the &(smtp)& transport.
27222
27223 It is not necessary to set any options to have TLS work in the &(smtp)&
27224 transport. If Exim is built with TLS support, and TLS is advertised by a
27225 server, the &(smtp)& transport always tries to start a TLS session. However,
27226 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27227 transport) to a list of server hosts for which TLS should not be used.
27228
27229 If you do not want Exim to attempt to send messages unencrypted when an attempt
27230 to set up an encrypted connection fails in any way, you can set
27231 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27232 those hosts, delivery is always deferred if an encrypted connection cannot be
27233 set up. If there are any other hosts for the address, they are tried in the
27234 usual way.
27235
27236 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27237 the message unencrypted. It always does this if the response to STARTTLS is
27238 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27239 session after a success response code, what happens is controlled by the
27240 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27241 delivery to this host is deferred, and other hosts (if available) are tried. If
27242 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27243 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27244 negotiation fails, Exim closes the current connection (because it is in an
27245 unknown state), opens a new one to the same host, and then tries the delivery
27246 unencrypted.
27247
27248 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27249 transport provide the client with a certificate, which is passed to the server
27250 if it requests it. If the server is Exim, it will request a certificate only if
27251 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27252
27253 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27254 specifies a collection of expected server certificates.
27255 These may be the system default set (depending on library version),
27256 a file or,
27257 depending on library version, a directory,
27258 must name a file or,
27259 for OpenSSL only (not GnuTLS), a directory.
27260 The client verifies the server's certificate
27261 against this collection, taking into account any revoked certificates that are
27262 in the list defined by &%tls_crl%&.
27263 Failure to verify fails the TLS connection unless either of the
27264 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27265
27266 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27267 certificate verification to the listed servers.  Verification either must
27268 or need not succeed respectively.
27269
27270 The &(smtp)& transport has two OCSP-related options:
27271 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27272 is requested and required for the connection to proceed.  The default
27273 value is empty.
27274 &%hosts_request_ocsp%&; a host-list for which (additionally)
27275 a Certificate Status is requested (but not necessarily verified).  The default
27276 value is "*" meaning that requests are made unless configured
27277 otherwise.
27278
27279 The host(s) should also be in &%hosts_require_tls%&, and
27280 &%tls_verify_certificates%& configured for the transport,
27281 for OCSP to be relevant.
27282
27283 If
27284 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27285 list of permitted cipher suites. If either of these checks fails, delivery to
27286 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27287 alternative hosts, if any.
27288
27289  &*Note*&:
27290 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27291 is operating as a client. Exim does not assume that a server certificate (set
27292 by the global options of the same name) should also be used when operating as a
27293 client.
27294
27295 .vindex "&$host$&"
27296 .vindex "&$host_address$&"
27297 All the TLS options in the &(smtp)& transport are expanded before use, with
27298 &$host$& and &$host_address$& containing the name and address of the server to
27299 which the client is connected. Forced failure of an expansion causes Exim to
27300 behave as if the relevant option were unset.
27301
27302 .vindex &$tls_out_bits$&
27303 .vindex &$tls_out_cipher$&
27304 .vindex &$tls_out_peerdn$&
27305 .vindex &$tls_out_sni$&
27306 Before an SMTP connection is established, the
27307 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27308 variables are emptied. (Until the first connection, they contain the values
27309 that were set when the message was received.) If STARTTLS is subsequently
27310 successfully obeyed, these variables are set to the relevant values for the
27311 outgoing connection.
27312
27313
27314
27315 .section "Use of TLS Server Name Indication" "SECTtlssni"
27316 .cindex "TLS" "Server Name Indication"
27317 .vindex "&$tls_in_sni$&"
27318 .oindex "&%tls_in_sni%&"
27319 With TLS1.0 or above, there is an extension mechanism by which extra
27320 information can be included at various points in the protocol.  One of these
27321 extensions, documented in RFC 6066 (and before that RFC 4366) is
27322 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27323 client in the initial handshake, so that the server can examine the servername
27324 within and possibly choose to use different certificates and keys (and more)
27325 for this session.
27326
27327 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27328 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27329 address.
27330
27331 With SMTP to MX, there are the same problems here as in choosing the identity
27332 against which to validate a certificate: you can't rely on insecure DNS to
27333 provide the identity which you then cryptographically verify.  So this will
27334 be of limited use in that environment.
27335
27336 With SMTP to Submission, there is a well-defined hostname which clients are
27337 connecting to and can validate certificates against.  Thus clients &*can*&
27338 choose to include this information in the TLS negotiation.  If this becomes
27339 wide-spread, then hosters can choose to present different certificates to
27340 different clients.  Or even negotiate different cipher suites.
27341
27342 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27343 if not empty, will be sent on a TLS session as part of the handshake.  There's
27344 nothing more to it.  Choosing a sensible value not derived insecurely is the
27345 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27346 for the lifetime of the client connection (including during authentication).
27347
27348 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27349 received from a client.
27350 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27351
27352 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27353 option (prior to expansion) then the following options will be re-expanded
27354 during TLS session handshake, to permit alternative values to be chosen:
27355
27356 .ilist
27357 .vindex "&%tls_certificate%&"
27358 &%tls_certificate%&
27359 .next
27360 .vindex "&%tls_crl%&"
27361 &%tls_crl%&
27362 .next
27363 .vindex "&%tls_privatekey%&"
27364 &%tls_privatekey%&
27365 .next
27366 .vindex "&%tls_verify_certificates%&"
27367 &%tls_verify_certificates%&
27368 .next
27369 .vindex "&%tls_ocsp_file%&"
27370 &%tls_ocsp_file%&
27371 .endlist
27372
27373 Great care should be taken to deal with matters of case, various injection
27374 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27375 can always be referenced; it is important to remember that &$tls_sni$& is
27376 arbitrary unverified data provided prior to authentication.
27377
27378 The Exim developers are proceeding cautiously and so far no other TLS options
27379 are re-expanded.
27380
27381 When Exim is built against OpenSSL, OpenSSL must have been built with support
27382 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27383 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27384 see &`-servername`& in the output, then OpenSSL has support.
27385
27386 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27387 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27388 built, then you have SNI support).
27389
27390
27391
27392 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27393          "SECTmulmessam"
27394 .cindex "multiple SMTP deliveries with TLS"
27395 .cindex "TLS" "multiple message deliveries"
27396 Exim sends multiple messages down the same TCP/IP connection by starting up
27397 an entirely new delivery process for each message, passing the socket from
27398 one process to the next. This implementation does not fit well with the use
27399 of TLS, because there is quite a lot of state information associated with a TLS
27400 connection, not just a socket identification. Passing all the state information
27401 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27402 session before passing the socket to a new process. The new process may then
27403 try to start a new TLS session, and if successful, may try to re-authenticate
27404 if AUTH is in use, before sending the next message.
27405
27406 The RFC is not clear as to whether or not an SMTP session continues in clear
27407 after TLS has been shut down, or whether TLS may be restarted again later, as
27408 just described. However, if the server is Exim, this shutdown and
27409 reinitialization works. It is not known which (if any) other servers operate
27410 successfully if the client closes a TLS session and continues with unencrypted
27411 SMTP, but there are certainly some that do not work. For such servers, Exim
27412 should not pass the socket to another process, because the failure of the
27413 subsequent attempt to use it would cause Exim to record a temporary host error,
27414 and delay other deliveries to that host.
27415
27416 To test for this case, Exim sends an EHLO command to the server after
27417 closing down the TLS session. If this fails in any way, the connection is
27418 closed instead of being passed to a new delivery process, but no retry
27419 information is recorded.
27420
27421 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27422 &(smtp)& transport to match those hosts for which Exim should not pass
27423 connections to new processes if TLS has been used.
27424
27425
27426
27427
27428 .section "Certificates and all that" "SECTcerandall"
27429 .cindex "certificate" "references to discussion"
27430 In order to understand fully how TLS works, you need to know about
27431 certificates, certificate signing, and certificate authorities. This is not the
27432 place to give a tutorial, especially as I do not know very much about it
27433 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27434 to Apache, currently at
27435 .display
27436 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27437 .endd
27438 Other parts of the &'modssl'& documentation are also helpful, and have
27439 links to further files.
27440 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27441 0-201-61598-3), contains both introductory and more in-depth descriptions.
27442 Some sample programs taken from the book are available from
27443 .display
27444 &url(http://www.rtfm.com/openssl-examples/)
27445 .endd
27446
27447
27448 .section "Certificate chains" "SECID186"
27449 The file named by &%tls_certificate%& may contain more than one
27450 certificate. This is useful in the case where the certificate that is being
27451 sent is validated by an intermediate certificate which the other end does
27452 not have. Multiple certificates must be in the correct order in the file.
27453 First the host's certificate itself, then the first intermediate
27454 certificate to validate the issuer of the host certificate, then the next
27455 intermediate certificate to validate the issuer of the first intermediate
27456 certificate, and so on, until finally (optionally) the root certificate.
27457 The root certificate must already be trusted by the recipient for
27458 validation to succeed, of course, but if it's not preinstalled, sending the
27459 root certificate along with the rest makes it available for the user to
27460 install if the receiving end is a client MUA that can interact with a user.
27461
27462 Note that certificates using MD5 are unlikely to work on today's Internet;
27463 even if your libraries allow loading them for use in Exim when acting as a
27464 server, increasingly clients will not accept such certificates.  The error
27465 diagnostics in such a case can be frustratingly vague.
27466
27467
27468
27469 .section "Self-signed certificates" "SECID187"
27470 .cindex "certificate" "self-signed"
27471 You can create a self-signed certificate using the &'req'& command provided
27472 with OpenSSL, like this:
27473 . ==== Do not shorten the duration here without reading and considering
27474 . ==== the text below.  Please leave it at 9999 days.
27475 .code
27476 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27477             -days 9999 -nodes
27478 .endd
27479 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27480 delimited and so can be identified independently. The &%-days%& option
27481 specifies a period for which the certificate is valid. The &%-nodes%& option is
27482 important: if you do not set it, the key is encrypted with a passphrase
27483 that you are prompted for, and any use that is made of the key causes more
27484 prompting for the passphrase. This is not helpful if you are going to use
27485 this certificate and key in an MTA, where prompting is not possible.
27486
27487 . ==== I expect to still be working 26 years from now.  The less technical
27488 . ==== debt I create, in terms of storing up trouble for my later years, the
27489 . ==== happier I will be then.  We really have reached the point where we
27490 . ==== should start, at the very least, provoking thought and making folks
27491 . ==== pause before proceeding, instead of leaving all the fixes until two
27492 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27493 . ==== -pdp, 2012
27494 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27495 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27496 the above command might produce a date in the past.  Think carefully about
27497 the lifetime of the systems you're deploying, and either reduce the duration
27498 of the certificate or reconsider your platform deployment.  (At time of
27499 writing, reducing the duration is the most likely choice, but the inexorable
27500 progression of time takes us steadily towards an era where this will not
27501 be a sensible resolution).
27502
27503 A self-signed certificate made in this way is sufficient for testing, and
27504 may be adequate for all your requirements if you are mainly interested in
27505 encrypting transfers, and not in secure identification.
27506
27507 However, many clients require that the certificate presented by the server be a
27508 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27509 certificate. In this situation, the self-signed certificate described above
27510 must be installed on the client host as a trusted root &'certification
27511 authority'& (CA), and the certificate used by Exim must be a user certificate
27512 signed with that self-signed certificate.
27513
27514 For information on creating self-signed CA certificates and using them to sign
27515 user certificates, see the &'General implementation overview'& chapter of the
27516 Open-source PKI book, available online at
27517 &url(http://ospkibook.sourceforge.net/).
27518 .ecindex IIDencsmtp1
27519 .ecindex IIDencsmtp2
27520
27521
27522
27523 . ////////////////////////////////////////////////////////////////////////////
27524 . ////////////////////////////////////////////////////////////////////////////
27525
27526 .chapter "Access control lists" "CHAPACL"
27527 .scindex IIDacl "&ACL;" "description"
27528 .cindex "control of incoming mail"
27529 .cindex "message" "controlling incoming"
27530 .cindex "policy control" "access control lists"
27531 Access Control Lists (ACLs) are defined in a separate section of the run time
27532 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27533 name, terminated by a colon. Here is a complete ACL section that contains just
27534 one very small ACL:
27535 .code
27536 begin acl
27537 small_acl:
27538   accept   hosts = one.host.only
27539 .endd
27540 You can have as many lists as you like in the ACL section, and the order in
27541 which they appear does not matter. The lists are self-terminating.
27542
27543 The majority of ACLs are used to control Exim's behaviour when it receives
27544 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27545 when a local process submits a message using SMTP by specifying the &%-bs%&
27546 option. The most common use is for controlling which recipients are accepted
27547 in incoming messages. In addition, you can define an ACL that is used to check
27548 local non-SMTP messages. The default configuration file contains an example of
27549 a realistic ACL for checking RCPT commands. This is discussed in chapter
27550 &<<CHAPdefconfil>>&.
27551
27552
27553 .section "Testing ACLs" "SECID188"
27554 The &%-bh%& command line option provides a way of testing your ACL
27555 configuration locally by running a fake SMTP session with which you interact.
27556
27557
27558 .section "Specifying when ACLs are used" "SECID189"
27559 .cindex "&ACL;" "options for specifying"
27560 In order to cause an ACL to be used, you have to name it in one of the relevant
27561 options in the main part of the configuration. These options are:
27562 .cindex "AUTH" "ACL for"
27563 .cindex "DATA" "ACLs for"
27564 .cindex "ETRN" "ACL for"
27565 .cindex "EXPN" "ACL for"
27566 .cindex "HELO" "ACL for"
27567 .cindex "EHLO" "ACL for"
27568 .cindex "DKIM" "ACL for"
27569 .cindex "MAIL" "ACL for"
27570 .cindex "QUIT, ACL for"
27571 .cindex "RCPT" "ACL for"
27572 .cindex "STARTTLS, ACL for"
27573 .cindex "VRFY" "ACL for"
27574 .cindex "SMTP" "connection, ACL for"
27575 .cindex "non-SMTP messages" "ACLs for"
27576 .cindex "MIME content scanning" "ACL for"
27577 .cindex "PRDR" "ACL for"
27578
27579 .table2 140pt
27580 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27581 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27582 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27583 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27584 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27585 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27586 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27587 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27588 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27589 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27590 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27591 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27592 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27593 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27594 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27595 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27596 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27597 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27598 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27599 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27600 .endtable
27601
27602 For example, if you set
27603 .code
27604 acl_smtp_rcpt = small_acl
27605 .endd
27606 the little ACL defined above is used whenever Exim receives a RCPT command
27607 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27608 done when RCPT commands arrive. A rejection of RCPT should cause the
27609 sending MTA to give up on the recipient address contained in the RCPT
27610 command, whereas rejection at other times may cause the client MTA to keep on
27611 trying to deliver the message. It is therefore recommended that you do as much
27612 testing as possible at RCPT time.
27613
27614
27615 .section "The non-SMTP ACLs" "SECID190"
27616 .cindex "non-SMTP messages" "ACLs for"
27617 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27618 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27619 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27620 the state of the SMTP connection such as encryption and authentication) are not
27621 relevant and are forbidden in these ACLs. However, the sender and recipients
27622 are known, so the &%senders%& and &%sender_domains%& conditions and the
27623 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27624 &$authenticated_sender$& are also available. You can specify added header lines
27625 in any of these ACLs.
27626
27627 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27628 non-SMTP message, before any of the message has been read. (This is the
27629 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27630 batched SMTP input, it runs after the DATA command has been reached. The
27631 result of this ACL is ignored; it cannot be used to reject a message. If you
27632 really need to, you could set a value in an ACL variable here and reject based
27633 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27634 controls, and in particular, it can be used to set
27635 .code
27636 control = suppress_local_fixups
27637 .endd
27638 This cannot be used in the other non-SMTP ACLs because by the time they are
27639 run, it is too late.
27640
27641 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27642 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27643
27644 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27645 kind of rejection is treated as permanent, because there is no way of sending a
27646 temporary error for these kinds of message.
27647
27648
27649 .section "The SMTP connect ACL" "SECID191"
27650 .cindex "SMTP" "connection, ACL for"
27651 .oindex &%smtp_banner%&
27652 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27653 session, after the test specified by &%host_reject_connection%& (which is now
27654 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27655 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27656 the message override the banner message that is otherwise specified by the
27657 &%smtp_banner%& option.
27658
27659
27660 .section "The EHLO/HELO ACL" "SECID192"
27661 .cindex "EHLO" "ACL for"
27662 .cindex "HELO" "ACL for"
27663 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27664 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27665 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27666 Note that a client may issue more than one EHLO or HELO command in an SMTP
27667 session, and indeed is required to issue a new EHLO or HELO after successfully
27668 setting up encryption following a STARTTLS command.
27669
27670 .new
27671 Note also that a deny neither forces the client to go away nor means that
27672 mail will be refused on the connection.  Consider checking for
27673 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27674 .wen
27675
27676 If the command is accepted by an &%accept%& verb that has a &%message%&
27677 modifier, the message may not contain more than one line (it will be truncated
27678 at the first newline and a panic logged if it does). Such a message cannot
27679 affect the EHLO options that are listed on the second and subsequent lines of
27680 an EHLO response.
27681
27682
27683 .section "The DATA ACLs" "SECID193"
27684 .cindex "DATA" "ACLs for"
27685 Two ACLs are associated with the DATA command, because it is two-stage
27686 command, with two responses being sent to the client.
27687 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27688 is obeyed. This gives you control after all the RCPT commands, but before
27689 the message itself is received. It offers the opportunity to give a negative
27690 response to the DATA command before the data is transmitted. Header lines
27691 added by MAIL or RCPT ACLs are not visible at this time, but any that
27692 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27693
27694 You cannot test the contents of the message, for example, to verify addresses
27695 in the headers, at RCPT time or when the DATA command is received. Such
27696 tests have to appear in the ACL that is run after the message itself has been
27697 received, before the final response to the DATA command is sent. This is
27698 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27699 associated with the DATA command.
27700
27701 For both of these ACLs, it is not possible to reject individual recipients. An
27702 error response rejects the entire message. Unfortunately, it is known that some
27703 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27704 before or after the data) correctly &-- they keep the message on their queues
27705 and try again later, but that is their problem, though it does waste some of
27706 your resources.
27707
27708 The &%acl_smtp_data%& ACL is run after
27709 the &%acl_smtp_data_prdr%&,
27710 the &%acl_smtp_dkim%&
27711 and the &%acl_smtp_mime%& ACLs.
27712
27713 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27714 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27715 enabled (which is the default).
27716
27717 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27718 received, and is executed for each DKIM signature found in a message.  If not
27719 otherwise specified, the default action is to accept.
27720
27721 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27722
27723 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27724
27725
27726 .section "The SMTP MIME ACL" "SECID194"
27727 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27728 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27729
27730 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27731
27732
27733 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27734 .cindex "PRDR" "ACL for"
27735 .oindex "&%prdr_enable%&"
27736 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27737 with PRDR support enabled (which is the default).
27738 It becomes active only when the PRDR feature is negotiated between
27739 client and server for a message, and more than one recipient
27740 has been accepted.
27741
27742 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27743 has been received, and is executed once for each recipient of the message
27744 with &$local_part$& and &$domain$& valid.
27745 The test may accept, defer or deny for individual recipients.
27746 The &%acl_smtp_data%& will still be called after this ACL and
27747 can reject the message overall, even if this ACL has accepted it
27748 for some or all recipients.
27749
27750 PRDR may be used to support per-user content filtering.  Without it
27751 one must defer any recipient after the first that has a different
27752 content-filter configuration.  With PRDR, the RCPT-time check
27753 .new
27754 .cindex "PRDR" "variable for"
27755 for this can be disabled when the variable &$prdr_requested$&
27756 is &"yes"&.
27757 .wen
27758 Any required difference in behaviour of the main DATA-time
27759 ACL should however depend on the PRDR-time ACL having run, as Exim
27760 will avoid doing so in some situations (e.g.  single-recipient mails).
27761
27762 See also the &%prdr_enable%& global option
27763 and the &%hosts_try_prdr%& smtp transport option.
27764
27765 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27766 If the ACL is not defined, processing completes as if
27767 the feature was not requested by the client.
27768
27769 .section "The QUIT ACL" "SECTQUITACL"
27770 .cindex "QUIT, ACL for"
27771 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27772 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27773 does not in fact control any access.
27774 For this reason, it may only accept
27775 or warn as its final result.
27776
27777 This ACL can be used for tasks such as custom logging at the end of an SMTP
27778 session. For example, you can use ACL variables in other ACLs to count
27779 messages, recipients, etc., and log the totals at QUIT time using one or
27780 more &%logwrite%& modifiers on a &%warn%& verb.
27781
27782 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27783 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27784
27785 You do not need to have a final &%accept%&, but if you do, you can use a
27786 &%message%& modifier to specify custom text that is sent as part of the 221
27787 response to QUIT.
27788
27789 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27790 failure (for example, failure to open a log file, or when Exim is bombing out
27791 because it has detected an unrecoverable error), all SMTP commands from the
27792 client are given temporary error responses until QUIT is received or the
27793 connection is closed. In these special cases, the QUIT ACL does not run.
27794
27795
27796 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27797 .vindex &$acl_smtp_notquit$&
27798 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27799 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27800 trouble, such as being unable to write to its log files, this ACL is not run,
27801 because it might try to do things (such as write to log files) that make the
27802 situation even worse.
27803
27804 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27805 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27806 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27807 and &%warn%&.
27808
27809 .vindex &$smtp_notquit_reason$&
27810 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27811 to a string that indicates the reason for the termination of the SMTP
27812 connection. The possible values are:
27813 .table2
27814 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27815 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27816 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27817 .irow &`connection-lost`&          "The SMTP connection has been lost"
27818 .irow &`data-timeout`&             "Timeout while reading message data"
27819 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27820 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27821 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27822 .irow &`synchronization-error`&    "SMTP synchronization error"
27823 .irow &`tls-failed`&               "TLS failed to start"
27824 .endtable
27825 In most cases when an SMTP connection is closed without having received QUIT,
27826 Exim sends an SMTP response message before actually closing the connection.
27827 With the exception of the &`acl-drop`& case, the default message can be
27828 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27829 &%drop%& verb in another ACL, it is the message from the other ACL that is
27830 used.
27831
27832
27833 .section "Finding an ACL to use" "SECID195"
27834 .cindex "&ACL;" "finding which to use"
27835 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27836 you can use different ACLs in different circumstances. For example,
27837 .code
27838 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27839                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27840 .endd
27841 In the default configuration file there are some example settings for
27842 providing an RFC 4409 message submission service on port 587 and a
27843 non-standard &"smtps"& service on port 465. You can use a string
27844 expansion like this to choose an ACL for MUAs on these ports which is
27845 more appropriate for this purpose than the default ACL on port 25.
27846
27847 The expanded string does not have to be the name of an ACL in the
27848 configuration file; there are other possibilities. Having expanded the
27849 string, Exim searches for an ACL as follows:
27850
27851 .ilist
27852 If the string begins with a slash, Exim uses it as a file name, and reads its
27853 contents as an ACL. The lines are processed in the same way as lines in the
27854 Exim configuration file. In particular, continuation lines are supported, blank
27855 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27856 If the file does not exist or cannot be read, an error occurs (typically
27857 causing a temporary failure of whatever caused the ACL to be run). For example:
27858 .code
27859 acl_smtp_data = /etc/acls/\
27860   ${lookup{$sender_host_address}lsearch\
27861   {/etc/acllist}{$value}{default}}
27862 .endd
27863 This looks up an ACL file to use on the basis of the host's IP address, falling
27864 back to a default if the lookup fails. If an ACL is successfully read from a
27865 file, it is retained in memory for the duration of the Exim process, so that it
27866 can be re-used without having to re-read the file.
27867 .next
27868 If the string does not start with a slash, and does not contain any spaces,
27869 Exim searches the ACL section of the configuration for an ACL whose name
27870 matches the string.
27871 .next
27872 If no named ACL is found, or if the string contains spaces, Exim parses
27873 the string as an inline ACL. This can save typing in cases where you just
27874 want to have something like
27875 .code
27876 acl_smtp_vrfy = accept
27877 .endd
27878 in order to allow free use of the VRFY command. Such a string may contain
27879 newlines; it is processed in the same way as an ACL that is read from a file.
27880 .endlist
27881
27882
27883
27884
27885 .section "ACL return codes" "SECID196"
27886 .cindex "&ACL;" "return codes"
27887 Except for the QUIT ACL, which does not affect the SMTP return code (see
27888 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27889 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27890 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27891 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27892 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27893 This also causes a 4&'xx'& return code.
27894
27895 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27896 &"deny"&, because there is no mechanism for passing temporary errors to the
27897 submitters of non-SMTP messages.
27898
27899
27900 ACLs that are relevant to message reception may also return &"discard"&. This
27901 has the effect of &"accept"&, but causes either the entire message or an
27902 individual recipient address to be discarded. In other words, it is a
27903 blackholing facility. Use it with care.
27904
27905 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27906 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27907 RCPT ACL is to discard just the one recipient address. If there are no
27908 recipients left when the message's data is received, the DATA ACL is not
27909 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27910 remaining recipients. The &"discard"& return is not permitted for the
27911 &%acl_smtp_predata%& ACL.
27912
27913
27914 .cindex "&[local_scan()]& function" "when all recipients discarded"
27915 The &[local_scan()]& function is always run, even if there are no remaining
27916 recipients; it may create new recipients.
27917
27918
27919
27920 .section "Unset ACL options" "SECID197"
27921 .cindex "&ACL;" "unset options"
27922 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27923 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27924 not defined at all. For any defined ACL, the default action when control
27925 reaches the end of the ACL statements is &"deny"&.
27926
27927 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27928 these two are ACLs that are used only for their side effects. They cannot be
27929 used to accept or reject anything.
27930
27931 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27932 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27933 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27934 when the ACL is not defined is &"accept"&.
27935
27936 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27937 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27938 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27939 messages over an SMTP connection. For an example, see the ACL in the default
27940 configuration file.
27941
27942
27943
27944
27945 .section "Data for message ACLs" "SECID198"
27946 .cindex "&ACL;" "data for message ACL"
27947 .vindex &$domain$&
27948 .vindex &$local_part$&
27949 .vindex &$sender_address$&
27950 .vindex &$sender_host_address$&
27951 .vindex &$smtp_command$&
27952 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27953 that contain information about the host and the message's sender (for example,
27954 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27955 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27956 &$local_part$& are set from the argument address. The entire SMTP command
27957 is available in &$smtp_command$&.
27958
27959 When an ACL for the AUTH parameter of MAIL is running, the variables that
27960 contain information about the host are set, but &$sender_address$& is not yet
27961 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27962 how it is used.
27963
27964 .vindex "&$message_size$&"
27965 The &$message_size$& variable is set to the value of the SIZE parameter on
27966 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27967 that parameter is not given. The value is updated to the true message size by
27968 the time the final DATA ACL is run (after the message data has been
27969 received).
27970
27971 .vindex "&$rcpt_count$&"
27972 .vindex "&$recipients_count$&"
27973 The &$rcpt_count$& variable increases by one for each RCPT command received.
27974 The &$recipients_count$& variable increases by one each time a RCPT command is
27975 accepted, so while an ACL for RCPT is being processed, it contains the number
27976 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27977 &$rcpt_count$& contains the total number of RCPT commands, and
27978 &$recipients_count$& contains the total number of accepted recipients.
27979
27980
27981
27982
27983
27984 .section "Data for non-message ACLs" "SECTdatfornon"
27985 .cindex "&ACL;" "data for non-message ACL"
27986 .vindex &$smtp_command_argument$&
27987 .vindex &$smtp_command$&
27988 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27989 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27990 and the entire SMTP command is available in &$smtp_command$&.
27991 These variables can be tested using a &%condition%& condition. For example,
27992 here is an ACL for use with AUTH, which insists that either the session is
27993 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27994 does not permit authentication methods that use cleartext passwords on
27995 unencrypted connections.
27996 .code
27997 acl_check_auth:
27998   accept encrypted = *
27999   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28000                      {CRAM-MD5}}
28001   deny   message   = TLS encryption or CRAM-MD5 required
28002 .endd
28003 (Another way of applying this restriction is to arrange for the authenticators
28004 that use cleartext passwords not to be advertised when the connection is not
28005 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28006 option to do this.)
28007
28008
28009
28010 .section "Format of an ACL" "SECID199"
28011 .cindex "&ACL;" "format of"
28012 .cindex "&ACL;" "verbs, definition of"
28013 An individual ACL consists of a number of statements. Each statement starts
28014 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28015 Modifiers can change the way the verb operates, define error and log messages,
28016 set variables, insert delays, and vary the processing of accepted messages.
28017
28018 If all the conditions are met, the verb is obeyed. The same condition may be
28019 used (with different arguments) more than once in the same statement. This
28020 provides a means of specifying an &"and"& conjunction between conditions. For
28021 example:
28022 .code
28023 deny  dnslists = list1.example
28024 dnslists = list2.example
28025 .endd
28026 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28027 the conditions and modifiers when it reaches a condition that fails. What
28028 happens then depends on the verb (and in one case, on a special modifier). Not
28029 all the conditions make sense at every testing point. For example, you cannot
28030 test a sender address in the ACL that is run for a VRFY command.
28031
28032
28033 .section "ACL verbs" "SECID200"
28034 The ACL verbs are as follows:
28035
28036 .ilist
28037 .cindex "&%accept%& ACL verb"
28038 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28039 of the conditions are not met, what happens depends on whether &%endpass%&
28040 appears among the conditions (for syntax see below). If the failing condition
28041 is before &%endpass%&, control is passed to the next ACL statement; if it is
28042 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28043 check a RCPT command:
28044 .code
28045 accept domains = +local_domains
28046 endpass
28047 verify = recipient
28048 .endd
28049 If the recipient domain does not match the &%domains%& condition, control
28050 passes to the next statement. If it does match, the recipient is verified, and
28051 the command is accepted if verification succeeds. However, if verification
28052 fails, the ACL yields &"deny"&, because the failing condition is after
28053 &%endpass%&.
28054
28055 The &%endpass%& feature has turned out to be confusing to many people, so its
28056 use is not recommended nowadays. It is always possible to rewrite an ACL so
28057 that &%endpass%& is not needed, and it is no longer used in the default
28058 configuration.
28059
28060 .cindex "&%message%& ACL modifier" "with &%accept%&"
28061 If a &%message%& modifier appears on an &%accept%& statement, its action
28062 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28063 (when an &%accept%& verb either accepts or passes control to the next
28064 statement), &%message%& can be used to vary the message that is sent when an
28065 SMTP command is accepted. For example, in a RCPT ACL you could have:
28066 .display
28067 &`accept  `&<&'some conditions'&>
28068 &`        message = OK, I will allow you through today`&
28069 .endd
28070 You can specify an SMTP response code, optionally followed by an &"extended
28071 response code"& at the start of the message, but the first digit must be the
28072 same as would be sent by default, which is 2 for an &%accept%& verb.
28073
28074 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28075 an error message that is used when access is denied. This behaviour is retained
28076 for backward compatibility, but current &"best practice"& is to avoid the use
28077 of &%endpass%&.
28078
28079
28080 .next
28081 .cindex "&%defer%& ACL verb"
28082 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28083 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28084 &%defer%& is the same as &%deny%&, because there is no way of sending a
28085 temporary error. For a RCPT command, &%defer%& is much the same as using a
28086 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28087 be used in any ACL, and even for a recipient it might be a simpler approach.
28088
28089
28090 .next
28091 .cindex "&%deny%& ACL verb"
28092 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28093 the conditions are not met, control is passed to the next ACL statement. For
28094 example,
28095 .code
28096 deny dnslists = blackholes.mail-abuse.org
28097 .endd
28098 rejects commands from hosts that are on a DNS black list.
28099
28100
28101 .next
28102 .cindex "&%discard%& ACL verb"
28103 &%discard%&: This verb behaves like &%accept%&, except that it returns
28104 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28105 that are concerned with receiving messages. When all the conditions are true,
28106 the sending entity receives a &"success"& response. However, &%discard%& causes
28107 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28108 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28109 message's recipients are discarded. Recipients that are discarded before DATA
28110 do not appear in the log line when the &%received_recipients%& log selector is set.
28111
28112 If the &%log_message%& modifier is set when &%discard%& operates,
28113 its contents are added to the line that is automatically written to the log.
28114 The &%message%& modifier operates exactly as it does for &%accept%&.
28115
28116
28117 .next
28118 .cindex "&%drop%& ACL verb"
28119 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28120 forcibly closed after the 5&'xx'& error message has been sent. For example:
28121 .code
28122 drop   message   = I don't take more than 20 RCPTs
28123        condition = ${if > {$rcpt_count}{20}}
28124 .endd
28125 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28126 The connection is always dropped after sending a 550 response.
28127
28128 .next
28129 .cindex "&%require%& ACL verb"
28130 &%require%&: If all the conditions are met, control is passed to the next ACL
28131 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28132 example, when checking a RCPT command,
28133 .code
28134 require message = Sender did not verify
28135         verify  = sender
28136 .endd
28137 passes control to subsequent statements only if the message's sender can be
28138 verified. Otherwise, it rejects the command. Note the positioning of the
28139 &%message%& modifier, before the &%verify%& condition. The reason for this is
28140 discussed in section &<<SECTcondmodproc>>&.
28141
28142 .next
28143 .cindex "&%warn%& ACL verb"
28144 &%warn%&: If all the conditions are true, a line specified by the
28145 &%log_message%& modifier is written to Exim's main log. Control always passes
28146 to the next ACL statement. If any condition is false, the log line is not
28147 written. If an identical log line is requested several times in the same
28148 message, only one copy is actually written to the log. If you want to force
28149 duplicates to be written, use the &%logwrite%& modifier instead.
28150
28151 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28152 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28153 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28154 first failing condition. There is more about adding header lines in section
28155 &<<SECTaddheadacl>>&.
28156
28157 If any condition on a &%warn%& statement cannot be completed (that is, there is
28158 some sort of defer), the log line specified by &%log_message%& is not written.
28159 This does not include the case of a forced failure from a lookup, which
28160 is considered to be a successful completion. After a defer, no further
28161 conditions or modifiers in the &%warn%& statement are processed. The incident
28162 is logged, and the ACL continues to be processed, from the next statement
28163 onwards.
28164
28165
28166 .vindex "&$acl_verify_message$&"
28167 When one of the &%warn%& conditions is an address verification that fails, the
28168 text of the verification failure message is in &$acl_verify_message$&. If you
28169 want this logged, you must set it up explicitly. For example:
28170 .code
28171 warn   !verify = sender
28172        log_message = sender verify failed: $acl_verify_message
28173 .endd
28174 .endlist
28175
28176 At the end of each ACL there is an implicit unconditional &%deny%&.
28177
28178 As you can see from the examples above, the conditions and modifiers are
28179 written one to a line, with the first one on the same line as the verb, and
28180 subsequent ones on following lines. If you have a very long condition, you can
28181 continue it onto several physical lines by the usual backslash continuation
28182 mechanism. It is conventional to align the conditions vertically.
28183
28184
28185
28186 .section "ACL variables" "SECTaclvariables"
28187 .cindex "&ACL;" "variables"
28188 There are some special variables that can be set during ACL processing. They
28189 can be used to pass information between different ACLs, different invocations
28190 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28191 transports, and filters that are used to deliver a message. The names of these
28192 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28193 an underscore, but the remainder of the name can be any sequence of
28194 alphanumeric characters and underscores that you choose. There is no limit on
28195 the number of ACL variables. The two sets act as follows:
28196 .ilist
28197 The values of those variables whose names begin with &$acl_c$& persist
28198 throughout an SMTP connection. They are never reset. Thus, a value that is set
28199 while receiving one message is still available when receiving the next message
28200 on the same SMTP connection.
28201 .next
28202 The values of those variables whose names begin with &$acl_m$& persist only
28203 while a message is being received. They are reset afterwards. They are also
28204 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28205 .endlist
28206
28207 When a message is accepted, the current values of all the ACL variables are
28208 preserved with the message and are subsequently made available at delivery
28209 time. The ACL variables are set by a modifier called &%set%&. For example:
28210 .code
28211 accept hosts = whatever
28212        set acl_m4 = some value
28213 accept authenticated = *
28214        set acl_c_auth = yes
28215 .endd
28216 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28217 be set. If you want to set a variable without taking any action, you can use a
28218 &%warn%& verb without any other modifiers or conditions.
28219
28220 .oindex &%strict_acl_vars%&
28221 What happens if a syntactically valid but undefined ACL variable is
28222 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28223 false (the default), an empty string is substituted; if it is true, an
28224 error is generated.
28225
28226 Versions of Exim before 4.64 have a limited set of numbered variables, but
28227 their names are compatible, so there is no problem with upgrading.
28228
28229
28230 .section "Condition and modifier processing" "SECTcondmodproc"
28231 .cindex "&ACL;" "conditions; processing"
28232 .cindex "&ACL;" "modifiers; processing"
28233 An exclamation mark preceding a condition negates its result. For example:
28234 .code
28235 deny   domains = *.dom.example
28236       !verify  = recipient
28237 .endd
28238 causes the ACL to return &"deny"& if the recipient domain ends in
28239 &'dom.example'& and the recipient address cannot be verified. Sometimes
28240 negation can be used on the right-hand side of a condition. For example, these
28241 two statements are equivalent:
28242 .code
28243 deny  hosts = !192.168.3.4
28244 deny !hosts =  192.168.3.4
28245 .endd
28246 However, for many conditions (&%verify%& being a good example), only left-hand
28247 side negation of the whole condition is possible.
28248
28249 The arguments of conditions and modifiers are expanded. A forced failure
28250 of an expansion causes a condition to be ignored, that is, it behaves as if the
28251 condition is true. Consider these two statements:
28252 .code
28253 accept  senders = ${lookup{$host_name}lsearch\
28254                   {/some/file}{$value}fail}
28255 accept  senders = ${lookup{$host_name}lsearch\
28256                   {/some/file}{$value}{}}
28257 .endd
28258 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28259 the returned list is searched, but if the lookup fails the behaviour is
28260 different in the two cases. The &%fail%& in the first statement causes the
28261 condition to be ignored, leaving no further conditions. The &%accept%& verb
28262 therefore succeeds. The second statement, however, generates an empty list when
28263 the lookup fails. No sender can match an empty list, so the condition fails,
28264 and therefore the &%accept%& also fails.
28265
28266 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28267 specify actions that are taken as the conditions for a statement are checked;
28268 others specify text for messages that are used when access is denied or a
28269 warning is generated. The &%control%& modifier affects the way an incoming
28270 message is handled.
28271
28272 The positioning of the modifiers in an ACL statement is important, because the
28273 processing of a verb ceases as soon as its outcome is known. Only those
28274 modifiers that have already been encountered will take effect. For example,
28275 consider this use of the &%message%& modifier:
28276 .code
28277 require message = Can't verify sender
28278         verify  = sender
28279         message = Can't verify recipient
28280         verify  = recipient
28281         message = This message cannot be used
28282 .endd
28283 If sender verification fails, Exim knows that the result of the statement is
28284 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28285 so its text is used as the error message. If sender verification succeeds, but
28286 recipient verification fails, the second message is used. If recipient
28287 verification succeeds, the third message becomes &"current"&, but is never used
28288 because there are no more conditions to cause failure.
28289
28290 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28291 modifier that is used, because all the conditions must be true for rejection to
28292 happen. Specifying more than one &%message%& modifier does not make sense, and
28293 the message can even be specified after all the conditions. For example:
28294 .code
28295 deny   hosts = ...
28296       !senders = *@my.domain.example
28297        message = Invalid sender from client host
28298 .endd
28299 The &"deny"& result does not happen until the end of the statement is reached,
28300 by which time Exim has set up the message.
28301
28302
28303
28304 .section "ACL modifiers" "SECTACLmodi"
28305 .cindex "&ACL;" "modifiers; list of"
28306 The ACL modifiers are as follows:
28307
28308 .vlist
28309 .vitem &*add_header*&&~=&~<&'text'&>
28310 This modifier specifies one or more header lines that are to be added to an
28311 incoming message, assuming, of course, that the message is ultimately
28312 accepted. For details, see section &<<SECTaddheadacl>>&.
28313
28314 .vitem &*continue*&&~=&~<&'text'&>
28315 .cindex "&%continue%& ACL modifier"
28316 .cindex "database" "updating in ACL"
28317 This modifier does nothing of itself, and processing of the ACL always
28318 continues with the next condition or modifier. The value of &%continue%& is in
28319 the side effects of expanding its argument. Typically this could be used to
28320 update a database. It is really just a syntactic tidiness, to avoid having to
28321 write rather ugly lines like this:
28322 .display
28323 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28324 .endd
28325 Instead, all you need is
28326 .display
28327 &`continue = `&<&'some expansion'&>
28328 .endd
28329
28330 .vitem &*control*&&~=&~<&'text'&>
28331 .cindex "&%control%& ACL modifier"
28332 This modifier affects the subsequent processing of the SMTP connection or of an
28333 incoming message that is accepted. The effect of the first type of control
28334 lasts for the duration of the connection, whereas the effect of the second type
28335 lasts only until the current message has been received. The message-specific
28336 controls always apply to the whole message, not to individual recipients,
28337 even if the &%control%& modifier appears in a RCPT ACL.
28338
28339 As there are now quite a few controls that can be applied, they are described
28340 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28341 in several different ways. For example:
28342
28343 . ==== As this is a nested list, any displays it contains must be indented
28344 . ==== as otherwise they are too far to the left. That comment applies only
28345 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28346 . ==== way.
28347
28348 .ilist
28349 It can be at the end of an &%accept%& statement:
28350 .code
28351     accept  ...some conditions
28352             control = queue_only
28353 .endd
28354 In this case, the control is applied when this statement yields &"accept"&, in
28355 other words, when the conditions are all true.
28356
28357 .next
28358 It can be in the middle of an &%accept%& statement:
28359 .code
28360     accept  ...some conditions...
28361             control = queue_only
28362             ...some more conditions...
28363 .endd
28364 If the first set of conditions are true, the control is applied, even if the
28365 statement does not accept because one of the second set of conditions is false.
28366 In this case, some subsequent statement must yield &"accept"& for the control
28367 to be relevant.
28368
28369 .next
28370 It can be used with &%warn%& to apply the control, leaving the
28371 decision about accepting or denying to a subsequent verb. For
28372 example:
28373 .code
28374     warn    ...some conditions...
28375             control = freeze
28376     accept  ...
28377 .endd
28378 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28379 &%logwrite%&, so it does not add anything to the message and does not write a
28380 log entry.
28381
28382 .next
28383 If you want to apply a control unconditionally, you can use it with a
28384 &%require%& verb. For example:
28385 .code
28386     require  control = no_multiline_responses
28387 .endd
28388 .endlist
28389
28390 .vitem &*delay*&&~=&~<&'time'&>
28391 .cindex "&%delay%& ACL modifier"
28392 .oindex "&%-bh%&"
28393 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28394 the time interval before proceeding. However, when testing Exim using the
28395 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28396 output instead). The time is given in the usual Exim notation, and the delay
28397 happens as soon as the modifier is processed. In an SMTP session, pending
28398 output is flushed before the delay is imposed.
28399
28400 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28401 example:
28402 .code
28403 deny    ...some conditions...
28404         delay = 30s
28405 .endd
28406 The delay happens if all the conditions are true, before the statement returns
28407 &"deny"&. Compare this with:
28408 .code
28409 deny    delay = 30s
28410         ...some conditions...
28411 .endd
28412 which waits for 30s before processing the conditions. The &%delay%& modifier
28413 can also be used with &%warn%& and together with &%control%&:
28414 .code
28415 warn    ...some conditions...
28416         delay = 2m
28417         control = freeze
28418 accept  ...
28419 .endd
28420
28421 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28422 responses to several commands are no longer buffered and sent in one packet (as
28423 they would normally be) because all output is flushed before imposing the
28424 delay. This optimization is disabled so that a number of small delays do not
28425 appear to the client as one large aggregated delay that might provoke an
28426 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28427 using a &%control%& modifier to set &%no_delay_flush%&.
28428
28429
28430 .vitem &*endpass*&
28431 .cindex "&%endpass%& ACL modifier"
28432 This modifier, which has no argument, is recognized only in &%accept%& and
28433 &%discard%& statements. It marks the boundary between the conditions whose
28434 failure causes control to pass to the next statement, and the conditions whose
28435 failure causes the ACL to return &"deny"&. This concept has proved to be
28436 confusing to some people, so the use of &%endpass%& is no longer recommended as
28437 &"best practice"&. See the description of &%accept%& above for more details.
28438
28439
28440 .vitem &*log_message*&&~=&~<&'text'&>
28441 .cindex "&%log_message%& ACL modifier"
28442 This modifier sets up a message that is used as part of the log message if the
28443 ACL denies access or a &%warn%& statement's conditions are true. For example:
28444 .code
28445 require log_message = wrong cipher suite $tls_in_cipher
28446         encrypted   = DES-CBC3-SHA
28447 .endd
28448 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28449 example:
28450 .display
28451 &`discard `&<&'some conditions'&>
28452 &`        log_message = Discarded $local_part@$domain because...`&
28453 .endd
28454 When access is denied, &%log_message%& adds to any underlying error message
28455 that may exist because of a condition failure. For example, while verifying a
28456 recipient address, a &':fail:'& redirection might have already set up a
28457 message.
28458
28459 The message may be defined before the conditions to which it applies, because
28460 the string expansion does not happen until Exim decides that access is to be
28461 denied. This means that any variables that are set by the condition are
28462 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28463 variables are set after a DNS black list lookup succeeds. If the expansion of
28464 &%log_message%& fails, or if the result is an empty string, the modifier is
28465 ignored.
28466
28467 .vindex "&$acl_verify_message$&"
28468 If you want to use a &%warn%& statement to log the result of an address
28469 verification, you can use &$acl_verify_message$& to include the verification
28470 error message.
28471
28472 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28473 the start of the logged message. If the same warning log message is requested
28474 more than once while receiving  a single email message, only one copy is
28475 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28476 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28477 is logged for a successful &%warn%& statement.
28478
28479 If &%log_message%& is not present and there is no underlying error message (for
28480 example, from the failure of address verification), but &%message%& is present,
28481 the &%message%& text is used for logging rejections. However, if any text for
28482 logging contains newlines, only the first line is logged. In the absence of
28483 both &%log_message%& and &%message%&, a default built-in message is used for
28484 logging rejections.
28485
28486
28487 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28488 .cindex "&%log_reject_target%& ACL modifier"
28489 .cindex "logging in ACL" "specifying which log"
28490 This modifier makes it possible to specify which logs are used for messages
28491 about ACL rejections. Its argument is a colon-separated list of words that can
28492 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28493 may be empty, in which case a rejection is not logged at all. For example, this
28494 ACL fragment writes no logging information when access is denied:
28495 .display
28496 &`deny `&<&'some conditions'&>
28497 &`     log_reject_target =`&
28498 .endd
28499 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28500 permanent and temporary rejections. Its effect lasts for the rest of the
28501 current ACL.
28502
28503
28504 .vitem &*logwrite*&&~=&~<&'text'&>
28505 .cindex "&%logwrite%& ACL modifier"
28506 .cindex "logging in ACL" "immediate"
28507 This modifier writes a message to a log file as soon as it is encountered when
28508 processing an ACL. (Compare &%log_message%&, which, except in the case of
28509 &%warn%& and &%discard%&, is used only if the ACL statement denies
28510 access.) The &%logwrite%& modifier can be used to log special incidents in
28511 ACLs. For example:
28512 .display
28513 &`accept `&<&'some special conditions'&>
28514 &`       control  = freeze`&
28515 &`       logwrite = froze message because ...`&
28516 .endd
28517 By default, the message is written to the main log. However, it may begin
28518 with a colon, followed by a comma-separated list of log names, and then
28519 another colon, to specify exactly which logs are to be written. For
28520 example:
28521 .code
28522 logwrite = :main,reject: text for main and reject logs
28523 logwrite = :panic: text for panic log only
28524 .endd
28525
28526
28527 .vitem &*message*&&~=&~<&'text'&>
28528 .cindex "&%message%& ACL modifier"
28529 This modifier sets up a text string that is expanded and used as a response
28530 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28531 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28532 there is some complication if &%endpass%& is involved; see the description of
28533 &%accept%& for details.)
28534
28535 The expansion of the message happens at the time Exim decides that the ACL is
28536 to end, not at the time it processes &%message%&. If the expansion fails, or
28537 generates an empty string, the modifier is ignored. Here is an example where
28538 &%message%& must be specified first, because the ACL ends with a rejection if
28539 the &%hosts%& condition fails:
28540 .code
28541 require  message = Host not recognized
28542          hosts = 10.0.0.0/8
28543 .endd
28544 (Once a condition has failed, no further conditions or modifiers are
28545 processed.)
28546
28547 .cindex "SMTP" "error codes"
28548 .oindex "&%smtp_banner%&
28549 For ACLs that are triggered by SMTP commands, the message is returned as part
28550 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28551 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28552 is accepted. In the case of the connect ACL, accepting with a message modifier
28553 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28554 accept message may not contain more than one line (otherwise it will be
28555 truncated at the first newline and a panic logged), and it cannot affect the
28556 EHLO options.
28557
28558 When SMTP is involved, the message may begin with an overriding response code,
28559 consisting of three digits optionally followed by an &"extended response code"&
28560 of the form &'n.n.n'&, each code being followed by a space. For example:
28561 .code
28562 deny  message = 599 1.2.3 Host not welcome
28563       hosts = 192.168.34.0/24
28564 .endd
28565 The first digit of the supplied response code must be the same as would be sent
28566 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28567 access, but for the predata ACL, note that the default success code is 354, not
28568 2&'xx'&.
28569
28570 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28571 the message modifier cannot override the 221 response code.
28572
28573 The text in a &%message%& modifier is literal; any quotes are taken as
28574 literals, but because the string is expanded, backslash escapes are processed
28575 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28576 response.
28577
28578 .vindex "&$acl_verify_message$&"
28579 For ACLs that are called by an &%acl =%& ACL condition, the message is
28580 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28581
28582 If &%message%& is used on a statement that verifies an address, the message
28583 specified overrides any message that is generated by the verification process.
28584 However, the original message is available in the variable
28585 &$acl_verify_message$&, so you can incorporate it into your message if you
28586 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28587 routers to be passed back as part of the SMTP response, you should either not
28588 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28589
28590 For compatibility with previous releases of Exim, a &%message%& modifier that
28591 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28592 modifier, but this usage is now deprecated. However, &%message%& acts only when
28593 all the conditions are true, wherever it appears in an ACL command, whereas
28594 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28595 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28596 effect.
28597
28598
28599 .vitem &*remove_header*&&~=&~<&'text'&>
28600 This modifier specifies one or more header names in a colon-separated list
28601  that are to be removed from an incoming message, assuming, of course, that
28602 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28603
28604
28605 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28606 .cindex "&%set%& ACL modifier"
28607 This modifier puts a value into one of the ACL variables (see section
28608 &<<SECTaclvariables>>&).
28609
28610
28611 .vitem &*udpsend*&&~=&~<&'parameters'&>
28612 This modifier sends a UDP packet, for purposes such as statistics
28613 collection or behaviour monitoring. The parameters are expanded, and
28614 the result of the expansion must be a colon-separated list consisting
28615 of a destination server, port number, and the packet contents. The
28616 server can be specified as a host name or IPv4 or IPv6 address. The
28617 separator can be changed with the usual angle bracket syntax. For
28618 example, you might want to collect information on which hosts connect
28619 when:
28620 .code
28621 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28622              $tod_zulu $sender_host_address
28623 .endd
28624 .endlist
28625
28626
28627
28628
28629 .section "Use of the control modifier" "SECTcontrols"
28630 .cindex "&%control%& ACL modifier"
28631 The &%control%& modifier supports the following settings:
28632
28633 .vlist
28634 .vitem &*control&~=&~allow_auth_unadvertised*&
28635 This modifier allows a client host to use the SMTP AUTH command even when it
28636 has not been advertised in response to EHLO. Furthermore, because there are
28637 apparently some really broken clients that do this, Exim will accept AUTH after
28638 HELO (rather than EHLO) when this control is set. It should be used only if you
28639 really need it, and you should limit its use to those broken clients that do
28640 not work without it. For example:
28641 .code
28642 warn hosts   = 192.168.34.25
28643      control = allow_auth_unadvertised
28644 .endd
28645 Normally, when an Exim server receives an AUTH command, it checks the name of
28646 the authentication mechanism that is given in the command to ensure that it
28647 matches an advertised mechanism. When this control is set, the check that a
28648 mechanism has been advertised is bypassed. Any configured mechanism can be used
28649 by the client. This control is permitted only in the connection and HELO ACLs.
28650
28651
28652 .vitem &*control&~=&~caseful_local_part*& &&&
28653        &*control&~=&~caselower_local_part*&
28654 .cindex "&ACL;" "case of local part in"
28655 .cindex "case of local parts"
28656 .vindex "&$local_part$&"
28657 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28658 (that is, during RCPT processing). By default, the contents of &$local_part$&
28659 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28660 any uppercase letters in the original local part are restored in &$local_part$&
28661 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28662 is encountered.
28663
28664 These controls affect only the current recipient. Moreover, they apply only to
28665 local part handling that takes place directly in the ACL (for example, as a key
28666 in lookups). If a test to verify the recipient is obeyed, the case-related
28667 handling of the local part during the verification is controlled by the router
28668 configuration (see the &%caseful_local_part%& generic router option).
28669
28670 This facility could be used, for example, to add a spam score to local parts
28671 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28672 spam score:
28673 .code
28674 warn  control = caseful_local_part
28675       set acl_m4 = ${eval:\
28676                      $acl_m4 + \
28677                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28678                     }
28679       control = caselower_local_part
28680 .endd
28681 Notice that we put back the lower cased version afterwards, assuming that
28682 is what is wanted for subsequent tests.
28683
28684
28685 .vitem &*control&~=&~cutthrough_delivery*&
28686 .cindex "&ACL;" "cutthrough routing"
28687 .cindex "cutthrough" "requesting"
28688 This option requests delivery be attempted while the item is being received.
28689
28690 The option is usable in the RCPT ACL.
28691 If enabled for a message received via smtp and routed to an smtp transport,
28692 and only one transport, interface, destination host and port combination
28693 is used for all recipients of the message,
28694 then the delivery connection is made while the receiving connection is open
28695 and data is copied from one to the other.
28696
28697 An attempt to set this option for any recipient but the first
28698 for a mail will be quietly ignored.
28699 If a recipient-verify callout
28700 .new
28701 (with use_sender)
28702 .wen
28703 connection is subsequently
28704 requested in the same ACL it is held open and used for
28705 any subsequent recipients and the data,
28706 otherwise one is made after the initial RCPT ACL completes.
28707
28708 Note that routers are used in verify mode,
28709 and cannot depend on content of received headers.
28710 Note also that headers cannot be
28711 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28712 Headers may be modified by routers (subject to the above) and transports.
28713
28714 .new
28715 All the usual ACLs are called; if one results in the message being
28716 rejected, all effort spent in delivery (including the costs on
28717 the ultimate destination) will be wasted.
28718 Note that in the case of data-time ACLs this includes the entire
28719 message body.
28720 .wen
28721
28722 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28723 of outgoing messages is done, because it sends data to the ultimate destination
28724 before the entire message has been received from the source.
28725 It is not supported for messages received with the SMTP PRDR option in use.
28726
28727 Should the ultimate destination system positively accept or reject the mail,
28728 a corresponding indication is given to the source system and nothing is queued.
28729 If there is a temporary error the item is queued for later delivery in the
28730 usual fashion. If the item is successfully delivered in cutthrough mode
28731 the delivery log lines are tagged with ">>" rather than "=>" and appear
28732 before the acceptance "<=" line.
28733
28734 Delivery in this mode avoids the generation of a bounce mail to a
28735 (possibly faked)
28736 sender when the destination system is doing content-scan based rejection.
28737
28738
28739 .vitem &*control&~=&~debug/*&<&'options'&>
28740 .cindex "&ACL;" "enabling debug logging"
28741 .cindex "debugging" "enabling from an ACL"
28742 This control turns on debug logging, almost as though Exim had been invoked
28743 with &`-d`&, with the output going to a new logfile, by default called
28744 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28745 may access any variables already defined.  The logging may be adjusted with
28746 the &'opts'& option, which takes the same values as the &`-d`& command-line
28747 option.  Some examples (which depend on variables that don't exist in all
28748 contexts):
28749 .code
28750       control = debug
28751       control = debug/tag=.$sender_host_address
28752       control = debug/opts=+expand+acl
28753       control = debug/tag=.$message_exim_id/opts=+expand
28754 .endd
28755
28756
28757 .vitem &*control&~=&~dkim_disable_verify*&
28758 .cindex "disable DKIM verify"
28759 .cindex "DKIM" "disable verify"
28760 This control turns off DKIM verification processing entirely.  For details on
28761 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28762
28763
28764 .vitem &*control&~=&~dscp/*&<&'value'&>
28765 .cindex "&ACL;" "setting DSCP value"
28766 .cindex "DSCP" "inbound"
28767 This option causes the DSCP value associated with the socket for the inbound
28768 connection to be adjusted to a given value, given as one of a number of fixed
28769 strings or to numeric value.
28770 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28771 Common values include &`throughput`&, &`mincost`&, and on newer systems
28772 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28773
28774 The outbound packets from Exim will be marked with this value in the header
28775 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28776 that these values will have any effect, not be stripped by networking
28777 equipment, or do much of anything without cooperation with your Network
28778 Engineer and those of all network operators between the source and destination.
28779
28780
28781 .vitem &*control&~=&~enforce_sync*& &&&
28782        &*control&~=&~no_enforce_sync*&
28783 .cindex "SMTP" "synchronization checking"
28784 .cindex "synchronization checking in SMTP"
28785 These controls make it possible to be selective about when SMTP synchronization
28786 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28787 state of the switch (it is true by default). See the description of this option
28788 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28789
28790 The effect of these two controls lasts for the remainder of the SMTP
28791 connection. They can appear in any ACL except the one for the non-SMTP
28792 messages. The most straightforward place to put them is in the ACL defined by
28793 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28794 before the first synchronization check. The expected use is to turn off the
28795 synchronization checks for badly-behaved hosts that you nevertheless need to
28796 work with.
28797
28798
28799 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28800 .cindex "fake defer"
28801 .cindex "defer, fake"
28802 This control works in exactly the same way as &%fakereject%& (described below)
28803 except that it causes an SMTP 450 response after the message data instead of a
28804 550 response. You must take care when using &%fakedefer%& because it causes the
28805 messages to be duplicated when the sender retries. Therefore, you should not
28806 use &%fakedefer%& if the message is to be delivered normally.
28807
28808 .vitem &*control&~=&~fakereject/*&<&'message'&>
28809 .cindex "fake rejection"
28810 .cindex "rejection, fake"
28811 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28812 words, only when an SMTP message is being received. If Exim accepts the
28813 message, instead the final 250 response, a 550 rejection message is sent.
28814 However, Exim proceeds to deliver the message as normal. The control applies
28815 only to the current message, not to any subsequent ones that may be received in
28816 the same SMTP connection.
28817
28818 The text for the 550 response is taken from the &%control%& modifier. If no
28819 message is supplied, the following is used:
28820 .code
28821 550-Your message has been rejected but is being
28822 550-kept for evaluation.
28823 550-If it was a legitimate message, it may still be
28824 550 delivered to the target recipient(s).
28825 .endd
28826 This facility should be used with extreme caution.
28827
28828 .vitem &*control&~=&~freeze*&
28829 .cindex "frozen messages" "forcing in ACL"
28830 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28831 other words, only when a message is being received. If the message is accepted,
28832 it is placed on Exim's queue and frozen. The control applies only to the
28833 current message, not to any subsequent ones that may be received in the same
28834 SMTP connection.
28835
28836 This modifier can optionally be followed by &`/no_tell`&. If the global option
28837 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28838 is told about the freezing), provided all the &*control=freeze*& modifiers that
28839 are obeyed for the current message have the &`/no_tell`& option.
28840
28841 .vitem &*control&~=&~no_delay_flush*&
28842 .cindex "SMTP" "output flushing, disabling for delay"
28843 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28844 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28845 use. This control, as long as it is encountered before the &%delay%& modifier,
28846 disables such output flushing.
28847
28848 .vitem &*control&~=&~no_callout_flush*&
28849 .cindex "SMTP" "output flushing, disabling for callout"
28850 Exim normally flushes SMTP output before performing a callout in an ACL, to
28851 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28852 use. This control, as long as it is encountered before the &%verify%& condition
28853 that causes the callout, disables such output flushing.
28854
28855 .vitem &*control&~=&~no_mbox_unspool*&
28856 This control is available when Exim is compiled with the content scanning
28857 extension. Content scanning may require a copy of the current message, or parts
28858 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28859 or spam scanner. Normally, such copies are deleted when they are no longer
28860 needed. If this control is set, the copies are not deleted. The control applies
28861 only to the current message, not to any subsequent ones that may be received in
28862 the same SMTP connection. It is provided for debugging purposes and is unlikely
28863 to be useful in production.
28864
28865 .vitem &*control&~=&~no_multiline_responses*&
28866 .cindex "multiline responses, suppressing"
28867 This control is permitted for any ACL except the one for non-SMTP messages.
28868 It seems that there are broken clients in use that cannot handle multiline
28869 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28870
28871 If this control is set, multiline SMTP responses from ACL rejections are
28872 suppressed. One way of doing this would have been to put out these responses as
28873 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28874 (&"use multiline responses for more"& it says &-- ha!), and some of the
28875 responses might get close to that. So this facility, which is after all only a
28876 sop to broken clients, is implemented by doing two very easy things:
28877
28878 .ilist
28879 Extra information that is normally output as part of a rejection caused by
28880 sender verification failure is omitted. Only the final line (typically &"sender
28881 verification failed"&) is sent.
28882 .next
28883 If a &%message%& modifier supplies a multiline response, only the first
28884 line is output.
28885 .endlist
28886
28887 The setting of the switch can, of course, be made conditional on the
28888 calling host. Its effect lasts until the end of the SMTP connection.
28889
28890 .vitem &*control&~=&~no_pipelining*&
28891 .cindex "PIPELINING" "suppressing advertising"
28892 This control turns off the advertising of the PIPELINING extension to SMTP in
28893 the current session. To be useful, it must be obeyed before Exim sends its
28894 response to an EHLO command. Therefore, it should normally appear in an ACL
28895 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28896 &%pipelining_advertise_hosts%&.
28897
28898 .vitem &*control&~=&~queue_only*&
28899 .oindex "&%queue_only%&"
28900 .cindex "queueing incoming messages"
28901 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28902 other words, only when a message is being received. If the message is accepted,
28903 it is placed on Exim's queue and left there for delivery by a subsequent queue
28904 runner. No immediate delivery process is started. In other words, it has the
28905 effect as the &%queue_only%& global option. However, the control applies only
28906 to the current message, not to any subsequent ones that may be received in the
28907 same SMTP connection.
28908
28909 .vitem &*control&~=&~submission/*&<&'options'&>
28910 .cindex "message" "submission"
28911 .cindex "submission mode"
28912 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28913 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28914 the current message is a submission from a local MUA. In this case, Exim
28915 operates in &"submission mode"&, and applies certain fixups to the message if
28916 necessary. For example, it adds a &'Date:'& header line if one is not present.
28917 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28918 late (the message has already been created).
28919
28920 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28921 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28922 submission mode; the available options for this control are described there.
28923 The control applies only to the current message, not to any subsequent ones
28924 that may be received in the same SMTP connection.
28925
28926 .vitem &*control&~=&~suppress_local_fixups*&
28927 .cindex "submission fixups, suppressing"
28928 This control applies to locally submitted (non TCP/IP) messages, and is the
28929 complement of &`control = submission`&. It disables the fixups that are
28930 normally applied to locally-submitted messages. Specifically:
28931
28932 .ilist
28933 Any &'Sender:'& header line is left alone (in this respect, it is a
28934 dynamic version of &%local_sender_retain%&).
28935 .next
28936 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28937 .next
28938 There is no check that &'From:'& corresponds to the actual sender.
28939 .endlist ilist
28940
28941 This control may be useful when a remotely-originated message is accepted,
28942 passed to some scanning program, and then re-submitted for delivery. It can be
28943 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28944 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28945 data is read.
28946
28947 &*Note:*& This control applies only to the current message, not to any others
28948 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28949
28950 .new
28951 .vitem &*control&~=&~utf8_downconvert*&
28952 This control enables conversion of UTF-8 in message addresses
28953 to a-label form.
28954 For details see &<<SECTi18nMTA>>&.
28955 .wen
28956 .endlist vlist
28957
28958
28959 .section "Summary of message fixup control" "SECTsummesfix"
28960 All four possibilities for message fixups can be specified:
28961
28962 .ilist
28963 Locally submitted, fixups applied: the default.
28964 .next
28965 Locally submitted, no fixups applied: use
28966 &`control = suppress_local_fixups`&.
28967 .next
28968 Remotely submitted, no fixups applied: the default.
28969 .next
28970 Remotely submitted, fixups applied: use &`control = submission`&.
28971 .endlist
28972
28973
28974
28975 .section "Adding header lines in ACLs" "SECTaddheadacl"
28976 .cindex "header lines" "adding in an ACL"
28977 .cindex "header lines" "position of added lines"
28978 .cindex "&%add_header%& ACL modifier"
28979 The &%add_header%& modifier can be used to add one or more extra header lines
28980 to an incoming message, as in this example:
28981 .code
28982 warn dnslists = sbl.spamhaus.org : \
28983                 dialup.mail-abuse.org
28984      add_header = X-blacklisted-at: $dnslist_domain
28985 .endd
28986 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28987 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28988 receiving a message). The message must ultimately be accepted for
28989 &%add_header%& to have any significant effect. You can use &%add_header%& with
28990 any ACL verb, including &%deny%& (though this is potentially useful only in a
28991 RCPT ACL).
28992
28993 Headers will not be added to the message if the modifier is used in
28994 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28995
28996 Leading and trailing newlines are removed from
28997 the data for the &%add_header%& modifier; if it then
28998 contains one or more newlines that
28999 are not followed by a space or a tab, it is assumed to contain multiple header
29000 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29001 front of any line that is not a valid header line.
29002
29003 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29004 They are added to the message before processing the DATA and MIME ACLs.
29005 However, if an identical header line is requested more than once, only one copy
29006 is actually added to the message. Further header lines may be accumulated
29007 during the DATA and MIME ACLs, after which they are added to the message, again
29008 with duplicates suppressed. Thus, it is possible to add two identical header
29009 lines to an SMTP message, but only if one is added before DATA and one after.
29010 In the case of non-SMTP messages, new headers are accumulated during the
29011 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29012 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29013 are included in the entry that is written to the reject log.
29014
29015 .cindex "header lines" "added; visibility of"
29016 Header lines are not visible in string expansions
29017 of message headers
29018 until they are added to the
29019 message. It follows that header lines defined in the MAIL, RCPT, and predata
29020 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29021 header lines that are added by the DATA or MIME ACLs are not visible in those
29022 ACLs. Because of this restriction, you cannot use header lines as a way of
29023 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29024 this, you can use ACL variables, as described in section
29025 &<<SECTaclvariables>>&.
29026
29027 The list of headers yet to be added is given by the &%$headers_added%& variable.
29028
29029 The &%add_header%& modifier acts immediately as it is encountered during the
29030 processing of an ACL. Notice the difference between these two cases:
29031 .display
29032 &`accept add_header = ADDED: some text`&
29033 &`       `&<&'some condition'&>
29034
29035 &`accept `&<&'some condition'&>
29036 &`       add_header = ADDED: some text`&
29037 .endd
29038 In the first case, the header line is always added, whether or not the
29039 condition is true. In the second case, the header line is added only if the
29040 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29041 ACL statement. All those that are encountered before a condition fails are
29042 honoured.
29043
29044 .cindex "&%warn%& ACL verb"
29045 For compatibility with previous versions of Exim, a &%message%& modifier for a
29046 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29047 effect only if all the conditions are true, even if it appears before some of
29048 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29049 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29050 are present on a &%warn%& verb, both are processed according to their
29051 specifications.
29052
29053 By default, new header lines are added to a message at the end of the existing
29054 header lines. However, you can specify that any particular header line should
29055 be added right at the start (before all the &'Received:'& lines), immediately
29056 after the first block of &'Received:'& lines, or immediately before any line
29057 that is not a &'Received:'& or &'Resent-something:'& header.
29058
29059 This is done by specifying &":at_start:"&, &":after_received:"&, or
29060 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29061 header line, respectively. (Header text cannot start with a colon, as there has
29062 to be a header name first.) For example:
29063 .code
29064 warn add_header = \
29065        :after_received:X-My-Header: something or other...
29066 .endd
29067 If more than one header line is supplied in a single &%add_header%& modifier,
29068 each one is treated independently and can therefore be placed differently. If
29069 you add more than one line at the start, or after the Received: block, they end
29070 up in reverse order.
29071
29072 &*Warning*&: This facility currently applies only to header lines that are
29073 added in an ACL. It does NOT work for header lines that are added in a
29074 system filter or in a router or transport.
29075
29076
29077
29078 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29079 .cindex "header lines" "removing in an ACL"
29080 .cindex "header lines" "position of removed lines"
29081 .cindex "&%remove_header%& ACL modifier"
29082 The &%remove_header%& modifier can be used to remove one or more header lines
29083 from an incoming message, as in this example:
29084 .code
29085 warn   message        = Remove internal headers
29086        remove_header  = x-route-mail1 : x-route-mail2
29087 .endd
29088 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29089 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29090 receiving a message). The message must ultimately be accepted for
29091 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29092 with any ACL verb, including &%deny%&, though this is really not useful for
29093 any verb that doesn't result in a delivered message.
29094
29095 Headers will not be removed to the message if the modifier is used in
29096 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29097
29098 More than one header can be removed at the same time by using a colon separated
29099 list of header names. The header matching is case insensitive. Wildcards are
29100 not permitted, nor is list expansion performed, so you cannot use hostlists to
29101 create a list of headers, however both connection and message variable expansion
29102 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29103 .code
29104 warn   hosts           = +internal_hosts
29105        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29106 warn   message         = Remove internal headers
29107        remove_header   = $acl_c_ihdrs
29108 .endd
29109 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29110 They are removed from the message before processing the DATA and MIME ACLs.
29111 There is no harm in attempting to remove the same header twice nor is removing
29112 a non-existent header. Further header lines to be removed may be accumulated
29113 during the DATA and MIME ACLs, after which they are removed from the message,
29114 if present. In the case of non-SMTP messages, headers to be removed are
29115 accumulated during the non-SMTP ACLs, and are removed from the message after
29116 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29117 ACL, there really is no effect because there is no logging of what headers
29118 would have been removed.
29119
29120 .cindex "header lines" "removed; visibility of"
29121 Header lines are not visible in string expansions until the DATA phase when it
29122 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29123 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29124 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29125 this restriction, you cannot use header lines as a way of controlling data
29126 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29127 you should instead use ACL variables, as described in section
29128 &<<SECTaclvariables>>&.
29129
29130 The &%remove_header%& modifier acts immediately as it is encountered during the
29131 processing of an ACL. Notice the difference between these two cases:
29132 .display
29133 &`accept remove_header = X-Internal`&
29134 &`       `&<&'some condition'&>
29135
29136 &`accept `&<&'some condition'&>
29137 &`       remove_header = X-Internal`&
29138 .endd
29139 In the first case, the header line is always removed, whether or not the
29140 condition is true. In the second case, the header line is removed only if the
29141 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29142 same ACL statement. All those that are encountered before a condition fails
29143 are honoured.
29144
29145 &*Warning*&: This facility currently applies only to header lines that are
29146 present during ACL processing. It does NOT remove header lines that are added
29147 in a system filter or in a router or transport.
29148
29149
29150
29151
29152 .section "ACL conditions" "SECTaclconditions"
29153 .cindex "&ACL;" "conditions; list of"
29154 Some of the conditions listed in this section are available only when Exim is
29155 compiled with the content-scanning extension. They are included here briefly
29156 for completeness. More detailed descriptions can be found in the discussion on
29157 content scanning in chapter &<<CHAPexiscan>>&.
29158
29159 Not all conditions are relevant in all circumstances. For example, testing
29160 senders and recipients does not make sense in an ACL that is being run as the
29161 result of the arrival of an ETRN command, and checks on message headers can be
29162 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29163 can use the same condition (with different parameters) more than once in the
29164 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29165 The conditions are as follows:
29166
29167
29168 .vlist
29169 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29170 .cindex "&ACL;" "nested"
29171 .cindex "&ACL;" "indirect"
29172 .cindex "&ACL;" "arguments"
29173 .cindex "&%acl%& ACL condition"
29174 The possible values of the argument are the same as for the
29175 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29176 &"accept"& the condition is true; if it returns &"deny"& the condition is
29177 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29178 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29179 condition false. This means that further processing of the &%warn%& verb
29180 ceases, but processing of the ACL continues.
29181
29182 If the argument is a named ACL, up to nine space-separated optional values
29183 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29184 and $acl_narg is set to the count of values.
29185 Previous values of these variables are restored after the call returns.
29186 The name and values are expanded separately.
29187 Note that spaces in complex expansions which are used as arguments
29188 will act as argument separators.
29189
29190 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29191 the connection is dropped. If it returns &"discard"&, the verb must be
29192 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29193 conditions are tested.
29194
29195 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29196 loops. This condition allows you to use different ACLs in different
29197 circumstances. For example, different ACLs can be used to handle RCPT commands
29198 for different local users or different local domains.
29199
29200 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29201 .cindex "&%authenticated%& ACL condition"
29202 .cindex "authentication" "ACL checking"
29203 .cindex "&ACL;" "testing for authentication"
29204 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29205 the name of the authenticator is tested against the list. To test for
29206 authentication by any authenticator, you can set
29207 .code
29208 authenticated = *
29209 .endd
29210
29211 .vitem &*condition&~=&~*&<&'string'&>
29212 .cindex "&%condition%& ACL condition"
29213 .cindex "customizing" "ACL condition"
29214 .cindex "&ACL;" "customized test"
29215 .cindex "&ACL;" "testing, customized"
29216 This feature allows you to make up custom conditions. If the result of
29217 expanding the string is an empty string, the number zero, or one of the strings
29218 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29219 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29220 any other value, some error is assumed to have occurred, and the ACL returns
29221 &"defer"&. However, if the expansion is forced to fail, the condition is
29222 ignored. The effect is to treat it as true, whether it is positive or
29223 negative.
29224
29225 .vitem &*decode&~=&~*&<&'location'&>
29226 .cindex "&%decode%& ACL condition"
29227 This condition is available only when Exim is compiled with the
29228 content-scanning extension, and it is allowed only in the ACL defined by
29229 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29230 If all goes well, the condition is true. It is false only if there are
29231 problems such as a syntax error or a memory shortage. For more details, see
29232 chapter &<<CHAPexiscan>>&.
29233
29234 .vitem &*demime&~=&~*&<&'extension&~list'&>
29235 .cindex "&%demime%& ACL condition"
29236 This condition is available only when Exim is compiled with the
29237 content-scanning extension. Its use is described in section
29238 &<<SECTdemimecond>>&.
29239
29240 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29241 .cindex "&%dnslists%& ACL condition"
29242 .cindex "DNS list" "in ACL"
29243 .cindex "black list (DNS)"
29244 .cindex "&ACL;" "testing a DNS list"
29245 This condition checks for entries in DNS black lists. These are also known as
29246 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29247 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29248 different variants of this condition to describe briefly here. See sections
29249 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29250
29251 .vitem &*domains&~=&~*&<&'domain&~list'&>
29252 .cindex "&%domains%& ACL condition"
29253 .cindex "domain" "ACL checking"
29254 .cindex "&ACL;" "testing a recipient domain"
29255 .vindex "&$domain_data$&"
29256 This condition is relevant only after a RCPT command. It checks that the domain
29257 of the recipient address is in the domain list. If percent-hack processing is
29258 enabled, it is done before this test is done. If the check succeeds with a
29259 lookup, the result of the lookup is placed in &$domain_data$& until the next
29260 &%domains%& test.
29261
29262 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29263 use &%domains%& in a DATA ACL.
29264
29265
29266 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29267 .cindex "&%encrypted%& ACL condition"
29268 .cindex "encryption" "checking in an ACL"
29269 .cindex "&ACL;" "testing for encryption"
29270 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29271 name of the cipher suite in use is tested against the list. To test for
29272 encryption without testing for any specific cipher suite(s), set
29273 .code
29274 encrypted = *
29275 .endd
29276
29277
29278 .vitem &*hosts&~=&~*&<&'host&~list'&>
29279 .cindex "&%hosts%& ACL condition"
29280 .cindex "host" "ACL checking"
29281 .cindex "&ACL;" "testing the client host"
29282 This condition tests that the calling host matches the host list. If you have
29283 name lookups or wildcarded host names and IP addresses in the same host list,
29284 you should normally put the IP addresses first. For example, you could have:
29285 .code
29286 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29287 .endd
29288 The lookup in this example uses the host name for its key. This is implied by
29289 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29290 and it wouldn't matter which way round you had these two items.)
29291
29292 The reason for the problem with host names lies in the left-to-right way that
29293 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29294 but when it reaches an item that requires a host name, it fails if it cannot
29295 find a host name to compare with the pattern. If the above list is given in the
29296 opposite order, the &%accept%& statement fails for a host whose name cannot be
29297 found, even if its IP address is 10.9.8.7.
29298
29299 If you really do want to do the name check first, and still recognize the IP
29300 address even if the name lookup fails, you can rewrite the ACL like this:
29301 .code
29302 accept hosts = dbm;/etc/friendly/hosts
29303 accept hosts = 10.9.8.7
29304 .endd
29305 The default action on failing to find the host name is to assume that the host
29306 is not in the list, so the first &%accept%& statement fails. The second
29307 statement can then check the IP address.
29308
29309 .vindex "&$host_data$&"
29310 If a &%hosts%& condition is satisfied by means of a lookup, the result
29311 of the lookup is made available in the &$host_data$& variable. This
29312 allows you, for example, to set up a statement like this:
29313 .code
29314 deny  hosts = net-lsearch;/some/file
29315 message = $host_data
29316 .endd
29317 which gives a custom error message for each denied host.
29318
29319 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29320 .cindex "&%local_parts%& ACL condition"
29321 .cindex "local part" "ACL checking"
29322 .cindex "&ACL;" "testing a local part"
29323 .vindex "&$local_part_data$&"
29324 This condition is relevant only after a RCPT command. It checks that the local
29325 part of the recipient address is in the list. If percent-hack processing is
29326 enabled, it is done before this test. If the check succeeds with a lookup, the
29327 result of the lookup is placed in &$local_part_data$&, which remains set until
29328 the next &%local_parts%& test.
29329
29330 .vitem &*malware&~=&~*&<&'option'&>
29331 .cindex "&%malware%& ACL condition"
29332 .cindex "&ACL;" "virus scanning"
29333 .cindex "&ACL;" "scanning for viruses"
29334 This condition is available only when Exim is compiled with the
29335 content-scanning extension. It causes the incoming message to be scanned for
29336 viruses. For details, see chapter &<<CHAPexiscan>>&.
29337
29338 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29339 .cindex "&%mime_regex%& ACL condition"
29340 .cindex "&ACL;" "testing by regex matching"
29341 This condition is available only when Exim is compiled with the
29342 content-scanning extension, and it is allowed only in the ACL defined by
29343 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29344 with any of the regular expressions. For details, see chapter
29345 &<<CHAPexiscan>>&.
29346
29347 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29348 .cindex "rate limiting"
29349 This condition can be used to limit the rate at which a user or host submits
29350 messages. Details are given in section &<<SECTratelimiting>>&.
29351
29352 .vitem &*recipients&~=&~*&<&'address&~list'&>
29353 .cindex "&%recipients%& ACL condition"
29354 .cindex "recipient" "ACL checking"
29355 .cindex "&ACL;" "testing a recipient"
29356 This condition is relevant only after a RCPT command. It checks the entire
29357 recipient address against a list of recipients.
29358
29359 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29360 .cindex "&%regex%& ACL condition"
29361 .cindex "&ACL;" "testing by regex matching"
29362 This condition is available only when Exim is compiled with the
29363 content-scanning extension, and is available only in the DATA, MIME, and
29364 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29365 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29366
29367 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29368 .cindex "&%sender_domains%& ACL condition"
29369 .cindex "sender" "ACL checking"
29370 .cindex "&ACL;" "testing a sender domain"
29371 .vindex "&$domain$&"
29372 .vindex "&$sender_address_domain$&"
29373 This condition tests the domain of the sender of the message against the given
29374 domain list. &*Note*&: The domain of the sender address is in
29375 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29376 of this condition. This is an exception to the general rule for testing domain
29377 lists. It is done this way so that, if this condition is used in an ACL for a
29378 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29379 influence the sender checking.
29380
29381 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29382 relaying, because sender addresses are easily, and commonly, forged.
29383
29384 .vitem &*senders&~=&~*&<&'address&~list'&>
29385 .cindex "&%senders%& ACL condition"
29386 .cindex "sender" "ACL checking"
29387 .cindex "&ACL;" "testing a sender"
29388 This condition tests the sender of the message against the given list. To test
29389 for a bounce message, which has an empty sender, set
29390 .code
29391 senders = :
29392 .endd
29393 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29394 relaying, because sender addresses are easily, and commonly, forged.
29395
29396 .vitem &*spam&~=&~*&<&'username'&>
29397 .cindex "&%spam%& ACL condition"
29398 .cindex "&ACL;" "scanning for spam"
29399 This condition is available only when Exim is compiled with the
29400 content-scanning extension. It causes the incoming message to be scanned by
29401 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29402
29403 .vitem &*verify&~=&~certificate*&
29404 .cindex "&%verify%& ACL condition"
29405 .cindex "TLS" "client certificate verification"
29406 .cindex "certificate" "verification of client"
29407 .cindex "&ACL;" "certificate verification"
29408 .cindex "&ACL;" "testing a TLS certificate"
29409 This condition is true in an SMTP session if the session is encrypted, and a
29410 certificate was received from the client, and the certificate was verified. The
29411 server requests a certificate only if the client matches &%tls_verify_hosts%&
29412 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29413
29414 .vitem &*verify&~=&~csa*&
29415 .cindex "CSA verification"
29416 This condition checks whether the sending host (the client) is authorized to
29417 send email. Details of how this works are given in section
29418 &<<SECTverifyCSA>>&.
29419
29420 .vitem &*verify&~=&~header_names_ascii*&
29421 .cindex "&%verify%& ACL condition"
29422 .cindex "&ACL;" "verifying header names only ASCII"
29423 .cindex "header lines" "verifying header names only ASCII"
29424 .cindex "verifying" "header names only ASCII"
29425 This condition is relevant only in an ACL that is run after a message has been
29426 received, that is, in an ACL specified by &%acl_smtp_data%& or
29427 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29428 there are no non-ASCII characters, also excluding control characters.  The
29429 allowable characters are decimal ASCII values 33 through 126.
29430
29431 Exim itself will handle headers with non-ASCII characters, but it can cause
29432 problems for downstream applications, so this option will allow their
29433 detection and rejection in the DATA ACL's.
29434
29435 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29436 .cindex "&%verify%& ACL condition"
29437 .cindex "&ACL;" "verifying sender in the header"
29438 .cindex "header lines" "verifying the sender in"
29439 .cindex "sender" "verifying in header"
29440 .cindex "verifying" "sender in header"
29441 This condition is relevant only in an ACL that is run after a message has been
29442 received, that is, in an ACL specified by &%acl_smtp_data%& or
29443 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29444 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29445 is loosely thought of as a &"sender"& address (hence the name of the test).
29446 However, an address that appears in one of these headers need not be an address
29447 that accepts bounce messages; only sender addresses in envelopes are required
29448 to accept bounces. Therefore, if you use the callout option on this check, you
29449 might want to arrange for a non-empty address in the MAIL command.
29450
29451 Details of address verification and the options are given later, starting at
29452 section &<<SECTaddressverification>>& (callouts are described in section
29453 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29454 condition to restrict it to bounce messages only:
29455 .code
29456 deny    senders = :
29457         message = A valid sender header is required for bounces
29458        !verify  = header_sender
29459 .endd
29460
29461 .vitem &*verify&~=&~header_syntax*&
29462 .cindex "&%verify%& ACL condition"
29463 .cindex "&ACL;" "verifying header syntax"
29464 .cindex "header lines" "verifying syntax"
29465 .cindex "verifying" "header syntax"
29466 This condition is relevant only in an ACL that is run after a message has been
29467 received, that is, in an ACL specified by &%acl_smtp_data%& or
29468 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29469 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29470 and &'Bcc:'&), returning true if there are no problems.
29471 Unqualified addresses (local parts without domains) are
29472 permitted only in locally generated messages and from hosts that match
29473 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29474 appropriate.
29475
29476 Note that this condition is a syntax check only. However, a common spamming
29477 ploy used to be to send syntactically invalid headers such as
29478 .code
29479 To: @
29480 .endd
29481 and this condition can be used to reject such messages, though they are not as
29482 common as they used to be.
29483
29484 .vitem &*verify&~=&~helo*&
29485 .cindex "&%verify%& ACL condition"
29486 .cindex "&ACL;" "verifying HELO/EHLO"
29487 .cindex "HELO" "verifying"
29488 .cindex "EHLO" "verifying"
29489 .cindex "verifying" "EHLO"
29490 .cindex "verifying" "HELO"
29491 This condition is true if a HELO or EHLO command has been received from the
29492 client host, and its contents have been verified. If there has been no previous
29493 attempt to verify the HELO/EHLO contents, it is carried out when this
29494 condition is encountered. See the description of the &%helo_verify_hosts%& and
29495 &%helo_try_verify_hosts%& options for details of how to request verification
29496 independently of this condition.
29497
29498 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29499 option), this condition is always true.
29500
29501
29502 .vitem &*verify&~=&~not_blind*&
29503 .cindex "verifying" "not blind"
29504 .cindex "bcc recipients, verifying none"
29505 This condition checks that there are no blind (bcc) recipients in the message.
29506 Every envelope recipient must appear either in a &'To:'& header line or in a
29507 &'Cc:'& header line for this condition to be true. Local parts are checked
29508 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29509 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29510 used only in a DATA or non-SMTP ACL.
29511
29512 There are, of course, many legitimate messages that make use of blind (bcc)
29513 recipients. This check should not be used on its own for blocking messages.
29514
29515
29516 .vitem &*verify&~=&~recipient/*&<&'options'&>
29517 .cindex "&%verify%& ACL condition"
29518 .cindex "&ACL;" "verifying recipient"
29519 .cindex "recipient" "verifying"
29520 .cindex "verifying" "recipient"
29521 .vindex "&$address_data$&"
29522 This condition is relevant only after a RCPT command. It verifies the current
29523 recipient. Details of address verification are given later, starting at section
29524 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29525 of &$address_data$& is the last value that was set while routing the address.
29526 This applies even if the verification fails. When an address that is being
29527 verified is redirected to a single address, verification continues with the new
29528 address, and in that case, the subsequent value of &$address_data$& is the
29529 value for the child address.
29530
29531 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29532 .cindex "&%verify%& ACL condition"
29533 .cindex "&ACL;" "verifying host reverse lookup"
29534 .cindex "host" "verifying reverse lookup"
29535 This condition ensures that a verified host name has been looked up from the IP
29536 address of the client host. (This may have happened already if the host name
29537 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29538 Verification ensures that the host name obtained from a reverse DNS lookup, or
29539 one of its aliases, does, when it is itself looked up in the DNS, yield the
29540 original IP address.
29541
29542 There is one possible option, &`defer_ok`&.  If this is present and a
29543 DNS operation returns a temporary error, the verify condition succeeds.
29544
29545 If this condition is used for a locally generated message (that is, when there
29546 is no client host involved), it always succeeds.
29547
29548 .vitem &*verify&~=&~sender/*&<&'options'&>
29549 .cindex "&%verify%& ACL condition"
29550 .cindex "&ACL;" "verifying sender"
29551 .cindex "sender" "verifying"
29552 .cindex "verifying" "sender"
29553 This condition is relevant only after a MAIL or RCPT command, or after a
29554 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29555 the message's sender is empty (that is, this is a bounce message), the
29556 condition is true. Otherwise, the sender address is verified.
29557
29558 .vindex "&$address_data$&"
29559 .vindex "&$sender_address_data$&"
29560 If there is data in the &$address_data$& variable at the end of routing, its
29561 value is placed in &$sender_address_data$& at the end of verification. This
29562 value can be used in subsequent conditions and modifiers in the same ACL
29563 statement. It does not persist after the end of the current statement. If you
29564 want to preserve the value for longer, you can save it in an ACL variable.
29565
29566 Details of verification are given later, starting at section
29567 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29568 to avoid doing it more than once per message.
29569
29570 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29571 .cindex "&%verify%& ACL condition"
29572 This is a variation of the previous option, in which a modified address is
29573 verified as a sender.
29574 .endlist
29575
29576
29577
29578 .section "Using DNS lists" "SECTmorednslists"
29579 .cindex "DNS list" "in ACL"
29580 .cindex "black list (DNS)"
29581 .cindex "&ACL;" "testing a DNS list"
29582 In its simplest form, the &%dnslists%& condition tests whether the calling host
29583 is on at least one of a number of DNS lists by looking up the inverted IP
29584 address in one or more DNS domains. (Note that DNS list domains are not mail
29585 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29586 special options instead.) For example, if the calling host's IP
29587 address is 192.168.62.43, and the ACL statement is
29588 .code
29589 deny dnslists = blackholes.mail-abuse.org : \
29590                 dialups.mail-abuse.org
29591 .endd
29592 the following records are looked up:
29593 .code
29594 43.62.168.192.blackholes.mail-abuse.org
29595 43.62.168.192.dialups.mail-abuse.org
29596 .endd
29597 As soon as Exim finds an existing DNS record, processing of the list stops.
29598 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29599 to test that a host is on more than one list (an &"and"& conjunction), you can
29600 use two separate conditions:
29601 .code
29602 deny dnslists = blackholes.mail-abuse.org
29603      dnslists = dialups.mail-abuse.org
29604 .endd
29605 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29606 behaves as if the host does not match the list item, that is, as if the DNS
29607 record does not exist. If there are further items in the DNS list, they are
29608 processed.
29609
29610 This is usually the required action when &%dnslists%& is used with &%deny%&
29611 (which is the most common usage), because it prevents a DNS failure from
29612 blocking mail. However, you can change this behaviour by putting one of the
29613 following special items in the list:
29614 .display
29615 &`+include_unknown `&   behave as if the item is on the list
29616 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29617 &`+defer_unknown   `&   give a temporary error
29618 .endd
29619 .cindex "&`+include_unknown`&"
29620 .cindex "&`+exclude_unknown`&"
29621 .cindex "&`+defer_unknown`&"
29622 Each of these applies to any subsequent items on the list. For example:
29623 .code
29624 deny dnslists = +defer_unknown : foo.bar.example
29625 .endd
29626 Testing the list of domains stops as soon as a match is found. If you want to
29627 warn for one list and block for another, you can use two different statements:
29628 .code
29629 deny  dnslists = blackholes.mail-abuse.org
29630 warn  message  = X-Warn: sending host is on dialups list
29631       dnslists = dialups.mail-abuse.org
29632 .endd
29633 .cindex cacheing "of dns lookup"
29634 .cindex DNS TTL
29635 DNS list lookups are cached by Exim for the duration of the SMTP session
29636 .new
29637 (but limited by the DNS return TTL value),
29638 .wen
29639 so a lookup based on the IP address is done at most once for any incoming
29640 connection (assuming long-enough TTL).
29641 Exim does not share information between multiple incoming
29642 connections (but your local name server cache should be active).
29643
29644
29645
29646 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29647 .cindex "DNS list" "keyed by explicit IP address"
29648 By default, the IP address that is used in a DNS list lookup is the IP address
29649 of the calling host. However, you can specify another IP address by listing it
29650 after the domain name, introduced by a slash. For example:
29651 .code
29652 deny dnslists = black.list.tld/192.168.1.2
29653 .endd
29654 This feature is not very helpful with explicit IP addresses; it is intended for
29655 use with IP addresses that are looked up, for example, the IP addresses of the
29656 MX hosts or nameservers of an email sender address. For an example, see section
29657 &<<SECTmulkeyfor>>& below.
29658
29659
29660
29661
29662 .section "DNS lists keyed on domain names" "SECID202"
29663 .cindex "DNS list" "keyed by domain name"
29664 There are some lists that are keyed on domain names rather than inverted IP
29665 addresses (see for example the &'domain based zones'& link at
29666 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29667 with these lists. You can change the name that is looked up in a DNS list by
29668 listing it after the domain name, introduced by a slash. For example,
29669 .code
29670 deny  message  = Sender's domain is listed at $dnslist_domain
29671       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29672 .endd
29673 This particular example is useful only in ACLs that are obeyed after the
29674 RCPT or DATA commands, when a sender address is available. If (for
29675 example) the message's sender is &'user@tld.example'& the name that is looked
29676 up by this example is
29677 .code
29678 tld.example.dsn.rfc-ignorant.org
29679 .endd
29680 A single &%dnslists%& condition can contain entries for both names and IP
29681 addresses. For example:
29682 .code
29683 deny dnslists = sbl.spamhaus.org : \
29684                 dsn.rfc-ignorant.org/$sender_address_domain
29685 .endd
29686 The first item checks the sending host's IP address; the second checks a domain
29687 name. The whole condition is true if either of the DNS lookups succeeds.
29688
29689
29690
29691
29692 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29693 .cindex "DNS list" "multiple keys for"
29694 The syntax described above for looking up explicitly-defined values (either
29695 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29696 name for the DNS list, what follows the slash can in fact be a list of items.
29697 As with all lists in Exim, the default separator is a colon. However, because
29698 this is a sublist within the list of DNS blacklist domains, it is necessary
29699 either to double the separators like this:
29700 .code
29701 dnslists = black.list.tld/name.1::name.2
29702 .endd
29703 or to change the separator character, like this:
29704 .code
29705 dnslists = black.list.tld/<;name.1;name.2
29706 .endd
29707 If an item in the list is an IP address, it is inverted before the DNS
29708 blacklist domain is appended. If it is not an IP address, no inversion
29709 occurs. Consider this condition:
29710 .code
29711 dnslists = black.list.tld/<;192.168.1.2;a.domain
29712 .endd
29713 The DNS lookups that occur are:
29714 .code
29715 2.1.168.192.black.list.tld
29716 a.domain.black.list.tld
29717 .endd
29718 Once a DNS record has been found (that matches a specific IP return
29719 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29720 are done. If there is a temporary DNS error, the rest of the sublist of domains
29721 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29722 only if no other DNS lookup in this sublist succeeds. In other words, a
29723 successful lookup for any of the items in the sublist overrides a temporary
29724 error for a previous item.
29725
29726 The ability to supply a list of items after the slash is in some sense just a
29727 syntactic convenience. These two examples have the same effect:
29728 .code
29729 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29730 dnslists = black.list.tld/a.domain::b.domain
29731 .endd
29732 However, when the data for the list is obtained from a lookup, the second form
29733 is usually much more convenient. Consider this example:
29734 .code
29735 deny message  = The mail servers for the domain \
29736                 $sender_address_domain \
29737                 are listed at $dnslist_domain ($dnslist_value); \
29738                 see $dnslist_text.
29739      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29740                                    ${lookup dnsdb {>|mxh=\
29741                                    $sender_address_domain} }} }
29742 .endd
29743 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29744 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29745 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29746 of expanding the condition might be something like this:
29747 .code
29748 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29749 .endd
29750 Thus, this example checks whether or not the IP addresses of the sender
29751 domain's mail servers are on the Spamhaus black list.
29752
29753 The key that was used for a successful DNS list lookup is put into the variable
29754 &$dnslist_matched$& (see section &<<SECID204>>&).
29755
29756
29757
29758
29759 .section "Data returned by DNS lists" "SECID203"
29760 .cindex "DNS list" "data returned from"
29761 DNS lists are constructed using address records in the DNS. The original RBL
29762 just used the address 127.0.0.1 on the right hand side of each record, but the
29763 RBL+ list and some other lists use a number of values with different meanings.
29764 The values used on the RBL+ list are:
29765 .display
29766 127.1.0.1  RBL
29767 127.1.0.2  DUL
29768 127.1.0.3  DUL and RBL
29769 127.1.0.4  RSS
29770 127.1.0.5  RSS and RBL
29771 127.1.0.6  RSS and DUL
29772 127.1.0.7  RSS and DUL and RBL
29773 .endd
29774 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29775 different values. Some DNS lists may return more than one address record;
29776 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29777
29778
29779 .section "Variables set from DNS lists" "SECID204"
29780 .cindex "expansion" "variables, set from DNS list"
29781 .cindex "DNS list" "variables set from"
29782 .vindex "&$dnslist_domain$&"
29783 .vindex "&$dnslist_matched$&"
29784 .vindex "&$dnslist_text$&"
29785 .vindex "&$dnslist_value$&"
29786 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29787 the name of the overall domain that matched (for example,
29788 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29789 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29790 the DNS record. When the key is an IP address, it is not reversed in
29791 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29792 cases, for example:
29793 .code
29794 deny dnslists = spamhaus.example
29795 .endd
29796 the key is also available in another variable (in this case,
29797 &$sender_host_address$&). In more complicated cases, however, this is not true.
29798 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29799 might generate a dnslists lookup like this:
29800 .code
29801 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29802 .endd
29803 If this condition succeeds, the value in &$dnslist_matched$& might be
29804 &`192.168.6.7`& (for example).
29805
29806 If more than one address record is returned by the DNS lookup, all the IP
29807 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29808 The variable &$dnslist_text$& contains the contents of any associated TXT
29809 record. For lists such as RBL+ the TXT record for a merged entry is often not
29810 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29811 information.
29812
29813 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29814 &-- although these appear before the condition in the ACL, they are not
29815 expanded until after it has failed. For example:
29816 .code
29817 deny    hosts = !+local_networks
29818         message = $sender_host_address is listed \
29819                   at $dnslist_domain
29820         dnslists = rbl-plus.mail-abuse.example
29821 .endd
29822
29823
29824
29825 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29826 .cindex "DNS list" "matching specific returned data"
29827 You can add an equals sign and an IP address after a &%dnslists%& domain name
29828 in order to restrict its action to DNS records with a matching right hand side.
29829 For example,
29830 .code
29831 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29832 .endd
29833 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29834 any address record is considered to be a match. For the moment, we assume
29835 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29836 describes how multiple records are handled.
29837
29838 More than one IP address may be given for checking, using a comma as a
29839 separator. These are alternatives &-- if any one of them matches, the
29840 &%dnslists%& condition is true. For example:
29841 .code
29842 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29843 .endd
29844 If you want to specify a constraining address list and also specify names or IP
29845 addresses to be looked up, the constraining address list must be specified
29846 first. For example:
29847 .code
29848 deny dnslists = dsn.rfc-ignorant.org\
29849                 =127.0.0.2/$sender_address_domain
29850 .endd
29851
29852 If the character &`&&`& is used instead of &`=`&, the comparison for each
29853 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29854 In other words, the listed addresses are used as bit masks. The comparison is
29855 true if all the bits in the mask are present in the address that is being
29856 tested. For example:
29857 .code
29858 dnslists = a.b.c&0.0.0.3
29859 .endd
29860 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29861 want to test whether one bit or another bit is present (as opposed to both
29862 being present), you must use multiple values. For example:
29863 .code
29864 dnslists = a.b.c&0.0.0.1,0.0.0.2
29865 .endd
29866 matches if the final component of the address is an odd number or two times
29867 an odd number.
29868
29869
29870
29871 .section "Negated DNS matching conditions" "SECID205"
29872 You can supply a negative list of IP addresses as part of a &%dnslists%&
29873 condition. Whereas
29874 .code
29875 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29876 .endd
29877 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29878 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29879 .code
29880 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29881 .endd
29882 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29883 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29884 words, the result of the test is inverted if an exclamation mark appears before
29885 the &`=`& (or the &`&&`&) sign.
29886
29887 &*Note*&: This kind of negation is not the same as negation in a domain,
29888 host, or address list (which is why the syntax is different).
29889
29890 If you are using just one list, the negation syntax does not gain you much. The
29891 previous example is precisely equivalent to
29892 .code
29893 deny  dnslists = a.b.c
29894      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29895 .endd
29896 However, if you are using multiple lists, the negation syntax is clearer.
29897 Consider this example:
29898 .code
29899 deny  dnslists = sbl.spamhaus.org : \
29900                  list.dsbl.org : \
29901                  dnsbl.njabl.org!=127.0.0.3 : \
29902                  relays.ordb.org
29903 .endd
29904 Using only positive lists, this would have to be:
29905 .code
29906 deny  dnslists = sbl.spamhaus.org : \
29907                  list.dsbl.org
29908 deny  dnslists = dnsbl.njabl.org
29909      !dnslists = dnsbl.njabl.org=127.0.0.3
29910 deny  dnslists = relays.ordb.org
29911 .endd
29912 which is less clear, and harder to maintain.
29913
29914
29915
29916
29917 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29918 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29919 thereby providing more than one IP address. When an item in a &%dnslists%& list
29920 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29921 the match to specific results from the DNS lookup, there are two ways in which
29922 the checking can be handled. For example, consider the condition:
29923 .code
29924 dnslists = a.b.c=127.0.0.1
29925 .endd
29926 What happens if the DNS lookup for the incoming IP address yields both
29927 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29928 condition true because at least one given value was found, or is it false
29929 because at least one of the found values was not listed? And how does this
29930 affect negated conditions? Both possibilities are provided for with the help of
29931 additional separators &`==`& and &`=&&`&.
29932
29933 .ilist
29934 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29935 IP addresses matches one of the listed addresses. For the example above, the
29936 condition is true because 127.0.0.1 matches.
29937 .next
29938 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29939 looked up IP addresses matches one of the listed addresses. If the condition is
29940 changed to:
29941 .code
29942 dnslists = a.b.c==127.0.0.1
29943 .endd
29944 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29945 false because 127.0.0.2 is not listed. You would need to have:
29946 .code
29947 dnslists = a.b.c==127.0.0.1,127.0.0.2
29948 .endd
29949 for the condition to be true.
29950 .endlist
29951
29952 When &`!`& is used to negate IP address matching, it inverts the result, giving
29953 the precise opposite of the behaviour above. Thus:
29954 .ilist
29955 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29956 addresses matches one of the listed addresses. Consider:
29957 .code
29958 dnslists = a.b.c!&0.0.0.1
29959 .endd
29960 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29961 false because 127.0.0.1 matches.
29962 .next
29963 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29964 looked up IP address that does not match. Consider:
29965 .code
29966 dnslists = a.b.c!=&0.0.0.1
29967 .endd
29968 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29969 true, because 127.0.0.2 does not match. You would need to have:
29970 .code
29971 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29972 .endd
29973 for the condition to be false.
29974 .endlist
29975 When the DNS lookup yields only a single IP address, there is no difference
29976 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29977
29978
29979
29980
29981 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29982 .cindex "DNS list" "information from merged"
29983 When the facility for restricting the matching IP values in a DNS list is used,
29984 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29985 the true reason for rejection. This happens when lists are merged and the IP
29986 address in the A record is used to distinguish them; unfortunately there is
29987 only one TXT record. One way round this is not to use merged lists, but that
29988 can be inefficient because it requires multiple DNS lookups where one would do
29989 in the vast majority of cases when the host of interest is not on any of the
29990 lists.
29991
29992 A less inefficient way of solving this problem is available. If
29993 two domain names, comma-separated, are given, the second is used first to
29994 do an initial check, making use of any IP value restrictions that are set.
29995 If there is a match, the first domain is used, without any IP value
29996 restrictions, to get the TXT record. As a byproduct of this, there is also
29997 a check that the IP being tested is indeed on the first list. The first
29998 domain is the one that is put in &$dnslist_domain$&. For example:
29999 .code
30000 reject message  = \
30001          rejected because $sender_host_address is blacklisted \
30002          at $dnslist_domain\n$dnslist_text
30003        dnslists = \
30004          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30005          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30006 .endd
30007 For the first blacklist item, this starts by doing a lookup in
30008 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30009 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30010 value, and as long as something is found, it looks for the corresponding TXT
30011 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30012 The second blacklist item is processed similarly.
30013
30014 If you are interested in more than one merged list, the same list must be
30015 given several times, but because the results of the DNS lookups are cached,
30016 the DNS calls themselves are not repeated. For example:
30017 .code
30018 reject dnslists = \
30019          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30020          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30021          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30022          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30023 .endd
30024 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30025 values matches (or if no record is found), this is the only lookup that is
30026 done. Only if there is a match is one of the more specific lists consulted.
30027
30028
30029
30030 .section "DNS lists and IPv6" "SECTmorednslistslast"
30031 .cindex "IPv6" "DNS black lists"
30032 .cindex "DNS list" "IPv6 usage"
30033 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30034 nibble by nibble. For example, if the calling host's IP address is
30035 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30036 .code
30037 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30038   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30039 .endd
30040 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30041 lists contain wildcard records, intended for IPv4, that interact badly with
30042 IPv6. For example, the DNS entry
30043 .code
30044 *.3.some.list.example.    A    127.0.0.1
30045 .endd
30046 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30047 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30048
30049 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30050 &%condition%& condition, as in this example:
30051 .code
30052 deny   condition = ${if isip4{$sender_host_address}}
30053        dnslists  = some.list.example
30054 .endd
30055
30056 If an explicit key is being used for a DNS lookup and it may be an IPv6
30057 address you should specify alternate list separators for both the outer
30058 (DNS list name) list and inner (lookup keys) list:
30059 .code
30060        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30061 .endd
30062
30063 .section "Rate limiting incoming messages" "SECTratelimiting"
30064 .cindex "rate limiting" "client sending"
30065 .cindex "limiting client sending rates"
30066 .oindex "&%smtp_ratelimit_*%&"
30067 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30068 which clients can send email. This is more powerful than the
30069 &%smtp_ratelimit_*%& options, because those options control the rate of
30070 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30071 works across all connections (concurrent and sequential) from the same client
30072 host. The syntax of the &%ratelimit%& condition is:
30073 .display
30074 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30075 .endd
30076 If the average client sending rate is less than &'m'& messages per time
30077 period &'p'& then the condition is false; otherwise it is true.
30078
30079 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30080 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30081 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30082 of &'p'&.
30083
30084 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30085 time interval, for example, &`8h`& for eight hours. A larger time constant
30086 means that it takes Exim longer to forget a client's past behaviour. The
30087 parameter &'m'& is the maximum number of messages that a client is permitted to
30088 send in each time interval. It also specifies the number of messages permitted
30089 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30090 constant, you can allow a client to send more messages in a burst without
30091 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30092 both small, messages must be sent at an even rate.
30093
30094 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30095 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30096 when deploying the &%ratelimit%& ACL condition. The script prints usage
30097 instructions when it is run with no arguments.
30098
30099 The key is used to look up the data for calculating the client's average
30100 sending rate. This data is stored in Exim's spool directory, alongside the
30101 retry and other hints databases. The default key is &$sender_host_address$&,
30102 which means Exim computes the sending rate of each client host IP address.
30103 By changing the key you can change how Exim identifies clients for the purpose
30104 of ratelimiting. For example, to limit the sending rate of each authenticated
30105 user, independent of the computer they are sending from, set the key to
30106 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30107 example, &$authenticated_id$& is only meaningful if the client has
30108 authenticated (which you can check with the &%authenticated%& ACL condition).
30109
30110 The lookup key does not have to identify clients: If you want to limit the
30111 rate at which a recipient receives messages, you can use the key
30112 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30113 ACL.
30114
30115 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30116 specifies what Exim measures the rate of, for example messages or recipients
30117 or bytes. You can adjust the measurement using the &%unique=%& and/or
30118 &%count=%& options. You can also control when Exim updates the recorded rate
30119 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30120 separated by a slash, like the other parameters. They may appear in any order.
30121
30122 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30123 any options that alter the meaning of the stored data. The limit &'m'& is not
30124 stored, so you can alter the configured maximum rate and Exim will still
30125 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30126 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30127 behaviour. The lookup key is not affected by changes to the update mode and
30128 the &%count=%& option.
30129
30130
30131 .section "Ratelimit options for what is being measured" "ratoptmea"
30132 .cindex "rate limiting" "per_* options"
30133 The &%per_conn%& option limits the client's connection rate. It is not
30134 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30135 &%acl_not_smtp_start%& ACLs.
30136
30137 The &%per_mail%& option limits the client's rate of sending messages. This is
30138 the default if none of the &%per_*%& options is specified. It can be used in
30139 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30140 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30141
30142 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30143 the same ACLs as the &%per_mail%& option, though it is best to use this option
30144 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30145 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30146 in its MAIL command, which may be inaccurate or completely missing. You can
30147 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30148 in kilobytes, megabytes, or gigabytes, respectively.
30149
30150 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30151 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30152 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30153 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30154 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30155 in either case the rate limiting engine will see a message with many
30156 recipients as a large high-speed burst.
30157
30158 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30159 number of different recipients that the client has sent messages to in the
30160 last time period. That is, if the client repeatedly sends messages to the same
30161 recipient, its measured rate is not increased. This option can only be used in
30162 &%acl_smtp_rcpt%&.
30163
30164 The &%per_cmd%& option causes Exim to recompute the rate every time the
30165 condition is processed. This can be used to limit the rate of any SMTP
30166 command. If it is used in multiple ACLs it can limit the aggregate rate of
30167 multiple different commands.
30168
30169 The &%count=%& option can be used to alter how much Exim adds to the client's
30170 measured rate. For example, the &%per_byte%& option is equivalent to
30171 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30172 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30173 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30174
30175 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30176
30177
30178 .section "Ratelimit update modes" "ratoptupd"
30179 .cindex "rate limiting" "reading data without updating"
30180 You can specify one of three options with the &%ratelimit%& condition to
30181 control when its database is updated. This section describes the &%readonly%&
30182 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30183
30184 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30185 previously-computed rate to check against the limit.
30186
30187 For example, you can test the client's sending rate and deny it access (when
30188 it is too fast) in the connect ACL. If the client passes this check then it
30189 can go on to send a message, in which case its recorded rate will be updated
30190 in the MAIL ACL. Subsequent connections from the same client will check this
30191 new rate.
30192 .code
30193 acl_check_connect:
30194  deny ratelimit = 100 / 5m / readonly
30195     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30196                   (max $sender_rate_limit)
30197 # ...
30198 acl_check_mail:
30199  warn ratelimit = 100 / 5m / strict
30200     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30201                   (max $sender_rate_limit)
30202 .endd
30203
30204 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30205 processing a message then it may increase the client's measured rate more than
30206 it should. For example, this will happen if you check the &%per_rcpt%& option
30207 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30208 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30209 multiple update problems by using the &%readonly%& option on later ratelimit
30210 checks.
30211
30212 The &%per_*%& options described above do not make sense in some ACLs. If you
30213 use a &%per_*%& option in an ACL where it is not normally permitted then the
30214 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30215 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30216 next section) so you must specify the &%readonly%& option explicitly.
30217
30218
30219 .section "Ratelimit options for handling fast clients" "ratoptfast"
30220 .cindex "rate limiting" "strict and leaky modes"
30221 If a client's average rate is greater than the maximum, the rate limiting
30222 engine can react in two possible ways, depending on the presence of the
30223 &%strict%& or &%leaky%& update modes. This is independent of the other
30224 counter-measures (such as rejecting the message) that may be specified by the
30225 rest of the ACL.
30226
30227 The &%leaky%& (default) option means that the client's recorded rate is not
30228 updated if it is above the limit. The effect of this is that Exim measures the
30229 client's average rate of successfully sent email, which cannot be greater than
30230 the maximum allowed. If the client is over the limit it may suffer some
30231 counter-measures (as specified in the ACL), but it will still be able to send
30232 email at the configured maximum rate, whatever the rate of its attempts. This
30233 is generally the better choice if you have clients that retry automatically.
30234 For example, it does not prevent a sender with an over-aggressive retry rate
30235 from getting any email through.
30236
30237 The &%strict%& option means that the client's recorded rate is always
30238 updated. The effect of this is that Exim measures the client's average rate
30239 of attempts to send email, which can be much higher than the maximum it is
30240 actually allowed. If the client is over the limit it may be subjected to
30241 counter-measures by the ACL. It must slow down and allow sufficient time to
30242 pass that its computed rate falls below the maximum before it can send email
30243 again. The time (the number of smoothing periods) it must wait and not
30244 attempt to send mail can be calculated with this formula:
30245 .code
30246         ln(peakrate/maxrate)
30247 .endd
30248
30249
30250 .section "Limiting the rate of different events" "ratoptuniq"
30251 .cindex "rate limiting" "counting unique events"
30252 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30253 rate of different events. For example, the &%per_addr%& option uses this
30254 mechanism to count the number of different recipients that the client has
30255 sent messages to in the last time period; it is equivalent to
30256 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30257 measure the rate that a client uses different sender addresses with the
30258 options &`per_mail/unique=$sender_address`&.
30259
30260 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30261 has seen for that key. The whole set is thrown away when it is older than the
30262 rate smoothing period &'p'&, so each different event is counted at most once
30263 per period. In the &%leaky%& update mode, an event that causes the client to
30264 go over the limit is not added to the set, in the same way that the client's
30265 recorded rate is not updated in the same situation.
30266
30267 When you combine the &%unique=%& and &%readonly%& options, the specific
30268 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30269 rate.
30270
30271 The &%unique=%& mechanism needs more space in the ratelimit database than the
30272 other &%ratelimit%& options in order to store the event set. The number of
30273 unique values is potentially as large as the rate limit, so the extra space
30274 required increases with larger limits.
30275
30276 The uniqueification is not perfect: there is a small probability that Exim
30277 will think a new event has happened before. If the sender's rate is less than
30278 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30279 the measured rate can go above the limit, in which case Exim may under-count
30280 events by a significant margin. Fortunately, if the rate is high enough (2.7
30281 times the limit) that the false positive rate goes above 9%, then Exim will
30282 throw away the over-full event set before the measured rate falls below the
30283 limit. Therefore the only harm should be that exceptionally high sending rates
30284 are logged incorrectly; any countermeasures you configure will be as effective
30285 as intended.
30286
30287
30288 .section "Using rate limiting" "useratlim"
30289 Exim's other ACL facilities are used to define what counter-measures are taken
30290 when the rate limit is exceeded. This might be anything from logging a warning
30291 (for example, while measuring existing sending rates in order to define
30292 policy), through time delays to slow down fast senders, up to rejecting the
30293 message. For example:
30294 .code
30295 # Log all senders' rates
30296 warn ratelimit = 0 / 1h / strict
30297      log_message = Sender rate $sender_rate / $sender_rate_period
30298
30299 # Slow down fast senders; note the need to truncate $sender_rate
30300 # at the decimal point.
30301 warn ratelimit = 100 / 1h / per_rcpt / strict
30302      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30303                    $sender_rate_limit }s
30304
30305 # Keep authenticated users under control
30306 deny authenticated = *
30307      ratelimit = 100 / 1d / strict / $authenticated_id
30308
30309 # System-wide rate limit
30310 defer message = Sorry, too busy. Try again later.
30311      ratelimit = 10 / 1s / $primary_hostname
30312
30313 # Restrict incoming rate from each host, with a default
30314 # set using a macro and special cases looked up in a table.
30315 defer message = Sender rate exceeds $sender_rate_limit \
30316                messages per $sender_rate_period
30317      ratelimit = ${lookup {$sender_host_address} \
30318                    cdb {DB/ratelimits.cdb} \
30319                    {$value} {RATELIMIT} }
30320 .endd
30321 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30322 especially with the &%per_rcpt%& option, you may suffer from a performance
30323 bottleneck caused by locking on the ratelimit hints database. Apart from
30324 making your ACLs less complicated, you can reduce the problem by using a
30325 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30326 this means that Exim will lose its hints data after a reboot (including retry
30327 hints, the callout cache, and ratelimit data).
30328
30329
30330
30331 .section "Address verification" "SECTaddressverification"
30332 .cindex "verifying address" "options for"
30333 .cindex "policy control" "address verification"
30334 Several of the &%verify%& conditions described in section
30335 &<<SECTaclconditions>>& cause addresses to be verified. Section
30336 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30337 The verification conditions can be followed by options that modify the
30338 verification process. The options are separated from the keyword and from each
30339 other by slashes, and some of them contain parameters. For example:
30340 .code
30341 verify = sender/callout
30342 verify = recipient/defer_ok/callout=10s,defer_ok
30343 .endd
30344 The first stage of address verification, which always happens, is to run the
30345 address through the routers, in &"verify mode"&. Routers can detect the
30346 difference between verification and routing for delivery, and their actions can
30347 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30348 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30349 The available options are as follows:
30350
30351 .ilist
30352 If the &%callout%& option is specified, successful routing to one or more
30353 remote hosts is followed by a &"callout"& to those hosts as an additional
30354 check. Callouts and their sub-options are discussed in the next section.
30355 .next
30356 If there is a defer error while doing verification routing, the ACL
30357 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30358 options, the condition is forced to be true instead. Note that this is a main
30359 verification option as well as a suboption for callouts.
30360 .next
30361 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30362 discusses the reporting of sender address verification failures.
30363 .next
30364 The &%success_on_redirect%& option causes verification always to succeed
30365 immediately after a successful redirection. By default, if a redirection
30366 generates just one address, that address is also verified. See further
30367 discussion in section &<<SECTredirwhilveri>>&.
30368 .endlist
30369
30370 .cindex "verifying address" "differentiating failures"
30371 .vindex "&$recipient_verify_failure$&"
30372 .vindex "&$sender_verify_failure$&"
30373 .vindex "&$acl_verify_message$&"
30374 After an address verification failure, &$acl_verify_message$& contains the
30375 error message that is associated with the failure. It can be preserved by
30376 coding like this:
30377 .code
30378 warn  !verify = sender
30379        set acl_m0 = $acl_verify_message
30380 .endd
30381 If you are writing your own custom rejection message or log message when
30382 denying access, you can use this variable to include information about the
30383 verification failure.
30384
30385 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30386 appropriate) contains one of the following words:
30387
30388 .ilist
30389 &%qualify%&: The address was unqualified (no domain), and the message
30390 was neither local nor came from an exempted host.
30391 .next
30392 &%route%&: Routing failed.
30393 .next
30394 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30395 occurred at or before the MAIL command (that is, on initial
30396 connection, HELO, or MAIL).
30397 .next
30398 &%recipient%&: The RCPT command in a callout was rejected.
30399 .next
30400 &%postmaster%&: The postmaster check in a callout was rejected.
30401 .endlist
30402
30403 The main use of these variables is expected to be to distinguish between
30404 rejections of MAIL and rejections of RCPT in callouts.
30405
30406
30407
30408
30409 .section "Callout verification" "SECTcallver"
30410 .cindex "verifying address" "by callout"
30411 .cindex "callout" "verification"
30412 .cindex "SMTP" "callout verification"
30413 For non-local addresses, routing verifies the domain, but is unable to do any
30414 checking of the local part. There are situations where some means of verifying
30415 the local part is desirable. One way this can be done is to make an SMTP
30416 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30417 a subsequent host for a recipient address, to see if the host accepts the
30418 address. We use the term &'callout'& to cover both cases. Note that for a
30419 sender address, the callback is not to the client host that is trying to
30420 deliver the message, but to one of the hosts that accepts incoming mail for the
30421 sender's domain.
30422
30423 Exim does not do callouts by default. If you want them to happen, you must
30424 request them by setting appropriate options on the &%verify%& condition, as
30425 described below. This facility should be used with care, because it can add a
30426 lot of resource usage to the cost of verifying an address. However, Exim does
30427 cache the results of callouts, which helps to reduce the cost. Details of
30428 caching are in section &<<SECTcallvercache>>&.
30429
30430 Recipient callouts are usually used only between hosts that are controlled by
30431 the same administration. For example, a corporate gateway host could use
30432 callouts to check for valid recipients on an internal mailserver. A successful
30433 callout does not guarantee that a real delivery to the address would succeed;
30434 on the other hand, a failing callout does guarantee that a delivery would fail.
30435
30436 If the &%callout%& option is present on a condition that verifies an address, a
30437 second stage of verification occurs if the address is successfully routed to
30438 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30439 &(manualroute)& router, where the router specifies the hosts. However, if a
30440 router that does not set up hosts routes to an &(smtp)& transport with a
30441 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30442 &%hosts_override%& set, its hosts are always used, whether or not the router
30443 supplies a host list.
30444 Callouts are only supported on &(smtp)& transports.
30445
30446 The port that is used is taken from the transport, if it is specified and is a
30447 remote transport. (For routers that do verification only, no transport need be
30448 specified.) Otherwise, the default SMTP port is used. If a remote transport
30449 specifies an outgoing interface, this is used; otherwise the interface is not
30450 specified. Likewise, the text that is used for the HELO command is taken from
30451 the transport's &%helo_data%& option; if there is no transport, the value of
30452 &$smtp_active_hostname$& is used.
30453
30454 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30455 test whether a bounce message could be delivered to the sender address. The
30456 following SMTP commands are sent:
30457 .display
30458 &`HELO `&<&'local host name'&>
30459 &`MAIL FROM:<>`&
30460 &`RCPT TO:`&<&'the address to be tested'&>
30461 &`QUIT`&
30462 .endd
30463 LHLO is used instead of HELO if the transport's &%protocol%& option is
30464 set to &"lmtp"&.
30465
30466 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30467 settings.
30468
30469 A recipient callout check is similar. By default, it also uses an empty address
30470 for the sender. This default is chosen because most hosts do not make use of
30471 the sender address when verifying a recipient. Using the same address means
30472 that a single cache entry can be used for each recipient. Some sites, however,
30473 do make use of the sender address when verifying. These are catered for by the
30474 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30475
30476 If the response to the RCPT command is a 2&'xx'& code, the verification
30477 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30478 Exim tries the next host, if any. If there is a problem with all the remote
30479 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30480 &%callout%& option is given, in which case the condition is forced to succeed.
30481
30482 .cindex "SMTP" "output flushing, disabling for callout"
30483 A callout may take a little time. For this reason, Exim normally flushes SMTP
30484 output before performing a callout in an ACL, to avoid unexpected timeouts in
30485 clients when the SMTP PIPELINING extension is in use. The flushing can be
30486 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30487
30488
30489
30490
30491 .section "Additional parameters for callouts" "CALLaddparcall"
30492 .cindex "callout" "additional parameters for"
30493 The &%callout%& option can be followed by an equals sign and a number of
30494 optional parameters, separated by commas. For example:
30495 .code
30496 verify = recipient/callout=10s,defer_ok
30497 .endd
30498 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30499 separate verify options, is retained for backwards compatibility, but is now
30500 deprecated. The additional parameters for &%callout%& are as follows:
30501
30502
30503 .vlist
30504 .vitem <&'a&~time&~interval'&>
30505 .cindex "callout" "timeout, specifying"
30506 This specifies the timeout that applies for the callout attempt to each host.
30507 For example:
30508 .code
30509 verify = sender/callout=5s
30510 .endd
30511 The default is 30 seconds. The timeout is used for each response from the
30512 remote host. It is also used for the initial connection, unless overridden by
30513 the &%connect%& parameter.
30514
30515
30516 .vitem &*connect&~=&~*&<&'time&~interval'&>
30517 .cindex "callout" "connection timeout, specifying"
30518 This parameter makes it possible to set a different (usually smaller) timeout
30519 for making the SMTP connection. For example:
30520 .code
30521 verify = sender/callout=5s,connect=1s
30522 .endd
30523 If not specified, this timeout defaults to the general timeout value.
30524
30525 .vitem &*defer_ok*&
30526 .cindex "callout" "defer, action on"
30527 When this parameter is present, failure to contact any host, or any other kind
30528 of temporary error, is treated as success by the ACL. However, the cache is not
30529 updated in this circumstance.
30530
30531 .vitem &*fullpostmaster*&
30532 .cindex "callout" "full postmaster check"
30533 This operates like the &%postmaster%& option (see below), but if the check for
30534 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30535 accordance with the specification in RFC 2821. The RFC states that the
30536 unqualified address &'postmaster'& should be accepted.
30537
30538
30539 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30540 .cindex "callout" "sender when verifying header"
30541 When verifying addresses in header lines using the &%header_sender%&
30542 verification option, Exim behaves by default as if the addresses are envelope
30543 sender addresses from a message. Callout verification therefore tests to see
30544 whether a bounce message could be delivered, by using an empty address in the
30545 MAIL command. However, it is arguable that these addresses might never be used
30546 as envelope senders, and could therefore justifiably reject bounce messages
30547 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30548 address to use in the MAIL command. For example:
30549 .code
30550 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30551 .endd
30552 This parameter is available only for the &%header_sender%& verification option.
30553
30554
30555 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30556 .cindex "callout" "overall timeout, specifying"
30557 This parameter sets an overall timeout for performing a callout verification.
30558 For example:
30559 .code
30560 verify = sender/callout=5s,maxwait=30s
30561 .endd
30562 This timeout defaults to four times the callout timeout for individual SMTP
30563 commands. The overall timeout applies when there is more than one host that can
30564 be tried. The timeout is checked before trying the next host. This prevents
30565 very long delays if there are a large number of hosts and all are timing out
30566 (for example, when network connections are timing out).
30567
30568
30569 .vitem &*no_cache*&
30570 .cindex "callout" "cache, suppressing"
30571 .cindex "caching callout, suppressing"
30572 When this parameter is given, the callout cache is neither read nor updated.
30573
30574 .vitem &*postmaster*&
30575 .cindex "callout" "postmaster; checking"
30576 When this parameter is set, a successful callout check is followed by a similar
30577 check for the local part &'postmaster'& at the same domain. If this address is
30578 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30579 the postmaster check is recorded in a cache record; if it is a failure, this is
30580 used to fail subsequent callouts for the domain without a connection being
30581 made, until the cache record expires.
30582
30583 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30584 The postmaster check uses an empty sender in the MAIL command by default.
30585 You can use this parameter to do a postmaster check using a different address.
30586 For example:
30587 .code
30588 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30589 .endd
30590 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30591 one overrides. The &%postmaster%& parameter is equivalent to this example:
30592 .code
30593 require  verify = sender/callout=postmaster_mailfrom=
30594 .endd
30595 &*Warning*&: The caching arrangements for postmaster checking do not take
30596 account of the sender address. It is assumed that either the empty address or
30597 a fixed non-empty address will be used. All that Exim remembers is that the
30598 postmaster check for the domain succeeded or failed.
30599
30600
30601 .vitem &*random*&
30602 .cindex "callout" "&""random""& check"
30603 When this parameter is set, before doing the normal callout check, Exim does a
30604 check for a &"random"& local part at the same domain. The local part is not
30605 really random &-- it is defined by the expansion of the option
30606 &%callout_random_local_part%&, which defaults to
30607 .code
30608 $primary_hostname-$tod_epoch-testing
30609 .endd
30610 The idea here is to try to determine whether the remote host accepts all local
30611 parts without checking. If it does, there is no point in doing callouts for
30612 specific local parts. If the &"random"& check succeeds, the result is saved in
30613 a cache record, and used to force the current and subsequent callout checks to
30614 succeed without a connection being made, until the cache record expires.
30615
30616 .vitem &*use_postmaster*&
30617 .cindex "callout" "sender for recipient check"
30618 This parameter applies to recipient callouts only. For example:
30619 .code
30620 deny  !verify = recipient/callout=use_postmaster
30621 .endd
30622 .vindex "&$qualify_domain$&"
30623 It causes a non-empty postmaster address to be used in the MAIL command when
30624 performing the callout for the recipient, and also for a &"random"& check if
30625 that is configured. The local part of the address is &`postmaster`& and the
30626 domain is the contents of &$qualify_domain$&.
30627
30628 .vitem &*use_sender*&
30629 This option applies to recipient callouts only. For example:
30630 .code
30631 require  verify = recipient/callout=use_sender
30632 .endd
30633 It causes the message's actual sender address to be used in the MAIL
30634 command when performing the callout, instead of an empty address. There is no
30635 need to use this option unless you know that the called hosts make use of the
30636 sender when checking recipients. If used indiscriminately, it reduces the
30637 usefulness of callout caching.
30638 .endlist
30639
30640 If you use any of the parameters that set a non-empty sender for the MAIL
30641 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30642 &%use_sender%&), you should think about possible loops. Recipient checking is
30643 usually done between two hosts that are under the same management, and the host
30644 that receives the callouts is not normally configured to do callouts itself.
30645 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30646 these circumstances.
30647
30648 However, if you use a non-empty sender address for a callout to an arbitrary
30649 host, there is the likelihood that the remote host will itself initiate a
30650 callout check back to your host. As it is checking what appears to be a message
30651 sender, it is likely to use an empty address in MAIL, thus avoiding a
30652 callout loop. However, to be on the safe side it would be best to set up your
30653 own ACLs so that they do not do sender verification checks when the recipient
30654 is the address you use for header sender or postmaster callout checking.
30655
30656 Another issue to think about when using non-empty senders for callouts is
30657 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30658 by the sender/recipient combination; thus, for any given recipient, many more
30659 actual callouts are performed than when an empty sender or postmaster is used.
30660
30661
30662
30663
30664 .section "Callout caching" "SECTcallvercache"
30665 .cindex "hints database" "callout cache"
30666 .cindex "callout" "cache, description of"
30667 .cindex "caching" "callout"
30668 Exim caches the results of callouts in order to reduce the amount of resources
30669 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30670 option. A hints database called &"callout"& is used for the cache. Two
30671 different record types are used: one records the result of a callout check for
30672 a specific address, and the other records information that applies to the
30673 entire domain (for example, that it accepts the local part &'postmaster'&).
30674
30675 When an original callout fails, a detailed SMTP error message is given about
30676 the failure. However, for subsequent failures use the cache data, this message
30677 is not available.
30678
30679 The expiry times for negative and positive address cache records are
30680 independent, and can be set by the global options &%callout_negative_expire%&
30681 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30682
30683 If a host gives a negative response to an SMTP connection, or rejects any
30684 commands up to and including
30685 .code
30686 MAIL FROM:<>
30687 .endd
30688 (but not including the MAIL command with a non-empty address),
30689 any callout attempt is bound to fail. Exim remembers such failures in a
30690 domain cache record, which it uses to fail callouts for the domain without
30691 making new connections, until the domain record times out. There are two
30692 separate expiry times for domain cache records:
30693 &%callout_domain_negative_expire%& (default 3h) and
30694 &%callout_domain_positive_expire%& (default 7d).
30695
30696 Domain records expire when the negative expiry time is reached if callouts
30697 cannot be made for the domain, or if the postmaster check failed.
30698 Otherwise, they expire when the positive expiry time is reached. This
30699 ensures that, for example, a host that stops accepting &"random"& local parts
30700 will eventually be noticed.
30701
30702 The callout caching mechanism is based on the domain of the address that is
30703 being tested. If the domain routes to several hosts, it is assumed that their
30704 behaviour will be the same.
30705
30706
30707
30708 .section "Sender address verification reporting" "SECTsenaddver"
30709 .cindex "verifying" "suppressing error details"
30710 See section &<<SECTaddressverification>>& for a general discussion of
30711 verification. When sender verification fails in an ACL, the details of the
30712 failure are given as additional output lines before the 550 response to the
30713 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30714 you might see:
30715 .code
30716 MAIL FROM:<xyz@abc.example>
30717 250 OK
30718 RCPT TO:<pqr@def.example>
30719 550-Verification failed for <xyz@abc.example>
30720 550-Called:   192.168.34.43
30721 550-Sent:     RCPT TO:<xyz@abc.example>
30722 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30723 550 Sender verification failed
30724 .endd
30725 If more than one RCPT command fails in the same way, the details are given
30726 only for the first of them. However, some administrators do not want to send
30727 out this much information. You can suppress the details by adding
30728 &`/no_details`& to the ACL statement that requests sender verification. For
30729 example:
30730 .code
30731 verify = sender/no_details
30732 .endd
30733
30734 .section "Redirection while verifying" "SECTredirwhilveri"
30735 .cindex "verifying" "redirection while"
30736 .cindex "address redirection" "while verifying"
30737 A dilemma arises when a local address is redirected by aliasing or forwarding
30738 during verification: should the generated addresses themselves be verified,
30739 or should the successful expansion of the original address be enough to verify
30740 it? By default, Exim takes the following pragmatic approach:
30741
30742 .ilist
30743 When an incoming address is redirected to just one child address, verification
30744 continues with the child address, and if that fails to verify, the original
30745 verification also fails.
30746 .next
30747 When an incoming address is redirected to more than one child address,
30748 verification does not continue. A success result is returned.
30749 .endlist
30750
30751 This seems the most reasonable behaviour for the common use of aliasing as a
30752 way of redirecting different local parts to the same mailbox. It means, for
30753 example, that a pair of alias entries of the form
30754 .code
30755 A.Wol:   aw123
30756 aw123:   :fail: Gone away, no forwarding address
30757 .endd
30758 work as expected, with both local parts causing verification failure. When a
30759 redirection generates more than one address, the behaviour is more like a
30760 mailing list, where the existence of the alias itself is sufficient for
30761 verification to succeed.
30762
30763 It is possible, however, to change the default behaviour so that all successful
30764 redirections count as successful verifications, however many new addresses are
30765 generated. This is specified by the &%success_on_redirect%& verification
30766 option. For example:
30767 .code
30768 require verify = recipient/success_on_redirect/callout=10s
30769 .endd
30770 In this example, verification succeeds if a router generates a new address, and
30771 the callout does not occur, because no address was routed to a remote host.
30772
30773 When verification is being tested via the &%-bv%& option, the treatment of
30774 redirections is as just described, unless the &%-v%& or any debugging option is
30775 also specified. In that case, full verification is done for every generated
30776 address and a report is output for each of them.
30777
30778
30779
30780 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30781 .cindex "CSA" "verifying"
30782 Client SMTP Authorization is a system that allows a site to advertise
30783 which machines are and are not permitted to send email. This is done by placing
30784 special SRV records in the DNS; these are looked up using the client's HELO
30785 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30786 Authorization checks in Exim are performed by the ACL condition:
30787 .code
30788 verify = csa
30789 .endd
30790 This fails if the client is not authorized. If there is a DNS problem, or if no
30791 valid CSA SRV record is found, or if the client is authorized, the condition
30792 succeeds. These three cases can be distinguished using the expansion variable
30793 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30794 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30795 be likely to cause problems for legitimate email.
30796
30797 The error messages produced by the CSA code include slightly more
30798 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30799 looking up the CSA SRV record, or problems looking up the CSA target
30800 address record. There are four reasons for &$csa_status$& being &"fail"&:
30801
30802 .ilist
30803 The client's host name is explicitly not authorized.
30804 .next
30805 The client's IP address does not match any of the CSA target IP addresses.
30806 .next
30807 The client's host name is authorized but it has no valid target IP addresses
30808 (for example, the target's addresses are IPv6 and the client is using IPv4).
30809 .next
30810 The client's host name has no CSA SRV record but a parent domain has asserted
30811 that all subdomains must be explicitly authorized.
30812 .endlist
30813
30814 The &%csa%& verification condition can take an argument which is the domain to
30815 use for the DNS query. The default is:
30816 .code
30817 verify = csa/$sender_helo_name
30818 .endd
30819 This implementation includes an extension to CSA. If the query domain
30820 is an address literal such as [192.0.2.95], or if it is a bare IP
30821 address, Exim searches for CSA SRV records in the reverse DNS as if
30822 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30823 meaningful to say:
30824 .code
30825 verify = csa/$sender_host_address
30826 .endd
30827 In fact, this is the check that Exim performs if the client does not say HELO.
30828 This extension can be turned off by setting the main configuration option
30829 &%dns_csa_use_reverse%& to be false.
30830
30831 If a CSA SRV record is not found for the domain itself, a search
30832 is performed through its parent domains for a record which might be
30833 making assertions about subdomains. The maximum depth of this search is limited
30834 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30835 default. Exim does not look for CSA SRV records in a top level domain, so the
30836 default settings handle HELO domains as long as seven
30837 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30838 of legitimate HELO domains.
30839
30840 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30841 direct SRV lookups, this is not sufficient because of the extra parent domain
30842 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30843 addresses into lookups in the reverse DNS space. The result of a successful
30844 lookup such as:
30845 .code
30846 ${lookup dnsdb {csa=$sender_helo_name}}
30847 .endd
30848 has two space-separated fields: an authorization code and a target host name.
30849 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30850 authorization required but absent, or &"?"& for unknown.
30851
30852
30853
30854
30855 .section "Bounce address tag validation" "SECTverifyPRVS"
30856 .cindex "BATV, verifying"
30857 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30858 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30859 Genuine incoming bounce messages should therefore always be addressed to
30860 recipients that have a valid tag. This scheme is a way of detecting unwanted
30861 bounce messages caused by sender address forgeries (often called &"collateral
30862 spam"&), because the recipients of such messages do not include valid tags.
30863
30864 There are two expansion items to help with the implementation of the BATV
30865 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30866 the original envelope sender address by using a simple key to add a hash of the
30867 address and some time-based randomizing information. The &%prvs%& expansion
30868 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30869 The syntax of these expansion items is described in section
30870 &<<SECTexpansionitems>>&.
30871
30872 As an example, suppose the secret per-address keys are stored in an MySQL
30873 database. A query to look up the key for an address could be defined as a macro
30874 like this:
30875 .code
30876 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30877                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30878                 }{$value}}
30879 .endd
30880 Suppose also that the senders who make use of BATV are defined by an address
30881 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30882 use this:
30883 .code
30884 # Bounces: drop unsigned addresses for BATV senders
30885 deny message = This address does not send an unsigned reverse path
30886      senders = :
30887      recipients = +batv_senders
30888
30889 # Bounces: In case of prvs-signed address, check signature.
30890 deny message = Invalid reverse path signature.
30891      senders = :
30892      condition  = ${prvscheck {$local_part@$domain}\
30893                   {PRVSCHECK_SQL}{1}}
30894      !condition = $prvscheck_result
30895 .endd
30896 The first statement rejects recipients for bounce messages that are addressed
30897 to plain BATV sender addresses, because it is known that BATV senders do not
30898 send out messages with plain sender addresses. The second statement rejects
30899 recipients that are prvs-signed, but with invalid signatures (either because
30900 the key is wrong, or the signature has timed out).
30901
30902 A non-prvs-signed address is not rejected by the second statement, because the
30903 &%prvscheck%& expansion yields an empty string if its first argument is not a
30904 prvs-signed address, thus causing the &%condition%& condition to be false. If
30905 the first argument is a syntactically valid prvs-signed address, the yield is
30906 the third string (in this case &"1"&), whether or not the cryptographic and
30907 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30908 of the checks (empty for failure, &"1"& for success).
30909
30910 There is one more issue you must consider when implementing prvs-signing:
30911 you have to ensure that the routers accept prvs-signed addresses and
30912 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30913 router to remove the signature with a configuration along these lines:
30914 .code
30915 batv_redirect:
30916   driver = redirect
30917   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30918 .endd
30919 This works because, if the third argument of &%prvscheck%& is empty, the result
30920 of the expansion of a prvs-signed address is the decoded value of the original
30921 address. This router should probably be the first of your routers that handles
30922 local addresses.
30923
30924 To create BATV-signed addresses in the first place, a transport of this form
30925 can be used:
30926 .code
30927 external_smtp_batv:
30928   driver = smtp
30929   return_path = ${prvs {$return_path} \
30930                        {${lookup mysql{SELECT \
30931                        secret FROM batv_prvs WHERE \
30932                        sender='${quote_mysql:$sender_address}'} \
30933                        {$value}fail}}}
30934 .endd
30935 If no key can be found for the existing return path, no signing takes place.
30936
30937
30938
30939 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30940 .cindex "&ACL;" "relay control"
30941 .cindex "relaying" "control by ACL"
30942 .cindex "policy control" "relay control"
30943 An MTA is said to &'relay'& a message if it receives it from some host and
30944 delivers it directly to another host as a result of a remote address contained
30945 within it. Redirecting a local address via an alias or forward file and then
30946 passing the message on to another host is not relaying,
30947 .cindex "&""percent hack""&"
30948 but a redirection as a result of the &"percent hack"& is.
30949
30950 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30951 A host which is acting as a gateway or an MX backup is concerned with incoming
30952 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30953 a host which is acting as a smart host for a number of clients is concerned
30954 with outgoing relaying from those clients to the Internet at large. Often the
30955 same host is fulfilling both functions,
30956 . ///
30957 . as illustrated in the diagram below,
30958 . ///
30959 but in principle these two kinds of relaying are entirely independent. What is
30960 not wanted is the transmission of mail from arbitrary remote hosts through your
30961 system to arbitrary domains.
30962
30963
30964 You can implement relay control by means of suitable statements in the ACL that
30965 runs for each RCPT command. For convenience, it is often easiest to use
30966 Exim's named list facility to define the domains and hosts involved. For
30967 example, suppose you want to do the following:
30968
30969 .ilist
30970 Deliver a number of domains to mailboxes on the local host (or process them
30971 locally in some other way). Let's say these are &'my.dom1.example'& and
30972 &'my.dom2.example'&.
30973 .next
30974 Relay mail for a number of other domains for which you are the secondary MX.
30975 These might be &'friend1.example'& and &'friend2.example'&.
30976 .next
30977 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30978 Suppose your LAN is 192.168.45.0/24.
30979 .endlist
30980
30981
30982 In the main part of the configuration, you put the following definitions:
30983 .code
30984 domainlist local_domains    = my.dom1.example : my.dom2.example
30985 domainlist relay_to_domains = friend1.example : friend2.example
30986 hostlist   relay_from_hosts = 192.168.45.0/24
30987 .endd
30988 Now you can use these definitions in the ACL that is run for every RCPT
30989 command:
30990 .code
30991 acl_check_rcpt:
30992   accept domains = +local_domains : +relay_to_domains
30993   accept hosts   = +relay_from_hosts
30994 .endd
30995 The first statement accepts any RCPT command that contains an address in
30996 the local or relay domains. For any other domain, control passes to the second
30997 statement, which accepts the command only if it comes from one of the relay
30998 hosts. In practice, you will probably want to make your ACL more sophisticated
30999 than this, for example, by including sender and recipient verification. The
31000 default configuration includes a more comprehensive example, which is described
31001 in chapter &<<CHAPdefconfil>>&.
31002
31003
31004
31005 .section "Checking a relay configuration" "SECTcheralcon"
31006 .cindex "relaying" "checking control of"
31007 You can check the relay characteristics of your configuration in the same way
31008 that you can test any ACL behaviour for an incoming SMTP connection, by using
31009 the &%-bh%& option to run a fake SMTP session with which you interact.
31010 .ecindex IIDacl
31011
31012
31013
31014 . ////////////////////////////////////////////////////////////////////////////
31015 . ////////////////////////////////////////////////////////////////////////////
31016
31017 .chapter "Content scanning at ACL time" "CHAPexiscan"
31018 .scindex IIDcosca "content scanning" "at ACL time"
31019 The extension of Exim to include content scanning at ACL time, formerly known
31020 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31021 was integrated into the main source for Exim release 4.50, and Tom continues to
31022 maintain it. Most of the wording of this chapter is taken from Tom's
31023 specification.
31024
31025 It is also possible to scan the content of messages at other times. The
31026 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31027 scanning after all the ACLs have run. A transport filter can be used to scan
31028 messages at delivery time (see the &%transport_filter%& option, described in
31029 chapter &<<CHAPtransportgeneric>>&).
31030
31031 If you want to include the ACL-time content-scanning features when you compile
31032 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31033 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31034
31035 .ilist
31036 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31037 for all MIME parts for SMTP and non-SMTP messages, respectively.
31038 .next
31039 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31040 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31041 run at the end of message reception (the &%acl_smtp_data%& ACL).
31042 .next
31043 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31044 of messages, or parts of messages, for debugging purposes.
31045 .next
31046 Additional expansion variables that are set in the new ACL and by the new
31047 conditions.
31048 .next
31049 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31050 .endlist
31051
31052 There is another content-scanning configuration option for &_Local/Makefile_&,
31053 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
31054 condition is compiled, in addition to all the other content-scanning features.
31055
31056 Content-scanning is continually evolving, and new features are still being
31057 added. While such features are still unstable and liable to incompatible
31058 changes, they are made available in Exim by setting options whose names begin
31059 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31060 this manual. You can find out about them by reading the file called
31061 &_doc/experimental.txt_&.
31062
31063 All the content-scanning facilities work on a MBOX copy of the message that is
31064 temporarily created in a file called:
31065 .display
31066 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31067 .endd
31068 The &_.eml_& extension is a friendly hint to virus scanners that they can
31069 expect an MBOX-like structure inside that file. The file is created when the
31070 first content scanning facility is called. Subsequent calls to content
31071 scanning conditions open the same file again. The directory is recursively
31072 removed when the &%acl_smtp_data%& ACL has finished running, unless
31073 .code
31074 control = no_mbox_unspool
31075 .endd
31076 has been encountered. When the MIME ACL decodes files, they are put into the
31077 same directory by default.
31078
31079
31080
31081 .section "Scanning for viruses" "SECTscanvirus"
31082 .cindex "virus scanning"
31083 .cindex "content scanning" "for viruses"
31084 .cindex "content scanning" "the &%malware%& condition"
31085 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31086 It supports a &"generic"& interface to scanners called via the shell, and
31087 specialized interfaces for &"daemon"& type virus scanners, which are resident
31088 in memory and thus are much faster.
31089
31090 A timeout of 2 minutes is applied to a scanner call (by default);
31091 if it expires then a defer action is taken.
31092
31093 .oindex "&%av_scanner%&"
31094 You can set the &%av_scanner%& option in the main part of the configuration
31095 to specify which scanner to use, together with any additional options that
31096 are needed. The basic syntax is as follows:
31097 .display
31098 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31099 .endd
31100 If you do not set &%av_scanner%&, it defaults to
31101 .code
31102 av_scanner = sophie:/var/run/sophie
31103 .endd
31104 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31105 before use.
31106 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31107 The following scanner types are supported in this release:
31108
31109 .vlist
31110 .vitem &%avast%&
31111 .cindex "virus scanners" "avast"
31112 This is the scanner daemon of Avast. It has been tested with Avast Core
31113 Security (currently at version 1.1.7).
31114 You can get a trial version at &url(http://www.avast.com) or for Linux
31115 at &url(http://www.avast.com/linux-server-antivirus).
31116 This scanner type takes one option,
31117 which can be either a full path to a UNIX socket,
31118 or host and port specifiers separated by white space.
31119 The host may be a name or an IP address; the port is either a
31120 single number or a pair of numbers with a dash between.
31121 Any further options are given, on separate lines,
31122 to the daemon as options before the main scan command.
31123 For example:
31124 .code
31125 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31126 av_scanner = avast:192.168.2.22 5036
31127 .endd
31128 If you omit the argument, the default path
31129 &_/var/run/avast/scan.sock_&
31130 is used.
31131 If you use a remote host,
31132 you need to make Exim's spool directory available to it,
31133 as the scanner is passed a file path, not file contents.
31134 For information about available commands and their options you may use
31135 .code
31136 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31137     FLAGS
31138     SENSITIVITY
31139     PACK
31140 .endd
31141
31142
31143 .vitem &%aveserver%&
31144 .cindex "virus scanners" "Kaspersky"
31145 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31146 at &url(http://www.kaspersky.com). This scanner type takes one option,
31147 which is the path to the daemon's UNIX socket. The default is shown in this
31148 example:
31149 .code
31150 av_scanner = aveserver:/var/run/aveserver
31151 .endd
31152
31153
31154 .vitem &%clamd%&
31155 .cindex "virus scanners" "clamd"
31156 This daemon-type scanner is GPL and free. You can get it at
31157 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31158 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31159 in the MIME ACL. This is no longer believed to be necessary.
31160
31161 The options are a list of server specifiers, which may be
31162 a UNIX socket specification,
31163 a TCP socket specification,
31164 or a (global) option.
31165
31166 A socket specification consists of a space-separated list.
31167 For a Unix socket the first element is a full path for the socket,
31168 for a TCP socket the first element is the IP address
31169 and the second a port number,
31170 Any further elements are per-server (non-global) options.
31171 These per-server options are supported:
31172 .code
31173 retry=<timespec>        Retry on connect fail
31174 .endd
31175
31176 The &`retry`& option specifies a time after which a single retry for
31177 a failed connect is made.  The default is to not retry.
31178
31179 If a Unix socket file is specified, only one server is supported.
31180
31181 Examples:
31182 .code
31183 av_scanner = clamd:/opt/clamd/socket
31184 av_scanner = clamd:192.0.2.3 1234
31185 av_scanner = clamd:192.0.2.3 1234:local
31186 av_scanner = clamd:192.0.2.3 1234 retry=10s
31187 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31188 .endd
31189 If the value of av_scanner points to a UNIX socket file or contains the
31190 &`local`&
31191 option, then the ClamAV interface will pass a filename containing the data
31192 to be scanned, which will should normally result in less I/O happening and be
31193 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31194 Exim does not assume that there is a common filesystem with the remote host.
31195 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31196 you be running a version of ClamAV prior to 0.95.
31197
31198 The final example shows that multiple TCP targets can be specified.  Exim will
31199 randomly use one for each incoming email (i.e. it load balances them).  Note
31200 that only TCP targets may be used if specifying a list of scanners; a UNIX
31201 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31202 unavailable, Exim will try the remaining one(s) until it finds one that works.
31203 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31204 not keep track of scanner state between multiple messages, and the scanner
31205 selection is random, so the message will get logged in the mainlog for each
31206 email that the down scanner gets chosen first (message wrapped to be readable):
31207 .code
31208 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31209    clamd: connection to localhost, port 3310 failed
31210    (Connection refused)
31211 .endd
31212
31213 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31214 contributing the code for this scanner.
31215
31216 .vitem &%cmdline%&
31217 .cindex "virus scanners" "command line interface"
31218 This is the keyword for the generic command line scanner interface. It can be
31219 used to attach virus scanners that are invoked from the shell. This scanner
31220 type takes 3 mandatory options:
31221
31222 .olist
31223 The full path and name of the scanner binary, with all command line options,
31224 and a placeholder (&`%s`&) for the directory to scan.
31225
31226 .next
31227 A regular expression to match against the STDOUT and STDERR output of the
31228 virus scanner. If the expression matches, a virus was found. You must make
31229 absolutely sure that this expression matches on &"virus found"&. This is called
31230 the &"trigger"& expression.
31231
31232 .next
31233 Another regular expression, containing exactly one pair of parentheses, to
31234 match the name of the virus found in the scanners output. This is called the
31235 &"name"& expression.
31236 .endlist olist
31237
31238 For example, Sophos Sweep reports a virus on a line like this:
31239 .code
31240 Virus 'W32/Magistr-B' found in file ./those.bat
31241 .endd
31242 For the trigger expression, we can match the phrase &"found in file"&. For the
31243 name expression, we want to extract the W32/Magistr-B string, so we can match
31244 for the single quotes left and right of it. Altogether, this makes the
31245 configuration setting:
31246 .code
31247 av_scanner = cmdline:\
31248              /path/to/sweep -ss -all -rec -archive %s:\
31249              found in file:'(.+)'
31250 .endd
31251 .vitem &%drweb%&
31252 .cindex "virus scanners" "DrWeb"
31253 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31254 takes one option,
31255 either a full path to a UNIX socket,
31256 or host and port specifiers separated by white space.
31257 The host may be a name or an IP address; the port is either a
31258 single number or a pair of numbers with a dash between.
31259 For example:
31260 .code
31261 av_scanner = drweb:/var/run/drwebd.sock
31262 av_scanner = drweb:192.168.2.20 31337
31263 .endd
31264 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31265 is used. Thanks to Alex Miller for contributing the code for this scanner.
31266
31267 .vitem &%f-protd%&
31268 .cindex "virus scanners" "f-protd"
31269 The f-protd scanner is accessed via HTTP over TCP.
31270 One argument is taken, being a space-separated hostname and port number
31271 (or port-range).
31272 For example:
31273 .code
31274 av_scanner = f-protd:localhost 10200-10204
31275 .endd
31276 If you omit the argument, the default values show above are used.
31277
31278 .vitem &%fsecure%&
31279 .cindex "virus scanners" "F-Secure"
31280 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31281 argument which is the path to a UNIX socket. For example:
31282 .code
31283 av_scanner = fsecure:/path/to/.fsav
31284 .endd
31285 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31286 Thelmen for contributing the code for this scanner.
31287
31288 .vitem &%kavdaemon%&
31289 .cindex "virus scanners" "Kaspersky"
31290 This is the scanner daemon of Kaspersky Version 4. This version of the
31291 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31292 scanner type takes one option, which is the path to the daemon's UNIX socket.
31293 For example:
31294 .code
31295 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31296 .endd
31297 The default path is &_/var/run/AvpCtl_&.
31298
31299 .vitem &%mksd%&
31300 .cindex "virus scanners" "mksd"
31301 This is a daemon type scanner that is aimed mainly at Polish users, though some
31302 parts of documentation are now available in English. You can get it at
31303 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31304 the maximum number of processes used simultaneously to scan the attachments,
31305 provided that the demime facility is employed and also provided that mksd has
31306 been run with at least the same number of child processes. For example:
31307 .code
31308 av_scanner = mksd:2
31309 .endd
31310 You can safely omit this option (the default value is 1).
31311
31312 .vitem &%sock%&
31313 .cindex "virus scanners" "simple socket-connected"
31314 This is a general-purpose way of talking to simple scanner daemons
31315 running on the local machine.
31316 There are four options:
31317 an address (which may be an IP address and port, or the path of a Unix socket),
31318 a commandline to send (may include a single %s which will be replaced with
31319 the path to the mail file to be scanned),
31320 an RE to trigger on from the returned data,
31321 an RE to extract malware_name from the returned data.
31322 For example:
31323 .code
31324 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31325 .endd
31326 Default for the socket specifier is &_/tmp/malware.sock_&.
31327 Default for the commandline is &_%s\n_&.
31328 Both regular-expressions are required.
31329
31330 .vitem &%sophie%&
31331 .cindex "virus scanners" "Sophos and Sophie"
31332 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31333 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31334 for this scanner type is the path to the UNIX socket that Sophie uses for
31335 client communication. For example:
31336 .code
31337 av_scanner = sophie:/tmp/sophie
31338 .endd
31339 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31340 the option.
31341 .endlist
31342
31343 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31344 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31345 ACL.
31346
31347 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31348 makes it possible to use different scanners. See further below for an example.
31349 The &%malware%& condition caches its results, so when you use it multiple times
31350 for the same message, the actual scanning process is only carried out once.
31351 However, using expandable items in &%av_scanner%& disables this caching, in
31352 which case each use of the &%malware%& condition causes a new scan of the
31353 message.
31354
31355 The &%malware%& condition takes a right-hand argument that is expanded before
31356 use and taken as a list, slash-separated by default.
31357 The first element can then be one of
31358
31359 .ilist
31360 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31361 The condition succeeds if a virus was found, and fail otherwise. This is the
31362 recommended usage.
31363 .next
31364 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31365 the condition fails immediately.
31366 .next
31367 A regular expression, in which case the message is scanned for viruses. The
31368 condition succeeds if a virus is found and its name matches the regular
31369 expression. This allows you to take special actions on certain types of virus.
31370 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31371 unless the separator is changed (in the usual way).
31372 .endlist
31373
31374 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31375 messages even if there is a problem with the virus scanner.
31376 Otherwise, such a problem causes the ACL to defer.
31377
31378 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31379 specify a non-default timeout.  The default is two minutes.
31380 For example:
31381 .code
31382 malware = * / defer_ok / tmo=10s
31383 .endd
31384 A timeout causes the ACL to defer.
31385
31386 .vindex "&$callout_address$&"
31387 When a connection is made to the scanner the expansion variable &$callout_address$&
31388 is set to record the actual address used.
31389
31390 .vindex "&$malware_name$&"
31391 When a virus is found, the condition sets up an expansion variable called
31392 &$malware_name$& that contains the name of the virus. You can use it in a
31393 &%message%& modifier that specifies the error returned to the sender, and/or in
31394 logging data.
31395
31396 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31397 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31398 &%malware%& condition.
31399
31400 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31401 imposed by your anti-virus scanner.
31402
31403 Here is a very simple scanning example:
31404 .code
31405 deny message = This message contains malware ($malware_name)
31406      demime = *
31407      malware = *
31408 .endd
31409 The next example accepts messages when there is a problem with the scanner:
31410 .code
31411 deny message = This message contains malware ($malware_name)
31412      demime = *
31413      malware = */defer_ok
31414 .endd
31415 The next example shows how to use an ACL variable to scan with both sophie and
31416 aveserver. It assumes you have set:
31417 .code
31418 av_scanner = $acl_m0
31419 .endd
31420 in the main Exim configuration.
31421 .code
31422 deny message = This message contains malware ($malware_name)
31423      set acl_m0 = sophie
31424      malware = *
31425
31426 deny message = This message contains malware ($malware_name)
31427      set acl_m0 = aveserver
31428      malware = *
31429 .endd
31430
31431
31432 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31433 .cindex "content scanning" "for spam"
31434 .cindex "spam scanning"
31435 .cindex "SpamAssassin"
31436 .cindex "Rspamd"
31437 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31438 score and a report for the message.
31439 Support is also provided for Rspamd.
31440
31441 For more information about installation and configuration of SpamAssassin or
31442 Rspamd refer to their respective websites at
31443 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31444
31445 SpamAssassin can be installed with CPAN by running:
31446 .code
31447 perl -MCPAN -e 'install Mail::SpamAssassin'
31448 .endd
31449 SpamAssassin has its own set of configuration files. Please review its
31450 documentation to see how you can tweak it. The default installation should work
31451 nicely, however.
31452
31453 .oindex "&%spamd_address%&"
31454 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31455 intend to use an instance running on the local host you do not need to set
31456 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31457 you must set the &%spamd_address%& option in the global part of the Exim
31458 configuration as follows (example):
31459 .code
31460 spamd_address = 192.168.99.45 387
31461 .endd
31462
31463 To use Rspamd (which by default listens on all local addresses
31464 on TCP port 11333)
31465 you should add &%variant=rspamd%& after the address/port pair, for example:
31466 .code
31467 spamd_address = 127.0.0.1 11333 variant=rspamd
31468 .endd
31469
31470 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31471 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31472 file name instead of an address/port pair:
31473 .code
31474 spamd_address = /var/run/spamd_socket
31475 .endd
31476 You can have multiple &%spamd%& servers to improve scalability. These can
31477 reside on other hardware reachable over the network. To specify multiple
31478 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31479 option, separated with colons (the separator can be changed in the usual way):
31480 .code
31481 spamd_address = 192.168.2.10 783 : \
31482                 192.168.2.11 783 : \
31483                 192.168.2.12 783
31484 .endd
31485 Up to 32 &%spamd%& servers are supported.
31486 When a server fails to respond to the connection attempt, all other
31487 servers are tried until one succeeds. If no server responds, the &%spam%&
31488 condition defers.
31489
31490 Unix and TCP socket specifications may be mixed in any order.
31491 Each element of the list is a list itself, space-separated by default
31492 and changeable in the usual way.
31493
31494 For TCP socket specifications a host name or IP (v4 or v6, but
31495 subject to list-separator quoting rules) address can be used,
31496 and the port can be one or a dash-separated pair.
31497 In the latter case, the range is tried in strict order.
31498
31499 Elements after the first for Unix sockets, or second for TCP socket,
31500 are options.
31501 The supported options are:
31502 .code
31503 pri=<priority>      Selection priority
31504 weight=<value>      Selection bias
31505 time=<start>-<end>  Use only between these times of day
31506 retry=<timespec>    Retry on connect fail
31507 tmo=<timespec>      Connection time limit
31508 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31509 .endd
31510
31511 The &`pri`& option specifies a priority for the server within the list,
31512 higher values being tried first.
31513 The default priority is 1.
31514
31515 The &`weight`& option specifies a selection bias.
31516 Within a priority set
31517 servers are queried in a random fashion, weighted by this value.
31518 The default value for selection bias is 1.
31519
31520 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31521 in the local time zone; each element being one or more digits.
31522 Either the seconds or both minutes and seconds, plus the leading &`.`&
31523 characters, may be omitted and will be taken as zero.
31524
31525 Timeout specifications for the &`retry`& and &`tmo`& options
31526 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31527
31528 The &`tmo`& option specifies an overall timeout for communication.
31529 The default value is two minutes.
31530
31531 The &`retry`& option specifies a time after which a single retry for
31532 a failed connect is made.
31533 The default is to not retry.
31534
31535 The &%spamd_address%& variable is expanded before use if it starts with
31536 a dollar sign. In this case, the expansion may return a string that is
31537 used as the list so that multiple spamd servers can be the result of an
31538 expansion.
31539
31540 .vindex "&$callout_address$&"
31541 When a connection is made to the server the expansion variable &$callout_address$&
31542 is set to record the actual address used.
31543
31544 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31545 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31546 .code
31547 deny message = This message was classified as SPAM
31548      spam = joe
31549 .endd
31550 The right-hand side of the &%spam%& condition specifies a name. This is
31551 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31552 to scan using a specific profile, but rather use the SpamAssassin system-wide
31553 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31554 Rspamd does not use this setting. However, you must put something on the
31555 right-hand side.
31556
31557 The name allows you to use per-domain or per-user antispam profiles in
31558 principle, but this is not straightforward in practice, because a message may
31559 have multiple recipients, not necessarily all in the same domain. Because the
31560 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31561 read the contents of the message, the variables &$local_part$& and &$domain$&
31562 are not set.
31563 Careful enforcement of single-recipient messages
31564 (e.g. by responding with defer in the recipient ACL for all recipients
31565 after the first),
31566 or the use of PRDR,
31567 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31568 are needed to use this feature.
31569
31570 The right-hand side of the &%spam%& condition is expanded before being used, so
31571 you can put lookups or conditions there. When the right-hand side evaluates to
31572 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31573
31574
31575 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31576 large ones may cause significant performance degradation. As most spam messages
31577 are quite small, it is recommended that you do not scan the big ones. For
31578 example:
31579 .code
31580 deny message = This message was classified as SPAM
31581      condition = ${if < {$message_size}{10K}}
31582      spam = nobody
31583 .endd
31584
31585 The &%spam%& condition returns true if the threshold specified in the user's
31586 SpamAssassin profile has been matched or exceeded. If you want to use the
31587 &%spam%& condition for its side effects (see the variables below), you can make
31588 it always return &"true"& by appending &`:true`& to the username.
31589
31590 .cindex "spam scanning" "returned variables"
31591 When the &%spam%& condition is run, it sets up a number of expansion
31592 variables.
31593 Except for &$spam_report$&,
31594 these variables are saved with the received message so are
31595 available for use at delivery time.
31596
31597 .vlist
31598 .vitem &$spam_score$&
31599 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31600 for inclusion in log or reject messages.
31601
31602 .vitem &$spam_score_int$&
31603 The spam score of the message, multiplied by ten, as an integer value. For
31604 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31605 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31606 The integer value is useful for numeric comparisons in conditions.
31607
31608 .vitem &$spam_bar$&
31609 A string consisting of a number of &"+"& or &"-"& characters, representing the
31610 integer part of the spam score value. A spam score of 4.4 would have a
31611 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31612 headers, since MUAs can match on such strings. The maximum length of the
31613 spam bar is 50 characters.
31614
31615 .vitem &$spam_report$&
31616 A multiline text table, containing the full SpamAssassin report for the
31617 message. Useful for inclusion in headers or reject messages.
31618 This variable is only usable in a DATA-time ACL.
31619
31620 .vitem &$spam_action$&
31621 For SpamAssassin either 'reject' or 'no action' depending on the
31622 spam score versus threshold.
31623 For Rspamd, the recommended action.
31624
31625 .endlist
31626
31627 The &%spam%& condition caches its results unless expansion in
31628 spamd_address was used. If you call it again with the same user name, it
31629 does not scan again, but rather returns the same values as before.
31630
31631 The &%spam%& condition returns DEFER if there is any error while running
31632 the message through SpamAssassin or if the expansion of spamd_address
31633 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31634 statement block), append &`/defer_ok`& to the right-hand side of the
31635 spam condition, like this:
31636 .code
31637 deny message = This message was classified as SPAM
31638      spam    = joe/defer_ok
31639 .endd
31640 This causes messages to be accepted even if there is a problem with &%spamd%&.
31641
31642 Here is a longer, commented example of the use of the &%spam%&
31643 condition:
31644 .code
31645 # put headers in all messages (no matter if spam or not)
31646 warn  spam = nobody:true
31647       add_header = X-Spam-Score: $spam_score ($spam_bar)
31648       add_header = X-Spam-Report: $spam_report
31649
31650 # add second subject line with *SPAM* marker when message
31651 # is over threshold
31652 warn  spam = nobody
31653       add_header = Subject: *SPAM* $h_Subject:
31654
31655 # reject spam at high scores (> 12)
31656 deny  message = This message scored $spam_score spam points.
31657       spam = nobody:true
31658       condition = ${if >{$spam_score_int}{120}{1}{0}}
31659 .endd
31660
31661
31662
31663 .section "Scanning MIME parts" "SECTscanmimepart"
31664 .cindex "content scanning" "MIME parts"
31665 .cindex "MIME content scanning"
31666 .oindex "&%acl_smtp_mime%&"
31667 .oindex "&%acl_not_smtp_mime%&"
31668 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31669 each MIME part of an SMTP message, including multipart types, in the sequence
31670 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31671 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31672 options may both refer to the same ACL if you want the same processing in both
31673 cases.
31674
31675 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31676 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31677 the case of a non-SMTP message. However, a MIME ACL is called only if the
31678 message contains a &'Content-Type:'& header line. When a call to a MIME
31679 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31680 result code is sent to the client. In the case of an SMTP message, the
31681 &%acl_smtp_data%& ACL is not called when this happens.
31682
31683 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31684 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31685 condition to match against the raw MIME part. You can also use the
31686 &%mime_regex%& condition to match against the decoded MIME part (see section
31687 &<<SECTscanregex>>&).
31688
31689 At the start of a MIME ACL, a number of variables are set from the header
31690 information for the relevant MIME part. These are described below. The contents
31691 of the MIME part are not by default decoded into a disk file except for MIME
31692 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31693 part into a disk file, you can use the &%decode%& condition. The general
31694 syntax is:
31695 .display
31696 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31697 .endd
31698 The right hand side is expanded before use. After expansion,
31699 the value can be:
31700
31701 .olist
31702 &"0"& or &"false"&, in which case no decoding is done.
31703 .next
31704 The string &"default"&. In that case, the file is put in the temporary
31705 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31706 a sequential file name consisting of the message id and a sequence number. The
31707 full path and name is available in &$mime_decoded_filename$& after decoding.
31708 .next
31709 A full path name starting with a slash. If the full name is an existing
31710 directory, it is used as a replacement for the default directory. The filename
31711 is then sequentially assigned. If the path does not exist, it is used as
31712 the full path and file name.
31713 .next
31714 If the string does not start with a slash, it is used as the
31715 filename, and the default path is then used.
31716 .endlist
31717 The &%decode%& condition normally succeeds. It is only false for syntax
31718 errors or unusual circumstances such as memory shortages. You can easily decode
31719 a file with its original, proposed filename using
31720 .code
31721 decode = $mime_filename
31722 .endd
31723 However, you should keep in mind that &$mime_filename$& might contain
31724 anything. If you place files outside of the default path, they are not
31725 automatically unlinked.
31726
31727 For RFC822 attachments (these are messages attached to messages, with a
31728 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31729 as for the primary message, only that the &$mime_is_rfc822$& expansion
31730 variable is set (see below). Attached messages are always decoded to disk
31731 before being checked, and the files are unlinked once the check is done.
31732
31733 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31734 used to match regular expressions against raw and decoded MIME parts,
31735 respectively. They are described in section &<<SECTscanregex>>&.
31736
31737 .cindex "MIME content scanning" "returned variables"
31738 The following list describes all expansion variables that are
31739 available in the MIME ACL:
31740
31741 .vlist
31742 .vitem &$mime_boundary$&
31743 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31744 have a boundary string, which is stored in this variable. If the current part
31745 has no boundary parameter in the &'Content-Type:'& header, this variable
31746 contains the empty string.
31747
31748 .vitem &$mime_charset$&
31749 This variable contains the character set identifier, if one was found in the
31750 &'Content-Type:'& header. Examples for charset identifiers are:
31751 .code
31752 us-ascii
31753 gb2312 (Chinese)
31754 iso-8859-1
31755 .endd
31756 Please note that this value is not normalized, so you should do matches
31757 case-insensitively.
31758
31759 .vitem &$mime_content_description$&
31760 This variable contains the normalized content of the &'Content-Description:'&
31761 header. It can contain a human-readable description of the parts content. Some
31762 implementations repeat the filename for attachments here, but they are usually
31763 only used for display purposes.
31764
31765 .vitem &$mime_content_disposition$&
31766 This variable contains the normalized content of the &'Content-Disposition:'&
31767 header. You can expect strings like &"attachment"& or &"inline"& here.
31768
31769 .vitem &$mime_content_id$&
31770 This variable contains the normalized content of the &'Content-ID:'& header.
31771 This is a unique ID that can be used to reference a part from another part.
31772
31773 .vitem &$mime_content_size$&
31774 This variable is set only after the &%decode%& modifier (see above) has been
31775 successfully run. It contains the size of the decoded part in kilobytes. The
31776 size is always rounded up to full kilobytes, so only a completely empty part
31777 has a &$mime_content_size$& of zero.
31778
31779 .vitem &$mime_content_transfer_encoding$&
31780 This variable contains the normalized content of the
31781 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31782 type. Typical values are &"base64"& and &"quoted-printable"&.
31783
31784 .vitem &$mime_content_type$&
31785 If the MIME part has a &'Content-Type:'& header, this variable contains its
31786 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31787 are some examples of popular MIME types, as they may appear in this variable:
31788 .code
31789 text/plain
31790 text/html
31791 application/octet-stream
31792 image/jpeg
31793 audio/midi
31794 .endd
31795 If the MIME part has no &'Content-Type:'& header, this variable contains the
31796 empty string.
31797
31798 .vitem &$mime_decoded_filename$&
31799 This variable is set only after the &%decode%& modifier (see above) has been
31800 successfully run. It contains the full path and file name of the file
31801 containing the decoded data.
31802 .endlist
31803
31804 .cindex "RFC 2047"
31805 .vlist
31806 .vitem &$mime_filename$&
31807 This is perhaps the most important of the MIME variables. It contains a
31808 proposed filename for an attachment, if one was found in either the
31809 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31810 RFC2047
31811 or RFC2231
31812 decoded, but no additional sanity checks are done.
31813  If no filename was
31814 found, this variable contains the empty string.
31815
31816 .vitem &$mime_is_coverletter$&
31817 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31818 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31819 content in the cover letter, while not restricting attachments at all.
31820
31821 The variable contains 1 (true) for a MIME part believed to be part of the
31822 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31823 follows:
31824
31825 .olist
31826 The outermost MIME part of a message is always a cover letter.
31827
31828 .next
31829 If a multipart/alternative or multipart/related MIME part is a cover letter,
31830 so are all MIME subparts within that multipart.
31831
31832 .next
31833 If any other multipart is a cover letter, the first subpart is a cover letter,
31834 and the rest are attachments.
31835
31836 .next
31837 All parts contained within an attachment multipart are attachments.
31838 .endlist olist
31839
31840 As an example, the following will ban &"HTML mail"& (including that sent with
31841 alternative plain text), while allowing HTML files to be attached. HTML
31842 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31843 .code
31844 deny message = HTML mail is not accepted here
31845 !condition = $mime_is_rfc822
31846 condition = $mime_is_coverletter
31847 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31848 .endd
31849 .vitem &$mime_is_multipart$&
31850 This variable has the value 1 (true) when the current part has the main type
31851 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31852 Since multipart entities only serve as containers for other parts, you may not
31853 want to carry out specific actions on them.
31854
31855 .vitem &$mime_is_rfc822$&
31856 This variable has the value 1 (true) if the current part is not a part of the
31857 checked message itself, but part of an attached message. Attached message
31858 decoding is fully recursive.
31859
31860 .vitem &$mime_part_count$&
31861 This variable is a counter that is raised for each processed MIME part. It
31862 starts at zero for the very first part (which is usually a multipart). The
31863 counter is per-message, so it is reset when processing RFC822 attachments (see
31864 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31865 complete, so you can use it in the DATA ACL to determine the number of MIME
31866 parts of a message. For non-MIME messages, this variable contains the value -1.
31867 .endlist
31868
31869
31870
31871 .section "Scanning with regular expressions" "SECTscanregex"
31872 .cindex "content scanning" "with regular expressions"
31873 .cindex "regular expressions" "content scanning with"
31874 You can specify your own custom regular expression matches on the full body of
31875 the message, or on individual MIME parts.
31876
31877 The &%regex%& condition takes one or more regular expressions as arguments and
31878 matches them against the full message (when called in the DATA ACL) or a raw
31879 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31880 linewise, with a maximum line length of 32K characters. That means you cannot
31881 have multiline matches with the &%regex%& condition.
31882
31883 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31884 to 32K of decoded content (the whole content at once, not linewise). If the
31885 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31886 is decoded automatically when &%mime_regex%& is executed (using default path
31887 and filename values). If the decoded data is larger than  32K, only the first
31888 32K characters are checked.
31889
31890 The regular expressions are passed as a colon-separated list. To include a
31891 literal colon, you must double it. Since the whole right-hand side string is
31892 expanded before being used, you must also escape dollar signs and backslashes
31893 with more backslashes, or use the &`\N`& facility to disable expansion.
31894 Here is a simple example that contains two regular expressions:
31895 .code
31896 deny message = contains blacklisted regex ($regex_match_string)
31897      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31898 .endd
31899 The conditions returns true if any one of the regular expressions matches. The
31900 &$regex_match_string$& expansion variable is then set up and contains the
31901 matching regular expression.
31902 The expansion variables &$regex1$& &$regex2$& etc
31903 are set to any substrings captured by the regular expression.
31904
31905 &*Warning*&: With large messages, these conditions can be fairly
31906 CPU-intensive.
31907
31908
31909
31910
31911 .section "The demime condition" "SECTdemimecond"
31912 .cindex "content scanning" "MIME checking"
31913 .cindex "MIME content scanning"
31914 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31915 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31916 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31917 ACL functionality, but provides no additional facilities. Please note that this
31918 condition is deprecated and kept only for backward compatibility. You must set
31919 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31920 use the &%demime%& condition.
31921
31922 The &%demime%& condition unpacks MIME containers in the message. It detects
31923 errors in MIME containers and can match file extensions found in the message
31924 against a list. Using this facility produces files containing the unpacked MIME
31925 parts of the message in the temporary scan directory. If you do antivirus
31926 scanning, it is recommended that you use the &%demime%& condition before the
31927 antivirus (&%malware%&) condition.
31928
31929 On the right-hand side of the &%demime%& condition you can pass a
31930 colon-separated list of file extensions that it should match against. For
31931 example:
31932 .code
31933 deny message = Found blacklisted file attachment
31934      demime  = vbs:com:bat:pif:prf:lnk
31935 .endd
31936 If one of the file extensions is found, the condition is true, otherwise it is
31937 false. If there is a temporary error while demimeing (for example, &"disk
31938 full"&), the condition defers, and the message is temporarily rejected (unless
31939 the condition is on a &%warn%& verb).
31940
31941 The right-hand side is expanded before being treated as a list, so you can have
31942 conditions and lookups there. If it expands to an empty string, &"false"&, or
31943 zero (&"0"&), no demimeing is done and the condition is false.
31944
31945 The &%demime%& condition set the following variables:
31946
31947 .vlist
31948 .vitem &$demime_errorlevel$&
31949 .vindex "&$demime_errorlevel$&"
31950 When an error is detected in a MIME container, this variable contains the
31951 severity of the error, as an integer number. The higher the value, the more
31952 severe the error (the current maximum value is 3). If this variable is unset or
31953 zero, no error occurred.
31954
31955 .vitem &$demime_reason$&
31956 .vindex "&$demime_reason$&"
31957 When &$demime_errorlevel$& is greater than zero, this variable contains a
31958 human-readable text string describing the MIME error that occurred.
31959 .endlist
31960
31961 .vlist
31962 .vitem &$found_extension$&
31963 .vindex "&$found_extension$&"
31964 When the &%demime%& condition is true, this variable contains the file
31965 extension it found.
31966 .endlist
31967
31968 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31969 the &%demime%& condition, and are not changed on subsequent calls.
31970
31971 If you do not want to check for file extensions, but rather use the &%demime%&
31972 condition for unpacking or error checking purposes, pass &"*"& as the
31973 right-hand side value. Here is a more elaborate example of how to use this
31974 facility:
31975 .code
31976 # Reject messages with serious MIME container errors
31977 deny  message = Found MIME error ($demime_reason).
31978       demime = *
31979       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31980
31981 # Reject known virus spreading file extensions.
31982 # Accepting these is pretty much braindead.
31983 deny  message = contains $found_extension file (blacklisted).
31984       demime  = com:vbs:bat:pif:scr
31985
31986 # Freeze .exe and .doc files. Postmaster can
31987 # examine them and eventually thaw them.
31988 deny  log_message = Another $found_extension file.
31989       demime = exe:doc
31990       control = freeze
31991 .endd
31992 .ecindex IIDcosca
31993
31994
31995
31996
31997 . ////////////////////////////////////////////////////////////////////////////
31998 . ////////////////////////////////////////////////////////////////////////////
31999
32000 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32001          "Local scan function"
32002 .scindex IIDlosca "&[local_scan()]& function" "description of"
32003 .cindex "customizing" "input scan using C function"
32004 .cindex "policy control" "by local scan function"
32005 In these days of email worms, viruses, and ever-increasing spam, some sites
32006 want to apply a lot of checking to messages before accepting them.
32007
32008 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32009 passing messages to external virus and spam scanning software. You can also do
32010 a certain amount in Exim itself through string expansions and the &%condition%&
32011 condition in the ACL that runs after the SMTP DATA command or the ACL for
32012 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32013
32014 To allow for further customization to a site's own requirements, there is the
32015 possibility of linking Exim with a private message scanning function, written
32016 in C. If you want to run code that is written in something other than C, you
32017 can of course use a little C stub to call it.
32018
32019 The local scan function is run once for every incoming message, at the point
32020 when Exim is just about to accept the message.
32021 It can therefore be used to control non-SMTP messages from local processes as
32022 well as messages arriving via SMTP.
32023
32024 Exim applies a timeout to calls of the local scan function, and there is an
32025 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32026 Zero means &"no timeout"&.
32027 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32028 before calling the local scan function, so that the most common types of crash
32029 are caught. If the timeout is exceeded or one of those signals is caught, the
32030 incoming message is rejected with a temporary error if it is an SMTP message.
32031 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32032 code. The incident is logged on the main and reject logs.
32033
32034
32035
32036 .section "Building Exim to use a local scan function" "SECID207"
32037 .cindex "&[local_scan()]& function" "building Exim to use"
32038 To make use of the local scan function feature, you must tell Exim where your
32039 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32040 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32041 directory, so you might set
32042 .code
32043 LOCAL_SCAN_SOURCE=Local/local_scan.c
32044 .endd
32045 for example. The function must be called &[local_scan()]&. It is called by
32046 Exim after it has received a message, when the success return code is about to
32047 be sent. This is after all the ACLs have been run. The return code from your
32048 function controls whether the message is actually accepted or not. There is a
32049 commented template function (that just accepts the message) in the file
32050 _src/local_scan.c_.
32051
32052 If you want to make use of Exim's run time configuration file to set options
32053 for your &[local_scan()]& function, you must also set
32054 .code
32055 LOCAL_SCAN_HAS_OPTIONS=yes
32056 .endd
32057 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32058
32059
32060
32061
32062 .section "API for local_scan()" "SECTapiforloc"
32063 .cindex "&[local_scan()]& function" "API description"
32064 You must include this line near the start of your code:
32065 .code
32066 #include "local_scan.h"
32067 .endd
32068 This header file defines a number of variables and other values, and the
32069 prototype for the function itself. Exim is coded to use unsigned char values
32070 almost exclusively, and one of the things this header defines is a shorthand
32071 for &`unsigned char`& called &`uschar`&.
32072 It also contains the following macro definitions, to simplify casting character
32073 strings and pointers to character strings:
32074 .code
32075 #define CS   (char *)
32076 #define CCS  (const char *)
32077 #define CSS  (char **)
32078 #define US   (unsigned char *)
32079 #define CUS  (const unsigned char *)
32080 #define USS  (unsigned char **)
32081 .endd
32082 The function prototype for &[local_scan()]& is:
32083 .code
32084 extern int local_scan(int fd, uschar **return_text);
32085 .endd
32086 The arguments are as follows:
32087
32088 .ilist
32089 &%fd%& is a file descriptor for the file that contains the body of the message
32090 (the -D file). The file is open for reading and writing, but updating it is not
32091 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32092
32093 The descriptor is positioned at character 19 of the file, which is the first
32094 character of the body itself, because the first 19 characters are the message
32095 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32096 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32097 case this changes in some future version.
32098 .next
32099 &%return_text%& is an address which you can use to return a pointer to a text
32100 string at the end of the function. The value it points to on entry is NULL.
32101 .endlist
32102
32103 The function must return an &%int%& value which is one of the following macros:
32104
32105 .vlist
32106 .vitem &`LOCAL_SCAN_ACCEPT`&
32107 .vindex "&$local_scan_data$&"
32108 The message is accepted. If you pass back a string of text, it is saved with
32109 the message, and made available in the variable &$local_scan_data$&. No
32110 newlines are permitted (if there are any, they are turned into spaces) and the
32111 maximum length of text is 1000 characters.
32112
32113 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32114 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32115 queued without immediate delivery, and is frozen.
32116
32117 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32118 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32119 queued without immediate delivery.
32120
32121 .vitem &`LOCAL_SCAN_REJECT`&
32122 The message is rejected; the returned text is used as an error message which is
32123 passed back to the sender and which is also logged. Newlines are permitted &--
32124 they cause a multiline response for SMTP rejections, but are converted to
32125 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32126 used.
32127
32128 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32129 The message is temporarily rejected; the returned text is used as an error
32130 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32131 problem"& is used.
32132
32133 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32134 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32135 message is not written to the reject log. It has the effect of unsetting the
32136 &%rejected_header%& log selector for just this rejection. If
32137 &%rejected_header%& is already unset (see the discussion of the
32138 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32139 same as LOCAL_SCAN_REJECT.
32140
32141 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32142 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32143 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32144 .endlist
32145
32146 If the message is not being received by interactive SMTP, rejections are
32147 reported by writing to &%stderr%& or by sending an email, as configured by the
32148 &%-oe%& command line options.
32149
32150
32151
32152 .section "Configuration options for local_scan()" "SECTconoptloc"
32153 .cindex "&[local_scan()]& function" "configuration options"
32154 It is possible to have option settings in the main configuration file
32155 that set values in static variables in the &[local_scan()]& module. If you
32156 want to do this, you must have the line
32157 .code
32158 LOCAL_SCAN_HAS_OPTIONS=yes
32159 .endd
32160 in your &_Local/Makefile_& when you build Exim. (This line is in
32161 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32162 file, you must define static variables to hold the option values, and a table
32163 to define them.
32164
32165 The table must be a vector called &%local_scan_options%&, of type
32166 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32167 and a pointer to the variable that holds the value. The entries must appear in
32168 alphabetical order. Following &%local_scan_options%& you must also define a
32169 variable called &%local_scan_options_count%& that contains the number of
32170 entries in the table. Here is a short example, showing two kinds of option:
32171 .code
32172 static int my_integer_option = 42;
32173 static uschar *my_string_option = US"a default string";
32174
32175 optionlist local_scan_options[] = {
32176   { "my_integer", opt_int,       &my_integer_option },
32177   { "my_string",  opt_stringptr, &my_string_option }
32178 };
32179
32180 int local_scan_options_count =
32181   sizeof(local_scan_options)/sizeof(optionlist);
32182 .endd
32183 The values of the variables can now be changed from Exim's runtime
32184 configuration file by including a local scan section as in this example:
32185 .code
32186 begin local_scan
32187 my_integer = 99
32188 my_string = some string of text...
32189 .endd
32190 The available types of option data are as follows:
32191
32192 .vlist
32193 .vitem &*opt_bool*&
32194 This specifies a boolean (true/false) option. The address should point to a
32195 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32196 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32197 whether such a variable has been set at all, you can initialize it to
32198 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32199 values.)
32200
32201 .vitem &*opt_fixed*&
32202 This specifies a fixed point number, such as is used for load averages.
32203 The address should point to a variable of type &`int`&. The value is stored
32204 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32205
32206 .vitem &*opt_int*&
32207 This specifies an integer; the address should point to a variable of type
32208 &`int`&. The value may be specified in any of the integer formats accepted by
32209 Exim.
32210
32211 .vitem &*opt_mkint*&
32212 This is the same as &%opt_int%&, except that when such a value is output in a
32213 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32214 printed with the suffix K or M.
32215
32216 .vitem &*opt_octint*&
32217 This also specifies an integer, but the value is always interpreted as an
32218 octal integer, whether or not it starts with the digit zero, and it is
32219 always output in octal.
32220
32221 .vitem &*opt_stringptr*&
32222 This specifies a string value; the address must be a pointer to a
32223 variable that points to a string (for example, of type &`uschar *`&).
32224
32225 .vitem &*opt_time*&
32226 This specifies a time interval value. The address must point to a variable of
32227 type &`int`&. The value that is placed there is a number of seconds.
32228 .endlist
32229
32230 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32231 out the values of all the &[local_scan()]& options.
32232
32233
32234
32235 .section "Available Exim variables" "SECID208"
32236 .cindex "&[local_scan()]& function" "available Exim variables"
32237 The header &_local_scan.h_& gives you access to a number of C variables. These
32238 are the only ones that are guaranteed to be maintained from release to release.
32239 Note, however, that you can obtain the value of any Exim expansion variable,
32240 including &$recipients$&, by calling &'expand_string()'&. The exported
32241 C variables are as follows:
32242
32243 .vlist
32244 .vitem &*int&~body_linecount*&
32245 This variable contains the number of lines in the message's body.
32246
32247 .vitem &*int&~body_zerocount*&
32248 This variable contains the number of binary zero bytes in the message's body.
32249
32250 .vitem &*unsigned&~int&~debug_selector*&
32251 This variable is set to zero when no debugging is taking place. Otherwise, it
32252 is a bitmap of debugging selectors. Two bits are identified for use in
32253 &[local_scan()]&; they are defined as macros:
32254
32255 .ilist
32256 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32257 testing option that is not privileged &-- any caller may set it. All the
32258 other selector bits can be set only by admin users.
32259
32260 .next
32261 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32262 by the &`+local_scan`& debug selector. It is not included in the default set
32263 of debugging bits.
32264 .endlist ilist
32265
32266 Thus, to write to the debugging output only when &`+local_scan`& has been
32267 selected, you should use code like this:
32268 .code
32269 if ((debug_selector & D_local_scan) != 0)
32270   debug_printf("xxx", ...);
32271 .endd
32272 .vitem &*uschar&~*expand_string_message*&
32273 After a failing call to &'expand_string()'& (returned value NULL), the
32274 variable &%expand_string_message%& contains the error message, zero-terminated.
32275
32276 .vitem &*header_line&~*header_list*&
32277 A pointer to a chain of header lines. The &%header_line%& structure is
32278 discussed below.
32279
32280 .vitem &*header_line&~*header_last*&
32281 A pointer to the last of the header lines.
32282
32283 .vitem &*uschar&~*headers_charset*&
32284 The value of the &%headers_charset%& configuration option.
32285
32286 .vitem &*BOOL&~host_checking*&
32287 This variable is TRUE during a host checking session that is initiated by the
32288 &%-bh%& command line option.
32289
32290 .vitem &*uschar&~*interface_address*&
32291 The IP address of the interface that received the message, as a string. This
32292 is NULL for locally submitted messages.
32293
32294 .vitem &*int&~interface_port*&
32295 The port on which this message was received. When testing with the &%-bh%&
32296 command line option, the value of this variable is -1 unless a port has been
32297 specified via the &%-oMi%& option.
32298
32299 .vitem &*uschar&~*message_id*&
32300 This variable contains Exim's message id for the incoming message (the value of
32301 &$message_exim_id$&) as a zero-terminated string.
32302
32303 .vitem &*uschar&~*received_protocol*&
32304 The name of the protocol by which the message was received.
32305
32306 .vitem &*int&~recipients_count*&
32307 The number of accepted recipients.
32308
32309 .vitem &*recipient_item&~*recipients_list*&
32310 .cindex "recipient" "adding in local scan"
32311 .cindex "recipient" "removing in local scan"
32312 The list of accepted recipients, held in a vector of length
32313 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32314 can add additional recipients by calling &'receive_add_recipient()'& (see
32315 below). You can delete recipients by removing them from the vector and
32316 adjusting the value in &%recipients_count%&. In particular, by setting
32317 &%recipients_count%& to zero you remove all recipients. If you then return the
32318 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32319 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32320 and then call &'receive_add_recipient()'& as often as needed.
32321
32322 .vitem &*uschar&~*sender_address*&
32323 The envelope sender address. For bounce messages this is the empty string.
32324
32325 .vitem &*uschar&~*sender_host_address*&
32326 The IP address of the sending host, as a string. This is NULL for
32327 locally-submitted messages.
32328
32329 .vitem &*uschar&~*sender_host_authenticated*&
32330 The name of the authentication mechanism that was used, or NULL if the message
32331 was not received over an authenticated SMTP connection.
32332
32333 .vitem &*uschar&~*sender_host_name*&
32334 The name of the sending host, if known.
32335
32336 .vitem &*int&~sender_host_port*&
32337 The port on the sending host.
32338
32339 .vitem &*BOOL&~smtp_input*&
32340 This variable is TRUE for all SMTP input, including BSMTP.
32341
32342 .vitem &*BOOL&~smtp_batched_input*&
32343 This variable is TRUE for BSMTP input.
32344
32345 .vitem &*int&~store_pool*&
32346 The contents of this variable control which pool of memory is used for new
32347 requests. See section &<<SECTmemhanloc>>& for details.
32348 .endlist
32349
32350
32351 .section "Structure of header lines" "SECID209"
32352 The &%header_line%& structure contains the members listed below.
32353 You can add additional header lines by calling the &'header_add()'& function
32354 (see below). You can cause header lines to be ignored (deleted) by setting
32355 their type to *.
32356
32357
32358 .vlist
32359 .vitem &*struct&~header_line&~*next*&
32360 A pointer to the next header line, or NULL for the last line.
32361
32362 .vitem &*int&~type*&
32363 A code identifying certain headers that Exim recognizes. The codes are printing
32364 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32365 Notice in particular that any header line whose type is * is not transmitted
32366 with the message. This flagging is used for header lines that have been
32367 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32368 lines.) Effectively, * means &"deleted"&.
32369
32370 .vitem &*int&~slen*&
32371 The number of characters in the header line, including the terminating and any
32372 internal newlines.
32373
32374 .vitem &*uschar&~*text*&
32375 A pointer to the text of the header. It always ends with a newline, followed by
32376 a zero byte. Internal newlines are preserved.
32377 .endlist
32378
32379
32380
32381 .section "Structure of recipient items" "SECID210"
32382 The &%recipient_item%& structure contains these members:
32383
32384 .vlist
32385 .vitem &*uschar&~*address*&
32386 This is a pointer to the recipient address as it was received.
32387
32388 .vitem &*int&~pno*&
32389 This is used in later Exim processing when top level addresses are created by
32390 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32391 and must always contain -1 at this stage.
32392
32393 .vitem &*uschar&~*errors_to*&
32394 If this value is not NULL, bounce messages caused by failing to deliver to the
32395 recipient are sent to the address it contains. In other words, it overrides the
32396 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32397 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32398 an unqualified address, Exim qualifies it using the domain from
32399 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32400 is NULL for all recipients.
32401 .endlist
32402
32403
32404
32405 .section "Available Exim functions" "SECID211"
32406 .cindex "&[local_scan()]& function" "available Exim functions"
32407 The header &_local_scan.h_& gives you access to a number of Exim functions.
32408 These are the only ones that are guaranteed to be maintained from release to
32409 release:
32410
32411 .vlist
32412 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32413        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32414
32415 This function creates a child process that runs the command specified by
32416 &%argv%&. The environment for the process is specified by &%envp%&, which can
32417 be NULL if no environment variables are to be passed. A new umask is supplied
32418 for the process in &%newumask%&.
32419
32420 Pipes to the standard input and output of the new process are set up
32421 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32422 standard error is cloned to the standard output. If there are any file
32423 descriptors &"in the way"& in the new process, they are closed. If the final
32424 argument is TRUE, the new process is made into a process group leader.
32425
32426 The function returns the pid of the new process, or -1 if things go wrong.
32427
32428 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32429 This function waits for a child process to terminate, or for a timeout (in
32430 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32431 return value is as follows:
32432
32433 .ilist
32434 >= 0
32435
32436 The process terminated by a normal exit and the value is the process
32437 ending status.
32438
32439 .next
32440 < 0 and > &--256
32441
32442 The process was terminated by a signal and the value is the negation of the
32443 signal number.
32444
32445 .next
32446 &--256
32447
32448 The process timed out.
32449 .next
32450 &--257
32451
32452 The was some other error in wait(); &%errno%& is still set.
32453 .endlist
32454
32455 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32456 This function provide you with a means of submitting a new message to
32457 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32458 want, but this packages it all up for you.) The function creates a pipe,
32459 forks a subprocess that is running
32460 .code
32461 exim -t -oem -oi -f <>
32462 .endd
32463 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32464 that is connected to the standard input. The yield of the function is the PID
32465 of the subprocess. You can then write a message to the file descriptor, with
32466 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32467
32468 When you have finished, call &'child_close()'& to wait for the process to
32469 finish and to collect its ending status. A timeout value of zero is usually
32470 fine in this circumstance. Unless you have made a mistake with the recipient
32471 addresses, you should get a return code of zero.
32472
32473
32474 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32475        *sender_authentication)*&
32476 This function is a more sophisticated version of &'child_open()'&. The command
32477 that it runs is:
32478 .display
32479 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32480 .endd
32481 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32482
32483
32484 .vitem &*void&~debug_printf(char&~*,&~...)*&
32485 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32486 output is written to the standard error stream. If no debugging is selected,
32487 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32488 conditional on the &`local_scan`& debug selector by coding like this:
32489 .code
32490 if ((debug_selector & D_local_scan) != 0)
32491   debug_printf("xxx", ...);
32492 .endd
32493
32494 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32495 This is an interface to Exim's string expansion code. The return value is the
32496 expanded string, or NULL if there was an expansion failure.
32497 The C variable &%expand_string_message%& contains an error message after an
32498 expansion failure. If expansion does not change the string, the return value is
32499 the pointer to the input string. Otherwise, the return value points to a new
32500 block of memory that was obtained by a call to &'store_get()'&. See section
32501 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32502
32503 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32504 This function allows you to an add additional header line at the end of the
32505 existing ones. The first argument is the type, and should normally be a space
32506 character. The second argument is a format string and any number of
32507 substitution arguments as for &[sprintf()]&. You may include internal newlines
32508 if you want, and you must ensure that the string ends with a newline.
32509
32510 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32511         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32512 This function adds a new header line at a specified point in the header
32513 chain. The header itself is specified as for &'header_add()'&.
32514
32515 If &%name%& is NULL, the new header is added at the end of the chain if
32516 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32517 NULL, the header lines are searched for the first non-deleted header that
32518 matches the name. If one is found, the new header is added before it if
32519 &%after%& is false. If &%after%& is true, the new header is added after the
32520 found header and any adjacent subsequent ones with the same name (even if
32521 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32522 option controls where the header is added. If it is true, addition is at the
32523 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32524 headers, or at the top if there are no &'Received:'& headers, you could use
32525 .code
32526 header_add_at_position(TRUE, US"Received", TRUE,
32527   ' ', "X-xxx: ...");
32528 .endd
32529 Normally, there is always at least one non-deleted &'Received:'& header, but
32530 there may not be if &%received_header_text%& expands to an empty string.
32531
32532
32533 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32534 This function removes header lines. If &%occurrence%& is zero or negative, all
32535 occurrences of the header are removed. If occurrence is greater than zero, that
32536 particular instance of the header is removed. If no header(s) can be found that
32537 match the specification, the function does nothing.
32538
32539
32540 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32541         int&~length,&~BOOL&~notdel)*&"
32542 This function tests whether the given header has the given name. It is not just
32543 a string comparison, because white space is permitted between the name and the
32544 colon. If the &%notdel%& argument is true, a false return is forced for all
32545 &"deleted"& headers; otherwise they are not treated specially. For example:
32546 .code
32547 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32548 .endd
32549 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32550 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32551 This function base64-encodes a string, which is passed by address and length.
32552 The text may contain bytes of any value, including zero. The result is passed
32553 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32554 zero-terminated.
32555
32556 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32557 This function decodes a base64-encoded string. Its arguments are a
32558 zero-terminated base64-encoded string and the address of a variable that is set
32559 to point to the result, which is in dynamic memory. The length of the decoded
32560 string is the yield of the function. If the input is invalid base64 data, the
32561 yield is -1. A zero byte is added to the end of the output string to make it
32562 easy to interpret as a C string (assuming it contains no zeros of its own). The
32563 added zero byte is not included in the returned count.
32564
32565 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32566 This function checks for a match in a domain list. Domains are always
32567 matched caselessly. The return value is one of the following:
32568 .display
32569 &`OK     `& match succeeded
32570 &`FAIL   `& match failed
32571 &`DEFER  `& match deferred
32572 .endd
32573 DEFER is usually caused by some kind of lookup defer, such as the
32574 inability to contact a database.
32575
32576 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32577         BOOL&~caseless)*&"
32578 This function checks for a match in a local part list. The third argument
32579 controls case-sensitivity. The return values are as for
32580 &'lss_match_domain()'&.
32581
32582 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32583         BOOL&~caseless)*&"
32584 This function checks for a match in an address list. The third argument
32585 controls the case-sensitivity of the local part match. The domain is always
32586 matched caselessly. The return values are as for &'lss_match_domain()'&.
32587
32588 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32589         uschar&~*list)*&"
32590 This function checks for a match in a host list. The most common usage is
32591 expected to be
32592 .code
32593 lss_match_host(sender_host_name, sender_host_address, ...)
32594 .endd
32595 .vindex "&$sender_host_address$&"
32596 An empty address field matches an empty item in the host list. If the host name
32597 is NULL, the name corresponding to &$sender_host_address$& is automatically
32598 looked up if a host name is required to match an item in the list. The return
32599 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32600 returns ERROR in the case when it had to look up a host name, but the lookup
32601 failed.
32602
32603 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32604         *format,&~...)*&"
32605 This function writes to Exim's log files. The first argument should be zero (it
32606 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32607 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32608 them. It specifies to which log or logs the message is written. The remaining
32609 arguments are a format and relevant insertion arguments. The string should not
32610 contain any newlines, not even at the end.
32611
32612
32613 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32614 This function adds an additional recipient to the message. The first argument
32615 is the recipient address. If it is unqualified (has no domain), it is qualified
32616 with the &%qualify_recipient%& domain. The second argument must always be -1.
32617
32618 This function does not allow you to specify a private &%errors_to%& address (as
32619 described with the structure of &%recipient_item%& above), because it pre-dates
32620 the addition of that field to the structure. However, it is easy to add such a
32621 value afterwards. For example:
32622 .code
32623  receive_add_recipient(US"monitor@mydom.example", -1);
32624  recipients_list[recipients_count-1].errors_to =
32625    US"postmaster@mydom.example";
32626 .endd
32627
32628 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32629 This is a convenience function to remove a named recipient from the list of
32630 recipients. It returns true if a recipient was removed, and false if no
32631 matching recipient could be found. The argument must be a complete email
32632 address.
32633 .endlist
32634
32635
32636 .cindex "RFC 2047"
32637 .vlist
32638 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32639   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32640 This function decodes strings that are encoded according to RFC 2047. Typically
32641 these are the contents of header lines. First, each &"encoded word"& is decoded
32642 from the Q or B encoding into a byte-string. Then, if provided with the name of
32643 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32644 made  to translate the result to the named character set. If this fails, the
32645 binary string is returned with an error message.
32646
32647 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32648 maximum MIME word length is enforced. The third argument is the target
32649 encoding, or NULL if no translation is wanted.
32650
32651 .cindex "binary zero" "in RFC 2047 decoding"
32652 .cindex "RFC 2047" "binary zero in"
32653 If a binary zero is encountered in the decoded string, it is replaced by the
32654 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32655 not be 0 because header lines are handled as zero-terminated strings.
32656
32657 The function returns the result of processing the string, zero-terminated; if
32658 &%lenptr%& is not NULL, the length of the result is set in the variable to
32659 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32660
32661 If an error is encountered, the function returns NULL and uses the &%error%&
32662 argument to return an error message. The variable pointed to by &%error%& is
32663 set to NULL if there is no error; it may be set non-NULL even when the function
32664 returns a non-NULL value if decoding was successful, but there was a problem
32665 with translation.
32666
32667
32668 .vitem &*int&~smtp_fflush(void)*&
32669 This function is used in conjunction with &'smtp_printf()'&, as described
32670 below.
32671
32672 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32673 The arguments of this function are like &[printf()]&; it writes to the SMTP
32674 output stream. You should use this function only when there is an SMTP output
32675 stream, that is, when the incoming message is being received via interactive
32676 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32677 is FALSE. If you want to test for an incoming message from another host (as
32678 opposed to a local process that used the &%-bs%& command line option), you can
32679 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32680 is involved.
32681
32682 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32683 output function, so it can be used for all forms of SMTP connection.
32684
32685 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32686 must start with an appropriate response code: 550 if you are going to return
32687 LOCAL_SCAN_REJECT, 451 if you are going to return
32688 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32689 initial lines of a multi-line response, the code must be followed by a hyphen
32690 to indicate that the line is not the final response line. You must also ensure
32691 that the lines you write terminate with CRLF. For example:
32692 .code
32693 smtp_printf("550-this is some extra info\r\n");
32694 return LOCAL_SCAN_REJECT;
32695 .endd
32696 Note that you can also create multi-line responses by including newlines in
32697 the data returned via the &%return_text%& argument. The added value of using
32698 &'smtp_printf()'& is that, for instance, you could introduce delays between
32699 multiple output lines.
32700
32701 The &'smtp_printf()'& function does not return any error indication, because it
32702 does not automatically flush pending output, and therefore does not test
32703 the state of the stream. (In the main code of Exim, flushing and error
32704 detection is done when Exim is ready for the next SMTP input command.) If
32705 you want to flush the output and check for an error (for example, the
32706 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32707 arguments. It flushes the output stream, and returns a non-zero value if there
32708 is an error.
32709
32710 .vitem &*void&~*store_get(int)*&
32711 This function accesses Exim's internal store (memory) manager. It gets a new
32712 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32713 runs out of memory. See the next section for a discussion of memory handling.
32714
32715 .vitem &*void&~*store_get_perm(int)*&
32716 This function is like &'store_get()'&, but it always gets memory from the
32717 permanent pool. See the next section for a discussion of memory handling.
32718
32719 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32720 See below.
32721
32722 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32723 See below.
32724
32725 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32726 These three functions create strings using Exim's dynamic memory facilities.
32727 The first makes a copy of an entire string. The second copies up to a maximum
32728 number of characters, indicated by the second argument. The third uses a format
32729 and insertion arguments to create a new string. In each case, the result is a
32730 pointer to a new string in the current memory pool. See the next section for
32731 more discussion.
32732 .endlist
32733
32734
32735
32736 .section "More about Exim's memory handling" "SECTmemhanloc"
32737 .cindex "&[local_scan()]& function" "memory handling"
32738 No function is provided for freeing memory, because that is never needed.
32739 The dynamic memory that Exim uses when receiving a message is automatically
32740 recycled if another message is received by the same process (this applies only
32741 to incoming SMTP connections &-- other input methods can supply only one
32742 message at a time). After receiving the last message, a reception process
32743 terminates.
32744
32745 Because it is recycled, the normal dynamic memory cannot be used for holding
32746 data that must be preserved over a number of incoming messages on the same SMTP
32747 connection. However, Exim in fact uses two pools of dynamic memory; the second
32748 one is not recycled, and can be used for this purpose.
32749
32750 If you want to allocate memory that remains available for subsequent messages
32751 in the same SMTP connection, you should set
32752 .code
32753 store_pool = POOL_PERM
32754 .endd
32755 before calling the function that does the allocation. There is no need to
32756 restore the value if you do not need to; however, if you do want to revert to
32757 the normal pool, you can either restore the previous value of &%store_pool%& or
32758 set it explicitly to POOL_MAIN.
32759
32760 The pool setting applies to all functions that get dynamic memory, including
32761 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32762 There is also a convenience function called &'store_get_perm()'& that gets a
32763 block of memory from the permanent pool while preserving the value of
32764 &%store_pool%&.
32765 .ecindex IIDlosca
32766
32767
32768
32769
32770 . ////////////////////////////////////////////////////////////////////////////
32771 . ////////////////////////////////////////////////////////////////////////////
32772
32773 .chapter "System-wide message filtering" "CHAPsystemfilter"
32774 .scindex IIDsysfil1 "filter" "system filter"
32775 .scindex IIDsysfil2 "filtering all mail"
32776 .scindex IIDsysfil3 "system filter"
32777 The previous chapters (on ACLs and the local scan function) describe checks
32778 that can be applied to messages before they are accepted by a host. There is
32779 also a mechanism for checking messages once they have been received, but before
32780 they are delivered. This is called the &'system filter'&.
32781
32782 The system filter operates in a similar manner to users' filter files, but it
32783 is run just once per message (however many recipients the message has).
32784 It should not normally be used as a substitute for routing, because &%deliver%&
32785 commands in a system router provide new envelope recipient addresses.
32786 The system filter must be an Exim filter. It cannot be a Sieve filter.
32787
32788 The system filter is run at the start of a delivery attempt, before any routing
32789 is done. If a message fails to be completely delivered at the first attempt,
32790 the system filter is run again at the start of every retry.
32791 If you want your filter to do something only once per message, you can make use
32792 of the &%first_delivery%& condition in an &%if%& command in the filter to
32793 prevent it happening on retries.
32794
32795 .vindex "&$domain$&"
32796 .vindex "&$local_part$&"
32797 &*Warning*&: Because the system filter runs just once, variables that are
32798 specific to individual recipient addresses, such as &$local_part$& and
32799 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32800 you want to run a centrally-specified filter for each recipient address
32801 independently, you can do so by setting up a suitable &(redirect)& router, as
32802 described in section &<<SECTperaddfil>>& below.
32803
32804
32805 .section "Specifying a system filter" "SECID212"
32806 .cindex "uid (user id)" "system filter"
32807 .cindex "gid (group id)" "system filter"
32808 The name of the file that contains the system filter must be specified by
32809 setting &%system_filter%&. If you want the filter to run under a uid and gid
32810 other than root, you must also set &%system_filter_user%& and
32811 &%system_filter_group%& as appropriate. For example:
32812 .code
32813 system_filter = /etc/mail/exim.filter
32814 system_filter_user = exim
32815 .endd
32816 If a system filter generates any deliveries directly to files or pipes (via the
32817 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32818 specified by setting &%system_filter_file_transport%& and
32819 &%system_filter_pipe_transport%&, respectively. Similarly,
32820 &%system_filter_reply_transport%& must be set to handle any messages generated
32821 by the &%reply%& command.
32822
32823
32824 .section "Testing a system filter" "SECID213"
32825 You can run simple tests of a system filter in the same way as for a user
32826 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32827 are permitted only in system filters are recognized.
32828
32829 If you want to test the combined effect of a system filter and a user filter,
32830 you can use both &%-bF%& and &%-bf%& on the same command line.
32831
32832
32833
32834 .section "Contents of a system filter" "SECID214"
32835 The language used to specify system filters is the same as for users' filter
32836 files. It is described in the separate end-user document &'Exim's interface to
32837 mail filtering'&. However, there are some additional features that are
32838 available only in system filters; these are described in subsequent sections.
32839 If they are encountered in a user's filter file or when testing with &%-bf%&,
32840 they cause errors.
32841
32842 .cindex "frozen messages" "manual thaw; testing in filter"
32843 There are two special conditions which, though available in users' filter
32844 files, are designed for use in system filters. The condition &%first_delivery%&
32845 is true only for the first attempt at delivering a message, and
32846 &%manually_thawed%& is true only if the message has been frozen, and
32847 subsequently thawed by an admin user. An explicit forced delivery counts as a
32848 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32849
32850 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32851 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32852 succeed, it will not be tried again.
32853 If you want Exim to retry an unseen delivery until it succeeds, you should
32854 arrange to set it up every time the filter runs.
32855
32856 When a system filter finishes running, the values of the variables &$n0$& &--
32857 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32858 users' filter files. Thus a system filter can, for example, set up &"scores"&
32859 to which users' filter files can refer.
32860
32861
32862
32863 .section "Additional variable for system filters" "SECID215"
32864 .vindex "&$recipients$&"
32865 The expansion variable &$recipients$&, containing a list of all the recipients
32866 of the message (separated by commas and white space), is available in system
32867 filters. It is not available in users' filters for privacy reasons.
32868
32869
32870
32871 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32872 .cindex "freezing messages"
32873 .cindex "message" "freezing"
32874 .cindex "message" "forced failure"
32875 .cindex "&%fail%&" "in system filter"
32876 .cindex "&%freeze%& in system filter"
32877 .cindex "&%defer%& in system filter"
32878 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32879 always available in system filters, but are not normally enabled in users'
32880 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32881 for the &(redirect)& router.) These commands can optionally be followed by the
32882 word &%text%& and a string containing an error message, for example:
32883 .code
32884 fail text "this message looks like spam to me"
32885 .endd
32886 The keyword &%text%& is optional if the next character is a double quote.
32887
32888 The &%defer%& command defers delivery of the original recipients of the
32889 message. The &%fail%& command causes all the original recipients to be failed,
32890 and a bounce message to be created. The &%freeze%& command suspends all
32891 delivery attempts for the original recipients. In all cases, any new deliveries
32892 that are specified by the filter are attempted as normal after the filter has
32893 run.
32894
32895 The &%freeze%& command is ignored if the message has been manually unfrozen and
32896 not manually frozen since. This means that automatic freezing by a system
32897 filter can be used as a way of checking out suspicious messages. If a message
32898 is found to be all right, manually unfreezing it allows it to be delivered.
32899
32900 .cindex "log" "&%fail%& command log line"
32901 .cindex "&%fail%&" "log line; reducing"
32902 The text given with a fail command is used as part of the bounce message as
32903 well as being written to the log. If the message is quite long, this can fill
32904 up a lot of log space when such failures are common. To reduce the size of the
32905 log message, Exim interprets the text in a special way if it starts with the
32906 two characters &`<<`& and contains &`>>`& later. The text between these two
32907 strings is written to the log, and the rest of the text is used in the bounce
32908 message. For example:
32909 .code
32910 fail "<<filter test 1>>Your message is rejected \
32911      because it contains attachments that we are \
32912      not prepared to receive."
32913 .endd
32914
32915 .cindex "loop" "caused by &%fail%&"
32916 Take great care with the &%fail%& command when basing the decision to fail on
32917 the contents of the message, because the bounce message will of course include
32918 the contents of the original message and will therefore trigger the &%fail%&
32919 command again (causing a mail loop) unless steps are taken to prevent this.
32920 Testing the &%error_message%& condition is one way to prevent this. You could
32921 use, for example
32922 .code
32923 if $message_body contains "this is spam" and not error_message
32924 then fail text "spam is not wanted here" endif
32925 .endd
32926 though of course that might let through unwanted bounce messages. The
32927 alternative is clever checking of the body and/or headers to detect bounces
32928 generated by the filter.
32929
32930 The interpretation of a system filter file ceases after a
32931 &%defer%&,
32932 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32933 set up earlier in the filter file are honoured, so you can use a sequence such
32934 as
32935 .code
32936 mail ...
32937 freeze
32938 .endd
32939 to send a specified message when the system filter is freezing (or deferring or
32940 failing) a message. The normal deliveries for the message do not, of course,
32941 take place.
32942
32943
32944
32945 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32946 .cindex "header lines" "adding; in system filter"
32947 .cindex "header lines" "removing; in system filter"
32948 .cindex "filter" "header lines; adding/removing"
32949 Two filter commands that are available only in system filters are:
32950 .code
32951 headers add <string>
32952 headers remove <string>
32953 .endd
32954 The argument for the &%headers add%& is a string that is expanded and then
32955 added to the end of the message's headers. It is the responsibility of the
32956 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32957 space is ignored, and if the string is otherwise empty, or if the expansion is
32958 forced to fail, the command has no effect.
32959
32960 You can use &"\n"& within the string, followed by white space, to specify
32961 continued header lines. More than one header may be added in one command by
32962 including &"\n"& within the string without any following white space. For
32963 example:
32964 .code
32965 headers add "X-header-1: ....\n  \
32966              continuation of X-header-1 ...\n\
32967              X-header-2: ...."
32968 .endd
32969 Note that the header line continuation white space after the first newline must
32970 be placed before the backslash that continues the input string, because white
32971 space after input continuations is ignored.
32972
32973 The argument for &%headers remove%& is a colon-separated list of header names.
32974 This command applies only to those headers that are stored with the message;
32975 those that are added at delivery time (such as &'Envelope-To:'& and
32976 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32977 header with the same name, they are all removed.
32978
32979 The &%headers%& command in a system filter makes an immediate change to the set
32980 of header lines that was received with the message (with possible additions
32981 from ACL processing). Subsequent commands in the system filter operate on the
32982 modified set, which also forms the basis for subsequent message delivery.
32983 Unless further modified during routing or transporting, this set of headers is
32984 used for all recipients of the message.
32985
32986 During routing and transporting, the variables that refer to the contents of
32987 header lines refer only to those lines that are in this set. Thus, header lines
32988 that are added by a system filter are visible to users' filter files and to all
32989 routers and transports. This contrasts with the manipulation of header lines by
32990 routers and transports, which is not immediate, but which instead is saved up
32991 until the message is actually being written (see section
32992 &<<SECTheadersaddrem>>&).
32993
32994 If the message is not delivered at the first attempt, header lines that were
32995 added by the system filter are stored with the message, and so are still
32996 present at the next delivery attempt. Header lines that were removed are still
32997 present, but marked &"deleted"& so that they are not transported with the
32998 message. For this reason, it is usual to make the &%headers%& command
32999 conditional on &%first_delivery%& so that the set of header lines is not
33000 modified more than once.
33001
33002 Because header modification in a system filter acts immediately, you have to
33003 use an indirect approach if you want to modify the contents of a header line.
33004 For example:
33005 .code
33006 headers add "Old-Subject: $h_subject:"
33007 headers remove "Subject"
33008 headers add "Subject: new subject (was: $h_old-subject:)"
33009 headers remove "Old-Subject"
33010 .endd
33011
33012
33013
33014 .section "Setting an errors address in a system filter" "SECID217"
33015 .cindex "envelope sender"
33016 In a system filter, if a &%deliver%& command is followed by
33017 .code
33018 errors_to <some address>
33019 .endd
33020 in order to change the envelope sender (and hence the error reporting) for that
33021 delivery, any address may be specified. (In a user filter, only the current
33022 user's address can be set.) For example, if some mail is being monitored, you
33023 might use
33024 .code
33025 unseen deliver monitor@spying.example errors_to root@local.example
33026 .endd
33027 to take a copy which would not be sent back to the normal error reporting
33028 address if its delivery failed.
33029
33030
33031
33032 .section "Per-address filtering" "SECTperaddfil"
33033 .vindex "&$domain$&"
33034 .vindex "&$local_part$&"
33035 In contrast to the system filter, which is run just once per message for each
33036 delivery attempt, it is also possible to set up a system-wide filtering
33037 operation that runs once for each recipient address. In this case, variables
33038 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33039 filter file could be made dependent on them. This is an example of a router
33040 which implements such a filter:
33041 .code
33042 central_filter:
33043   check_local_user
33044   driver = redirect
33045   domains = +local_domains
33046   file = /central/filters/$local_part
33047   no_verify
33048   allow_filter
33049   allow_freeze
33050 .endd
33051 The filter is run in a separate process under its own uid. Therefore, either
33052 &%check_local_user%& must be set (as above), in which case the filter is run as
33053 the local user, or the &%user%& option must be used to specify which user to
33054 use. If both are set, &%user%& overrides.
33055
33056 Care should be taken to ensure that none of the commands in the filter file
33057 specify a significant delivery if the message is to go on to be delivered to
33058 its intended recipient. The router will not then claim to have dealt with the
33059 address, so it will be passed on to subsequent routers to be delivered in the
33060 normal way.
33061 .ecindex IIDsysfil1
33062 .ecindex IIDsysfil2
33063 .ecindex IIDsysfil3
33064
33065
33066
33067
33068
33069
33070 . ////////////////////////////////////////////////////////////////////////////
33071 . ////////////////////////////////////////////////////////////////////////////
33072
33073 .chapter "Message processing" "CHAPmsgproc"
33074 .scindex IIDmesproc "message" "general processing"
33075 Exim performs various transformations on the sender and recipient addresses of
33076 all messages that it handles, and also on the messages' header lines. Some of
33077 these are optional and configurable, while others always take place. All of
33078 this processing, except rewriting as a result of routing, and the addition or
33079 removal of header lines while delivering, happens when a message is received,
33080 before it is placed on Exim's queue.
33081
33082 Some of the automatic processing takes place by default only for
33083 &"locally-originated"& messages. This adjective is used to describe messages
33084 that are not received over TCP/IP, but instead are passed to an Exim process on
33085 its standard input. This includes the interactive &"local SMTP"& case that is
33086 set up by the &%-bs%& command line option.
33087
33088 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33089 or ::1) are not considered to be locally-originated. Exim does not treat the
33090 loopback interface specially in any way.
33091
33092 If you want the loopback interface to be treated specially, you must ensure
33093 that there are appropriate entries in your ACLs.
33094
33095
33096
33097
33098 .section "Submission mode for non-local messages" "SECTsubmodnon"
33099 .cindex "message" "submission"
33100 .cindex "submission mode"
33101 Processing that happens automatically for locally-originated messages (unless
33102 &%suppress_local_fixups%& is set) can also be requested for messages that are
33103 received over TCP/IP. The term &"submission mode"& is used to describe this
33104 state. Submission mode is set by the modifier
33105 .code
33106 control = submission
33107 .endd
33108 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33109 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33110 a local submission, and is normally used when the source of the message is
33111 known to be an MUA running on a client host (as opposed to an MTA). For
33112 example, to set submission mode for messages originating on the IPv4 loopback
33113 interface, you could include the following in the MAIL ACL:
33114 .code
33115 warn  hosts = 127.0.0.1
33116       control = submission
33117 .endd
33118 .cindex "&%sender_retain%& submission option"
33119 There are some options that can be used when setting submission mode. A slash
33120 is used to separate options. For example:
33121 .code
33122 control = submission/sender_retain
33123 .endd
33124 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33125 true and &%local_from_check%& false for the current incoming message. The first
33126 of these allows an existing &'Sender:'& header in the message to remain, and
33127 the second suppresses the check to ensure that &'From:'& matches the
33128 authenticated sender. With this setting, Exim still fixes up messages by adding
33129 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33130 attempt to check sender authenticity in header lines.
33131
33132 When &%sender_retain%& is not set, a submission mode setting may specify a
33133 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33134 example:
33135 .code
33136 control = submission/domain=some.domain
33137 .endd
33138 The domain may be empty. How this value is used is described in sections
33139 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33140 that allows you to specify the user's full name for inclusion in a created
33141 &'Sender:'& or &'From:'& header line. For example:
33142 .code
33143 accept authenticated = *
33144        control = submission/domain=wonderland.example/\
33145                             name=${lookup {$authenticated_id} \
33146                                    lsearch {/etc/exim/namelist}}
33147 .endd
33148 Because the name may contain any characters, including slashes, the &%name%&
33149 option must be given last. The remainder of the string is used as the name. For
33150 the example above, if &_/etc/exim/namelist_& contains:
33151 .code
33152 bigegg:  Humpty Dumpty
33153 .endd
33154 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33155 line would be:
33156 .code
33157 Sender: Humpty Dumpty <bigegg@wonderland.example>
33158 .endd
33159 .cindex "return path" "in submission mode"
33160 By default, submission mode forces the return path to the same address as is
33161 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33162 specified, the return path is also left unchanged.
33163
33164 &*Note*&: The changes caused by submission mode take effect after the predata
33165 ACL. This means that any sender checks performed before the fix-ups use the
33166 untrusted sender address specified by the user, not the trusted sender address
33167 specified by submission mode. Although this might be slightly unexpected, it
33168 does mean that you can configure ACL checks to spot that a user is trying to
33169 spoof another's address.
33170
33171 .section "Line endings" "SECTlineendings"
33172 .cindex "line endings"
33173 .cindex "carriage return"
33174 .cindex "linefeed"
33175 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33176 linefeed) is the line ending for messages transmitted over the Internet using
33177 SMTP over TCP/IP. However, within individual operating systems, different
33178 conventions are used. For example, Unix-like systems use just LF, but others
33179 use CRLF or just CR.
33180
33181 Exim was designed for Unix-like systems, and internally, it stores messages
33182 using the system's convention of a single LF as a line terminator. When
33183 receiving a message, all line endings are translated to this standard format.
33184 Originally, it was thought that programs that passed messages directly to an
33185 MTA within an operating system would use that system's convention. Experience
33186 has shown that this is not the case; for example, there are Unix applications
33187 that use CRLF in this circumstance. For this reason, and for compatibility with
33188 other MTAs, the way Exim handles line endings for all messages is now as
33189 follows:
33190
33191 .ilist
33192 LF not preceded by CR is treated as a line ending.
33193 .next
33194 CR is treated as a line ending; if it is immediately followed by LF, the LF
33195 is ignored.
33196 .next
33197 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33198 nor a local message in the state where a line containing only a dot is a
33199 terminator.
33200 .next
33201 If a bare CR is encountered within a header line, an extra space is added after
33202 the line terminator so as not to end the header line. The reasoning behind this
33203 is that bare CRs in header lines are most likely either to be mistakes, or
33204 people trying to play silly games.
33205 .next
33206 If the first header line received in a message ends with CRLF, a subsequent
33207 bare LF in a header line is treated in the same way as a bare CR in a header
33208 line.
33209 .endlist
33210
33211
33212
33213
33214
33215 .section "Unqualified addresses" "SECID218"
33216 .cindex "unqualified addresses"
33217 .cindex "address" "qualification"
33218 By default, Exim expects every envelope address it receives from an external
33219 host to be fully qualified. Unqualified addresses cause negative responses to
33220 SMTP commands. However, because SMTP is used as a means of transporting
33221 messages from MUAs running on personal workstations, there is sometimes a
33222 requirement to accept unqualified addresses from specific hosts or IP networks.
33223
33224 Exim has two options that separately control which hosts may send unqualified
33225 sender or recipient addresses in SMTP commands, namely
33226 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33227 cases, if an unqualified address is accepted, it is qualified by adding the
33228 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33229
33230 .oindex "&%qualify_domain%&"
33231 .oindex "&%qualify_recipient%&"
33232 Unqualified addresses in header lines are automatically qualified for messages
33233 that are locally originated, unless the &%-bnq%& option is given on the command
33234 line. For messages received over SMTP, unqualified addresses in header lines
33235 are qualified only if unqualified addresses are permitted in SMTP commands. In
33236 other words, such qualification is also controlled by
33237 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33238
33239
33240
33241
33242 .section "The UUCP From line" "SECID219"
33243 .cindex "&""From""& line"
33244 .cindex "UUCP" "&""From""& line"
33245 .cindex "sender" "address"
33246 .oindex "&%uucp_from_pattern%&"
33247 .oindex "&%uucp_from_sender%&"
33248 .cindex "envelope sender"
33249 .cindex "Sendmail compatibility" "&""From""& line"
33250 Messages that have come from UUCP (and some other applications) often begin
33251 with a line containing the envelope sender and a timestamp, following the word
33252 &"From"&. Examples of two common formats are:
33253 .code
33254 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33255 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33256 .endd
33257 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33258 Exim recognizes such lines at the start of messages that are submitted to it
33259 via the command line (that is, on the standard input). It does not recognize
33260 such lines in incoming SMTP messages, unless the sending host matches
33261 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33262 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33263 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33264 default value matches the two common cases shown above and puts the address
33265 that follows &"From"& into &$1$&.
33266
33267 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33268 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33269 a trusted user, the message's sender address is constructed by expanding the
33270 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33271 then parsed as an RFC 2822 address. If there is no domain, the local part is
33272 qualified with &%qualify_domain%& unless it is the empty string. However, if
33273 the command line &%-f%& option is used, it overrides the &"From"& line.
33274
33275 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33276 sender address is not changed. This is also the case for incoming SMTP messages
33277 that are permitted to contain &"From"& lines.
33278
33279 Only one &"From"& line is recognized. If there is more than one, the second is
33280 treated as a data line that starts the body of the message, as it is not valid
33281 as a header line. This also happens if a &"From"& line is present in an
33282 incoming SMTP message from a source that is not permitted to send them.
33283
33284
33285
33286 .section "Resent- header lines" "SECID220"
33287 .cindex "&%Resent-%& header lines"
33288 RFC 2822 makes provision for sets of header lines starting with the string
33289 &`Resent-`& to be added to a message when it is resent by the original
33290 recipient to somebody else. These headers are &'Resent-Date:'&,
33291 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33292 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33293
33294 .blockquote
33295 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33296 processing of replies or other such automatic actions on messages.'&
33297 .endblockquote
33298
33299 This leaves things a bit vague as far as other processing actions such as
33300 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33301 follows:
33302
33303 .ilist
33304 A &'Resent-From:'& line that just contains the login id of the submitting user
33305 is automatically rewritten in the same way as &'From:'& (see below).
33306 .next
33307 If there's a rewriting rule for a particular header line, it is also applied to
33308 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33309 &'From:'& also rewrites &'Resent-From:'&.
33310 .next
33311 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33312 also removed.
33313 .next
33314 For a locally-submitted message,
33315 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33316 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33317 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33318 included in log lines in this case.
33319 .next
33320 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33321 &%Resent-%& header lines are present.
33322 .endlist
33323
33324
33325
33326
33327 .section "The Auto-Submitted: header line" "SECID221"
33328 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33329 includes the header line:
33330 .code
33331 Auto-Submitted: auto-replied
33332 .endd
33333
33334 .section "The Bcc: header line" "SECID222"
33335 .cindex "&'Bcc:'& header line"
33336 If Exim is called with the &%-t%& option, to take recipient addresses from a
33337 message's header, it removes any &'Bcc:'& header line that may exist (after
33338 extracting its addresses). If &%-t%& is not present on the command line, any
33339 existing &'Bcc:'& is not removed.
33340
33341
33342 .section "The Date: header line" "SECID223"
33343 .cindex "&'Date:'& header line"
33344 If a locally-generated or submission-mode message has no &'Date:'& header line,
33345 Exim adds one, using the current date and time, unless the
33346 &%suppress_local_fixups%& control has been specified.
33347
33348 .section "The Delivery-date: header line" "SECID224"
33349 .cindex "&'Delivery-date:'& header line"
33350 .oindex "&%delivery_date_remove%&"
33351 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33352 set. Exim can be configured to add them to the final delivery of messages. (See
33353 the generic &%delivery_date_add%& transport option.) They should not be present
33354 in messages in transit. If the &%delivery_date_remove%& configuration option is
33355 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33356 messages.
33357
33358
33359 .section "The Envelope-to: header line" "SECID225"
33360 .cindex "&'Envelope-to:'& header line"
33361 .oindex "&%envelope_to_remove%&"
33362 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33363 Exim can be configured to add them to the final delivery of messages. (See the
33364 generic &%envelope_to_add%& transport option.) They should not be present in
33365 messages in transit. If the &%envelope_to_remove%& configuration option is set
33366 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33367 messages.
33368
33369
33370 .section "The From: header line" "SECTthefrohea"
33371 .cindex "&'From:'& header line"
33372 .cindex "Sendmail compatibility" "&""From""& line"
33373 .cindex "message" "submission"
33374 .cindex "submission mode"
33375 If a submission-mode message does not contain a &'From:'& header line, Exim
33376 adds one if either of the following conditions is true:
33377
33378 .ilist
33379 The envelope sender address is not empty (that is, this is not a bounce
33380 message). The added header line copies the envelope sender address.
33381 .next
33382 .vindex "&$authenticated_id$&"
33383 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33384 .olist
33385 .vindex "&$qualify_domain$&"
33386 If no domain is specified by the submission control, the local part is
33387 &$authenticated_id$& and the domain is &$qualify_domain$&.
33388 .next
33389 If a non-empty domain is specified by the submission control, the local
33390 part is &$authenticated_id$&, and the domain is the specified domain.
33391 .next
33392 If an empty domain is specified by the submission control,
33393 &$authenticated_id$& is assumed to be the complete address.
33394 .endlist
33395 .endlist
33396
33397 A non-empty envelope sender takes precedence.
33398
33399 If a locally-generated incoming message does not contain a &'From:'& header
33400 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33401 containing the sender's address. The calling user's login name and full name
33402 are used to construct the address, as described in section &<<SECTconstr>>&.
33403 They are obtained from the password data by calling &[getpwuid()]& (but see the
33404 &%unknown_login%& configuration option). The address is qualified with
33405 &%qualify_domain%&.
33406
33407 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33408 &'From:'& header line containing just the unqualified login name of the calling
33409 user, this is replaced by an address containing the user's login name and full
33410 name as described in section &<<SECTconstr>>&.
33411
33412
33413 .section "The Message-ID: header line" "SECID226"
33414 .cindex "&'Message-ID:'& header line"
33415 .cindex "message" "submission"
33416 .oindex "&%message_id_header_text%&"
33417 If a locally-generated or submission-mode incoming message does not contain a
33418 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33419 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33420 to the message. If there are any &'Resent-:'& headers in the message, it
33421 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33422 message id, preceded by the letter E to ensure it starts with a letter, and
33423 followed by @ and the primary host name. Additional information can be included
33424 in this header line by setting the &%message_id_header_text%& and/or
33425 &%message_id_header_domain%& options.
33426
33427
33428 .section "The Received: header line" "SECID227"
33429 .cindex "&'Received:'& header line"
33430 A &'Received:'& header line is added at the start of every message. The
33431 contents are defined by the &%received_header_text%& configuration option, and
33432 Exim automatically adds a semicolon and a timestamp to the configured string.
33433
33434 The &'Received:'& header is generated as soon as the message's header lines
33435 have been received. At this stage, the timestamp in the &'Received:'& header
33436 line is the time that the message started to be received. This is the value
33437 that is seen by the DATA ACL and by the &[local_scan()]& function.
33438
33439 Once a message is accepted, the timestamp in the &'Received:'& header line is
33440 changed to the time of acceptance, which is (apart from a small delay while the
33441 -H spool file is written) the earliest time at which delivery could start.
33442
33443
33444 .section "The References: header line" "SECID228"
33445 .cindex "&'References:'& header line"
33446 Messages created by the &(autoreply)& transport include a &'References:'&
33447 header line. This is constructed according to the rules that are described in
33448 section 3.64 of RFC 2822 (which states that replies should contain such a
33449 header line), and section 3.14 of RFC 3834 (which states that automatic
33450 responses are not different in this respect). However, because some mail
33451 processing software does not cope well with very long header lines, no more
33452 than 12 message IDs are copied from the &'References:'& header line in the
33453 incoming message. If there are more than 12, the first one and then the final
33454 11 are copied, before adding the message ID of the incoming message.
33455
33456
33457
33458 .section "The Return-path: header line" "SECID229"
33459 .cindex "&'Return-path:'& header line"
33460 .oindex "&%return_path_remove%&"
33461 &'Return-path:'& header lines are defined as something an MTA may insert when
33462 it does the final delivery of messages. (See the generic &%return_path_add%&
33463 transport option.) Therefore, they should not be present in messages in
33464 transit. If the &%return_path_remove%& configuration option is set (the
33465 default), Exim removes &'Return-path:'& header lines from incoming messages.
33466
33467
33468
33469 .section "The Sender: header line" "SECTthesenhea"
33470 .cindex "&'Sender:'& header line"
33471 .cindex "message" "submission"
33472 For a locally-originated message from an untrusted user, Exim may remove an
33473 existing &'Sender:'& header line, and it may add a new one. You can modify
33474 these actions by setting the &%local_sender_retain%& option true, the
33475 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33476 control setting.
33477
33478 When a local message is received from an untrusted user and
33479 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33480 control has not been set, a check is made to see if the address given in the
33481 &'From:'& header line is the correct (local) sender of the message. The address
33482 that is expected has the login name as the local part and the value of
33483 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33484 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33485 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33486 line is added to the message.
33487
33488 If you set &%local_from_check%& false, this checking does not occur. However,
33489 the removal of an existing &'Sender:'& line still happens, unless you also set
33490 &%local_sender_retain%& to be true. It is not possible to set both of these
33491 options true at the same time.
33492
33493 .cindex "submission mode"
33494 By default, no processing of &'Sender:'& header lines is done for messages
33495 received over TCP/IP or for messages submitted by trusted users. However, when
33496 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33497 not specified on the submission control, the following processing takes place:
33498
33499 .vindex "&$authenticated_id$&"
33500 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33501 authenticated, and &$authenticated_id$& is not empty, a sender address is
33502 created as follows:
33503
33504 .ilist
33505 .vindex "&$qualify_domain$&"
33506 If no domain is specified by the submission control, the local part is
33507 &$authenticated_id$& and the domain is &$qualify_domain$&.
33508 .next
33509 If a non-empty domain is specified by the submission control, the local part
33510 is &$authenticated_id$&, and the domain is the specified domain.
33511 .next
33512 If an empty domain is specified by the submission control,
33513 &$authenticated_id$& is assumed to be the complete address.
33514 .endlist
33515
33516 This address is compared with the address in the &'From:'& header line. If they
33517 are different, a &'Sender:'& header line containing the created address is
33518 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33519 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33520
33521 .cindex "return path" "created from &'Sender:'&"
33522 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33523 the message (the envelope sender address) is changed to be the same address,
33524 except in the case of submission mode when &%sender_retain%& is specified.
33525
33526
33527
33528 .section "Adding and removing header lines in routers and transports" &&&
33529          "SECTheadersaddrem"
33530 .cindex "header lines" "adding; in router or transport"
33531 .cindex "header lines" "removing; in router or transport"
33532 When a message is delivered, the addition and removal of header lines can be
33533 specified in a system filter, or on any of the routers and transports that
33534 process the message. Section &<<SECTaddremheasys>>& contains details about
33535 modifying headers in a system filter. Header lines can also be added in an ACL
33536 as a message is received (see section &<<SECTaddheadacl>>&).
33537
33538 In contrast to what happens in a system filter, header modifications that are
33539 specified on routers and transports apply only to the particular recipient
33540 addresses that are being processed by those routers and transports. These
33541 changes do not actually take place until a copy of the message is being
33542 transported. Therefore, they do not affect the basic set of header lines, and
33543 they do not affect the values of the variables that refer to header lines.
33544
33545 &*Note*&: In particular, this means that any expansions in the configuration of
33546 the transport cannot refer to the modified header lines, because such
33547 expansions all occur before the message is actually transported.
33548
33549 For both routers and transports, the argument of a &%headers_add%&
33550 option must be in the form of one or more RFC 2822 header lines, separated by
33551 newlines (coded as &"\n"&). For example:
33552 .code
33553 headers_add = X-added-header: added by $primary_hostname\n\
33554               X-added-second: another added header line
33555 .endd
33556 Exim does not check the syntax of these added header lines.
33557
33558 Multiple &%headers_add%& options for a single router or transport can be
33559 specified; the values will append to a single list of header lines.
33560 Each header-line is separately expanded.
33561
33562 The argument of a &%headers_remove%& option must consist of a colon-separated
33563 list of header names. This is confusing, because header names themselves are
33564 often terminated by colons. In this case, the colons are the list separators,
33565 not part of the names. For example:
33566 .code
33567 headers_remove = return-receipt-to:acknowledge-to
33568 .endd
33569
33570 Multiple &%headers_remove%& options for a single router or transport can be
33571 specified; the arguments will append to a single header-names list.
33572 Each item is separately expanded.
33573 Note that colons in complex expansions which are used to
33574 form all or part of a &%headers_remove%& list
33575 will act as list separators.
33576
33577 When &%headers_add%& or &%headers_remove%& is specified on a router,
33578 items are expanded at routing time,
33579 and then associated with all addresses that are
33580 accepted by that router, and also with any new addresses that it generates. If
33581 an address passes through several routers as a result of aliasing or
33582 forwarding, the changes are cumulative.
33583
33584 .oindex "&%unseen%&"
33585 However, this does not apply to multiple routers that result from the use of
33586 the &%unseen%& option. Any header modifications that were specified by the
33587 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33588
33589 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33590 settings cannot be delivered together in a batch, so a transport is always
33591 dealing with a set of addresses that have the same header-processing
33592 requirements.
33593
33594 The transport starts by writing the original set of header lines that arrived
33595 with the message, possibly modified by the system filter. As it writes out
33596 these lines, it consults the list of header names that were attached to the
33597 recipient address(es) by &%headers_remove%& options in routers, and it also
33598 consults the transport's own &%headers_remove%& option. Header lines whose
33599 names are on either of these lists are not written out. If there are multiple
33600 instances of any listed header, they are all skipped.
33601
33602 After the remaining original header lines have been written, new header
33603 lines that were specified by routers' &%headers_add%& options are written, in
33604 the order in which they were attached to the address. These are followed by any
33605 header lines specified by the transport's &%headers_add%& option.
33606
33607 This way of handling header line modifications in routers and transports has
33608 the following consequences:
33609
33610 .ilist
33611 The original set of header lines, possibly modified by the system filter,
33612 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33613 to it, at all times.
33614 .next
33615 Header lines that are added by a router's
33616 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33617 expansion syntax in subsequent routers or the transport.
33618 .next
33619 Conversely, header lines that are specified for removal by &%headers_remove%&
33620 in a router remain visible to subsequent routers and the transport.
33621 .next
33622 Headers added to an address by &%headers_add%& in a router cannot be removed by
33623 a later router or by a transport.
33624 .next
33625 An added header can refer to the contents of an original header that is to be
33626 removed, even it has the same name as the added header. For example:
33627 .code
33628 headers_remove = subject
33629 headers_add = Subject: new subject (was: $h_subject:)
33630 .endd
33631 .endlist
33632
33633 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33634 for a &(redirect)& router that has the &%one_time%& option set.
33635
33636
33637
33638
33639
33640 .section "Constructed addresses" "SECTconstr"
33641 .cindex "address" "constructed"
33642 .cindex "constructed address"
33643 When Exim constructs a sender address for a locally-generated message, it uses
33644 the form
33645 .display
33646 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33647 .endd
33648 For example:
33649 .code
33650 Zaphod Beeblebrox <zaphod@end.univ.example>
33651 .endd
33652 The user name is obtained from the &%-F%& command line option if set, or
33653 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33654 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33655 ampersand character, this is replaced by the login name with the first letter
33656 upper cased, as is conventional in a number of operating systems. See the
33657 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33658 The &%unknown_username%& option can be used to specify user names in cases when
33659 there is no password file entry.
33660
33661 .cindex "RFC 2047"
33662 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33663 parts of it if necessary. In addition, if it contains any non-printing
33664 characters, it is encoded as described in RFC 2047, which defines a way of
33665 including non-ASCII characters in header lines. The value of the
33666 &%headers_charset%& option specifies the name of the encoding that is used (the
33667 characters are assumed to be in this encoding). The setting of
33668 &%print_topbitchars%& controls whether characters with the top bit set (that
33669 is, with codes greater than 127) count as printing characters or not.
33670
33671
33672
33673 .section "Case of local parts" "SECID230"
33674 .cindex "case of local parts"
33675 .cindex "local part" "case of"
33676 RFC 2822 states that the case of letters in the local parts of addresses cannot
33677 be assumed to be non-significant. Exim preserves the case of local parts of
33678 addresses, but by default it uses a lower-cased form when it is routing,
33679 because on most Unix systems, usernames are in lower case and case-insensitive
33680 routing is required. However, any particular router can be made to use the
33681 original case for local parts by setting the &%caseful_local_part%& generic
33682 router option.
33683
33684 .cindex "mixed-case login names"
33685 If you must have mixed-case user names on your system, the best way to proceed,
33686 assuming you want case-independent handling of incoming email, is to set up
33687 your first router to convert incoming local parts in your domains to the
33688 correct case by means of a file lookup. For example:
33689 .code
33690 correct_case:
33691   driver = redirect
33692   domains = +local_domains
33693   data = ${lookup{$local_part}cdb\
33694               {/etc/usercased.cdb}{$value}fail}\
33695               @$domain
33696 .endd
33697 For this router, the local part is forced to lower case by the default action
33698 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33699 up a new local part in the correct case. If you then set &%caseful_local_part%&
33700 on any subsequent routers which process your domains, they will operate on
33701 local parts with the correct case in a case-sensitive manner.
33702
33703
33704
33705 .section "Dots in local parts" "SECID231"
33706 .cindex "dot" "in local part"
33707 .cindex "local part" "dots in"
33708 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33709 part may not begin or end with a dot, nor have two consecutive dots in the
33710 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33711 empty components for compatibility.
33712
33713
33714
33715 .section "Rewriting addresses" "SECID232"
33716 .cindex "rewriting" "addresses"
33717 Rewriting of sender and recipient addresses, and addresses in headers, can
33718 happen automatically, or as the result of configuration options, as described
33719 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33720 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33721
33722 Automatic rewriting includes qualification, as mentioned above. The other case
33723 in which it can happen is when an incomplete non-local domain is given. The
33724 routing process may cause this to be expanded into the full domain name. For
33725 example, a header such as
33726 .code
33727 To: hare@teaparty
33728 .endd
33729 might get rewritten as
33730 .code
33731 To: hare@teaparty.wonderland.fict.example
33732 .endd
33733 Rewriting as a result of routing is the one kind of message processing that
33734 does not happen at input time, as it cannot be done until the address has
33735 been routed.
33736
33737 Strictly, one should not do &'any'& deliveries of a message until all its
33738 addresses have been routed, in case any of the headers get changed as a
33739 result of routing. However, doing this in practice would hold up many
33740 deliveries for unreasonable amounts of time, just because one address could not
33741 immediately be routed. Exim therefore does not delay other deliveries when
33742 routing of one or more addresses is deferred.
33743 .ecindex IIDmesproc
33744
33745
33746
33747 . ////////////////////////////////////////////////////////////////////////////
33748 . ////////////////////////////////////////////////////////////////////////////
33749
33750 .chapter "SMTP processing" "CHAPSMTP"
33751 .scindex IIDsmtpproc1 "SMTP" "processing details"
33752 .scindex IIDsmtpproc2 "LMTP" "processing details"
33753 Exim supports a number of different ways of using the SMTP protocol, and its
33754 LMTP variant, which is an interactive protocol for transferring messages into a
33755 closed mail store application. This chapter contains details of how SMTP is
33756 processed. For incoming mail, the following are available:
33757
33758 .ilist
33759 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33760 .next
33761 SMTP over the standard input and output (the &%-bs%& option);
33762 .next
33763 Batched SMTP on the standard input (the &%-bS%& option).
33764 .endlist
33765
33766 For mail delivery, the following are available:
33767
33768 .ilist
33769 SMTP over TCP/IP (the &(smtp)& transport);
33770 .next
33771 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33772 &"lmtp"&);
33773 .next
33774 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33775 transport);
33776 .next
33777 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33778 the &%use_bsmtp%& option set).
33779 .endlist
33780
33781 &'Batched SMTP'& is the name for a process in which batches of messages are
33782 stored in or read from files (or pipes), in a format in which SMTP commands are
33783 used to contain the envelope information.
33784
33785
33786
33787 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33788 .cindex "SMTP" "outgoing over TCP/IP"
33789 .cindex "outgoing SMTP over TCP/IP"
33790 .cindex "LMTP" "over TCP/IP"
33791 .cindex "outgoing LMTP over TCP/IP"
33792 .cindex "EHLO"
33793 .cindex "HELO"
33794 .cindex "SIZE option on MAIL command"
33795 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33796 The &%protocol%& option selects which protocol is to be used, but the actual
33797 processing is the same in both cases.
33798
33799 If, in response to its EHLO command, Exim is told that the SIZE
33800 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33801 command. The value of <&'n'&> is the message size plus the value of the
33802 &%size_addition%& option (default 1024) to allow for additions to the message
33803 such as per-transport header lines, or changes made in a
33804 .cindex "transport" "filter"
33805 .cindex "filter" "transport filter"
33806 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33807 suppressed.
33808
33809 If the remote server advertises support for PIPELINING, Exim uses the
33810 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33811 required for the transaction.
33812
33813 If the remote server advertises support for the STARTTLS command, and Exim
33814 was built to support TLS encryption, it tries to start a TLS session unless the
33815 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33816 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33817 is called for verification.
33818
33819 If the remote server advertises support for the AUTH command, Exim scans
33820 the authenticators configuration for any suitable client settings, as described
33821 in chapter &<<CHAPSMTPAUTH>>&.
33822
33823 .cindex "carriage return"
33824 .cindex "linefeed"
33825 Responses from the remote host are supposed to be terminated by CR followed by
33826 LF. However, there are known to be hosts that do not send CR characters, so in
33827 order to be able to interwork with such hosts, Exim treats LF on its own as a
33828 line terminator.
33829
33830 If a message contains a number of different addresses, all those with the same
33831 characteristics (for example, the same envelope sender) that resolve to the
33832 same set of hosts, in the same order, are sent in a single SMTP transaction,
33833 even if they are for different domains, unless there are more than the setting
33834 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33835 they are split into groups containing no more than &%max_rcpt%&s addresses
33836 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33837 in parallel sessions. The order of hosts with identical MX values is not
33838 significant when checking whether addresses can be batched in this way.
33839
33840 When the &(smtp)& transport suffers a temporary failure that is not
33841 message-related, Exim updates its transport-specific database, which contains
33842 records indexed by host name that remember which messages are waiting for each
33843 particular host. It also updates the retry database with new retry times.
33844
33845 .cindex "hints database" "retry keys"
33846 Exim's retry hints are based on host name plus IP address, so if one address of
33847 a multi-homed host is broken, it will soon be skipped most of the time.
33848 See the next section for more detail about error handling.
33849
33850 .cindex "SMTP" "passed connection"
33851 .cindex "SMTP" "batching over TCP/IP"
33852 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33853 looks in the hints database for the transport to see if there are any queued
33854 messages waiting for the host to which it is connected. If it finds one, it
33855 creates a new Exim process using the &%-MC%& option (which can only be used by
33856 a process running as root or the Exim user) and passes the TCP/IP socket to it
33857 so that it can deliver another message using the same socket. The new process
33858 does only those deliveries that are routed to the connected host, and may in
33859 turn pass the socket on to a third process, and so on.
33860
33861 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33862 limit the number of messages sent down a single TCP/IP connection.
33863
33864 .cindex "asterisk" "after IP address"
33865 The second and subsequent messages delivered down an existing connection are
33866 identified in the main log by the addition of an asterisk after the closing
33867 square bracket of the IP address.
33868
33869
33870
33871
33872 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33873 .cindex "error" "in outgoing SMTP"
33874 .cindex "SMTP" "errors in outgoing"
33875 .cindex "host" "error"
33876 Three different kinds of error are recognized for outgoing SMTP: host errors,
33877 message errors, and recipient errors.
33878
33879 .vlist
33880 .vitem "&*Host errors*&"
33881 A host error is not associated with a particular message or with a
33882 particular recipient of a message. The host errors are:
33883
33884 .ilist
33885 Connection refused or timed out,
33886 .next
33887 Any error response code on connection,
33888 .next
33889 Any error response code to EHLO or HELO,
33890 .next
33891 Loss of connection at any time, except after &"."&,
33892 .next
33893 I/O errors at any time,
33894 .next
33895 Timeouts during the session, other than in response to MAIL, RCPT or
33896 the &"."& at the end of the data.
33897 .endlist ilist
33898
33899 For a host error, a permanent error response on connection, or in response to
33900 EHLO, causes all addresses routed to the host to be failed. Any other host
33901 error causes all addresses to be deferred, and retry data to be created for the
33902 host. It is not tried again, for any message, until its retry time arrives. If
33903 the current set of addresses are not all delivered in this run (to some
33904 alternative host), the message is added to the list of those waiting for this
33905 host, so if it is still undelivered when a subsequent successful delivery is
33906 made to the host, it will be sent down the same SMTP connection.
33907
33908 .vitem "&*Message errors*&"
33909 .cindex "message" "error"
33910 A message error is associated with a particular message when sent to a
33911 particular host, but not with a particular recipient of the message. The
33912 message errors are:
33913
33914 .ilist
33915 Any error response code to MAIL, DATA, or the &"."& that terminates
33916 the data,
33917 .next
33918 Timeout after MAIL,
33919 .next
33920 Timeout or loss of connection after the &"."& that terminates the data. A
33921 timeout after the DATA command itself is treated as a host error, as is loss of
33922 connection at any other time.
33923 .endlist ilist
33924
33925 For a message error, a permanent error response (5&'xx'&) causes all addresses
33926 to be failed, and a delivery error report to be returned to the sender. A
33927 temporary error response (4&'xx'&), or one of the timeouts, causes all
33928 addresses to be deferred. Retry data is not created for the host, but instead,
33929 a retry record for the combination of host plus message id is created. The
33930 message is not added to the list of those waiting for this host. This ensures
33931 that the failing message will not be sent to this host again until the retry
33932 time arrives. However, other messages that are routed to the host are not
33933 affected, so if it is some property of the message that is causing the error,
33934 it will not stop the delivery of other mail.
33935
33936 If the remote host specified support for the SIZE parameter in its response
33937 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33938 over-large message will cause a message error because the error arrives as a
33939 response to MAIL.
33940
33941 .vitem "&*Recipient errors*&"
33942 .cindex "recipient" "error"
33943 A recipient error is associated with a particular recipient of a message. The
33944 recipient errors are:
33945
33946 .ilist
33947 Any error response to RCPT,
33948 .next
33949 Timeout after RCPT.
33950 .endlist
33951
33952 For a recipient error, a permanent error response (5&'xx'&) causes the
33953 recipient address to be failed, and a bounce message to be returned to the
33954 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33955 address to be deferred, and routing retry data to be created for it. This is
33956 used to delay processing of the address in subsequent queue runs, until its
33957 routing retry time arrives. This applies to all messages, but because it
33958 operates only in queue runs, one attempt will be made to deliver a new message
33959 to the failing address before the delay starts to operate. This ensures that,
33960 if the failure is really related to the message rather than the recipient
33961 (&"message too big for this recipient"& is a possible example), other messages
33962 have a chance of getting delivered. If a delivery to the address does succeed,
33963 the retry information gets cleared, so all stuck messages get tried again, and
33964 the retry clock is reset.
33965
33966 The message is not added to the list of those waiting for this host. Use of the
33967 host for other messages is unaffected, and except in the case of a timeout,
33968 other recipients are processed independently, and may be successfully delivered
33969 in the current SMTP session. After a timeout it is of course impossible to
33970 proceed with the session, so all addresses get deferred. However, those other
33971 than the one that failed do not suffer any subsequent retry delays. Therefore,
33972 if one recipient is causing trouble, the others have a chance of getting
33973 through when a subsequent delivery attempt occurs before the failing
33974 recipient's retry time.
33975 .endlist
33976
33977 In all cases, if there are other hosts (or IP addresses) available for the
33978 current set of addresses (for example, from multiple MX records), they are
33979 tried in this run for any undelivered addresses, subject of course to their
33980 own retry data. In other words, recipient error retry data does not take effect
33981 until the next delivery attempt.
33982
33983 Some hosts have been observed to give temporary error responses to every
33984 MAIL command at certain times (&"insufficient space"& has been seen). It
33985 would be nice if such circumstances could be recognized, and defer data for the
33986 host itself created, but this is not possible within the current Exim design.
33987 What actually happens is that retry data for every (host, message) combination
33988 is created.
33989
33990 The reason that timeouts after MAIL and RCPT are treated specially is that
33991 these can sometimes arise as a result of the remote host's verification
33992 procedures. Exim makes this assumption, and treats them as if a temporary error
33993 response had been received. A timeout after &"."& is treated specially because
33994 it is known that some broken implementations fail to recognize the end of the
33995 message if the last character of the last line is a binary zero. Thus, it is
33996 helpful to treat this case as a message error.
33997
33998 Timeouts at other times are treated as host errors, assuming a problem with the
33999 host, or the connection to it. If a timeout after MAIL, RCPT,
34000 or &"."& is really a connection problem, the assumption is that at the next try
34001 the timeout is likely to occur at some other point in the dialogue, causing it
34002 then to be treated as a host error.
34003
34004 There is experimental evidence that some MTAs drop the connection after the
34005 terminating &"."& if they do not like the contents of the message for some
34006 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34007 should be given. That is why Exim treats this case as a message rather than a
34008 host error, in order not to delay other messages to the same host.
34009
34010
34011
34012
34013 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34014 .cindex "SMTP" "incoming over TCP/IP"
34015 .cindex "incoming SMTP over TCP/IP"
34016 .cindex "inetd"
34017 .cindex "daemon"
34018 Incoming SMTP messages can be accepted in one of two ways: by running a
34019 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34020 &_/etc/inetd.conf_& should be like this:
34021 .code
34022 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34023 .endd
34024 Exim distinguishes between this case and the case of a locally running user
34025 agent using the &%-bs%& option by checking whether or not the standard input is
34026 a socket. When it is, either the port must be privileged (less than 1024), or
34027 the caller must be root or the Exim user. If any other user passes a socket
34028 with an unprivileged port number, Exim prints a message on the standard error
34029 stream and exits with an error code.
34030
34031 By default, Exim does not make a log entry when a remote host connects or
34032 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34033 unexpected. It can be made to write such log entries by setting the
34034 &%smtp_connection%& log selector.
34035
34036 .cindex "carriage return"
34037 .cindex "linefeed"
34038 Commands from the remote host are supposed to be terminated by CR followed by
34039 LF. However, there are known to be hosts that do not send CR characters. In
34040 order to be able to interwork with such hosts, Exim treats LF on its own as a
34041 line terminator.
34042 Furthermore, because common code is used for receiving messages from all
34043 sources, a CR on its own is also interpreted as a line terminator. However, the
34044 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34045
34046 .cindex "EHLO" "invalid data"
34047 .cindex "HELO" "invalid data"
34048 One area that sometimes gives rise to problems concerns the EHLO or
34049 HELO commands. Some clients send syntactically invalid versions of these
34050 commands, which Exim rejects by default. (This is nothing to do with verifying
34051 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34052 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34053 match the broken hosts that send invalid commands.
34054
34055 .cindex "SIZE option on MAIL command"
34056 .cindex "MAIL" "SIZE option"
34057 The amount of disk space available is checked whenever SIZE is received on
34058 a MAIL command, independently of whether &%message_size_limit%& or
34059 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34060 false. A temporary error is given if there is not enough space. If
34061 &%check_spool_space%& is set, the check is for that amount of space plus the
34062 value given with SIZE, that is, it checks that the addition of the incoming
34063 message will not reduce the space below the threshold.
34064
34065 When a message is successfully received, Exim includes the local message id in
34066 its response to the final &"."& that terminates the data. If the remote host
34067 logs this text it can help with tracing what has happened to a message.
34068
34069 The Exim daemon can limit the number of simultaneous incoming connections it is
34070 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34071 number of simultaneous incoming connections from a single remote host (see the
34072 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34073 rejected using the SMTP temporary error code 421.
34074
34075 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34076 subprocess has finished, as this can get lost at busy times. Instead, it looks
34077 for completed subprocesses every time it wakes up. Provided there are other
34078 things happening (new incoming calls, starts of queue runs), completed
34079 processes will be noticed and tidied away. On very quiet systems you may
34080 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34081 it will be noticed when the daemon next wakes up.
34082
34083 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34084 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34085 high system load &-- for details see the &%smtp_accept_reserve%&,
34086 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34087 applies in both the daemon and &'inetd'& cases.
34088
34089 Exim normally starts a delivery process for each message received, though this
34090 can be varied by means of the &%-odq%& command line option and the
34091 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34092 number of simultaneously running delivery processes started in this way from
34093 SMTP input can be limited by the &%smtp_accept_queue%& and
34094 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34095 subsequently received messages are just put on the input queue without starting
34096 a delivery process.
34097
34098 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34099 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34100 started up from the &'inetd'& daemon, because in that case each connection is
34101 handled by an entirely independent Exim process. Control by load average is,
34102 however, available with &'inetd'&.
34103
34104 Exim can be configured to verify addresses in incoming SMTP commands as they
34105 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34106 to rewrite addresses at this time &-- before any syntax checking is done. See
34107 section &<<SECTrewriteS>>&.
34108
34109 Exim can also be configured to limit the rate at which a client host submits
34110 MAIL and RCPT commands in a single SMTP session. See the
34111 &%smtp_ratelimit_hosts%& option.
34112
34113
34114
34115 .section "Unrecognized SMTP commands" "SECID234"
34116 .cindex "SMTP" "unrecognized commands"
34117 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34118 commands during a single SMTP connection, it drops the connection after sending
34119 the error response to the last command. The default value for
34120 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34121 abuse that subvert web servers into making connections to SMTP ports; in these
34122 circumstances, a number of non-SMTP lines are sent first.
34123
34124
34125 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34126 .cindex "SMTP" "syntax errors"
34127 .cindex "SMTP" "protocol errors"
34128 A syntax error is detected if an SMTP command is recognized, but there is
34129 something syntactically wrong with its data, for example, a malformed email
34130 address in a RCPT command. Protocol errors include invalid command
34131 sequencing such as RCPT before MAIL. If Exim receives more than
34132 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34133 drops the connection after sending the error response to the last command. The
34134 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34135 broken clients that loop sending bad commands (yes, it has been seen).
34136
34137
34138
34139 .section "Use of non-mail SMTP commands" "SECID236"
34140 .cindex "SMTP" "non-mail commands"
34141 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34142 DATA. Exim counts such commands, and drops the connection if there are too
34143 many of them in a single SMTP session. This action catches some
34144 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34145 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34146 defines what &"too many"& means. Its default value is 10.
34147
34148 When a new message is expected, one occurrence of RSET is not counted. This
34149 allows a client to send one RSET between messages (this is not necessary,
34150 but some clients do it). Exim also allows one uncounted occurrence of HELO
34151 or EHLO, and one occurrence of STARTTLS between messages. After
34152 starting up a TLS session, another EHLO is expected, and so it too is not
34153 counted.
34154
34155 The first occurrence of AUTH in a connection, or immediately following
34156 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34157 RCPT, DATA, and QUIT are counted.
34158
34159 You can control which hosts are subject to the limit set by
34160 &%smtp_accept_max_nonmail%& by setting
34161 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34162 the limit apply to all hosts. This option means that you can exclude any
34163 specific badly-behaved hosts that you have to live with.
34164
34165
34166
34167
34168 .section "The VRFY and EXPN commands" "SECID237"
34169 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34170 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34171 appropriate) in order to decide whether the command should be accepted or not.
34172
34173 .new
34174 .cindex "VRFY" "processing"
34175 When no ACL is defined for VRFY, or if it rejects without
34176 setting an explicit response code, the command is accepted
34177 (with a 252 SMTP response code)
34178 in order to support awkward clients that do a VRFY before every RCPT.
34179 .wen
34180 When VRFY is accepted, it runs exactly the same code as when Exim is
34181 called with the &%-bv%& option, and returns 250/451/550
34182 SMTP response codes.
34183
34184 .cindex "EXPN" "processing"
34185 If no ACL for EXPN is defined, the command is rejected.
34186 When EXPN is accepted, a single-level expansion of the address is done.
34187 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34188 than a verification (the &%-bv%& option). If an unqualified local part is given
34189 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34190 of VRFY and EXPN commands are logged on the main and reject logs, and
34191 VRFY verification failures are logged on the main log for consistency with
34192 RCPT failures.
34193
34194
34195
34196 .section "The ETRN command" "SECTETRN"
34197 .cindex "ETRN" "processing"
34198 RFC 1985 describes an SMTP command called ETRN that is designed to
34199 overcome the security problems of the TURN command (which has fallen into
34200 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34201 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34202 should be accepted or not. If no ACL is defined, the command is rejected.
34203
34204 The ETRN command is concerned with &"releasing"& messages that are awaiting
34205 delivery to certain hosts. As Exim does not organize its message queue by host,
34206 the only form of ETRN that is supported by default is the one where the
34207 text starts with the &"#"& prefix, in which case the remainder of the text is
34208 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34209 the &%-R%& option to happen, with the remainder of the ETRN text as its
34210 argument. For example,
34211 .code
34212 ETRN #brigadoon
34213 .endd
34214 runs the command
34215 .code
34216 exim -R brigadoon
34217 .endd
34218 which causes a delivery attempt on all messages with undelivered addresses
34219 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34220 default), Exim prevents the simultaneous execution of more than one queue run
34221 for the same argument string as a result of an ETRN command. This stops
34222 a misbehaving client from starting more than one queue runner at once.
34223
34224 .cindex "hints database" "ETRN serialization"
34225 Exim implements the serialization by means of a hints database in which a
34226 record is written whenever a process is started by ETRN, and deleted when
34227 the process completes. However, Exim does not keep the SMTP session waiting for
34228 the ETRN process to complete. Once ETRN is accepted, the client is sent
34229 a &"success"& return code. Obviously there is scope for hints records to get
34230 left lying around if there is a system or program crash. To guard against this,
34231 Exim ignores any records that are more than six hours old.
34232
34233 .oindex "&%smtp_etrn_command%&"
34234 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34235 used. This specifies a command that is run whenever ETRN is received,
34236 whatever the form of its argument. For
34237 example:
34238 .code
34239 smtp_etrn_command = /etc/etrn_command $domain \
34240                     $sender_host_address
34241 .endd
34242 .vindex "&$domain$&"
34243 The string is split up into arguments which are independently expanded. The
34244 expansion variable &$domain$& is set to the argument of the ETRN command,
34245 and no syntax checking is done on the contents of this argument. Exim does not
34246 wait for the command to complete, so its status code is not checked. Exim runs
34247 under its own uid and gid when receiving incoming SMTP, so it is not possible
34248 for it to change them before running the command.
34249
34250
34251
34252 .section "Incoming local SMTP" "SECID238"
34253 .cindex "SMTP" "local incoming"
34254 Some user agents use SMTP to pass messages to their local MTA using the
34255 standard input and output, as opposed to passing the envelope on the command
34256 line and writing the message to the standard input. This is supported by the
34257 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34258 messages over TCP/IP (including the use of ACLs), except that the envelope
34259 sender given in a MAIL command is ignored unless the caller is trusted. In
34260 an ACL you can detect this form of SMTP input by testing for an empty host
34261 identification. It is common to have this as the first line in the ACL that
34262 runs for RCPT commands:
34263 .code
34264 accept hosts = :
34265 .endd
34266 This accepts SMTP messages from local processes without doing any other tests.
34267
34268
34269
34270 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34271 .cindex "SMTP" "batched outgoing"
34272 .cindex "batched SMTP output"
34273 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34274 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34275 be output in BSMTP format. No SMTP responses are possible for this form of
34276 delivery. All it is doing is using SMTP commands as a way of transmitting the
34277 envelope along with the message.
34278
34279 The message is written to the file or pipe preceded by the SMTP commands
34280 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34281 the message that start with a dot have an extra dot added. The SMTP command
34282 HELO is not normally used. If it is required, the &%message_prefix%& option
34283 can be used to specify it.
34284
34285 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34286 one recipient address at a time by default. However, you can arrange for them
34287 to handle several addresses at once by setting the &%batch_max%& option. When
34288 this is done for BSMTP, messages may contain multiple RCPT commands. See
34289 chapter &<<CHAPbatching>>& for more details.
34290
34291 .vindex "&$host$&"
34292 When one or more addresses are routed to a BSMTP transport by a router that
34293 sets up a host list, the name of the first host on the list is available to the
34294 transport in the variable &$host$&. Here is an example of such a transport and
34295 router:
34296 .code
34297 begin routers
34298 route_append:
34299   driver = manualroute
34300   transport = smtp_appendfile
34301   route_list = domain.example  batch.host.example
34302
34303 begin transports
34304 smtp_appendfile:
34305   driver = appendfile
34306   directory = /var/bsmtp/$host
34307   batch_max = 1000
34308   use_bsmtp
34309   user = exim
34310 .endd
34311 This causes messages addressed to &'domain.example'& to be written in BSMTP
34312 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34313 message (unless there are more than 1000 recipients).
34314
34315
34316
34317 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34318 .cindex "SMTP" "batched incoming"
34319 .cindex "batched SMTP input"
34320 The &%-bS%& command line option causes Exim to accept one or more messages by
34321 reading SMTP on the standard input, but to generate no responses. If the caller
34322 is trusted, the senders in the MAIL commands are believed; otherwise the
34323 sender is always the caller of Exim. Unqualified senders and receivers are not
34324 rejected (there seems little point) but instead just get qualified. HELO
34325 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34326 as NOOP; QUIT quits.
34327
34328 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34329 ACL is run in the same way as for non-SMTP local input.
34330
34331 If an error is detected while reading a message, including a missing &"."& at
34332 the end, Exim gives up immediately. It writes details of the error to the
34333 standard output in a stylized way that the calling program should be able to
34334 make some use of automatically, for example:
34335 .code
34336 554 Unexpected end of file
34337 Transaction started in line 10
34338 Error detected in line 14
34339 .endd
34340 It writes a more verbose version, for human consumption, to the standard error
34341 file, for example:
34342 .code
34343 An error was detected while processing a file of BSMTP input.
34344 The error message was:
34345
34346 501 '>' missing at end of address
34347
34348 The SMTP transaction started in line 10.
34349 The error was detected in line 12.
34350 The SMTP command at fault was:
34351
34352 rcpt to:<malformed@in.com.plete
34353
34354 1 previous message was successfully processed.
34355 The rest of the batch was abandoned.
34356 .endd
34357 The return code from Exim is zero only if there were no errors. It is 1 if some
34358 messages were accepted before an error was detected, and 2 if no messages were
34359 accepted.
34360 .ecindex IIDsmtpproc1
34361 .ecindex IIDsmtpproc2
34362
34363
34364
34365 . ////////////////////////////////////////////////////////////////////////////
34366 . ////////////////////////////////////////////////////////////////////////////
34367
34368 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34369          "Customizing messages"
34370 When a message fails to be delivered, or remains on the queue for more than a
34371 configured amount of time, Exim sends a message to the original sender, or
34372 to an alternative configured address. The text of these messages is built into
34373 the code of Exim, but it is possible to change it, either by adding a single
34374 string, or by replacing each of the paragraphs by text supplied in a file.
34375
34376 The &'From:'& and &'To:'& header lines are automatically generated; you can
34377 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34378 option. Exim also adds the line
34379 .code
34380 Auto-Submitted: auto-generated
34381 .endd
34382 to all warning and bounce messages,
34383
34384
34385 .section "Customizing bounce messages" "SECID239"
34386 .cindex "customizing" "bounce message"
34387 .cindex "bounce message" "customizing"
34388 If &%bounce_message_text%& is set, its contents are included in the default
34389 message immediately after &"This message was created automatically by mail
34390 delivery software."& The string is not expanded. It is not used if
34391 &%bounce_message_file%& is set.
34392
34393 When &%bounce_message_file%& is set, it must point to a template file for
34394 constructing error messages. The file consists of a series of text items,
34395 separated by lines consisting of exactly four asterisks. If the file cannot be
34396 opened, default text is used and a message is written to the main and panic
34397 logs. If any text item in the file is empty, default text is used for that
34398 item.
34399
34400 .vindex "&$bounce_recipient$&"
34401 .vindex "&$bounce_return_size_limit$&"
34402 Each item of text that is read from the file is expanded, and there are two
34403 expansion variables which can be of use here: &$bounce_recipient$& is set to
34404 the recipient of an error message while it is being created, and
34405 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34406 option, rounded to a whole number.
34407
34408 The items must appear in the file in the following order:
34409
34410 .ilist
34411 The first item is included in the headers, and should include at least a
34412 &'Subject:'& header. Exim does not check the syntax of these headers.
34413 .next
34414 The second item forms the start of the error message. After it, Exim lists the
34415 failing addresses with their error messages.
34416 .next
34417 The third item is used to introduce any text from pipe transports that is to be
34418 returned to the sender. It is omitted if there is no such text.
34419 .next
34420 The fourth, fifth and sixth items will be ignored and may be empty.
34421 The fields exist for back-compatibility
34422 .endlist
34423
34424 The default state (&%bounce_message_file%& unset) is equivalent to the
34425 following file, in which the sixth item is empty. The &'Subject:'& and some
34426 other lines have been split in order to fit them on the page:
34427 .code
34428 Subject: Mail delivery failed
34429   ${if eq{$sender_address}{$bounce_recipient}
34430   {: returning message to sender}}
34431 ****
34432 This message was created automatically by mail delivery software.
34433
34434 A message ${if eq{$sender_address}{$bounce_recipient}
34435   {that you sent }{sent by
34436
34437 <$sender_address>
34438
34439 }}could not be delivered to all of its recipients.
34440 This is a permanent error. The following address(es) failed:
34441 ****
34442 The following text was generated during the delivery attempt(s):
34443 ****
34444 ------ This is a copy of the message, including all the headers.
34445   ------
34446 ****
34447 ------ The body of the message is $message_size characters long;
34448   only the first
34449 ------ $bounce_return_size_limit or so are included here.
34450 ****
34451 .endd
34452 .section "Customizing warning messages" "SECTcustwarn"
34453 .cindex "customizing" "warning message"
34454 .cindex "warning of delay" "customizing the message"
34455 The option &%warn_message_file%& can be pointed at a template file for use when
34456 warnings about message delays are created. In this case there are only three
34457 text sections:
34458
34459 .ilist
34460 The first item is included in the headers, and should include at least a
34461 &'Subject:'& header. Exim does not check the syntax of these headers.
34462 .next
34463 The second item forms the start of the warning message. After it, Exim lists
34464 the delayed addresses.
34465 .next
34466 The third item then ends the message.
34467 .endlist
34468
34469 The default state is equivalent to the following file, except that some lines
34470 have been split here, in order to fit them on the page:
34471 .code
34472 Subject: Warning: message $message_exim_id delayed
34473   $warn_message_delay
34474 ****
34475 This message was created automatically by mail delivery software.
34476
34477 A message ${if eq{$sender_address}{$warn_message_recipients}
34478 {that you sent }{sent by
34479
34480 <$sender_address>
34481
34482 }}has not been delivered to all of its recipients after
34483 more than $warn_message_delay on the queue on $primary_hostname.
34484
34485 The message identifier is:     $message_exim_id
34486 The subject of the message is: $h_subject
34487 The date of the message is:    $h_date
34488
34489 The following address(es) have not yet been delivered:
34490 ****
34491 No action is required on your part. Delivery attempts will
34492 continue for some time, and this warning may be repeated at
34493 intervals if the message remains undelivered. Eventually the
34494 mail delivery software will give up, and when that happens,
34495 the message will be returned to you.
34496 .endd
34497 .vindex "&$warn_message_delay$&"
34498 .vindex "&$warn_message_recipients$&"
34499 However, in the default state the subject and date lines are omitted if no
34500 appropriate headers exist. During the expansion of this file,
34501 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34502 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34503 of recipients for the warning message. There may be more than one if there are
34504 multiple addresses with different &%errors_to%& settings on the routers that
34505 handled them.
34506
34507
34508
34509
34510 . ////////////////////////////////////////////////////////////////////////////
34511 . ////////////////////////////////////////////////////////////////////////////
34512
34513 .chapter "Some common configuration settings" "CHAPcomconreq"
34514 This chapter discusses some configuration settings that seem to be fairly
34515 common. More examples and discussion can be found in the Exim book.
34516
34517
34518
34519 .section "Sending mail to a smart host" "SECID240"
34520 .cindex "smart host" "example router"
34521 If you want to send all mail for non-local domains to a &"smart host"&, you
34522 should replace the default &(dnslookup)& router with a router which does the
34523 routing explicitly:
34524 .code
34525 send_to_smart_host:
34526   driver = manualroute
34527   route_list = !+local_domains smart.host.name
34528   transport = remote_smtp
34529 .endd
34530 You can use the smart host's IP address instead of the name if you wish.
34531 If you are using Exim only to submit messages to a smart host, and not for
34532 receiving incoming messages, you can arrange for it to do the submission
34533 synchronously by setting the &%mua_wrapper%& option (see chapter
34534 &<<CHAPnonqueueing>>&).
34535
34536
34537
34538
34539 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34540 .cindex "mailing lists"
34541 Exim can be used to run simple mailing lists, but for large and/or complicated
34542 requirements, the use of additional specialized mailing list software such as
34543 Majordomo or Mailman is recommended.
34544
34545 The &(redirect)& router can be used to handle mailing lists where each list
34546 is maintained in a separate file, which can therefore be managed by an
34547 independent manager. The &%domains%& router option can be used to run these
34548 lists in a separate domain from normal mail. For example:
34549 .code
34550 lists:
34551   driver = redirect
34552   domains = lists.example
34553   file = /usr/lists/$local_part
34554   forbid_pipe
34555   forbid_file
34556   errors_to = $local_part-request@lists.example
34557   no_more
34558 .endd
34559 This router is skipped for domains other than &'lists.example'&. For addresses
34560 in that domain, it looks for a file that matches the local part. If there is no
34561 such file, the router declines, but because &%no_more%& is set, no subsequent
34562 routers are tried, and so the whole delivery fails.
34563
34564 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34565 expanded into a file name or a pipe delivery, which is usually inappropriate in
34566 a mailing list.
34567
34568 .oindex "&%errors_to%&"
34569 The &%errors_to%& option specifies that any delivery errors caused by addresses
34570 taken from a mailing list are to be sent to the given address rather than the
34571 original sender of the message. However, before acting on this, Exim verifies
34572 the error address, and ignores it if verification fails.
34573
34574 For example, using the configuration above, mail sent to
34575 &'dicts@lists.example'& is passed on to those addresses contained in
34576 &_/usr/lists/dicts_&, with error reports directed to
34577 &'dicts-request@lists.example'&, provided that this address can be verified.
34578 There could be a file called &_/usr/lists/dicts-request_& containing
34579 the address(es) of this particular list's manager(s), but other approaches,
34580 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34581 or &%local_part_suffix%& options) to handle addresses of the form
34582 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34583
34584
34585
34586 .section "Syntax errors in mailing lists" "SECID241"
34587 .cindex "mailing lists" "syntax errors in"
34588 If an entry in redirection data contains a syntax error, Exim normally defers
34589 delivery of the original address. That means that a syntax error in a mailing
34590 list holds up all deliveries to the list. This may not be appropriate when a
34591 list is being maintained automatically from data supplied by users, and the
34592 addresses are not rigorously checked.
34593
34594 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34595 entries that fail to parse, noting the incident in the log. If in addition
34596 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34597 whenever a broken address is skipped. It is usually appropriate to set
34598 &%syntax_errors_to%& to the same address as &%errors_to%&.
34599
34600
34601
34602 .section "Re-expansion of mailing lists" "SECID242"
34603 .cindex "mailing lists" "re-expansion of"
34604 Exim remembers every individual address to which a message has been delivered,
34605 in order to avoid duplication, but it normally stores only the original
34606 recipient addresses with a message. If all the deliveries to a mailing list
34607 cannot be done at the first attempt, the mailing list is re-expanded when the
34608 delivery is next tried. This means that alterations to the list are taken into
34609 account at each delivery attempt, so addresses that have been added to
34610 the list since the message arrived will therefore receive a copy of the
34611 message, even though it pre-dates their subscription.
34612
34613 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34614 on the &(redirect)& router. If this is done, any addresses generated by the
34615 router that fail to deliver at the first attempt are added to the message as
34616 &"top level"& addresses, and the parent address that generated them is marked
34617 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34618 subsequent delivery attempts. The disadvantage of this is that if any of the
34619 failing addresses are incorrect, correcting them in the file has no effect on
34620 pre-existing messages.
34621
34622 The original top-level address is remembered with each of the generated
34623 addresses, and is output in any log messages. However, any intermediate parent
34624 addresses are not recorded. This makes a difference to the log only if the
34625 &%all_parents%& selector is set, but for mailing lists there is normally only
34626 one level of expansion anyway.
34627
34628
34629
34630 .section "Closed mailing lists" "SECID243"
34631 .cindex "mailing lists" "closed"
34632 The examples so far have assumed open mailing lists, to which anybody may
34633 send mail. It is also possible to set up closed lists, where mail is accepted
34634 from specified senders only. This is done by making use of the generic
34635 &%senders%& option to restrict the router that handles the list.
34636
34637 The following example uses the same file as a list of recipients and as a list
34638 of permitted senders. It requires three routers:
34639 .code
34640 lists_request:
34641   driver = redirect
34642   domains = lists.example
34643   local_part_suffix = -request
34644   file = /usr/lists/$local_part$local_part_suffix
34645   no_more
34646
34647 lists_post:
34648   driver = redirect
34649   domains = lists.example
34650   senders = ${if exists {/usr/lists/$local_part}\
34651              {lsearch;/usr/lists/$local_part}{*}}
34652   file = /usr/lists/$local_part
34653   forbid_pipe
34654   forbid_file
34655   errors_to = $local_part-request@lists.example
34656   no_more
34657
34658 lists_closed:
34659   driver = redirect
34660   domains = lists.example
34661   allow_fail
34662   data = :fail: $local_part@lists.example is a closed mailing list
34663 .endd
34664 All three routers have the same &%domains%& setting, so for any other domains,
34665 they are all skipped. The first router runs only if the local part ends in
34666 &%-request%&. It handles messages to the list manager(s) by means of an open
34667 mailing list.
34668
34669 The second router runs only if the &%senders%& precondition is satisfied. It
34670 checks for the existence of a list that corresponds to the local part, and then
34671 checks that the sender is on the list by means of a linear search. It is
34672 necessary to check for the existence of the file before trying to search it,
34673 because otherwise Exim thinks there is a configuration error. If the file does
34674 not exist, the expansion of &%senders%& is *, which matches all senders. This
34675 means that the router runs, but because there is no list, declines, and
34676 &%no_more%& ensures that no further routers are run. The address fails with an
34677 &"unrouteable address"& error.
34678
34679 The third router runs only if the second router is skipped, which happens when
34680 a mailing list exists, but the sender is not on it. This router forcibly fails
34681 the address, giving a suitable error message.
34682
34683
34684
34685
34686 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34687 .cindex "VERP"
34688 .cindex "Variable Envelope Return Paths"
34689 .cindex "envelope sender"
34690 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34691 are a way of helping mailing list administrators discover which subscription
34692 address is the cause of a particular delivery failure. The idea is to encode
34693 the original recipient address in the outgoing envelope sender address, so that
34694 if the message is forwarded by another host and then subsequently bounces, the
34695 original recipient can be extracted from the recipient address of the bounce.
34696
34697 .oindex &%errors_to%&
34698 .oindex &%return_path%&
34699 Envelope sender addresses can be modified by Exim using two different
34700 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34701 list examples), or the &%return_path%& option on a transport. The second of
34702 these is effective only if the message is successfully delivered to another
34703 host; it is not used for errors detected on the local host (see the description
34704 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34705 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34706 .code
34707 verp_smtp:
34708   driver = smtp
34709   max_rcpt = 1
34710   return_path = \
34711     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34712       {$1-request+$local_part=$domain@your.dom.example}fail}
34713 .endd
34714 This has the effect of rewriting the return path (envelope sender) on outgoing
34715 SMTP messages, if the local part of the original return path ends in
34716 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34717 local part and domain of the recipient into the return path. Suppose, for
34718 example, that a message whose return path has been set to
34719 &'somelist-request@your.dom.example'& is sent to
34720 &'subscriber@other.dom.example'&. In the transport, the return path is
34721 rewritten as
34722 .code
34723 somelist-request+subscriber=other.dom.example@your.dom.example
34724 .endd
34725 .vindex "&$local_part$&"
34726 For this to work, you must tell Exim to send multiple copies of messages that
34727 have more than one recipient, so that each copy has just one recipient. This is
34728 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34729 might be sent to several different recipients in the same domain, in which case
34730 &$local_part$& is not available in the transport, because it is not unique.
34731
34732 Unless your host is doing nothing but mailing list deliveries, you should
34733 probably use a separate transport for the VERP deliveries, so as not to use
34734 extra resources in making one-per-recipient copies for other deliveries. This
34735 can easily be done by expanding the &%transport%& option in the router:
34736 .code
34737 dnslookup:
34738   driver = dnslookup
34739   domains = ! +local_domains
34740   transport = \
34741     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34742       {verp_smtp}{remote_smtp}}
34743   no_more
34744 .endd
34745 If you want to change the return path using &%errors_to%& in a router instead
34746 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34747 routers that handle mailing list addresses. This will ensure that all delivery
34748 errors, including those detected on the local host, are sent to the VERP
34749 address.
34750
34751 On a host that does no local deliveries and has no manual routing, only the
34752 &(dnslookup)& router needs to be changed. A special transport is not needed for
34753 SMTP deliveries. Every mailing list recipient has its own return path value,
34754 and so Exim must hand them to the transport one at a time. Here is an example
34755 of a &(dnslookup)& router that implements VERP:
34756 .code
34757 verp_dnslookup:
34758   driver = dnslookup
34759   domains = ! +local_domains
34760   transport = remote_smtp
34761   errors_to = \
34762     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34763      {$1-request+$local_part=$domain@your.dom.example}fail}
34764   no_more
34765 .endd
34766 Before you start sending out messages with VERPed return paths, you must also
34767 configure Exim to accept the bounce messages that come back to those paths.
34768 Typically this is done by setting a &%local_part_suffix%& option for a
34769 router, and using this to route the messages to wherever you want to handle
34770 them.
34771
34772 The overhead incurred in using VERP depends very much on the size of the
34773 message, the number of recipient addresses that resolve to the same remote
34774 host, and the speed of the connection over which the message is being sent. If
34775 a lot of addresses resolve to the same host and the connection is slow, sending
34776 a separate copy of the message for each address may take substantially longer
34777 than sending a single copy with many recipients (for which VERP cannot be
34778 used).
34779
34780
34781
34782
34783
34784
34785 .section "Virtual domains" "SECTvirtualdomains"
34786 .cindex "virtual domains"
34787 .cindex "domain" "virtual"
34788 The phrase &'virtual domain'& is unfortunately used with two rather different
34789 meanings:
34790
34791 .ilist
34792 A domain for which there are no real mailboxes; all valid local parts are
34793 aliases for other email addresses. Common examples are organizational
34794 top-level domains and &"vanity"& domains.
34795 .next
34796 One of a number of independent domains that are all handled by the same host,
34797 with mailboxes on that host, but where the mailbox owners do not necessarily
34798 have login accounts on that host.
34799 .endlist
34800
34801 The first usage is probably more common, and does seem more &"virtual"& than
34802 the second. This kind of domain can be handled in Exim with a straightforward
34803 aliasing router. One approach is to create a separate alias file for each
34804 virtual domain. Exim can test for the existence of the alias file to determine
34805 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34806 to a router of this form:
34807 .code
34808 virtual:
34809   driver = redirect
34810   domains = dsearch;/etc/mail/virtual
34811   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34812   no_more
34813 .endd
34814 The &%domains%& option specifies that the router is to be skipped, unless there
34815 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34816 domain that is being processed. When the router runs, it looks up the local
34817 part in the file to find a new address (or list of addresses). The &%no_more%&
34818 setting ensures that if the lookup fails (leading to &%data%& being an empty
34819 string), Exim gives up on the address without trying any subsequent routers.
34820
34821 This one router can handle all the virtual domains because the alias file names
34822 follow a fixed pattern. Permissions can be arranged so that appropriate people
34823 can edit the different alias files. A successful aliasing operation results in
34824 a new envelope recipient address, which is then routed from scratch.
34825
34826 The other kind of &"virtual"& domain can also be handled in a straightforward
34827 way. One approach is to create a file for each domain containing a list of
34828 valid local parts, and use it in a router like this:
34829 .code
34830 my_domains:
34831   driver = accept
34832   domains = dsearch;/etc/mail/domains
34833   local_parts = lsearch;/etc/mail/domains/$domain
34834   transport = my_mailboxes
34835 .endd
34836 The address is accepted if there is a file for the domain, and the local part
34837 can be found in the file. The &%domains%& option is used to check for the
34838 file's existence because &%domains%& is tested before the &%local_parts%&
34839 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34840 because that option is tested after &%local_parts%&. The transport is as
34841 follows:
34842 .code
34843 my_mailboxes:
34844   driver = appendfile
34845   file = /var/mail/$domain/$local_part
34846   user = mail
34847 .endd
34848 This uses a directory of mailboxes for each domain. The &%user%& setting is
34849 required, to specify which uid is to be used for writing to the mailboxes.
34850
34851 The configuration shown here is just one example of how you might support this
34852 requirement. There are many other ways this kind of configuration can be set
34853 up, for example, by using a database instead of separate files to hold all the
34854 information about the domains.
34855
34856
34857
34858 .section "Multiple user mailboxes" "SECTmulbox"
34859 .cindex "multiple mailboxes"
34860 .cindex "mailbox" "multiple"
34861 .cindex "local part" "prefix"
34862 .cindex "local part" "suffix"
34863 Heavy email users often want to operate with multiple mailboxes, into which
34864 incoming mail is automatically sorted. A popular way of handling this is to
34865 allow users to use multiple sender addresses, so that replies can easily be
34866 identified. Users are permitted to add prefixes or suffixes to their local
34867 parts for this purpose. The wildcard facility of the generic router options
34868 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34869 example, consider this router:
34870 .code
34871 userforward:
34872   driver = redirect
34873   check_local_user
34874   file = $home/.forward
34875   local_part_suffix = -*
34876   local_part_suffix_optional
34877   allow_filter
34878 .endd
34879 .vindex "&$local_part_suffix$&"
34880 It runs a user's &_.forward_& file for all local parts of the form
34881 &'username-*'&. Within the filter file the user can distinguish different
34882 cases by testing the variable &$local_part_suffix$&. For example:
34883 .code
34884 if $local_part_suffix contains -special then
34885 save /home/$local_part/Mail/special
34886 endif
34887 .endd
34888 If the filter file does not exist, or does not deal with such addresses, they
34889 fall through to subsequent routers, and, assuming no subsequent use of the
34890 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34891 control over which suffixes are valid.
34892
34893 Alternatively, a suffix can be used to trigger the use of a different
34894 &_.forward_& file &-- which is the way a similar facility is implemented in
34895 another MTA:
34896 .code
34897 userforward:
34898   driver = redirect
34899   check_local_user
34900   file = $home/.forward$local_part_suffix
34901   local_part_suffix = -*
34902   local_part_suffix_optional
34903   allow_filter
34904 .endd
34905 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34906 example, &_.forward-special_& is used. Once again, if the appropriate file
34907 does not exist, or does not deal with the address, it is passed on to
34908 subsequent routers, which could, if required, look for an unqualified
34909 &_.forward_& file to use as a default.
34910
34911
34912
34913 .section "Simplified vacation processing" "SECID244"
34914 .cindex "vacation processing"
34915 The traditional way of running the &'vacation'& program is for a user to set up
34916 a pipe command in a &_.forward_& file
34917 (see section &<<SECTspecitredli>>& for syntax details).
34918 This is prone to error by inexperienced users. There are two features of Exim
34919 that can be used to make this process simpler for users:
34920
34921 .ilist
34922 A local part prefix such as &"vacation-"& can be specified on a router which
34923 can cause the message to be delivered directly to the &'vacation'& program, or
34924 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34925 &_.forward_& file are then much simpler. For example:
34926 .code
34927 spqr, vacation-spqr
34928 .endd
34929 .next
34930 The &%require_files%& generic router option can be used to trigger a
34931 vacation delivery by checking for the existence of a certain file in the
34932 user's home directory. The &%unseen%& generic option should also be used, to
34933 ensure that the original delivery also proceeds. In this case, all the user has
34934 to do is to create a file called, say, &_.vacation_&, containing a vacation
34935 message.
34936 .endlist
34937
34938 Another advantage of both these methods is that they both work even when the
34939 use of arbitrary pipes by users is locked out.
34940
34941
34942
34943 .section "Taking copies of mail" "SECID245"
34944 .cindex "message" "copying every"
34945 Some installations have policies that require archive copies of all messages to
34946 be made. A single copy of each message can easily be taken by an appropriate
34947 command in a system filter, which could, for example, use a different file for
34948 each day's messages.
34949
34950 There is also a shadow transport mechanism that can be used to take copies of
34951 messages that are successfully delivered by local transports, one copy per
34952 delivery. This could be used, &'inter alia'&, to implement automatic
34953 notification of delivery by sites that insist on doing such things.
34954
34955
34956
34957 .section "Intermittently connected hosts" "SECID246"
34958 .cindex "intermittently connected hosts"
34959 It has become quite common (because it is cheaper) for hosts to connect to the
34960 Internet periodically rather than remain connected all the time. The normal
34961 arrangement is that mail for such hosts accumulates on a system that is
34962 permanently connected.
34963
34964 Exim was designed for use on permanently connected hosts, and so it is not
34965 particularly well-suited to use in an intermittently connected environment.
34966 Nevertheless there are some features that can be used.
34967
34968
34969 .section "Exim on the upstream server host" "SECID247"
34970 It is tempting to arrange for incoming mail for the intermittently connected
34971 host to remain on Exim's queue until the client connects. However, this
34972 approach does not scale very well. Two different kinds of waiting message are
34973 being mixed up in the same queue &-- those that cannot be delivered because of
34974 some temporary problem, and those that are waiting for their destination host
34975 to connect. This makes it hard to manage the queue, as well as wasting
34976 resources, because each queue runner scans the entire queue.
34977
34978 A better approach is to separate off those messages that are waiting for an
34979 intermittently connected host. This can be done by delivering these messages
34980 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34981 format, from where they are transmitted by other software when their
34982 destination connects. This makes it easy to collect all the mail for one host
34983 in a single directory, and to apply local timeout rules on a per-message basis
34984 if required.
34985
34986 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34987 you are doing this, you should configure Exim with a long retry period for the
34988 intermittent host. For example:
34989 .code
34990 cheshire.wonderland.fict.example    *   F,5d,24h
34991 .endd
34992 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34993 which messages it has queued up for that host. Once the intermittent host comes
34994 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34995 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34996 causes all the queued up messages to be delivered, often down a single SMTP
34997 connection. While the host remains connected, any new messages get delivered
34998 immediately.
34999
35000 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35001 issued with a different IP address each time it connects, Exim's retry
35002 mechanisms on the holding host get confused, because the IP address is normally
35003 used as part of the key string for holding retry information. This can be
35004 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35005 Since this has disadvantages for permanently connected hosts, it is best to
35006 arrange a separate transport for the intermittently connected ones.
35007
35008
35009
35010 .section "Exim on the intermittently connected client host" "SECID248"
35011 The value of &%smtp_accept_queue_per_connection%& should probably be
35012 increased, or even set to zero (that is, disabled) on the intermittently
35013 connected host, so that all incoming messages down a single connection get
35014 delivered immediately.
35015
35016 .cindex "SMTP" "passed connection"
35017 .cindex "SMTP" "multiple deliveries"
35018 .cindex "multiple SMTP deliveries"
35019 Mail waiting to be sent from an intermittently connected host will probably
35020 not have been routed, because without a connection DNS lookups are not
35021 possible. This means that if a normal queue run is done at connection time,
35022 each message is likely to be sent in a separate SMTP session. This can be
35023 avoided by starting the queue run with a command line option beginning with
35024 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35025 first pass, routing is done but no deliveries take place. The second pass is a
35026 normal queue run; since all the messages have been previously routed, those
35027 destined for the same host are likely to get sent as multiple deliveries in a
35028 single SMTP connection.
35029
35030
35031
35032 . ////////////////////////////////////////////////////////////////////////////
35033 . ////////////////////////////////////////////////////////////////////////////
35034
35035 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35036          "Exim as a non-queueing client"
35037 .cindex "client, non-queueing"
35038 .cindex "smart host" "suppressing queueing"
35039 On a personal computer, it is a common requirement for all
35040 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35041 configured to operate that way, for all the popular operating systems.
35042 However, there are some MUAs for Unix-like systems that cannot be so
35043 configured: they submit messages using the command line interface of
35044 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35045 messages this way.
35046
35047 If the personal computer runs continuously, there is no problem, because it can
35048 run a conventional MTA that handles delivery to the smart host, and deal with
35049 any delays via its queueing mechanism. However, if the computer does not run
35050 continuously or runs different operating systems at different times, queueing
35051 email is not desirable.
35052
35053 There is therefore a requirement for something that can provide the
35054 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35055 any queueing or retrying facilities. Furthermore, the delivery to the smart
35056 host should be synchronous, so that if it fails, the sending MUA is immediately
35057 informed. In other words, we want something that extends an MUA that submits
35058 to a local MTA via the command line so that it behaves like one that submits
35059 to a remote smart host using TCP/SMTP.
35060
35061 There are a number of applications (for example, there is one called &'ssmtp'&)
35062 that do this job. However, people have found them to be lacking in various
35063 ways. For instance, you might want to allow aliasing and forwarding to be done
35064 before sending a message to the smart host.
35065
35066 Exim already had the necessary infrastructure for doing this job. Just a few
35067 tweaks were needed to make it behave as required, though it is somewhat of an
35068 overkill to use a fully-featured MTA for this purpose.
35069
35070 .oindex "&%mua_wrapper%&"
35071 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35072 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35073 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35074 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35075 compatible router and transport configuration. Typically there will be just one
35076 router and one transport, sending everything to a smart host.
35077
35078 When run in MUA wrapping mode, the behaviour of Exim changes in the
35079 following ways:
35080
35081 .ilist
35082 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35083 In other words, the only way to submit messages is via the command line.
35084 .next
35085 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35086 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35087 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35088 does not finish until the delivery attempt is complete. If the delivery is
35089 successful, a zero return code is given.
35090 .next
35091 Address redirection is permitted, but the final routing for all addresses must
35092 be to the same remote transport, and to the same list of hosts. Furthermore,
35093 the return address (envelope sender) must be the same for all recipients, as
35094 must any added or deleted header lines. In other words, it must be possible to
35095 deliver the message in a single SMTP transaction, however many recipients there
35096 are.
35097 .next
35098 If these conditions are not met, or if routing any address results in a
35099 failure or defer status, or if Exim is unable to deliver all the recipients
35100 successfully to one of the smart hosts, delivery of the entire message fails.
35101 .next
35102 Because no queueing is allowed, all failures are treated as permanent; there
35103 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35104 smart host. Furthermore, because only a single yes/no response can be given to
35105 the caller, it is not possible to deliver to some recipients and not others. If
35106 there is an error (temporary or permanent) for any recipient, all are failed.
35107 .next
35108 If more than one smart host is listed, Exim will try another host after a
35109 connection failure or a timeout, in the normal way. However, if this kind of
35110 failure happens for all the hosts, the delivery fails.
35111 .next
35112 When delivery fails, an error message is written to the standard error stream
35113 (as well as to Exim's log), and Exim exits to the caller with a return code
35114 value 1. The message is expunged from Exim's spool files. No bounce messages
35115 are ever generated.
35116 .next
35117 No retry data is maintained, and any retry rules are ignored.
35118 .next
35119 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35120 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35121 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35122 .endlist
35123
35124 The overall effect is that Exim makes a single synchronous attempt to deliver
35125 the message, failing if there is any kind of problem. Because no local
35126 deliveries are done and no daemon can be run, Exim does not need root
35127 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35128 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35129 the advantages and disadvantages of running without root privilege.
35130
35131
35132
35133
35134 . ////////////////////////////////////////////////////////////////////////////
35135 . ////////////////////////////////////////////////////////////////////////////
35136
35137 .chapter "Log files" "CHAPlog"
35138 .scindex IIDloggen "log" "general description"
35139 .cindex "log" "types of"
35140 Exim writes three different logs, referred to as the main log, the reject log,
35141 and the panic log:
35142
35143 .ilist
35144 .cindex "main log"
35145 The main log records the arrival of each message and each delivery in a single
35146 line in each case. The format is as compact as possible, in an attempt to keep
35147 down the size of log files. Two-character flag sequences make it easy to pick
35148 out these lines. A number of other events are recorded in the main log. Some of
35149 them are optional, in which case the &%log_selector%& option controls whether
35150 they are included or not. A Perl script called &'eximstats'&, which does simple
35151 analysis of main log files, is provided in the Exim distribution (see section
35152 &<<SECTmailstat>>&).
35153 .next
35154 .cindex "reject log"
35155 The reject log records information from messages that are rejected as a result
35156 of a configuration option (that is, for policy reasons).
35157 The first line of each rejection is a copy of the line that is also written to
35158 the main log. Then, if the message's header has been read at the time the log
35159 is written, its contents are written to this log. Only the original header
35160 lines are available; header lines added by ACLs are not logged. You can use the
35161 reject log to check that your policy controls are working correctly; on a busy
35162 host this may be easier than scanning the main log for rejection messages. You
35163 can suppress the writing of the reject log by setting &%write_rejectlog%&
35164 false.
35165 .next
35166 .cindex "panic log"
35167 .cindex "system log"
35168 When certain serious errors occur, Exim writes entries to its panic log. If the
35169 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35170 are usually written to the main log as well, but can get lost amid the mass of
35171 other entries. The panic log should be empty under normal circumstances. It is
35172 therefore a good idea to check it (or to have a &'cron'& script check it)
35173 regularly, in order to become aware of any problems. When Exim cannot open its
35174 panic log, it tries as a last resort to write to the system log (syslog). This
35175 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35176 message itself is written at priority LOG_CRIT.
35177 .endlist
35178
35179 Every log line starts with a timestamp, in the format shown in the following
35180 example. Note that many of the examples shown in this chapter are line-wrapped.
35181 In the log file, this would be all on one line:
35182 .code
35183 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35184   by QUIT
35185 .endd
35186 By default, the timestamps are in the local timezone. There are two
35187 ways of changing this:
35188
35189 .ilist
35190 You can set the &%timezone%& option to a different time zone; in particular, if
35191 you set
35192 .code
35193 timezone = UTC
35194 .endd
35195 the timestamps will be in UTC (aka GMT).
35196 .next
35197 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35198 example:
35199 .code
35200 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35201 .endd
35202 .endlist
35203
35204 .cindex "log" "process ids in"
35205 .cindex "pid (process id)" "in log lines"
35206 Exim does not include its process id in log lines by default, but you can
35207 request that it does so by specifying the &`pid`& log selector (see section
35208 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35209 brackets, immediately after the time and date.
35210
35211
35212
35213
35214 .section "Where the logs are written" "SECTwhelogwri"
35215 .cindex "log" "destination"
35216 .cindex "log" "to file"
35217 .cindex "log" "to syslog"
35218 .cindex "syslog"
35219 The logs may be written to local files, or to syslog, or both. However, it
35220 should be noted that many syslog implementations use UDP as a transport, and
35221 are therefore unreliable in the sense that messages are not guaranteed to
35222 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35223 It has also been reported that on large log files (tens of megabytes) you may
35224 need to tweak syslog to prevent it syncing the file with each write &-- on
35225 Linux this has been seen to make syslog take 90% plus of CPU time.
35226
35227 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35228 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35229 configuration. This latter string is expanded, so it can contain, for example,
35230 references to the host name:
35231 .code
35232 log_file_path = /var/log/$primary_hostname/exim_%slog
35233 .endd
35234 It is generally advisable, however, to set the string in &_Local/Makefile_&
35235 rather than at run time, because then the setting is available right from the
35236 start of Exim's execution. Otherwise, if there's something it wants to log
35237 before it has read the configuration file (for example, an error in the
35238 configuration file) it will not use the path you want, and may not be able to
35239 log at all.
35240
35241 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35242 list, currently limited to at most two items. This is one option where the
35243 facility for changing a list separator may not be used. The list must always be
35244 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35245 otherwise the item must either be an absolute path, containing &`%s`& at the
35246 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35247 implying the use of a default path.
35248
35249 When Exim encounters an empty item in the list, it searches the list defined by
35250 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35251 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35252 mean &"use the path specified at build time"&. It no such item exists, log
35253 files are written in the &_log_& subdirectory of the spool directory. This is
35254 equivalent to the setting:
35255 .code
35256 log_file_path = $spool_directory/log/%slog
35257 .endd
35258 If you do not specify anything at build time or run time,
35259 or if you unset the option at run time (i.e. &`log_file_path = `&),
35260 that is where the logs are written.
35261
35262 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35263 are in use &-- see section &<<SECTdatlogfil>>& below.
35264
35265 Here are some examples of possible settings:
35266 .display
35267 &`LOG_FILE_PATH=syslog                    `& syslog only
35268 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35269 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35270 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35271 .endd
35272 If there are more than two paths in the list, the first is used and a panic
35273 error is logged.
35274
35275
35276
35277 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35278 .cindex "log" "cycling local files"
35279 .cindex "cycling logs"
35280 .cindex "&'exicyclog'&"
35281 .cindex "log" "local files; writing to"
35282 Some operating systems provide centralized and standardized methods for cycling
35283 log files. For those that do not, a utility script called &'exicyclog'& is
35284 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35285 main and reject logs each time it is called. The maximum number of old logs to
35286 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35287
35288 An Exim delivery process opens the main log when it first needs to write to it,
35289 and it keeps the file open in case subsequent entries are required &-- for
35290 example, if a number of different deliveries are being done for the same
35291 message. However, remote SMTP deliveries can take a long time, and this means
35292 that the file may be kept open long after it is renamed if &'exicyclog'& or
35293 something similar is being used to rename log files on a regular basis. To
35294 ensure that a switch of log files is noticed as soon as possible, Exim calls
35295 &[stat()]& on the main log's name before reusing an open file, and if the file
35296 does not exist, or its inode has changed, the old file is closed and Exim
35297 tries to open the main log from scratch. Thus, an old log file may remain open
35298 for quite some time, but no Exim processes should write to it once it has been
35299 renamed.
35300
35301
35302
35303 .section "Datestamped log files" "SECTdatlogfil"
35304 .cindex "log" "datestamped files"
35305 Instead of cycling the main and reject log files by renaming them
35306 periodically, some sites like to use files whose names contain a datestamp,
35307 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35308 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35309 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35310 point where the datestamp is required. For example:
35311 .code
35312 log_file_path = /var/spool/exim/log/%slog-%D
35313 log_file_path = /var/log/exim-%s-%D.log
35314 log_file_path = /var/spool/exim/log/%D-%slog
35315 log_file_path = /var/log/exim/%s.%M
35316 .endd
35317 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35318 examples of names generated by the above examples:
35319 .code
35320 /var/spool/exim/log/mainlog-20021225
35321 /var/log/exim-reject-20021225.log
35322 /var/spool/exim/log/20021225-mainlog
35323 /var/log/exim/main.200212
35324 .endd
35325 When this form of log file is specified, Exim automatically switches to new
35326 files at midnight. It does not make any attempt to compress old logs; you
35327 will need to write your own script if you require this. You should not
35328 run &'exicyclog'& with this form of logging.
35329
35330 The location of the panic log is also determined by &%log_file_path%&, but it
35331 is not datestamped, because rotation of the panic log does not make sense.
35332 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35333 the string. In addition, if it immediately follows a slash, a following
35334 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35335 character is removed. Thus, the four examples above would give these panic
35336 log names:
35337 .code
35338 /var/spool/exim/log/paniclog
35339 /var/log/exim-panic.log
35340 /var/spool/exim/log/paniclog
35341 /var/log/exim/panic
35342 .endd
35343
35344
35345 .section "Logging to syslog" "SECID249"
35346 .cindex "log" "syslog; writing to"
35347 The use of syslog does not change what Exim logs or the format of its messages,
35348 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35349 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35350 that, the same strings are written to syslog as to log files. The syslog
35351 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35352 by default, but you can change these by setting the &%syslog_facility%& and
35353 &%syslog_processname%& options, respectively. If Exim was compiled with
35354 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35355 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35356 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35357 the time and host name to each line.
35358 The three log streams are mapped onto syslog priorities as follows:
35359
35360 .ilist
35361 &'mainlog'& is mapped to LOG_INFO
35362 .next
35363 &'rejectlog'& is mapped to LOG_NOTICE
35364 .next
35365 &'paniclog'& is mapped to LOG_ALERT
35366 .endlist
35367
35368 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35369 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35370 these are routed by syslog to the same place. You can suppress this duplication
35371 by setting &%syslog_duplication%& false.
35372
35373 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35374 entries contain multiple lines when headers are included. To cope with both
35375 these cases, entries written to syslog are split into separate &[syslog()]&
35376 calls at each internal newline, and also after a maximum of
35377 870 data characters. (This allows for a total syslog line length of 1024, when
35378 additions such as timestamps are added.) If you are running a syslog
35379 replacement that can handle lines longer than the 1024 characters allowed by
35380 RFC 3164, you should set
35381 .code
35382 SYSLOG_LONG_LINES=yes
35383 .endd
35384 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35385 lines, but it still splits at internal newlines in &'reject'& log entries.
35386
35387 To make it easy to re-assemble split lines later, each component of a split
35388 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35389 where <&'n'&> is the component number and <&'m'&> is the total number of
35390 components in the entry. The / delimiter is used when the line was split
35391 because it was too long; if it was split because of an internal newline, the \
35392 delimiter is used. For example, supposing the length limit to be 50 instead of
35393 870, the following would be the result of a typical rejection message to
35394 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35395 name, and pid as added by syslog:
35396 .code
35397 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35398 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35399 [3/5]  when scanning for sender: missing or malformed lo
35400 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35401 [5/5] mple>)
35402 .endd
35403 The same error might cause the following lines to be written to &"rejectlog"&
35404 (LOG_NOTICE):
35405 .code
35406 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35407 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35408 [3/18] er when scanning for sender: missing or malformed
35409 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35410 [5\18] .example>)
35411 [6\18] Recipients: ph10@some.domain.cam.example
35412 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35413 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35414 [9\18]        id 16RdAL-0006pc-00
35415 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35416 [11\18] 09:43 +0100
35417 [12\18] F From: <>
35418 [13\18]   Subject: this is a test header
35419 [18\18]   X-something: this is another header
35420 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35421 [16\18] le>
35422 [17\18] B Bcc:
35423 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35424 .endd
35425 Log lines that are neither too long nor contain newlines are written to syslog
35426 without modification.
35427
35428 If only syslog is being used, the Exim monitor is unable to provide a log tail
35429 display, unless syslog is routing &'mainlog'& to a file on the local host and
35430 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35431 where it is.
35432
35433
35434
35435 .section "Log line flags" "SECID250"
35436 One line is written to the main log for each message received, and for each
35437 successful, unsuccessful, and delayed delivery. These lines can readily be
35438 picked out by the distinctive two-character flags that immediately follow the
35439 timestamp. The flags are:
35440 .display
35441 &`<=`&     message arrival
35442 &`=>`&     normal message delivery
35443 &`->`&     additional address in same delivery
35444 &`>>`&     cutthrough message delivery
35445 &`*>`&     delivery suppressed by &%-N%&
35446 &`**`&     delivery failed; address bounced
35447 &`==`&     delivery deferred; temporary problem
35448 .endd
35449
35450
35451 .section "Logging message reception" "SECID251"
35452 .cindex "log" "reception line"
35453 The format of the single-line entry in the main log that is written for every
35454 message received is shown in the basic example below, which is split over
35455 several lines in order to fit it on the page:
35456 .code
35457 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35458   H=mailer.fict.example [192.168.123.123] U=exim
35459   P=smtp S=5678 id=<incoming message id>
35460 .endd
35461 The address immediately following &"<="& is the envelope sender address. A
35462 bounce message is shown with the sender address &"<>"&, and if it is locally
35463 generated, this is followed by an item of the form
35464 .code
35465 R=<message id>
35466 .endd
35467 which is a reference to the message that caused the bounce to be sent.
35468
35469 .cindex "HELO"
35470 .cindex "EHLO"
35471 For messages from other hosts, the H and U fields identify the remote host and
35472 record the RFC 1413 identity of the user that sent the message, if one was
35473 received. The number given in square brackets is the IP address of the sending
35474 host. If there is a single, unparenthesized  host name in the H field, as
35475 above, it has been verified to correspond to the IP address (see the
35476 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35477 by the remote host in the SMTP HELO or EHLO command, and has not been
35478 verified. If verification yields a different name to that given for HELO or
35479 EHLO, the verified name appears first, followed by the HELO or EHLO
35480 name in parentheses.
35481
35482 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35483 without brackets, in the HELO or EHLO command, leading to entries in
35484 the log containing text like these examples:
35485 .code
35486 H=(10.21.32.43) [192.168.8.34]
35487 H=([10.21.32.43]) [192.168.8.34]
35488 .endd
35489 This can be confusing. Only the final address in square brackets can be relied
35490 on.
35491
35492 For locally generated messages (that is, messages not received over TCP/IP),
35493 the H field is omitted, and the U field contains the login name of the caller
35494 of Exim.
35495
35496 .cindex "authentication" "logging"
35497 .cindex "AUTH" "logging"
35498 For all messages, the P field specifies the protocol used to receive the
35499 message. This is the value that is stored in &$received_protocol$&. In the case
35500 of incoming SMTP messages, the value indicates whether or not any SMTP
35501 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35502 session was encrypted, there is an additional X field that records the cipher
35503 suite that was used.
35504
35505 .cindex log protocol
35506 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35507 hosts that have authenticated themselves using the SMTP AUTH command. The first
35508 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35509 there is an additional item A= followed by the name of the authenticator that
35510 was used. If an authenticated identification was set up by the authenticator's
35511 &%server_set_id%& option, this is logged too, separated by a colon from the
35512 authenticator name.
35513
35514 .cindex "size" "of message"
35515 The id field records the existing message id, if present. The size of the
35516 received message is given by the S field. When the message is delivered,
35517 headers may be removed or added, so that the size of delivered copies of the
35518 message may not correspond with this value (and indeed may be different to each
35519 other).
35520
35521 The &%log_selector%& option can be used to request the logging of additional
35522 data when a message is received. See section &<<SECTlogselector>>& below.
35523
35524
35525
35526 .section "Logging deliveries" "SECID252"
35527 .cindex "log" "delivery line"
35528 The format of the single-line entry in the main log that is written for every
35529 delivery is shown in one of the examples below, for local and remote
35530 deliveries, respectively. Each example has been split into multiple lines in order
35531 to fit it on the page:
35532 .code
35533 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35534   <marv@hitch.fict.example> R=localuser T=local_delivery
35535 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35536   monk@holistic.fict.example R=dnslookup T=remote_smtp
35537   H=holistic.fict.example [192.168.234.234]
35538 .endd
35539 For ordinary local deliveries, the original address is given in angle brackets
35540 after the final delivery address, which might be a pipe or a file. If
35541 intermediate address(es) exist between the original and the final address, the
35542 last of these is given in parentheses after the final address. The R and T
35543 fields record the router and transport that were used to process the address.
35544
35545 If SMTP AUTH was used for the delivery there is an additional item A=
35546 followed by the name of the authenticator that was used.
35547 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35548 option, this is logged too, separated by a colon from the authenticator name.
35549
35550 If a shadow transport was run after a successful local delivery, the log line
35551 for the successful delivery has an item added on the end, of the form
35552 .display
35553 &`ST=<`&&'shadow transport name'&&`>`&
35554 .endd
35555 If the shadow transport did not succeed, the error message is put in
35556 parentheses afterwards.
35557
35558 .cindex "asterisk" "after IP address"
35559 When more than one address is included in a single delivery (for example, two
35560 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35561 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35562 down a single SMTP connection, an asterisk follows the IP address in the log
35563 lines for the second and subsequent messages.
35564
35565 .cindex "delivery" "cutthrough; logging"
35566 .cindex "cutthrough" "logging"
35567 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35568 line precedes the reception line, since cutthrough waits for a possible
35569 rejection from the destination in case it can reject the sourced item.
35570
35571 The generation of a reply message by a filter file gets logged as a
35572 &"delivery"& to the addressee, preceded by &">"&.
35573
35574 The &%log_selector%& option can be used to request the logging of additional
35575 data when a message is delivered. See section &<<SECTlogselector>>& below.
35576
35577
35578 .section "Discarded deliveries" "SECID253"
35579 .cindex "discarded messages"
35580 .cindex "message" "discarded"
35581 .cindex "delivery" "discarded; logging"
35582 When a message is discarded as a result of the command &"seen finish"& being
35583 obeyed in a filter file which generates no deliveries, a log entry of the form
35584 .code
35585 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35586   <low.club@bridge.example> R=userforward
35587 .endd
35588 is written, to record why no deliveries are logged. When a message is discarded
35589 because it is aliased to &":blackhole:"& the log line is like this:
35590 .code
35591 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35592   <hole@nowhere.example> R=blackhole_router
35593 .endd
35594
35595
35596 .section "Deferred deliveries" "SECID254"
35597 When a delivery is deferred, a line of the following form is logged:
35598 .code
35599 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35600   R=dnslookup T=smtp defer (146): Connection refused
35601 .endd
35602 In the case of remote deliveries, the error is the one that was given for the
35603 last IP address that was tried. Details of individual SMTP failures are also
35604 written to the log, so the above line would be preceded by something like
35605 .code
35606 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35607   mail1.endrest.example [192.168.239.239]: Connection refused
35608 .endd
35609 When a deferred address is skipped because its retry time has not been reached,
35610 a message is written to the log, but this can be suppressed by setting an
35611 appropriate value in &%log_selector%&.
35612
35613
35614
35615 .section "Delivery failures" "SECID255"
35616 .cindex "delivery" "failure; logging"
35617 If a delivery fails because an address cannot be routed, a line of the
35618 following form is logged:
35619 .code
35620 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35621   <jim@trek99.example>: unknown mail domain
35622 .endd
35623 If a delivery fails at transport time, the router and transport are shown, and
35624 the response from the remote host is included, as in this example:
35625 .code
35626 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35627   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35628   after pipelined RCPT TO:<ace400@pb.example>: host
35629   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35630   <ace400@pb.example>...Addressee unknown
35631 .endd
35632 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35633 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35634 disabling PIPELINING. The log lines for all forms of delivery failure are
35635 flagged with &`**`&.
35636
35637
35638
35639 .section "Fake deliveries" "SECID256"
35640 .cindex "delivery" "fake; logging"
35641 If a delivery does not actually take place because the &%-N%& option has been
35642 used to suppress it, a normal delivery line is written to the log, except that
35643 &"=>"& is replaced by &"*>"&.
35644
35645
35646
35647 .section "Completion" "SECID257"
35648 A line of the form
35649 .code
35650 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35651 .endd
35652 is written to the main log when a message is about to be removed from the spool
35653 at the end of its processing.
35654
35655
35656
35657
35658 .section "Summary of Fields in Log Lines" "SECID258"
35659 .cindex "log" "summary of fields"
35660 A summary of the field identifiers that are used in log lines is shown in
35661 the following table:
35662 .display
35663 &`A   `&        authenticator name (and optional id and sender)
35664 &`C   `&        SMTP confirmation on delivery
35665 &`    `&        command list for &"no mail in SMTP session"&
35666 &`CV  `&        certificate verification status
35667 &`D   `&        duration of &"no mail in SMTP session"&
35668 &`DN  `&        distinguished name from peer certificate
35669 &`DT  `&        on &`=>`& lines: time taken for a delivery
35670 &`F   `&        sender address (on delivery lines)
35671 &`H   `&        host name and IP address
35672 &`I   `&        local interface used
35673 &`id  `&        message id for incoming message
35674 &`P   `&        on &`<=`& lines: protocol used
35675 &`    `&        on &`=>`& and &`**`& lines: return path
35676 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35677 &`QT  `&        on &`=>`& lines: time spent on queue so far
35678 &`    `&        on &"Completed"& lines: time spent on queue
35679 &`R   `&        on &`<=`& lines: reference for local bounce
35680 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35681 &`S   `&        size of message in bytes
35682 &`SNI `&        server name indication from TLS client hello
35683 &`ST  `&        shadow transport name
35684 &`T   `&        on &`<=`& lines: message subject (topic)
35685 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35686 &`U   `&        local user or RFC 1413 identity
35687 &`X   `&        TLS cipher suite
35688 .endd
35689
35690
35691 .section "Other log entries" "SECID259"
35692 Various other types of log entry are written from time to time. Most should be
35693 self-explanatory. Among the more common are:
35694
35695 .ilist
35696 .cindex "retry" "time not reached"
35697 &'retry time not reached'&&~&~An address previously suffered a temporary error
35698 during routing or local delivery, and the time to retry has not yet arrived.
35699 This message is not written to an individual message log file unless it happens
35700 during the first delivery attempt.
35701 .next
35702 &'retry time not reached for any host'&&~&~An address previously suffered
35703 temporary errors during remote delivery, and the retry time has not yet arrived
35704 for any of the hosts to which it is routed.
35705 .next
35706 .cindex "spool directory" "file locked"
35707 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35708 some other Exim process is already working on the message. This can be quite
35709 common if queue running processes are started at frequent intervals. The
35710 &'exiwhat'& utility script can be used to find out what Exim processes are
35711 doing.
35712 .next
35713 .cindex "error" "ignored"
35714 &'error ignored'&&~&~There are several circumstances that give rise to this
35715 message:
35716 .olist
35717 Exim failed to deliver a bounce message whose age was greater than
35718 &%ignore_bounce_errors_after%&. The bounce was discarded.
35719 .next
35720 A filter file set up a delivery using the &"noerror"& option, and the delivery
35721 failed. The delivery was discarded.
35722 .next
35723 A delivery set up by a router configured with
35724 . ==== As this is a nested list, any displays it contains must be indented
35725 . ==== as otherwise they are too far to the left.
35726 .code
35727     errors_to = <>
35728 .endd
35729 failed. The delivery was discarded.
35730 .endlist olist
35731 .endlist ilist
35732
35733
35734
35735
35736
35737 .section "Reducing or increasing what is logged" "SECTlogselector"
35738 .cindex "log" "selectors"
35739 By setting the &%log_selector%& global option, you can disable some of Exim's
35740 default logging, or you can request additional logging. The value of
35741 &%log_selector%& is made up of names preceded by plus or minus characters. For
35742 example:
35743 .code
35744 log_selector = +arguments -retry_defer
35745 .endd
35746 The list of optional log items is in the following table, with the default
35747 selection marked by asterisks:
35748 .display
35749 &` 8bitmime                   `&  received 8BITMIME status
35750 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35751 &` address_rewrite            `&  address rewriting
35752 &` all_parents                `&  all parents in => lines
35753 &` arguments                  `&  command line arguments
35754 &`*connection_reject          `&  connection rejections
35755 &`*delay_delivery             `&  immediate delivery delayed
35756 &` deliver_time               `&  time taken to perform delivery
35757 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35758 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35759 &`*etrn                       `&  ETRN commands
35760 &`*host_lookup_failed         `&  as it says
35761 &` ident_timeout              `&  timeout for ident connection
35762 &` incoming_interface         `&  local interface on <= and => lines
35763 &` incoming_port              `&  remote port on <= lines
35764 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35765 .new
35766 &` outgoing_interface         `&  local interface on => lines
35767 .wen
35768 &` outgoing_port              `&  add remote port to => lines
35769 &`*queue_run                  `&  start and end queue runs
35770 &` queue_time                 `&  time on queue for one recipient
35771 &` queue_time_overall         `&  time on queue for whole message
35772 &` pid                        `&  Exim process id
35773 .new
35774 &` proxy                      `&  proxy address on <= and => lines
35775 .wen
35776 &` received_recipients        `&  recipients on <= lines
35777 &` received_sender            `&  sender on <= lines
35778 &`*rejected_header            `&  header contents on reject log
35779 &`*retry_defer                `&  &"retry time not reached"&
35780 &` return_path_on_delivery    `&  put return path on => and ** lines
35781 &` sender_on_delivery         `&  add sender to => lines
35782 &`*sender_verify_fail         `&  sender verification failures
35783 &`*size_reject                `&  rejection because too big
35784 &`*skip_delivery              `&  delivery skipped in a queue run
35785 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35786 &` smtp_connection            `&  incoming SMTP connections
35787 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35788 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35789 &` smtp_no_mail               `&  session with no MAIL commands
35790 &` smtp_protocol_error        `&  SMTP protocol errors
35791 &` smtp_syntax_error          `&  SMTP syntax errors
35792 &` subject                    `&  contents of &'Subject:'& on <= lines
35793 &`*tls_certificate_verified   `&  certificate verification status
35794 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35795 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35796 &` tls_sni                    `&  TLS SNI on <= lines
35797 &` unknown_in_list            `&  DNS lookup failed in list match
35798
35799 &` all                        `&  all of the above
35800 .endd
35801 See also the &%slow_lookup_log%& main configuration option,
35802 section &<<SECID99>>&
35803
35804 More details on each of these items follows:
35805
35806 .ilist
35807 .cindex "8BITMIME"
35808 .cindex "log" "8BITMIME"
35809 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35810 which may help in tracking down interoperability issues with ancient MTAs
35811 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35812 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35813 &`7BIT`& and &`8BITMIME`& respectively.
35814 .next
35815 .cindex "&%warn%& ACL verb" "log when skipping"
35816 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35817 its conditions cannot be evaluated, a log line to this effect is written if
35818 this log selector is set.
35819 .next
35820 .cindex "log" "rewriting"
35821 .cindex "rewriting" "logging"
35822 &%address_rewrite%&: This applies both to global rewrites and per-transport
35823 rewrites, but not to rewrites in filters run as an unprivileged user (because
35824 such users cannot access the log).
35825 .next
35826 .cindex "log" "full parentage"
35827 &%all_parents%&: Normally only the original and final addresses are logged on
35828 delivery lines; with this selector, intermediate parents are given in
35829 parentheses between them.
35830 .next
35831 .cindex "log" "Exim arguments"
35832 .cindex "Exim arguments, logging"
35833 &%arguments%&: This causes Exim to write the arguments with which it was called
35834 to the main log, preceded by the current working directory. This is a debugging
35835 feature, added to make it easier to find out how certain MUAs call
35836 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35837 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35838 that are empty or that contain white space are quoted. Non-printing characters
35839 are shown as escape sequences. This facility cannot log unrecognized arguments,
35840 because the arguments are checked before the configuration file is read. The
35841 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35842 between the caller and Exim.
35843 .next
35844 .cindex "log" "connection rejections"
35845 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35846 connection is rejected, for whatever reason.
35847 .next
35848 .cindex "log" "delayed delivery"
35849 .cindex "delayed delivery, logging"
35850 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35851 started for an incoming message because the load is too high or too many
35852 messages were received on one connection. Logging does not occur if no delivery
35853 process is started because &%queue_only%& is set or &%-odq%& was used.
35854 .next
35855 .cindex "log" "delivery duration"
35856 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35857 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35858 .next
35859 .cindex "log" "message size on delivery"
35860 .cindex "size" "of message"
35861 &%delivery_size%&: For each delivery, the size of message delivered is added to
35862 the &"=>"& line, tagged with S=.
35863 .next
35864 .cindex "log" "dnslist defer"
35865 .cindex "DNS list" "logging defer"
35866 .cindex "black list (DNS)"
35867 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35868 DNS black list suffers a temporary error.
35869 .next
35870 .cindex "log" "ETRN commands"
35871 .cindex "ETRN" "logging"
35872 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35873 is run to determine whether or not it is actually accepted. An invalid ETRN
35874 command, or one received within a message transaction is not logged by this
35875 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35876 .next
35877 .cindex "log" "host lookup failure"
35878 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35879 any addresses, or when a lookup of an IP address fails to find a host name, a
35880 log line is written. This logging does not apply to direct DNS lookups when
35881 routing email addresses, but it does apply to &"byname"& lookups.
35882 .next
35883 .cindex "log" "ident timeout"
35884 .cindex "RFC 1413" "logging timeout"
35885 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35886 client's ident port times out.
35887 .next
35888 .cindex "log" "incoming interface"
35889 .cindex "log" "local interface"
35890 .cindex "log" "local address and port"
35891 .cindex "TCP/IP" "logging local address and port"
35892 .cindex "interface" "logging"
35893 &%incoming_interface%&: The interface on which a message was received is added
35894 to the &"<="& line as an IP address in square brackets, tagged by I= and
35895 followed by a colon and the port number. The local interface and port are also
35896 added to other SMTP log lines, for example &"SMTP connection from"&, to
35897 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35898 .new
35899 The latter can be disabled by turning off the &%outgoing_interface%& option.
35900 .wen
35901 .next
35902 .new
35903 .cindex log "incoming proxy address"
35904 .cindex proxy "logging proxy address"
35905 .cindex "TCP/IP" "logging proxy address"
35906 &%proxy%&: The internal (closest to the system running Exim) IP address
35907 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35908 on a proxied connection
35909 or the &"=>"& line for a message delivered on a proxied connection..
35910 See &<<SECTproxyInbound>>& for more information.
35911 .wen
35912 .next
35913 .cindex "log" "incoming remote port"
35914 .cindex "port" "logging remote"
35915 .cindex "TCP/IP" "logging incoming remote port"
35916 .vindex "&$sender_fullhost$&"
35917 .vindex "&$sender_rcvhost$&"
35918 &%incoming_port%&: The remote port number from which a message was received is
35919 added to log entries and &'Received:'& header lines, following the IP address
35920 in square brackets, and separated from it by a colon. This is implemented by
35921 changing the value that is put in the &$sender_fullhost$& and
35922 &$sender_rcvhost$& variables. Recording the remote port number has become more
35923 important with the widening use of NAT (see RFC 2505).
35924 .next
35925 .cindex "log" "dropped connection"
35926 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35927 connection is unexpectedly dropped.
35928 .next
35929 .cindex "log" "outgoing interface"
35930 .cindex "log" "local interface"
35931 .cindex "log" "local address and port"
35932 .cindex "TCP/IP" "logging local address and port"
35933 .cindex "interface" "logging"
35934 .new
35935 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35936 interface on which a message was sent is added to delivery lines as an I= tag
35937 followed by IP address in square brackets. You can disable this by turning
35938 off the &%outgoing_interface%& option.
35939 .wen
35940 .next
35941 .cindex "log" "outgoing remote port"
35942 .cindex "port" "logging outgoint remote"
35943 .cindex "TCP/IP" "logging ougtoing remote port"
35944 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35945 containing => tags) following the IP address.
35946 .new
35947 The local port is also added if &%incoming_interface%& and
35948 &%outgoing_interface%& are both enabled.
35949 .wen
35950 This option is not included in the default setting, because for most ordinary
35951 configurations, the remote port number is always 25 (the SMTP port), and the
35952 local port is a random ephemeral port.
35953 .next
35954 .cindex "log" "process ids in"
35955 .cindex "pid (process id)" "in log lines"
35956 &%pid%&: The current process id is added to every log line, in square brackets,
35957 immediately after the time and date.
35958 .next
35959 .cindex "log" "queue run"
35960 .cindex "queue runner" "logging"
35961 &%queue_run%&: The start and end of every queue run are logged.
35962 .next
35963 .cindex "log" "queue time"
35964 &%queue_time%&: The amount of time the message has been in the queue on the
35965 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35966 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35967 includes reception time as well as the delivery time for the current address.
35968 This means that it may be longer than the difference between the arrival and
35969 delivery log line times, because the arrival log line is not written until the
35970 message has been successfully received.
35971 .next
35972 &%queue_time_overall%&: The amount of time the message has been in the queue on
35973 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35974 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35975 message, so it includes reception time as well as the total delivery time.
35976 .next
35977 .cindex "log" "recipients"
35978 &%received_recipients%&: The recipients of a message are listed in the main log
35979 as soon as the message is received. The list appears at the end of the log line
35980 that is written when a message is received, preceded by the word &"for"&. The
35981 addresses are listed after they have been qualified, but before any rewriting
35982 has taken place.
35983 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35984 in the list.
35985 .next
35986 .cindex "log" "sender reception"
35987 &%received_sender%&: The unrewritten original sender of a message is added to
35988 the end of the log line that records the message's arrival, after the word
35989 &"from"& (before the recipients if &%received_recipients%& is also set).
35990 .next
35991 .cindex "log" "header lines for rejection"
35992 &%rejected_header%&: If a message's header has been received at the time a
35993 rejection is written to the reject log, the complete header is added to the
35994 log. Header logging can be turned off individually for messages that are
35995 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35996 .next
35997 .cindex "log" "retry defer"
35998 &%retry_defer%&: A log line is written if a delivery is deferred because a
35999 retry time has not yet been reached. However, this &"retry time not reached"&
36000 message is always omitted from individual message logs after the first delivery
36001 attempt.
36002 .next
36003 .cindex "log" "return path"
36004 &%return_path_on_delivery%&: The return path that is being transmitted with
36005 the message is included in delivery and bounce lines, using the tag P=.
36006 This is omitted if no delivery actually happens, for example, if routing fails,
36007 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36008 .next
36009 .cindex "log" "sender on delivery"
36010 &%sender_on_delivery%&: The message's sender address is added to every delivery
36011 and bounce line, tagged by F= (for &"from"&).
36012 This is the original sender that was received with the message; it is not
36013 necessarily the same as the outgoing return path.
36014 .next
36015 .cindex "log" "sender verify failure"
36016 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36017 gives details of a sender verification failure is not written. Log lines for
36018 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36019 detail is lost.
36020 .next
36021 .cindex "log" "size rejection"
36022 &%size_reject%&: A log line is written whenever a message is rejected because
36023 it is too big.
36024 .next
36025 .cindex "log" "frozen messages; skipped"
36026 .cindex "frozen messages" "logging skipping"
36027 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36028 queue run because it is frozen or because another process is already delivering
36029 it.
36030 .cindex "&""spool file is locked""&"
36031 The message that is written is &"spool file is locked"&.
36032 .next
36033 .cindex "log" "smtp confirmation"
36034 .cindex "SMTP" "logging confirmation"
36035 .cindex "LMTP" "logging confirmation"
36036 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36037 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36038 A number of MTAs (including Exim) return an identifying string in this
36039 response.
36040 .next
36041 .cindex "log" "SMTP connections"
36042 .cindex "SMTP" "logging connections"
36043 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36044 established or closed, unless the connection is from a host that matches
36045 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36046 only when the closure is unexpected.) This applies to connections from local
36047 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36048 dropped in the middle of a message, a log line is always written, whether or
36049 not this selector is set, but otherwise nothing is written at the start and end
36050 of connections unless this selector is enabled.
36051
36052 For TCP/IP connections to an Exim daemon, the current number of connections is
36053 included in the log message for each new connection, but note that the count is
36054 reset if the daemon is restarted.
36055 Also, because connections are closed (and the closure is logged) in
36056 subprocesses, the count may not include connections that have been closed but
36057 whose termination the daemon has not yet noticed. Thus, while it is possible to
36058 match up the opening and closing of connections in the log, the value of the
36059 logged counts may not be entirely accurate.
36060 .next
36061 .cindex "log" "SMTP transaction; incomplete"
36062 .cindex "SMTP" "logging incomplete transactions"
36063 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36064 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36065 and the message sender plus any accepted recipients are included in the log
36066 line. This can provide evidence of dictionary attacks.
36067 .next
36068 .cindex "log" "non-MAIL SMTP sessions"
36069 .cindex "MAIL" "logging session without"
36070 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36071 connection terminates without having issued a MAIL command. This includes both
36072 the case when the connection is dropped, and the case when QUIT is used. It
36073 does not include cases where the connection is rejected right at the start (by
36074 an ACL, or because there are too many connections, or whatever). These cases
36075 already have their own log lines.
36076
36077 The log line that is written contains the identity of the client in the usual
36078 way, followed by D= and a time, which records the duration of the connection.
36079 If the connection was authenticated, this fact is logged exactly as it is for
36080 an incoming message, with an A= item. If the connection was encrypted, CV=,
36081 DN=, and X= items may appear as they do for an incoming message, controlled by
36082 the same logging options.
36083
36084 Finally, if any SMTP commands were issued during the connection, a C= item
36085 is added to the line, listing the commands that were used. For example,
36086 .code
36087 C=EHLO,QUIT
36088 .endd
36089 shows that the client issued QUIT straight after EHLO. If there were fewer
36090 than 20 commands, they are all listed. If there were more than 20 commands,
36091 the last 20 are listed, preceded by &"..."&. However, with the default
36092 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36093 have been aborted before 20 non-mail commands are processed.
36094 .next
36095 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36096 colon-separated, is appended to the A= item for a message arrival or delivery
36097 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36098 was accepted or used.
36099 .next
36100 .cindex "log" "SMTP protocol error"
36101 .cindex "SMTP" "logging protocol error"
36102 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36103 encountered. Exim does not have perfect detection of all protocol errors
36104 because of transmission delays and the use of pipelining. If PIPELINING has
36105 been advertised to a client, an Exim server assumes that the client will use
36106 it, and therefore it does not count &"expected"& errors (for example, RCPT
36107 received after rejecting MAIL) as protocol errors.
36108 .next
36109 .cindex "SMTP" "logging syntax errors"
36110 .cindex "SMTP" "syntax errors; logging"
36111 .cindex "SMTP" "unknown command; logging"
36112 .cindex "log" "unknown SMTP command"
36113 .cindex "log" "SMTP syntax error"
36114 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36115 encountered. An unrecognized command is treated as a syntax error. For an
36116 external connection, the host identity is given; for an internal connection
36117 using &%-bs%& the sender identification (normally the calling user) is given.
36118 .next
36119 .cindex "log" "subject"
36120 .cindex "subject, logging"
36121 &%subject%&: The subject of the message is added to the arrival log line,
36122 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36123 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36124 specifies whether characters with values greater than 127 should be logged
36125 unchanged, or whether they should be rendered as escape sequences.
36126 .next
36127 .cindex "log" "certificate verification"
36128 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36129 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36130 verified, and &`CV=no`& if not.
36131 .next
36132 .cindex "log" "TLS cipher"
36133 .cindex "TLS" "logging cipher"
36134 &%tls_cipher%&: When a message is sent or received over an encrypted
36135 connection, the cipher suite used is added to the log line, preceded by X=.
36136 .next
36137 .cindex "log" "TLS peer DN"
36138 .cindex "TLS" "logging peer DN"
36139 &%tls_peerdn%&: When a message is sent or received over an encrypted
36140 connection, and a certificate is supplied by the remote host, the peer DN is
36141 added to the log line, preceded by DN=.
36142 .next
36143 .cindex "log" "TLS SNI"
36144 .cindex "TLS" "logging SNI"
36145 &%tls_sni%&: When a message is received over an encrypted connection, and
36146 the remote host provided the Server Name Indication extension, the SNI is
36147 added to the log line, preceded by SNI=.
36148 .next
36149 .cindex "log" "DNS failure in list"
36150 &%unknown_in_list%&: This setting causes a log entry to be written when the
36151 result of a list match is failure because a DNS lookup failed.
36152 .endlist
36153
36154
36155 .section "Message log" "SECID260"
36156 .cindex "message" "log file for"
36157 .cindex "log" "message log; description of"
36158 .cindex "&_msglog_& directory"
36159 .oindex "&%preserve_message_logs%&"
36160 In addition to the general log files, Exim writes a log file for each message
36161 that it handles. The names of these per-message logs are the message ids, and
36162 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36163 message log contains copies of the log lines that apply to the message. This
36164 makes it easier to inspect the status of an individual message without having
36165 to search the main log. A message log is deleted when processing of the message
36166 is complete, unless &%preserve_message_logs%& is set, but this should be used
36167 only with great care because they can fill up your disk very quickly.
36168
36169 On a heavily loaded system, it may be desirable to disable the use of
36170 per-message logs, in order to reduce disk I/O. This can be done by setting the
36171 &%message_logs%& option false.
36172 .ecindex IIDloggen
36173
36174
36175
36176
36177 . ////////////////////////////////////////////////////////////////////////////
36178 . ////////////////////////////////////////////////////////////////////////////
36179
36180 .chapter "Exim utilities" "CHAPutils"
36181 .scindex IIDutils "utilities"
36182 A number of utility scripts and programs are supplied with Exim and are
36183 described in this chapter. There is also the Exim Monitor, which is covered in
36184 the next chapter. The utilities described here are:
36185
36186 .itable none 0 0 3  7* left  15* left  40* left
36187 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36188   "list what Exim processes are doing"
36189 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36190 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36191 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36192 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36193                                                 various criteria"
36194 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36195 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36196   "extract statistics from the log"
36197 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36198   "check address acceptance from given IP"
36199 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36200 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36201 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36202 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36203 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36204 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36205 .endtable
36206
36207 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36208 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36209 &url(http://duncanthrax.net/exilog/) for details.
36210
36211
36212
36213
36214 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36215 .cindex "&'exiwhat'&"
36216 .cindex "process, querying"
36217 .cindex "SIGUSR1"
36218 On operating systems that can restart a system call after receiving a signal
36219 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36220 a line describing what it is doing to the file &_exim-process.info_& in the
36221 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36222 processes it can find, having first emptied the file. It then waits for one
36223 second to allow the Exim processes to react before displaying the results. In
36224 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36225 send the signal to the Exim processes, so it is normally run as root.
36226
36227 &*Warning*&: This is not an efficient process. It is intended for occasional
36228 use by system administrators. It is not sensible, for example, to set up a
36229 script that sends SIGUSR1 signals to Exim processes at short intervals.
36230
36231
36232 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36233 varies in different operating systems. Not only are different options used,
36234 but the format of the output is different. For this reason, there are some
36235 system configuration options that configure exactly how &'exiwhat'& works. If
36236 it doesn't seem to be working for you, check the following compile-time
36237 options:
36238 .display
36239 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36240 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36241 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36242 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36243 .endd
36244 An example of typical output from &'exiwhat'& is
36245 .code
36246 164 daemon: -q1h, listening on port 25
36247 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36248 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36249   [10.19.42.42] (editor@ref.example)
36250 10592 handling incoming call from [192.168.243.242]
36251 10628 accepting a local non-SMTP message
36252 .endd
36253 The first number in the output line is the process number. The third line has
36254 been split here, in order to fit it on the page.
36255
36256
36257
36258 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36259 .cindex "&'exiqgrep'&"
36260 .cindex "queue" "grepping"
36261 This utility is a Perl script contributed by Matt Hubbard. It runs
36262 .code
36263 exim -bpu
36264 .endd
36265 or (in case &*-a*& switch is specified)
36266 .code
36267 exim -bp
36268 .endd
36269 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36270 contain alternate exim configuration the queue management might be using.
36271
36272 to obtain a queue listing, and then greps the output to select messages
36273 that match given criteria. The following selection options are available:
36274
36275 .vlist
36276 .vitem &*-f*&&~<&'regex'&>
36277 Match the sender address using a case-insensitive search. The field that is
36278 tested is enclosed in angle brackets, so you can test for bounce messages with
36279 .code
36280 exiqgrep -f '^<>$'
36281 .endd
36282 .vitem &*-r*&&~<&'regex'&>
36283 Match a recipient address using a case-insensitive search. The field that is
36284 tested is not enclosed in angle brackets.
36285
36286 .vitem &*-s*&&~<&'regex'&>
36287 Match against the size field.
36288
36289 .vitem &*-y*&&~<&'seconds'&>
36290 Match messages that are younger than the given time.
36291
36292 .vitem &*-o*&&~<&'seconds'&>
36293 Match messages that are older than the given time.
36294
36295 .vitem &*-z*&
36296 Match only frozen messages.
36297
36298 .vitem &*-x*&
36299 Match only non-frozen messages.
36300 .endlist
36301
36302 The following options control the format of the output:
36303
36304 .vlist
36305 .vitem &*-c*&
36306 Display only the count of matching messages.
36307
36308 .vitem &*-l*&
36309 Long format &-- display the full message information as output by Exim. This is
36310 the default.
36311
36312 .vitem &*-i*&
36313 Display message ids only.
36314
36315 .vitem &*-b*&
36316 Brief format &-- one line per message.
36317
36318 .vitem &*-R*&
36319 Display messages in reverse order.
36320
36321 .vitem &*-a*&
36322 Include delivered recipients in queue listing.
36323 .endlist
36324
36325 There is one more option, &%-h%&, which outputs a list of options.
36326
36327
36328
36329 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36330 .cindex "&'exiqsumm'&"
36331 .cindex "queue" "summary"
36332 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36333 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36334 running a command such as
36335 .code
36336 exim -bp | exiqsumm
36337 .endd
36338 The output consists of one line for each domain that has messages waiting for
36339 it, as in the following example:
36340 .code
36341 3   2322   74m   66m  msn.com.example
36342 .endd
36343 Each line lists the number of pending deliveries for a domain, their total
36344 volume, and the length of time that the oldest and the newest messages have
36345 been waiting. Note that the number of pending deliveries is greater than the
36346 number of messages when messages have more than one recipient.
36347
36348 A summary line is output at the end. By default the output is sorted on the
36349 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36350 the output to be sorted by oldest message and by count of messages,
36351 respectively. There are also three options that split the messages for each
36352 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36353 separates frozen messages, and &%-s%& separates messages according to their
36354 sender.
36355
36356 The output of &'exim -bp'& contains the original addresses in the message, so
36357 this also applies to the output from &'exiqsumm'&. No domains from addresses
36358 generated by aliasing or forwarding are included (unless the &%one_time%&
36359 option of the &(redirect)& router has been used to convert them into &"top
36360 level"& addresses).
36361
36362
36363
36364
36365 .section "Extracting specific information from the log (exigrep)" &&&
36366          "SECTextspeinf"
36367 .cindex "&'exigrep'&"
36368 .cindex "log" "extracts; grepping for"
36369 The &'exigrep'& utility is a Perl script that searches one or more main log
36370 files for entries that match a given pattern. When it finds a match, it
36371 extracts all the log entries for the relevant message, not just those that
36372 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36373 given message, or all mail for a given user, or for a given host, for example.
36374 The input files can be in Exim log format or syslog format.
36375 If a matching log line is not associated with a specific message, it is
36376 included in &'exigrep'&'s output without any additional lines. The usage is:
36377 .display
36378 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36379 .endd
36380 If no log file names are given on the command line, the standard input is read.
36381
36382 The &%-t%& argument specifies a number of seconds. It adds an additional
36383 condition for message selection. Messages that are complete are shown only if
36384 they spent more than <&'n'&> seconds on the queue.
36385
36386 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36387 makes it case-sensitive. This may give a performance improvement when searching
36388 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36389 option; with &%-I%& they do not. In both cases it is possible to change the
36390 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36391
36392 The &%-l%& option means &"literal"&, that is, treat all characters in the
36393 pattern as standing for themselves. Otherwise the pattern must be a Perl
36394 regular expression.
36395
36396 The &%-v%& option inverts the matching condition. That is, a line is selected
36397 if it does &'not'& match the pattern.
36398
36399 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36400 that are generated as a result/response to a message that &'exigrep'& matched
36401 normally.
36402
36403 Example of &%-M%&:
36404 user_a sends a message to user_b, which generates a bounce back to user_b. If
36405 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36406 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36407 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36408 when searching for &"user_a"& will show both messages since the bounce is
36409 &"related"& to or a &"result"& of the first message that was found by the
36410 search term.
36411
36412 If the location of a &'zcat'& command is known from the definition of
36413 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36414 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36415 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36416 autodetection of some well known compression extensions.
36417
36418
36419 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36420 .cindex "&'exipick'&"
36421 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36422 lists messages from the queue according to a variety of criteria. For details
36423 of &'exipick'&'s facilities, visit the web page at
36424 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36425 the &%--help%& option.
36426
36427
36428 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36429 .cindex "log" "cycling local files"
36430 .cindex "cycling logs"
36431 .cindex "&'exicyclog'&"
36432 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36433 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36434 you are using log files with datestamps in their names (see section
36435 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36436 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36437 There are two command line options for &'exicyclog'&:
36438 .ilist
36439 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36440 default that is set when Exim is built. The default default is 10.
36441 .next
36442 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36443 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36444 overriding the script's default, which is to find the setting from Exim's
36445 configuration.
36446 .endlist
36447
36448 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36449 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36450 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36451 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36452 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36453 logs are handled similarly.
36454
36455 If the limit is greater than 99, the script uses 3-digit numbers such as
36456 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36457 to one that is greater, or &'vice versa'&, you will have to fix the names of
36458 any existing log files.
36459
36460 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36461 the end are deleted. All files with numbers greater than 01 are compressed,
36462 using a compression command which is configured by the COMPRESS_COMMAND
36463 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36464 root &%crontab%& entry of the form
36465 .code
36466 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36467 .endd
36468 assuming you have used the name &"exim"& for the Exim user. You can run
36469 &'exicyclog'& as root if you wish, but there is no need.
36470
36471
36472
36473 .section "Mail statistics (eximstats)" "SECTmailstat"
36474 .cindex "statistics"
36475 .cindex "&'eximstats'&"
36476 A Perl script called &'eximstats'& is provided for extracting statistical
36477 information from log files. The output is either plain text, or HTML.
36478 Exim log files are also supported by the &'Lire'& system produced by the
36479 LogReport Foundation &url(http://www.logreport.org).
36480
36481 The &'eximstats'& script has been hacked about quite a bit over time. The
36482 latest version is the result of some extensive revision by Steve Campbell. A
36483 lot of information is given by default, but there are options for suppressing
36484 various parts of it. Following any options, the arguments to the script are a
36485 list of files, which should be main log files. For example:
36486 .code
36487 eximstats -nr /var/spool/exim/log/mainlog.01
36488 .endd
36489 By default, &'eximstats'& extracts information about the number and volume of
36490 messages received from or delivered to various hosts. The information is sorted
36491 both by message count and by volume, and the top fifty hosts in each category
36492 are listed on the standard output. Similar information, based on email
36493 addresses or domains instead of hosts can be requested by means of various
36494 options. For messages delivered and received locally, similar statistics are
36495 also produced per user.
36496
36497 The output also includes total counts and statistics about delivery errors, and
36498 histograms showing the number of messages received and deliveries made in each
36499 hour of the day. A delivery with more than one address in its envelope (for
36500 example, an SMTP transaction with more than one RCPT command) is counted
36501 as a single delivery by &'eximstats'&.
36502
36503 Though normally more deliveries than receipts are reported (as messages may
36504 have multiple recipients), it is possible for &'eximstats'& to report more
36505 messages received than delivered, even though the queue is empty at the start
36506 and end of the period in question. If an incoming message contains no valid
36507 recipients, no deliveries are recorded for it. A bounce message is handled as
36508 an entirely separate message.
36509
36510 &'eximstats'& always outputs a grand total summary giving the volume and number
36511 of messages received and deliveries made, and the number of hosts involved in
36512 each case. It also outputs the number of messages that were delayed (that is,
36513 not completely delivered at the first attempt), and the number that had at
36514 least one address that failed.
36515
36516 The remainder of the output is in sections that can be independently disabled
36517 or modified by various options. It consists of a summary of deliveries by
36518 transport, histograms of messages received and delivered per time interval
36519 (default per hour), information about the time messages spent on the queue,
36520 a list of relayed messages, lists of the top fifty sending hosts, local
36521 senders, destination hosts, and destination local users by count and by volume,
36522 and a list of delivery errors that occurred.
36523
36524 The relay information lists messages that were actually relayed, that is, they
36525 came from a remote host and were directly delivered to some other remote host,
36526 without being processed (for example, for aliasing or forwarding) locally.
36527
36528 There are quite a few options for &'eximstats'& to control exactly what it
36529 outputs. These are documented in the Perl script itself, and can be extracted
36530 by running the command &(perldoc)& on the script. For example:
36531 .code
36532 perldoc /usr/exim/bin/eximstats
36533 .endd
36534
36535 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36536 .cindex "&'exim_checkaccess'&"
36537 .cindex "policy control" "checking access"
36538 .cindex "checking access"
36539 The &%-bh%& command line argument allows you to run a fake SMTP session with
36540 debugging output, in order to check what Exim is doing when it is applying
36541 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36542 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36543 sometimes you just want to answer the question &"Does this address have
36544 access?"& without bothering with any further details.
36545
36546 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36547 two arguments, an IP address and an email address:
36548 .code
36549 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36550 .endd
36551 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36552 given email address would be accepted in a RCPT command in a TCP/IP
36553 connection from the host with the given IP address. The output of the utility
36554 is either the word &"accepted"&, or the SMTP error response, for example:
36555 .code
36556 Rejected:
36557 550 Relay not permitted
36558 .endd
36559 When running this test, the utility uses &`<>`& as the envelope sender address
36560 for the MAIL command, but you can change this by providing additional
36561 options. These are passed directly to the Exim command. For example, to specify
36562 that the test is to be run with the sender address &'himself@there.example'&
36563 you can use:
36564 .code
36565 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36566                  -f himself@there.example
36567 .endd
36568 Note that these additional Exim command line items must be given after the two
36569 mandatory arguments.
36570
36571 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36572 while running its checks. You can run checks that include callouts by using
36573 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36574
36575
36576
36577 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36578 .cindex "DBM" "building dbm files"
36579 .cindex "building DBM files"
36580 .cindex "&'exim_dbmbuild'&"
36581 .cindex "lower casing"
36582 .cindex "binary zero" "in lookup key"
36583 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36584 the format used by the &(lsearch)& lookup (see section
36585 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36586 names as keys and the remainder of the information as data. The lower-casing
36587 can be prevented by calling the program with the &%-nolc%& option.
36588
36589 A terminating zero is included as part of the key string. This is expected by
36590 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36591 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36592 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36593 files.
36594
36595 The program requires two arguments: the name of the input file (which can be a
36596 single hyphen to indicate the standard input), and the name of the output file.
36597 It creates the output under a temporary name, and then renames it if all went
36598 well.
36599
36600 .cindex "USE_DB"
36601 If the native DB interface is in use (USE_DB is set in a compile-time
36602 configuration file &-- this is common in free versions of Unix) the two file
36603 names must be different, because in this mode the Berkeley DB functions create
36604 a single output file using exactly the name given. For example,
36605 .code
36606 exim_dbmbuild /etc/aliases /etc/aliases.db
36607 .endd
36608 reads the system alias file and creates a DBM version of it in
36609 &_/etc/aliases.db_&.
36610
36611 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36612 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36613 environment, the suffixes are added to the second argument of
36614 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36615 when the Berkeley functions are used in compatibility mode (though this is not
36616 recommended), because in that case it adds a &_.db_& suffix to the file name.
36617
36618 If a duplicate key is encountered, the program outputs a warning, and when it
36619 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36620 option is used. By default, only the first of a set of duplicates is used &--
36621 this makes it compatible with &(lsearch)& lookups. There is an option
36622 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36623 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36624 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36625 return code is 2.
36626
36627
36628
36629
36630 .section "Finding individual retry times (exinext)" "SECTfinindret"
36631 .cindex "retry" "times"
36632 .cindex "&'exinext'&"
36633 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36634 fish specific information out of the retry database. Given a mail domain (or a
36635 complete address), it looks up the hosts for that domain, and outputs any retry
36636 information for the hosts or for the domain. At present, the retry information
36637 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36638 output. For example:
36639 .code
36640 $ exinext piglet@milne.fict.example
36641 kanga.milne.example:192.168.8.1 error 146: Connection refused
36642   first failed: 21-Feb-1996 14:57:34
36643   last tried:   21-Feb-1996 14:57:34
36644   next try at:  21-Feb-1996 15:02:34
36645 roo.milne.example:192.168.8.3 error 146: Connection refused
36646   first failed: 20-Jan-1996 13:12:08
36647   last tried:   21-Feb-1996 11:42:03
36648   next try at:  21-Feb-1996 19:42:03
36649   past final cutoff time
36650 .endd
36651 You can also give &'exinext'& a local part, without a domain, and it
36652 will give any retry information for that local part in your default domain.
36653 A message id can be used to obtain retry information pertaining to a specific
36654 message. This exists only when an attempt to deliver a message to a remote host
36655 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36656 &'exinext'& is not particularly efficient, but then it is not expected to be
36657 run very often.
36658
36659 The &'exinext'& utility calls Exim to find out information such as the location
36660 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36661 passed on to the &'exim'& commands. The first specifies an alternate Exim
36662 configuration file, and the second sets macros for use within the configuration
36663 file. These features are mainly to help in testing, but might also be useful in
36664 environments where more than one configuration file is in use.
36665
36666
36667
36668 .section "Hints database maintenance" "SECThindatmai"
36669 .cindex "hints database" "maintenance"
36670 .cindex "maintaining Exim's hints database"
36671 Three utility programs are provided for maintaining the DBM files that Exim
36672 uses to contain its delivery hint information. Each program requires two
36673 arguments. The first specifies the name of Exim's spool directory, and the
36674 second is the name of the database it is to operate on. These are as follows:
36675
36676 .ilist
36677 &'retry'&: the database of retry information
36678 .next
36679 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36680 for remote hosts
36681 .next
36682 &'callout'&: the callout cache
36683 .next
36684 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36685 .next
36686 &'misc'&: other hints data
36687 .endlist
36688
36689 The &'misc'& database is used for
36690
36691 .ilist
36692 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36693 .next
36694 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36695 &(smtp)& transport)
36696 .next
36697 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36698 in a transport)
36699 .endlist
36700
36701
36702
36703 .section "exim_dumpdb" "SECID261"
36704 .cindex "&'exim_dumpdb'&"
36705 The entire contents of a database are written to the standard output by the
36706 &'exim_dumpdb'& program, which has no options or arguments other than the
36707 spool and database names. For example, to dump the retry database:
36708 .code
36709 exim_dumpdb /var/spool/exim retry
36710 .endd
36711 Two lines of output are produced for each entry:
36712 .code
36713 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36714 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36715 .endd
36716 The first item on the first line is the key of the record. It starts with one
36717 of the letters R, or T, depending on whether it refers to a routing or
36718 transport retry. For a local delivery, the next part is the local address; for
36719 a remote delivery it is the name of the remote host, followed by its failing IP
36720 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36721 transport). If the remote port is not the standard one (port 25), it is added
36722 to the IP address. Then there follows an error code, an additional error code,
36723 and a textual description of the error.
36724
36725 The three times on the second line are the time of first failure, the time of
36726 the last delivery attempt, and the computed time for the next attempt. The line
36727 ends with an asterisk if the cutoff time for the last retry rule has been
36728 exceeded.
36729
36730 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36731 consists of a host name followed by a list of ids for messages that are or were
36732 waiting to be delivered to that host. If there are a very large number for any
36733 one host, continuation records, with a sequence number added to the host name,
36734 may be seen. The data in these records is often out of date, because a message
36735 may be routed to several alternative hosts, and Exim makes no effort to keep
36736 cross-references.
36737
36738
36739
36740 .section "exim_tidydb" "SECID262"
36741 .cindex "&'exim_tidydb'&"
36742 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36743 database. If run with no options, it removes all records that are more than 30
36744 days old. The age is calculated from the date and time that the record was last
36745 updated. Note that, in the case of the retry database, it is &'not'& the time
36746 since the first delivery failure. Information about a host that has been down
36747 for more than 30 days will remain in the database, provided that the record is
36748 updated sufficiently often.
36749
36750 The cutoff date can be altered by means of the &%-t%& option, which must be
36751 followed by a time. For example, to remove all records older than a week from
36752 the retry database:
36753 .code
36754 exim_tidydb -t 7d /var/spool/exim retry
36755 .endd
36756 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36757 message ids. In the former these appear as data in records keyed by host &--
36758 they were messages that were waiting for that host &-- and in the latter they
36759 are the keys for retry information for messages that have suffered certain
36760 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36761 message ids in database records are those of messages that are still on the
36762 queue. Message ids for messages that no longer exist are removed from
36763 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36764 For the &'retry'& database, records whose keys are non-existent message ids are
36765 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36766 whenever it removes information from the database.
36767
36768 Certain records are automatically removed by Exim when they are no longer
36769 needed, but others are not. For example, if all the MX hosts for a domain are
36770 down, a retry record is created for each one. If the primary MX host comes back
36771 first, its record is removed when Exim successfully delivers to it, but the
36772 records for the others remain because Exim has not tried to use those hosts.
36773
36774 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36775 hints databases. You should do this at a quiet time of day, because it requires
36776 a database to be locked (and therefore inaccessible to Exim) while it does its
36777 work. Removing records from a DBM file does not normally make the file smaller,
36778 but all the common DBM libraries are able to re-use the space that is released.
36779 After an initial phase of increasing in size, the databases normally reach a
36780 point at which they no longer get any bigger, as long as they are regularly
36781 tidied.
36782
36783 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36784 databases is likely to keep on increasing.
36785
36786
36787
36788
36789 .section "exim_fixdb" "SECID263"
36790 .cindex "&'exim_fixdb'&"
36791 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36792 Its main use is for testing Exim, but it might also be occasionally useful for
36793 getting round problems in a live system. It has no options, and its interface
36794 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36795 key of a database record can then be entered, and the data for that record is
36796 displayed.
36797
36798 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36799 except the &'retry'& database, that is the only operation that can be carried
36800 out. For the &'retry'& database, each field is output preceded by a number, and
36801 data for individual fields can be changed by typing the field number followed
36802 by new data, for example:
36803 .code
36804 > 4 951102:1000
36805 .endd
36806 resets the time of the next delivery attempt. Time values are given as a
36807 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36808 used as optional separators.
36809
36810
36811
36812
36813 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36814 .cindex "mailbox" "maintenance"
36815 .cindex "&'exim_lock'&"
36816 .cindex "locking mailboxes"
36817 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36818 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36819 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36820 a user agent while investigating a problem. The utility requires the name of
36821 the file as its first argument. If the locking is successful, the second
36822 argument is run as a command (using C's &[system()]& function); if there is no
36823 second argument, the value of the SHELL environment variable is used; if this
36824 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36825 is unlocked and the utility ends. The following options are available:
36826
36827 .vlist
36828 .vitem &%-fcntl%&
36829 Use &[fcntl()]& locking on the open mailbox.
36830
36831 .vitem &%-flock%&
36832 Use &[flock()]& locking on the open mailbox, provided the operating system
36833 supports it.
36834
36835 .vitem &%-interval%&
36836 This must be followed by a number, which is a number of seconds; it sets the
36837 interval to sleep between retries (default 3).
36838
36839 .vitem &%-lockfile%&
36840 Create a lock file before opening the mailbox.
36841
36842 .vitem &%-mbx%&
36843 Lock the mailbox using MBX rules.
36844
36845 .vitem &%-q%&
36846 Suppress verification output.
36847
36848 .vitem &%-retries%&
36849 This must be followed by a number; it sets the number of times to try to get
36850 the lock (default 10).
36851
36852 .vitem &%-restore_time%&
36853 This option causes &%exim_lock%& to restore the modified and read times to the
36854 locked file before exiting. This allows you to access a locked mailbox (for
36855 example, to take a backup copy) without disturbing the times that the user
36856 subsequently sees.
36857
36858 .vitem &%-timeout%&
36859 This must be followed by a number, which is a number of seconds; it sets a
36860 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36861 default), a non-blocking call is used.
36862
36863 .vitem &%-v%&
36864 Generate verbose output.
36865 .endlist
36866
36867 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36868 default is to create a lock file and also to use &[fcntl()]& locking on the
36869 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36870 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36871 requires that the directory containing the file be writeable. Locking by lock
36872 file does not last for ever; Exim assumes that a lock file is expired if it is
36873 more than 30 minutes old.
36874
36875 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36876 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36877 to be taken out on the open mailbox, and an exclusive lock on the file
36878 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36879 number of the mailbox file. When the locking is released, if an exclusive lock
36880 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36881
36882 The default output contains verification of the locking that takes place. The
36883 &%-v%& option causes some additional information to be given. The &%-q%& option
36884 suppresses all output except error messages.
36885
36886 A command such as
36887 .code
36888 exim_lock /var/spool/mail/spqr
36889 .endd
36890 runs an interactive shell while the file is locked, whereas
36891 .display
36892 &`exim_lock -q /var/spool/mail/spqr <<End`&
36893 <&'some commands'&>
36894 &`End`&
36895 .endd
36896 runs a specific non-interactive sequence of commands while the file is locked,
36897 suppressing all verification output. A single command can be run by a command
36898 such as
36899 .code
36900 exim_lock -q /var/spool/mail/spqr \
36901   "cp /var/spool/mail/spqr /some/where"
36902 .endd
36903 Note that if a command is supplied, it must be entirely contained within the
36904 second argument &-- hence the quotes.
36905 .ecindex IIDutils
36906
36907
36908 . ////////////////////////////////////////////////////////////////////////////
36909 . ////////////////////////////////////////////////////////////////////////////
36910
36911 .chapter "The Exim monitor" "CHAPeximon"
36912 .scindex IIDeximon "Exim monitor" "description"
36913 .cindex "X-windows"
36914 .cindex "&'eximon'&"
36915 .cindex "Local/eximon.conf"
36916 .cindex "&_exim_monitor/EDITME_&"
36917 The Exim monitor is an application which displays in an X window information
36918 about the state of Exim's queue and what Exim is doing. An admin user can
36919 perform certain operations on messages from this GUI interface; however all
36920 such facilities are also available from the command line, and indeed, the
36921 monitor itself makes use of the command line to perform any actions requested.
36922
36923
36924
36925 .section "Running the monitor" "SECID264"
36926 The monitor is started by running the script called &'eximon'&. This is a shell
36927 script that sets up a number of environment variables, and then runs the
36928 binary called &_eximon.bin_&. The default appearance of the monitor window can
36929 be changed by editing the &_Local/eximon.conf_& file created by editing
36930 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36931 parameters are for.
36932
36933 The parameters that get built into the &'eximon'& script can be overridden for
36934 a particular invocation by setting up environment variables of the same names,
36935 preceded by &`EXIMON_`&. For example, a shell command such as
36936 .code
36937 EXIMON_LOG_DEPTH=400 eximon
36938 .endd
36939 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36940 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36941 overrides the Exim log file configuration. This makes it possible to have
36942 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36943 syslog messages are routed to a file on the local host.
36944
36945 X resources can be used to change the appearance of the window in the normal
36946 way. For example, a resource setting of the form
36947 .code
36948 Eximon*background: gray94
36949 .endd
36950 changes the colour of the background to light grey rather than white. The
36951 stripcharts are drawn with both the data lines and the reference lines in
36952 black. This means that the reference lines are not visible when on top of the
36953 data. However, their colour can be changed by setting a resource called
36954 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36955 For example, if your X server is running Unix, you could set up lighter
36956 reference lines in the stripcharts by obeying
36957 .code
36958 xrdb -merge <<End
36959 Eximon*highlight: gray
36960 End
36961 .endd
36962 .cindex "admin user"
36963 In order to see the contents of messages on the queue, and to operate on them,
36964 &'eximon'& must either be run as root or by an admin user.
36965
36966 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36967 contain X11 resource parameters interpreted by the X11 library.  In addition,
36968 if the first parameter starts with the string "gdb" then it is removed and the
36969 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36970 versioned variants of gdb can be invoked).
36971
36972 The monitor's window is divided into three parts. The first contains one or
36973 more stripcharts and two action buttons, the second contains a &"tail"& of the
36974 main log file, and the third is a display of the queue of messages awaiting
36975 delivery, with two more action buttons. The following sections describe these
36976 different parts of the display.
36977
36978
36979
36980
36981 .section "The stripcharts" "SECID265"
36982 .cindex "stripchart"
36983 The first stripchart is always a count of messages on the queue. Its name can
36984 be configured by setting QUEUE_STRIPCHART_NAME in the
36985 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36986 configuration script by regular expression matches on log file entries, making
36987 it possible to display, for example, counts of messages delivered to certain
36988 hosts or using certain transports. The supplied defaults display counts of
36989 received and delivered messages, and of local and SMTP deliveries. The default
36990 period between stripchart updates is one minute; this can be adjusted by a
36991 parameter in the &_Local/eximon.conf_& file.
36992
36993 The stripchart displays rescale themselves automatically as the value they are
36994 displaying changes. There are always 10 horizontal lines in each chart; the
36995 title string indicates the value of each division when it is greater than one.
36996 For example, &"x2"& means that each division represents a value of 2.
36997
36998 It is also possible to have a stripchart which shows the percentage fullness of
36999 a particular disk partition, which is useful when local deliveries are confined
37000 to a single partition.
37001
37002 .cindex "&%statvfs%& function"
37003 This relies on the availability of the &[statvfs()]& function or equivalent in
37004 the operating system. Most, but not all versions of Unix that support Exim have
37005 this. For this particular stripchart, the top of the chart always represents
37006 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37007 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37008 &_Local/eximon.conf_& file.
37009
37010
37011
37012
37013 .section "Main action buttons" "SECID266"
37014 .cindex "size" "of monitor window"
37015 .cindex "Exim monitor" "window size"
37016 .cindex "window size"
37017 Below the stripcharts there is an action button for quitting the monitor. Next
37018 to this is another button marked &"Size"&. They are placed here so that
37019 shrinking the window to its default minimum size leaves just the queue count
37020 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37021 the window to expand to its maximum size, unless it is already at the maximum,
37022 in which case it is reduced to its minimum.
37023
37024 When expanding to the maximum, if the window cannot be fully seen where it
37025 currently is, it is moved back to where it was the last time it was at full
37026 size. When it is expanding from its minimum size, the old position is
37027 remembered, and next time it is reduced to the minimum it is moved back there.
37028
37029 The idea is that you can keep a reduced window just showing one or two
37030 stripcharts at a convenient place on your screen, easily expand it to show
37031 the full window when required, and just as easily put it back to what it was.
37032 The idea is copied from what the &'twm'& window manager does for its
37033 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37034 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37035
37036 Normally, the monitor starts up with the window at its full size, but it can be
37037 built so that it starts up with the window at its smallest size, by setting
37038 START_SMALL=yes in &_Local/eximon.conf_&.
37039
37040
37041
37042 .section "The log display" "SECID267"
37043 .cindex "log" "tail of; in monitor"
37044 The second section of the window is an area in which a display of the tail of
37045 the main log is maintained.
37046 To save space on the screen, the timestamp on each log line is shortened by
37047 removing the date and, if &%log_timezone%& is set, the timezone.
37048 The log tail is not available when the only destination for logging data is
37049 syslog, unless the syslog lines are routed to a local file whose name is passed
37050 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37051
37052 The log sub-window has a scroll bar at its lefthand side which can be used to
37053 move back to look at earlier text, and the up and down arrow keys also have a
37054 scrolling effect. The amount of log that is kept depends on the setting of
37055 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37056 to use. When this is full, the earlier 50% of data is discarded &-- this is
37057 much more efficient than throwing it away line by line. The sub-window also has
37058 a horizontal scroll bar for accessing the ends of long log lines. This is the
37059 only means of horizontal scrolling; the right and left arrow keys are not
37060 available. Text can be cut from this part of the window using the mouse in the
37061 normal way. The size of this subwindow is controlled by parameters in the
37062 configuration file &_Local/eximon.conf_&.
37063
37064 Searches of the text in the log window can be carried out by means of the ^R
37065 and ^S keystrokes, which default to a reverse and a forward search,
37066 respectively. The search covers only the text that is displayed in the window.
37067 It cannot go further back up the log.
37068
37069 The point from which the search starts is indicated by a caret marker. This is
37070 normally at the end of the text in the window, but can be positioned explicitly
37071 by pointing and clicking with the left mouse button, and is moved automatically
37072 by a successful search. If new text arrives in the window when it is scrolled
37073 back, the caret remains where it is, but if the window is not scrolled back,
37074 the caret is moved to the end of the new text.
37075
37076 Pressing ^R or ^S pops up a window into which the search text can be typed.
37077 There are buttons for selecting forward or reverse searching, for carrying out
37078 the search, and for cancelling. If the &"Search"& button is pressed, the search
37079 happens and the window remains so that further searches can be done. If the
37080 &"Return"& key is pressed, a single search is done and the window is closed. If
37081 ^C is typed the search is cancelled.
37082
37083 The searching facility is implemented using the facilities of the Athena text
37084 widget. By default this pops up a window containing both &"search"& and
37085 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37086 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37087 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37088 provided version of &%TextPop%& when the remaining parts of the text widget
37089 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37090 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37091 on these systems, at the expense of having unwanted items in the search popup
37092 window.
37093
37094
37095
37096 .section "The queue display" "SECID268"
37097 .cindex "queue" "display in monitor"
37098 The bottom section of the monitor window contains a list of all messages that
37099 are on the queue, which includes those currently being received or delivered,
37100 as well as those awaiting delivery. The size of this subwindow is controlled by
37101 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37102 at which it is updated is controlled by another parameter in the same file &--
37103 the default is 5 minutes, since queue scans can be quite expensive. However,
37104 there is an &"Update"& action button just above the display which can be used
37105 to force an update of the queue display at any time.
37106
37107 When a host is down for some time, a lot of pending mail can build up for it,
37108 and this can make it hard to deal with other messages on the queue. To help
37109 with this situation there is a button next to &"Update"& called &"Hide"&. If
37110 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37111 type anything in here and press &"Return"&, the text is added to a chain of
37112 such texts, and if every undelivered address in a message matches at least one
37113 of the texts, the message is not displayed.
37114
37115 If there is an address that does not match any of the texts, all the addresses
37116 are displayed as normal. The matching happens on the ends of addresses so, for
37117 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37118 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37119 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37120 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37121 a hide request is automatically cancelled after one hour.
37122
37123 While the dialogue box is displayed, you can't press any buttons or do anything
37124 else to the monitor window. For this reason, if you want to cut text from the
37125 queue display to use in the dialogue box, you have to do the cutting before
37126 pressing the &"Hide"& button.
37127
37128 The queue display contains, for each unhidden queued message, the length of
37129 time it has been on the queue, the size of the message, the message id, the
37130 message sender, and the first undelivered recipient, all on one line. If it is
37131 a bounce message, the sender is shown as &"<>"&. If there is more than one
37132 recipient to which the message has not yet been delivered, subsequent ones are
37133 listed on additional lines, up to a maximum configured number, following which
37134 an ellipsis is displayed. Recipients that have already received the message are
37135 not shown.
37136
37137 .cindex "frozen messages" "display"
37138 If a message is frozen, an asterisk is displayed at the left-hand side.
37139
37140 The queue display has a vertical scroll bar, and can also be scrolled by means
37141 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37142 The text searching facilities, as described above for the log window, are also
37143 available, but the caret is always moved to the end of the text when the queue
37144 display is updated.
37145
37146
37147
37148 .section "The queue menu" "SECID269"
37149 .cindex "queue" "menu in monitor"
37150 If the &%shift%& key is held down and the left button is clicked when the mouse
37151 pointer is over the text for any message, an action menu pops up, and the first
37152 line of the queue display for the message is highlighted. This does not affect
37153 any selected text.
37154
37155 If you want to use some other event for popping up the menu, you can set the
37156 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37157 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37158 value set in this parameter is a standard X event description. For example, to
37159 run eximon using &%ctrl%& rather than &%shift%& you could use
37160 .code
37161 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37162 .endd
37163 The title of the menu is the message id, and it contains entries which act as
37164 follows:
37165
37166 .ilist
37167 &'message log'&: The contents of the message log for the message are displayed
37168 in a new text window.
37169 .next
37170 &'headers'&: Information from the spool file that contains the envelope
37171 information and headers is displayed in a new text window. See chapter
37172 &<<CHAPspool>>& for a description of the format of spool files.
37173 .next
37174 &'body'&: The contents of the spool file containing the body of the message are
37175 displayed in a new text window. There is a default limit of 20,000 bytes to the
37176 amount of data displayed. This can be changed by setting the BODY_MAX
37177 option at compile time, or the EXIMON_BODY_MAX option at run time.
37178 .next
37179 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37180 delivery of the message. This causes an automatic thaw if the message is
37181 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37182 a new text window. The delivery is run in a separate process, to avoid holding
37183 up the monitor while the delivery proceeds.
37184 .next
37185 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37186 that the message be frozen.
37187 .next
37188 .cindex "thawing messages"
37189 .cindex "unfreezing messages"
37190 .cindex "frozen messages" "thawing"
37191 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37192 that the message be thawed.
37193 .next
37194 .cindex "delivery" "forcing failure"
37195 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37196 that Exim gives up trying to deliver the message. A bounce message is generated
37197 for any remaining undelivered addresses.
37198 .next
37199 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37200 that the message be deleted from the system without generating a bounce
37201 message.
37202 .next
37203 &'add recipient'&: A dialog box is displayed into which a recipient address can
37204 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37205 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37206 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37207 causes a call to Exim to be made using the &%-Mar%& option to request that an
37208 additional recipient be added to the message, unless the entry box is empty, in
37209 which case no action is taken.
37210 .next
37211 &'mark delivered'&: A dialog box is displayed into which a recipient address
37212 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37213 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37214 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37215 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37216 recipient address as already delivered, unless the entry box is empty, in which
37217 case no action is taken.
37218 .next
37219 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37220 mark all recipient addresses as already delivered.
37221 .next
37222 &'edit sender'&: A dialog box is displayed initialized with the current
37223 sender's address. Pressing RETURN causes a call to Exim to be made using the
37224 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37225 in which case no action is taken. If you want to set an empty sender (as in
37226 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37227 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37228 the address is qualified with that domain.
37229 .endlist
37230
37231 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37232 other cases when a call to Exim is made, if there is any output from Exim (in
37233 particular, if the command fails) a window containing the command and the
37234 output is displayed. Otherwise, the results of the action are normally apparent
37235 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37236 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37237 if no output is generated.
37238
37239 The queue display is automatically updated for actions such as freezing and
37240 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37241 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37242 force an update of the display after one of these actions.
37243
37244 In any text window that is displayed as result of a menu action, the normal
37245 cut-and-paste facility is available, and searching can be carried out using ^R
37246 and ^S, as described above for the log tail window.
37247 .ecindex IIDeximon
37248
37249
37250
37251
37252
37253 . ////////////////////////////////////////////////////////////////////////////
37254 . ////////////////////////////////////////////////////////////////////////////
37255
37256 .chapter "Security considerations" "CHAPsecurity"
37257 .scindex IIDsecurcon "security" "discussion of"
37258 This chapter discusses a number of issues concerned with security, some of
37259 which are also covered in other parts of this manual.
37260
37261 For reasons that this author does not understand, some people have promoted
37262 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37263 existence of this chapter in the documentation. However, the intent of the
37264 chapter is simply to describe the way Exim works in relation to certain
37265 security concerns, not to make any specific claims about the effectiveness of
37266 its security as compared with other MTAs.
37267
37268 What follows is a description of the way Exim is supposed to be. Best efforts
37269 have been made to try to ensure that the code agrees with the theory, but an
37270 absence of bugs can never be guaranteed. Any that are reported will get fixed
37271 as soon as possible.
37272
37273
37274 .section "Building a more &""hardened""& Exim" "SECID286"
37275 .cindex "security" "build-time features"
37276 There are a number of build-time options that can be set in &_Local/Makefile_&
37277 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37278 Exim administrator who does not have the root password, or by someone who has
37279 penetrated the Exim (but not the root) account. These options are as follows:
37280
37281 .ilist
37282 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37283 start of any file names used with the &%-C%& option. When it is set, these file
37284 names are also not allowed to contain the sequence &"/../"&. (However, if the
37285 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37286 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37287 default setting for &%ALT_CONFIG_PREFIX%&.
37288
37289 If the permitted configuration files are confined to a directory to
37290 which only root has access, this guards against someone who has broken
37291 into the Exim account from running a privileged Exim with an arbitrary
37292 configuration file, and using it to break into other accounts.
37293 .next
37294
37295 If a non-trusted configuration file (i.e. not the default configuration file
37296 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37297 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37298 the next item), then root privilege is retained only if the caller of Exim is
37299 root. This locks out the possibility of testing a configuration using &%-C%&
37300 right through message reception and delivery, even if the caller is root. The
37301 reception works, but by that time, Exim is running as the Exim user, so when
37302 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37303 privilege to be lost. However, root can test reception and delivery using two
37304 separate commands.
37305
37306 .next
37307 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37308 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37309 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37310 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37311 the restrictive side.  Requiring build-time selection of safe macros is onerous
37312 but this option is intended solely as a transition mechanism to permit
37313 previously-working configurations to continue to work after release 4.73.
37314 .next
37315 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37316 is disabled.
37317 .next
37318 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37319 never to be used for any deliveries. This is like the &%never_users%& runtime
37320 option, but it cannot be overridden; the runtime option adds additional users
37321 to the list. The default setting is &"root"&; this prevents a non-root user who
37322 is permitted to modify the runtime file from using Exim as a way to get root.
37323 .endlist
37324
37325
37326
37327 .section "Root privilege" "SECID270"
37328 .cindex "setuid"
37329 .cindex "root privilege"
37330 The Exim binary is normally setuid to root, which means that it gains root
37331 privilege (runs as root) when it starts execution. In some special cases (for
37332 example, when the daemon is not in use and there are no local deliveries), it
37333 may be possible to run Exim setuid to some user other than root. This is
37334 discussed in the next section. However, in most installations, root privilege
37335 is required for two things:
37336
37337 .ilist
37338 To set up a socket connected to the standard SMTP port (25) when initialising
37339 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37340 not required.
37341 .next
37342 To be able to change uid and gid in order to read users' &_.forward_& files and
37343 perform local deliveries as the receiving user or as specified in the
37344 configuration.
37345 .endlist
37346
37347 It is not necessary to be root to do any of the other things Exim does, such as
37348 receiving messages and delivering them externally over SMTP, and it is
37349 obviously more secure if Exim does not run as root except when necessary.
37350 For this reason, a user and group for Exim to use must be defined in
37351 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37352 group"&. Their values can be changed by the run time configuration, though this
37353 is not recommended. Often a user called &'exim'& is used, but some sites use
37354 &'mail'& or another user name altogether.
37355
37356 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37357 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37358 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37359
37360 After a new Exim process has interpreted its command line options, it changes
37361 uid and gid in the following cases:
37362
37363 .ilist
37364 .oindex "&%-C%&"
37365 .oindex "&%-D%&"
37366 If the &%-C%& option is used to specify an alternate configuration file, or if
37367 the &%-D%& option is used to define macro values for the configuration, and the
37368 calling process is not running as root, the uid and gid are changed to those of
37369 the calling process.
37370 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37371 option may not be used at all.
37372 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37373 can be supplied if the calling process is running as root, the Exim run-time
37374 user or CONFIGURE_OWNER, if defined.
37375 .next
37376 .oindex "&%-be%&"
37377 .oindex "&%-bf%&"
37378 .oindex "&%-bF%&"
37379 If the expansion test option (&%-be%&) or one of the filter testing options
37380 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37381 calling process.
37382 .next
37383 If the process is not a daemon process or a queue runner process or a delivery
37384 process or a process for testing address routing (started with &%-bt%&), the
37385 uid and gid are changed to the Exim user and group. This means that Exim always
37386 runs under its own uid and gid when receiving messages. This also applies when
37387 testing address verification
37388 .oindex "&%-bv%&"
37389 .oindex "&%-bh%&"
37390 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37391 option).
37392 .next
37393 For a daemon, queue runner, delivery, or address testing process, the uid
37394 remains as root at this stage, but the gid is changed to the Exim group.
37395 .endlist
37396
37397 The processes that initially retain root privilege behave as follows:
37398
37399 .ilist
37400 A daemon process changes the gid to the Exim group and the uid to the Exim
37401 user after setting up one or more listening sockets. The &[initgroups()]&
37402 function is called, so that if the Exim user is in any additional groups, they
37403 will be used during message reception.
37404 .next
37405 A queue runner process retains root privilege throughout its execution. Its
37406 job is to fork a controlled sequence of delivery processes.
37407 .next
37408 A delivery process retains root privilege throughout most of its execution,
37409 but any actual deliveries (that is, the transports themselves) are run in
37410 subprocesses which always change to a non-root uid and gid. For local
37411 deliveries this is typically the uid and gid of the owner of the mailbox; for
37412 remote deliveries, the Exim uid and gid are used. Once all the delivery
37413 subprocesses have been run, a delivery process changes to the Exim uid and gid
37414 while doing post-delivery tidying up such as updating the retry database and
37415 generating bounce and warning messages.
37416
37417 While the recipient addresses in a message are being routed, the delivery
37418 process runs as root. However, if a user's filter file has to be processed,
37419 this is done in a subprocess that runs under the individual user's uid and
37420 gid. A system filter is run as root unless &%system_filter_user%& is set.
37421 .next
37422 A process that is testing addresses (the &%-bt%& option) runs as root so that
37423 the routing is done in the same environment as a message delivery.
37424 .endlist
37425
37426
37427
37428
37429 .section "Running Exim without privilege" "SECTrunexiwitpri"
37430 .cindex "privilege, running without"
37431 .cindex "unprivileged running"
37432 .cindex "root privilege" "running without"
37433 Some installations like to run Exim in an unprivileged state for more of its
37434 operation, for added security. Support for this mode of operation is provided
37435 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37436 gid are changed to the Exim user and group at the start of a delivery process
37437 (and also queue runner and address testing processes). This means that address
37438 routing is no longer run as root, and the deliveries themselves cannot change
37439 to any other uid.
37440
37441 .cindex SIGHUP
37442 .cindex "daemon" "restarting"
37443 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37444 that the daemon can still be started in the usual way, and it can respond
37445 correctly to SIGHUP because the re-invocation regains root privilege.
37446
37447 An alternative approach is to make Exim setuid to the Exim user and also setgid
37448 to the Exim group. If you do this, the daemon must be started from a root
37449 process. (Calling Exim from a root process makes it behave in the way it does
37450 when it is setuid root.) However, the daemon cannot restart itself after a
37451 SIGHUP signal because it cannot regain privilege.
37452
37453 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37454 stops Exim from trying to re-invoke itself to do a delivery after a message has
37455 been received. Such a re-invocation is a waste of resources because it has no
37456 effect.
37457
37458 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37459 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37460 to the Exim user seems a clean approach, but there is one complication:
37461
37462 In this style of operation, Exim is running with the real uid and gid set to
37463 those of the calling process, and the effective uid/gid set to Exim's values.
37464 Ideally, any association with the calling process' uid/gid should be dropped,
37465 that is, the real uid/gid should be reset to the effective values so as to
37466 discard any privileges that the caller may have. While some operating systems
37467 have a function that permits this action for a non-root effective uid, quite a
37468 number of them do not. Because of this lack of standardization, Exim does not
37469 address this problem at this time.
37470
37471 For this reason, the recommended approach for &"mostly unprivileged"& running
37472 is to keep the Exim binary setuid to root, and to set
37473 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37474 be used in the most straightforward way.
37475
37476 If you configure Exim not to run delivery processes as root, there are a
37477 number of restrictions on what you can do:
37478
37479 .ilist
37480 You can deliver only as the Exim user/group. You should  explicitly use the
37481 &%user%& and &%group%& options to override routers or local transports that
37482 normally deliver as the recipient. This makes sure that configurations that
37483 work in this mode function the same way in normal mode. Any implicit or
37484 explicit specification of another user causes an error.
37485 .next
37486 Use of &_.forward_& files is severely restricted, such that it is usually
37487 not worthwhile to include them in the configuration.
37488 .next
37489 Users who wish to use &_.forward_& would have to make their home directory and
37490 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37491 and their equivalents in Exim filters, cannot be used. While they could be
37492 enabled in the Exim user's name, that would be insecure and not very useful.
37493 .next
37494 Unless the local user mailboxes are all owned by the Exim user (possible in
37495 some POP3 or IMAP-only environments):
37496
37497 .olist
37498 They must be owned by the Exim group and be writeable by that group. This
37499 implies you must set &%mode%& in the appendfile configuration, as well as the
37500 mode of the mailbox files themselves.
37501 .next
37502 You must set &%no_check_owner%&, since most or all of the files will not be
37503 owned by the Exim user.
37504 .next
37505 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37506 on a newly created mailbox when unprivileged. This also implies that new
37507 mailboxes need to be created manually.
37508 .endlist olist
37509 .endlist ilist
37510
37511
37512 These restrictions severely restrict what can be done in local deliveries.
37513 However, there are no restrictions on remote deliveries. If you are running a
37514 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37515 gives more security at essentially no cost.
37516
37517 If you are using the &%mua_wrapper%& facility (see chapter
37518 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37519
37520
37521
37522
37523 .section "Delivering to local files" "SECID271"
37524 Full details of the checks applied by &(appendfile)& before it writes to a file
37525 are given in chapter &<<CHAPappendfile>>&.
37526
37527
37528
37529 .section "Running local commands" "SECTsecconslocalcmds"
37530 .cindex "security" "local commands"
37531 .cindex "security" "command injection attacks"
37532 There are a number of ways in which an administrator can configure Exim to run
37533 commands based upon received, untrustworthy, data. Further, in some
37534 configurations a user who can control a &_.forward_& file can also arrange to
37535 run commands. Configuration to check includes, but is not limited to:
37536
37537 .ilist
37538 Use of &%use_shell%& in the pipe transport: various forms of shell command
37539 injection may be possible with this option present. It is dangerous and should
37540 be used only with considerable caution. Consider constraints which whitelist
37541 allowed characters in a variable which is to be used in a pipe transport that
37542 has &%use_shell%& enabled.
37543 .next
37544 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37545 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37546 &_.forward_& files in a redirect router. If Exim is running on a central mail
37547 hub to which ordinary users do not have shell access, but home directories are
37548 NFS mounted (for instance) then administrators should review the list of these
37549 forbid options available, and should bear in mind that the options that may
37550 need forbidding can change as new features are added between releases.
37551 .next
37552 The &%${run...}%& expansion item does not use a shell by default, but
37553 administrators can configure use of &_/bin/sh_& as part of the command.
37554 Such invocations should be viewed with prejudicial suspicion.
37555 .next
37556 Administrators who use embedded Perl are advised to explore how Perl's
37557 taint checking might apply to their usage.
37558 .next
37559 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37560 administrators are well advised to view its use with suspicion, in case (for
37561 instance) it allows a local-part to contain embedded Exim directives.
37562 .next
37563 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37564 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37565 each can reference arbitrary lists and files, rather than just being a list
37566 of opaque strings.
37567 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37568 real-world security vulnerabilities caused by its use with untrustworthy data
37569 injected in, for SQL injection attacks.
37570 Consider the use of the &%inlisti%& expansion condition instead.
37571 .endlist
37572
37573
37574
37575
37576 .section "Trust in configuration data" "SECTsecconfdata"
37577 .cindex "security" "data sources"
37578 .cindex "security" "regular expressions"
37579 .cindex "regular expressions" "security"
37580 .cindex "PCRE" "security"
37581 If configuration data for Exim can come from untrustworthy sources, there
37582 are some issues to be aware of:
37583
37584 .ilist
37585 Use of &%${expand...}%& may provide a path for shell injection attacks.
37586 .next
37587 Letting untrusted data provide a regular expression is unwise.
37588 .next
37589 Using &%${match...}%& to apply a fixed regular expression against untrusted
37590 data may result in pathological behaviour within PCRE.  Be aware of what
37591 "backtracking" means and consider options for being more strict with a regular
37592 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37593 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37594 possessive quantifiers or just not using regular expressions against untrusted
37595 data.
37596 .next
37597 It can be important to correctly use &%${quote:...}%&,
37598 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37599 items to ensure that data is correctly constructed.
37600 .next
37601 Some lookups might return multiple results, even though normal usage is only
37602 expected to yield one result.
37603 .endlist
37604
37605
37606
37607
37608 .section "IPv4 source routing" "SECID272"
37609 .cindex "source routing" "in IP packets"
37610 .cindex "IP source routing"
37611 Many operating systems suppress IP source-routed packets in the kernel, but
37612 some cannot be made to do this, so Exim does its own check. It logs incoming
37613 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37614 IPv6. No special checking is currently done.
37615
37616
37617
37618 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37619 Support for these SMTP commands is disabled by default. If required, they can
37620 be enabled by defining suitable ACLs.
37621
37622
37623
37624
37625 .section "Privileged users" "SECID274"
37626 .cindex "trusted users"
37627 .cindex "admin user"
37628 .cindex "privileged user"
37629 .cindex "user" "trusted"
37630 .cindex "user" "admin"
37631 Exim recognizes two sets of users with special privileges. Trusted users are
37632 able to submit new messages to Exim locally, but supply their own sender
37633 addresses and information about a sending host. For other users submitting
37634 local messages, Exim sets up the sender address from the uid, and doesn't
37635 permit a remote host to be specified.
37636
37637 .oindex "&%-f%&"
37638 However, an untrusted user is permitted to use the &%-f%& command line option
37639 in the special form &%-f <>%& to indicate that a delivery failure for the
37640 message should not cause an error report. This affects the message's envelope,
37641 but it does not affect the &'Sender:'& header. Untrusted users may also be
37642 permitted to use specific forms of address with the &%-f%& option by setting
37643 the &%untrusted_set_sender%& option.
37644
37645 Trusted users are used to run processes that receive mail messages from some
37646 other mail domain and pass them on to Exim for delivery either locally, or over
37647 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37648 as any user listed in the &%trusted_users%& configuration option, or under any
37649 group listed in the &%trusted_groups%& option.
37650
37651 Admin users are permitted to do things to the messages on Exim's queue. They
37652 can freeze or thaw messages, cause them to be returned to their senders, remove
37653 them entirely, or modify them in various ways. In addition, admin users can run
37654 the Exim monitor and see all the information it is capable of providing, which
37655 includes the contents of files on the spool.
37656
37657 .oindex "&%-M%&"
37658 .oindex "&%-q%&"
37659 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37660 delivery of messages on its queue is restricted to admin users. This
37661 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37662 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37663 queue is also restricted to admin users. This restriction can be relaxed by
37664 setting &%no_queue_list_requires_admin%&.
37665
37666 Exim recognizes an admin user if the calling process is running as root or as
37667 the Exim user or if any of the groups associated with the calling process is
37668 the Exim group. It is not necessary actually to be running under the Exim
37669 group. However, if admin users who are not root or the Exim user are to access
37670 the contents of files on the spool via the Exim monitor (which runs
37671 unprivileged), Exim must be built to allow group read access to its spool
37672 files.
37673
37674
37675
37676 .section "Spool files" "SECID275"
37677 .cindex "spool directory" "files"
37678 Exim's spool directory and everything it contains is owned by the Exim user and
37679 set to the Exim group. The mode for spool files is defined in the
37680 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37681 any user who is a member of the Exim group can access these files.
37682
37683
37684
37685 .section "Use of argv[0]" "SECID276"
37686 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37687 of specific strings, Exim assumes certain options. For example, calling Exim
37688 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37689 to calling it with the option &%-bS%&. There are no security implications in
37690 this.
37691
37692
37693
37694 .section "Use of %f formatting" "SECID277"
37695 The only use made of &"%f"& by Exim is in formatting load average values. These
37696 are actually stored in integer variables as 1000 times the load average.
37697 Consequently, their range is limited and so therefore is the length of the
37698 converted output.
37699
37700
37701
37702 .section "Embedded Exim path" "SECID278"
37703 Exim uses its own path name, which is embedded in the code, only when it needs
37704 to re-exec in order to regain root privilege. Therefore, it is not root when it
37705 does so. If some bug allowed the path to get overwritten, it would lead to an
37706 arbitrary program's being run as exim, not as root.
37707
37708
37709
37710 .section "Dynamic module directory" "SECTdynmoddir"
37711 Any dynamically loadable modules must be installed into the directory
37712 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37713 loading it.
37714
37715
37716 .section "Use of sprintf()" "SECID279"
37717 .cindex "&[sprintf()]&"
37718 A large number of occurrences of &"sprintf"& in the code are actually calls to
37719 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37720 The intermediate formatting is done into a large fixed buffer by a function
37721 that runs through the format string itself, and checks the length of each
37722 conversion before performing it, thus preventing buffer overruns.
37723
37724 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37725 the output buffer is known to be sufficiently long to contain the converted
37726 string.
37727
37728
37729
37730 .section "Use of debug_printf() and log_write()" "SECID280"
37731 Arbitrary strings are passed to both these functions, but they do their
37732 formatting by calling the function &'string_vformat()'&, which runs through
37733 the format string itself, and checks the length of each conversion.
37734
37735
37736
37737 .section "Use of strcat() and strcpy()" "SECID281"
37738 These are used only in cases where the output buffer is known to be large
37739 enough to hold the result.
37740 .ecindex IIDsecurcon
37741
37742
37743
37744
37745 . ////////////////////////////////////////////////////////////////////////////
37746 . ////////////////////////////////////////////////////////////////////////////
37747
37748 .chapter "Format of spool files" "CHAPspool"
37749 .scindex IIDforspo1 "format" "spool files"
37750 .scindex IIDforspo2 "spool directory" "format of files"
37751 .scindex IIDforspo3 "spool files" "format of"
37752 .cindex "spool files" "editing"
37753 A message on Exim's queue consists of two files, whose names are the message id
37754 followed by -D and -H, respectively. The data portion of the message is kept in
37755 the -D file on its own. The message's envelope, status, and headers are all
37756 kept in the -H file, whose format is described in this chapter. Each of these
37757 two files contains the final component of its own name as its first line. This
37758 is insurance against disk crashes where the directory is lost but the files
37759 themselves are recoverable.
37760
37761 Some people are tempted into editing -D files in order to modify messages. You
37762 need to be extremely careful if you do this; it is not recommended and you are
37763 on your own if you do it. Here are some of the pitfalls:
37764
37765 .ilist
37766 You must ensure that Exim does not try to deliver the message while you are
37767 fiddling with it. The safest way is to take out a write lock on the -D file,
37768 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37769 place, the lock will be retained. If you write a new file and rename it, the
37770 lock will be lost at the instant of rename.
37771 .next
37772 .vindex "&$body_linecount$&"
37773 If you change the number of lines in the file, the value of
37774 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37775 present, this value is not used by Exim, but there is no guarantee that this
37776 will always be the case.
37777 .next
37778 If the message is in MIME format, you must take care not to break it.
37779 .next
37780 If the message is cryptographically signed, any change will invalidate the
37781 signature.
37782 .endlist
37783 All in all, modifying -D files is fraught with danger.
37784
37785 Files whose names end with -J may also be seen in the &_input_& directory (or
37786 its subdirectories when &%split_spool_directory%& is set). These are journal
37787 files, used to record addresses to which the message has been delivered during
37788 the course of a delivery attempt. If there are still undelivered recipients at
37789 the end, the -H file is updated, and the -J file is deleted. If, however, there
37790 is some kind of crash (for example, a power outage) before this happens, the -J
37791 file remains in existence. When Exim next processes the message, it notices the
37792 -J file and uses it to update the -H file before starting the next delivery
37793 attempt.
37794
37795 .section "Format of the -H file" "SECID282"
37796 .cindex "uid (user id)" "in spool file"
37797 .cindex "gid (group id)" "in spool file"
37798 The second line of the -H file contains the login name for the uid of the
37799 process that called Exim to read the message, followed by the numerical uid and
37800 gid. For a locally generated message, this is normally the user who sent the
37801 message. For a message received over TCP/IP via the daemon, it is
37802 normally the Exim user.
37803
37804 The third line of the file contains the address of the message's sender as
37805 transmitted in the envelope, contained in angle brackets. The sender address is
37806 empty for bounce messages. For incoming SMTP mail, the sender address is given
37807 in the MAIL command. For locally generated mail, the sender address is
37808 created by Exim from the login name of the current user and the configured
37809 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37810 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37811 &"<>"& or an address that matches &%untrusted_set_senders%&.
37812
37813 The fourth line contains two numbers. The first is the time that the message
37814 was received, in the conventional Unix form &-- the number of seconds since the
37815 start of the epoch. The second number is a count of the number of messages
37816 warning of delayed delivery that have been sent to the sender.
37817
37818 There follow a number of lines starting with a hyphen. These can appear in any
37819 order, and are omitted when not relevant:
37820
37821 .vlist
37822 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37823 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37824 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37825 recognized, to provide backward compatibility. In the old format, a line of
37826 this form is present for every ACL variable that is not empty. The number
37827 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37828 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37829 the data string for the variable. The string itself starts at the beginning of
37830 the next line, and is followed by a newline character. It may contain internal
37831 newlines.
37832
37833 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37834 A line of this form is present for every ACL connection variable that is
37835 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37836 The length is the length of the data string for the variable. The string itself
37837 starts at the beginning of the next line, and is followed by a newline
37838 character. It may contain internal newlines.
37839
37840 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37841 A line of this form is present for every ACL message variable that is defined.
37842 Note that there is a space between &%-aclm%& and the rest of the name. The
37843 length is the length of the data string for the variable. The string itself
37844 starts at the beginning of the next line, and is followed by a newline
37845 character. It may contain internal newlines.
37846
37847 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37848 This is present if, when the message was received over SMTP, the value of
37849 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37850
37851 .vitem &%-allow_unqualified_recipient%&
37852 This is present if unqualified recipient addresses are permitted in header
37853 lines (to stop such addresses from being qualified if rewriting occurs at
37854 transport time). Local messages that were input using &%-bnq%& and remote
37855 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37856
37857 .vitem &%-allow_unqualified_sender%&
37858 This is present if unqualified sender addresses are permitted in header lines
37859 (to stop such addresses from being qualified if rewriting occurs at transport
37860 time). Local messages that were input using &%-bnq%& and remote messages from
37861 hosts that match &%sender_unqualified_hosts%& set this flag.
37862
37863 .vitem "&%-auth_id%&&~<&'text'&>"
37864 The id information for a message received on an authenticated SMTP connection
37865 &-- the value of the &$authenticated_id$& variable.
37866
37867 .vitem "&%-auth_sender%&&~<&'address'&>"
37868 The address of an authenticated sender &-- the value of the
37869 &$authenticated_sender$& variable.
37870
37871 .vitem "&%-body_linecount%&&~<&'number'&>"
37872 This records the number of lines in the body of the message, and is always
37873 present.
37874
37875 .vitem "&%-body_zerocount%&&~<&'number'&>"
37876 This records the number of binary zero bytes in the body of the message, and is
37877 present if the number is greater than zero.
37878
37879 .vitem &%-deliver_firsttime%&
37880 This is written when a new message is first added to the spool. When the spool
37881 file is updated after a deferral, it is omitted.
37882
37883 .vitem "&%-frozen%&&~<&'time'&>"
37884 .cindex "frozen messages" "spool data"
37885 The message is frozen, and the freezing happened at <&'time'&>.
37886
37887 .vitem "&%-helo_name%&&~<&'text'&>"
37888 This records the host name as specified by a remote host in a HELO or EHLO
37889 command.
37890
37891 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37892 This records the IP address of the host from which the message was received and
37893 the remote port number that was used. It is omitted for locally generated
37894 messages.
37895
37896 .vitem "&%-host_auth%&&~<&'text'&>"
37897 If the message was received on an authenticated SMTP connection, this records
37898 the name of the authenticator &-- the value of the
37899 &$sender_host_authenticated$& variable.
37900
37901 .vitem &%-host_lookup_failed%&
37902 This is present if an attempt to look up the sending host's name from its IP
37903 address failed. It corresponds to the &$host_lookup_failed$& variable.
37904
37905 .vitem "&%-host_name%&&~<&'text'&>"
37906 .cindex "reverse DNS lookup"
37907 .cindex "DNS" "reverse lookup"
37908 This records the name of the remote host from which the message was received,
37909 if the host name was looked up from the IP address when the message was being
37910 received. It is not present if no reverse lookup was done.
37911
37912 .vitem "&%-ident%&&~<&'text'&>"
37913 For locally submitted messages, this records the login of the originating user,
37914 unless it was a trusted user and the &%-oMt%& option was used to specify an
37915 ident value. For messages received over TCP/IP, this records the ident string
37916 supplied by the remote host, if any.
37917
37918 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37919 This records the IP address of the local interface and the port number through
37920 which a message was received from a remote host. It is omitted for locally
37921 generated messages.
37922
37923 .vitem &%-local%&
37924 The message is from a local sender.
37925
37926 .vitem &%-localerror%&
37927 The message is a locally-generated bounce message.
37928
37929 .vitem "&%-local_scan%&&~<&'string'&>"
37930 This records the data string that was returned by the &[local_scan()]& function
37931 when the message was received &-- the value of the &$local_scan_data$&
37932 variable. It is omitted if no data was returned.
37933
37934 .vitem &%-manual_thaw%&
37935 The message was frozen but has been thawed manually, that is, by an explicit
37936 Exim command rather than via the auto-thaw process.
37937
37938 .vitem &%-N%&
37939 A testing delivery process was started using the &%-N%& option to suppress any
37940 actual deliveries, but delivery was deferred. At any further delivery attempts,
37941 &%-N%& is assumed.
37942
37943 .vitem &%-received_protocol%&
37944 This records the value of the &$received_protocol$& variable, which contains
37945 the name of the protocol by which the message was received.
37946
37947 .vitem &%-sender_set_untrusted%&
37948 The envelope sender of this message was set by an untrusted local caller (used
37949 to ensure that the caller is displayed in queue listings).
37950
37951 .vitem "&%-spam_score_int%&&~<&'number'&>"
37952 If a message was scanned by SpamAssassin, this is present. It records the value
37953 of &$spam_score_int$&.
37954
37955 .vitem &%-tls_certificate_verified%&
37956 A TLS certificate was received from the client that sent this message, and the
37957 certificate was verified by the server.
37958
37959 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37960 When the message was received over an encrypted connection, this records the
37961 name of the cipher suite that was used.
37962
37963 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37964 When the message was received over an encrypted connection, and a certificate
37965 was received from the client, this records the Distinguished Name from that
37966 certificate.
37967 .endlist
37968
37969 Following the options there is a list of those addresses to which the message
37970 is not to be delivered. This set of addresses is initialized from the command
37971 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37972 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37973 the address is added to this set. The addresses are kept internally as a
37974 balanced binary tree, and it is a representation of that tree which is written
37975 to the spool file. If an address is expanded via an alias or forward file, the
37976 original address is added to the tree when deliveries to all its child
37977 addresses are complete.
37978
37979 If the tree is empty, there is a single line in the spool file containing just
37980 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37981 Y or N, followed by an address. The address is the value for the node of the
37982 tree, and the letters indicate whether the node has a left branch and/or a
37983 right branch attached to it, respectively. If branches exist, they immediately
37984 follow. Here is an example of a three-node tree:
37985 .code
37986 YY darcy@austen.fict.example
37987 NN alice@wonderland.fict.example
37988 NN editor@thesaurus.ref.example
37989 .endd
37990 After the non-recipients tree, there is a list of the message's recipients.
37991 This is a simple list, preceded by a count. It includes all the original
37992 recipients of the message, including those to whom the message has already been
37993 delivered. In the simplest case, the list contains one address per line. For
37994 example:
37995 .code
37996 4
37997 editor@thesaurus.ref.example
37998 darcy@austen.fict.example
37999 rdo@foundation
38000 alice@wonderland.fict.example
38001 .endd
38002 However, when a child address has been added to the top-level addresses as a
38003 result of the use of the &%one_time%& option on a &(redirect)& router, each
38004 line is of the following form:
38005 .display
38006 <&'top-level address'&> <&'errors_to address'&> &&&
38007   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38008 .endd
38009 The 01 flag bit indicates the presence of the three other fields that follow
38010 the top-level address. Other bits may be used in future to support additional
38011 fields. The <&'parent number'&> is the offset in the recipients list of the
38012 original parent of the &"one time"& address. The first two fields are the
38013 envelope sender that is associated with this address and its length. If the
38014 length is zero, there is no special envelope sender (there are then two space
38015 characters in the line). A non-empty field can arise from a &(redirect)& router
38016 that has an &%errors_to%& setting.
38017
38018
38019 A blank line separates the envelope and status information from the headers
38020 which follow. A header may occupy several lines of the file, and to save effort
38021 when reading it in, each header is preceded by a number and an identifying
38022 character. The number is the number of characters in the header, including any
38023 embedded newlines and the terminating newline. The character is one of the
38024 following:
38025
38026 .table2 50pt
38027 .row <&'blank'&>         "header in which Exim has no special interest"
38028 .row &`B`&               "&'Bcc:'& header"
38029 .row &`C`&               "&'Cc:'& header"
38030 .row &`F`&               "&'From:'& header"
38031 .row &`I`&               "&'Message-id:'& header"
38032 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38033 .row &`R`&               "&'Reply-To:'& header"
38034 .row &`S`&               "&'Sender:'& header"
38035 .row &`T`&               "&'To:'& header"
38036 .row &`*`&               "replaced or deleted header"
38037 .endtable
38038
38039 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38040 purposes. They are not transmitted when the message is delivered. Here is a
38041 typical set of headers:
38042 .code
38043 111P Received: by hobbit.fict.example with local (Exim 4.00)
38044 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38045 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38046 038* X-rewrote-sender: bb@hobbit.fict.example
38047 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38048 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38049 099* To: alice@wonderland.fict.example, rdo@foundation,
38050 darcy@austen.fict.example, editor@thesaurus.ref.example
38051 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38052 darcy@austen.fict.example, editor@thesaurus.ref.example
38053 038  Date: Fri, 11 May 2001 10:28:59 +0100
38054 .endd
38055 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38056 &'To:'& header have been rewritten, the last one because routing expanded the
38057 unqualified domain &'foundation'&.
38058 .ecindex IIDforspo1
38059 .ecindex IIDforspo2
38060 .ecindex IIDforspo3
38061
38062 . ////////////////////////////////////////////////////////////////////////////
38063 . ////////////////////////////////////////////////////////////////////////////
38064
38065 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38066          "DKIM Support"
38067 .cindex "DKIM"
38068
38069 DKIM is a mechanism by which messages sent by some entity can be provably
38070 linked to a domain which that entity controls.  It permits reputation to
38071 be tracked on a per-domain basis, rather than merely upon source IP address.
38072 DKIM is documented in RFC 4871.
38073
38074 .new
38075 DKIM support is compiled into Exim by default if TLS support is present.
38076 .wen
38077 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38078
38079 Exim's DKIM implementation allows to
38080 .olist
38081 Sign outgoing messages: This function is implemented in the SMTP transport.
38082 It can co-exist with all other Exim features
38083 (including transport filters)
38084 except cutthrough delivery.
38085 .next
38086 Verify signatures in incoming messages: This is implemented by an additional
38087 ACL (acl_smtp_dkim), which can be called several times per message, with
38088 different signature contexts.
38089 .endlist
38090
38091 In typical Exim style, the verification implementation does not include any
38092 default "policy". Instead it enables you to build your own policy using
38093 Exim's standard controls.
38094
38095 Please note that verification of DKIM signatures in incoming mail is turned
38096 on by default for logging purposes. For each signature in incoming email,
38097 exim will log a line displaying the most important signature details, and the
38098 signature status. Here is an example (with line-breaks added for clarity):
38099 .code
38100 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38101     d=facebookmail.com s=q1-2009b
38102     c=relaxed/relaxed a=rsa-sha1
38103     i=@facebookmail.com t=1252484542 [verification succeeded]
38104 .endd
38105 You might want to turn off DKIM verification processing entirely for internal
38106 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38107 control modifier. This should typically be done in the RCPT ACL, at points
38108 where you accept mail from relay sources (internal hosts or authenticated
38109 senders).
38110
38111
38112 .section "Signing outgoing messages" "SECDKIMSIGN"
38113 .cindex "DKIM" "signing"
38114
38115 Signing is implemented by setting private options on the SMTP transport.
38116 These options take (expandable) strings as arguments.
38117
38118 .option dkim_domain smtp string&!! unset
38119 MANDATORY:
38120 The domain you want to sign with. The result of this expanded
38121 option is put into the &%$dkim_domain%& expansion variable.
38122
38123 .option dkim_selector smtp string&!! unset
38124 MANDATORY:
38125 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38126 variable to look up a matching selector. The result is put in the expansion
38127 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38128 option along with &%$dkim_domain%&.
38129
38130 .option dkim_private_key smtp string&!! unset
38131 MANDATORY:
38132 This sets the private key to use. You can use the &%$dkim_domain%& and
38133 &%$dkim_selector%& expansion variables to determine the private key to use.
38134 The result can either
38135 .ilist
38136 be a valid RSA private key in ASCII armor, including line breaks.
38137 .next
38138 start with a slash, in which case it is treated as a file that contains
38139 the private key.
38140 .next
38141 be "0", "false" or the empty string, in which case the message will not
38142 be signed. This case will not result in an error, even if &%dkim_strict%&
38143 is set.
38144 .endlist
38145
38146 .option dkim_canon smtp string&!! unset
38147 OPTIONAL:
38148 This option sets the canonicalization method used when signing a message.
38149 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38150 The option defaults to "relaxed" when unset. Note: the current implementation
38151 only supports using the same canonicalization method for both headers and body.
38152
38153 .option dkim_strict smtp string&!! unset
38154 OPTIONAL:
38155 This  option  defines  how  Exim  behaves  when  signing a message that
38156 should be signed fails for some reason.  When the expansion evaluates to
38157 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38158 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38159 variables here.
38160
38161 .option dkim_sign_headers smtp string&!! unset
38162 OPTIONAL:
38163 When set, this option must expand to (or be specified as) a colon-separated
38164 list of header names. Headers with these names will be included in the message
38165 signature. When unspecified, the header names recommended in RFC4871 will be
38166 used.
38167
38168
38169 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38170 .cindex "DKIM" "verification"
38171
38172 Verification of DKIM signatures in incoming email is implemented via the
38173 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38174 syntactically(!) correct signature in the incoming message.
38175 A missing ACL definition defaults to accept.
38176 If any ACL call does not accept, the message is not accepted.
38177 If a cutthrough delivery was in progress for the message it is
38178 summarily dropped (having wasted the transmission effort).
38179
38180 To evaluate the signature in the ACL a large number of expansion variables
38181 containing the signature status and its details are set up during the
38182 runtime of the ACL.
38183
38184 Calling the ACL only for existing signatures is not sufficient to build
38185 more advanced policies. For that reason, the global option
38186 &%dkim_verify_signers%&, and a global expansion variable
38187 &%$dkim_signers%& exist.
38188
38189 The global option &%dkim_verify_signers%& can be set to a colon-separated
38190 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38191 called. It is expanded when the message has been received. At this point,
38192 the expansion variable &%$dkim_signers%& already contains a colon-separated
38193 list of signer domains and identities for the message. When
38194 &%dkim_verify_signers%& is not specified in the main configuration,
38195 it defaults as:
38196 .code
38197 dkim_verify_signers = $dkim_signers
38198 .endd
38199 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38200 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38201 call the ACL for known domains or identities. This would be achieved as follows:
38202 .code
38203 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38204 .endd
38205 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38206 and "ebay.com", plus all domains and identities that have signatures in the message.
38207 You can also be more creative in constructing your policy. For example:
38208 .code
38209 dkim_verify_signers = $sender_address_domain:$dkim_signers
38210 .endd
38211
38212 If a domain or identity is listed several times in the (expanded) value of
38213 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38214
38215
38216 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38217 available (from most to least important):
38218
38219
38220 .vlist
38221 .vitem &%$dkim_cur_signer%&
38222 The signer that is being evaluated in this ACL run. This can be a domain or
38223 an identity. This is one of the list items from the expanded main option
38224 &%dkim_verify_signers%& (see above).
38225 .vitem &%$dkim_verify_status%&
38226 A string describing the general status of the signature. One of
38227 .ilist
38228 &%none%&: There is no signature in the message for the current domain or
38229 identity (as reflected by &%$dkim_cur_signer%&).
38230 .next
38231 &%invalid%&: The signature could not be verified due to a processing error.
38232 More detail is available in &%$dkim_verify_reason%&.
38233 .next
38234 &%fail%&: Verification of the signature failed.  More detail is
38235 available in &%$dkim_verify_reason%&.
38236 .next
38237 &%pass%&: The signature passed verification. It is valid.
38238 .endlist
38239 .vitem &%$dkim_verify_reason%&
38240 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38241 "fail" or "invalid". One of
38242 .ilist
38243 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38244 key for the domain could not be retrieved. This may be a temporary problem.
38245 .next
38246 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38247 record for the domain is syntactically invalid.
38248 .next
38249 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38250 body hash does not match the one specified in the signature header. This
38251 means that the message body was modified in transit.
38252 .next
38253 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38254 could not be verified. This may mean that headers were modified,
38255 re-written or otherwise changed in a way which is incompatible with
38256 DKIM verification. It may of course also mean that the signature is forged.
38257 .endlist
38258 .vitem &%$dkim_domain%&
38259 The signing domain. IMPORTANT: This variable is only populated if there is
38260 an actual signature in the message for the current domain or identity (as
38261 reflected by &%$dkim_cur_signer%&).
38262 .vitem &%$dkim_identity%&
38263 The signing identity, if present. IMPORTANT: This variable is only populated
38264 if there is an actual signature in the message for the current domain or
38265 identity (as reflected by &%$dkim_cur_signer%&).
38266 .vitem &%$dkim_selector%&
38267 The key record selector string.
38268 .vitem &%$dkim_algo%&
38269 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38270 .vitem &%$dkim_canon_body%&
38271 The body canonicalization method. One of 'relaxed' or 'simple'.
38272 .vitem &%dkim_canon_headers%&
38273 The header canonicalization method. One of 'relaxed' or 'simple'.
38274 .vitem &%$dkim_copiedheaders%&
38275 A transcript of headers and their values which are included in the signature
38276 (copied from the 'z=' tag of the signature).
38277 .vitem &%$dkim_bodylength%&
38278 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38279 limit was set by the signer, "9999999999999" is returned. This makes sure
38280 that this variable always expands to an integer value.
38281 .vitem &%$dkim_created%&
38282 UNIX timestamp reflecting the date and time when the signature was created.
38283 When this was not specified by the signer, "0" is returned.
38284 .vitem &%$dkim_expires%&
38285 UNIX timestamp reflecting the date and time when the signer wants the
38286 signature to be treated as "expired". When this was not specified by the
38287 signer, "9999999999999" is returned. This makes it possible to do useful
38288 integer size comparisons against this value.
38289 .vitem &%$dkim_headernames%&
38290 A colon-separated list of names of headers included in the signature.
38291 .vitem &%$dkim_key_testing%&
38292 "1" if the key record has the "testing" flag set, "0" if not.
38293 .vitem &%$dkim_key_nosubdomains%&
38294 "1" if the key record forbids subdomaining, "0" otherwise.
38295 .vitem &%$dkim_key_srvtype%&
38296 Service type (tag s=) from the key record. Defaults to "*" if not specified
38297 in the key record.
38298 .vitem &%$dkim_key_granularity%&
38299 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38300 in the key record.
38301 .vitem &%$dkim_key_notes%&
38302 Notes from the key record (tag n=).
38303 .vitem &%$dkim_key_length%&
38304 Number of bits in the key.
38305 .endlist
38306
38307 In addition, two ACL conditions are provided:
38308
38309 .vlist
38310 .vitem &%dkim_signers%&
38311 ACL condition that checks a colon-separated list of domains or identities
38312 for a match against the domain or identity that the ACL is currently verifying
38313 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38314 verb to a group of domains or identities. For example:
38315
38316 .code
38317 # Warn when Mail purportedly from GMail has no signature at all
38318 warn log_message = GMail sender without DKIM signature
38319      sender_domains = gmail.com
38320      dkim_signers = gmail.com
38321      dkim_status = none
38322 .endd
38323
38324 .vitem &%dkim_status%&
38325 ACL condition that checks a colon-separated list of possible DKIM verification
38326 results against the actual result of verification. This is typically used
38327 to restrict an ACL verb to a list of verification outcomes, for example:
38328
38329 .code
38330 deny message = Mail from Paypal with invalid/missing signature
38331      sender_domains = paypal.com:paypal.de
38332      dkim_signers = paypal.com:paypal.de
38333      dkim_status = none:invalid:fail
38334 .endd
38335
38336 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38337 see the documentation of the &%$dkim_verify_status%& expansion variable above
38338 for more information of what they mean.
38339 .endlist
38340
38341 . ////////////////////////////////////////////////////////////////////////////
38342 . ////////////////////////////////////////////////////////////////////////////
38343
38344 .chapter "Proxies" "CHAPproxies" &&&
38345          "Proxy support"
38346 .cindex "proxy support"
38347 .cindex "proxy" "access via"
38348
38349 .new
38350 A proxy is an intermediate system through which communication is passed.
38351 Proxies may provide a security, availability or load-distribution function.
38352
38353
38354 .section "Inbound proxies" SECTproxyInbound
38355 .cindex proxy inbound
38356 .cindex proxy "server side"
38357 .cindex proxy "Proxy protocol"
38358 .cindex "Proxy protocol" proxy
38359
38360 Exim has support for receiving inbound SMTP connections via a proxy
38361 that uses &"Proxy Protocol"& to speak to it.
38362 To include this support, include &"SUPPORT_PROXY=yes"&
38363 in Local/Makefile.
38364
38365 It was built on specifications from:
38366 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38367 That URL was revised in May 2014 to version 2 spec:
38368 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38369
38370 The purpose of this facility is so that an application load balancer,
38371 such as HAProxy, can sit in front of several Exim servers
38372 to distribute load.
38373 Exim uses the local protocol communication with the proxy to obtain
38374 the remote SMTP system IP address and port information.
38375 There is no logging if a host passes or
38376 fails Proxy Protocol negotiation, but it can easily be determined and
38377 recorded in an ACL (example is below).
38378
38379 Use of a proxy is enabled by setting the &%hosts_proxy%&
38380 main configuration option to a hostlist; connections from these
38381 hosts will use Proxy Protocol.
38382
38383 The following expansion variables are usable
38384 (&"internal"& and &"external"& here refer to the interfaces
38385 of the proxy):
38386 .display
38387 &'proxy_host_address   '& internal IP address of the proxy
38388 &'proxy_host_port      '& internal TCP port of the proxy
38389 &'proxy_target_address '& external IP address of the proxy
38390 &'proxy_target_port    '& external TCP port of the proxy
38391 &'proxy_session        '& boolean: SMTP connection via proxy
38392 .endd
38393 If &$proxy_session$& is set but &$proxy_host_address$& is empty
38394 there was a protocol error.
38395
38396 Since the real connections are all coming from the proxy, and the
38397 per host connection tracking is done before Proxy Protocol is
38398 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38399 handle all of the parallel volume you expect per inbound proxy.
38400 With the option set so high, you lose the ability
38401 to protect your server from many connections from one IP.
38402 In order to prevent your server from overload, you
38403 need to add a per connection ratelimit to your connect ACL.
38404 A possible solution is:
38405 .display
38406   # Set max number of connections per host
38407   LIMIT   = 5
38408   # Or do some kind of IP lookup in a flat file or database
38409   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38410
38411   defer   message        = Too many connections from this IP right now
38412           ratelimit      = LIMIT / 5s / per_conn / strict
38413 .endd
38414
38415
38416
38417 .section "Outbound proxies" SECTproxySOCKS
38418 .cindex proxy outbound
38419 .cindex proxy "client side"
38420 .cindex proxy SOCKS
38421 .cindex SOCKS proxy
38422 Exim has support for sending outbound SMTP via a proxy
38423 using a protocol called SOCKS5 (defined by RFC1928).
38424 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38425 Local/Makefile.
38426
38427 Use of a proxy is enabled by setting the &%socks_proxy%& option
38428 on an smtp transport.
38429 The option value is expanded and should then be a list
38430 (colon-separated by default) of proxy specifiers.
38431 Each proxy specifier is a list
38432 (space-separated by default) where the initial element
38433 is an IP address and any subsequent elements are options.
38434
38435 Options are a string <name>=<value>. 
38436 The list of options is in the following table:
38437 .display
38438 &'auth   '& authentication method
38439 &'name   '& authentication username
38440 &'pass   '& authentication password
38441 &'port   '& tcp port
38442 &'tmo    '& connection timeout
38443 &'pri    '& priority
38444 &'weight '& selection bias
38445 .endd
38446
38447 More details on each of these options follows:
38448
38449 .ilist
38450 .cindex authentication "to proxy"
38451 .cindex proxy authentication
38452 &%auth%&: Either &"none"& (default) or &"name"&.
38453 Using &"name"& selects username/password authentication per RFC 1929
38454 for access to the proxy.
38455 Default is &"none"&.
38456 .next
38457 &%name%&: sets the username for the &"name"& authentication method.
38458 Default is empty.
38459 .next
38460 &%pass%&: sets the password for the &"name"& authentication method.
38461 Default is empty.
38462 .next
38463 &%port%&: the TCP port number to use for the connection to the proxy.
38464 Default is 1080.
38465 .next
38466 &%tmo%&: sets a connection timeout in seconds for this proxy.
38467 Default is 5.
38468 .next
38469 &%pri%&: specifies a priority for the proxy within the list,
38470 higher values being tried first.
38471 The default priority is 1.
38472 .next
38473 &%weight%&: specifies a selection bias.
38474 Within a priority set servers are queried in a random fashion,
38475 weighted by this value.
38476 The default value for selection bias is 1.
38477 .endlist
38478
38479 Proxies from the list are tried according to their priority
38480 and weight settings until one responds.  The timeout for the
38481 overall connection applies to the set of proxied attempts.
38482
38483 .section Logging SECTproxyLog
38484 To log the (local) IP of a proxy in the incoming or delivery logline,
38485 add &"+proxy"& to the &%log_selector%& option.
38486 This will add a component tagged with &"PRX="& to the line.
38487 .wen
38488
38489 . ////////////////////////////////////////////////////////////////////////////
38490 . ////////////////////////////////////////////////////////////////////////////
38491
38492 .chapter "Internationalisation" "CHAPi18n" &&&
38493          "Internationalisation""
38494 .cindex internationalisation "email address"
38495 .cindex EAI
38496 .cindex i18n
38497 .cindex UTF-8 "mail name handling"
38498
38499 .new
38500 Exim has support for Internationalised mail names.
38501 To include this it must be built with SUPPORT_I18N and the libidn library.
38502 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38503
38504 .section "MTA operations" SECTi18nMTA
38505 .cindex SMTPUTF8 "ESMTP option"
38506 The main configuration option &%smtputf8_advertise_hosts%& specifies
38507 a host list.  If this matches the sending host and
38508 accept_8bitmime is true (the default) then the ESMTP option
38509 SMTPUTF8 will be advertised.
38510
38511 If the sender specifies the SMTPUTF8 option on a MAIL command
38512 international handling for the message is enabled and
38513 the expansion variable &$message_smtputf8$& will have value TRUE.
38514
38515 The option &%allow_utf8_domains%& is set to true for this
38516 message. All DNS lookups are converted to a-label form
38517 whatever the setting of &%allow_utf8_domains%&
38518 when Exim is built with SUPPORT_I18N.
38519
38520 Both localparts and domain are maintained as the original
38521 UTF-8 form internally; any comparison or regular-expression use will
38522 require appropriate care.  Filenames created, eg. by
38523 the appendfile transport, will have UTF-8 names.
38524
38525 HELO names sent by the smtp transport will have any UTF-8
38526 components expanded to a-label form,
38527 and any certificate name checks will be done using the a-label
38528 form of the name.
38529
38530 .cindex log protocol
38531 .cindex SMTPUTF8 logging
38532 Log lines and Received-by: header lines will acquire a "utf8"
38533 prefix on the protocol element, eg. utf8esmtp.
38534
38535 The following expansion operator can be used:
38536 .code
38537 ${utf8_domain_to_alabel:str}
38538 ${utf8_domain_from_alabel:str}
38539 ${utf8_localpart_to_alabel:str}
38540 ${utf8_localpart_from_alabel:str}
38541 .endd
38542
38543 ACLs may use the following modifier:
38544 .display
38545 control = utf8_downconvert
38546 control = utf8_downconvert/<value>
38547 .endd
38548 This sets a flag requiring that addresses are converted to
38549 a-label form before smtp delivery, for use in a
38550 Message Submission Agent context.
38551 If a value is appended it may be:
38552 .display
38553 &`1  `& (default) mandatory downconversion
38554 &`0  `& no downconversion
38555 &`-1 `& if SMTPUTF8 not supported by destination host
38556 .endd
38557
38558 If mua_wrapper is set, the utf8_downconvert control
38559 is initially set to -1.
38560
38561
38562 There is no explicit support for VRFY and EXPN.
38563 Configurations supporting these should inspect
38564 &$smtp_command_argument$& for an SMTPUTF8 argument.
38565
38566 There is no support for LMTP on Unix sockets.
38567 Using the "lmtp" protocol option on an smtp transport,
38568 for LMTP over TCP, should work as expected.
38569
38570 There is no support for DSN unitext handling,
38571 and no provision for converting logging from or to UTF-8.
38572
38573
38574
38575 .section "MDA operations" SECTi18nMDA
38576 To aid in constructing names suitable for IMAP folders
38577 the following expansion operator can be used:
38578 .code
38579 ${imapfolder {<string>} {<sep>} {<specials>}}
38580 .endd
38581
38582 The string is converted from the charset specified by
38583 the "headers charset" command (in a filter file)
38584 or &%headers_charset%& main configuration option (otherwise),
38585 to the
38586 modified UTF-7 encoding specified by RFC 2060,
38587 with the following exception: All occurences of <sep>
38588 (which has to be a single character)
38589 are replaced with periods ("."), and all periods and slashes that are not
38590 <sep> and are not in the <specials> string are BASE64 encoded.
38591
38592 The third argument can be omitted, defaulting to an empty string.
38593 The second argument can be omitted, defaulting to "/".
38594
38595 This is the encoding used by Courier for Maildir names on disk, and followed
38596 by many other IMAP servers.
38597
38598 Examples:
38599 .display
38600 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38601 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38602 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38603 .endd
38604
38605 Note that the source charset setting is vital, and also that characters
38606 must be representable in UTF-16.
38607
38608 .wen
38609
38610 . ////////////////////////////////////////////////////////////////////////////
38611 . ////////////////////////////////////////////////////////////////////////////
38612
38613 .chapter "Events" "CHAPevents" &&&
38614          "Events"
38615 .cindex events
38616
38617 .new
38618 The events mechanism in Exim can be used to intercept processing at a number
38619 of points.  It was originally invented to giave a way to do customised logging
38620 actions (for example, to a database) but can also be used to modify some
38621 processing actions.
38622
38623 Most installations will never need to use Events.
38624 The support can be left out of a build by defining DISABLE_EVENT=yes
38625 in &_Local/Makefile_&.
38626
38627 There are two major classes of events: main and transport.
38628 The main configuration option &%event_action%& controls reception events;
38629 a transport option &%event_action%& controls delivery events.
38630
38631 Both options are a string which is expanded when the event fires.
38632 An example might look like:
38633 .cindex logging custom
38634 .code
38635 event_action = ${if eq {msg:delivery}{$event_name} \
38636 {${lookup pgsql {SELECT * FROM record_Delivery( \
38637     '${quote_pgsql:$sender_address_domain}',\
38638     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38639     '${quote_pgsql:$domain}', \
38640     '${quote_pgsql:${lc:$local_part}}', \
38641     '${quote_pgsql:$host_address}', \
38642     '${quote_pgsql:${lc:$host}}', \
38643     '${quote_pgsql:$message_exim_id}')}} \
38644 } {}}
38645 .endd
38646
38647 Events have names which correspond to the point in process at which they fire.
38648 The name is placed in the variable &$event_name$& and the event action
38649 expansion must check this, as it will be called for every possible event type.
38650
38651 The current list of events is:
38652 .display
38653 &`msg:complete           after    main       `& per message
38654 &`msg:delivery           after    transport  `& per recipient
38655 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38656 &`msg:rcpt:defer         after    transport  `& per recipient
38657 &`msg:host:defer         after    transport  `& per attempt
38658 &`msg:fail:delivery      after    main       `& per recipient
38659 &`msg:fail:internal      after    main       `& per recipient
38660 &`tcp:connect            before   transport  `& per connection
38661 &`tcp:close              after    transport  `& per connection
38662 &`tls:cert               before   both       `& per certificate in verification chain
38663 &`smtp:connect           after    transport  `& per connection
38664 .endd
38665 New event types may be added in future.
38666
38667 The event name is a colon-separated list, defining the type of
38668 event in a tree of possibilities.  It may be used as a list
38669 or just matched on as a whole.  There will be no spaces in the name.
38670
38671 The second column in the table above describes whether the event fires
38672 before or after the action is associates with.  Those which fire before
38673 can be used to affect that action (more on this below).
38674
38675 An additional variable, &$event_data$&, is filled with information varying
38676 with the event type:
38677 .display
38678 &`msg:delivery         `& smtp confirmation mssage
38679 &`msg:rcpt:host:defer  `& error string
38680 &`msg:rcpt:defer       `& error string
38681 &`msg:host:defer       `& error string
38682 &`tls:cert             `& verification chain depth
38683 &`smtp:connect         `& smtp banner
38684 .endd
38685
38686 The :defer events populate one extra variable: &$event_defer_errno$&.
38687
38688 For complex operations an ACL expansion can be used in &%event_action%&
38689 however due to the multiple contextx that Exim operates in during
38690 the course of its processing:
38691 .ilist
38692 variables set in transport events will not be visible outside that
38693 transport call
38694 .next
38695 acl_m variables in a server context are lost on a new connection,
38696 and after smtp helo/ehlo/mail/starttls/rset commands
38697 .endlist
38698 Using an ACL expansion with the logwrite modifier can be
38699 a useful way of writing to the main log.
38700
38701 The expansion of the event_action option should normally
38702 return an empty string.  Should it return anything else the
38703 following will be forced:
38704 .display
38705 &`msg:delivery     `&  (ignored)
38706 &`msg:host:defer   `&  (ignored)
38707 &`msg:fail:delivery`&  (ignored)
38708 &`tcp:connect      `&  do not connect
38709 &`tcp:close        `&  (ignored)
38710 &`tls:cert         `&  refuse verification
38711 &`smtp:connect     `&  close connection
38712 .endd
38713 No other use is made of the result string.
38714
38715 For a tcp:connect event, if the connection is being made to a proxy
38716 then the address and port variables will be that of the proxy and not
38717 the target system.
38718
38719 For tls:cert events, if GnuTLS is in use this will trigger only per
38720 chain element received on the connection.
38721 For OpenSSL it will trigger for every chain element including those
38722 loaded locally.
38723 .wen
38724
38725 . ////////////////////////////////////////////////////////////////////////////
38726 . ////////////////////////////////////////////////////////////////////////////
38727
38728 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38729          "Adding drivers or lookups"
38730 .cindex "adding drivers"
38731 .cindex "new drivers, adding"
38732 .cindex "drivers" "adding new"
38733 The following actions have to be taken in order to add a new router, transport,
38734 authenticator, or lookup type to Exim:
38735
38736 .olist
38737 Choose a name for the driver or lookup type that does not conflict with any
38738 existing name; I will use &"newdriver"& in what follows.
38739 .next
38740 Add to &_src/EDITME_& the line:
38741 .display
38742 <&'type'&>&`_NEWDRIVER=yes`&
38743 .endd
38744 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38745 code is not to be included in the binary by default, comment this line out. You
38746 should also add any relevant comments about the driver or lookup type.
38747 .next
38748 Add to &_src/config.h.defaults_& the line:
38749 .code
38750 #define <type>_NEWDRIVER
38751 .endd
38752 .next
38753 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38754 and create a table entry as is done for all the other drivers and lookup types.
38755 .next
38756 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38757 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38758 Add your &`NEWDRIVER`& to that list.
38759 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38760 simple form that most lookups have.
38761 .next
38762 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38763 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38764 driver or lookup type and add it to the definition of OBJ.
38765 .next
38766 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38767 &_src_&.
38768 .next
38769 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38770 as for other drivers and lookups.
38771 .endlist
38772
38773 Then all you need to do is write the code! A good way to start is to make a
38774 proforma by copying an existing module of the same type, globally changing all
38775 occurrences of the name, and cutting out most of the code. Note that any
38776 options you create must be listed in alphabetical order, because the tables are
38777 searched using a binary chop procedure.
38778
38779 There is a &_README_& file in each of the sub-directories of &_src_& describing
38780 the interface that is expected.
38781
38782
38783
38784
38785 . ////////////////////////////////////////////////////////////////////////////
38786 . ////////////////////////////////////////////////////////////////////////////
38787
38788 . /////////////////////////////////////////////////////////////////////////////
38789 . These lines are processing instructions for the Simple DocBook Processor that
38790 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38791 . PDFs than using xmlto and fop. They will be ignored by all other XML
38792 . processors.
38793 . /////////////////////////////////////////////////////////////////////////////
38794
38795 .literal xml
38796 <?sdop
38797   format="newpage"
38798   foot_right_recto="&chaptertitle;"
38799   foot_right_verso="&chaptertitle;"
38800 ?>
38801 .literal off
38802
38803 .makeindex "Options index"   "option"
38804 .makeindex "Variables index" "variable"
38805 .makeindex "Concept index"   "concept"
38806
38807
38808 . /////////////////////////////////////////////////////////////////////////////
38809 . /////////////////////////////////////////////////////////////////////////////